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