1% texinfo.tex -- TeX macros to handle Texinfo files. 2% 3% Load plain if necessary, i.e., if running under initex. 4\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi 5% 6\def\texinfoversion{2006-11-08.17} 7% 8% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, 9% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free 10% Software Foundation, Inc. 11% 12% This texinfo.tex file is free software; you can redistribute it and/or 13% modify it under the terms of the GNU General Public License as 14% published by the Free Software Foundation; either version 2, or (at 15% your option) any later version. 16% 17% This texinfo.tex file is distributed in the hope that it will be 18% useful, but WITHOUT ANY WARRANTY; without even the implied warranty 19% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20% General Public License for more details. 21% 22% You should have received a copy of the GNU General Public License 23% along with this texinfo.tex file; see the file COPYING. If not, write 24% to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 25% Boston, MA 02110-1301, USA. 26% 27% As a special exception, when this file is read by TeX when processing 28% a Texinfo source document, you may use the result without 29% restriction. (This has been our intent since Texinfo was invented.) 30% 31% Please try the latest version of texinfo.tex before submitting bug 32% reports; you can get the latest version from: 33% http://www.gnu.org/software/texinfo/ (the Texinfo home page), or 34% ftp://tug.org/tex/texinfo.tex 35% (and all CTAN mirrors, see http://www.ctan.org). 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. 38% 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. 42% 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: 46% tex foo.texi 47% texindex foo.?? 48% tex foo.texi 49% tex foo.texi 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. 54% 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. 58% 59% The GNU Texinfo home page is http://www.gnu.org/software/texinfo. 60 61 62\message{Loading texinfo [version \texinfoversion]:} 63 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} 69 70\message{Basics,} 71\chardef\other=12 72 73% We never want plain's \outer definition of \+ in Texinfo. 74% For @tex, we can use \tabalign. 75\let\+ = \relax 76 77% Save some plain tex macros whose names we will redefine. 78\let\ptexb=\b 79\let\ptexbullet=\bullet 80\let\ptexc=\c 81\let\ptexcomma=\, 82\let\ptexdot=\. 83\let\ptexdots=\dots 84\let\ptexend=\end 85\let\ptexequiv=\equiv 86\let\ptexexclam=\! 87\let\ptexfootnote=\footnote 88\let\ptexgtr=> 89\let\ptexhat=^ 90\let\ptexi=\i 91\let\ptexindent=\indent 92\let\ptexinsert=\insert 93\let\ptexlbrace=\{ 94\let\ptexless=< 95\let\ptexnewwrite\newwrite 96\let\ptexnoindent=\noindent 97\let\ptexplus=+ 98\let\ptexrbrace=\} 99\let\ptexslash=\/ 100\let\ptexstar=\* 101\let\ptext=\t 102 103% If this character appears in an error message or help string, it 104% starts a new line in the output. 105\newlinechar = `^^J 106 107% Use TeX 3.0's \inputlineno to get the line number, for better error 108% messages, but if we're using an old version of TeX, don't do anything. 109% 110\ifx\inputlineno\thisisundefined 111 \let\linenumber = \empty % Pre-3.0. 112\else 113 \def\linenumber{l.\the\inputlineno:\space} 114\fi 115 116% Set up fixed words for English if not already set. 117\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi 118\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi 119\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi 120\ifx\putwordin\undefined \gdef\putwordin{in}\fi 121\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi 122\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi 123\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi 124\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi 125\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi 126\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi 127\ifx\putwordof\undefined \gdef\putwordof{of}\fi 128\ifx\putwordon\undefined \gdef\putwordon{on}\fi 129\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi 130\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi 131\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi 132\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi 133\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi 134\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi 135\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi 136% 137\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi 138\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi 139\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi 140\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi 141\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi 142\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi 143\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi 144\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi 145\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi 146\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi 147\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi 148\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi 149% 150\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi 151\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi 152\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi 153\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi 154\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi 155 156% Since the category of space is not known, we have to be careful. 157\chardef\spacecat = 10 158\def\spaceisspace{\catcode`\ =\spacecat} 159 160% sometimes characters are active, so we need control sequences. 161\chardef\colonChar = `\: 162\chardef\commaChar = `\, 163\chardef\dashChar = `\- 164\chardef\dotChar = `\. 165\chardef\exclamChar= `\! 166\chardef\lquoteChar= `\` 167\chardef\questChar = `\? 168\chardef\rquoteChar= `\' 169\chardef\semiChar = `\; 170\chardef\underChar = `\_ 171 172% Ignore a token. 173% 174\def\gobble#1{} 175 176% The following is used inside several \edef's. 177\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} 178 179% Hyphenation fixes. 180\hyphenation{ 181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script 182 ap-pen-dix bit-map bit-maps 183 data-base data-bases eshell fall-ing half-way long-est man-u-script 184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm 185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces 186 spell-ing spell-ings 187 stand-alone strong-est time-stamp time-stamps which-ever white-space 188 wide-spread wrap-around 189} 190 191% Margin to add to right of even pages, to left of odd pages. 192\newdimen\bindingoffset 193\newdimen\normaloffset 194\newdimen\pagewidth \newdimen\pageheight 195 196% For a final copy, take out the rectangles 197% that mark overfull boxes (in case you have decided 198% that the text looks ok even though it passes the margin). 199% 200\def\finalout{\overfullrule=0pt} 201 202% @| inserts a changebar to the left of the current line. It should 203% surround any changed text. This approach does *not* work if the 204% change spans more than two lines of output. To handle that, we would 205% have adopt a much more difficult approach (putting marks into the main 206% vertical list for the beginning and end of each change). 207% 208\def\|{% 209 % \vadjust can only be used in horizontal mode. 210 \leavevmode 211 % 212 % Append this vertical mode material after the current line in the output. 213 \vadjust{% 214 % We want to insert a rule with the height and depth of the current 215 % leading; that is exactly what \strutbox is supposed to record. 216 \vskip-\baselineskip 217 % 218 % \vadjust-items are inserted at the left edge of the type. So 219 % the \llap here moves out into the left-hand margin. 220 \llap{% 221 % 222 % For a thicker or thinner bar, change the `1pt'. 223 \vrule height\baselineskip width1pt 224 % 225 % This is the space between the bar and the text. 226 \hskip 12pt 227 }% 228 }% 229} 230 231% Sometimes it is convenient to have everything in the transcript file 232% and nothing on the terminal. We don't just call \tracingall here, 233% since that produces some useless output on the terminal. We also make 234% some effort to order the tracing commands to reduce output in the log 235% file; cf. trace.sty in LaTeX. 236% 237\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% 238\def\loggingall{% 239 \tracingstats2 240 \tracingpages1 241 \tracinglostchars2 % 2 gives us more in etex 242 \tracingparagraphs1 243 \tracingoutput1 244 \tracingmacros2 245 \tracingrestores1 246 \showboxbreadth\maxdimen \showboxdepth\maxdimen 247 \ifx\eTeXversion\undefined\else % etex gives us more logging 248 \tracingscantokens1 249 \tracingifs1 250 \tracinggroups1 251 \tracingnesting2 252 \tracingassigns1 253 \fi 254 \tracingcommands3 % 3 gives us more in etex 255 \errorcontextlines16 256}% 257 258% add check for \lastpenalty to plain's definitions. If the last thing 259% we did was a \nobreak, we don't want to insert more space. 260% 261\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount 262 \removelastskip\penalty-50\smallskip\fi\fi} 263\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount 264 \removelastskip\penalty-100\medskip\fi\fi} 265\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount 266 \removelastskip\penalty-200\bigskip\fi\fi} 267 268% For @cropmarks command. 269% Do @cropmarks to get crop marks. 270% 271\newif\ifcropmarks 272\let\cropmarks = \cropmarkstrue 273% 274% Dimensions to add cropmarks at corners. 275% Added by P. A. MacKay, 12 Nov. 1986 276% 277\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines 278\newdimen\cornerlong \cornerlong=1pc 279\newdimen\cornerthick \cornerthick=.3pt 280\newdimen\topandbottommargin \topandbottommargin=.75in 281 282% Main output routine. 283\chardef\PAGE = 255 284\output = {\onepageout{\pagecontents\PAGE}} 285 286\newbox\headlinebox 287\newbox\footlinebox 288 289% \onepageout takes a vbox as an argument. Note that \pagecontents 290% does insertions, but you have to call it yourself. 291\def\onepageout#1{% 292 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi 293 % 294 \ifodd\pageno \advance\hoffset by \bindingoffset 295 \else \advance\hoffset by -\bindingoffset\fi 296 % 297 % Do this outside of the \shipout so @code etc. will be expanded in 298 % the headline as they should be, not taken literally (outputting ''code). 299 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% 300 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% 301 % 302 {% 303 % Have to do this stuff outside the \shipout because we want it to 304 % take effect in \write's, yet the group defined by the \vbox ends 305 % before the \shipout runs. 306 % 307 \indexdummies % don't expand commands in the output. 308 \normalturnoffactive % \ in index entries must not stay \, e.g., if 309 % the page break happens to be in the middle of an example. 310 % We don't want .vr (or whatever) entries like this: 311 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} 312 % "\acronym" won't work when it's read back in; 313 % it needs to be 314 % {\code {{\tt \backslashcurfont }acronym} 315 \shipout\vbox{% 316 % Do this early so pdf references go to the beginning of the page. 317 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi 318 % 319 \ifcropmarks \vbox to \outervsize\bgroup 320 \hsize = \outerhsize 321 \vskip-\topandbottommargin 322 \vtop to0pt{% 323 \line{\ewtop\hfil\ewtop}% 324 \nointerlineskip 325 \line{% 326 \vbox{\moveleft\cornerthick\nstop}% 327 \hfill 328 \vbox{\moveright\cornerthick\nstop}% 329 }% 330 \vss}% 331 \vskip\topandbottommargin 332 \line\bgroup 333 \hfil % center the page within the outer (page) hsize. 334 \ifodd\pageno\hskip\bindingoffset\fi 335 \vbox\bgroup 336 \fi 337 % 338 \unvbox\headlinebox 339 \pagebody{#1}% 340 \ifdim\ht\footlinebox > 0pt 341 % Only leave this space if the footline is nonempty. 342 % (We lessened \vsize for it in \oddfootingyyy.) 343 % The \baselineskip=24pt in plain's \makefootline has no effect. 344 \vskip 24pt 345 \unvbox\footlinebox 346 \fi 347 % 348 \ifcropmarks 349 \egroup % end of \vbox\bgroup 350 \hfil\egroup % end of (centering) \line\bgroup 351 \vskip\topandbottommargin plus1fill minus1fill 352 \boxmaxdepth = \cornerthick 353 \vbox to0pt{\vss 354 \line{% 355 \vbox{\moveleft\cornerthick\nsbot}% 356 \hfill 357 \vbox{\moveright\cornerthick\nsbot}% 358 }% 359 \nointerlineskip 360 \line{\ewbot\hfil\ewbot}% 361 }% 362 \egroup % \vbox from first cropmarks clause 363 \fi 364 }% end of \shipout\vbox 365 }% end of group with \indexdummies 366 \advancepageno 367 \ifnum\outputpenalty>-20000 \else\dosupereject\fi 368} 369 370\newinsert\margin \dimen\margin=\maxdimen 371 372\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} 373{\catcode`\@ =11 374\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi 375% marginal hacks, juha@viisa.uucp (Juha Takala) 376\ifvoid\margin\else % marginal info is present 377 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi 378\dimen@=\dp#1 \unvbox#1 379\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi 380\ifr@ggedbottom \kern-\dimen@ \vfil \fi} 381} 382 383% Here are the rules for the cropmarks. Note that they are 384% offset so that the space between them is truly \outerhsize or \outervsize 385% (P. A. MacKay, 12 November, 1986) 386% 387\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} 388\def\nstop{\vbox 389 {\hrule height\cornerthick depth\cornerlong width\cornerthick}} 390\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} 391\def\nsbot{\vbox 392 {\hrule height\cornerlong depth\cornerthick width\cornerthick}} 393 394% Parse an argument, then pass it to #1. The argument is the rest of 395% the input line (except we remove a trailing comment). #1 should be a 396% macro which expects an ordinary undelimited TeX argument. 397% 398\def\parsearg{\parseargusing{}} 399\def\parseargusing#1#2{% 400 \def\argtorun{#2}% 401 \begingroup 402 \obeylines 403 \spaceisspace 404 #1% 405 \parseargline\empty% Insert the \empty token, see \finishparsearg below. 406} 407 408{\obeylines % 409 \gdef\parseargline#1^^M{% 410 \endgroup % End of the group started in \parsearg. 411 \argremovecomment #1\comment\ArgTerm% 412 }% 413} 414 415% First remove any @comment, then any @c comment. 416\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} 417\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} 418 419% Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space. 420% 421% \argremovec might leave us with trailing space, e.g., 422% @end itemize @c foo 423% This space token undergoes the same procedure and is eventually removed 424% by \finishparsearg. 425% 426\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} 427\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} 428\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% 429 \def\temp{#3}% 430 \ifx\temp\empty 431 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp: 432 \let\temp\finishparsearg 433 \else 434 \let\temp\argcheckspaces 435 \fi 436 % Put the space token in: 437 \temp#1 #3\ArgTerm 438} 439 440% If a _delimited_ argument is enclosed in braces, they get stripped; so 441% to get _exactly_ the rest of the line, we had to prevent such situation. 442% We prepended an \empty token at the very beginning and we expand it now, 443% just before passing the control to \argtorun. 444% (Similarily, we have to think about #3 of \argcheckspacesY above: it is 445% either the null string, or it ends with \^^M---thus there is no danger 446% that a pair of braces would be stripped. 447% 448% But first, we have to remove the trailing space token. 449% 450\def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}} 451 452% \parseargdef\foo{...} 453% is roughly equivalent to 454% \def\foo{\parsearg\Xfoo} 455% \def\Xfoo#1{...} 456% 457% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my 458% favourite TeX trick. --kasal, 16nov03 459 460\def\parseargdef#1{% 461 \expandafter \doparseargdef \csname\string#1\endcsname #1% 462} 463\def\doparseargdef#1#2{% 464 \def#2{\parsearg#1}% 465 \def#1##1% 466} 467 468% Several utility definitions with active space: 469{ 470 \obeyspaces 471 \gdef\obeyedspace{ } 472 473 % Make each space character in the input produce a normal interword 474 % space in the output. Don't allow a line break at this space, as this 475 % is used only in environments like @example, where each line of input 476 % should produce a line of output anyway. 477 % 478 \gdef\sepspaces{\obeyspaces\let =\tie} 479 480 % If an index command is used in an @example environment, any spaces 481 % therein should become regular spaces in the raw index file, not the 482 % expansion of \tie (\leavevmode \penalty \@M \ ). 483 \gdef\unsepspaces{\let =\space} 484} 485 486 487\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} 488 489% Define the framework for environments in texinfo.tex. It's used like this: 490% 491% \envdef\foo{...} 492% \def\Efoo{...} 493% 494% It's the responsibility of \envdef to insert \begingroup before the 495% actual body; @end closes the group after calling \Efoo. \envdef also 496% defines \thisenv, so the current environment is known; @end checks 497% whether the environment name matches. The \checkenv macro can also be 498% used to check whether the current environment is the one expected. 499% 500% Non-false conditionals (@iftex, @ifset) don't fit into this, so they 501% are not treated as enviroments; they don't open a group. (The 502% implementation of @end takes care not to call \endgroup in this 503% special case.) 504 505 506% At runtime, environments start with this: 507\def\startenvironment#1{\begingroup\def\thisenv{#1}} 508% initialize 509\let\thisenv\empty 510 511% ... but they get defined via ``\envdef\foo{...}'': 512\long\def\envdef#1#2{\def#1{\startenvironment#1#2}} 513\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} 514 515% Check whether we're in the right environment: 516\def\checkenv#1{% 517 \def\temp{#1}% 518 \ifx\thisenv\temp 519 \else 520 \badenverr 521 \fi 522} 523 524% Evironment mismatch, #1 expected: 525\def\badenverr{% 526 \errhelp = \EMsimple 527 \errmessage{This command can appear only \inenvironment\temp, 528 not \inenvironment\thisenv}% 529} 530\def\inenvironment#1{% 531 \ifx#1\empty 532 out of any environment% 533 \else 534 in environment \expandafter\string#1% 535 \fi 536} 537 538% @end foo executes the definition of \Efoo. 539% But first, it executes a specialized version of \checkenv 540% 541\parseargdef\end{% 542 \if 1\csname iscond.#1\endcsname 543 \else 544 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 545 \expandafter\checkenv\csname#1\endcsname 546 \csname E#1\endcsname 547 \endgroup 548 \fi 549} 550 551\newhelp\EMsimple{Press RETURN to continue.} 552 553 554%% Simple single-character @ commands 555 556% @@ prints an @ 557% Kludge this until the fonts are right (grr). 558\def\@{{\tt\char64}} 559 560% This is turned off because it was never documented 561% and you can use @w{...} around a quote to suppress ligatures. 562%% Define @` and @' to be the same as ` and ' 563%% but suppressing ligatures. 564%\def\`{{`}} 565%\def\'{{'}} 566 567% Used to generate quoted braces. 568\def\mylbrace {{\tt\char123}} 569\def\myrbrace {{\tt\char125}} 570\let\{=\mylbrace 571\let\}=\myrbrace 572\begingroup 573 % Definitions to produce \{ and \} commands for indices, 574 % and @{ and @} for the aux/toc files. 575 \catcode`\{ = \other \catcode`\} = \other 576 \catcode`\[ = 1 \catcode`\] = 2 577 \catcode`\! = 0 \catcode`\\ = \other 578 !gdef!lbracecmd[\{]% 579 !gdef!rbracecmd[\}]% 580 !gdef!lbraceatcmd[@{]% 581 !gdef!rbraceatcmd[@}]% 582!endgroup 583 584% @comma{} to avoid , parsing problems. 585\let\comma = , 586 587% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent 588% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. 589\let\, = \c 590\let\dotaccent = \. 591\def\ringaccent#1{{\accent23 #1}} 592\let\tieaccent = \t 593\let\ubaraccent = \b 594\let\udotaccent = \d 595 596% Other special characters: @questiondown @exclamdown @ordf @ordm 597% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. 598\def\questiondown{?`} 599\def\exclamdown{!`} 600\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} 601\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} 602 603% Dotless i and dotless j, used for accents. 604\def\imacro{i} 605\def\jmacro{j} 606\def\dotless#1{% 607 \def\temp{#1}% 608 \ifx\temp\imacro \ptexi 609 \else\ifx\temp\jmacro \j 610 \else \errmessage{@dotless can be used only with i or j}% 611 \fi\fi 612} 613 614% The \TeX{} logo, as in plain, but resetting the spacing so that a 615% period following counts as ending a sentence. (Idea found in latex.) 616% 617\edef\TeX{\TeX \spacefactor=1000 } 618 619% @LaTeX{} logo. Not quite the same results as the definition in 620% latex.ltx, since we use a different font for the raised A; it's most 621% convenient for us to use an explicitly smaller font, rather than using 622% the \scriptstyle font (since we don't reset \scriptstyle and 623% \scriptscriptstyle). 624% 625\def\LaTeX{% 626 L\kern-.36em 627 {\setbox0=\hbox{T}% 628 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}% 629 \kern-.15em 630 \TeX 631} 632 633% Be sure we're in horizontal mode when doing a tie, since we make space 634% equivalent to this in @example-like environments. Otherwise, a space 635% at the beginning of a line will start with \penalty -- and 636% since \penalty is valid in vertical mode, we'd end up putting the 637% penalty on the vertical list instead of in the new paragraph. 638{\catcode`@ = 11 639 % Avoid using \@M directly, because that causes trouble 640 % if the definition is written into an index file. 641 \global\let\tiepenalty = \@M 642 \gdef\tie{\leavevmode\penalty\tiepenalty\ } 643} 644 645% @: forces normal size whitespace following. 646\def\:{\spacefactor=1000 } 647 648% @* forces a line break. 649\def\*{\hfil\break\hbox{}\ignorespaces} 650 651% @/ allows a line break. 652\let\/=\allowbreak 653 654% @. is an end-of-sentence period. 655\def\.{.\spacefactor=\endofsentencespacefactor\space} 656 657% @! is an end-of-sentence bang. 658\def\!{!\spacefactor=\endofsentencespacefactor\space} 659 660% @? is an end-of-sentence query. 661\def\?{?\spacefactor=\endofsentencespacefactor\space} 662 663% @frenchspacing on|off says whether to put extra space after punctuation. 664% 665\def\onword{on} 666\def\offword{off} 667% 668\parseargdef\frenchspacing{% 669 \def\temp{#1}% 670 \ifx\temp\onword \plainfrenchspacing 671 \else\ifx\temp\offword \plainnonfrenchspacing 672 \else 673 \errhelp = \EMsimple 674 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}% 675 \fi\fi 676} 677 678% @w prevents a word break. Without the \leavevmode, @w at the 679% beginning of a paragraph, when TeX is still in vertical mode, would 680% produce a whole line of output instead of starting the paragraph. 681\def\w#1{\leavevmode\hbox{#1}} 682 683% @group ... @end group forces ... to be all on one page, by enclosing 684% it in a TeX vbox. We use \vtop instead of \vbox to construct the box 685% to keep its height that of a normal line. According to the rules for 686% \topskip (p.114 of the TeXbook), the glue inserted is 687% max (\topskip - \ht (first item), 0). If that height is large, 688% therefore, no glue is inserted, and the space between the headline and 689% the text is small, which looks bad. 690% 691% Another complication is that the group might be very large. This can 692% cause the glue on the previous page to be unduly stretched, because it 693% does not have much material. In this case, it's better to add an 694% explicit \vfill so that the extra space is at the bottom. The 695% threshold for doing this is if the group is more than \vfilllimit 696% percent of a page (\vfilllimit can be changed inside of @tex). 697% 698\newbox\groupbox 699\def\vfilllimit{0.7} 700% 701\envdef\group{% 702 \ifnum\catcode`\^^M=\active \else 703 \errhelp = \groupinvalidhelp 704 \errmessage{@group invalid in context where filling is enabled}% 705 \fi 706 \startsavinginserts 707 % 708 \setbox\groupbox = \vtop\bgroup 709 % Do @comment since we are called inside an environment such as 710 % @example, where each end-of-line in the input causes an 711 % end-of-line in the output. We don't want the end-of-line after 712 % the `@group' to put extra space in the output. Since @group 713 % should appear on a line by itself (according to the Texinfo 714 % manual), we don't worry about eating any user text. 715 \comment 716} 717% 718% The \vtop produces a box with normal height and large depth; thus, TeX puts 719% \baselineskip glue before it, and (when the next line of text is done) 720% \lineskip glue after it. Thus, space below is not quite equal to space 721% above. But it's pretty close. 722\def\Egroup{% 723 % To get correct interline space between the last line of the group 724 % and the first line afterwards, we have to propagate \prevdepth. 725 \endgraf % Not \par, as it may have been set to \lisppar. 726 \global\dimen1 = \prevdepth 727 \egroup % End the \vtop. 728 % \dimen0 is the vertical size of the group's box. 729 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox 730 % \dimen2 is how much space is left on the page (more or less). 731 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal 732 % if the group doesn't fit on the current page, and it's a big big 733 % group, force a page break. 734 \ifdim \dimen0 > \dimen2 735 \ifdim \pagetotal < \vfilllimit\pageheight 736 \page 737 \fi 738 \fi 739 \box\groupbox 740 \prevdepth = \dimen1 741 \checkinserts 742} 743% 744% TeX puts in an \escapechar (i.e., `@') at the beginning of the help 745% message, so this ends up printing `@group can only ...'. 746% 747\newhelp\groupinvalidhelp{% 748group can only be used in environments such as @example,^^J% 749where each line of input produces a line of output.} 750 751% @need space-in-mils 752% forces a page break if there is not space-in-mils remaining. 753 754\newdimen\mil \mil=0.001in 755 756% Old definition--didn't work. 757%\parseargdef\need{\par % 758%% This method tries to make TeX break the page naturally 759%% if the depth of the box does not fit. 760%{\baselineskip=0pt% 761%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak 762%\prevdepth=-1000pt 763%}} 764 765\parseargdef\need{% 766 % Ensure vertical mode, so we don't make a big box in the middle of a 767 % paragraph. 768 \par 769 % 770 % If the @need value is less than one line space, it's useless. 771 \dimen0 = #1\mil 772 \dimen2 = \ht\strutbox 773 \advance\dimen2 by \dp\strutbox 774 \ifdim\dimen0 > \dimen2 775 % 776 % Do a \strut just to make the height of this box be normal, so the 777 % normal leading is inserted relative to the preceding line. 778 % And a page break here is fine. 779 \vtop to #1\mil{\strut\vfil}% 780 % 781 % TeX does not even consider page breaks if a penalty added to the 782 % main vertical list is 10000 or more. But in order to see if the 783 % empty box we just added fits on the page, we must make it consider 784 % page breaks. On the other hand, we don't want to actually break the 785 % page after the empty box. So we use a penalty of 9999. 786 % 787 % There is an extremely small chance that TeX will actually break the 788 % page at this \penalty, if there are no other feasible breakpoints in 789 % sight. (If the user is using lots of big @group commands, which 790 % almost-but-not-quite fill up a page, TeX will have a hard time doing 791 % good page breaking, for example.) However, I could not construct an 792 % example where a page broke at this \penalty; if it happens in a real 793 % document, then we can reconsider our strategy. 794 \penalty9999 795 % 796 % Back up by the size of the box, whether we did a page break or not. 797 \kern -#1\mil 798 % 799 % Do not allow a page break right after this kern. 800 \nobreak 801 \fi 802} 803 804% @br forces paragraph break (and is undocumented). 805 806\let\br = \par 807 808% @page forces the start of a new page. 809% 810\def\page{\par\vfill\supereject} 811 812% @exdent text.... 813% outputs text on separate line in roman font, starting at standard page margin 814 815% This records the amount of indent in the innermost environment. 816% That's how much \exdent should take out. 817\newskip\exdentamount 818 819% This defn is used inside fill environments such as @defun. 820\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} 821 822% This defn is used inside nofill environments such as @example. 823\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount 824 \leftline{\hskip\leftskip{\rm#1}}}} 825 826% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current 827% paragraph. For more general purposes, use the \margin insertion 828% class. WHICH is `l' or `r'. 829% 830\newskip\inmarginspacing \inmarginspacing=1cm 831\def\strutdepth{\dp\strutbox} 832% 833\def\doinmargin#1#2{\strut\vadjust{% 834 \nobreak 835 \kern-\strutdepth 836 \vtop to \strutdepth{% 837 \baselineskip=\strutdepth 838 \vss 839 % if you have multiple lines of stuff to put here, you'll need to 840 % make the vbox yourself of the appropriate size. 841 \ifx#1l% 842 \llap{\ignorespaces #2\hskip\inmarginspacing}% 843 \else 844 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% 845 \fi 846 \null 847 }% 848}} 849\def\inleftmargin{\doinmargin l} 850\def\inrightmargin{\doinmargin r} 851% 852% @inmargin{TEXT [, RIGHT-TEXT]} 853% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; 854% else use TEXT for both). 855% 856\def\inmargin#1{\parseinmargin #1,,\finish} 857\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. 858 \setbox0 = \hbox{\ignorespaces #2}% 859 \ifdim\wd0 > 0pt 860 \def\lefttext{#1}% have both texts 861 \def\righttext{#2}% 862 \else 863 \def\lefttext{#1}% have only one text 864 \def\righttext{#1}% 865 \fi 866 % 867 \ifodd\pageno 868 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin 869 \else 870 \def\temp{\inleftmargin\lefttext}% 871 \fi 872 \temp 873} 874 875% @include file insert text of that file as input. 876% 877\def\include{\parseargusing\filenamecatcodes\includezzz} 878\def\includezzz#1{% 879 \pushthisfilestack 880 \def\thisfile{#1}% 881 {% 882 \makevalueexpandable 883 \def\temp{\input #1 }% 884 \expandafter 885 }\temp 886 \popthisfilestack 887} 888\def\filenamecatcodes{% 889 \catcode`\\=\other 890 \catcode`~=\other 891 \catcode`^=\other 892 \catcode`_=\other 893 \catcode`|=\other 894 \catcode`<=\other 895 \catcode`>=\other 896 \catcode`+=\other 897 \catcode`-=\other 898} 899 900\def\pushthisfilestack{% 901 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm 902} 903\def\pushthisfilestackX{% 904 \expandafter\pushthisfilestackY\thisfile\StackTerm 905} 906\def\pushthisfilestackY #1\StackTerm #2\StackTerm {% 907 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% 908} 909 910\def\popthisfilestack{\errthisfilestackempty} 911\def\errthisfilestackempty{\errmessage{Internal error: 912 the stack of filenames is empty.}} 913 914\def\thisfile{} 915 916% @center line 917% outputs that line, centered. 918% 919\parseargdef\center{% 920 \ifhmode 921 \let\next\centerH 922 \else 923 \let\next\centerV 924 \fi 925 \next{\hfil \ignorespaces#1\unskip \hfil}% 926} 927\def\centerH#1{% 928 {% 929 \hfil\break 930 \advance\hsize by -\leftskip 931 \advance\hsize by -\rightskip 932 \line{#1}% 933 \break 934 }% 935} 936\def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}} 937 938% @sp n outputs n lines of vertical space 939 940\parseargdef\sp{\vskip #1\baselineskip} 941 942% @comment ...line which is ignored... 943% @c is the same as @comment 944% @ignore ... @end ignore is another way to write a comment 945 946\def\comment{\begingroup \catcode`\^^M=\other% 947\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% 948\commentxxx} 949{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} 950 951\let\c=\comment 952 953% @paragraphindent NCHARS 954% We'll use ems for NCHARS, close enough. 955% NCHARS can also be the word `asis' or `none'. 956% We cannot feasibly implement @paragraphindent asis, though. 957% 958\def\asisword{asis} % no translation, these are keywords 959\def\noneword{none} 960% 961\parseargdef\paragraphindent{% 962 \def\temp{#1}% 963 \ifx\temp\asisword 964 \else 965 \ifx\temp\noneword 966 \defaultparindent = 0pt 967 \else 968 \defaultparindent = #1em 969 \fi 970 \fi 971 \parindent = \defaultparindent 972} 973 974% @exampleindent NCHARS 975% We'll use ems for NCHARS like @paragraphindent. 976% It seems @exampleindent asis isn't necessary, but 977% I preserve it to make it similar to @paragraphindent. 978\parseargdef\exampleindent{% 979 \def\temp{#1}% 980 \ifx\temp\asisword 981 \else 982 \ifx\temp\noneword 983 \lispnarrowing = 0pt 984 \else 985 \lispnarrowing = #1em 986 \fi 987 \fi 988} 989 990% @firstparagraphindent WORD 991% If WORD is `none', then suppress indentation of the first paragraph 992% after a section heading. If WORD is `insert', then do indent at such 993% paragraphs. 994% 995% The paragraph indentation is suppressed or not by calling 996% \suppressfirstparagraphindent, which the sectioning commands do. 997% We switch the definition of this back and forth according to WORD. 998% By default, we suppress indentation. 999% 1000\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} 1001\def\insertword{insert} 1002% 1003\parseargdef\firstparagraphindent{% 1004 \def\temp{#1}% 1005 \ifx\temp\noneword 1006 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent 1007 \else\ifx\temp\insertword 1008 \let\suppressfirstparagraphindent = \relax 1009 \else 1010 \errhelp = \EMsimple 1011 \errmessage{Unknown @firstparagraphindent option `\temp'}% 1012 \fi\fi 1013} 1014 1015% Here is how we actually suppress indentation. Redefine \everypar to 1016% \kern backwards by \parindent, and then reset itself to empty. 1017% 1018% We also make \indent itself not actually do anything until the next 1019% paragraph. 1020% 1021\gdef\dosuppressfirstparagraphindent{% 1022 \gdef\indent{% 1023 \restorefirstparagraphindent 1024 \indent 1025 }% 1026 \gdef\noindent{% 1027 \restorefirstparagraphindent 1028 \noindent 1029 }% 1030 \global\everypar = {% 1031 \kern -\parindent 1032 \restorefirstparagraphindent 1033 }% 1034} 1035 1036\gdef\restorefirstparagraphindent{% 1037 \global \let \indent = \ptexindent 1038 \global \let \noindent = \ptexnoindent 1039 \global \everypar = {}% 1040} 1041 1042 1043% @asis just yields its argument. Used with @table, for example. 1044% 1045\def\asis#1{#1} 1046 1047% @math outputs its argument in math mode. 1048% 1049% One complication: _ usually means subscripts, but it could also mean 1050% an actual _ character, as in @math{@var{some_variable} + 1}. So make 1051% _ active, and distinguish by seeing if the current family is \slfam, 1052% which is what @var uses. 1053{ 1054 \catcode`\_ = \active 1055 \gdef\mathunderscore{% 1056 \catcode`\_=\active 1057 \def_{\ifnum\fam=\slfam \_\else\sb\fi}% 1058 } 1059} 1060% Another complication: we want \\ (and @\) to output a \ character. 1061% FYI, plain.tex uses \\ as a temporary control sequence (why?), but 1062% this is not advertised and we don't care. Texinfo does not 1063% otherwise define @\. 1064% 1065% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. 1066\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} 1067% 1068\def\math{% 1069 \tex 1070 \mathunderscore 1071 \let\\ = \mathbackslash 1072 \mathactive 1073 $\finishmath 1074} 1075\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. 1076 1077% Some active characters (such as <) are spaced differently in math. 1078% We have to reset their definitions in case the @math was an argument 1079% to a command which sets the catcodes (such as @item or @section). 1080% 1081{ 1082 \catcode`^ = \active 1083 \catcode`< = \active 1084 \catcode`> = \active 1085 \catcode`+ = \active 1086 \gdef\mathactive{% 1087 \let^ = \ptexhat 1088 \let< = \ptexless 1089 \let> = \ptexgtr 1090 \let+ = \ptexplus 1091 } 1092} 1093 1094% @bullet and @minus need the same treatment as @math, just above. 1095\def\bullet{$\ptexbullet$} 1096\def\minus{$-$} 1097 1098% @dots{} outputs an ellipsis using the current font. 1099% We do .5em per period so that it has the same spacing in the cm 1100% typewriter fonts as three actual period characters; on the other hand, 1101% in other typewriter fonts three periods are wider than 1.5em. So do 1102% whichever is larger. 1103% 1104\def\dots{% 1105 \leavevmode 1106 \setbox0=\hbox{...}% get width of three periods 1107 \ifdim\wd0 > 1.5em 1108 \dimen0 = \wd0 1109 \else 1110 \dimen0 = 1.5em 1111 \fi 1112 \hbox to \dimen0{% 1113 \hskip 0pt plus.25fil 1114 .\hskip 0pt plus1fil 1115 .\hskip 0pt plus1fil 1116 .\hskip 0pt plus.5fil 1117 }% 1118} 1119 1120% @enddots{} is an end-of-sentence ellipsis. 1121% 1122\def\enddots{% 1123 \dots 1124 \spacefactor=\endofsentencespacefactor 1125} 1126 1127% @comma{} is so commas can be inserted into text without messing up 1128% Texinfo's parsing. 1129% 1130\let\comma = , 1131 1132% @refill is a no-op. 1133\let\refill=\relax 1134 1135% If working on a large document in chapters, it is convenient to 1136% be able to disable indexing, cross-referencing, and contents, for test runs. 1137% This is done with @novalidate (before @setfilename). 1138% 1139\newif\iflinks \linkstrue % by default we want the aux files. 1140\let\novalidate = \linksfalse 1141 1142% @setfilename is done at the beginning of every texinfo file. 1143% So open here the files we need to have open while reading the input. 1144% This makes it possible to make a .fmt file for texinfo. 1145\def\setfilename{% 1146 \fixbackslash % Turn off hack to swallow `\input texinfo'. 1147 \iflinks 1148 \tryauxfile 1149 % Open the new aux file. TeX will close it automatically at exit. 1150 \immediate\openout\auxfile=\jobname.aux 1151 \fi % \openindices needs to do some work in any case. 1152 \openindices 1153 \let\setfilename=\comment % Ignore extra @setfilename cmds. 1154 % 1155 % If texinfo.cnf is present on the system, read it. 1156 % Useful for site-wide @afourpaper, etc. 1157 \openin 1 texinfo.cnf 1158 \ifeof 1 \else \input texinfo.cnf \fi 1159 \closein 1 1160 % 1161 \comment % Ignore the actual filename. 1162} 1163 1164% Called from \setfilename. 1165% 1166\def\openindices{% 1167 \newindex{cp}% 1168 \newcodeindex{fn}% 1169 \newcodeindex{vr}% 1170 \newcodeindex{tp}% 1171 \newcodeindex{ky}% 1172 \newcodeindex{pg}% 1173} 1174 1175% @bye. 1176\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} 1177 1178 1179\message{pdf,} 1180% adobe `portable' document format 1181\newcount\tempnum 1182\newcount\lnkcount 1183\newtoks\filename 1184\newcount\filenamelength 1185\newcount\pgn 1186\newtoks\toksA 1187\newtoks\toksB 1188\newtoks\toksC 1189\newtoks\toksD 1190\newbox\boxA 1191\newcount\countA 1192\newif\ifpdf 1193\newif\ifpdfmakepagedest 1194 1195% when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 1196% can be set). So we test for \relax and 0 as well as \undefined, 1197% borrowed from ifpdf.sty. 1198\ifx\pdfoutput\undefined 1199\else 1200 \ifx\pdfoutput\relax 1201 \else 1202 \ifcase\pdfoutput 1203 \else 1204 \pdftrue 1205 \fi 1206 \fi 1207\fi 1208 1209% PDF uses PostScript string constants for the names of xref targets, 1210% for display in the outlines, and in other places. Thus, we have to 1211% double any backslashes. Otherwise, a name like "\node" will be 1212% interpreted as a newline (\n), followed by o, d, e. Not good. 1213% http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html 1214% (and related messages, the final outcome is that it is up to the TeX 1215% user to double the backslashes and otherwise make the string valid, so 1216% that's what we do). 1217 1218% double active backslashes. 1219% 1220{\catcode`\@=0 \catcode`\\=\active 1221 @gdef@activebackslashdouble{% 1222 @catcode`@\=@active 1223 @let\=@doublebackslash} 1224} 1225 1226% To handle parens, we must adopt a different approach, since parens are 1227% not active characters. hyperref.dtx (which has the same problem as 1228% us) handles it with this amazing macro to replace tokens. I've 1229% tinkered with it a little for texinfo, but it's definitely from there. 1230% 1231% #1 is the tokens to replace. 1232% #2 is the replacement. 1233% #3 is the control sequence with the string. 1234% 1235\def\HyPsdSubst#1#2#3{% 1236 \def\HyPsdReplace##1#1##2\END{% 1237 ##1% 1238 \ifx\\##2\\% 1239 \else 1240 #2% 1241 \HyReturnAfterFi{% 1242 \HyPsdReplace##2\END 1243 }% 1244 \fi 1245 }% 1246 \xdef#3{\expandafter\HyPsdReplace#3#1\END}% 1247} 1248\long\def\HyReturnAfterFi#1\fi{\fi#1} 1249 1250% #1 is a control sequence in which to do the replacements. 1251\def\backslashparens#1{% 1252 \xdef#1{#1}% redefine it as its expansion; the definition is simply 1253 % \lastnode when called from \setref -> \pdfmkdest. 1254 \HyPsdSubst{(}{\realbackslash(}{#1}% 1255 \HyPsdSubst{)}{\realbackslash)}{#1}% 1256} 1257 1258\newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images 1259with PDF output, and none of those formats could be found. (.eps cannot 1260be supported due to the design of the PDF format; use regular TeX (DVI 1261output) for that.)} 1262 1263\ifpdf 1264 \input pdfcolor 1265 \pdfcatalog{/PageMode /UseOutlines}% 1266 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto). 1267 \def\dopdfimage#1#2#3{% 1268 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% 1269 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% 1270 % 1271 % pdftex (and the PDF format) support .png, .jpg, .pdf (among 1272 % others). Let's try in that order. 1273 \let\pdfimgext=\empty 1274 \begingroup 1275 \openin 1 #1.png \ifeof 1 1276 \openin 1 #1.jpg \ifeof 1 1277 \openin 1 #1.jpeg \ifeof 1 1278 \openin 1 #1.JPG \ifeof 1 1279 \openin 1 #1.pdf \ifeof 1 1280 \errhelp = \nopdfimagehelp 1281 \errmessage{Could not find image file #1 for pdf}% 1282 \else 1283 \gdef\pdfimgext{pdf}% 1284 \fi 1285 \else 1286 \gdef\pdfimgext{JPG}% 1287 \fi 1288 \else 1289 \gdef\pdfimgext{jpeg}% 1290 \fi 1291 \else 1292 \gdef\pdfimgext{jpg}% 1293 \fi 1294 \else 1295 \gdef\pdfimgext{png}% 1296 \fi 1297 \closein 1 1298 \endgroup 1299 % 1300 % without \immediate, pdftex seg faults when the same image is 1301 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) 1302 \ifnum\pdftexversion < 14 1303 \immediate\pdfimage 1304 \else 1305 \immediate\pdfximage 1306 \fi 1307 \ifdim \wd0 >0pt width \imagewidth \fi 1308 \ifdim \wd2 >0pt height \imageheight \fi 1309 \ifnum\pdftexversion<13 1310 #1.\pdfimgext 1311 \else 1312 {#1.\pdfimgext}% 1313 \fi 1314 \ifnum\pdftexversion < 14 \else 1315 \pdfrefximage \pdflastximage 1316 \fi} 1317 \def\pdfmkdest#1{{% 1318 % We have to set dummies so commands such as @code, and characters 1319 % such as \, aren't expanded when present in a section title. 1320 \atdummies 1321 \activebackslashdouble 1322 \def\pdfdestname{#1}% 1323 \backslashparens\pdfdestname 1324 \pdfdest name{\pdfdestname} xyz% 1325 }}% 1326 % 1327 % used to mark target names; must be expandable. 1328 \def\pdfmkpgn#1{#1}% 1329 % 1330 \let\linkcolor = \Blue % was Cyan, but that seems light? 1331 \def\endlink{\Black\pdfendlink} 1332 % Adding outlines to PDF; macros for calculating structure of outlines 1333 % come from Petr Olsak 1334 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% 1335 \else \csname#1\endcsname \fi} 1336 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax 1337 \advance\tempnum by 1 1338 \expandafter\xdef\csname#1\endcsname{\the\tempnum}} 1339 % 1340 % #1 is the section text, which is what will be displayed in the 1341 % outline by the pdf viewer. #2 is the pdf expression for the number 1342 % of subentries (or empty, for subsubsections). #3 is the node text, 1343 % which might be empty if this toc entry had no corresponding node. 1344 % #4 is the page number 1345 % 1346 \def\dopdfoutline#1#2#3#4{% 1347 % Generate a link to the node text if that exists; else, use the 1348 % page number. We could generate a destination for the section 1349 % text in the case where a section has no node, but it doesn't 1350 % seem worth the trouble, since most documents are normally structured. 1351 \def\pdfoutlinedest{#3}% 1352 \ifx\pdfoutlinedest\empty 1353 \def\pdfoutlinedest{#4}% 1354 \else 1355 % Doubled backslashes in the name. 1356 {\activebackslashdouble \xdef\pdfoutlinedest{#3}% 1357 \backslashparens\pdfoutlinedest}% 1358 \fi 1359 % 1360 % Also double the backslashes in the display string. 1361 {\activebackslashdouble \xdef\pdfoutlinetext{#1}% 1362 \backslashparens\pdfoutlinetext}% 1363 % 1364 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}% 1365 } 1366 % 1367 \def\pdfmakeoutlines{% 1368 \begingroup 1369 % Thanh's hack / proper braces in bookmarks 1370 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace 1371 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace 1372 % 1373 % Read toc silently, to get counts of subentries for \pdfoutline. 1374 \def\numchapentry##1##2##3##4{% 1375 \def\thischapnum{##2}% 1376 \def\thissecnum{0}% 1377 \def\thissubsecnum{0}% 1378 }% 1379 \def\numsecentry##1##2##3##4{% 1380 \advancenumber{chap\thischapnum}% 1381 \def\thissecnum{##2}% 1382 \def\thissubsecnum{0}% 1383 }% 1384 \def\numsubsecentry##1##2##3##4{% 1385 \advancenumber{sec\thissecnum}% 1386 \def\thissubsecnum{##2}% 1387 }% 1388 \def\numsubsubsecentry##1##2##3##4{% 1389 \advancenumber{subsec\thissubsecnum}% 1390 }% 1391 \def\thischapnum{0}% 1392 \def\thissecnum{0}% 1393 \def\thissubsecnum{0}% 1394 % 1395 % use \def rather than \let here because we redefine \chapentry et 1396 % al. a second time, below. 1397 \def\appentry{\numchapentry}% 1398 \def\appsecentry{\numsecentry}% 1399 \def\appsubsecentry{\numsubsecentry}% 1400 \def\appsubsubsecentry{\numsubsubsecentry}% 1401 \def\unnchapentry{\numchapentry}% 1402 \def\unnsecentry{\numsecentry}% 1403 \def\unnsubsecentry{\numsubsecentry}% 1404 \def\unnsubsubsecentry{\numsubsubsecentry}% 1405 \readdatafile{toc}% 1406 % 1407 % Read toc second time, this time actually producing the outlines. 1408 % The `-' means take the \expnumber as the absolute number of 1409 % subentries, which we calculated on our first read of the .toc above. 1410 % 1411 % We use the node names as the destinations. 1412 \def\numchapentry##1##2##3##4{% 1413 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% 1414 \def\numsecentry##1##2##3##4{% 1415 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% 1416 \def\numsubsecentry##1##2##3##4{% 1417 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% 1418 \def\numsubsubsecentry##1##2##3##4{% count is always zero 1419 \dopdfoutline{##1}{}{##3}{##4}}% 1420 % 1421 % PDF outlines are displayed using system fonts, instead of 1422 % document fonts. Therefore we cannot use special characters, 1423 % since the encoding is unknown. For example, the eogonek from 1424 % Latin 2 (0xea) gets translated to a | character. Info from 1425 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. 1426 % 1427 % xx to do this right, we have to translate 8-bit characters to 1428 % their "best" equivalent, based on the @documentencoding. Right 1429 % now, I guess we'll just let the pdf reader have its way. 1430 \indexnofonts 1431 \setupdatafile 1432 \catcode`\\=\active \otherbackslash 1433 \input \jobname.toc 1434 \endgroup 1435 } 1436 % 1437 \def\skipspaces#1{\def\PP{#1}\def\D{|}% 1438 \ifx\PP\D\let\nextsp\relax 1439 \else\let\nextsp\skipspaces 1440 \ifx\p\space\else\addtokens{\filename}{\PP}% 1441 \advance\filenamelength by 1 1442 \fi 1443 \fi 1444 \nextsp} 1445 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} 1446 \ifnum\pdftexversion < 14 1447 \let \startlink \pdfannotlink 1448 \else 1449 \let \startlink \pdfstartlink 1450 \fi 1451 % make a live url in pdf output. 1452 \def\pdfurl#1{% 1453 \begingroup 1454 % it seems we really need yet another set of dummies; have not 1455 % tried to figure out what each command should do in the context 1456 % of @url. for now, just make @/ a no-op, that's the only one 1457 % people have actually reported a problem with. 1458 % 1459 \normalturnoffactive 1460 \def\@{@}% 1461 \let\/=\empty 1462 \makevalueexpandable 1463 \leavevmode\Red 1464 \startlink attr{/Border [0 0 0]}% 1465 user{/Subtype /Link /A << /S /URI /URI (#1) >>}% 1466 \endgroup} 1467 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} 1468 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} 1469 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} 1470 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} 1471 \def\maketoks{% 1472 \expandafter\poptoks\the\toksA|ENDTOKS|\relax 1473 \ifx\first0\adn0 1474 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 1475 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 1476 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 1477 \else 1478 \ifnum0=\countA\else\makelink\fi 1479 \ifx\first.\let\next=\done\else 1480 \let\next=\maketoks 1481 \addtokens{\toksB}{\the\toksD} 1482 \ifx\first,\addtokens{\toksB}{\space}\fi 1483 \fi 1484 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 1485 \next} 1486 \def\makelink{\addtokens{\toksB}% 1487 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} 1488 \def\pdflink#1{% 1489 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} 1490 \linkcolor #1\endlink} 1491 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} 1492\else 1493 \let\pdfmkdest = \gobble 1494 \let\pdfurl = \gobble 1495 \let\endlink = \relax 1496 \let\linkcolor = \relax 1497 \let\pdfmakeoutlines = \relax 1498\fi % \ifx\pdfoutput 1499 1500 1501\message{fonts,} 1502 1503% Change the current font style to #1, remembering it in \curfontstyle. 1504% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in 1505% italics, not bold italics. 1506% 1507\def\setfontstyle#1{% 1508 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. 1509 \csname ten#1\endcsname % change the current font 1510} 1511 1512% Select #1 fonts with the current style. 1513% 1514\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} 1515 1516\def\rm{\fam=0 \setfontstyle{rm}} 1517\def\it{\fam=\itfam \setfontstyle{it}} 1518\def\sl{\fam=\slfam \setfontstyle{sl}} 1519\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} 1520\def\tt{\fam=\ttfam \setfontstyle{tt}} 1521 1522% Texinfo sort of supports the sans serif font style, which plain TeX does not. 1523% So we set up a \sf. 1524\newfam\sffam 1525\def\sf{\fam=\sffam \setfontstyle{sf}} 1526\let\li = \sf % Sometimes we call it \li, not \sf. 1527 1528% We don't need math for this font style. 1529\def\ttsl{\setfontstyle{ttsl}} 1530 1531 1532% Default leading. 1533\newdimen\textleading \textleading = 13.2pt 1534 1535% Set the baselineskip to #1, and the lineskip and strut size 1536% correspondingly. There is no deep meaning behind these magic numbers 1537% used as factors; they just match (closely enough) what Knuth defined. 1538% 1539\def\lineskipfactor{.08333} 1540\def\strutheightpercent{.70833} 1541\def\strutdepthpercent {.29167} 1542% 1543\def\setleading#1{% 1544 \normalbaselineskip = #1\relax 1545 \normallineskip = \lineskipfactor\normalbaselineskip 1546 \normalbaselines 1547 \setbox\strutbox =\hbox{% 1548 \vrule width0pt height\strutheightpercent\baselineskip 1549 depth \strutdepthpercent \baselineskip 1550 }% 1551} 1552 1553 1554% Set the font macro #1 to the font named #2, adding on the 1555% specified font prefix (normally `cm'). 1556% #3 is the font's design size, #4 is a scale factor 1557\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} 1558 1559 1560% Use cm as the default font prefix. 1561% To specify the font prefix, you must define \fontprefix 1562% before you read in texinfo.tex. 1563\ifx\fontprefix\undefined 1564\def\fontprefix{cm} 1565\fi 1566% Support font families that don't use the same naming scheme as CM. 1567\def\rmshape{r} 1568\def\rmbshape{bx} %where the normal face is bold 1569\def\bfshape{b} 1570\def\bxshape{bx} 1571\def\ttshape{tt} 1572\def\ttbshape{tt} 1573\def\ttslshape{sltt} 1574\def\itshape{ti} 1575\def\itbshape{bxti} 1576\def\slshape{sl} 1577\def\slbshape{bxsl} 1578\def\sfshape{ss} 1579\def\sfbshape{ss} 1580\def\scshape{csc} 1581\def\scbshape{csc} 1582 1583% Definitions for a main text size of 11pt. This is the default in 1584% Texinfo. 1585% 1586\def\definetextfontsizexi{ 1587% Text fonts (11.2pt, magstep1). 1588\def\textnominalsize{11pt} 1589\edef\mainmagstep{\magstephalf} 1590\setfont\textrm\rmshape{10}{\mainmagstep} 1591\setfont\texttt\ttshape{10}{\mainmagstep} 1592\setfont\textbf\bfshape{10}{\mainmagstep} 1593\setfont\textit\itshape{10}{\mainmagstep} 1594\setfont\textsl\slshape{10}{\mainmagstep} 1595\setfont\textsf\sfshape{10}{\mainmagstep} 1596\setfont\textsc\scshape{10}{\mainmagstep} 1597\setfont\textttsl\ttslshape{10}{\mainmagstep} 1598\font\texti=cmmi10 scaled \mainmagstep 1599\font\textsy=cmsy10 scaled \mainmagstep 1600 1601% A few fonts for @defun names and args. 1602\setfont\defbf\bfshape{10}{\magstep1} 1603\setfont\deftt\ttshape{10}{\magstep1} 1604\setfont\defttsl\ttslshape{10}{\magstep1} 1605\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} 1606 1607% Fonts for indices, footnotes, small examples (9pt). 1608\def\smallnominalsize{9pt} 1609\setfont\smallrm\rmshape{9}{1000} 1610\setfont\smalltt\ttshape{9}{1000} 1611\setfont\smallbf\bfshape{10}{900} 1612\setfont\smallit\itshape{9}{1000} 1613\setfont\smallsl\slshape{9}{1000} 1614\setfont\smallsf\sfshape{9}{1000} 1615\setfont\smallsc\scshape{10}{900} 1616\setfont\smallttsl\ttslshape{10}{900} 1617\font\smalli=cmmi9 1618\font\smallsy=cmsy9 1619 1620% Fonts for small examples (8pt). 1621\def\smallernominalsize{8pt} 1622\setfont\smallerrm\rmshape{8}{1000} 1623\setfont\smallertt\ttshape{8}{1000} 1624\setfont\smallerbf\bfshape{10}{800} 1625\setfont\smallerit\itshape{8}{1000} 1626\setfont\smallersl\slshape{8}{1000} 1627\setfont\smallersf\sfshape{8}{1000} 1628\setfont\smallersc\scshape{10}{800} 1629\setfont\smallerttsl\ttslshape{10}{800} 1630\font\smalleri=cmmi8 1631\font\smallersy=cmsy8 1632 1633% Fonts for title page (20.4pt): 1634\def\titlenominalsize{20pt} 1635\setfont\titlerm\rmbshape{12}{\magstep3} 1636\setfont\titleit\itbshape{10}{\magstep4} 1637\setfont\titlesl\slbshape{10}{\magstep4} 1638\setfont\titlett\ttbshape{12}{\magstep3} 1639\setfont\titlettsl\ttslshape{10}{\magstep4} 1640\setfont\titlesf\sfbshape{17}{\magstep1} 1641\let\titlebf=\titlerm 1642\setfont\titlesc\scbshape{10}{\magstep4} 1643\font\titlei=cmmi12 scaled \magstep3 1644\font\titlesy=cmsy10 scaled \magstep4 1645\def\authorrm{\secrm} 1646\def\authortt{\sectt} 1647 1648% Chapter (and unnumbered) fonts (17.28pt). 1649\def\chapnominalsize{17pt} 1650\setfont\chaprm\rmbshape{12}{\magstep2} 1651\setfont\chapit\itbshape{10}{\magstep3} 1652\setfont\chapsl\slbshape{10}{\magstep3} 1653\setfont\chaptt\ttbshape{12}{\magstep2} 1654\setfont\chapttsl\ttslshape{10}{\magstep3} 1655\setfont\chapsf\sfbshape{17}{1000} 1656\let\chapbf=\chaprm 1657\setfont\chapsc\scbshape{10}{\magstep3} 1658\font\chapi=cmmi12 scaled \magstep2 1659\font\chapsy=cmsy10 scaled \magstep3 1660 1661% Section fonts (14.4pt). 1662\def\secnominalsize{14pt} 1663\setfont\secrm\rmbshape{12}{\magstep1} 1664\setfont\secit\itbshape{10}{\magstep2} 1665\setfont\secsl\slbshape{10}{\magstep2} 1666\setfont\sectt\ttbshape{12}{\magstep1} 1667\setfont\secttsl\ttslshape{10}{\magstep2} 1668\setfont\secsf\sfbshape{12}{\magstep1} 1669\let\secbf\secrm 1670\setfont\secsc\scbshape{10}{\magstep2} 1671\font\seci=cmmi12 scaled \magstep1 1672\font\secsy=cmsy10 scaled \magstep2 1673 1674% Subsection fonts (13.15pt). 1675\def\ssecnominalsize{13pt} 1676\setfont\ssecrm\rmbshape{12}{\magstephalf} 1677\setfont\ssecit\itbshape{10}{1315} 1678\setfont\ssecsl\slbshape{10}{1315} 1679\setfont\ssectt\ttbshape{12}{\magstephalf} 1680\setfont\ssecttsl\ttslshape{10}{1315} 1681\setfont\ssecsf\sfbshape{12}{\magstephalf} 1682\let\ssecbf\ssecrm 1683\setfont\ssecsc\scbshape{10}{1315} 1684\font\sseci=cmmi12 scaled \magstephalf 1685\font\ssecsy=cmsy10 scaled 1315 1686 1687% Reduced fonts for @acro in text (10pt). 1688\def\reducednominalsize{10pt} 1689\setfont\reducedrm\rmshape{10}{1000} 1690\setfont\reducedtt\ttshape{10}{1000} 1691\setfont\reducedbf\bfshape{10}{1000} 1692\setfont\reducedit\itshape{10}{1000} 1693\setfont\reducedsl\slshape{10}{1000} 1694\setfont\reducedsf\sfshape{10}{1000} 1695\setfont\reducedsc\scshape{10}{1000} 1696\setfont\reducedttsl\ttslshape{10}{1000} 1697\font\reducedi=cmmi10 1698\font\reducedsy=cmsy10 1699 1700% reset the current fonts 1701\textfonts 1702\rm 1703} % end of 11pt text font size definitions 1704 1705 1706% Definitions to make the main text be 10pt Computer Modern, with 1707% section, chapter, etc., sizes following suit. This is for the GNU 1708% Press printing of the Emacs 22 manual. Maybe other manuals in the 1709% future. Used with @smallbook, which sets the leading to 12pt. 1710% 1711\def\definetextfontsizex{% 1712% Text fonts (10pt). 1713\def\textnominalsize{10pt} 1714\edef\mainmagstep{1000} 1715\setfont\textrm\rmshape{10}{\mainmagstep} 1716\setfont\texttt\ttshape{10}{\mainmagstep} 1717\setfont\textbf\bfshape{10}{\mainmagstep} 1718\setfont\textit\itshape{10}{\mainmagstep} 1719\setfont\textsl\slshape{10}{\mainmagstep} 1720\setfont\textsf\sfshape{10}{\mainmagstep} 1721\setfont\textsc\scshape{10}{\mainmagstep} 1722\setfont\textttsl\ttslshape{10}{\mainmagstep} 1723\font\texti=cmmi10 scaled \mainmagstep 1724\font\textsy=cmsy10 scaled \mainmagstep 1725 1726% A few fonts for @defun names and args. 1727\setfont\defbf\bfshape{10}{\magstephalf} 1728\setfont\deftt\ttshape{10}{\magstephalf} 1729\setfont\defttsl\ttslshape{10}{\magstephalf} 1730\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} 1731 1732% Fonts for indices, footnotes, small examples (9pt). 1733\def\smallnominalsize{9pt} 1734\setfont\smallrm\rmshape{9}{1000} 1735\setfont\smalltt\ttshape{9}{1000} 1736\setfont\smallbf\bfshape{10}{900} 1737\setfont\smallit\itshape{9}{1000} 1738\setfont\smallsl\slshape{9}{1000} 1739\setfont\smallsf\sfshape{9}{1000} 1740\setfont\smallsc\scshape{10}{900} 1741\setfont\smallttsl\ttslshape{10}{900} 1742\font\smalli=cmmi9 1743\font\smallsy=cmsy9 1744 1745% Fonts for small examples (8pt). 1746\def\smallernominalsize{8pt} 1747\setfont\smallerrm\rmshape{8}{1000} 1748\setfont\smallertt\ttshape{8}{1000} 1749\setfont\smallerbf\bfshape{10}{800} 1750\setfont\smallerit\itshape{8}{1000} 1751\setfont\smallersl\slshape{8}{1000} 1752\setfont\smallersf\sfshape{8}{1000} 1753\setfont\smallersc\scshape{10}{800} 1754\setfont\smallerttsl\ttslshape{10}{800} 1755\font\smalleri=cmmi8 1756\font\smallersy=cmsy8 1757 1758% Fonts for title page (20.4pt): 1759\def\titlenominalsize{20pt} 1760\setfont\titlerm\rmbshape{12}{\magstep3} 1761\setfont\titleit\itbshape{10}{\magstep4} 1762\setfont\titlesl\slbshape{10}{\magstep4} 1763\setfont\titlett\ttbshape{12}{\magstep3} 1764\setfont\titlettsl\ttslshape{10}{\magstep4} 1765\setfont\titlesf\sfbshape{17}{\magstep1} 1766\let\titlebf=\titlerm 1767\setfont\titlesc\scbshape{10}{\magstep4} 1768\font\titlei=cmmi12 scaled \magstep3 1769\font\titlesy=cmsy10 scaled \magstep4 1770\def\authorrm{\secrm} 1771\def\authortt{\sectt} 1772 1773% Chapter fonts (14.4pt). 1774\def\chapnominalsize{14pt} 1775\setfont\chaprm\rmbshape{12}{\magstep1} 1776\setfont\chapit\itbshape{10}{\magstep2} 1777\setfont\chapsl\slbshape{10}{\magstep2} 1778\setfont\chaptt\ttbshape{12}{\magstep1} 1779\setfont\chapttsl\ttslshape{10}{\magstep2} 1780\setfont\chapsf\sfbshape{12}{\magstep1} 1781\let\chapbf\chaprm 1782\setfont\chapsc\scbshape{10}{\magstep2} 1783\font\chapi=cmmi12 scaled \magstep1 1784\font\chapsy=cmsy10 scaled \magstep2 1785 1786% Section fonts (12pt). 1787\def\secnominalsize{12pt} 1788\setfont\secrm\rmbshape{12}{1000} 1789\setfont\secit\itbshape{10}{\magstep1} 1790\setfont\secsl\slbshape{10}{\magstep1} 1791\setfont\sectt\ttbshape{12}{1000} 1792\setfont\secttsl\ttslshape{10}{\magstep1} 1793\setfont\secsf\sfbshape{12}{1000} 1794\let\secbf\secrm 1795\setfont\secsc\scbshape{10}{\magstep1} 1796\font\seci=cmmi12 1797\font\secsy=cmsy10 scaled \magstep1 1798 1799% Subsection fonts (10pt). 1800\def\ssecnominalsize{10pt} 1801\setfont\ssecrm\rmbshape{10}{1000} 1802\setfont\ssecit\itbshape{10}{1000} 1803\setfont\ssecsl\slbshape{10}{1000} 1804\setfont\ssectt\ttbshape{10}{1000} 1805\setfont\ssecttsl\ttslshape{10}{1000} 1806\setfont\ssecsf\sfbshape{10}{1000} 1807\let\ssecbf\ssecrm 1808\setfont\ssecsc\scbshape{10}{1000} 1809\font\sseci=cmmi10 1810\font\ssecsy=cmsy10 1811 1812% Reduced fonts for @acro in text (9pt). 1813\def\reducednominalsize{9pt} 1814\setfont\reducedrm\rmshape{9}{1000} 1815\setfont\reducedtt\ttshape{9}{1000} 1816\setfont\reducedbf\bfshape{10}{900} 1817\setfont\reducedit\itshape{9}{1000} 1818\setfont\reducedsl\slshape{9}{1000} 1819\setfont\reducedsf\sfshape{9}{1000} 1820\setfont\reducedsc\scshape{10}{900} 1821\setfont\reducedttsl\ttslshape{10}{900} 1822\font\reducedi=cmmi9 1823\font\reducedsy=cmsy9 1824 1825% reduce space between paragraphs 1826\divide\parskip by 2 1827 1828% reset the current fonts 1829\textfonts 1830\rm 1831} % end of 10pt text font size definitions 1832 1833 1834% We provide the user-level command 1835% @fonttextsize 10 1836% (or 11) to redefine the text font size. pt is assumed. 1837% 1838\def\xword{10} 1839\def\xiword{11} 1840% 1841\parseargdef\fonttextsize{% 1842 \def\textsizearg{#1}% 1843 \wlog{doing @fonttextsize \textsizearg}% 1844 % 1845 % Set \globaldefs so that documents can use this inside @tex, since 1846 % makeinfo 4.8 does not support it, but we need it nonetheless. 1847 % 1848 \begingroup \globaldefs=1 1849 \ifx\textsizearg\xword \definetextfontsizex 1850 \else \ifx\textsizearg\xiword \definetextfontsizexi 1851 \else 1852 \errhelp=\EMsimple 1853 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'} 1854 \fi\fi 1855 \endgroup 1856} 1857 1858 1859% In order for the font changes to affect most math symbols and letters, 1860% we have to define the \textfont of the standard families. Since 1861% texinfo doesn't allow for producing subscripts and superscripts except 1862% in the main text, we don't bother to reset \scriptfont and 1863% \scriptscriptfont (which would also require loading a lot more fonts). 1864% 1865\def\resetmathfonts{% 1866 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy 1867 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf 1868 \textfont\ttfam=\tentt \textfont\sffam=\tensf 1869} 1870 1871% The font-changing commands redefine the meanings of \tenSTYLE, instead 1872% of just \STYLE. We do this because \STYLE needs to also set the 1873% current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire 1874% \tenSTYLE to set the current font. 1875% 1876% Each font-changing command also sets the names \lsize (one size lower) 1877% and \lllsize (three sizes lower). These relative commands are used in 1878% the LaTeX logo and acronyms. 1879% 1880% This all needs generalizing, badly. 1881% 1882\def\textfonts{% 1883 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl 1884 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc 1885 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy 1886 \let\tenttsl=\textttsl 1887 \def\curfontsize{text}% 1888 \def\lsize{reduced}\def\lllsize{smaller}% 1889 \resetmathfonts \setleading{\textleading}} 1890\def\titlefonts{% 1891 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl 1892 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc 1893 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy 1894 \let\tenttsl=\titlettsl 1895 \def\curfontsize{title}% 1896 \def\lsize{chap}\def\lllsize{subsec}% 1897 \resetmathfonts \setleading{25pt}} 1898\def\titlefont#1{{\titlefonts\rm #1}} 1899\def\chapfonts{% 1900 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl 1901 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc 1902 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy 1903 \let\tenttsl=\chapttsl 1904 \def\curfontsize{chap}% 1905 \def\lsize{sec}\def\lllsize{text}% 1906 \resetmathfonts \setleading{19pt}} 1907\def\secfonts{% 1908 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl 1909 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc 1910 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy 1911 \let\tenttsl=\secttsl 1912 \def\curfontsize{sec}% 1913 \def\lsize{subsec}\def\lllsize{reduced}% 1914 \resetmathfonts \setleading{16pt}} 1915\def\subsecfonts{% 1916 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl 1917 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc 1918 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy 1919 \let\tenttsl=\ssecttsl 1920 \def\curfontsize{ssec}% 1921 \def\lsize{text}\def\lllsize{small}% 1922 \resetmathfonts \setleading{15pt}} 1923\let\subsubsecfonts = \subsecfonts 1924\def\reducedfonts{% 1925 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl 1926 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc 1927 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy 1928 \let\tenttsl=\reducedttsl 1929 \def\curfontsize{reduced}% 1930 \def\lsize{small}\def\lllsize{smaller}% 1931 \resetmathfonts \setleading{10.5pt}} 1932\def\smallfonts{% 1933 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl 1934 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc 1935 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy 1936 \let\tenttsl=\smallttsl 1937 \def\curfontsize{small}% 1938 \def\lsize{smaller}\def\lllsize{smaller}% 1939 \resetmathfonts \setleading{10.5pt}} 1940\def\smallerfonts{% 1941 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl 1942 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc 1943 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy 1944 \let\tenttsl=\smallerttsl 1945 \def\curfontsize{smaller}% 1946 \def\lsize{smaller}\def\lllsize{smaller}% 1947 \resetmathfonts \setleading{9.5pt}} 1948 1949% Set the fonts to use with the @small... environments. 1950\let\smallexamplefonts = \smallfonts 1951 1952% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample 1953% can fit this many characters: 1954% 8.5x11=86 smallbook=72 a4=90 a5=69 1955% If we use \scriptfonts (8pt), then we can fit this many characters: 1956% 8.5x11=90+ smallbook=80 a4=90+ a5=77 1957% For me, subjectively, the few extra characters that fit aren't worth 1958% the additional smallness of 8pt. So I'm making the default 9pt. 1959% 1960% By the way, for comparison, here's what fits with @example (10pt): 1961% 8.5x11=71 smallbook=60 a4=75 a5=58 1962% 1963% I wish the USA used A4 paper. 1964% --karl, 24jan03. 1965 1966 1967% Set up the default fonts, so we can use them for creating boxes. 1968% 1969\definetextfontsizexi 1970 1971% Define these so they can be easily changed for other fonts. 1972\def\angleleft{$\langle$} 1973\def\angleright{$\rangle$} 1974 1975% Count depth in font-changes, for error checks 1976\newcount\fontdepth \fontdepth=0 1977 1978% Fonts for short table of contents. 1979\setfont\shortcontrm\rmshape{12}{1000} 1980\setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12 1981\setfont\shortcontsl\slshape{12}{1000} 1982\setfont\shortconttt\ttshape{12}{1000} 1983 1984%% Add scribe-like font environments, plus @l for inline lisp (usually sans 1985%% serif) and @ii for TeX italic 1986 1987% \smartitalic{ARG} outputs arg in italics, followed by an italic correction 1988% unless the following character is such as not to need one. 1989\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else 1990 \ptexslash\fi\fi\fi} 1991\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} 1992\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} 1993 1994% like \smartslanted except unconditionally uses \ttsl. 1995% @var is set to this for defun arguments. 1996\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} 1997 1998% like \smartslanted except unconditionally use \sl. We never want 1999% ttsl for book titles, do we? 2000\def\cite#1{{\sl #1}\futurelet\next\smartitalicx} 2001 2002\let\i=\smartitalic 2003\let\slanted=\smartslanted 2004\let\var=\smartslanted 2005\let\dfn=\smartslanted 2006\let\emph=\smartitalic 2007 2008% @b, explicit bold. 2009\def\b#1{{\bf #1}} 2010\let\strong=\b 2011 2012% @sansserif, explicit sans. 2013\def\sansserif#1{{\sf #1}} 2014 2015% We can't just use \exhyphenpenalty, because that only has effect at 2016% the end of a paragraph. Restore normal hyphenation at the end of the 2017% group within which \nohyphenation is presumably called. 2018% 2019\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} 2020\def\restorehyphenation{\hyphenchar\font = `- } 2021 2022% Set sfcode to normal for the chars that usually have another value. 2023% Can't use plain's \frenchspacing because it uses the `\x notation, and 2024% sometimes \x has an active definition that messes things up. 2025% 2026\catcode`@=11 2027 \def\plainfrenchspacing{% 2028 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m 2029 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m 2030 \def\endofsentencespacefactor{1000}% for @. and friends 2031 } 2032 \def\plainnonfrenchspacing{% 2033 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000 2034 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250 2035 \def\endofsentencespacefactor{3000}% for @. and friends 2036 } 2037\catcode`@=\other 2038\def\endofsentencespacefactor{3000}% default 2039 2040\def\t#1{% 2041 {\tt \rawbackslash \plainfrenchspacing #1}% 2042 \null 2043} 2044\def\samp#1{`\tclose{#1}'\null} 2045\setfont\keyrm\rmshape{8}{1000} 2046\font\keysy=cmsy9 2047\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% 2048 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% 2049 \vbox{\hrule\kern-0.4pt 2050 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% 2051 \kern-0.4pt\hrule}% 2052 \kern-.06em\raise0.4pt\hbox{\angleright}}}} 2053\def\key #1{{\nohyphenation \uppercase{#1}}\null} 2054% The old definition, with no lozenge: 2055%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} 2056\def\ctrl #1{{\tt \rawbackslash \hat}#1} 2057 2058% @file, @option are the same as @samp. 2059\let\file=\samp 2060\let\option=\samp 2061 2062% @code is a modification of @t, 2063% which makes spaces the same size as normal in the surrounding text. 2064\def\tclose#1{% 2065 {% 2066 % Change normal interword space to be same as for the current font. 2067 \spaceskip = \fontdimen2\font 2068 % 2069 % Switch to typewriter. 2070 \tt 2071 % 2072 % But `\ ' produces the large typewriter interword space. 2073 \def\ {{\spaceskip = 0pt{} }}% 2074 % 2075 % Turn off hyphenation. 2076 \nohyphenation 2077 % 2078 \rawbackslash 2079 \plainfrenchspacing 2080 #1% 2081 }% 2082 \null 2083} 2084 2085% We *must* turn on hyphenation at `-' and `_' in @code. 2086% Otherwise, it is too hard to avoid overfull hboxes 2087% in the Emacs manual, the Library manual, etc. 2088 2089% Unfortunately, TeX uses one parameter (\hyphenchar) to control 2090% both hyphenation at - and hyphenation within words. 2091% We must therefore turn them both off (\tclose does that) 2092% and arrange explicitly to hyphenate at a dash. 2093% -- rms. 2094{ 2095 \catcode`\-=\active \catcode`\_=\active 2096 \catcode`\'=\active \catcode`\`=\active 2097 % 2098 \global\def\code{\begingroup 2099 \catcode\rquoteChar=\active \catcode\lquoteChar=\active 2100 \let'\codequoteright \let`\codequoteleft 2101 % 2102 \catcode\dashChar=\active \catcode\underChar=\active 2103 \ifallowcodebreaks 2104 \let-\codedash 2105 \let_\codeunder 2106 \else 2107 \let-\realdash 2108 \let_\realunder 2109 \fi 2110 \codex 2111 } 2112} 2113 2114\def\realdash{-} 2115\def\codedash{-\discretionary{}{}{}} 2116\def\codeunder{% 2117 % this is all so @math{@code{var_name}+1} can work. In math mode, _ 2118 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) 2119 % will therefore expand the active definition of _, which is us 2120 % (inside @code that is), therefore an endless loop. 2121 \ifusingtt{\ifmmode 2122 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. 2123 \else\normalunderscore \fi 2124 \discretionary{}{}{}}% 2125 {\_}% 2126} 2127\def\codex #1{\tclose{#1}\endgroup} 2128 2129% An additional complication: the above will allow breaks after, e.g., 2130% each of the four underscores in __typeof__. This is undesirable in 2131% some manuals, especially if they don't have long identifiers in 2132% general. @allowcodebreaks provides a way to control this. 2133% 2134\newif\ifallowcodebreaks \allowcodebreakstrue 2135 2136\def\keywordtrue{true} 2137\def\keywordfalse{false} 2138 2139\parseargdef\allowcodebreaks{% 2140 \def\txiarg{#1}% 2141 \ifx\txiarg\keywordtrue 2142 \allowcodebreakstrue 2143 \else\ifx\txiarg\keywordfalse 2144 \allowcodebreaksfalse 2145 \else 2146 \errhelp = \EMsimple 2147 \errmessage{Unknown @allowcodebreaks option `\txiarg'}% 2148 \fi\fi 2149} 2150 2151% @kbd is like @code, except that if the argument is just one @key command, 2152% then @kbd has no effect. 2153 2154% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), 2155% `example' (@kbd uses ttsl only inside of @example and friends), 2156% or `code' (@kbd uses normal tty font always). 2157\parseargdef\kbdinputstyle{% 2158 \def\txiarg{#1}% 2159 \ifx\txiarg\worddistinct 2160 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% 2161 \else\ifx\txiarg\wordexample 2162 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% 2163 \else\ifx\txiarg\wordcode 2164 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% 2165 \else 2166 \errhelp = \EMsimple 2167 \errmessage{Unknown @kbdinputstyle option `\txiarg'}% 2168 \fi\fi\fi 2169} 2170\def\worddistinct{distinct} 2171\def\wordexample{example} 2172\def\wordcode{code} 2173 2174% Default is `distinct.' 2175\kbdinputstyle distinct 2176 2177\def\xkey{\key} 2178\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% 2179\ifx\one\xkey\ifx\threex\three \key{#2}% 2180\else{\tclose{\kbdfont\look}}\fi 2181\else{\tclose{\kbdfont\look}}\fi} 2182 2183% For @indicateurl, @env, @command quotes seem unnecessary, so use \code. 2184\let\indicateurl=\code 2185\let\env=\code 2186\let\command=\code 2187 2188% @uref (abbreviation for `urlref') takes an optional (comma-separated) 2189% second argument specifying the text to display and an optional third 2190% arg as text to display instead of (rather than in addition to) the url 2191% itself. First (mandatory) arg is the url. Perhaps eventually put in 2192% a hypertex \special here. 2193% 2194\def\uref#1{\douref #1,,,\finish} 2195\def\douref#1,#2,#3,#4\finish{\begingroup 2196 \unsepspaces 2197 \pdfurl{#1}% 2198 \setbox0 = \hbox{\ignorespaces #3}% 2199 \ifdim\wd0 > 0pt 2200 \unhbox0 % third arg given, show only that 2201 \else 2202 \setbox0 = \hbox{\ignorespaces #2}% 2203 \ifdim\wd0 > 0pt 2204 \ifpdf 2205 \unhbox0 % PDF: 2nd arg given, show only it 2206 \else 2207 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url 2208 \fi 2209 \else 2210 \code{#1}% only url given, so show it 2211 \fi 2212 \fi 2213 \endlink 2214\endgroup} 2215 2216% @url synonym for @uref, since that's how everyone uses it. 2217% 2218\let\url=\uref 2219 2220% rms does not like angle brackets --karl, 17may97. 2221% So now @email is just like @uref, unless we are pdf. 2222% 2223%\def\email#1{\angleleft{\tt #1}\angleright} 2224\ifpdf 2225 \def\email#1{\doemail#1,,\finish} 2226 \def\doemail#1,#2,#3\finish{\begingroup 2227 \unsepspaces 2228 \pdfurl{mailto:#1}% 2229 \setbox0 = \hbox{\ignorespaces #2}% 2230 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi 2231 \endlink 2232 \endgroup} 2233\else 2234 \let\email=\uref 2235\fi 2236 2237% Check if we are currently using a typewriter font. Since all the 2238% Computer Modern typewriter fonts have zero interword stretch (and 2239% shrink), and it is reasonable to expect all typewriter fonts to have 2240% this property, we can check that font parameter. 2241% 2242\def\ifmonospace{\ifdim\fontdimen3\font=0pt } 2243 2244% Typeset a dimension, e.g., `in' or `pt'. The only reason for the 2245% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. 2246% 2247\def\dmn#1{\thinspace #1} 2248 2249\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} 2250 2251% @l was never documented to mean ``switch to the Lisp font'', 2252% and it is not used as such in any manual I can find. We need it for 2253% Polish suppressed-l. --karl, 22sep96. 2254%\def\l#1{{\li #1}\null} 2255 2256% Explicit font changes: @r, @sc, undocumented @ii. 2257\def\r#1{{\rm #1}} % roman font 2258\def\sc#1{{\smallcaps#1}} % smallcaps font 2259\def\ii#1{{\it #1}} % italic font 2260 2261% @acronym for "FBI", "NATO", and the like. 2262% We print this one point size smaller, since it's intended for 2263% all-uppercase. 2264% 2265\def\acronym#1{\doacronym #1,,\finish} 2266\def\doacronym#1,#2,#3\finish{% 2267 {\selectfonts\lsize #1}% 2268 \def\temp{#2}% 2269 \ifx\temp\empty \else 2270 \space ({\unsepspaces \ignorespaces \temp \unskip})% 2271 \fi 2272} 2273 2274% @abbr for "Comput. J." and the like. 2275% No font change, but don't do end-of-sentence spacing. 2276% 2277\def\abbr#1{\doabbr #1,,\finish} 2278\def\doabbr#1,#2,#3\finish{% 2279 {\plainfrenchspacing #1}% 2280 \def\temp{#2}% 2281 \ifx\temp\empty \else 2282 \space ({\unsepspaces \ignorespaces \temp \unskip})% 2283 \fi 2284} 2285 2286% @pounds{} is a sterling sign, which Knuth put in the CM italic font. 2287% 2288\def\pounds{{\it\$}} 2289 2290% @euro{} comes from a separate font, depending on the current style. 2291% We use the free feym* fonts from the eurosym package by Henrik 2292% Theiling, which support regular, slanted, bold and bold slanted (and 2293% "outlined" (blackboard board, sort of) versions, which we don't need). 2294% It is available from http://www.ctan.org/tex-archive/fonts/eurosym. 2295% 2296% Although only regular is the truly official Euro symbol, we ignore 2297% that. The Euro is designed to be slightly taller than the regular 2298% font height. 2299% 2300% feymr - regular 2301% feymo - slanted 2302% feybr - bold 2303% feybo - bold slanted 2304% 2305% There is no good (free) typewriter version, to my knowledge. 2306% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide. 2307% Hmm. 2308% 2309% Also doesn't work in math. Do we need to do math with euro symbols? 2310% Hope not. 2311% 2312% 2313\def\euro{{\eurofont e}} 2314\def\eurofont{% 2315 % We set the font at each command, rather than predefining it in 2316 % \textfonts and the other font-switching commands, so that 2317 % installations which never need the symbol don't have to have the 2318 % font installed. 2319 % 2320 % There is only one designed size (nominal 10pt), so we always scale 2321 % that to the current nominal size. 2322 % 2323 % By the way, simply using "at 1em" works for cmr10 and the like, but 2324 % does not work for cmbx10 and other extended/shrunken fonts. 2325 % 2326 \def\eurosize{\csname\curfontsize nominalsize\endcsname}% 2327 % 2328 \ifx\curfontstyle\bfstylename 2329 % bold: 2330 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize 2331 \else 2332 % regular: 2333 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize 2334 \fi 2335 \thiseurofont 2336} 2337 2338% @registeredsymbol - R in a circle. The font for the R should really 2339% be smaller yet, but lllsize is the best we can do for now. 2340% Adapted from the plain.tex definition of \copyright. 2341% 2342\def\registeredsymbol{% 2343 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% 2344 \hfil\crcr\Orb}}% 2345 }$% 2346} 2347 2348% @textdegree - the normal degrees sign. 2349% 2350\def\textdegree{$^\circ$} 2351 2352% Laurent Siebenmann reports \Orb undefined with: 2353% Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38 2354% so we'll define it if necessary. 2355% 2356\ifx\Orb\undefined 2357\def\Orb{\mathhexbox20D} 2358\fi 2359 2360 2361\message{page headings,} 2362 2363\newskip\titlepagetopglue \titlepagetopglue = 1.5in 2364\newskip\titlepagebottomglue \titlepagebottomglue = 2pc 2365 2366% First the title page. Must do @settitle before @titlepage. 2367\newif\ifseenauthor 2368\newif\iffinishedtitlepage 2369 2370% Do an implicit @contents or @shortcontents after @end titlepage if the 2371% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. 2372% 2373\newif\ifsetcontentsaftertitlepage 2374 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue 2375\newif\ifsetshortcontentsaftertitlepage 2376 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue 2377 2378\parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% 2379 \endgroup\page\hbox{}\page} 2380 2381\envdef\titlepage{% 2382 % Open one extra group, as we want to close it in the middle of \Etitlepage. 2383 \begingroup 2384 \parindent=0pt \textfonts 2385 % Leave some space at the very top of the page. 2386 \vglue\titlepagetopglue 2387 % No rule at page bottom unless we print one at the top with @title. 2388 \finishedtitlepagetrue 2389 % 2390 % Most title ``pages'' are actually two pages long, with space 2391 % at the top of the second. We don't want the ragged left on the second. 2392 \let\oldpage = \page 2393 \def\page{% 2394 \iffinishedtitlepage\else 2395 \finishtitlepage 2396 \fi 2397 \let\page = \oldpage 2398 \page 2399 \null 2400 }% 2401} 2402 2403\def\Etitlepage{% 2404 \iffinishedtitlepage\else 2405 \finishtitlepage 2406 \fi 2407 % It is important to do the page break before ending the group, 2408 % because the headline and footline are only empty inside the group. 2409 % If we use the new definition of \page, we always get a blank page 2410 % after the title page, which we certainly don't want. 2411 \oldpage 2412 \endgroup 2413 % 2414 % Need this before the \...aftertitlepage checks so that if they are 2415 % in effect the toc pages will come out with page numbers. 2416 \HEADINGSon 2417 % 2418 % If they want short, they certainly want long too. 2419 \ifsetshortcontentsaftertitlepage 2420 \shortcontents 2421 \contents 2422 \global\let\shortcontents = \relax 2423 \global\let\contents = \relax 2424 \fi 2425 % 2426 \ifsetcontentsaftertitlepage 2427 \contents 2428 \global\let\contents = \relax 2429 \global\let\shortcontents = \relax 2430 \fi 2431} 2432 2433\def\finishtitlepage{% 2434 \vskip4pt \hrule height 2pt width \hsize 2435 \vskip\titlepagebottomglue 2436 \finishedtitlepagetrue 2437} 2438 2439%%% Macros to be used within @titlepage: 2440 2441\let\subtitlerm=\tenrm 2442\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} 2443 2444\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines 2445 \let\tt=\authortt} 2446 2447\parseargdef\title{% 2448 \checkenv\titlepage 2449 \leftline{\titlefonts\rm #1} 2450 % print a rule at the page bottom also. 2451 \finishedtitlepagefalse 2452 \vskip4pt \hrule height 4pt width \hsize \vskip4pt 2453} 2454 2455\parseargdef\subtitle{% 2456 \checkenv\titlepage 2457 {\subtitlefont \rightline{#1}}% 2458} 2459 2460% @author should come last, but may come many times. 2461% It can also be used inside @quotation. 2462% 2463\parseargdef\author{% 2464 \def\temp{\quotation}% 2465 \ifx\thisenv\temp 2466 \def\quotationauthor{#1}% printed in \Equotation. 2467 \else 2468 \checkenv\titlepage 2469 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi 2470 {\authorfont \leftline{#1}}% 2471 \fi 2472} 2473 2474 2475%%% Set up page headings and footings. 2476 2477\let\thispage=\folio 2478 2479\newtoks\evenheadline % headline on even pages 2480\newtoks\oddheadline % headline on odd pages 2481\newtoks\evenfootline % footline on even pages 2482\newtoks\oddfootline % footline on odd pages 2483 2484% Now make TeX use those variables 2485\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline 2486 \else \the\evenheadline \fi}} 2487\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline 2488 \else \the\evenfootline \fi}\HEADINGShook} 2489\let\HEADINGShook=\relax 2490 2491% Commands to set those variables. 2492% For example, this is what @headings on does 2493% @evenheading @thistitle|@thispage|@thischapter 2494% @oddheading @thischapter|@thispage|@thistitle 2495% @evenfooting @thisfile|| 2496% @oddfooting ||@thisfile 2497 2498 2499\def\evenheading{\parsearg\evenheadingxxx} 2500\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} 2501\def\evenheadingyyy #1\|#2\|#3\|#4\finish{% 2502\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 2503 2504\def\oddheading{\parsearg\oddheadingxxx} 2505\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} 2506\def\oddheadingyyy #1\|#2\|#3\|#4\finish{% 2507\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 2508 2509\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% 2510 2511\def\evenfooting{\parsearg\evenfootingxxx} 2512\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} 2513\def\evenfootingyyy #1\|#2\|#3\|#4\finish{% 2514\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 2515 2516\def\oddfooting{\parsearg\oddfootingxxx} 2517\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} 2518\def\oddfootingyyy #1\|#2\|#3\|#4\finish{% 2519 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% 2520 % 2521 % Leave some space for the footline. Hopefully ok to assume 2522 % @evenfooting will not be used by itself. 2523 \global\advance\pageheight by -12pt 2524 \global\advance\vsize by -12pt 2525} 2526 2527\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} 2528 2529 2530% @headings double turns headings on for double-sided printing. 2531% @headings single turns headings on for single-sided printing. 2532% @headings off turns them off. 2533% @headings on same as @headings double, retained for compatibility. 2534% @headings after turns on double-sided headings after this page. 2535% @headings doubleafter turns on double-sided headings after this page. 2536% @headings singleafter turns on single-sided headings after this page. 2537% By default, they are off at the start of a document, 2538% and turned `on' after @end titlepage. 2539 2540\def\headings #1 {\csname HEADINGS#1\endcsname} 2541 2542\def\HEADINGSoff{% 2543\global\evenheadline={\hfil} \global\evenfootline={\hfil} 2544\global\oddheadline={\hfil} \global\oddfootline={\hfil}} 2545\HEADINGSoff 2546% When we turn headings on, set the page number to 1. 2547% For double-sided printing, put current file name in lower left corner, 2548% chapter name on inside top of right hand pages, document 2549% title on inside top of left hand pages, and page numbers on outside top 2550% edge of all pages. 2551\def\HEADINGSdouble{% 2552\global\pageno=1 2553\global\evenfootline={\hfil} 2554\global\oddfootline={\hfil} 2555\global\evenheadline={\line{\folio\hfil\thistitle}} 2556\global\oddheadline={\line{\thischapter\hfil\folio}} 2557\global\let\contentsalignmacro = \chapoddpage 2558} 2559\let\contentsalignmacro = \chappager 2560 2561% For single-sided printing, chapter title goes across top left of page, 2562% page number on top right. 2563\def\HEADINGSsingle{% 2564\global\pageno=1 2565\global\evenfootline={\hfil} 2566\global\oddfootline={\hfil} 2567\global\evenheadline={\line{\thischapter\hfil\folio}} 2568\global\oddheadline={\line{\thischapter\hfil\folio}} 2569\global\let\contentsalignmacro = \chappager 2570} 2571\def\HEADINGSon{\HEADINGSdouble} 2572 2573\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} 2574\let\HEADINGSdoubleafter=\HEADINGSafter 2575\def\HEADINGSdoublex{% 2576\global\evenfootline={\hfil} 2577\global\oddfootline={\hfil} 2578\global\evenheadline={\line{\folio\hfil\thistitle}} 2579\global\oddheadline={\line{\thischapter\hfil\folio}} 2580\global\let\contentsalignmacro = \chapoddpage 2581} 2582 2583\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} 2584\def\HEADINGSsinglex{% 2585\global\evenfootline={\hfil} 2586\global\oddfootline={\hfil} 2587\global\evenheadline={\line{\thischapter\hfil\folio}} 2588\global\oddheadline={\line{\thischapter\hfil\folio}} 2589\global\let\contentsalignmacro = \chappager 2590} 2591 2592% Subroutines used in generating headings 2593% This produces Day Month Year style of output. 2594% Only define if not already defined, in case a txi-??.tex file has set 2595% up a different format (e.g., txi-cs.tex does this). 2596\ifx\today\undefined 2597\def\today{% 2598 \number\day\space 2599 \ifcase\month 2600 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr 2601 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug 2602 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec 2603 \fi 2604 \space\number\year} 2605\fi 2606 2607% @settitle line... specifies the title of the document, for headings. 2608% It generates no output of its own. 2609\def\thistitle{\putwordNoTitle} 2610\def\settitle{\parsearg{\gdef\thistitle}} 2611 2612 2613\message{tables,} 2614% Tables -- @table, @ftable, @vtable, @item(x). 2615 2616% default indentation of table text 2617\newdimen\tableindent \tableindent=.8in 2618% default indentation of @itemize and @enumerate text 2619\newdimen\itemindent \itemindent=.3in 2620% margin between end of table item and start of table text. 2621\newdimen\itemmargin \itemmargin=.1in 2622 2623% used internally for \itemindent minus \itemmargin 2624\newdimen\itemmax 2625 2626% Note @table, @ftable, and @vtable define @item, @itemx, etc., with 2627% these defs. 2628% They also define \itemindex 2629% to index the item name in whatever manner is desired (perhaps none). 2630 2631\newif\ifitemxneedsnegativevskip 2632 2633\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} 2634 2635\def\internalBitem{\smallbreak \parsearg\itemzzz} 2636\def\internalBitemx{\itemxpar \parsearg\itemzzz} 2637 2638\def\itemzzz #1{\begingroup % 2639 \advance\hsize by -\rightskip 2640 \advance\hsize by -\tableindent 2641 \setbox0=\hbox{\itemindicate{#1}}% 2642 \itemindex{#1}% 2643 \nobreak % This prevents a break before @itemx. 2644 % 2645 % If the item text does not fit in the space we have, put it on a line 2646 % by itself, and do not allow a page break either before or after that 2647 % line. We do not start a paragraph here because then if the next 2648 % command is, e.g., @kindex, the whatsit would get put into the 2649 % horizontal list on a line by itself, resulting in extra blank space. 2650 \ifdim \wd0>\itemmax 2651 % 2652 % Make this a paragraph so we get the \parskip glue and wrapping, 2653 % but leave it ragged-right. 2654 \begingroup 2655 \advance\leftskip by-\tableindent 2656 \advance\hsize by\tableindent 2657 \advance\rightskip by0pt plus1fil 2658 \leavevmode\unhbox0\par 2659 \endgroup 2660 % 2661 % We're going to be starting a paragraph, but we don't want the 2662 % \parskip glue -- logically it's part of the @item we just started. 2663 \nobreak \vskip-\parskip 2664 % 2665 % Stop a page break at the \parskip glue coming up. However, if 2666 % what follows is an environment such as @example, there will be no 2667 % \parskip glue; then the negative vskip we just inserted would 2668 % cause the example and the item to crash together. So we use this 2669 % bizarre value of 10001 as a signal to \aboveenvbreak to insert 2670 % \parskip glue after all. Section titles are handled this way also. 2671 % 2672 \penalty 10001 2673 \endgroup 2674 \itemxneedsnegativevskipfalse 2675 \else 2676 % The item text fits into the space. Start a paragraph, so that the 2677 % following text (if any) will end up on the same line. 2678 \noindent 2679 % Do this with kerns and \unhbox so that if there is a footnote in 2680 % the item text, it can migrate to the main vertical list and 2681 % eventually be printed. 2682 \nobreak\kern-\tableindent 2683 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 2684 \unhbox0 2685 \nobreak\kern\dimen0 2686 \endgroup 2687 \itemxneedsnegativevskiptrue 2688 \fi 2689} 2690 2691\def\item{\errmessage{@item while not in a list environment}} 2692\def\itemx{\errmessage{@itemx while not in a list environment}} 2693 2694% @table, @ftable, @vtable. 2695\envdef\table{% 2696 \let\itemindex\gobble 2697 \tablecheck{table}% 2698} 2699\envdef\ftable{% 2700 \def\itemindex ##1{\doind {fn}{\code{##1}}}% 2701 \tablecheck{ftable}% 2702} 2703\envdef\vtable{% 2704 \def\itemindex ##1{\doind {vr}{\code{##1}}}% 2705 \tablecheck{vtable}% 2706} 2707\def\tablecheck#1{% 2708 \ifnum \the\catcode`\^^M=\active 2709 \endgroup 2710 \errmessage{This command won't work in this context; perhaps the problem is 2711 that we are \inenvironment\thisenv}% 2712 \def\next{\doignore{#1}}% 2713 \else 2714 \let\next\tablex 2715 \fi 2716 \next 2717} 2718\def\tablex#1{% 2719 \def\itemindicate{#1}% 2720 \parsearg\tabley 2721} 2722\def\tabley#1{% 2723 {% 2724 \makevalueexpandable 2725 \edef\temp{\noexpand\tablez #1\space\space\space}% 2726 \expandafter 2727 }\temp \endtablez 2728} 2729\def\tablez #1 #2 #3 #4\endtablez{% 2730 \aboveenvbreak 2731 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi 2732 \ifnum 0#2>0 \tableindent=#2\mil \fi 2733 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi 2734 \itemmax=\tableindent 2735 \advance \itemmax by -\itemmargin 2736 \advance \leftskip by \tableindent 2737 \exdentamount=\tableindent 2738 \parindent = 0pt 2739 \parskip = \smallskipamount 2740 \ifdim \parskip=0pt \parskip=2pt \fi 2741 \let\item = \internalBitem 2742 \let\itemx = \internalBitemx 2743} 2744\def\Etable{\endgraf\afterenvbreak} 2745\let\Eftable\Etable 2746\let\Evtable\Etable 2747\let\Eitemize\Etable 2748\let\Eenumerate\Etable 2749 2750% This is the counter used by @enumerate, which is really @itemize 2751 2752\newcount \itemno 2753 2754\envdef\itemize{\parsearg\doitemize} 2755 2756\def\doitemize#1{% 2757 \aboveenvbreak 2758 \itemmax=\itemindent 2759 \advance\itemmax by -\itemmargin 2760 \advance\leftskip by \itemindent 2761 \exdentamount=\itemindent 2762 \parindent=0pt 2763 \parskip=\smallskipamount 2764 \ifdim\parskip=0pt \parskip=2pt \fi 2765 \def\itemcontents{#1}% 2766 % @itemize with no arg is equivalent to @itemize @bullet. 2767 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi 2768 \let\item=\itemizeitem 2769} 2770 2771% Definition of @item while inside @itemize and @enumerate. 2772% 2773\def\itemizeitem{% 2774 \advance\itemno by 1 % for enumerations 2775 {\let\par=\endgraf \smallbreak}% reasonable place to break 2776 {% 2777 % If the document has an @itemize directly after a section title, a 2778 % \nobreak will be last on the list, and \sectionheading will have 2779 % done a \vskip-\parskip. In that case, we don't want to zero 2780 % parskip, or the item text will crash with the heading. On the 2781 % other hand, when there is normal text preceding the item (as there 2782 % usually is), we do want to zero parskip, or there would be too much 2783 % space. In that case, we won't have a \nobreak before. At least 2784 % that's the theory. 2785 \ifnum\lastpenalty<10000 \parskip=0in \fi 2786 \noindent 2787 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% 2788 \vadjust{\penalty 1200}}% not good to break after first line of item. 2789 \flushcr 2790} 2791 2792% \splitoff TOKENS\endmark defines \first to be the first token in 2793% TOKENS, and \rest to be the remainder. 2794% 2795\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% 2796 2797% Allow an optional argument of an uppercase letter, lowercase letter, 2798% or number, to specify the first label in the enumerated list. No 2799% argument is the same as `1'. 2800% 2801\envparseargdef\enumerate{\enumeratey #1 \endenumeratey} 2802\def\enumeratey #1 #2\endenumeratey{% 2803 % If we were given no argument, pretend we were given `1'. 2804 \def\thearg{#1}% 2805 \ifx\thearg\empty \def\thearg{1}\fi 2806 % 2807 % Detect if the argument is a single token. If so, it might be a 2808 % letter. Otherwise, the only valid thing it can be is a number. 2809 % (We will always have one token, because of the test we just made. 2810 % This is a good thing, since \splitoff doesn't work given nothing at 2811 % all -- the first parameter is undelimited.) 2812 \expandafter\splitoff\thearg\endmark 2813 \ifx\rest\empty 2814 % Only one token in the argument. It could still be anything. 2815 % A ``lowercase letter'' is one whose \lccode is nonzero. 2816 % An ``uppercase letter'' is one whose \lccode is both nonzero, and 2817 % not equal to itself. 2818 % Otherwise, we assume it's a number. 2819 % 2820 % We need the \relax at the end of the \ifnum lines to stop TeX from 2821 % continuing to look for a <number>. 2822 % 2823 \ifnum\lccode\expandafter`\thearg=0\relax 2824 \numericenumerate % a number (we hope) 2825 \else 2826 % It's a letter. 2827 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax 2828 \lowercaseenumerate % lowercase letter 2829 \else 2830 \uppercaseenumerate % uppercase letter 2831 \fi 2832 \fi 2833 \else 2834 % Multiple tokens in the argument. We hope it's a number. 2835 \numericenumerate 2836 \fi 2837} 2838 2839% An @enumerate whose labels are integers. The starting integer is 2840% given in \thearg. 2841% 2842\def\numericenumerate{% 2843 \itemno = \thearg 2844 \startenumeration{\the\itemno}% 2845} 2846 2847% The starting (lowercase) letter is in \thearg. 2848\def\lowercaseenumerate{% 2849 \itemno = \expandafter`\thearg 2850 \startenumeration{% 2851 % Be sure we're not beyond the end of the alphabet. 2852 \ifnum\itemno=0 2853 \errmessage{No more lowercase letters in @enumerate; get a bigger 2854 alphabet}% 2855 \fi 2856 \char\lccode\itemno 2857 }% 2858} 2859 2860% The starting (uppercase) letter is in \thearg. 2861\def\uppercaseenumerate{% 2862 \itemno = \expandafter`\thearg 2863 \startenumeration{% 2864 % Be sure we're not beyond the end of the alphabet. 2865 \ifnum\itemno=0 2866 \errmessage{No more uppercase letters in @enumerate; get a bigger 2867 alphabet} 2868 \fi 2869 \char\uccode\itemno 2870 }% 2871} 2872 2873% Call \doitemize, adding a period to the first argument and supplying the 2874% common last two arguments. Also subtract one from the initial value in 2875% \itemno, since @item increments \itemno. 2876% 2877\def\startenumeration#1{% 2878 \advance\itemno by -1 2879 \doitemize{#1.}\flushcr 2880} 2881 2882% @alphaenumerate and @capsenumerate are abbreviations for giving an arg 2883% to @enumerate. 2884% 2885\def\alphaenumerate{\enumerate{a}} 2886\def\capsenumerate{\enumerate{A}} 2887\def\Ealphaenumerate{\Eenumerate} 2888\def\Ecapsenumerate{\Eenumerate} 2889 2890 2891% @multitable macros 2892% Amy Hendrickson, 8/18/94, 3/6/96 2893% 2894% @multitable ... @end multitable will make as many columns as desired. 2895% Contents of each column will wrap at width given in preamble. Width 2896% can be specified either with sample text given in a template line, 2897% or in percent of \hsize, the current width of text on page. 2898 2899% Table can continue over pages but will only break between lines. 2900 2901% To make preamble: 2902% 2903% Either define widths of columns in terms of percent of \hsize: 2904% @multitable @columnfractions .25 .3 .45 2905% @item ... 2906% 2907% Numbers following @columnfractions are the percent of the total 2908% current hsize to be used for each column. You may use as many 2909% columns as desired. 2910 2911 2912% Or use a template: 2913% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 2914% @item ... 2915% using the widest term desired in each column. 2916 2917% Each new table line starts with @item, each subsequent new column 2918% starts with @tab. Empty columns may be produced by supplying @tab's 2919% with nothing between them for as many times as empty columns are needed, 2920% ie, @tab@tab@tab will produce two empty columns. 2921 2922% @item, @tab do not need to be on their own lines, but it will not hurt 2923% if they are. 2924 2925% Sample multitable: 2926 2927% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 2928% @item first col stuff @tab second col stuff @tab third col 2929% @item 2930% first col stuff 2931% @tab 2932% second col stuff 2933% @tab 2934% third col 2935% @item first col stuff @tab second col stuff 2936% @tab Many paragraphs of text may be used in any column. 2937% 2938% They will wrap at the width determined by the template. 2939% @item@tab@tab This will be in third column. 2940% @end multitable 2941 2942% Default dimensions may be reset by user. 2943% @multitableparskip is vertical space between paragraphs in table. 2944% @multitableparindent is paragraph indent in table. 2945% @multitablecolmargin is horizontal space to be left between columns. 2946% @multitablelinespace is space to leave between table items, baseline 2947% to baseline. 2948% 0pt means it depends on current normal line spacing. 2949% 2950\newskip\multitableparskip 2951\newskip\multitableparindent 2952\newdimen\multitablecolspace 2953\newskip\multitablelinespace 2954\multitableparskip=0pt 2955\multitableparindent=6pt 2956\multitablecolspace=12pt 2957\multitablelinespace=0pt 2958 2959% Macros used to set up halign preamble: 2960% 2961\let\endsetuptable\relax 2962\def\xendsetuptable{\endsetuptable} 2963\let\columnfractions\relax 2964\def\xcolumnfractions{\columnfractions} 2965\newif\ifsetpercent 2966 2967% #1 is the @columnfraction, usually a decimal number like .5, but might 2968% be just 1. We just use it, whatever it is. 2969% 2970\def\pickupwholefraction#1 {% 2971 \global\advance\colcount by 1 2972 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% 2973 \setuptable 2974} 2975 2976\newcount\colcount 2977\def\setuptable#1{% 2978 \def\firstarg{#1}% 2979 \ifx\firstarg\xendsetuptable 2980 \let\go = \relax 2981 \else 2982 \ifx\firstarg\xcolumnfractions 2983 \global\setpercenttrue 2984 \else 2985 \ifsetpercent 2986 \let\go\pickupwholefraction 2987 \else 2988 \global\advance\colcount by 1 2989 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a 2990 % separator; typically that is always in the input, anyway. 2991 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% 2992 \fi 2993 \fi 2994 \ifx\go\pickupwholefraction 2995 % Put the argument back for the \pickupwholefraction call, so 2996 % we'll always have a period there to be parsed. 2997 \def\go{\pickupwholefraction#1}% 2998 \else 2999 \let\go = \setuptable 3000 \fi% 3001 \fi 3002 \go 3003} 3004 3005% multitable-only commands. 3006% 3007% @headitem starts a heading row, which we typeset in bold. 3008% Assignments have to be global since we are inside the implicit group 3009% of an alignment entry. Note that \everycr resets \everytab. 3010\def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}% 3011% 3012% A \tab used to include \hskip1sp. But then the space in a template 3013% line is not enough. That is bad. So let's go back to just `&' until 3014% we encounter the problem it was intended to solve again. 3015% --karl, nathan@acm.org, 20apr99. 3016\def\tab{\checkenv\multitable &\the\everytab}% 3017 3018% @multitable ... @end multitable definitions: 3019% 3020\newtoks\everytab % insert after every tab. 3021% 3022\envdef\multitable{% 3023 \vskip\parskip 3024 \startsavinginserts 3025 % 3026 % @item within a multitable starts a normal row. 3027 % We use \def instead of \let so that if one of the multitable entries 3028 % contains an @itemize, we don't choke on the \item (seen as \crcr aka 3029 % \endtemplate) expanding \doitemize. 3030 \def\item{\crcr}% 3031 % 3032 \tolerance=9500 3033 \hbadness=9500 3034 \setmultitablespacing 3035 \parskip=\multitableparskip 3036 \parindent=\multitableparindent 3037 \overfullrule=0pt 3038 \global\colcount=0 3039 % 3040 \everycr = {% 3041 \noalign{% 3042 \global\everytab={}% 3043 \global\colcount=0 % Reset the column counter. 3044 % Check for saved footnotes, etc. 3045 \checkinserts 3046 % Keeps underfull box messages off when table breaks over pages. 3047 %\filbreak 3048 % Maybe so, but it also creates really weird page breaks when the 3049 % table breaks over pages. Wouldn't \vfil be better? Wait until the 3050 % problem manifests itself, so it can be fixed for real --karl. 3051 }% 3052 }% 3053 % 3054 \parsearg\domultitable 3055} 3056\def\domultitable#1{% 3057 % To parse everything between @multitable and @item: 3058 \setuptable#1 \endsetuptable 3059 % 3060 % This preamble sets up a generic column definition, which will 3061 % be used as many times as user calls for columns. 3062 % \vtop will set a single line and will also let text wrap and 3063 % continue for many paragraphs if desired. 3064 \halign\bgroup &% 3065 \global\advance\colcount by 1 3066 \multistrut 3067 \vtop{% 3068 % Use the current \colcount to find the correct column width: 3069 \hsize=\expandafter\csname col\the\colcount\endcsname 3070 % 3071 % In order to keep entries from bumping into each other 3072 % we will add a \leftskip of \multitablecolspace to all columns after 3073 % the first one. 3074 % 3075 % If a template has been used, we will add \multitablecolspace 3076 % to the width of each template entry. 3077 % 3078 % If the user has set preamble in terms of percent of \hsize we will 3079 % use that dimension as the width of the column, and the \leftskip 3080 % will keep entries from bumping into each other. Table will start at 3081 % left margin and final column will justify at right margin. 3082 % 3083 % Make sure we don't inherit \rightskip from the outer environment. 3084 \rightskip=0pt 3085 \ifnum\colcount=1 3086 % The first column will be indented with the surrounding text. 3087 \advance\hsize by\leftskip 3088 \else 3089 \ifsetpercent \else 3090 % If user has not set preamble in terms of percent of \hsize 3091 % we will advance \hsize by \multitablecolspace. 3092 \advance\hsize by \multitablecolspace 3093 \fi 3094 % In either case we will make \leftskip=\multitablecolspace: 3095 \leftskip=\multitablecolspace 3096 \fi 3097 % Ignoring space at the beginning and end avoids an occasional spurious 3098 % blank line, when TeX decides to break the line at the space before the 3099 % box from the multistrut, so the strut ends up on a line by itself. 3100 % For example: 3101 % @multitable @columnfractions .11 .89 3102 % @item @code{#} 3103 % @tab Legal holiday which is valid in major parts of the whole country. 3104 % Is automatically provided with highlighting sequences respectively 3105 % marking characters. 3106 \noindent\ignorespaces##\unskip\multistrut 3107 }\cr 3108} 3109\def\Emultitable{% 3110 \crcr 3111 \egroup % end the \halign 3112 \global\setpercentfalse 3113} 3114 3115\def\setmultitablespacing{% 3116 \def\multistrut{\strut}% just use the standard line spacing 3117 % 3118 % Compute \multitablelinespace (if not defined by user) for use in 3119 % \multitableparskip calculation. We used define \multistrut based on 3120 % this, but (ironically) that caused the spacing to be off. 3121 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100. 3122\ifdim\multitablelinespace=0pt 3123\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip 3124\global\advance\multitablelinespace by-\ht0 3125\fi 3126%% Test to see if parskip is larger than space between lines of 3127%% table. If not, do nothing. 3128%% If so, set to same dimension as multitablelinespace. 3129\ifdim\multitableparskip>\multitablelinespace 3130\global\multitableparskip=\multitablelinespace 3131\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller 3132 %% than skip between lines in the table. 3133\fi% 3134\ifdim\multitableparskip=0pt 3135\global\multitableparskip=\multitablelinespace 3136\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller 3137 %% than skip between lines in the table. 3138\fi} 3139 3140 3141\message{conditionals,} 3142 3143% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, 3144% @ifnotxml always succeed. They currently do nothing; we don't 3145% attempt to check whether the conditionals are properly nested. But we 3146% have to remember that they are conditionals, so that @end doesn't 3147% attempt to close an environment group. 3148% 3149\def\makecond#1{% 3150 \expandafter\let\csname #1\endcsname = \relax 3151 \expandafter\let\csname iscond.#1\endcsname = 1 3152} 3153\makecond{iftex} 3154\makecond{ifnotdocbook} 3155\makecond{ifnothtml} 3156\makecond{ifnotinfo} 3157\makecond{ifnotplaintext} 3158\makecond{ifnotxml} 3159 3160% Ignore @ignore, @ifhtml, @ifinfo, and the like. 3161% 3162\def\direntry{\doignore{direntry}} 3163\def\documentdescription{\doignore{documentdescription}} 3164\def\docbook{\doignore{docbook}} 3165\def\html{\doignore{html}} 3166\def\ifdocbook{\doignore{ifdocbook}} 3167\def\ifhtml{\doignore{ifhtml}} 3168\def\ifinfo{\doignore{ifinfo}} 3169\def\ifnottex{\doignore{ifnottex}} 3170\def\ifplaintext{\doignore{ifplaintext}} 3171\def\ifxml{\doignore{ifxml}} 3172\def\ignore{\doignore{ignore}} 3173\def\menu{\doignore{menu}} 3174\def\xml{\doignore{xml}} 3175 3176% Ignore text until a line `@end #1', keeping track of nested conditionals. 3177% 3178% A count to remember the depth of nesting. 3179\newcount\doignorecount 3180 3181\def\doignore#1{\begingroup 3182 % Scan in ``verbatim'' mode: 3183 \obeylines 3184 \catcode`\@ = \other 3185 \catcode`\{ = \other 3186 \catcode`\} = \other 3187 % 3188 % Make sure that spaces turn into tokens that match what \doignoretext wants. 3189 \spaceisspace 3190 % 3191 % Count number of #1's that we've seen. 3192 \doignorecount = 0 3193 % 3194 % Swallow text until we reach the matching `@end #1'. 3195 \dodoignore{#1}% 3196} 3197 3198{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. 3199 \obeylines % 3200 % 3201 \gdef\dodoignore#1{% 3202 % #1 contains the command name as a string, e.g., `ifinfo'. 3203 % 3204 % Define a command to find the next `@end #1'. 3205 \long\def\doignoretext##1^^M@end #1{% 3206 \doignoretextyyy##1^^M@#1\_STOP_}% 3207 % 3208 % And this command to find another #1 command, at the beginning of a 3209 % line. (Otherwise, we would consider a line `@c @ifset', for 3210 % example, to count as an @ifset for nesting.) 3211 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% 3212 % 3213 % And now expand that command. 3214 \doignoretext ^^M% 3215 }% 3216} 3217 3218\def\doignoreyyy#1{% 3219 \def\temp{#1}% 3220 \ifx\temp\empty % Nothing found. 3221 \let\next\doignoretextzzz 3222 \else % Found a nested condition, ... 3223 \advance\doignorecount by 1 3224 \let\next\doignoretextyyy % ..., look for another. 3225 % If we're here, #1 ends with ^^M\ifinfo (for example). 3226 \fi 3227 \next #1% the token \_STOP_ is present just after this macro. 3228} 3229 3230% We have to swallow the remaining "\_STOP_". 3231% 3232\def\doignoretextzzz#1{% 3233 \ifnum\doignorecount = 0 % We have just found the outermost @end. 3234 \let\next\enddoignore 3235 \else % Still inside a nested condition. 3236 \advance\doignorecount by -1 3237 \let\next\doignoretext % Look for the next @end. 3238 \fi 3239 \next 3240} 3241 3242% Finish off ignored text. 3243{ \obeylines% 3244 % Ignore anything after the last `@end #1'; this matters in verbatim 3245 % environments, where otherwise the newline after an ignored conditional 3246 % would result in a blank line in the output. 3247 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}% 3248} 3249 3250 3251% @set VAR sets the variable VAR to an empty value. 3252% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. 3253% 3254% Since we want to separate VAR from REST-OF-LINE (which might be 3255% empty), we can't just use \parsearg; we have to insert a space of our 3256% own to delimit the rest of the line, and then take it out again if we 3257% didn't need it. 3258% We rely on the fact that \parsearg sets \catcode`\ =10. 3259% 3260\parseargdef\set{\setyyy#1 \endsetyyy} 3261\def\setyyy#1 #2\endsetyyy{% 3262 {% 3263 \makevalueexpandable 3264 \def\temp{#2}% 3265 \edef\next{\gdef\makecsname{SET#1}}% 3266 \ifx\temp\empty 3267 \next{}% 3268 \else 3269 \setzzz#2\endsetzzz 3270 \fi 3271 }% 3272} 3273% Remove the trailing space \setxxx inserted. 3274\def\setzzz#1 \endsetzzz{\next{#1}} 3275 3276% @clear VAR clears (i.e., unsets) the variable VAR. 3277% 3278\parseargdef\clear{% 3279 {% 3280 \makevalueexpandable 3281 \global\expandafter\let\csname SET#1\endcsname=\relax 3282 }% 3283} 3284 3285% @value{foo} gets the text saved in variable foo. 3286\def\value{\begingroup\makevalueexpandable\valuexxx} 3287\def\valuexxx#1{\expandablevalue{#1}\endgroup} 3288{ 3289 \catcode`\- = \active \catcode`\_ = \active 3290 % 3291 \gdef\makevalueexpandable{% 3292 \let\value = \expandablevalue 3293 % We don't want these characters active, ... 3294 \catcode`\-=\other \catcode`\_=\other 3295 % ..., but we might end up with active ones in the argument if 3296 % we're called from @code, as @code{@value{foo-bar_}}, though. 3297 % So \let them to their normal equivalents. 3298 \let-\realdash \let_\normalunderscore 3299 } 3300} 3301 3302% We have this subroutine so that we can handle at least some @value's 3303% properly in indexes (we call \makevalueexpandable in \indexdummies). 3304% The command has to be fully expandable (if the variable is set), since 3305% the result winds up in the index file. This means that if the 3306% variable's value contains other Texinfo commands, it's almost certain 3307% it will fail (although perhaps we could fix that with sufficient work 3308% to do a one-level expansion on the result, instead of complete). 3309% 3310\def\expandablevalue#1{% 3311 \expandafter\ifx\csname SET#1\endcsname\relax 3312 {[No value for ``#1'']}% 3313 \message{Variable `#1', used in @value, is not set.}% 3314 \else 3315 \csname SET#1\endcsname 3316 \fi 3317} 3318 3319% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined 3320% with @set. 3321% 3322% To get special treatment of `@end ifset,' call \makeond and the redefine. 3323% 3324\makecond{ifset} 3325\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} 3326\def\doifset#1#2{% 3327 {% 3328 \makevalueexpandable 3329 \let\next=\empty 3330 \expandafter\ifx\csname SET#2\endcsname\relax 3331 #1% If not set, redefine \next. 3332 \fi 3333 \expandafter 3334 }\next 3335} 3336\def\ifsetfail{\doignore{ifset}} 3337 3338% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been 3339% defined with @set, or has been undefined with @clear. 3340% 3341% The `\else' inside the `\doifset' parameter is a trick to reuse the 3342% above code: if the variable is not set, do nothing, if it is set, 3343% then redefine \next to \ifclearfail. 3344% 3345\makecond{ifclear} 3346\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} 3347\def\ifclearfail{\doignore{ifclear}} 3348 3349% @dircategory CATEGORY -- specify a category of the dir file 3350% which this file should belong to. Ignore this in TeX. 3351\let\dircategory=\comment 3352 3353% @defininfoenclose. 3354\let\definfoenclose=\comment 3355 3356 3357\message{indexing,} 3358% Index generation facilities 3359 3360% Define \newwrite to be identical to plain tex's \newwrite 3361% except not \outer, so it can be used within macros and \if's. 3362\edef\newwrite{\makecsname{ptexnewwrite}} 3363 3364% \newindex {foo} defines an index named foo. 3365% It automatically defines \fooindex such that 3366% \fooindex ...rest of line... puts an entry in the index foo. 3367% It also defines \fooindfile to be the number of the output channel for 3368% the file that accumulates this index. The file's extension is foo. 3369% The name of an index should be no more than 2 characters long 3370% for the sake of vms. 3371% 3372\def\newindex#1{% 3373 \iflinks 3374 \expandafter\newwrite \csname#1indfile\endcsname 3375 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file 3376 \fi 3377 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index 3378 \noexpand\doindex{#1}} 3379} 3380 3381% @defindex foo == \newindex{foo} 3382% 3383\def\defindex{\parsearg\newindex} 3384 3385% Define @defcodeindex, like @defindex except put all entries in @code. 3386% 3387\def\defcodeindex{\parsearg\newcodeindex} 3388% 3389\def\newcodeindex#1{% 3390 \iflinks 3391 \expandafter\newwrite \csname#1indfile\endcsname 3392 \openout \csname#1indfile\endcsname \jobname.#1 3393 \fi 3394 \expandafter\xdef\csname#1index\endcsname{% 3395 \noexpand\docodeindex{#1}}% 3396} 3397 3398 3399% @synindex foo bar makes index foo feed into index bar. 3400% Do this instead of @defindex foo if you don't want it as a separate index. 3401% 3402% @syncodeindex foo bar similar, but put all entries made for index foo 3403% inside @code. 3404% 3405\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} 3406\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} 3407 3408% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), 3409% #3 the target index (bar). 3410\def\dosynindex#1#2#3{% 3411 % Only do \closeout if we haven't already done it, else we'll end up 3412 % closing the target index. 3413 \expandafter \ifx\csname donesynindex#2\endcsname \undefined 3414 % The \closeout helps reduce unnecessary open files; the limit on the 3415 % Acorn RISC OS is a mere 16 files. 3416 \expandafter\closeout\csname#2indfile\endcsname 3417 \expandafter\let\csname\donesynindex#2\endcsname = 1 3418 \fi 3419 % redefine \fooindfile: 3420 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname 3421 \expandafter\let\csname#2indfile\endcsname=\temp 3422 % redefine \fooindex: 3423 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% 3424} 3425 3426% Define \doindex, the driver for all \fooindex macros. 3427% Argument #1 is generated by the calling \fooindex macro, 3428% and it is "foo", the name of the index. 3429 3430% \doindex just uses \parsearg; it calls \doind for the actual work. 3431% This is because \doind is more useful to call from other macros. 3432 3433% There is also \dosubind {index}{topic}{subtopic} 3434% which makes an entry in a two-level index such as the operation index. 3435 3436\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} 3437\def\singleindexer #1{\doind{\indexname}{#1}} 3438 3439% like the previous two, but they put @code around the argument. 3440\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} 3441\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} 3442 3443% Take care of Texinfo commands that can appear in an index entry. 3444% Since there are some commands we want to expand, and others we don't, 3445% we have to laboriously prevent expansion for those that we don't. 3446% 3447\def\indexdummies{% 3448 \escapechar = `\\ % use backslash in output files. 3449 \def\@{@}% change to @@ when we switch to @ as escape char in index files. 3450 \def\ {\realbackslash\space }% 3451 % 3452 % Need these in case \tex is in effect and \{ is a \delimiter again. 3453 % But can't use \lbracecmd and \rbracecmd because texindex assumes 3454 % braces and backslashes are used only as delimiters. 3455 \let\{ = \mylbrace 3456 \let\} = \myrbrace 3457 % 3458 % I don't entirely understand this, but when an index entry is 3459 % generated from a macro call, the \endinput which \scanmacro inserts 3460 % causes processing to be prematurely terminated. This is, 3461 % apparently, because \indexsorttmp is fully expanded, and \endinput 3462 % is an expandable command. The redefinition below makes \endinput 3463 % disappear altogether for that purpose -- although logging shows that 3464 % processing continues to some further point. On the other hand, it 3465 % seems \endinput does not hurt in the printed index arg, since that 3466 % is still getting written without apparent harm. 3467 % 3468 % Sample source (mac-idx3.tex, reported by Graham Percival to 3469 % help-texinfo, 22may06): 3470 % @macro funindex {WORD} 3471 % @findex xyz 3472 % @end macro 3473 % ... 3474 % @funindex commtest 3475 % 3476 % The above is not enough to reproduce the bug, but it gives the flavor. 3477 % 3478 % Sample whatsit resulting: 3479 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}} 3480 % 3481 % So: 3482 \let\endinput = \empty 3483 % 3484 % Do the redefinitions. 3485 \commondummies 3486} 3487 3488% For the aux and toc files, @ is the escape character. So we want to 3489% redefine everything using @ as the escape character (instead of 3490% \realbackslash, still used for index files). When everything uses @, 3491% this will be simpler. 3492% 3493\def\atdummies{% 3494 \def\@{@@}% 3495 \def\ {@ }% 3496 \let\{ = \lbraceatcmd 3497 \let\} = \rbraceatcmd 3498 % 3499 % Do the redefinitions. 3500 \commondummies 3501 \otherbackslash 3502} 3503 3504% Called from \indexdummies and \atdummies. 3505% 3506\def\commondummies{% 3507 % 3508 % \definedummyword defines \#1 as \string\#1\space, thus effectively 3509 % preventing its expansion. This is used only for control% words, 3510 % not control letters, because the \space would be incorrect for 3511 % control characters, but is needed to separate the control word 3512 % from whatever follows. 3513 % 3514 % For control letters, we have \definedummyletter, which omits the 3515 % space. 3516 % 3517 % These can be used both for control words that take an argument and 3518 % those that do not. If it is followed by {arg} in the input, then 3519 % that will dutifully get written to the index (or wherever). 3520 % 3521 \def\definedummyword ##1{\def##1{\string##1\space}}% 3522 \def\definedummyletter##1{\def##1{\string##1}}% 3523 \let\definedummyaccent\definedummyletter 3524 % 3525 \commondummiesnofonts 3526 % 3527 \definedummyletter\_% 3528 % 3529 % Non-English letters. 3530 \definedummyword\AA 3531 \definedummyword\AE 3532 \definedummyword\L 3533 \definedummyword\OE 3534 \definedummyword\O 3535 \definedummyword\aa 3536 \definedummyword\ae 3537 \definedummyword\l 3538 \definedummyword\oe 3539 \definedummyword\o 3540 \definedummyword\ss 3541 \definedummyword\exclamdown 3542 \definedummyword\questiondown 3543 \definedummyword\ordf 3544 \definedummyword\ordm 3545 % 3546 % Although these internal commands shouldn't show up, sometimes they do. 3547 \definedummyword\bf 3548 \definedummyword\gtr 3549 \definedummyword\hat 3550 \definedummyword\less 3551 \definedummyword\sf 3552 \definedummyword\sl 3553 \definedummyword\tclose 3554 \definedummyword\tt 3555 % 3556 \definedummyword\LaTeX 3557 \definedummyword\TeX 3558 % 3559 % Assorted special characters. 3560 \definedummyword\bullet 3561 \definedummyword\comma 3562 \definedummyword\copyright 3563 \definedummyword\registeredsymbol 3564 \definedummyword\dots 3565 \definedummyword\enddots 3566 \definedummyword\equiv 3567 \definedummyword\error 3568 \definedummyword\euro 3569 \definedummyword\expansion 3570 \definedummyword\minus 3571 \definedummyword\pounds 3572 \definedummyword\point 3573 \definedummyword\print 3574 \definedummyword\result 3575 \definedummyword\textdegree 3576 % 3577 % We want to disable all macros so that they are not expanded by \write. 3578 \macrolist 3579 % 3580 \normalturnoffactive 3581 % 3582 % Handle some cases of @value -- where it does not contain any 3583 % (non-fully-expandable) commands. 3584 \makevalueexpandable 3585} 3586 3587% \commondummiesnofonts: common to \commondummies and \indexnofonts. 3588% 3589\def\commondummiesnofonts{% 3590 % Control letters and accents. 3591 \definedummyletter\!% 3592 \definedummyaccent\"% 3593 \definedummyaccent\'% 3594 \definedummyletter\*% 3595 \definedummyaccent\,% 3596 \definedummyletter\.% 3597 \definedummyletter\/% 3598 \definedummyletter\:% 3599 \definedummyaccent\=% 3600 \definedummyletter\?% 3601 \definedummyaccent\^% 3602 \definedummyaccent\`% 3603 \definedummyaccent\~% 3604 \definedummyword\u 3605 \definedummyword\v 3606 \definedummyword\H 3607 \definedummyword\dotaccent 3608 \definedummyword\ringaccent 3609 \definedummyword\tieaccent 3610 \definedummyword\ubaraccent 3611 \definedummyword\udotaccent 3612 \definedummyword\dotless 3613 % 3614 % Texinfo font commands. 3615 \definedummyword\b 3616 \definedummyword\i 3617 \definedummyword\r 3618 \definedummyword\sc 3619 \definedummyword\t 3620 % 3621 % Commands that take arguments. 3622 \definedummyword\acronym 3623 \definedummyword\cite 3624 \definedummyword\code 3625 \definedummyword\command 3626 \definedummyword\dfn 3627 \definedummyword\emph 3628 \definedummyword\env 3629 \definedummyword\file 3630 \definedummyword\kbd 3631 \definedummyword\key 3632 \definedummyword\math 3633 \definedummyword\option 3634 \definedummyword\pxref 3635 \definedummyword\ref 3636 \definedummyword\samp 3637 \definedummyword\strong 3638 \definedummyword\tie 3639 \definedummyword\uref 3640 \definedummyword\url 3641 \definedummyword\var 3642 \definedummyword\verb 3643 \definedummyword\w 3644 \definedummyword\xref 3645} 3646 3647% \indexnofonts is used when outputting the strings to sort the index 3648% by, and when constructing control sequence names. It eliminates all 3649% control sequences and just writes whatever the best ASCII sort string 3650% would be for a given command (usually its argument). 3651% 3652\def\indexnofonts{% 3653 % Accent commands should become @asis. 3654 \def\definedummyaccent##1{\let##1\asis}% 3655 % We can just ignore other control letters. 3656 \def\definedummyletter##1{\let##1\empty}% 3657 % Hopefully, all control words can become @asis. 3658 \let\definedummyword\definedummyaccent 3659 % 3660 \commondummiesnofonts 3661 % 3662 % Don't no-op \tt, since it isn't a user-level command 3663 % and is used in the definitions of the active chars like <, >, |, etc. 3664 % Likewise with the other plain tex font commands. 3665 %\let\tt=\asis 3666 % 3667 \def\ { }% 3668 \def\@{@}% 3669 % how to handle braces? 3670 \def\_{\normalunderscore}% 3671 % 3672 % Non-English letters. 3673 \def\AA{AA}% 3674 \def\AE{AE}% 3675 \def\L{L}% 3676 \def\OE{OE}% 3677 \def\O{O}% 3678 \def\aa{aa}% 3679 \def\ae{ae}% 3680 \def\l{l}% 3681 \def\oe{oe}% 3682 \def\o{o}% 3683 \def\ss{ss}% 3684 \def\exclamdown{!}% 3685 \def\questiondown{?}% 3686 \def\ordf{a}% 3687 \def\ordm{o}% 3688 % 3689 \def\LaTeX{LaTeX}% 3690 \def\TeX{TeX}% 3691 % 3692 % Assorted special characters. 3693 % (The following {} will end up in the sort string, but that's ok.) 3694 \def\bullet{bullet}% 3695 \def\comma{,}% 3696 \def\copyright{copyright}% 3697 \def\registeredsymbol{R}% 3698 \def\dots{...}% 3699 \def\enddots{...}% 3700 \def\equiv{==}% 3701 \def\error{error}% 3702 \def\euro{euro}% 3703 \def\expansion{==>}% 3704 \def\minus{-}% 3705 \def\pounds{pounds}% 3706 \def\point{.}% 3707 \def\print{-|}% 3708 \def\result{=>}% 3709 \def\textdegree{degrees}% 3710 % 3711 % We need to get rid of all macros, leaving only the arguments (if present). 3712 % Of course this is not nearly correct, but it is the best we can do for now. 3713 % makeinfo does not expand macros in the argument to @deffn, which ends up 3714 % writing an index entry, and texindex isn't prepared for an index sort entry 3715 % that starts with \. 3716 % 3717 % Since macro invocations are followed by braces, we can just redefine them 3718 % to take a single TeX argument. The case of a macro invocation that 3719 % goes to end-of-line is not handled. 3720 % 3721 \macrolist 3722} 3723 3724\let\indexbackslash=0 %overridden during \printindex. 3725\let\SETmarginindex=\relax % put index entries in margin (undocumented)? 3726 3727% Most index entries go through here, but \dosubind is the general case. 3728% #1 is the index name, #2 is the entry text. 3729\def\doind#1#2{\dosubind{#1}{#2}{}} 3730 3731% Workhorse for all \fooindexes. 3732% #1 is name of index, #2 is stuff to put there, #3 is subentry -- 3733% empty if called from \doind, as we usually are (the main exception 3734% is with most defuns, which call us directly). 3735% 3736\def\dosubind#1#2#3{% 3737 \iflinks 3738 {% 3739 % Store the main index entry text (including the third arg). 3740 \toks0 = {#2}% 3741 % If third arg is present, precede it with a space. 3742 \def\thirdarg{#3}% 3743 \ifx\thirdarg\empty \else 3744 \toks0 = \expandafter{\the\toks0 \space #3}% 3745 \fi 3746 % 3747 \edef\writeto{\csname#1indfile\endcsname}% 3748 % 3749 \ifvmode 3750 \dosubindsanitize 3751 \else 3752 \dosubindwrite 3753 \fi 3754 }% 3755 \fi 3756} 3757 3758% Write the entry in \toks0 to the index file: 3759% 3760\def\dosubindwrite{% 3761 % Put the index entry in the margin if desired. 3762 \ifx\SETmarginindex\relax\else 3763 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% 3764 \fi 3765 % 3766 % Remember, we are within a group. 3767 \indexdummies % Must do this here, since \bf, etc expand at this stage 3768 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now 3769 % so it will be output as is; and it will print as backslash. 3770 % 3771 % Process the index entry with all font commands turned off, to 3772 % get the string to sort by. 3773 {\indexnofonts 3774 \edef\temp{\the\toks0}% need full expansion 3775 \xdef\indexsorttmp{\temp}% 3776 }% 3777 % 3778 % Set up the complete index entry, with both the sort key and 3779 % the original text, including any font commands. We write 3780 % three arguments to \entry to the .?? file (four in the 3781 % subentry case), texindex reduces to two when writing the .??s 3782 % sorted result. 3783 \edef\temp{% 3784 \write\writeto{% 3785 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% 3786 }% 3787 \temp 3788} 3789 3790% Take care of unwanted page breaks: 3791% 3792% If a skip is the last thing on the list now, preserve it 3793% by backing up by \lastskip, doing the \write, then inserting 3794% the skip again. Otherwise, the whatsit generated by the 3795% \write will make \lastskip zero. The result is that sequences 3796% like this: 3797% @end defun 3798% @tindex whatever 3799% @defun ... 3800% will have extra space inserted, because the \medbreak in the 3801% start of the @defun won't see the skip inserted by the @end of 3802% the previous defun. 3803% 3804% But don't do any of this if we're not in vertical mode. We 3805% don't want to do a \vskip and prematurely end a paragraph. 3806% 3807% Avoid page breaks due to these extra skips, too. 3808% 3809% But wait, there is a catch there: 3810% We'll have to check whether \lastskip is zero skip. \ifdim is not 3811% sufficient for this purpose, as it ignores stretch and shrink parts 3812% of the skip. The only way seems to be to check the textual 3813% representation of the skip. 3814% 3815% The following is almost like \def\zeroskipmacro{0.0pt} except that 3816% the ``p'' and ``t'' characters have catcode \other, not 11 (letter). 3817% 3818\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} 3819% 3820% ..., ready, GO: 3821% 3822\def\dosubindsanitize{% 3823 % \lastskip and \lastpenalty cannot both be nonzero simultaneously. 3824 \skip0 = \lastskip 3825 \edef\lastskipmacro{\the\lastskip}% 3826 \count255 = \lastpenalty 3827 % 3828 % If \lastskip is nonzero, that means the last item was a 3829 % skip. And since a skip is discardable, that means this 3830 % -\skip0 glue we're inserting is preceded by a 3831 % non-discardable item, therefore it is not a potential 3832 % breakpoint, therefore no \nobreak needed. 3833 \ifx\lastskipmacro\zeroskipmacro 3834 \else 3835 \vskip-\skip0 3836 \fi 3837 % 3838 \dosubindwrite 3839 % 3840 \ifx\lastskipmacro\zeroskipmacro 3841 % If \lastskip was zero, perhaps the last item was a penalty, and 3842 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want 3843 % to re-insert the same penalty (values >10000 are used for various 3844 % signals); since we just inserted a non-discardable item, any 3845 % following glue (such as a \parskip) would be a breakpoint. For example: 3846 % 3847 % @deffn deffn-whatever 3848 % @vindex index-whatever 3849 % Description. 3850 % would allow a break between the index-whatever whatsit 3851 % and the "Description." paragraph. 3852 \ifnum\count255>9999 \penalty\count255 \fi 3853 \else 3854 % On the other hand, if we had a nonzero \lastskip, 3855 % this make-up glue would be preceded by a non-discardable item 3856 % (the whatsit from the \write), so we must insert a \nobreak. 3857 \nobreak\vskip\skip0 3858 \fi 3859} 3860 3861% The index entry written in the file actually looks like 3862% \entry {sortstring}{page}{topic} 3863% or 3864% \entry {sortstring}{page}{topic}{subtopic} 3865% The texindex program reads in these files and writes files 3866% containing these kinds of lines: 3867% \initial {c} 3868% before the first topic whose initial is c 3869% \entry {topic}{pagelist} 3870% for a topic that is used without subtopics 3871% \primary {topic} 3872% for the beginning of a topic that is used with subtopics 3873% \secondary {subtopic}{pagelist} 3874% for each subtopic. 3875 3876% Define the user-accessible indexing commands 3877% @findex, @vindex, @kindex, @cindex. 3878 3879\def\findex {\fnindex} 3880\def\kindex {\kyindex} 3881\def\cindex {\cpindex} 3882\def\vindex {\vrindex} 3883\def\tindex {\tpindex} 3884\def\pindex {\pgindex} 3885 3886\def\cindexsub {\begingroup\obeylines\cindexsub} 3887{\obeylines % 3888\gdef\cindexsub "#1" #2^^M{\endgroup % 3889\dosubind{cp}{#2}{#1}}} 3890 3891% Define the macros used in formatting output of the sorted index material. 3892 3893% @printindex causes a particular index (the ??s file) to get printed. 3894% It does not print any chapter heading (usually an @unnumbered). 3895% 3896\parseargdef\printindex{\begingroup 3897 \dobreak \chapheadingskip{10000}% 3898 % 3899 \smallfonts \rm 3900 \tolerance = 9500 3901 \everypar = {}% don't want the \kern\-parindent from indentation suppression. 3902 % 3903 % See if the index file exists and is nonempty. 3904 % Change catcode of @ here so that if the index file contains 3905 % \initial {@} 3906 % as its first line, TeX doesn't complain about mismatched braces 3907 % (because it thinks @} is a control sequence). 3908 \catcode`\@ = 11 3909 \openin 1 \jobname.#1s 3910 \ifeof 1 3911 % \enddoublecolumns gets confused if there is no text in the index, 3912 % and it loses the chapter title and the aux file entries for the 3913 % index. The easiest way to prevent this problem is to make sure 3914 % there is some text. 3915 \putwordIndexNonexistent 3916 \else 3917 % 3918 % If the index file exists but is empty, then \openin leaves \ifeof 3919 % false. We have to make TeX try to read something from the file, so 3920 % it can discover if there is anything in it. 3921 \read 1 to \temp 3922 \ifeof 1 3923 \putwordIndexIsEmpty 3924 \else 3925 % Index files are almost Texinfo source, but we use \ as the escape 3926 % character. It would be better to use @, but that's too big a change 3927 % to make right now. 3928 \def\indexbackslash{\backslashcurfont}% 3929 \catcode`\\ = 0 3930 \escapechar = `\\ 3931 \begindoublecolumns 3932 \input \jobname.#1s 3933 \enddoublecolumns 3934 \fi 3935 \fi 3936 \closein 1 3937\endgroup} 3938 3939% These macros are used by the sorted index file itself. 3940% Change them to control the appearance of the index. 3941 3942\def\initial#1{{% 3943 % Some minor font changes for the special characters. 3944 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt 3945 % 3946 % Remove any glue we may have, we'll be inserting our own. 3947 \removelastskip 3948 % 3949 % We like breaks before the index initials, so insert a bonus. 3950 \nobreak 3951 \vskip 0pt plus 3\baselineskip 3952 \penalty 0 3953 \vskip 0pt plus -3\baselineskip 3954 % 3955 % Typeset the initial. Making this add up to a whole number of 3956 % baselineskips increases the chance of the dots lining up from column 3957 % to column. It still won't often be perfect, because of the stretch 3958 % we need before each entry, but it's better. 3959 % 3960 % No shrink because it confuses \balancecolumns. 3961 \vskip 1.67\baselineskip plus .5\baselineskip 3962 \leftline{\secbf #1}% 3963 % Do our best not to break after the initial. 3964 \nobreak 3965 \vskip .33\baselineskip plus .1\baselineskip 3966}} 3967 3968% \entry typesets a paragraph consisting of the text (#1), dot leaders, and 3969% then page number (#2) flushed to the right margin. It is used for index 3970% and table of contents entries. The paragraph is indented by \leftskip. 3971% 3972% A straightforward implementation would start like this: 3973% \def\entry#1#2{... 3974% But this frozes the catcodes in the argument, and can cause problems to 3975% @code, which sets - active. This problem was fixed by a kludge--- 3976% ``-'' was active throughout whole index, but this isn't really right. 3977% 3978% The right solution is to prevent \entry from swallowing the whole text. 3979% --kasal, 21nov03 3980\def\entry{% 3981 \begingroup 3982 % 3983 % Start a new paragraph if necessary, so our assignments below can't 3984 % affect previous text. 3985 \par 3986 % 3987 % Do not fill out the last line with white space. 3988 \parfillskip = 0in 3989 % 3990 % No extra space above this paragraph. 3991 \parskip = 0in 3992 % 3993 % Do not prefer a separate line ending with a hyphen to fewer lines. 3994 \finalhyphendemerits = 0 3995 % 3996 % \hangindent is only relevant when the entry text and page number 3997 % don't both fit on one line. In that case, bob suggests starting the 3998 % dots pretty far over on the line. Unfortunately, a large 3999 % indentation looks wrong when the entry text itself is broken across 4000 % lines. So we use a small indentation and put up with long leaders. 4001 % 4002 % \hangafter is reset to 1 (which is the value we want) at the start 4003 % of each paragraph, so we need not do anything with that. 4004 \hangindent = 2em 4005 % 4006 % When the entry text needs to be broken, just fill out the first line 4007 % with blank space. 4008 \rightskip = 0pt plus1fil 4009 % 4010 % A bit of stretch before each entry for the benefit of balancing 4011 % columns. 4012 \vskip 0pt plus1pt 4013 % 4014 % Swallow the left brace of the text (first parameter): 4015 \afterassignment\doentry 4016 \let\temp = 4017} 4018\def\doentry{% 4019 \bgroup % Instead of the swallowed brace. 4020 \noindent 4021 \aftergroup\finishentry 4022 % And now comes the text of the entry. 4023} 4024\def\finishentry#1{% 4025 % #1 is the page number. 4026 % 4027 % The following is kludged to not output a line of dots in the index if 4028 % there are no page numbers. The next person who breaks this will be 4029 % cursed by a Unix daemon. 4030 \def\tempa{{\rm }}% 4031 \def\tempb{#1}% 4032 \edef\tempc{\tempa}% 4033 \edef\tempd{\tempb}% 4034 \ifx\tempc\tempd 4035 \ % 4036 \else 4037 % 4038 % If we must, put the page number on a line of its own, and fill out 4039 % this line with blank space. (The \hfil is overwhelmed with the 4040 % fill leaders glue in \indexdotfill if the page number does fit.) 4041 \hfil\penalty50 4042 \null\nobreak\indexdotfill % Have leaders before the page number. 4043 % 4044 % The `\ ' here is removed by the implicit \unskip that TeX does as 4045 % part of (the primitive) \par. Without it, a spurious underfull 4046 % \hbox ensues. 4047 \ifpdf 4048 \pdfgettoks#1.% 4049 \ \the\toksA 4050 \else 4051 \ #1% 4052 \fi 4053 \fi 4054 \par 4055 \endgroup 4056} 4057 4058% Like plain.tex's \dotfill, except uses up at least 1 em. 4059\def\indexdotfill{\cleaders 4060 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill} 4061 4062\def\primary #1{\line{#1\hfil}} 4063 4064\newskip\secondaryindent \secondaryindent=0.5cm 4065\def\secondary#1#2{{% 4066 \parfillskip=0in 4067 \parskip=0in 4068 \hangindent=1in 4069 \hangafter=1 4070 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill 4071 \ifpdf 4072 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. 4073 \else 4074 #2 4075 \fi 4076 \par 4077}} 4078 4079% Define two-column mode, which we use to typeset indexes. 4080% Adapted from the TeXbook, page 416, which is to say, 4081% the manmac.tex format used to print the TeXbook itself. 4082\catcode`\@=11 4083 4084\newbox\partialpage 4085\newdimen\doublecolumnhsize 4086 4087\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns 4088 % Grab any single-column material above us. 4089 \output = {% 4090 % 4091 % Here is a possibility not foreseen in manmac: if we accumulate a 4092 % whole lot of material, we might end up calling this \output 4093 % routine twice in a row (see the doublecol-lose test, which is 4094 % essentially a couple of indexes with @setchapternewpage off). In 4095 % that case we just ship out what is in \partialpage with the normal 4096 % output routine. Generally, \partialpage will be empty when this 4097 % runs and this will be a no-op. See the indexspread.tex test case. 4098 \ifvoid\partialpage \else 4099 \onepageout{\pagecontents\partialpage}% 4100 \fi 4101 % 4102 \global\setbox\partialpage = \vbox{% 4103 % Unvbox the main output page. 4104 \unvbox\PAGE 4105 \kern-\topskip \kern\baselineskip 4106 }% 4107 }% 4108 \eject % run that output routine to set \partialpage 4109 % 4110 % Use the double-column output routine for subsequent pages. 4111 \output = {\doublecolumnout}% 4112 % 4113 % Change the page size parameters. We could do this once outside this 4114 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 4115 % format, but then we repeat the same computation. Repeating a couple 4116 % of assignments once per index is clearly meaningless for the 4117 % execution time, so we may as well do it in one place. 4118 % 4119 % First we halve the line length, less a little for the gutter between 4120 % the columns. We compute the gutter based on the line length, so it 4121 % changes automatically with the paper format. The magic constant 4122 % below is chosen so that the gutter has the same value (well, +-<1pt) 4123 % as it did when we hard-coded it. 4124 % 4125 % We put the result in a separate register, \doublecolumhsize, so we 4126 % can restore it in \pagesofar, after \hsize itself has (potentially) 4127 % been clobbered. 4128 % 4129 \doublecolumnhsize = \hsize 4130 \advance\doublecolumnhsize by -.04154\hsize 4131 \divide\doublecolumnhsize by 2 4132 \hsize = \doublecolumnhsize 4133 % 4134 % Double the \vsize as well. (We don't need a separate register here, 4135 % since nobody clobbers \vsize.) 4136 \vsize = 2\vsize 4137} 4138 4139% The double-column output routine for all double-column pages except 4140% the last. 4141% 4142\def\doublecolumnout{% 4143 \splittopskip=\topskip \splitmaxdepth=\maxdepth 4144 % Get the available space for the double columns -- the normal 4145 % (undoubled) page height minus any material left over from the 4146 % previous page. 4147 \dimen@ = \vsize 4148 \divide\dimen@ by 2 4149 \advance\dimen@ by -\ht\partialpage 4150 % 4151 % box0 will be the left-hand column, box2 the right. 4152 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ 4153 \onepageout\pagesofar 4154 \unvbox255 4155 \penalty\outputpenalty 4156} 4157% 4158% Re-output the contents of the output page -- any previous material, 4159% followed by the two boxes we just split, in box0 and box2. 4160\def\pagesofar{% 4161 \unvbox\partialpage 4162 % 4163 \hsize = \doublecolumnhsize 4164 \wd0=\hsize \wd2=\hsize 4165 \hbox to\pagewidth{\box0\hfil\box2}% 4166} 4167% 4168% All done with double columns. 4169\def\enddoublecolumns{% 4170 \output = {% 4171 % Split the last of the double-column material. Leave it on the 4172 % current page, no automatic page break. 4173 \balancecolumns 4174 % 4175 % If we end up splitting too much material for the current page, 4176 % though, there will be another page break right after this \output 4177 % invocation ends. Having called \balancecolumns once, we do not 4178 % want to call it again. Therefore, reset \output to its normal 4179 % definition right away. (We hope \balancecolumns will never be 4180 % called on to balance too much material, but if it is, this makes 4181 % the output somewhat more palatable.) 4182 \global\output = {\onepageout{\pagecontents\PAGE}}% 4183 }% 4184 \eject 4185 \endgroup % started in \begindoublecolumns 4186 % 4187 % \pagegoal was set to the doubled \vsize above, since we restarted 4188 % the current page. We're now back to normal single-column 4189 % typesetting, so reset \pagegoal to the normal \vsize (after the 4190 % \endgroup where \vsize got restored). 4191 \pagegoal = \vsize 4192} 4193% 4194% Called at the end of the double column material. 4195\def\balancecolumns{% 4196 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. 4197 \dimen@ = \ht0 4198 \advance\dimen@ by \topskip 4199 \advance\dimen@ by-\baselineskip 4200 \divide\dimen@ by 2 % target to split to 4201 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% 4202 \splittopskip = \topskip 4203 % Loop until we get a decent breakpoint. 4204 {% 4205 \vbadness = 10000 4206 \loop 4207 \global\setbox3 = \copy0 4208 \global\setbox1 = \vsplit3 to \dimen@ 4209 \ifdim\ht3>\dimen@ 4210 \global\advance\dimen@ by 1pt 4211 \repeat 4212 }% 4213 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% 4214 \setbox0=\vbox to\dimen@{\unvbox1}% 4215 \setbox2=\vbox to\dimen@{\unvbox3}% 4216 % 4217 \pagesofar 4218} 4219\catcode`\@ = \other 4220 4221 4222\message{sectioning,} 4223% Chapters, sections, etc. 4224 4225% \unnumberedno is an oxymoron, of course. But we count the unnumbered 4226% sections so that we can refer to them unambiguously in the pdf 4227% outlines by their "section number". We avoid collisions with chapter 4228% numbers by starting them at 10000. (If a document ever has 10000 4229% chapters, we're in trouble anyway, I'm sure.) 4230\newcount\unnumberedno \unnumberedno = 10000 4231\newcount\chapno 4232\newcount\secno \secno=0 4233\newcount\subsecno \subsecno=0 4234\newcount\subsubsecno \subsubsecno=0 4235 4236% This counter is funny since it counts through charcodes of letters A, B, ... 4237\newcount\appendixno \appendixno = `\@ 4238% 4239% \def\appendixletter{\char\the\appendixno} 4240% We do the following ugly conditional instead of the above simple 4241% construct for the sake of pdftex, which needs the actual 4242% letter in the expansion, not just typeset. 4243% 4244\def\appendixletter{% 4245 \ifnum\appendixno=`A A% 4246 \else\ifnum\appendixno=`B B% 4247 \else\ifnum\appendixno=`C C% 4248 \else\ifnum\appendixno=`D D% 4249 \else\ifnum\appendixno=`E E% 4250 \else\ifnum\appendixno=`F F% 4251 \else\ifnum\appendixno=`G G% 4252 \else\ifnum\appendixno=`H H% 4253 \else\ifnum\appendixno=`I I% 4254 \else\ifnum\appendixno=`J J% 4255 \else\ifnum\appendixno=`K K% 4256 \else\ifnum\appendixno=`L L% 4257 \else\ifnum\appendixno=`M M% 4258 \else\ifnum\appendixno=`N N% 4259 \else\ifnum\appendixno=`O O% 4260 \else\ifnum\appendixno=`P P% 4261 \else\ifnum\appendixno=`Q Q% 4262 \else\ifnum\appendixno=`R R% 4263 \else\ifnum\appendixno=`S S% 4264 \else\ifnum\appendixno=`T T% 4265 \else\ifnum\appendixno=`U U% 4266 \else\ifnum\appendixno=`V V% 4267 \else\ifnum\appendixno=`W W% 4268 \else\ifnum\appendixno=`X X% 4269 \else\ifnum\appendixno=`Y Y% 4270 \else\ifnum\appendixno=`Z Z% 4271 % The \the is necessary, despite appearances, because \appendixletter is 4272 % expanded while writing the .toc file. \char\appendixno is not 4273 % expandable, thus it is written literally, thus all appendixes come out 4274 % with the same letter (or @) in the toc without it. 4275 \else\char\the\appendixno 4276 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 4277 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} 4278 4279% Each @chapter defines this as the name of the chapter. 4280% page headings and footings can use it. @section does likewise. 4281% However, they are not reliable, because we don't use marks. 4282\def\thischapter{} 4283\def\thissection{} 4284 4285\newcount\absseclevel % used to calculate proper heading level 4286\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count 4287 4288% @raisesections: treat @section as chapter, @subsection as section, etc. 4289\def\raisesections{\global\advance\secbase by -1} 4290\let\up=\raisesections % original BFox name 4291 4292% @lowersections: treat @chapter as section, @section as subsection, etc. 4293\def\lowersections{\global\advance\secbase by 1} 4294\let\down=\lowersections % original BFox name 4295 4296% we only have subsub. 4297\chardef\maxseclevel = 3 4298% 4299% A numbered section within an unnumbered changes to unnumbered too. 4300% To achive this, remember the "biggest" unnum. sec. we are currently in: 4301\chardef\unmlevel = \maxseclevel 4302% 4303% Trace whether the current chapter is an appendix or not: 4304% \chapheadtype is "N" or "A", unnumbered chapters are ignored. 4305\def\chapheadtype{N} 4306 4307% Choose a heading macro 4308% #1 is heading type 4309% #2 is heading level 4310% #3 is text for heading 4311\def\genhead#1#2#3{% 4312 % Compute the abs. sec. level: 4313 \absseclevel=#2 4314 \advance\absseclevel by \secbase 4315 % Make sure \absseclevel doesn't fall outside the range: 4316 \ifnum \absseclevel < 0 4317 \absseclevel = 0 4318 \else 4319 \ifnum \absseclevel > 3 4320 \absseclevel = 3 4321 \fi 4322 \fi 4323 % The heading type: 4324 \def\headtype{#1}% 4325 \if \headtype U% 4326 \ifnum \absseclevel < \unmlevel 4327 \chardef\unmlevel = \absseclevel 4328 \fi 4329 \else 4330 % Check for appendix sections: 4331 \ifnum \absseclevel = 0 4332 \edef\chapheadtype{\headtype}% 4333 \else 4334 \if \headtype A\if \chapheadtype N% 4335 \errmessage{@appendix... within a non-appendix chapter}% 4336 \fi\fi 4337 \fi 4338 % Check for numbered within unnumbered: 4339 \ifnum \absseclevel > \unmlevel 4340 \def\headtype{U}% 4341 \else 4342 \chardef\unmlevel = 3 4343 \fi 4344 \fi 4345 % Now print the heading: 4346 \if \headtype U% 4347 \ifcase\absseclevel 4348 \unnumberedzzz{#3}% 4349 \or \unnumberedseczzz{#3}% 4350 \or \unnumberedsubseczzz{#3}% 4351 \or \unnumberedsubsubseczzz{#3}% 4352 \fi 4353 \else 4354 \if \headtype A% 4355 \ifcase\absseclevel 4356 \appendixzzz{#3}% 4357 \or \appendixsectionzzz{#3}% 4358 \or \appendixsubseczzz{#3}% 4359 \or \appendixsubsubseczzz{#3}% 4360 \fi 4361 \else 4362 \ifcase\absseclevel 4363 \chapterzzz{#3}% 4364 \or \seczzz{#3}% 4365 \or \numberedsubseczzz{#3}% 4366 \or \numberedsubsubseczzz{#3}% 4367 \fi 4368 \fi 4369 \fi 4370 \suppressfirstparagraphindent 4371} 4372 4373% an interface: 4374\def\numhead{\genhead N} 4375\def\apphead{\genhead A} 4376\def\unnmhead{\genhead U} 4377 4378% @chapter, @appendix, @unnumbered. Increment top-level counter, reset 4379% all lower-level sectioning counters to zero. 4380% 4381% Also set \chaplevelprefix, which we prepend to @float sequence numbers 4382% (e.g., figures), q.v. By default (before any chapter), that is empty. 4383\let\chaplevelprefix = \empty 4384% 4385\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz 4386\def\chapterzzz#1{% 4387 % section resetting is \global in case the chapter is in a group, such 4388 % as an @include file. 4389 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 4390 \global\advance\chapno by 1 4391 % 4392 % Used for \float. 4393 \gdef\chaplevelprefix{\the\chapno.}% 4394 \resetallfloatnos 4395 % 4396 \message{\putwordChapter\space \the\chapno}% 4397 % 4398 % Write the actual heading. 4399 \chapmacro{#1}{Ynumbered}{\the\chapno}% 4400 % 4401 % So @section and the like are numbered underneath this chapter. 4402 \global\let\section = \numberedsec 4403 \global\let\subsection = \numberedsubsec 4404 \global\let\subsubsection = \numberedsubsubsec 4405} 4406 4407\outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz 4408\def\appendixzzz#1{% 4409 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 4410 \global\advance\appendixno by 1 4411 \gdef\chaplevelprefix{\appendixletter.}% 4412 \resetallfloatnos 4413 % 4414 \def\appendixnum{\putwordAppendix\space \appendixletter}% 4415 \message{\appendixnum}% 4416 % 4417 \chapmacro{#1}{Yappendix}{\appendixletter}% 4418 % 4419 \global\let\section = \appendixsec 4420 \global\let\subsection = \appendixsubsec 4421 \global\let\subsubsection = \appendixsubsubsec 4422} 4423 4424\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz 4425\def\unnumberedzzz#1{% 4426 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 4427 \global\advance\unnumberedno by 1 4428 % 4429 % Since an unnumbered has no number, no prefix for figures. 4430 \global\let\chaplevelprefix = \empty 4431 \resetallfloatnos 4432 % 4433 % This used to be simply \message{#1}, but TeX fully expands the 4434 % argument to \message. Therefore, if #1 contained @-commands, TeX 4435 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX 4436 % expanded @cite (which turns out to cause errors because \cite is meant 4437 % to be executed, not expanded). 4438 % 4439 % Anyway, we don't want the fully-expanded definition of @cite to appear 4440 % as a result of the \message, we just want `@cite' itself. We use 4441 % \the<toks register> to achieve this: TeX expands \the<toks> only once, 4442 % simply yielding the contents of <toks register>. (We also do this for 4443 % the toc entries.) 4444 \toks0 = {#1}% 4445 \message{(\the\toks0)}% 4446 % 4447 \chapmacro{#1}{Ynothing}{\the\unnumberedno}% 4448 % 4449 \global\let\section = \unnumberedsec 4450 \global\let\subsection = \unnumberedsubsec 4451 \global\let\subsubsection = \unnumberedsubsubsec 4452} 4453 4454% @centerchap is like @unnumbered, but the heading is centered. 4455\outer\parseargdef\centerchap{% 4456 % Well, we could do the following in a group, but that would break 4457 % an assumption that \chapmacro is called at the outermost level. 4458 % Thus we are safer this way: --kasal, 24feb04 4459 \let\centerparametersmaybe = \centerparameters 4460 \unnmhead0{#1}% 4461 \let\centerparametersmaybe = \relax 4462} 4463 4464% @top is like @unnumbered. 4465\let\top\unnumbered 4466 4467% Sections. 4468\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz 4469\def\seczzz#1{% 4470 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 4471 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% 4472} 4473 4474\outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz 4475\def\appendixsectionzzz#1{% 4476 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 4477 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% 4478} 4479\let\appendixsec\appendixsection 4480 4481\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz 4482\def\unnumberedseczzz#1{% 4483 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 4484 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% 4485} 4486 4487% Subsections. 4488\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz 4489\def\numberedsubseczzz#1{% 4490 \global\subsubsecno=0 \global\advance\subsecno by 1 4491 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% 4492} 4493 4494\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz 4495\def\appendixsubseczzz#1{% 4496 \global\subsubsecno=0 \global\advance\subsecno by 1 4497 \sectionheading{#1}{subsec}{Yappendix}% 4498 {\appendixletter.\the\secno.\the\subsecno}% 4499} 4500 4501\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz 4502\def\unnumberedsubseczzz#1{% 4503 \global\subsubsecno=0 \global\advance\subsecno by 1 4504 \sectionheading{#1}{subsec}{Ynothing}% 4505 {\the\unnumberedno.\the\secno.\the\subsecno}% 4506} 4507 4508% Subsubsections. 4509\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz 4510\def\numberedsubsubseczzz#1{% 4511 \global\advance\subsubsecno by 1 4512 \sectionheading{#1}{subsubsec}{Ynumbered}% 4513 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% 4514} 4515 4516\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz 4517\def\appendixsubsubseczzz#1{% 4518 \global\advance\subsubsecno by 1 4519 \sectionheading{#1}{subsubsec}{Yappendix}% 4520 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% 4521} 4522 4523\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz 4524\def\unnumberedsubsubseczzz#1{% 4525 \global\advance\subsubsecno by 1 4526 \sectionheading{#1}{subsubsec}{Ynothing}% 4527 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% 4528} 4529 4530% These macros control what the section commands do, according 4531% to what kind of chapter we are in (ordinary, appendix, or unnumbered). 4532% Define them by default for a numbered chapter. 4533\let\section = \numberedsec 4534\let\subsection = \numberedsubsec 4535\let\subsubsection = \numberedsubsubsec 4536 4537% Define @majorheading, @heading and @subheading 4538 4539% NOTE on use of \vbox for chapter headings, section headings, and such: 4540% 1) We use \vbox rather than the earlier \line to permit 4541% overlong headings to fold. 4542% 2) \hyphenpenalty is set to 10000 because hyphenation in a 4543% heading is obnoxious; this forbids it. 4544% 3) Likewise, headings look best if no \parindent is used, and 4545% if justification is not attempted. Hence \raggedright. 4546 4547 4548\def\majorheading{% 4549 {\advance\chapheadingskip by 10pt \chapbreak }% 4550 \parsearg\chapheadingzzz 4551} 4552 4553\def\chapheading{\chapbreak \parsearg\chapheadingzzz} 4554\def\chapheadingzzz#1{% 4555 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 4556 \parindent=0pt\raggedright 4557 \rm #1\hfill}}% 4558 \bigskip \par\penalty 200\relax 4559 \suppressfirstparagraphindent 4560} 4561 4562% @heading, @subheading, @subsubheading. 4563\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} 4564 \suppressfirstparagraphindent} 4565\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} 4566 \suppressfirstparagraphindent} 4567\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} 4568 \suppressfirstparagraphindent} 4569 4570% These macros generate a chapter, section, etc. heading only 4571% (including whitespace, linebreaking, etc. around it), 4572% given all the information in convenient, parsed form. 4573 4574%%% Args are the skip and penalty (usually negative) 4575\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} 4576 4577%%% Define plain chapter starts, and page on/off switching for it 4578% Parameter controlling skip before chapter headings (if needed) 4579 4580\newskip\chapheadingskip 4581 4582\def\chapbreak{\dobreak \chapheadingskip {-4000}} 4583\def\chappager{\par\vfill\supereject} 4584\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} 4585 4586\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} 4587 4588\def\CHAPPAGoff{% 4589\global\let\contentsalignmacro = \chappager 4590\global\let\pchapsepmacro=\chapbreak 4591\global\let\pagealignmacro=\chappager} 4592 4593\def\CHAPPAGon{% 4594\global\let\contentsalignmacro = \chappager 4595\global\let\pchapsepmacro=\chappager 4596\global\let\pagealignmacro=\chappager 4597\global\def\HEADINGSon{\HEADINGSsingle}} 4598 4599\def\CHAPPAGodd{% 4600\global\let\contentsalignmacro = \chapoddpage 4601\global\let\pchapsepmacro=\chapoddpage 4602\global\let\pagealignmacro=\chapoddpage 4603\global\def\HEADINGSon{\HEADINGSdouble}} 4604 4605\CHAPPAGon 4606 4607% Chapter opening. 4608% 4609% #1 is the text, #2 is the section type (Ynumbered, Ynothing, 4610% Yappendix, Yomitfromtoc), #3 the chapter number. 4611% 4612% To test against our argument. 4613\def\Ynothingkeyword{Ynothing} 4614\def\Yomitfromtockeyword{Yomitfromtoc} 4615\def\Yappendixkeyword{Yappendix} 4616% 4617\def\chapmacro#1#2#3{% 4618 \pchapsepmacro 4619 {% 4620 \chapfonts \rm 4621 % 4622 % Have to define \thissection before calling \donoderef, because the 4623 % xref code eventually uses it. On the other hand, it has to be called 4624 % after \pchapsepmacro, or the headline will change too soon. 4625 \gdef\thissection{#1}% 4626 \gdef\thischaptername{#1}% 4627 % 4628 % Only insert the separating space if we have a chapter/appendix 4629 % number, and don't print the unnumbered ``number''. 4630 \def\temptype{#2}% 4631 \ifx\temptype\Ynothingkeyword 4632 \setbox0 = \hbox{}% 4633 \def\toctype{unnchap}% 4634 \gdef\thischapternum{}% 4635 \gdef\thischapter{#1}% 4636 \else\ifx\temptype\Yomitfromtockeyword 4637 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry 4638 \def\toctype{omit}% 4639 \gdef\thischapternum{}% 4640 \gdef\thischapter{}% 4641 \else\ifx\temptype\Yappendixkeyword 4642 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% 4643 \def\toctype{app}% 4644 \xdef\thischapternum{\appendixletter}% 4645 % We don't substitute the actual chapter name into \thischapter 4646 % because we don't want its macros evaluated now. And we don't 4647 % use \thissection because that changes with each section. 4648 % 4649 \xdef\thischapter{\putwordAppendix{} \appendixletter: 4650 \noexpand\thischaptername}% 4651 \else 4652 \setbox0 = \hbox{#3\enspace}% 4653 \def\toctype{numchap}% 4654 \xdef\thischapternum{\the\chapno}% 4655 \xdef\thischapter{\putwordChapter{} \the\chapno: 4656 \noexpand\thischaptername}% 4657 \fi\fi\fi 4658 % 4659 % Write the toc entry for this chapter. Must come before the 4660 % \donoderef, because we include the current node name in the toc 4661 % entry, and \donoderef resets it to empty. 4662 \writetocentry{\toctype}{#1}{#3}% 4663 % 4664 % For pdftex, we have to write out the node definition (aka, make 4665 % the pdfdest) after any page break, but before the actual text has 4666 % been typeset. If the destination for the pdf outline is after the 4667 % text, then jumping from the outline may wind up with the text not 4668 % being visible, for instance under high magnification. 4669 \donoderef{#2}% 4670 % 4671 % Typeset the actual heading. 4672 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 4673 \hangindent=\wd0 \centerparametersmaybe 4674 \unhbox0 #1\par}% 4675 }% 4676 \nobreak\bigskip % no page break after a chapter title 4677 \nobreak 4678} 4679 4680% @centerchap -- centered and unnumbered. 4681\let\centerparametersmaybe = \relax 4682\def\centerparameters{% 4683 \advance\rightskip by 3\rightskip 4684 \leftskip = \rightskip 4685 \parfillskip = 0pt 4686} 4687 4688 4689% I don't think this chapter style is supported any more, so I'm not 4690% updating it with the new noderef stuff. We'll see. --karl, 11aug03. 4691% 4692\def\setchapterstyle #1 {\csname CHAPF#1\endcsname} 4693% 4694\def\unnchfopen #1{% 4695\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 4696 \parindent=0pt\raggedright 4697 \rm #1\hfill}}\bigskip \par\nobreak 4698} 4699\def\chfopen #1#2{\chapoddpage {\chapfonts 4700\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% 4701\par\penalty 5000 % 4702} 4703\def\centerchfopen #1{% 4704\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 4705 \parindent=0pt 4706 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak 4707} 4708\def\CHAPFopen{% 4709 \global\let\chapmacro=\chfopen 4710 \global\let\centerchapmacro=\centerchfopen} 4711 4712 4713% Section titles. These macros combine the section number parts and 4714% call the generic \sectionheading to do the printing. 4715% 4716\newskip\secheadingskip 4717\def\secheadingbreak{\dobreak \secheadingskip{-1000}} 4718 4719% Subsection titles. 4720\newskip\subsecheadingskip 4721\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} 4722 4723% Subsubsection titles. 4724\def\subsubsecheadingskip{\subsecheadingskip} 4725\def\subsubsecheadingbreak{\subsecheadingbreak} 4726 4727 4728% Print any size, any type, section title. 4729% 4730% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is 4731% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the 4732% section number. 4733% 4734\def\sectionheading#1#2#3#4{% 4735 {% 4736 % Switch to the right set of fonts. 4737 \csname #2fonts\endcsname \rm 4738 % 4739 % Insert space above the heading. 4740 \csname #2headingbreak\endcsname 4741 % 4742 % Only insert the space after the number if we have a section number. 4743 \def\sectionlevel{#2}% 4744 \def\temptype{#3}% 4745 % 4746 \ifx\temptype\Ynothingkeyword 4747 \setbox0 = \hbox{}% 4748 \def\toctype{unn}% 4749 \gdef\thissection{#1}% 4750 \else\ifx\temptype\Yomitfromtockeyword 4751 % for @headings -- no section number, don't include in toc, 4752 % and don't redefine \thissection. 4753 \setbox0 = \hbox{}% 4754 \def\toctype{omit}% 4755 \let\sectionlevel=\empty 4756 \else\ifx\temptype\Yappendixkeyword 4757 \setbox0 = \hbox{#4\enspace}% 4758 \def\toctype{app}% 4759 \gdef\thissection{#1}% 4760 \else 4761 \setbox0 = \hbox{#4\enspace}% 4762 \def\toctype{num}% 4763 \gdef\thissection{#1}% 4764 \fi\fi\fi 4765 % 4766 % Write the toc entry (before \donoderef). See comments in \chapmacro. 4767 \writetocentry{\toctype\sectionlevel}{#1}{#4}% 4768 % 4769 % Write the node reference (= pdf destination for pdftex). 4770 % Again, see comments in \chapmacro. 4771 \donoderef{#3}% 4772 % 4773 % Interline glue will be inserted when the vbox is completed. 4774 % That glue will be a valid breakpoint for the page, since it'll be 4775 % preceded by a whatsit (usually from the \donoderef, or from the 4776 % \writetocentry if there was no node). We don't want to allow that 4777 % break, since then the whatsits could end up on page n while the 4778 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000. 4779 \nobreak 4780 % 4781 % Output the actual section heading. 4782 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 4783 \hangindent=\wd0 % zero if no section number 4784 \unhbox0 #1}% 4785 }% 4786 % Add extra space after the heading -- half of whatever came above it. 4787 % Don't allow stretch, though. 4788 \kern .5 \csname #2headingskip\endcsname 4789 % 4790 % Do not let the kern be a potential breakpoint, as it would be if it 4791 % was followed by glue. 4792 \nobreak 4793 % 4794 % We'll almost certainly start a paragraph next, so don't let that 4795 % glue accumulate. (Not a breakpoint because it's preceded by a 4796 % discardable item.) 4797 \vskip-\parskip 4798 % 4799 % This is purely so the last item on the list is a known \penalty > 4800 % 10000. This is so \startdefun can avoid allowing breakpoints after 4801 % section headings. Otherwise, it would insert a valid breakpoint between: 4802 % 4803 % @section sec-whatever 4804 % @deffn def-whatever 4805 \penalty 10001 4806} 4807 4808 4809\message{toc,} 4810% Table of contents. 4811\newwrite\tocfile 4812 4813% Write an entry to the toc file, opening it if necessary. 4814% Called from @chapter, etc. 4815% 4816% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} 4817% We append the current node name (if any) and page number as additional 4818% arguments for the \{chap,sec,...}entry macros which will eventually 4819% read this. The node name is used in the pdf outlines as the 4820% destination to jump to. 4821% 4822% We open the .toc file for writing here instead of at @setfilename (or 4823% any other fixed time) so that @contents can be anywhere in the document. 4824% But if #1 is `omit', then we don't do anything. This is used for the 4825% table of contents chapter openings themselves. 4826% 4827\newif\iftocfileopened 4828\def\omitkeyword{omit}% 4829% 4830\def\writetocentry#1#2#3{% 4831 \edef\writetoctype{#1}% 4832 \ifx\writetoctype\omitkeyword \else 4833 \iftocfileopened\else 4834 \immediate\openout\tocfile = \jobname.toc 4835 \global\tocfileopenedtrue 4836 \fi 4837 % 4838 \iflinks 4839 {\atdummies 4840 \edef\temp{% 4841 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}% 4842 \temp 4843 }% 4844 \fi 4845 \fi 4846 % 4847 % Tell \shipout to create a pdf destination on each page, if we're 4848 % writing pdf. These are used in the table of contents. We can't 4849 % just write one on every page because the title pages are numbered 4850 % 1 and 2 (the page numbers aren't printed), and so are the first 4851 % two pages of the document. Thus, we'd have two destinations named 4852 % `1', and two named `2'. 4853 \ifpdf \global\pdfmakepagedesttrue \fi 4854} 4855 4856 4857% These characters do not print properly in the Computer Modern roman 4858% fonts, so we must take special care. This is more or less redundant 4859% with the Texinfo input format setup at the end of this file. 4860% 4861\def\activecatcodes{% 4862 \catcode`\"=\active 4863 \catcode`\$=\active 4864 \catcode`\<=\active 4865 \catcode`\>=\active 4866 \catcode`\\=\active 4867 \catcode`\^=\active 4868 \catcode`\_=\active 4869 \catcode`\|=\active 4870 \catcode`\~=\active 4871} 4872 4873 4874% Read the toc file, which is essentially Texinfo input. 4875\def\readtocfile{% 4876 \setupdatafile 4877 \activecatcodes 4878 \input \jobname.toc 4879} 4880 4881\newskip\contentsrightmargin \contentsrightmargin=1in 4882\newcount\savepageno 4883\newcount\lastnegativepageno \lastnegativepageno = -1 4884 4885% Prepare to read what we've written to \tocfile. 4886% 4887\def\startcontents#1{% 4888 % If @setchapternewpage on, and @headings double, the contents should 4889 % start on an odd page, unlike chapters. Thus, we maintain 4890 % \contentsalignmacro in parallel with \pagealignmacro. 4891 % From: Torbjorn Granlund <tege@matematik.su.se> 4892 \contentsalignmacro 4893 \immediate\closeout\tocfile 4894 % 4895 % Don't need to put `Contents' or `Short Contents' in the headline. 4896 % It is abundantly clear what they are. 4897 \def\thischapter{}% 4898 \chapmacro{#1}{Yomitfromtoc}{}% 4899 % 4900 \savepageno = \pageno 4901 \begingroup % Set up to handle contents files properly. 4902 \raggedbottom % Worry more about breakpoints than the bottom. 4903 \advance\hsize by -\contentsrightmargin % Don't use the full line length. 4904 % 4905 % Roman numerals for page numbers. 4906 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi 4907} 4908 4909 4910% Normal (long) toc. 4911\def\contents{% 4912 \startcontents{\putwordTOC}% 4913 \openin 1 \jobname.toc 4914 \ifeof 1 \else 4915 \readtocfile 4916 \fi 4917 \vfill \eject 4918 \contentsalignmacro % in case @setchapternewpage odd is in effect 4919 \ifeof 1 \else 4920 \pdfmakeoutlines 4921 \fi 4922 \closein 1 4923 \endgroup 4924 \lastnegativepageno = \pageno 4925 \global\pageno = \savepageno 4926} 4927 4928% And just the chapters. 4929\def\summarycontents{% 4930 \startcontents{\putwordShortTOC}% 4931 % 4932 \let\numchapentry = \shortchapentry 4933 \let\appentry = \shortchapentry 4934 \let\unnchapentry = \shortunnchapentry 4935 % We want a true roman here for the page numbers. 4936 \secfonts 4937 \let\rm=\shortcontrm \let\bf=\shortcontbf 4938 \let\sl=\shortcontsl \let\tt=\shortconttt 4939 \rm 4940 \hyphenpenalty = 10000 4941 \advance\baselineskip by 1pt % Open it up a little. 4942 \def\numsecentry##1##2##3##4{} 4943 \let\appsecentry = \numsecentry 4944 \let\unnsecentry = \numsecentry 4945 \let\numsubsecentry = \numsecentry 4946 \let\appsubsecentry = \numsecentry 4947 \let\unnsubsecentry = \numsecentry 4948 \let\numsubsubsecentry = \numsecentry 4949 \let\appsubsubsecentry = \numsecentry 4950 \let\unnsubsubsecentry = \numsecentry 4951 \openin 1 \jobname.toc 4952 \ifeof 1 \else 4953 \readtocfile 4954 \fi 4955 \closein 1 4956 \vfill \eject 4957 \contentsalignmacro % in case @setchapternewpage odd is in effect 4958 \endgroup 4959 \lastnegativepageno = \pageno 4960 \global\pageno = \savepageno 4961} 4962\let\shortcontents = \summarycontents 4963 4964% Typeset the label for a chapter or appendix for the short contents. 4965% The arg is, e.g., `A' for an appendix, or `3' for a chapter. 4966% 4967\def\shortchaplabel#1{% 4968 % This space should be enough, since a single number is .5em, and the 4969 % widest letter (M) is 1em, at least in the Computer Modern fonts. 4970 % But use \hss just in case. 4971 % (This space doesn't include the extra space that gets added after 4972 % the label; that gets put in by \shortchapentry above.) 4973 % 4974 % We'd like to right-justify chapter numbers, but that looks strange 4975 % with appendix letters. And right-justifying numbers and 4976 % left-justifying letters looks strange when there is less than 10 4977 % chapters. Have to read the whole toc once to know how many chapters 4978 % there are before deciding ... 4979 \hbox to 1em{#1\hss}% 4980} 4981 4982% These macros generate individual entries in the table of contents. 4983% The first argument is the chapter or section name. 4984% The last argument is the page number. 4985% The arguments in between are the chapter number, section number, ... 4986 4987% Chapters, in the main contents. 4988\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} 4989% 4990% Chapters, in the short toc. 4991% See comments in \dochapentry re vbox and related settings. 4992\def\shortchapentry#1#2#3#4{% 4993 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% 4994} 4995 4996% Appendices, in the main contents. 4997% Need the word Appendix, and a fixed-size box. 4998% 4999\def\appendixbox#1{% 5000 % We use M since it's probably the widest letter. 5001 \setbox0 = \hbox{\putwordAppendix{} M}% 5002 \hbox to \wd0{\putwordAppendix{} #1\hss}} 5003% 5004\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} 5005 5006% Unnumbered chapters. 5007\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} 5008\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} 5009 5010% Sections. 5011\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} 5012\let\appsecentry=\numsecentry 5013\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} 5014 5015% Subsections. 5016\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} 5017\let\appsubsecentry=\numsubsecentry 5018\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} 5019 5020% And subsubsections. 5021\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} 5022\let\appsubsubsecentry=\numsubsubsecentry 5023\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} 5024 5025% This parameter controls the indentation of the various levels. 5026% Same as \defaultparindent. 5027\newdimen\tocindent \tocindent = 15pt 5028 5029% Now for the actual typesetting. In all these, #1 is the text and #2 is the 5030% page number. 5031% 5032% If the toc has to be broken over pages, we want it to be at chapters 5033% if at all possible; hence the \penalty. 5034\def\dochapentry#1#2{% 5035 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip 5036 \begingroup 5037 \chapentryfonts 5038 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 5039 \endgroup 5040 \nobreak\vskip .25\baselineskip plus.1\baselineskip 5041} 5042 5043\def\dosecentry#1#2{\begingroup 5044 \secentryfonts \leftskip=\tocindent 5045 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 5046\endgroup} 5047 5048\def\dosubsecentry#1#2{\begingroup 5049 \subsecentryfonts \leftskip=2\tocindent 5050 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 5051\endgroup} 5052 5053\def\dosubsubsecentry#1#2{\begingroup 5054 \subsubsecentryfonts \leftskip=3\tocindent 5055 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 5056\endgroup} 5057 5058% We use the same \entry macro as for the index entries. 5059\let\tocentry = \entry 5060 5061% Space between chapter (or whatever) number and the title. 5062\def\labelspace{\hskip1em \relax} 5063 5064\def\dopageno#1{{\rm #1}} 5065\def\doshortpageno#1{{\rm #1}} 5066 5067\def\chapentryfonts{\secfonts \rm} 5068\def\secentryfonts{\textfonts} 5069\def\subsecentryfonts{\textfonts} 5070\def\subsubsecentryfonts{\textfonts} 5071 5072 5073\message{environments,} 5074% @foo ... @end foo. 5075 5076% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. 5077% 5078% Since these characters are used in examples, it should be an even number of 5079% \tt widths. Each \tt character is 1en, so two makes it 1em. 5080% 5081\def\point{$\star$} 5082\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} 5083\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} 5084\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} 5085\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} 5086 5087% The @error{} command. 5088% Adapted from the TeXbook's \boxit. 5089% 5090\newbox\errorbox 5091% 5092{\tentt \global\dimen0 = 3em}% Width of the box. 5093\dimen2 = .55pt % Thickness of rules 5094% The text. (`r' is open on the right, `e' somewhat less so on the left.) 5095\setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt} 5096% 5097\setbox\errorbox=\hbox to \dimen0{\hfil 5098 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. 5099 \advance\hsize by -2\dimen2 % Rules. 5100 \vbox{% 5101 \hrule height\dimen2 5102 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. 5103 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. 5104 \kern3pt\vrule width\dimen2}% Space to right. 5105 \hrule height\dimen2} 5106 \hfil} 5107% 5108\def\error{\leavevmode\lower.7ex\copy\errorbox} 5109 5110% @tex ... @end tex escapes into raw Tex temporarily. 5111% One exception: @ is still an escape character, so that @end tex works. 5112% But \@ or @@ will get a plain tex @ character. 5113 5114\envdef\tex{% 5115 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 5116 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 5117 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie 5118 \catcode `\%=14 5119 \catcode `\+=\other 5120 \catcode `\"=\other 5121 \catcode `\|=\other 5122 \catcode `\<=\other 5123 \catcode `\>=\other 5124 \escapechar=`\\ 5125 % 5126 \let\b=\ptexb 5127 \let\bullet=\ptexbullet 5128 \let\c=\ptexc 5129 \let\,=\ptexcomma 5130 \let\.=\ptexdot 5131 \let\dots=\ptexdots 5132 \let\equiv=\ptexequiv 5133 \let\!=\ptexexclam 5134 \let\i=\ptexi 5135 \let\indent=\ptexindent 5136 \let\noindent=\ptexnoindent 5137 \let\{=\ptexlbrace 5138 \let\+=\tabalign 5139 \let\}=\ptexrbrace 5140 \let\/=\ptexslash 5141 \let\*=\ptexstar 5142 \let\t=\ptext 5143 \let\frenchspacing=\plainfrenchspacing 5144 % 5145 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% 5146 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% 5147 \def\@{@}% 5148} 5149% There is no need to define \Etex. 5150 5151% Define @lisp ... @end lisp. 5152% @lisp environment forms a group so it can rebind things, 5153% including the definition of @end lisp (which normally is erroneous). 5154 5155% Amount to narrow the margins by for @lisp. 5156\newskip\lispnarrowing \lispnarrowing=0.4in 5157 5158% This is the definition that ^^M gets inside @lisp, @example, and other 5159% such environments. \null is better than a space, since it doesn't 5160% have any width. 5161\def\lisppar{\null\endgraf} 5162 5163% This space is always present above and below environments. 5164\newskip\envskipamount \envskipamount = 0pt 5165 5166% Make spacing and below environment symmetrical. We use \parskip here 5167% to help in doing that, since in @example-like environments \parskip 5168% is reset to zero; thus the \afterenvbreak inserts no space -- but the 5169% start of the next paragraph will insert \parskip. 5170% 5171\def\aboveenvbreak{{% 5172 % =10000 instead of <10000 because of a special case in \itemzzz and 5173 % \sectionheading, q.v. 5174 \ifnum \lastpenalty=10000 \else 5175 \advance\envskipamount by \parskip 5176 \endgraf 5177 \ifdim\lastskip<\envskipamount 5178 \removelastskip 5179 % it's not a good place to break if the last penalty was \nobreak 5180 % or better ... 5181 \ifnum\lastpenalty<10000 \penalty-50 \fi 5182 \vskip\envskipamount 5183 \fi 5184 \fi 5185}} 5186 5187\let\afterenvbreak = \aboveenvbreak 5188 5189% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will 5190% also clear it, so that its embedded environments do the narrowing again. 5191\let\nonarrowing=\relax 5192 5193% @cartouche ... @end cartouche: draw rectangle w/rounded corners around 5194% environment contents. 5195\font\circle=lcircle10 5196\newdimen\circthick 5197\newdimen\cartouter\newdimen\cartinner 5198\newskip\normbskip\newskip\normpskip\newskip\normlskip 5199\circthick=\fontdimen8\circle 5200% 5201\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth 5202\def\ctr{{\hskip 6pt\circle\char'010}} 5203\def\cbl{{\circle\char'012\hskip -6pt}} 5204\def\cbr{{\hskip 6pt\circle\char'011}} 5205\def\carttop{\hbox to \cartouter{\hskip\lskip 5206 \ctl\leaders\hrule height\circthick\hfil\ctr 5207 \hskip\rskip}} 5208\def\cartbot{\hbox to \cartouter{\hskip\lskip 5209 \cbl\leaders\hrule height\circthick\hfil\cbr 5210 \hskip\rskip}} 5211% 5212\newskip\lskip\newskip\rskip 5213 5214\envdef\cartouche{% 5215 \ifhmode\par\fi % can't be in the midst of a paragraph. 5216 \startsavinginserts 5217 \lskip=\leftskip \rskip=\rightskip 5218 \leftskip=0pt\rightskip=0pt % we want these *outside*. 5219 \cartinner=\hsize \advance\cartinner by-\lskip 5220 \advance\cartinner by-\rskip 5221 \cartouter=\hsize 5222 \advance\cartouter by 18.4pt % allow for 3pt kerns on either 5223 % side, and for 6pt waste from 5224 % each corner char, and rule thickness 5225 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip 5226 % Flag to tell @lisp, etc., not to narrow margin. 5227 \let\nonarrowing = t% 5228 \vbox\bgroup 5229 \baselineskip=0pt\parskip=0pt\lineskip=0pt 5230 \carttop 5231 \hbox\bgroup 5232 \hskip\lskip 5233 \vrule\kern3pt 5234 \vbox\bgroup 5235 \kern3pt 5236 \hsize=\cartinner 5237 \baselineskip=\normbskip 5238 \lineskip=\normlskip 5239 \parskip=\normpskip 5240 \vskip -\parskip 5241 \comment % For explanation, see the end of \def\group. 5242} 5243\def\Ecartouche{% 5244 \ifhmode\par\fi 5245 \kern3pt 5246 \egroup 5247 \kern3pt\vrule 5248 \hskip\rskip 5249 \egroup 5250 \cartbot 5251 \egroup 5252 \checkinserts 5253} 5254 5255 5256% This macro is called at the beginning of all the @example variants, 5257% inside a group. 5258\def\nonfillstart{% 5259 \aboveenvbreak 5260 \hfuzz = 12pt % Don't be fussy 5261 \sepspaces % Make spaces be word-separators rather than space tokens. 5262 \let\par = \lisppar % don't ignore blank lines 5263 \obeylines % each line of input is a line of output 5264 \parskip = 0pt 5265 \parindent = 0pt 5266 \emergencystretch = 0pt % don't try to avoid overfull boxes 5267 \ifx\nonarrowing\relax 5268 \advance \leftskip by \lispnarrowing 5269 \exdentamount=\lispnarrowing 5270 \else 5271 \let\nonarrowing = \relax 5272 \fi 5273 \let\exdent=\nofillexdent 5274} 5275 5276% If you want all examples etc. small: @set dispenvsize small. 5277% If you want even small examples the full size: @set dispenvsize nosmall. 5278% This affects the following displayed environments: 5279% @example, @display, @format, @lisp 5280% 5281\def\smallword{small} 5282\def\nosmallword{nosmall} 5283\let\SETdispenvsize\relax 5284\def\setnormaldispenv{% 5285 \ifx\SETdispenvsize\smallword 5286 \smallexamplefonts \rm 5287 \fi 5288} 5289\def\setsmalldispenv{% 5290 \ifx\SETdispenvsize\nosmallword 5291 \else 5292 \smallexamplefonts \rm 5293 \fi 5294} 5295 5296% We often define two environments, @foo and @smallfoo. 5297% Let's do it by one command: 5298\def\makedispenv #1#2{ 5299 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2} 5300 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2} 5301 \expandafter\let\csname E#1\endcsname \afterenvbreak 5302 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak 5303} 5304 5305% Define two synonyms: 5306\def\maketwodispenvs #1#2#3{ 5307 \makedispenv{#1}{#3} 5308 \makedispenv{#2}{#3} 5309} 5310 5311% @lisp: indented, narrowed, typewriter font; @example: same as @lisp. 5312% 5313% @smallexample and @smalllisp: use smaller fonts. 5314% Originally contributed by Pavel@xerox. 5315% 5316\maketwodispenvs {lisp}{example}{% 5317 \nonfillstart 5318 \tt\quoteexpand 5319 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. 5320 \gobble % eat return 5321} 5322% @display/@smalldisplay: same as @lisp except keep current font. 5323% 5324\makedispenv {display}{% 5325 \nonfillstart 5326 \gobble 5327} 5328 5329% @format/@smallformat: same as @display except don't narrow margins. 5330% 5331\makedispenv{format}{% 5332 \let\nonarrowing = t% 5333 \nonfillstart 5334 \gobble 5335} 5336 5337% @flushleft: same as @format, but doesn't obey \SETdispenvsize. 5338\envdef\flushleft{% 5339 \let\nonarrowing = t% 5340 \nonfillstart 5341 \gobble 5342} 5343\let\Eflushleft = \afterenvbreak 5344 5345% @flushright. 5346% 5347\envdef\flushright{% 5348 \let\nonarrowing = t% 5349 \nonfillstart 5350 \advance\leftskip by 0pt plus 1fill 5351 \gobble 5352} 5353\let\Eflushright = \afterenvbreak 5354 5355 5356% @quotation does normal linebreaking (hence we can't use \nonfillstart) 5357% and narrows the margins. We keep \parskip nonzero in general, since 5358% we're doing normal filling. So, when using \aboveenvbreak and 5359% \afterenvbreak, temporarily make \parskip 0. 5360% 5361\envdef\quotation{% 5362 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip 5363 \parindent=0pt 5364 % 5365 % @cartouche defines \nonarrowing to inhibit narrowing at next level down. 5366 \ifx\nonarrowing\relax 5367 \advance\leftskip by \lispnarrowing 5368 \advance\rightskip by \lispnarrowing 5369 \exdentamount = \lispnarrowing 5370 \else 5371 \let\nonarrowing = \relax 5372 \fi 5373 \parsearg\quotationlabel 5374} 5375 5376% We have retained a nonzero parskip for the environment, since we're 5377% doing normal filling. 5378% 5379\def\Equotation{% 5380 \par 5381 \ifx\quotationauthor\undefined\else 5382 % indent a bit. 5383 \leftline{\kern 2\leftskip \sl ---\quotationauthor}% 5384 \fi 5385 {\parskip=0pt \afterenvbreak}% 5386} 5387 5388% If we're given an argument, typeset it in bold with a colon after. 5389\def\quotationlabel#1{% 5390 \def\temp{#1}% 5391 \ifx\temp\empty \else 5392 {\bf #1: }% 5393 \fi 5394} 5395 5396 5397% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} 5398% If we want to allow any <char> as delimiter, 5399% we need the curly braces so that makeinfo sees the @verb command, eg: 5400% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org 5401% 5402% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. 5403% 5404% [Knuth] p.344; only we need to do the other characters Texinfo sets 5405% active too. Otherwise, they get lost as the first character on a 5406% verbatim line. 5407\def\dospecials{% 5408 \do\ \do\\\do\{\do\}\do\$\do\&% 5409 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% 5410 \do\<\do\>\do\|\do\@\do+\do\"% 5411} 5412% 5413% [Knuth] p. 380 5414\def\uncatcodespecials{% 5415 \def\do##1{\catcode`##1=\other}\dospecials} 5416% 5417% [Knuth] pp. 380,381,391 5418% Disable Spanish ligatures ?` and !` of \tt font 5419\begingroup 5420 \catcode`\`=\active\gdef`{\relax\lq} 5421\endgroup 5422% 5423% Setup for the @verb command. 5424% 5425% Eight spaces for a tab 5426\begingroup 5427 \catcode`\^^I=\active 5428 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} 5429\endgroup 5430% 5431\def\setupverb{% 5432 \tt % easiest (and conventionally used) font for verbatim 5433 \def\par{\leavevmode\endgraf}% 5434 \catcode`\`=\active 5435 \tabeightspaces 5436 % Respect line breaks, 5437 % print special symbols as themselves, and 5438 % make each space count 5439 % must do in this order: 5440 \obeylines \uncatcodespecials \sepspaces 5441} 5442 5443% Setup for the @verbatim environment 5444% 5445% Real tab expansion 5446\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount 5447% 5448\def\starttabbox{\setbox0=\hbox\bgroup} 5449 5450% Allow an option to not replace quotes with a regular directed right 5451% quote/apostrophe (char 0x27), but instead use the undirected quote 5452% from cmtt (char 0x0d). The undirected quote is ugly, so don't make it 5453% the default, but it works for pasting with more pdf viewers (at least 5454% evince), the lilypond developers report. xpdf does work with the 5455% regular 0x27. 5456% 5457\def\codequoteright{% 5458 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax 5459 '% 5460 \else 5461 \char'15 5462 \fi 5463} 5464% 5465% and a similar option for the left quote char vs. a grave accent. 5466% Modern fonts display ASCII 0x60 as a grave accent, so some people like 5467% the code environments to do likewise. 5468% 5469\def\codequoteleft{% 5470 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax 5471 `% 5472 \else 5473 \char'22 5474 \fi 5475} 5476% 5477\begingroup 5478 \catcode`\^^I=\active 5479 \gdef\tabexpand{% 5480 \catcode`\^^I=\active 5481 \def^^I{\leavevmode\egroup 5482 \dimen0=\wd0 % the width so far, or since the previous tab 5483 \divide\dimen0 by\tabw 5484 \multiply\dimen0 by\tabw % compute previous multiple of \tabw 5485 \advance\dimen0 by\tabw % advance to next multiple of \tabw 5486 \wd0=\dimen0 \box0 \starttabbox 5487 }% 5488 } 5489 \catcode`\'=\active 5490 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}% 5491 % 5492 \catcode`\`=\active 5493 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}% 5494 % 5495 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}% 5496\endgroup 5497 5498% start the verbatim environment. 5499\def\setupverbatim{% 5500 \let\nonarrowing = t% 5501 \nonfillstart 5502 % Easiest (and conventionally used) font for verbatim 5503 \tt 5504 \def\par{\leavevmode\egroup\box0\endgraf}% 5505 \catcode`\`=\active 5506 \tabexpand 5507 \quoteexpand 5508 % Respect line breaks, 5509 % print special symbols as themselves, and 5510 % make each space count 5511 % must do in this order: 5512 \obeylines \uncatcodespecials \sepspaces 5513 \everypar{\starttabbox}% 5514} 5515 5516% Do the @verb magic: verbatim text is quoted by unique 5517% delimiter characters. Before first delimiter expect a 5518% right brace, after last delimiter expect closing brace: 5519% 5520% \def\doverb'{'<char>#1<char>'}'{#1} 5521% 5522% [Knuth] p. 382; only eat outer {} 5523\begingroup 5524 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other 5525 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] 5526\endgroup 5527% 5528\def\verb{\begingroup\setupverb\doverb} 5529% 5530% 5531% Do the @verbatim magic: define the macro \doverbatim so that 5532% the (first) argument ends when '@end verbatim' is reached, ie: 5533% 5534% \def\doverbatim#1@end verbatim{#1} 5535% 5536% For Texinfo it's a lot easier than for LaTeX, 5537% because texinfo's \verbatim doesn't stop at '\end{verbatim}': 5538% we need not redefine '\', '{' and '}'. 5539% 5540% Inspired by LaTeX's verbatim command set [latex.ltx] 5541% 5542\begingroup 5543 \catcode`\ =\active 5544 \obeylines % 5545 % ignore everything up to the first ^^M, that's the newline at the end 5546 % of the @verbatim input line itself. Otherwise we get an extra blank 5547 % line in the output. 5548 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% 5549 % We really want {...\end verbatim} in the body of the macro, but 5550 % without the active space; thus we have to use \xdef and \gobble. 5551\endgroup 5552% 5553\envdef\verbatim{% 5554 \setupverbatim\doverbatim 5555} 5556\let\Everbatim = \afterenvbreak 5557 5558 5559% @verbatiminclude FILE - insert text of file in verbatim environment. 5560% 5561\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} 5562% 5563\def\doverbatiminclude#1{% 5564 {% 5565 \makevalueexpandable 5566 \setupverbatim 5567 \input #1 5568 \afterenvbreak 5569 }% 5570} 5571 5572% @copying ... @end copying. 5573% Save the text away for @insertcopying later. 5574% 5575% We save the uninterpreted tokens, rather than creating a box. 5576% Saving the text in a box would be much easier, but then all the 5577% typesetting commands (@smallbook, font changes, etc.) have to be done 5578% beforehand -- and a) we want @copying to be done first in the source 5579% file; b) letting users define the frontmatter in as flexible order as 5580% possible is very desirable. 5581% 5582\def\copying{\checkenv{}\begingroup\scanargctxt\docopying} 5583\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}} 5584% 5585\def\insertcopying{% 5586 \begingroup 5587 \parindent = 0pt % paragraph indentation looks wrong on title page 5588 \scanexp\copyingtext 5589 \endgroup 5590} 5591 5592\message{defuns,} 5593% @defun etc. 5594 5595\newskip\defbodyindent \defbodyindent=.4in 5596\newskip\defargsindent \defargsindent=50pt 5597\newskip\deflastargmargin \deflastargmargin=18pt 5598 5599% Start the processing of @deffn: 5600\def\startdefun{% 5601 \ifnum\lastpenalty<10000 5602 \medbreak 5603 \else 5604 % If there are two @def commands in a row, we'll have a \nobreak, 5605 % which is there to keep the function description together with its 5606 % header. But if there's nothing but headers, we need to allow a 5607 % break somewhere. Check specifically for penalty 10002, inserted 5608 % by \defargscommonending, instead of 10000, since the sectioning 5609 % commands also insert a nobreak penalty, and we don't want to allow 5610 % a break between a section heading and a defun. 5611 % 5612 \ifnum\lastpenalty=10002 \penalty2000 \fi 5613 % 5614 % Similarly, after a section heading, do not allow a break. 5615 % But do insert the glue. 5616 \medskip % preceded by discardable penalty, so not a breakpoint 5617 \fi 5618 % 5619 \parindent=0in 5620 \advance\leftskip by \defbodyindent 5621 \exdentamount=\defbodyindent 5622} 5623 5624\def\dodefunx#1{% 5625 % First, check whether we are in the right environment: 5626 \checkenv#1% 5627 % 5628 % As above, allow line break if we have multiple x headers in a row. 5629 % It's not a great place, though. 5630 \ifnum\lastpenalty=10002 \penalty3000 \fi 5631 % 5632 % And now, it's time to reuse the body of the original defun: 5633 \expandafter\gobbledefun#1% 5634} 5635\def\gobbledefun#1\startdefun{} 5636 5637% \printdefunline \deffnheader{text} 5638% 5639\def\printdefunline#1#2{% 5640 \begingroup 5641 % call \deffnheader: 5642 #1#2 \endheader 5643 % common ending: 5644 \interlinepenalty = 10000 5645 \advance\rightskip by 0pt plus 1fil 5646 \endgraf 5647 \nobreak\vskip -\parskip 5648 \penalty 10002 % signal to \startdefun and \dodefunx 5649 % Some of the @defun-type tags do not enable magic parentheses, 5650 % rendering the following check redundant. But we don't optimize. 5651 \checkparencounts 5652 \endgroup 5653} 5654 5655\def\Edefun{\endgraf\medbreak} 5656 5657% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; 5658% the only thing remainnig is to define \deffnheader. 5659% 5660\def\makedefun#1{% 5661 \expandafter\let\csname E#1\endcsname = \Edefun 5662 \edef\temp{\noexpand\domakedefun 5663 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% 5664 \temp 5665} 5666 5667% \domakedefun \deffn \deffnx \deffnheader 5668% 5669% Define \deffn and \deffnx, without parameters. 5670% \deffnheader has to be defined explicitly. 5671% 5672\def\domakedefun#1#2#3{% 5673 \envdef#1{% 5674 \startdefun 5675 \parseargusing\activeparens{\printdefunline#3}% 5676 }% 5677 \def#2{\dodefunx#1}% 5678 \def#3% 5679} 5680 5681%%% Untyped functions: 5682 5683% @deffn category name args 5684\makedefun{deffn}{\deffngeneral{}} 5685 5686% @deffn category class name args 5687\makedefun{defop}#1 {\defopon{#1\ \putwordon}} 5688 5689% \defopon {category on}class name args 5690\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } 5691 5692% \deffngeneral {subind}category name args 5693% 5694\def\deffngeneral#1#2 #3 #4\endheader{% 5695 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. 5696 \dosubind{fn}{\code{#3}}{#1}% 5697 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% 5698} 5699 5700%%% Typed functions: 5701 5702% @deftypefn category type name args 5703\makedefun{deftypefn}{\deftypefngeneral{}} 5704 5705% @deftypeop category class type name args 5706\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} 5707 5708% \deftypeopon {category on}class type name args 5709\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } 5710 5711% \deftypefngeneral {subind}category type name args 5712% 5713\def\deftypefngeneral#1#2 #3 #4 #5\endheader{% 5714 \dosubind{fn}{\code{#4}}{#1}% 5715 \defname{#2}{#3}{#4}\defunargs{#5\unskip}% 5716} 5717 5718%%% Typed variables: 5719 5720% @deftypevr category type var args 5721\makedefun{deftypevr}{\deftypecvgeneral{}} 5722 5723% @deftypecv category class type var args 5724\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} 5725 5726% \deftypecvof {category of}class type var args 5727\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } 5728 5729% \deftypecvgeneral {subind}category type var args 5730% 5731\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% 5732 \dosubind{vr}{\code{#4}}{#1}% 5733 \defname{#2}{#3}{#4}\defunargs{#5\unskip}% 5734} 5735 5736%%% Untyped variables: 5737 5738% @defvr category var args 5739\makedefun{defvr}#1 {\deftypevrheader{#1} {} } 5740 5741% @defcv category class var args 5742\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} 5743 5744% \defcvof {category of}class var args 5745\def\defcvof#1#2 {\deftypecvof{#1}#2 {} } 5746 5747%%% Type: 5748% @deftp category name args 5749\makedefun{deftp}#1 #2 #3\endheader{% 5750 \doind{tp}{\code{#2}}% 5751 \defname{#1}{}{#2}\defunargs{#3\unskip}% 5752} 5753 5754% Remaining @defun-like shortcuts: 5755\makedefun{defun}{\deffnheader{\putwordDeffunc} } 5756\makedefun{defmac}{\deffnheader{\putwordDefmac} } 5757\makedefun{defspec}{\deffnheader{\putwordDefspec} } 5758\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } 5759\makedefun{defvar}{\defvrheader{\putwordDefvar} } 5760\makedefun{defopt}{\defvrheader{\putwordDefopt} } 5761\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } 5762\makedefun{defmethod}{\defopon\putwordMethodon} 5763\makedefun{deftypemethod}{\deftypeopon\putwordMethodon} 5764\makedefun{defivar}{\defcvof\putwordInstanceVariableof} 5765\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} 5766 5767% \defname, which formats the name of the @def (not the args). 5768% #1 is the category, such as "Function". 5769% #2 is the return type, if any. 5770% #3 is the function name. 5771% 5772% We are followed by (but not passed) the arguments, if any. 5773% 5774\def\defname#1#2#3{% 5775 % Get the values of \leftskip and \rightskip as they were outside the @def... 5776 \advance\leftskip by -\defbodyindent 5777 % 5778 % How we'll format the type name. Putting it in brackets helps 5779 % distinguish it from the body text that may end up on the next line 5780 % just below it. 5781 \def\temp{#1}% 5782 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} 5783 % 5784 % Figure out line sizes for the paragraph shape. 5785 % The first line needs space for \box0; but if \rightskip is nonzero, 5786 % we need only space for the part of \box0 which exceeds it: 5787 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip 5788 % The continuations: 5789 \dimen2=\hsize \advance\dimen2 by -\defargsindent 5790 % (plain.tex says that \dimen1 should be used only as global.) 5791 \parshape 2 0in \dimen0 \defargsindent \dimen2 5792 % 5793 % Put the type name to the right margin. 5794 \noindent 5795 \hbox to 0pt{% 5796 \hfil\box0 \kern-\hsize 5797 % \hsize has to be shortened this way: 5798 \kern\leftskip 5799 % Intentionally do not respect \rightskip, since we need the space. 5800 }% 5801 % 5802 % Allow all lines to be underfull without complaint: 5803 \tolerance=10000 \hbadness=10000 5804 \exdentamount=\defbodyindent 5805 {% 5806 % defun fonts. We use typewriter by default (used to be bold) because: 5807 % . we're printing identifiers, they should be in tt in principle. 5808 % . in languages with many accents, such as Czech or French, it's 5809 % common to leave accents off identifiers. The result looks ok in 5810 % tt, but exceedingly strange in rm. 5811 % . we don't want -- and --- to be treated as ligatures. 5812 % . this still does not fix the ?` and !` ligatures, but so far no 5813 % one has made identifiers using them :). 5814 \df \tt 5815 \def\temp{#2}% return value type 5816 \ifx\temp\empty\else \tclose{\temp} \fi 5817 #3% output function name 5818 }% 5819 {\rm\enskip}% hskip 0.5 em of \tenrm 5820 % 5821 \boldbrax 5822 % arguments will be output next, if any. 5823} 5824 5825% Print arguments in slanted roman (not ttsl), inconsistently with using 5826% tt for the name. This is because literal text is sometimes needed in 5827% the argument list (groff manual), and ttsl and tt are not very 5828% distinguishable. Prevent hyphenation at `-' chars. 5829% 5830\def\defunargs#1{% 5831 % use sl by default (not ttsl), 5832 % tt for the names. 5833 \df \sl \hyphenchar\font=0 5834 % 5835 % On the other hand, if an argument has two dashes (for instance), we 5836 % want a way to get ttsl. Let's try @var for that. 5837 \let\var=\ttslanted 5838 #1% 5839 \sl\hyphenchar\font=45 5840} 5841 5842% We want ()&[] to print specially on the defun line. 5843% 5844\def\activeparens{% 5845 \catcode`\(=\active \catcode`\)=\active 5846 \catcode`\[=\active \catcode`\]=\active 5847 \catcode`\&=\active 5848} 5849 5850% Make control sequences which act like normal parenthesis chars. 5851\let\lparen = ( \let\rparen = ) 5852 5853% Be sure that we always have a definition for `(', etc. For example, 5854% if the fn name has parens in it, \boldbrax will not be in effect yet, 5855% so TeX would otherwise complain about undefined control sequence. 5856{ 5857 \activeparens 5858 \global\let(=\lparen \global\let)=\rparen 5859 \global\let[=\lbrack \global\let]=\rbrack 5860 \global\let& = \& 5861 5862 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} 5863 \gdef\magicamp{\let&=\amprm} 5864} 5865 5866\newcount\parencount 5867 5868% If we encounter &foo, then turn on ()-hacking afterwards 5869\newif\ifampseen 5870\def\amprm#1 {\ampseentrue{\bf\ }} 5871 5872\def\parenfont{% 5873 \ifampseen 5874 % At the first level, print parens in roman, 5875 % otherwise use the default font. 5876 \ifnum \parencount=1 \rm \fi 5877 \else 5878 % The \sf parens (in \boldbrax) actually are a little bolder than 5879 % the contained text. This is especially needed for [ and ] . 5880 \sf 5881 \fi 5882} 5883\def\infirstlevel#1{% 5884 \ifampseen 5885 \ifnum\parencount=1 5886 #1% 5887 \fi 5888 \fi 5889} 5890\def\bfafterword#1 {#1 \bf} 5891 5892\def\opnr{% 5893 \global\advance\parencount by 1 5894 {\parenfont(}% 5895 \infirstlevel \bfafterword 5896} 5897\def\clnr{% 5898 {\parenfont)}% 5899 \infirstlevel \sl 5900 \global\advance\parencount by -1 5901} 5902 5903\newcount\brackcount 5904\def\lbrb{% 5905 \global\advance\brackcount by 1 5906 {\bf[}% 5907} 5908\def\rbrb{% 5909 {\bf]}% 5910 \global\advance\brackcount by -1 5911} 5912 5913\def\checkparencounts{% 5914 \ifnum\parencount=0 \else \badparencount \fi 5915 \ifnum\brackcount=0 \else \badbrackcount \fi 5916} 5917\def\badparencount{% 5918 \errmessage{Unbalanced parentheses in @def}% 5919 \global\parencount=0 5920} 5921\def\badbrackcount{% 5922 \errmessage{Unbalanced square braces in @def}% 5923 \global\brackcount=0 5924} 5925 5926 5927\message{macros,} 5928% @macro. 5929 5930% To do this right we need a feature of e-TeX, \scantokens, 5931% which we arrange to emulate with a temporary file in ordinary TeX. 5932\ifx\eTeXversion\undefined 5933 \newwrite\macscribble 5934 \def\scantokens#1{% 5935 \toks0={#1}% 5936 \immediate\openout\macscribble=\jobname.tmp 5937 \immediate\write\macscribble{\the\toks0}% 5938 \immediate\closeout\macscribble 5939 \input \jobname.tmp 5940 } 5941\fi 5942 5943\def\scanmacro#1{% 5944 \begingroup 5945 \newlinechar`\^^M 5946 \let\xeatspaces\eatspaces 5947 % Undo catcode changes of \startcontents and \doprintindex 5948 % When called from @insertcopying or (short)caption, we need active 5949 % backslash to get it printed correctly. Previously, we had 5950 % \catcode`\\=\other instead. We'll see whether a problem appears 5951 % with macro expansion. --kasal, 19aug04 5952 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ 5953 % ... and \example 5954 \spaceisspace 5955 % 5956 % Append \endinput to make sure that TeX does not see the ending newline. 5957 % I've verified that it is necessary both for e-TeX and for ordinary TeX 5958 % --kasal, 29nov03 5959 \scantokens{#1\endinput}% 5960 \endgroup 5961} 5962 5963\def\scanexp#1{% 5964 \edef\temp{\noexpand\scanmacro{#1}}% 5965 \temp 5966} 5967 5968\newcount\paramno % Count of parameters 5969\newtoks\macname % Macro name 5970\newif\ifrecursive % Is it recursive? 5971 5972% List of all defined macros in the form 5973% \definedummyword\macro1\definedummyword\macro2... 5974% Currently is also contains all @aliases; the list can be split 5975% if there is a need. 5976\def\macrolist{} 5977 5978% Add the macro to \macrolist 5979\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname} 5980\def\addtomacrolistxxx#1{% 5981 \toks0 = \expandafter{\macrolist\definedummyword#1}% 5982 \xdef\macrolist{\the\toks0}% 5983} 5984 5985% Utility routines. 5986% This does \let #1 = #2, with \csnames; that is, 5987% \let \csname#1\endcsname = \csname#2\endcsname 5988% (except of course we have to play expansion games). 5989% 5990\def\cslet#1#2{% 5991 \expandafter\let 5992 \csname#1\expandafter\endcsname 5993 \csname#2\endcsname 5994} 5995 5996% Trim leading and trailing spaces off a string. 5997% Concepts from aro-bend problem 15 (see CTAN). 5998{\catcode`\@=11 5999\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} 6000\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} 6001\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} 6002\def\unbrace#1{#1} 6003\unbrace{\gdef\trim@@@ #1 } #2@{#1} 6004} 6005 6006% Trim a single trailing ^^M off a string. 6007{\catcode`\^^M=\other \catcode`\Q=3% 6008\gdef\eatcr #1{\eatcra #1Q^^MQ}% 6009\gdef\eatcra#1^^MQ{\eatcrb#1Q}% 6010\gdef\eatcrb#1Q#2Q{#1}% 6011} 6012 6013% Macro bodies are absorbed as an argument in a context where 6014% all characters are catcode 10, 11 or 12, except \ which is active 6015% (as in normal texinfo). It is necessary to change the definition of \. 6016 6017% It's necessary to have hard CRs when the macro is executed. This is 6018% done by making ^^M (\endlinechar) catcode 12 when reading the macro 6019% body, and then making it the \newlinechar in \scanmacro. 6020 6021\def\scanctxt{% 6022 \catcode`\"=\other 6023 \catcode`\+=\other 6024 \catcode`\<=\other 6025 \catcode`\>=\other 6026 \catcode`\@=\other 6027 \catcode`\^=\other 6028 \catcode`\_=\other 6029 \catcode`\|=\other 6030 \catcode`\~=\other 6031} 6032 6033\def\scanargctxt{% 6034 \scanctxt 6035 \catcode`\\=\other 6036 \catcode`\^^M=\other 6037} 6038 6039\def\macrobodyctxt{% 6040 \scanctxt 6041 \catcode`\{=\other 6042 \catcode`\}=\other 6043 \catcode`\^^M=\other 6044 \usembodybackslash 6045} 6046 6047\def\macroargctxt{% 6048 \scanctxt 6049 \catcode`\\=\other 6050} 6051 6052% \mbodybackslash is the definition of \ in @macro bodies. 6053% It maps \foo\ => \csname macarg.foo\endcsname => #N 6054% where N is the macro parameter number. 6055% We define \csname macarg.\endcsname to be \realbackslash, so 6056% \\ in macro replacement text gets you a backslash. 6057 6058{\catcode`@=0 @catcode`@\=@active 6059 @gdef@usembodybackslash{@let\=@mbodybackslash} 6060 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} 6061} 6062\expandafter\def\csname macarg.\endcsname{\realbackslash} 6063 6064\def\macro{\recursivefalse\parsearg\macroxxx} 6065\def\rmacro{\recursivetrue\parsearg\macroxxx} 6066 6067\def\macroxxx#1{% 6068 \getargs{#1}% now \macname is the macname and \argl the arglist 6069 \ifx\argl\empty % no arguments 6070 \paramno=0% 6071 \else 6072 \expandafter\parsemargdef \argl;% 6073 \fi 6074 \if1\csname ismacro.\the\macname\endcsname 6075 \message{Warning: redefining \the\macname}% 6076 \else 6077 \expandafter\ifx\csname \the\macname\endcsname \relax 6078 \else \errmessage{Macro name \the\macname\space already defined}\fi 6079 \global\cslet{macsave.\the\macname}{\the\macname}% 6080 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% 6081 \addtomacrolist{\the\macname}% 6082 \fi 6083 \begingroup \macrobodyctxt 6084 \ifrecursive \expandafter\parsermacbody 6085 \else \expandafter\parsemacbody 6086 \fi} 6087 6088\parseargdef\unmacro{% 6089 \if1\csname ismacro.#1\endcsname 6090 \global\cslet{#1}{macsave.#1}% 6091 \global\expandafter\let \csname ismacro.#1\endcsname=0% 6092 % Remove the macro name from \macrolist: 6093 \begingroup 6094 \expandafter\let\csname#1\endcsname \relax 6095 \let\definedummyword\unmacrodo 6096 \xdef\macrolist{\macrolist}% 6097 \endgroup 6098 \else 6099 \errmessage{Macro #1 not defined}% 6100 \fi 6101} 6102 6103% Called by \do from \dounmacro on each macro. The idea is to omit any 6104% macro definitions that have been changed to \relax. 6105% 6106\def\unmacrodo#1{% 6107 \ifx #1\relax 6108 % remove this 6109 \else 6110 \noexpand\definedummyword \noexpand#1% 6111 \fi 6112} 6113 6114% This makes use of the obscure feature that if the last token of a 6115% <parameter list> is #, then the preceding argument is delimited by 6116% an opening brace, and that opening brace is not consumed. 6117\def\getargs#1{\getargsxxx#1{}} 6118\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} 6119\def\getmacname #1 #2\relax{\macname={#1}} 6120\def\getmacargs#1{\def\argl{#1}} 6121 6122% Parse the optional {params} list. Set up \paramno and \paramlist 6123% so \defmacro knows what to do. Define \macarg.blah for each blah 6124% in the params list, to be ##N where N is the position in that list. 6125% That gets used by \mbodybackslash (above). 6126 6127% We need to get `macro parameter char #' into several definitions. 6128% The technique used is stolen from LaTeX: let \hash be something 6129% unexpandable, insert that wherever you need a #, and then redefine 6130% it to # just before using the token list produced. 6131% 6132% The same technique is used to protect \eatspaces till just before 6133% the macro is used. 6134 6135\def\parsemargdef#1;{\paramno=0\def\paramlist{}% 6136 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} 6137\def\parsemargdefxxx#1,{% 6138 \if#1;\let\next=\relax 6139 \else \let\next=\parsemargdefxxx 6140 \advance\paramno by 1% 6141 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname 6142 {\xeatspaces{\hash\the\paramno}}% 6143 \edef\paramlist{\paramlist\hash\the\paramno,}% 6144 \fi\next} 6145 6146% These two commands read recursive and nonrecursive macro bodies. 6147% (They're different since rec and nonrec macros end differently.) 6148 6149\long\def\parsemacbody#1@end macro% 6150{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 6151\long\def\parsermacbody#1@end rmacro% 6152{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 6153 6154% This defines the macro itself. There are six cases: recursive and 6155% nonrecursive macros of zero, one, and many arguments. 6156% Much magic with \expandafter here. 6157% \xdef is used so that macro definitions will survive the file 6158% they're defined in; @include reads the file inside a group. 6159\def\defmacro{% 6160 \let\hash=##% convert placeholders to macro parameter chars 6161 \ifrecursive 6162 \ifcase\paramno 6163 % 0 6164 \expandafter\xdef\csname\the\macname\endcsname{% 6165 \noexpand\scanmacro{\temp}}% 6166 \or % 1 6167 \expandafter\xdef\csname\the\macname\endcsname{% 6168 \bgroup\noexpand\macroargctxt 6169 \noexpand\braceorline 6170 \expandafter\noexpand\csname\the\macname xxx\endcsname}% 6171 \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 6172 \egroup\noexpand\scanmacro{\temp}}% 6173 \else % many 6174 \expandafter\xdef\csname\the\macname\endcsname{% 6175 \bgroup\noexpand\macroargctxt 6176 \noexpand\csname\the\macname xx\endcsname}% 6177 \expandafter\xdef\csname\the\macname xx\endcsname##1{% 6178 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 6179 \expandafter\expandafter 6180 \expandafter\xdef 6181 \expandafter\expandafter 6182 \csname\the\macname xxx\endcsname 6183 \paramlist{\egroup\noexpand\scanmacro{\temp}}% 6184 \fi 6185 \else 6186 \ifcase\paramno 6187 % 0 6188 \expandafter\xdef\csname\the\macname\endcsname{% 6189 \noexpand\norecurse{\the\macname}% 6190 \noexpand\scanmacro{\temp}\egroup}% 6191 \or % 1 6192 \expandafter\xdef\csname\the\macname\endcsname{% 6193 \bgroup\noexpand\macroargctxt 6194 \noexpand\braceorline 6195 \expandafter\noexpand\csname\the\macname xxx\endcsname}% 6196 \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 6197 \egroup 6198 \noexpand\norecurse{\the\macname}% 6199 \noexpand\scanmacro{\temp}\egroup}% 6200 \else % many 6201 \expandafter\xdef\csname\the\macname\endcsname{% 6202 \bgroup\noexpand\macroargctxt 6203 \expandafter\noexpand\csname\the\macname xx\endcsname}% 6204 \expandafter\xdef\csname\the\macname xx\endcsname##1{% 6205 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 6206 \expandafter\expandafter 6207 \expandafter\xdef 6208 \expandafter\expandafter 6209 \csname\the\macname xxx\endcsname 6210 \paramlist{% 6211 \egroup 6212 \noexpand\norecurse{\the\macname}% 6213 \noexpand\scanmacro{\temp}\egroup}% 6214 \fi 6215 \fi} 6216 6217\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} 6218 6219% \braceorline decides whether the next nonwhitespace character is a 6220% {. If so it reads up to the closing }, if not, it reads the whole 6221% line. Whatever was read is then fed to the next control sequence 6222% as an argument (by \parsebrace or \parsearg) 6223\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} 6224\def\braceorlinexxx{% 6225 \ifx\nchar\bgroup\else 6226 \expandafter\parsearg 6227 \fi \macnamexxx} 6228 6229 6230% @alias. 6231% We need some trickery to remove the optional spaces around the equal 6232% sign. Just make them active and then expand them all to nothing. 6233\def\alias{\parseargusing\obeyspaces\aliasxxx} 6234\def\aliasxxx #1{\aliasyyy#1\relax} 6235\def\aliasyyy #1=#2\relax{% 6236 {% 6237 \expandafter\let\obeyedspace=\empty 6238 \addtomacrolist{#1}% 6239 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% 6240 }% 6241 \next 6242} 6243 6244 6245\message{cross references,} 6246 6247\newwrite\auxfile 6248 6249\newif\ifhavexrefs % True if xref values are known. 6250\newif\ifwarnedxrefs % True if we warned once that they aren't known. 6251 6252% @inforef is relatively simple. 6253\def\inforef #1{\inforefzzz #1,,,,**} 6254\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, 6255 node \samp{\ignorespaces#1{}}} 6256 6257% @node's only job in TeX is to define \lastnode, which is used in 6258% cross-references. The @node line might or might not have commas, and 6259% might or might not have spaces before the first comma, like: 6260% @node foo , bar , ... 6261% We don't want such trailing spaces in the node name. 6262% 6263\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse} 6264% 6265% also remove a trailing comma, in case of something like this: 6266% @node Help-Cross, , , Cross-refs 6267\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse} 6268\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}} 6269 6270\let\nwnode=\node 6271\let\lastnode=\empty 6272 6273% Write a cross-reference definition for the current node. #1 is the 6274% type (Ynumbered, Yappendix, Ynothing). 6275% 6276\def\donoderef#1{% 6277 \ifx\lastnode\empty\else 6278 \setref{\lastnode}{#1}% 6279 \global\let\lastnode=\empty 6280 \fi 6281} 6282 6283% @anchor{NAME} -- define xref target at arbitrary point. 6284% 6285\newcount\savesfregister 6286% 6287\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} 6288\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} 6289\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} 6290 6291% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an 6292% anchor), which consists of three parts: 6293% 1) NAME-title - the current sectioning name taken from \thissection, 6294% or the anchor name. 6295% 2) NAME-snt - section number and type, passed as the SNT arg, or 6296% empty for anchors. 6297% 3) NAME-pg - the page number. 6298% 6299% This is called from \donoderef, \anchor, and \dofloat. In the case of 6300% floats, there is an additional part, which is not written here: 6301% 4) NAME-lof - the text as it should appear in a @listoffloats. 6302% 6303\def\setref#1#2{% 6304 \pdfmkdest{#1}% 6305 \iflinks 6306 {% 6307 \atdummies % preserve commands, but don't expand them 6308 \edef\writexrdef##1##2{% 6309 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef 6310 ##1}{##2}}% these are parameters of \writexrdef 6311 }% 6312 \toks0 = \expandafter{\thissection}% 6313 \immediate \writexrdef{title}{\the\toks0 }% 6314 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. 6315 \writexrdef{pg}{\folio}% will be written later, during \shipout 6316 }% 6317 \fi 6318} 6319 6320% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is 6321% the node name, #2 the name of the Info cross-reference, #3 the printed 6322% node name, #4 the name of the Info file, #5 the name of the printed 6323% manual. All but the node name can be omitted. 6324% 6325\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} 6326\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} 6327\def\ref#1{\xrefX[#1,,,,,,,]} 6328\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup 6329 \unsepspaces 6330 \def\printedmanual{\ignorespaces #5}% 6331 \def\printedrefname{\ignorespaces #3}% 6332 \setbox1=\hbox{\printedmanual\unskip}% 6333 \setbox0=\hbox{\printedrefname\unskip}% 6334 \ifdim \wd0 = 0pt 6335 % No printed node name was explicitly given. 6336 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax 6337 % Use the node name inside the square brackets. 6338 \def\printedrefname{\ignorespaces #1}% 6339 \else 6340 % Use the actual chapter/section title appear inside 6341 % the square brackets. Use the real section title if we have it. 6342 \ifdim \wd1 > 0pt 6343 % It is in another manual, so we don't have it. 6344 \def\printedrefname{\ignorespaces #1}% 6345 \else 6346 \ifhavexrefs 6347 % We know the real title if we have the xref values. 6348 \def\printedrefname{\refx{#1-title}{}}% 6349 \else 6350 % Otherwise just copy the Info node name. 6351 \def\printedrefname{\ignorespaces #1}% 6352 \fi% 6353 \fi 6354 \fi 6355 \fi 6356 % 6357 % Make link in pdf output. 6358 \ifpdf 6359 \leavevmode 6360 \getfilename{#4}% 6361 {\turnoffactive 6362 % See comments at \activebackslashdouble. 6363 {\activebackslashdouble \xdef\pdfxrefdest{#1}% 6364 \backslashparens\pdfxrefdest}% 6365 % 6366 \ifnum\filenamelength>0 6367 \startlink attr{/Border [0 0 0]}% 6368 goto file{\the\filename.pdf} name{\pdfxrefdest}% 6369 \else 6370 \startlink attr{/Border [0 0 0]}% 6371 goto name{\pdfmkpgn{\pdfxrefdest}}% 6372 \fi 6373 }% 6374 \linkcolor 6375 \fi 6376 % 6377 % Float references are printed completely differently: "Figure 1.2" 6378 % instead of "[somenode], p.3". We distinguish them by the 6379 % LABEL-title being set to a magic string. 6380 {% 6381 % Have to otherify everything special to allow the \csname to 6382 % include an _ in the xref name, etc. 6383 \indexnofonts 6384 \turnoffactive 6385 \expandafter\global\expandafter\let\expandafter\Xthisreftitle 6386 \csname XR#1-title\endcsname 6387 }% 6388 \iffloat\Xthisreftitle 6389 % If the user specified the print name (third arg) to the ref, 6390 % print it instead of our usual "Figure 1.2". 6391 \ifdim\wd0 = 0pt 6392 \refx{#1-snt}{}% 6393 \else 6394 \printedrefname 6395 \fi 6396 % 6397 % if the user also gave the printed manual name (fifth arg), append 6398 % "in MANUALNAME". 6399 \ifdim \wd1 > 0pt 6400 \space \putwordin{} \cite{\printedmanual}% 6401 \fi 6402 \else 6403 % node/anchor (non-float) references. 6404 % 6405 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not 6406 % insert empty discretionaries after hyphens, which means that it will 6407 % not find a line break at a hyphen in a node names. Since some manuals 6408 % are best written with fairly long node names, containing hyphens, this 6409 % is a loss. Therefore, we give the text of the node name again, so it 6410 % is as if TeX is seeing it for the first time. 6411 \ifdim \wd1 > 0pt 6412 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}% 6413 \else 6414 % _ (for example) has to be the character _ for the purposes of the 6415 % control sequence corresponding to the node, but it has to expand 6416 % into the usual \leavevmode...\vrule stuff for purposes of 6417 % printing. So we \turnoffactive for the \refx-snt, back on for the 6418 % printing, back off for the \refx-pg. 6419 {\turnoffactive 6420 % Only output a following space if the -snt ref is nonempty; for 6421 % @unnumbered and @anchor, it won't be. 6422 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% 6423 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi 6424 }% 6425 % output the `[mynode]' via a macro so it can be overridden. 6426 \xrefprintnodename\printedrefname 6427 % 6428 % But we always want a comma and a space: 6429 ,\space 6430 % 6431 % output the `page 3'. 6432 \turnoffactive \putwordpage\tie\refx{#1-pg}{}% 6433 \fi 6434 \fi 6435 \endlink 6436\endgroup} 6437 6438% This macro is called from \xrefX for the `[nodename]' part of xref 6439% output. It's a separate macro only so it can be changed more easily, 6440% since square brackets don't work well in some documents. Particularly 6441% one that Bob is working on :). 6442% 6443\def\xrefprintnodename#1{[#1]} 6444 6445% Things referred to by \setref. 6446% 6447\def\Ynothing{} 6448\def\Yomitfromtoc{} 6449\def\Ynumbered{% 6450 \ifnum\secno=0 6451 \putwordChapter@tie \the\chapno 6452 \else \ifnum\subsecno=0 6453 \putwordSection@tie \the\chapno.\the\secno 6454 \else \ifnum\subsubsecno=0 6455 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno 6456 \else 6457 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno 6458 \fi\fi\fi 6459} 6460\def\Yappendix{% 6461 \ifnum\secno=0 6462 \putwordAppendix@tie @char\the\appendixno{}% 6463 \else \ifnum\subsecno=0 6464 \putwordSection@tie @char\the\appendixno.\the\secno 6465 \else \ifnum\subsubsecno=0 6466 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno 6467 \else 6468 \putwordSection@tie 6469 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno 6470 \fi\fi\fi 6471} 6472 6473% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. 6474% If its value is nonempty, SUFFIX is output afterward. 6475% 6476\def\refx#1#2{% 6477 {% 6478 \indexnofonts 6479 \otherbackslash 6480 \expandafter\global\expandafter\let\expandafter\thisrefX 6481 \csname XR#1\endcsname 6482 }% 6483 \ifx\thisrefX\relax 6484 % If not defined, say something at least. 6485 \angleleft un\-de\-fined\angleright 6486 \iflinks 6487 \ifhavexrefs 6488 \message{\linenumber Undefined cross reference `#1'.}% 6489 \else 6490 \ifwarnedxrefs\else 6491 \global\warnedxrefstrue 6492 \message{Cross reference values unknown; you must run TeX again.}% 6493 \fi 6494 \fi 6495 \fi 6496 \else 6497 % It's defined, so just use it. 6498 \thisrefX 6499 \fi 6500 #2% Output the suffix in any case. 6501} 6502 6503% This is the macro invoked by entries in the aux file. Usually it's 6504% just a \def (we prepend XR to the control sequence name to avoid 6505% collisions). But if this is a float type, we have more work to do. 6506% 6507\def\xrdef#1#2{% 6508 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value. 6509 % 6510 % Was that xref control sequence that we just defined for a float? 6511 \expandafter\iffloat\csname XR#1\endcsname 6512 % it was a float, and we have the (safe) float type in \iffloattype. 6513 \expandafter\let\expandafter\floatlist 6514 \csname floatlist\iffloattype\endcsname 6515 % 6516 % Is this the first time we've seen this float type? 6517 \expandafter\ifx\floatlist\relax 6518 \toks0 = {\do}% yes, so just \do 6519 \else 6520 % had it before, so preserve previous elements in list. 6521 \toks0 = \expandafter{\floatlist\do}% 6522 \fi 6523 % 6524 % Remember this xref in the control sequence \floatlistFLOATTYPE, 6525 % for later use in \listoffloats. 6526 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}% 6527 \fi 6528} 6529 6530% Read the last existing aux file, if any. No error if none exists. 6531% 6532\def\tryauxfile{% 6533 \openin 1 \jobname.aux 6534 \ifeof 1 \else 6535 \readdatafile{aux}% 6536 \global\havexrefstrue 6537 \fi 6538 \closein 1 6539} 6540 6541\def\setupdatafile{% 6542 \catcode`\^^@=\other 6543 \catcode`\^^A=\other 6544 \catcode`\^^B=\other 6545 \catcode`\^^C=\other 6546 \catcode`\^^D=\other 6547 \catcode`\^^E=\other 6548 \catcode`\^^F=\other 6549 \catcode`\^^G=\other 6550 \catcode`\^^H=\other 6551 \catcode`\^^K=\other 6552 \catcode`\^^L=\other 6553 \catcode`\^^N=\other 6554 \catcode`\^^P=\other 6555 \catcode`\^^Q=\other 6556 \catcode`\^^R=\other 6557 \catcode`\^^S=\other 6558 \catcode`\^^T=\other 6559 \catcode`\^^U=\other 6560 \catcode`\^^V=\other 6561 \catcode`\^^W=\other 6562 \catcode`\^^X=\other 6563 \catcode`\^^Z=\other 6564 \catcode`\^^[=\other 6565 \catcode`\^^\=\other 6566 \catcode`\^^]=\other 6567 \catcode`\^^^=\other 6568 \catcode`\^^_=\other 6569 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. 6570 % in xref tags, i.e., node names. But since ^^e4 notation isn't 6571 % supported in the main text, it doesn't seem desirable. Furthermore, 6572 % that is not enough: for node names that actually contain a ^ 6573 % character, we would end up writing a line like this: 'xrdef {'hat 6574 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first 6575 % argument, and \hat is not an expandable control sequence. It could 6576 % all be worked out, but why? Either we support ^^ or we don't. 6577 % 6578 % The other change necessary for this was to define \auxhat: 6579 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter 6580 % and then to call \auxhat in \setq. 6581 % 6582 \catcode`\^=\other 6583 % 6584 % Special characters. Should be turned off anyway, but... 6585 \catcode`\~=\other 6586 \catcode`\[=\other 6587 \catcode`\]=\other 6588 \catcode`\"=\other 6589 \catcode`\_=\other 6590 \catcode`\|=\other 6591 \catcode`\<=\other 6592 \catcode`\>=\other 6593 \catcode`\$=\other 6594 \catcode`\#=\other 6595 \catcode`\&=\other 6596 \catcode`\%=\other 6597 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off 6598 % 6599 % This is to support \ in node names and titles, since the \ 6600 % characters end up in a \csname. It's easier than 6601 % leaving it active and making its active definition an actual \ 6602 % character. What I don't understand is why it works in the *value* 6603 % of the xrdef. Seems like it should be a catcode12 \, and that 6604 % should not typeset properly. But it works, so I'm moving on for 6605 % now. --karl, 15jan04. 6606 \catcode`\\=\other 6607 % 6608 % Make the characters 128-255 be printing characters. 6609 {% 6610 \count1=128 6611 \def\loop{% 6612 \catcode\count1=\other 6613 \advance\count1 by 1 6614 \ifnum \count1<256 \loop \fi 6615 }% 6616 }% 6617 % 6618 % @ is our escape character in .aux files, and we need braces. 6619 \catcode`\{=1 6620 \catcode`\}=2 6621 \catcode`\@=0 6622} 6623 6624\def\readdatafile#1{% 6625\begingroup 6626 \setupdatafile 6627 \input\jobname.#1 6628\endgroup} 6629 6630\message{insertions,} 6631% including footnotes. 6632 6633\newcount \footnoteno 6634 6635% The trailing space in the following definition for supereject is 6636% vital for proper filling; pages come out unaligned when you do a 6637% pagealignmacro call if that space before the closing brace is 6638% removed. (Generally, numeric constants should always be followed by a 6639% space to prevent strange expansion errors.) 6640\def\supereject{\par\penalty -20000\footnoteno =0 } 6641 6642% @footnotestyle is meaningful for info output only. 6643\let\footnotestyle=\comment 6644 6645{\catcode `\@=11 6646% 6647% Auto-number footnotes. Otherwise like plain. 6648\gdef\footnote{% 6649 \let\indent=\ptexindent 6650 \let\noindent=\ptexnoindent 6651 \global\advance\footnoteno by \@ne 6652 \edef\thisfootno{$^{\the\footnoteno}$}% 6653 % 6654 % In case the footnote comes at the end of a sentence, preserve the 6655 % extra spacing after we do the footnote number. 6656 \let\@sf\empty 6657 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi 6658 % 6659 % Remove inadvertent blank space before typesetting the footnote number. 6660 \unskip 6661 \thisfootno\@sf 6662 \dofootnote 6663}% 6664 6665% Don't bother with the trickery in plain.tex to not require the 6666% footnote text as a parameter. Our footnotes don't need to be so general. 6667% 6668% Oh yes, they do; otherwise, @ifset (and anything else that uses 6669% \parseargline) fails inside footnotes because the tokens are fixed when 6670% the footnote is read. --karl, 16nov96. 6671% 6672\gdef\dofootnote{% 6673 \insert\footins\bgroup 6674 % We want to typeset this text as a normal paragraph, even if the 6675 % footnote reference occurs in (for example) a display environment. 6676 % So reset some parameters. 6677 \hsize=\pagewidth 6678 \interlinepenalty\interfootnotelinepenalty 6679 \splittopskip\ht\strutbox % top baseline for broken footnotes 6680 \splitmaxdepth\dp\strutbox 6681 \floatingpenalty\@MM 6682 \leftskip\z@skip 6683 \rightskip\z@skip 6684 \spaceskip\z@skip 6685 \xspaceskip\z@skip 6686 \parindent\defaultparindent 6687 % 6688 \smallfonts \rm 6689 % 6690 % Because we use hanging indentation in footnotes, a @noindent appears 6691 % to exdent this text, so make it be a no-op. makeinfo does not use 6692 % hanging indentation so @noindent can still be needed within footnote 6693 % text after an @example or the like (not that this is good style). 6694 \let\noindent = \relax 6695 % 6696 % Hang the footnote text off the number. Use \everypar in case the 6697 % footnote extends for more than one paragraph. 6698 \everypar = {\hang}% 6699 \textindent{\thisfootno}% 6700 % 6701 % Don't crash into the line above the footnote text. Since this 6702 % expands into a box, it must come within the paragraph, lest it 6703 % provide a place where TeX can split the footnote. 6704 \footstrut 6705 \futurelet\next\fo@t 6706} 6707}%end \catcode `\@=11 6708 6709% In case a @footnote appears in a vbox, save the footnote text and create 6710% the real \insert just after the vbox finished. Otherwise, the insertion 6711% would be lost. 6712% Similarily, if a @footnote appears inside an alignment, save the footnote 6713% text to a box and make the \insert when a row of the table is finished. 6714% And the same can be done for other insert classes. --kasal, 16nov03. 6715 6716% Replace the \insert primitive by a cheating macro. 6717% Deeper inside, just make sure that the saved insertions are not spilled 6718% out prematurely. 6719% 6720\def\startsavinginserts{% 6721 \ifx \insert\ptexinsert 6722 \let\insert\saveinsert 6723 \else 6724 \let\checkinserts\relax 6725 \fi 6726} 6727 6728% This \insert replacement works for both \insert\footins{foo} and 6729% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. 6730% 6731\def\saveinsert#1{% 6732 \edef\next{\noexpand\savetobox \makeSAVEname#1}% 6733 \afterassignment\next 6734 % swallow the left brace 6735 \let\temp = 6736} 6737\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} 6738\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} 6739 6740\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} 6741 6742\def\placesaveins#1{% 6743 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname 6744 {\box#1}% 6745} 6746 6747% eat @SAVE -- beware, all of them have catcode \other: 6748{ 6749 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) 6750 \gdef\gobblesave @SAVE{} 6751} 6752 6753% initialization: 6754\def\newsaveins #1{% 6755 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% 6756 \next 6757} 6758\def\newsaveinsX #1{% 6759 \csname newbox\endcsname #1% 6760 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts 6761 \checksaveins #1}% 6762} 6763 6764% initialize: 6765\let\checkinserts\empty 6766\newsaveins\footins 6767\newsaveins\margin 6768 6769 6770% @image. We use the macros from epsf.tex to support this. 6771% If epsf.tex is not installed and @image is used, we complain. 6772% 6773% Check for and read epsf.tex up front. If we read it only at @image 6774% time, we might be inside a group, and then its definitions would get 6775% undone and the next image would fail. 6776\openin 1 = epsf.tex 6777\ifeof 1 \else 6778 % Do not bother showing banner with epsf.tex v2.7k (available in 6779 % doc/epsf.tex and on ctan). 6780 \def\epsfannounce{\toks0 = }% 6781 \input epsf.tex 6782\fi 6783\closein 1 6784% 6785% We will only complain once about lack of epsf.tex. 6786\newif\ifwarnednoepsf 6787\newhelp\noepsfhelp{epsf.tex must be installed for images to 6788 work. It is also included in the Texinfo distribution, or you can get 6789 it from ftp://tug.org/tex/epsf.tex.} 6790% 6791\def\image#1{% 6792 \ifx\epsfbox\undefined 6793 \ifwarnednoepsf \else 6794 \errhelp = \noepsfhelp 6795 \errmessage{epsf.tex not found, images will be ignored}% 6796 \global\warnednoepsftrue 6797 \fi 6798 \else 6799 \imagexxx #1,,,,,\finish 6800 \fi 6801} 6802% 6803% Arguments to @image: 6804% #1 is (mandatory) image filename; we tack on .eps extension. 6805% #2 is (optional) width, #3 is (optional) height. 6806% #4 is (ignored optional) html alt text. 6807% #5 is (ignored optional) extension. 6808% #6 is just the usual extra ignored arg for parsing this stuff. 6809\newif\ifimagevmode 6810\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup 6811 \catcode`\^^M = 5 % in case we're inside an example 6812 \normalturnoffactive % allow _ et al. in names 6813 % If the image is by itself, center it. 6814 \ifvmode 6815 \imagevmodetrue 6816 \nobreak\bigskip 6817 % Usually we'll have text after the image which will insert 6818 % \parskip glue, so insert it here too to equalize the space 6819 % above and below. 6820 \nobreak\vskip\parskip 6821 \nobreak 6822 \line\bgroup 6823 \fi 6824 % 6825 % Output the image. 6826 \ifpdf 6827 \dopdfimage{#1}{#2}{#3}% 6828 \else 6829 % \epsfbox itself resets \epsf?size at each figure. 6830 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi 6831 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi 6832 \epsfbox{#1.eps}% 6833 \fi 6834 % 6835 \ifimagevmode \egroup \bigbreak \fi % space after the image 6836\endgroup} 6837 6838 6839% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables, 6840% etc. We don't actually implement floating yet, we always include the 6841% float "here". But it seemed the best name for the future. 6842% 6843\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish} 6844 6845% There may be a space before second and/or third parameter; delete it. 6846\def\eatcommaspace#1, {#1,} 6847 6848% #1 is the optional FLOATTYPE, the text label for this float, typically 6849% "Figure", "Table", "Example", etc. Can't contain commas. If omitted, 6850% this float will not be numbered and cannot be referred to. 6851% 6852% #2 is the optional xref label. Also must be present for the float to 6853% be referable. 6854% 6855% #3 is the optional positioning argument; for now, it is ignored. It 6856% will somehow specify the positions allowed to float to (here, top, bottom). 6857% 6858% We keep a separate counter for each FLOATTYPE, which we reset at each 6859% chapter-level command. 6860\let\resetallfloatnos=\empty 6861% 6862\def\dofloat#1,#2,#3,#4\finish{% 6863 \let\thiscaption=\empty 6864 \let\thisshortcaption=\empty 6865 % 6866 % don't lose footnotes inside @float. 6867 % 6868 % BEWARE: when the floats start float, we have to issue warning whenever an 6869 % insert appears inside a float which could possibly float. --kasal, 26may04 6870 % 6871 \startsavinginserts 6872 % 6873 % We can't be used inside a paragraph. 6874 \par 6875 % 6876 \vtop\bgroup 6877 \def\floattype{#1}% 6878 \def\floatlabel{#2}% 6879 \def\floatloc{#3}% we do nothing with this yet. 6880 % 6881 \ifx\floattype\empty 6882 \let\safefloattype=\empty 6883 \else 6884 {% 6885 % the floattype might have accents or other special characters, 6886 % but we need to use it in a control sequence name. 6887 \indexnofonts 6888 \turnoffactive 6889 \xdef\safefloattype{\floattype}% 6890 }% 6891 \fi 6892 % 6893 % If label is given but no type, we handle that as the empty type. 6894 \ifx\floatlabel\empty \else 6895 % We want each FLOATTYPE to be numbered separately (Figure 1, 6896 % Table 1, Figure 2, ...). (And if no label, no number.) 6897 % 6898 \expandafter\getfloatno\csname\safefloattype floatno\endcsname 6899 \global\advance\floatno by 1 6900 % 6901 {% 6902 % This magic value for \thissection is output by \setref as the 6903 % XREFLABEL-title value. \xrefX uses it to distinguish float 6904 % labels (which have a completely different output format) from 6905 % node and anchor labels. And \xrdef uses it to construct the 6906 % lists of floats. 6907 % 6908 \edef\thissection{\floatmagic=\safefloattype}% 6909 \setref{\floatlabel}{Yfloat}% 6910 }% 6911 \fi 6912 % 6913 % start with \parskip glue, I guess. 6914 \vskip\parskip 6915 % 6916 % Don't suppress indentation if a float happens to start a section. 6917 \restorefirstparagraphindent 6918} 6919 6920% we have these possibilities: 6921% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap 6922% @float Foo,lbl & no caption: Foo 1.1 6923% @float Foo & @caption{Cap}: Foo: Cap 6924% @float Foo & no caption: Foo 6925% @float ,lbl & Caption{Cap}: 1.1: Cap 6926% @float ,lbl & no caption: 1.1 6927% @float & @caption{Cap}: Cap 6928% @float & no caption: 6929% 6930\def\Efloat{% 6931 \let\floatident = \empty 6932 % 6933 % In all cases, if we have a float type, it comes first. 6934 \ifx\floattype\empty \else \def\floatident{\floattype}\fi 6935 % 6936 % If we have an xref label, the number comes next. 6937 \ifx\floatlabel\empty \else 6938 \ifx\floattype\empty \else % if also had float type, need tie first. 6939 \appendtomacro\floatident{\tie}% 6940 \fi 6941 % the number. 6942 \appendtomacro\floatident{\chaplevelprefix\the\floatno}% 6943 \fi 6944 % 6945 % Start the printed caption with what we've constructed in 6946 % \floatident, but keep it separate; we need \floatident again. 6947 \let\captionline = \floatident 6948 % 6949 \ifx\thiscaption\empty \else 6950 \ifx\floatident\empty \else 6951 \appendtomacro\captionline{: }% had ident, so need a colon between 6952 \fi 6953 % 6954 % caption text. 6955 \appendtomacro\captionline{\scanexp\thiscaption}% 6956 \fi 6957 % 6958 % If we have anything to print, print it, with space before. 6959 % Eventually this needs to become an \insert. 6960 \ifx\captionline\empty \else 6961 \vskip.5\parskip 6962 \captionline 6963 % 6964 % Space below caption. 6965 \vskip\parskip 6966 \fi 6967 % 6968 % If have an xref label, write the list of floats info. Do this 6969 % after the caption, to avoid chance of it being a breakpoint. 6970 \ifx\floatlabel\empty \else 6971 % Write the text that goes in the lof to the aux file as 6972 % \floatlabel-lof. Besides \floatident, we include the short 6973 % caption if specified, else the full caption if specified, else nothing. 6974 {% 6975 \atdummies 6976 % 6977 % since we read the caption text in the macro world, where ^^M 6978 % is turned into a normal character, we have to scan it back, so 6979 % we don't write the literal three characters "^^M" into the aux file. 6980 \scanexp{% 6981 \xdef\noexpand\gtemp{% 6982 \ifx\thisshortcaption\empty 6983 \thiscaption 6984 \else 6985 \thisshortcaption 6986 \fi 6987 }% 6988 }% 6989 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident 6990 \ifx\gtemp\empty \else : \gtemp \fi}}% 6991 }% 6992 \fi 6993 \egroup % end of \vtop 6994 % 6995 % place the captured inserts 6996 % 6997 % BEWARE: when the floats start floating, we have to issue warning 6998 % whenever an insert appears inside a float which could possibly 6999 % float. --kasal, 26may04 7000 % 7001 \checkinserts 7002} 7003 7004% Append the tokens #2 to the definition of macro #1, not expanding either. 7005% 7006\def\appendtomacro#1#2{% 7007 \expandafter\def\expandafter#1\expandafter{#1#2}% 7008} 7009 7010% @caption, @shortcaption 7011% 7012\def\caption{\docaption\thiscaption} 7013\def\shortcaption{\docaption\thisshortcaption} 7014\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption} 7015\def\defcaption#1#2{\egroup \def#1{#2}} 7016 7017% The parameter is the control sequence identifying the counter we are 7018% going to use. Create it if it doesn't exist and assign it to \floatno. 7019\def\getfloatno#1{% 7020 \ifx#1\relax 7021 % Haven't seen this figure type before. 7022 \csname newcount\endcsname #1% 7023 % 7024 % Remember to reset this floatno at the next chap. 7025 \expandafter\gdef\expandafter\resetallfloatnos 7026 \expandafter{\resetallfloatnos #1=0 }% 7027 \fi 7028 \let\floatno#1% 7029} 7030 7031% \setref calls this to get the XREFLABEL-snt value. We want an @xref 7032% to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we 7033% first read the @float command. 7034% 7035\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% 7036 7037% Magic string used for the XREFLABEL-title value, so \xrefX can 7038% distinguish floats from other xref types. 7039\def\floatmagic{!!float!!} 7040 7041% #1 is the control sequence we are passed; we expand into a conditional 7042% which is true if #1 represents a float ref. That is, the magic 7043% \thissection value which we \setref above. 7044% 7045\def\iffloat#1{\expandafter\doiffloat#1==\finish} 7046% 7047% #1 is (maybe) the \floatmagic string. If so, #2 will be the 7048% (safe) float type for this float. We set \iffloattype to #2. 7049% 7050\def\doiffloat#1=#2=#3\finish{% 7051 \def\temp{#1}% 7052 \def\iffloattype{#2}% 7053 \ifx\temp\floatmagic 7054} 7055 7056% @listoffloats FLOATTYPE - print a list of floats like a table of contents. 7057% 7058\parseargdef\listoffloats{% 7059 \def\floattype{#1}% floattype 7060 {% 7061 % the floattype might have accents or other special characters, 7062 % but we need to use it in a control sequence name. 7063 \indexnofonts 7064 \turnoffactive 7065 \xdef\safefloattype{\floattype}% 7066 }% 7067 % 7068 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. 7069 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax 7070 \ifhavexrefs 7071 % if the user said @listoffloats foo but never @float foo. 7072 \message{\linenumber No `\safefloattype' floats to list.}% 7073 \fi 7074 \else 7075 \begingroup 7076 \leftskip=\tocindent % indent these entries like a toc 7077 \let\do=\listoffloatsdo 7078 \csname floatlist\safefloattype\endcsname 7079 \endgroup 7080 \fi 7081} 7082 7083% This is called on each entry in a list of floats. We're passed the 7084% xref label, in the form LABEL-title, which is how we save it in the 7085% aux file. We strip off the -title and look up \XRLABEL-lof, which 7086% has the text we're supposed to typeset here. 7087% 7088% Figures without xref labels will not be included in the list (since 7089% they won't appear in the aux file). 7090% 7091\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} 7092\def\listoffloatsdoentry#1-title\finish{{% 7093 % Can't fully expand XR#1-lof because it can contain anything. Just 7094 % pass the control sequence. On the other hand, XR#1-pg is just the 7095 % page number, and we want to fully expand that so we can get a link 7096 % in pdf output. 7097 \toksA = \expandafter{\csname XR#1-lof\endcsname}% 7098 % 7099 % use the same \entry macro we use to generate the TOC and index. 7100 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}% 7101 \writeentry 7102}} 7103 7104\message{localization,} 7105% and i18n. 7106 7107% @documentlanguage is usually given very early, just after 7108% @setfilename. If done too late, it may not override everything 7109% properly. Single argument is the language abbreviation. 7110% It would be nice if we could set up a hyphenation file here. 7111% 7112\parseargdef\documentlanguage{% 7113 \tex % read txi-??.tex file in plain TeX. 7114 % Read the file if it exists. 7115 \openin 1 txi-#1.tex 7116 \ifeof 1 7117 \errhelp = \nolanghelp 7118 \errmessage{Cannot read language file txi-#1.tex}% 7119 \else 7120 \input txi-#1.tex 7121 \fi 7122 \closein 1 7123 \endgroup 7124} 7125\newhelp\nolanghelp{The given language definition file cannot be found or 7126is empty. Maybe you need to install it? In the current directory 7127should work if nowhere else does.} 7128 7129 7130% @documentencoding should change something in TeX eventually, most 7131% likely, but for now just recognize it. 7132\let\documentencoding = \comment 7133 7134 7135% Page size parameters. 7136% 7137\newdimen\defaultparindent \defaultparindent = 15pt 7138 7139\chapheadingskip = 15pt plus 4pt minus 2pt 7140\secheadingskip = 12pt plus 3pt minus 2pt 7141\subsecheadingskip = 9pt plus 2pt minus 2pt 7142 7143% Prevent underfull vbox error messages. 7144\vbadness = 10000 7145 7146% Don't be so finicky about underfull hboxes, either. 7147\hbadness = 2000 7148 7149% Following George Bush, just get rid of widows and orphans. 7150\widowpenalty=10000 7151\clubpenalty=10000 7152 7153% Use TeX 3.0's \emergencystretch to help line breaking, but if we're 7154% using an old version of TeX, don't do anything. We want the amount of 7155% stretch added to depend on the line length, hence the dependence on 7156% \hsize. We call this whenever the paper size is set. 7157% 7158\def\setemergencystretch{% 7159 \ifx\emergencystretch\thisisundefined 7160 % Allow us to assign to \emergencystretch anyway. 7161 \def\emergencystretch{\dimen0}% 7162 \else 7163 \emergencystretch = .15\hsize 7164 \fi 7165} 7166 7167% Parameters in order: 1) textheight; 2) textwidth; 7168% 3) voffset; 4) hoffset; 5) binding offset; 6) topskip; 7169% 7) physical page height; 8) physical page width. 7170% 7171% We also call \setleading{\textleading}, so the caller should define 7172% \textleading. The caller should also set \parskip. 7173% 7174\def\internalpagesizes#1#2#3#4#5#6#7#8{% 7175 \voffset = #3\relax 7176 \topskip = #6\relax 7177 \splittopskip = \topskip 7178 % 7179 \vsize = #1\relax 7180 \advance\vsize by \topskip 7181 \outervsize = \vsize 7182 \advance\outervsize by 2\topandbottommargin 7183 \pageheight = \vsize 7184 % 7185 \hsize = #2\relax 7186 \outerhsize = \hsize 7187 \advance\outerhsize by 0.5in 7188 \pagewidth = \hsize 7189 % 7190 \normaloffset = #4\relax 7191 \bindingoffset = #5\relax 7192 % 7193 \ifpdf 7194 \pdfpageheight #7\relax 7195 \pdfpagewidth #8\relax 7196 \fi 7197 % 7198 \setleading{\textleading} 7199 % 7200 \parindent = \defaultparindent 7201 \setemergencystretch 7202} 7203 7204% @letterpaper (the default). 7205\def\letterpaper{{\globaldefs = 1 7206 \parskip = 3pt plus 2pt minus 1pt 7207 \textleading = 13.2pt 7208 % 7209 % If page is nothing but text, make it come out even. 7210 \internalpagesizes{46\baselineskip}{6in}% 7211 {\voffset}{.25in}% 7212 {\bindingoffset}{36pt}% 7213 {11in}{8.5in}% 7214}} 7215 7216% Use @smallbook to reset parameters for 7x9.25 trim size. 7217\def\smallbook{{\globaldefs = 1 7218 \parskip = 2pt plus 1pt 7219 \textleading = 12pt 7220 % 7221 \internalpagesizes{7.5in}{5in}% 7222 {\voffset}{.25in}% 7223 {\bindingoffset}{16pt}% 7224 {9.25in}{7in}% 7225 % 7226 \lispnarrowing = 0.3in 7227 \tolerance = 700 7228 \hfuzz = 1pt 7229 \contentsrightmargin = 0pt 7230 \defbodyindent = .5cm 7231}} 7232 7233% Use @smallerbook to reset parameters for 6x9 trim size. 7234% (Just testing, parameters still in flux.) 7235\def\smallerbook{{\globaldefs = 1 7236 \parskip = 1.5pt plus 1pt 7237 \textleading = 12pt 7238 % 7239 \internalpagesizes{7.4in}{4.8in}% 7240 {-.2in}{-.4in}% 7241 {0pt}{14pt}% 7242 {9in}{6in}% 7243 % 7244 \lispnarrowing = 0.25in 7245 \tolerance = 700 7246 \hfuzz = 1pt 7247 \contentsrightmargin = 0pt 7248 \defbodyindent = .4cm 7249}} 7250 7251% Use @afourpaper to print on European A4 paper. 7252\def\afourpaper{{\globaldefs = 1 7253 \parskip = 3pt plus 2pt minus 1pt 7254 \textleading = 13.2pt 7255 % 7256 % Double-side printing via postscript on Laserjet 4050 7257 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. 7258 % To change the settings for a different printer or situation, adjust 7259 % \normaloffset until the front-side and back-side texts align. Then 7260 % do the same for \bindingoffset. You can set these for testing in 7261 % your texinfo source file like this: 7262 % @tex 7263 % \global\normaloffset = -6mm 7264 % \global\bindingoffset = 10mm 7265 % @end tex 7266 \internalpagesizes{51\baselineskip}{160mm} 7267 {\voffset}{\hoffset}% 7268 {\bindingoffset}{44pt}% 7269 {297mm}{210mm}% 7270 % 7271 \tolerance = 700 7272 \hfuzz = 1pt 7273 \contentsrightmargin = 0pt 7274 \defbodyindent = 5mm 7275}} 7276 7277% Use @afivepaper to print on European A5 paper. 7278% From romildo@urano.iceb.ufop.br, 2 July 2000. 7279% He also recommends making @example and @lisp be small. 7280\def\afivepaper{{\globaldefs = 1 7281 \parskip = 2pt plus 1pt minus 0.1pt 7282 \textleading = 12.5pt 7283 % 7284 \internalpagesizes{160mm}{120mm}% 7285 {\voffset}{\hoffset}% 7286 {\bindingoffset}{8pt}% 7287 {210mm}{148mm}% 7288 % 7289 \lispnarrowing = 0.2in 7290 \tolerance = 800 7291 \hfuzz = 1.2pt 7292 \contentsrightmargin = 0pt 7293 \defbodyindent = 2mm 7294 \tableindent = 12mm 7295}} 7296 7297% A specific text layout, 24x15cm overall, intended for A4 paper. 7298\def\afourlatex{{\globaldefs = 1 7299 \afourpaper 7300 \internalpagesizes{237mm}{150mm}% 7301 {\voffset}{4.6mm}% 7302 {\bindingoffset}{7mm}% 7303 {297mm}{210mm}% 7304 % 7305 % Must explicitly reset to 0 because we call \afourpaper. 7306 \globaldefs = 0 7307}} 7308 7309% Use @afourwide to print on A4 paper in landscape format. 7310\def\afourwide{{\globaldefs = 1 7311 \afourpaper 7312 \internalpagesizes{241mm}{165mm}% 7313 {\voffset}{-2.95mm}% 7314 {\bindingoffset}{7mm}% 7315 {297mm}{210mm}% 7316 \globaldefs = 0 7317}} 7318 7319% @pagesizes TEXTHEIGHT[,TEXTWIDTH] 7320% Perhaps we should allow setting the margins, \topskip, \parskip, 7321% and/or leading, also. Or perhaps we should compute them somehow. 7322% 7323\parseargdef\pagesizes{\pagesizesyyy #1,,\finish} 7324\def\pagesizesyyy#1,#2,#3\finish{{% 7325 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi 7326 \globaldefs = 1 7327 % 7328 \parskip = 3pt plus 2pt minus 1pt 7329 \setleading{\textleading}% 7330 % 7331 \dimen0 = #1 7332 \advance\dimen0 by \voffset 7333 % 7334 \dimen2 = \hsize 7335 \advance\dimen2 by \normaloffset 7336 % 7337 \internalpagesizes{#1}{\hsize}% 7338 {\voffset}{\normaloffset}% 7339 {\bindingoffset}{44pt}% 7340 {\dimen0}{\dimen2}% 7341}} 7342 7343% Set default to letter. 7344% 7345\letterpaper 7346 7347 7348\message{and turning on texinfo input format.} 7349 7350% Define macros to output various characters with catcode for normal text. 7351\catcode`\"=\other 7352\catcode`\~=\other 7353\catcode`\^=\other 7354\catcode`\_=\other 7355\catcode`\|=\other 7356\catcode`\<=\other 7357\catcode`\>=\other 7358\catcode`\+=\other 7359\catcode`\$=\other 7360\def\normaldoublequote{"} 7361\def\normaltilde{~} 7362\def\normalcaret{^} 7363\def\normalunderscore{_} 7364\def\normalverticalbar{|} 7365\def\normalless{<} 7366\def\normalgreater{>} 7367\def\normalplus{+} 7368\def\normaldollar{$}%$ font-lock fix 7369 7370% This macro is used to make a character print one way in \tt 7371% (where it can probably be output as-is), and another way in other fonts, 7372% where something hairier probably needs to be done. 7373% 7374% #1 is what to print if we are indeed using \tt; #2 is what to print 7375% otherwise. Since all the Computer Modern typewriter fonts have zero 7376% interword stretch (and shrink), and it is reasonable to expect all 7377% typewriter fonts to have this, we can check that font parameter. 7378% 7379\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} 7380 7381% Same as above, but check for italic font. Actually this also catches 7382% non-italic slanted fonts since it is impossible to distinguish them from 7383% italic fonts. But since this is only used by $ and it uses \sl anyway 7384% this is not a problem. 7385\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} 7386 7387% Turn off all special characters except @ 7388% (and those which the user can use as if they were ordinary). 7389% Most of these we simply print from the \tt font, but for some, we can 7390% use math or other variants that look better in normal text. 7391 7392\catcode`\"=\active 7393\def\activedoublequote{{\tt\char34}} 7394\let"=\activedoublequote 7395\catcode`\~=\active 7396\def~{{\tt\char126}} 7397\chardef\hat=`\^ 7398\catcode`\^=\active 7399\def^{{\tt \hat}} 7400 7401\catcode`\_=\active 7402\def_{\ifusingtt\normalunderscore\_} 7403\let\realunder=_ 7404% Subroutine for the previous macro. 7405\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } 7406 7407\catcode`\|=\active 7408\def|{{\tt\char124}} 7409\chardef \less=`\< 7410\catcode`\<=\active 7411\def<{{\tt \less}} 7412\chardef \gtr=`\> 7413\catcode`\>=\active 7414\def>{{\tt \gtr}} 7415\catcode`\+=\active 7416\def+{{\tt \char 43}} 7417\catcode`\$=\active 7418\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix 7419 7420% If a .fmt file is being used, characters that might appear in a file 7421% name cannot be active until we have parsed the command line. 7422% So turn them off again, and have \everyjob (or @setfilename) turn them on. 7423% \otherifyactive is called near the end of this file. 7424\def\otherifyactive{\catcode`+=\other \catcode`\_=\other} 7425 7426% Used sometimes to turn off (effectively) the active characters even after 7427% parsing them. 7428\def\turnoffactive{% 7429 \normalturnoffactive 7430 \otherbackslash 7431} 7432 7433\catcode`\@=0 7434 7435% \backslashcurfont outputs one backslash character in current font, 7436% as in \char`\\. 7437\global\chardef\backslashcurfont=`\\ 7438\global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work 7439 7440% \realbackslash is an actual character `\' with catcode other, and 7441% \doublebackslash is two of them (for the pdf outlines). 7442{\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}} 7443 7444% In texinfo, backslash is an active character; it prints the backslash 7445% in fixed width font. 7446\catcode`\\=\active 7447@def@normalbackslash{{@tt@backslashcurfont}} 7448% On startup, @fixbackslash assigns: 7449% @let \ = @normalbackslash 7450 7451% \rawbackslash defines an active \ to do \backslashcurfont. 7452% \otherbackslash defines an active \ to be a literal `\' character with 7453% catcode other. 7454@gdef@rawbackslash{@let\=@backslashcurfont} 7455@gdef@otherbackslash{@let\=@realbackslash} 7456 7457% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of 7458% the literal character `\'. 7459% 7460@def@normalturnoffactive{% 7461 @let\=@normalbackslash 7462 @let"=@normaldoublequote 7463 @let~=@normaltilde 7464 @let^=@normalcaret 7465 @let_=@normalunderscore 7466 @let|=@normalverticalbar 7467 @let<=@normalless 7468 @let>=@normalgreater 7469 @let+=@normalplus 7470 @let$=@normaldollar %$ font-lock fix 7471 @unsepspaces 7472} 7473 7474% Make _ and + \other characters, temporarily. 7475% This is canceled by @fixbackslash. 7476@otherifyactive 7477 7478% If a .fmt file is being used, we don't want the `\input texinfo' to show up. 7479% That is what \eatinput is for; after that, the `\' should revert to printing 7480% a backslash. 7481% 7482@gdef@eatinput input texinfo{@fixbackslash} 7483@global@let\ = @eatinput 7484 7485% On the other hand, perhaps the file did not have a `\input texinfo'. Then 7486% the first `\' in the file would cause an error. This macro tries to fix 7487% that, assuming it is called before the first `\' could plausibly occur. 7488% Also turn back on active characters that might appear in the input 7489% file name, in case not using a pre-dumped format. 7490% 7491@gdef@fixbackslash{% 7492 @ifx\@eatinput @let\ = @normalbackslash @fi 7493 @catcode`+=@active 7494 @catcode`@_=@active 7495} 7496 7497% Say @foo, not \foo, in error messages. 7498@escapechar = `@@ 7499 7500% These look ok in all fonts, so just make them not special. 7501@catcode`@& = @other 7502@catcode`@# = @other 7503@catcode`@% = @other 7504 7505 7506@c Local variables: 7507@c eval: (add-hook 'write-file-hooks 'time-stamp) 7508@c page-delimiter: "^\\\\message" 7509@c time-stamp-start: "def\\\\texinfoversion{" 7510@c time-stamp-format: "%:y-%02m-%02d.%02H" 7511@c time-stamp-end: "}" 7512@c End: 7513 7514@c vim:sw=2: 7515 7516@ignore 7517 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 7518@end ignore 7519