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