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{2014-12-03.16} 7% 8% Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, 9% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 10% 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 Free 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 3 of the 15% License, or (at 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 program. If not, see <http://www.gnu.org/licenses/>. 24% 25% As a special exception, when this file is read by TeX when processing 26% a Texinfo source document, you may use the result without 27% restriction. This Exception is an additional permission under section 7 28% of the GNU General Public License, version 3 ("GPLv3"). 29% 30% Please try the latest version of texinfo.tex before submitting bug 31% reports; you can get the latest version from: 32% http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or 33% http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or 34% http://www.gnu.org/software/texinfo/ (the Texinfo home page) 35% The texinfo.tex in any given distribution could well be out 36% of date, so if that's what you're using, please check. 37% 38% Send bug reports to bug-texinfo@gnu.org. Please include including a 39% complete document in each bug report with which we can reproduce the 40% problem. Patches are, of course, greatly appreciated. 41% 42% To process a Texinfo manual with TeX, it's most reliable to use the 43% texi2dvi shell script that comes with the distribution. For a simple 44% manual foo.texi, however, you can get away with this: 45% tex foo.texi 46% texindex foo.?? 47% tex foo.texi 48% tex foo.texi 49% dvips foo.dvi -o # or whatever; this makes foo.ps. 50% The extra TeX runs get the cross-reference information correct. 51% Sometimes one run after texindex suffices, and sometimes you need more 52% than two; texi2dvi does it as many times as necessary. 53% 54% It is possible to adapt texinfo.tex for other languages, to some 55% extent. You can get the existing language-specific files from the 56% full Texinfo distribution. 57% 58% The GNU Texinfo home page is http://www.gnu.org/software/texinfo. 59 60 61\message{Loading texinfo [version \texinfoversion]:} 62 63% If in a .fmt file, print the version number 64% and turn on active characters that we couldn't do earlier because 65% they might have appeared in the input file name. 66\everyjob{\message{[Texinfo version \texinfoversion]}% 67 \catcode`+=\active \catcode`\_=\active} 68 69\chardef\other=12 70 71% We never want plain's \outer definition of \+ in Texinfo. 72% For @tex, we can use \tabalign. 73\let\+ = \relax 74 75% Save some plain tex macros whose names we will redefine. 76\let\ptexb=\b 77\let\ptexbullet=\bullet 78\let\ptexc=\c 79\let\ptexcomma=\, 80\let\ptexdot=\. 81\let\ptexdots=\dots 82\let\ptexend=\end 83\let\ptexequiv=\equiv 84\let\ptexexclam=\! 85\let\ptexfootnote=\footnote 86\let\ptexgtr=> 87\let\ptexhat=^ 88\let\ptexi=\i 89\let\ptexindent=\indent 90\let\ptexinsert=\insert 91\let\ptexlbrace=\{ 92\let\ptexless=< 93\let\ptexnewwrite\newwrite 94\let\ptexnoindent=\noindent 95\let\ptexplus=+ 96\let\ptexraggedright=\raggedright 97\let\ptexrbrace=\} 98\let\ptexslash=\/ 99\let\ptexsp=\sp 100\let\ptexstar=\* 101\let\ptexsup=\sup 102\let\ptext=\t 103\let\ptextop=\top 104{\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode 105 106% If this character appears in an error message or help string, it 107% starts a new line in the output. 108\newlinechar = `^^J 109 110% Use TeX 3.0's \inputlineno to get the line number, for better error 111% messages, but if we're using an old version of TeX, don't do anything. 112% 113\ifx\inputlineno\thisisundefined 114 \let\linenumber = \empty % Pre-3.0. 115\else 116 \def\linenumber{l.\the\inputlineno:\space} 117\fi 118 119% Set up fixed words for English if not already set. 120\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi 121\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi 122\ifx\putworderror\undefined \gdef\putworderror{error}\fi 123\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi 124\ifx\putwordin\undefined \gdef\putwordin{in}\fi 125\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi 126\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi 127\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi 128\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi 129\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi 130\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi 131\ifx\putwordof\undefined \gdef\putwordof{of}\fi 132\ifx\putwordon\undefined \gdef\putwordon{on}\fi 133\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi 134\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi 135\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi 136\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi 137\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi 138\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi 139\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi 140% 141\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi 142\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi 143\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi 144\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi 145\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi 146\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi 147\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi 148\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi 149\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi 150\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi 151\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi 152\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi 153% 154\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi 155\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi 156\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi 157\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi 158\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi 159 160% Since the category of space is not known, we have to be careful. 161\chardef\spacecat = 10 162\def\spaceisspace{\catcode`\ =\spacecat} 163 164% sometimes characters are active, so we need control sequences. 165\chardef\ampChar = `\& 166\chardef\colonChar = `\: 167\chardef\commaChar = `\, 168\chardef\dashChar = `\- 169\chardef\dotChar = `\. 170\chardef\exclamChar= `\! 171\chardef\hashChar = `\# 172\chardef\lquoteChar= `\` 173\chardef\questChar = `\? 174\chardef\rquoteChar= `\' 175\chardef\semiChar = `\; 176\chardef\slashChar = `\/ 177\chardef\underChar = `\_ 178 179% Ignore a token. 180% 181\def\gobble#1{} 182 183% The following is used inside several \edef's. 184\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} 185 186% Hyphenation fixes. 187\hyphenation{ 188 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script 189 ap-pen-dix bit-map bit-maps 190 data-base data-bases eshell fall-ing half-way long-est man-u-script 191 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm 192 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces 193 spell-ing spell-ings 194 stand-alone strong-est time-stamp time-stamps which-ever white-space 195 wide-spread wrap-around 196} 197 198% Margin to add to right of even pages, to left of odd pages. 199\newdimen\bindingoffset 200\newdimen\normaloffset 201\newdimen\pagewidth \newdimen\pageheight 202 203% For a final copy, take out the rectangles 204% that mark overfull boxes (in case you have decided 205% that the text looks ok even though it passes the margin). 206% 207\def\finalout{\overfullrule=0pt } 208 209% Sometimes it is convenient to have everything in the transcript file 210% and nothing on the terminal. We don't just call \tracingall here, 211% since that produces some useless output on the terminal. We also make 212% some effort to order the tracing commands to reduce output in the log 213% file; cf. trace.sty in LaTeX. 214% 215\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% 216\def\loggingall{% 217 \tracingstats2 218 \tracingpages1 219 \tracinglostchars2 % 2 gives us more in etex 220 \tracingparagraphs1 221 \tracingoutput1 222 \tracingmacros2 223 \tracingrestores1 224 \showboxbreadth\maxdimen \showboxdepth\maxdimen 225 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging 226 \tracingscantokens1 227 \tracingifs1 228 \tracinggroups1 229 \tracingnesting2 230 \tracingassigns1 231 \fi 232 \tracingcommands3 % 3 gives us more in etex 233 \errorcontextlines16 234}% 235 236% @errormsg{MSG}. Do the index-like expansions on MSG, but if things 237% aren't perfect, it's not the end of the world, being an error message, 238% after all. 239% 240\def\errormsg{\begingroup \indexnofonts \doerrormsg} 241\def\doerrormsg#1{\errmessage{#1}} 242 243% add check for \lastpenalty to plain's definitions. If the last thing 244% we did was a \nobreak, we don't want to insert more space. 245% 246\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount 247 \removelastskip\penalty-50\smallskip\fi\fi} 248\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount 249 \removelastskip\penalty-100\medskip\fi\fi} 250\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount 251 \removelastskip\penalty-200\bigskip\fi\fi} 252 253% Do @cropmarks to get crop marks. 254% 255\newif\ifcropmarks 256\let\cropmarks = \cropmarkstrue 257% 258% Dimensions to add cropmarks at corners. 259% Added by P. A. MacKay, 12 Nov. 1986 260% 261\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines 262\newdimen\cornerlong \cornerlong=1pc 263\newdimen\cornerthick \cornerthick=.3pt 264\newdimen\topandbottommargin \topandbottommargin=.75in 265 266% Output a mark which sets \thischapter, \thissection and \thiscolor. 267% We dump everything together because we only have one kind of mark. 268% This works because we only use \botmark / \topmark, not \firstmark. 269% 270% A mark contains a subexpression of the \ifcase ... \fi construct. 271% \get*marks macros below extract the needed part using \ifcase. 272% 273% Another complication is to let the user choose whether \thischapter 274% (\thissection) refers to the chapter (section) in effect at the top 275% of a page, or that at the bottom of a page. The solution is 276% described on page 260 of The TeXbook. It involves outputting two 277% marks for the sectioning macros, one before the section break, and 278% one after. I won't pretend I can describe this better than DEK... 279\def\domark{% 280 \toks0=\expandafter{\lastchapterdefs}% 281 \toks2=\expandafter{\lastsectiondefs}% 282 \toks4=\expandafter{\prevchapterdefs}% 283 \toks6=\expandafter{\prevsectiondefs}% 284 \toks8=\expandafter{\lastcolordefs}% 285 \mark{% 286 \the\toks0 \the\toks2 % 0: top marks (\last...) 287 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...) 288 \noexpand\else \the\toks8 % 2: color marks 289 }% 290} 291% \topmark doesn't work for the very first chapter (after the title 292% page or the contents), so we use \firstmark there -- this gets us 293% the mark with the chapter defs, unless the user sneaks in, e.g., 294% @setcolor (or @url, or @link, etc.) between @contents and the very 295% first @chapter. 296\def\gettopheadingmarks{% 297 \ifcase0\topmark\fi 298 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi 299} 300\def\getbottomheadingmarks{\ifcase1\botmark\fi} 301\def\getcolormarks{\ifcase2\topmark\fi} 302 303% Avoid "undefined control sequence" errors. 304\def\lastchapterdefs{} 305\def\lastsectiondefs{} 306\def\prevchapterdefs{} 307\def\prevsectiondefs{} 308\def\lastcolordefs{} 309 310% Main output routine. 311\chardef\PAGE = 255 312\output = {\onepageout{\pagecontents\PAGE}} 313 314\newbox\headlinebox 315\newbox\footlinebox 316 317% \onepageout takes a vbox as an argument. Note that \pagecontents 318% does insertions, but you have to call it yourself. 319\def\onepageout#1{% 320 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi 321 % 322 \ifodd\pageno \advance\hoffset by \bindingoffset 323 \else \advance\hoffset by -\bindingoffset\fi 324 % 325 % Do this outside of the \shipout so @code etc. will be expanded in 326 % the headline as they should be, not taken literally (outputting ''code). 327 \def\commmonheadfootline{\let\hsize=\pagewidth \texinfochars} 328 % 329 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi 330 \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}% 331 % 332 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi 333 \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}% 334 % 335 {% 336 % Have to do this stuff outside the \shipout because we want it to 337 % take effect in \write's, yet the group defined by the \vbox ends 338 % before the \shipout runs. 339 % 340 \indexdummies % don't expand commands in the output. 341 \normalturnoffactive % \ in index entries must not stay \, e.g., if 342 % the page break happens to be in the middle of an example. 343 % We don't want .vr (or whatever) entries like this: 344 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} 345 % "\acronym" won't work when it's read back in; 346 % it needs to be 347 % {\code {{\tt \backslashcurfont }acronym} 348 \shipout\vbox{% 349 % Do this early so pdf references go to the beginning of the page. 350 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi 351 % 352 \ifcropmarks \vbox to \outervsize\bgroup 353 \hsize = \outerhsize 354 \vskip-\topandbottommargin 355 \vtop to0pt{% 356 \line{\ewtop\hfil\ewtop}% 357 \nointerlineskip 358 \line{% 359 \vbox{\moveleft\cornerthick\nstop}% 360 \hfill 361 \vbox{\moveright\cornerthick\nstop}% 362 }% 363 \vss}% 364 \vskip\topandbottommargin 365 \line\bgroup 366 \hfil % center the page within the outer (page) hsize. 367 \ifodd\pageno\hskip\bindingoffset\fi 368 \vbox\bgroup 369 \fi 370 % 371 \unvbox\headlinebox 372 \pagebody{#1}% 373 \ifdim\ht\footlinebox > 0pt 374 % Only leave this space if the footline is nonempty. 375 % (We lessened \vsize for it in \oddfootingyyy.) 376 % The \baselineskip=24pt in plain's \makefootline has no effect. 377 \vskip 24pt 378 \unvbox\footlinebox 379 \fi 380 % 381 \ifcropmarks 382 \egroup % end of \vbox\bgroup 383 \hfil\egroup % end of (centering) \line\bgroup 384 \vskip\topandbottommargin plus1fill minus1fill 385 \boxmaxdepth = \cornerthick 386 \vbox to0pt{\vss 387 \line{% 388 \vbox{\moveleft\cornerthick\nsbot}% 389 \hfill 390 \vbox{\moveright\cornerthick\nsbot}% 391 }% 392 \nointerlineskip 393 \line{\ewbot\hfil\ewbot}% 394 }% 395 \egroup % \vbox from first cropmarks clause 396 \fi 397 }% end of \shipout\vbox 398 }% end of group with \indexdummies 399 \advancepageno 400 \ifnum\outputpenalty>-20000 \else\dosupereject\fi 401} 402 403\newinsert\margin \dimen\margin=\maxdimen 404 405\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} 406{\catcode`\@ =11 407\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi 408% marginal hacks, juha@viisa.uucp (Juha Takala) 409\ifvoid\margin\else % marginal info is present 410 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi 411\dimen@=\dp#1\relax \unvbox#1\relax 412\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi 413\ifr@ggedbottom \kern-\dimen@ \vfil \fi} 414} 415 416% Here are the rules for the cropmarks. Note that they are 417% offset so that the space between them is truly \outerhsize or \outervsize 418% (P. A. MacKay, 12 November, 1986) 419% 420\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} 421\def\nstop{\vbox 422 {\hrule height\cornerthick depth\cornerlong width\cornerthick}} 423\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} 424\def\nsbot{\vbox 425 {\hrule height\cornerlong depth\cornerthick width\cornerthick}} 426 427% Parse an argument, then pass it to #1. The argument is the rest of 428% the input line (except we remove a trailing comment). #1 should be a 429% macro which expects an ordinary undelimited TeX argument. 430% 431\def\parsearg{\parseargusing{}} 432\def\parseargusing#1#2{% 433 \def\argtorun{#2}% 434 \begingroup 435 \obeylines 436 \spaceisspace 437 #1% 438 \parseargline\empty% Insert the \empty token, see \finishparsearg below. 439} 440 441{\obeylines % 442 \gdef\parseargline#1^^M{% 443 \endgroup % End of the group started in \parsearg. 444 \argremovecomment #1\comment\ArgTerm% 445 }% 446} 447 448% First remove any @comment, then any @c comment. 449\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} 450\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} 451 452% Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space. 453% 454% \argremovec might leave us with trailing space, e.g., 455% @end itemize @c foo 456% This space token undergoes the same procedure and is eventually removed 457% by \finishparsearg. 458% 459\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} 460\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} 461\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% 462 \def\temp{#3}% 463 \ifx\temp\empty 464 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp: 465 \let\temp\finishparsearg 466 \else 467 \let\temp\argcheckspaces 468 \fi 469 % Put the space token in: 470 \temp#1 #3\ArgTerm 471} 472 473% If a _delimited_ argument is enclosed in braces, they get stripped; so 474% to get _exactly_ the rest of the line, we had to prevent such situation. 475% We prepended an \empty token at the very beginning and we expand it now, 476% just before passing the control to \argtorun. 477% (Similarly, we have to think about #3 of \argcheckspacesY above: it is 478% either the null string, or it ends with \^^M---thus there is no danger 479% that a pair of braces would be stripped. 480% 481% But first, we have to remove the trailing space token. 482% 483\def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}} 484 485% \parseargdef\foo{...} 486% is roughly equivalent to 487% \def\foo{\parsearg\Xfoo} 488% \def\Xfoo#1{...} 489% 490% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my 491% favourite TeX trick. --kasal, 16nov03 492 493\def\parseargdef#1{% 494 \expandafter \doparseargdef \csname\string#1\endcsname #1% 495} 496\def\doparseargdef#1#2{% 497 \def#2{\parsearg#1}% 498 \def#1##1% 499} 500 501% Several utility definitions with active space: 502{ 503 \obeyspaces 504 \gdef\obeyedspace{ } 505 506 % Make each space character in the input produce a normal interword 507 % space in the output. Don't allow a line break at this space, as this 508 % is used only in environments like @example, where each line of input 509 % should produce a line of output anyway. 510 % 511 \gdef\sepspaces{\obeyspaces\let =\tie} 512 513 % If an index command is used in an @example environment, any spaces 514 % therein should become regular spaces in the raw index file, not the 515 % expansion of \tie (\leavevmode \penalty \@M \ ). 516 \gdef\unsepspaces{\let =\space} 517} 518 519 520\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} 521 522% Define the framework for environments in texinfo.tex. It's used like this: 523% 524% \envdef\foo{...} 525% \def\Efoo{...} 526% 527% It's the responsibility of \envdef to insert \begingroup before the 528% actual body; @end closes the group after calling \Efoo. \envdef also 529% defines \thisenv, so the current environment is known; @end checks 530% whether the environment name matches. The \checkenv macro can also be 531% used to check whether the current environment is the one expected. 532% 533% Non-false conditionals (@iftex, @ifset) don't fit into this, so they 534% are not treated as environments; they don't open a group. (The 535% implementation of @end takes care not to call \endgroup in this 536% special case.) 537 538 539% At run-time, environments start with this: 540\def\startenvironment#1{\begingroup\def\thisenv{#1}} 541% initialize 542\let\thisenv\empty 543 544% ... but they get defined via ``\envdef\foo{...}'': 545\long\def\envdef#1#2{\def#1{\startenvironment#1#2}} 546\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} 547 548% Check whether we're in the right environment: 549\def\checkenv#1{% 550 \def\temp{#1}% 551 \ifx\thisenv\temp 552 \else 553 \badenverr 554 \fi 555} 556 557% Environment mismatch, #1 expected: 558\def\badenverr{% 559 \errhelp = \EMsimple 560 \errmessage{This command can appear only \inenvironment\temp, 561 not \inenvironment\thisenv}% 562} 563\def\inenvironment#1{% 564 \ifx#1\empty 565 outside of any environment% 566 \else 567 in environment \expandafter\string#1% 568 \fi 569} 570 571% @end foo executes the definition of \Efoo. 572% But first, it executes a specialized version of \checkenv 573% 574\parseargdef\end{% 575 \if 1\csname iscond.#1\endcsname 576 \else 577 % The general wording of \badenverr may not be ideal. 578 \expandafter\checkenv\csname#1\endcsname 579 \csname E#1\endcsname 580 \endgroup 581 \fi 582} 583 584\newhelp\EMsimple{Press RETURN to continue.} 585 586 587% Be sure we're in horizontal mode when doing a tie, since we make space 588% equivalent to this in @example-like environments. Otherwise, a space 589% at the beginning of a line will start with \penalty -- and 590% since \penalty is valid in vertical mode, we'd end up putting the 591% penalty on the vertical list instead of in the new paragraph. 592{\catcode`@ = 11 593 % Avoid using \@M directly, because that causes trouble 594 % if the definition is written into an index file. 595 \global\let\tiepenalty = \@M 596 \gdef\tie{\leavevmode\penalty\tiepenalty\ } 597} 598 599% @: forces normal size whitespace following. 600\def\:{\spacefactor=1000 } 601 602% @* forces a line break. 603\def\*{\unskip\hfil\break\hbox{}\ignorespaces} 604 605% @/ allows a line break. 606\let\/=\allowbreak 607 608% @. is an end-of-sentence period. 609\def\.{.\spacefactor=\endofsentencespacefactor\space} 610 611% @! is an end-of-sentence bang. 612\def\!{!\spacefactor=\endofsentencespacefactor\space} 613 614% @? is an end-of-sentence query. 615\def\?{?\spacefactor=\endofsentencespacefactor\space} 616 617% @frenchspacing on|off says whether to put extra space after punctuation. 618% 619\def\onword{on} 620\def\offword{off} 621% 622\parseargdef\frenchspacing{% 623 \def\temp{#1}% 624 \ifx\temp\onword \plainfrenchspacing 625 \else\ifx\temp\offword \plainnonfrenchspacing 626 \else 627 \errhelp = \EMsimple 628 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}% 629 \fi\fi 630} 631 632% @w prevents a word break. Without the \leavevmode, @w at the 633% beginning of a paragraph, when TeX is still in vertical mode, would 634% produce a whole line of output instead of starting the paragraph. 635\def\w#1{\leavevmode\hbox{#1}} 636 637% @group ... @end group forces ... to be all on one page, by enclosing 638% it in a TeX vbox. We use \vtop instead of \vbox to construct the box 639% to keep its height that of a normal line. According to the rules for 640% \topskip (p.114 of the TeXbook), the glue inserted is 641% max (\topskip - \ht (first item), 0). If that height is large, 642% therefore, no glue is inserted, and the space between the headline and 643% the text is small, which looks bad. 644% 645% Another complication is that the group might be very large. This can 646% cause the glue on the previous page to be unduly stretched, because it 647% does not have much material. In this case, it's better to add an 648% explicit \vfill so that the extra space is at the bottom. The 649% threshold for doing this is if the group is more than \vfilllimit 650% percent of a page (\vfilllimit can be changed inside of @tex). 651% 652\newbox\groupbox 653\def\vfilllimit{0.7} 654% 655\envdef\group{% 656 \ifnum\catcode`\^^M=\active \else 657 \errhelp = \groupinvalidhelp 658 \errmessage{@group invalid in context where filling is enabled}% 659 \fi 660 \startsavinginserts 661 % 662 \setbox\groupbox = \vtop\bgroup 663 % Do @comment since we are called inside an environment such as 664 % @example, where each end-of-line in the input causes an 665 % end-of-line in the output. We don't want the end-of-line after 666 % the `@group' to put extra space in the output. Since @group 667 % should appear on a line by itself (according to the Texinfo 668 % manual), we don't worry about eating any user text. 669 \comment 670} 671% 672% The \vtop produces a box with normal height and large depth; thus, TeX puts 673% \baselineskip glue before it, and (when the next line of text is done) 674% \lineskip glue after it. Thus, space below is not quite equal to space 675% above. But it's pretty close. 676\def\Egroup{% 677 % To get correct interline space between the last line of the group 678 % and the first line afterwards, we have to propagate \prevdepth. 679 \endgraf % Not \par, as it may have been set to \lisppar. 680 \global\dimen1 = \prevdepth 681 \egroup % End the \vtop. 682 % \dimen0 is the vertical size of the group's box. 683 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox 684 % \dimen2 is how much space is left on the page (more or less). 685 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal 686 % if the group doesn't fit on the current page, and it's a big big 687 % group, force a page break. 688 \ifdim \dimen0 > \dimen2 689 \ifdim \pagetotal < \vfilllimit\pageheight 690 \page 691 \fi 692 \fi 693 \box\groupbox 694 \prevdepth = \dimen1 695 \checkinserts 696} 697% 698% TeX puts in an \escapechar (i.e., `@') at the beginning of the help 699% message, so this ends up printing `@group can only ...'. 700% 701\newhelp\groupinvalidhelp{% 702group can only be used in environments such as @example,^^J% 703where each line of input produces a line of output.} 704 705% @need space-in-mils 706% forces a page break if there is not space-in-mils remaining. 707 708\newdimen\mil \mil=0.001in 709 710\parseargdef\need{% 711 % Ensure vertical mode, so we don't make a big box in the middle of a 712 % paragraph. 713 \par 714 % 715 % If the @need value is less than one line space, it's useless. 716 \dimen0 = #1\mil 717 \dimen2 = \ht\strutbox 718 \advance\dimen2 by \dp\strutbox 719 \ifdim\dimen0 > \dimen2 720 % 721 % Do a \strut just to make the height of this box be normal, so the 722 % normal leading is inserted relative to the preceding line. 723 % And a page break here is fine. 724 \vtop to #1\mil{\strut\vfil}% 725 % 726 % TeX does not even consider page breaks if a penalty added to the 727 % main vertical list is 10000 or more. But in order to see if the 728 % empty box we just added fits on the page, we must make it consider 729 % page breaks. On the other hand, we don't want to actually break the 730 % page after the empty box. So we use a penalty of 9999. 731 % 732 % There is an extremely small chance that TeX will actually break the 733 % page at this \penalty, if there are no other feasible breakpoints in 734 % sight. (If the user is using lots of big @group commands, which 735 % almost-but-not-quite fill up a page, TeX will have a hard time doing 736 % good page breaking, for example.) However, I could not construct an 737 % example where a page broke at this \penalty; if it happens in a real 738 % document, then we can reconsider our strategy. 739 \penalty9999 740 % 741 % Back up by the size of the box, whether we did a page break or not. 742 \kern -#1\mil 743 % 744 % Do not allow a page break right after this kern. 745 \nobreak 746 \fi 747} 748 749% @br forces paragraph break (and is undocumented). 750 751\let\br = \par 752 753% @page forces the start of a new page. 754% 755\def\page{\par\vfill\supereject} 756 757% @exdent text.... 758% outputs text on separate line in roman font, starting at standard page margin 759 760% This records the amount of indent in the innermost environment. 761% That's how much \exdent should take out. 762\newskip\exdentamount 763 764% This defn is used inside fill environments such as @defun. 765\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} 766 767% This defn is used inside nofill environments such as @example. 768\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount 769 \leftline{\hskip\leftskip{\rm#1}}}} 770 771% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current 772% paragraph. For more general purposes, use the \margin insertion 773% class. WHICH is `l' or `r'. Not documented, written for gawk manual. 774% 775\newskip\inmarginspacing \inmarginspacing=1cm 776\def\strutdepth{\dp\strutbox} 777% 778\def\doinmargin#1#2{\strut\vadjust{% 779 \nobreak 780 \kern-\strutdepth 781 \vtop to \strutdepth{% 782 \baselineskip=\strutdepth 783 \vss 784 % if you have multiple lines of stuff to put here, you'll need to 785 % make the vbox yourself of the appropriate size. 786 \ifx#1l% 787 \llap{\ignorespaces #2\hskip\inmarginspacing}% 788 \else 789 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% 790 \fi 791 \null 792 }% 793}} 794\def\inleftmargin{\doinmargin l} 795\def\inrightmargin{\doinmargin r} 796% 797% @inmargin{TEXT [, RIGHT-TEXT]} 798% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; 799% else use TEXT for both). 800% 801\def\inmargin#1{\parseinmargin #1,,\finish} 802\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. 803 \setbox0 = \hbox{\ignorespaces #2}% 804 \ifdim\wd0 > 0pt 805 \def\lefttext{#1}% have both texts 806 \def\righttext{#2}% 807 \else 808 \def\lefttext{#1}% have only one text 809 \def\righttext{#1}% 810 \fi 811 % 812 \ifodd\pageno 813 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin 814 \else 815 \def\temp{\inleftmargin\lefttext}% 816 \fi 817 \temp 818} 819 820% @| inserts a changebar to the left of the current line. It should 821% surround any changed text. This approach does *not* work if the 822% change spans more than two lines of output. To handle that, we would 823% have adopt a much more difficult approach (putting marks into the main 824% vertical list for the beginning and end of each change). This command 825% is not documented, not supported, and doesn't work. 826% 827\def\|{% 828 % \vadjust can only be used in horizontal mode. 829 \leavevmode 830 % 831 % Append this vertical mode material after the current line in the output. 832 \vadjust{% 833 % We want to insert a rule with the height and depth of the current 834 % leading; that is exactly what \strutbox is supposed to record. 835 \vskip-\baselineskip 836 % 837 % \vadjust-items are inserted at the left edge of the type. So 838 % the \llap here moves out into the left-hand margin. 839 \llap{% 840 % 841 % For a thicker or thinner bar, change the `1pt'. 842 \vrule height\baselineskip width1pt 843 % 844 % This is the space between the bar and the text. 845 \hskip 12pt 846 }% 847 }% 848} 849 850% @include FILE -- \input text of FILE. 851% 852\def\include{\parseargusing\filenamecatcodes\includezzz} 853\def\includezzz#1{% 854 \pushthisfilestack 855 \def\thisfile{#1}% 856 {% 857 \makevalueexpandable % we want to expand any @value in FILE. 858 \turnoffactive % and allow special characters in the expansion 859 \indexnofonts % Allow `@@' and other weird things in file names. 860 \wlog{texinfo.tex: doing @include of #1^^J}% 861 \edef\temp{\noexpand\input #1 }% 862 % 863 % This trickery is to read FILE outside of a group, in case it makes 864 % definitions, etc. 865 \expandafter 866 }\temp 867 \popthisfilestack 868} 869\def\filenamecatcodes{% 870 \catcode`\\=\other 871 \catcode`~=\other 872 \catcode`^=\other 873 \catcode`_=\other 874 \catcode`|=\other 875 \catcode`<=\other 876 \catcode`>=\other 877 \catcode`+=\other 878 \catcode`-=\other 879 \catcode`\`=\other 880 \catcode`\'=\other 881} 882 883\def\pushthisfilestack{% 884 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm 885} 886\def\pushthisfilestackX{% 887 \expandafter\pushthisfilestackY\thisfile\StackTerm 888} 889\def\pushthisfilestackY #1\StackTerm #2\StackTerm {% 890 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% 891} 892 893\def\popthisfilestack{\errthisfilestackempty} 894\def\errthisfilestackempty{\errmessage{Internal error: 895 the stack of filenames is empty.}} 896% 897\def\thisfile{} 898 899% @center line 900% outputs that line, centered. 901% 902\parseargdef\center{% 903 \ifhmode 904 \let\centersub\centerH 905 \else 906 \let\centersub\centerV 907 \fi 908 \centersub{\hfil \ignorespaces#1\unskip \hfil}% 909 \let\centersub\relax % don't let the definition persist, just in case 910} 911\def\centerH#1{{% 912 \hfil\break 913 \advance\hsize by -\leftskip 914 \advance\hsize by -\rightskip 915 \line{#1}% 916 \break 917}} 918% 919\newcount\centerpenalty 920\def\centerV#1{% 921 % The idea here is the same as in \startdefun, \cartouche, etc.: if 922 % @center is the first thing after a section heading, we need to wipe 923 % out the negative parskip inserted by \sectionheading, but still 924 % prevent a page break here. 925 \centerpenalty = \lastpenalty 926 \ifnum\centerpenalty>10000 \vskip\parskip \fi 927 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi 928 \line{\kern\leftskip #1\kern\rightskip}% 929} 930 931% @sp n outputs n lines of vertical space 932% 933\parseargdef\sp{\vskip #1\baselineskip} 934 935% @comment ...line which is ignored... 936% @c is the same as @comment 937% @ignore ... @end ignore is another way to write a comment 938% 939\def\comment{\begingroup \catcode`\^^M=\other% 940\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% 941\commentxxx} 942{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} 943% 944\let\c=\comment 945 946% @paragraphindent NCHARS 947% We'll use ems for NCHARS, close enough. 948% NCHARS can also be the word `asis' or `none'. 949% We cannot feasibly implement @paragraphindent asis, though. 950% 951\def\asisword{asis} % no translation, these are keywords 952\def\noneword{none} 953% 954\parseargdef\paragraphindent{% 955 \def\temp{#1}% 956 \ifx\temp\asisword 957 \else 958 \ifx\temp\noneword 959 \defaultparindent = 0pt 960 \else 961 \defaultparindent = #1em 962 \fi 963 \fi 964 \parindent = \defaultparindent 965} 966 967% @exampleindent NCHARS 968% We'll use ems for NCHARS like @paragraphindent. 969% It seems @exampleindent asis isn't necessary, but 970% I preserve it to make it similar to @paragraphindent. 971\parseargdef\exampleindent{% 972 \def\temp{#1}% 973 \ifx\temp\asisword 974 \else 975 \ifx\temp\noneword 976 \lispnarrowing = 0pt 977 \else 978 \lispnarrowing = #1em 979 \fi 980 \fi 981} 982 983% @firstparagraphindent WORD 984% If WORD is `none', then suppress indentation of the first paragraph 985% after a section heading. If WORD is `insert', then do indent at such 986% paragraphs. 987% 988% The paragraph indentation is suppressed or not by calling 989% \suppressfirstparagraphindent, which the sectioning commands do. 990% We switch the definition of this back and forth according to WORD. 991% By default, we suppress indentation. 992% 993\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} 994\def\insertword{insert} 995% 996\parseargdef\firstparagraphindent{% 997 \def\temp{#1}% 998 \ifx\temp\noneword 999 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent 1000 \else\ifx\temp\insertword 1001 \let\suppressfirstparagraphindent = \relax 1002 \else 1003 \errhelp = \EMsimple 1004 \errmessage{Unknown @firstparagraphindent option `\temp'}% 1005 \fi\fi 1006} 1007 1008% Here is how we actually suppress indentation. Redefine \everypar to 1009% \kern backwards by \parindent, and then reset itself to empty. 1010% 1011% We also make \indent itself not actually do anything until the next 1012% paragraph. 1013% 1014\gdef\dosuppressfirstparagraphindent{% 1015 \gdef\indent {\restorefirstparagraphindent \indent}% 1016 \gdef\noindent{\restorefirstparagraphindent \noindent}% 1017 \global\everypar = {\kern -\parindent \restorefirstparagraphindent}% 1018} 1019% 1020\gdef\restorefirstparagraphindent{% 1021 \global\let\indent = \ptexindent 1022 \global\let\noindent = \ptexnoindent 1023 \global\everypar = {}% 1024} 1025 1026 1027% @refill is a no-op. 1028\let\refill=\relax 1029 1030% If working on a large document in chapters, it is convenient to 1031% be able to disable indexing, cross-referencing, and contents, for test runs. 1032% This is done with @novalidate (before @setfilename). 1033% 1034\newif\iflinks \linkstrue % by default we want the aux files. 1035\let\novalidate = \linksfalse 1036 1037% @setfilename is done at the beginning of every texinfo file. 1038% So open here the files we need to have open while reading the input. 1039% This makes it possible to make a .fmt file for texinfo. 1040\def\setfilename{% 1041 \fixbackslash % Turn off hack to swallow `\input texinfo'. 1042 \iflinks 1043 \tryauxfile 1044 % Open the new aux file. TeX will close it automatically at exit. 1045 \immediate\openout\auxfile=\jobname.aux 1046 \fi % \openindices needs to do some work in any case. 1047 \openindices 1048 \let\setfilename=\comment % Ignore extra @setfilename cmds. 1049 % 1050 % If texinfo.cnf is present on the system, read it. 1051 % Useful for site-wide @afourpaper, etc. 1052 \openin 1 texinfo.cnf 1053 \ifeof 1 \else \input texinfo.cnf \fi 1054 \closein 1 1055 % 1056 \comment % Ignore the actual filename. 1057} 1058 1059% Called from \setfilename. 1060% 1061\def\openindices{% 1062 \newindex{cp}% 1063 \newcodeindex{fn}% 1064 \newcodeindex{vr}% 1065 \newcodeindex{tp}% 1066 \newcodeindex{ky}% 1067 \newcodeindex{pg}% 1068} 1069 1070% @bye. 1071\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} 1072 1073 1074\message{pdf,} 1075% adobe `portable' document format 1076\newcount\tempnum 1077\newcount\lnkcount 1078\newtoks\filename 1079\newcount\filenamelength 1080\newcount\pgn 1081\newtoks\toksA 1082\newtoks\toksB 1083\newtoks\toksC 1084\newtoks\toksD 1085\newbox\boxA 1086\newcount\countA 1087\newif\ifpdf 1088\newif\ifpdfmakepagedest 1089 1090% when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 1091% can be set). So we test for \relax and 0 as well as being undefined. 1092\ifx\pdfoutput\thisisundefined 1093\else 1094 \ifx\pdfoutput\relax 1095 \else 1096 \ifcase\pdfoutput 1097 \else 1098 \pdftrue 1099 \fi 1100 \fi 1101\fi 1102 1103% PDF uses PostScript string constants for the names of xref targets, 1104% for display in the outlines, and in other places. Thus, we have to 1105% double any backslashes. Otherwise, a name like "\node" will be 1106% interpreted as a newline (\n), followed by o, d, e. Not good. 1107% 1108% See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and 1109% related messages. The final outcome is that it is up to the TeX user 1110% to double the backslashes and otherwise make the string valid, so 1111% that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to 1112% do this reliably, so we use it. 1113 1114% #1 is a control sequence in which to do the replacements, 1115% which we \xdef. 1116\def\txiescapepdf#1{% 1117 \ifx\pdfescapestring\thisisundefined 1118 % No primitive available; should we give a warning or log? 1119 % Many times it won't matter. 1120 \else 1121 % The expandable \pdfescapestring primitive escapes parentheses, 1122 % backslashes, and other special chars. 1123 \xdef#1{\pdfescapestring{#1}}% 1124 \fi 1125} 1126 1127\newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images 1128with PDF output, and none of those formats could be found. (.eps cannot 1129be supported due to the design of the PDF format; use regular TeX (DVI 1130output) for that.)} 1131 1132\ifpdf 1133 % 1134 % Color manipulation macros using ideas from pdfcolor.tex, 1135 % except using rgb instead of cmyk; the latter is said to render as a 1136 % very dark gray on-screen and a very dark halftone in print, instead 1137 % of actual black. The dark red here is dark enough to print on paper as 1138 % nearly black, but still distinguishable for online viewing. We use 1139 % black by default, though. 1140 \def\rgbDarkRed{0.50 0.09 0.12} 1141 \def\rgbBlack{0 0 0} 1142 % 1143 % k sets the color for filling (usual text, etc.); 1144 % K sets the color for stroking (thin rules, e.g., normal _'s). 1145 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}} 1146 % 1147 % Set color, and create a mark which defines \thiscolor accordingly, 1148 % so that \makeheadline knows which color to restore. 1149 \def\setcolor#1{% 1150 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}% 1151 \domark 1152 \pdfsetcolor{#1}% 1153 } 1154 % 1155 \def\maincolor{\rgbBlack} 1156 \pdfsetcolor{\maincolor} 1157 \edef\thiscolor{\maincolor} 1158 \def\lastcolordefs{} 1159 % 1160 \def\makefootline{% 1161 \baselineskip24pt 1162 \line{\pdfsetcolor{\maincolor}\the\footline}% 1163 } 1164 % 1165 \def\makeheadline{% 1166 \vbox to 0pt{% 1167 \vskip-22.5pt 1168 \line{% 1169 \vbox to8.5pt{}% 1170 % Extract \thiscolor definition from the marks. 1171 \getcolormarks 1172 % Typeset the headline with \maincolor, then restore the color. 1173 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}% 1174 }% 1175 \vss 1176 }% 1177 \nointerlineskip 1178 } 1179 % 1180 % 1181 \pdfcatalog{/PageMode /UseOutlines} 1182 % 1183 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto). 1184 \def\dopdfimage#1#2#3{% 1185 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% 1186 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% 1187 % 1188 % pdftex (and the PDF format) support .pdf, .png, .jpg (among 1189 % others). Let's try in that order, PDF first since if 1190 % someone has a scalable image, presumably better to use that than a 1191 % bitmap. 1192 \let\pdfimgext=\empty 1193 \begingroup 1194 \openin 1 #1.pdf \ifeof 1 1195 \openin 1 #1.PDF \ifeof 1 1196 \openin 1 #1.png \ifeof 1 1197 \openin 1 #1.jpg \ifeof 1 1198 \openin 1 #1.jpeg \ifeof 1 1199 \openin 1 #1.JPG \ifeof 1 1200 \errhelp = \nopdfimagehelp 1201 \errmessage{Could not find image file #1 for pdf}% 1202 \else \gdef\pdfimgext{JPG}% 1203 \fi 1204 \else \gdef\pdfimgext{jpeg}% 1205 \fi 1206 \else \gdef\pdfimgext{jpg}% 1207 \fi 1208 \else \gdef\pdfimgext{png}% 1209 \fi 1210 \else \gdef\pdfimgext{PDF}% 1211 \fi 1212 \else \gdef\pdfimgext{pdf}% 1213 \fi 1214 \closein 1 1215 \endgroup 1216 % 1217 % without \immediate, ancient pdftex seg faults when the same image is 1218 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) 1219 \ifnum\pdftexversion < 14 1220 \immediate\pdfimage 1221 \else 1222 \immediate\pdfximage 1223 \fi 1224 \ifdim \wd0 >0pt width \pdfimagewidth \fi 1225 \ifdim \wd2 >0pt height \pdfimageheight \fi 1226 \ifnum\pdftexversion<13 1227 #1.\pdfimgext 1228 \else 1229 {#1.\pdfimgext}% 1230 \fi 1231 \ifnum\pdftexversion < 14 \else 1232 \pdfrefximage \pdflastximage 1233 \fi} 1234 % 1235 \def\pdfmkdest#1{{% 1236 % We have to set dummies so commands such as @code, and characters 1237 % such as \, aren't expanded when present in a section title. 1238 \indexnofonts 1239 \turnoffactive 1240 \makevalueexpandable 1241 \def\pdfdestname{#1}% 1242 \txiescapepdf\pdfdestname 1243 \safewhatsit{\pdfdest name{\pdfdestname} xyz}% 1244 }} 1245 % 1246 % used to mark target names; must be expandable. 1247 \def\pdfmkpgn#1{#1} 1248 % 1249 % by default, use black for everything. 1250 \def\urlcolor{\rgbBlack} 1251 \def\linkcolor{\rgbBlack} 1252 \def\endlink{\setcolor{\maincolor}\pdfendlink} 1253 % 1254 % Adding outlines to PDF; macros for calculating structure of outlines 1255 % come from Petr Olsak 1256 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% 1257 \else \csname#1\endcsname \fi} 1258 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax 1259 \advance\tempnum by 1 1260 \expandafter\xdef\csname#1\endcsname{\the\tempnum}} 1261 % 1262 % #1 is the section text, which is what will be displayed in the 1263 % outline by the pdf viewer. #2 is the pdf expression for the number 1264 % of subentries (or empty, for subsubsections). #3 is the node text, 1265 % which might be empty if this toc entry had no corresponding node. 1266 % #4 is the page number 1267 % 1268 \def\dopdfoutline#1#2#3#4{% 1269 % Generate a link to the node text if that exists; else, use the 1270 % page number. We could generate a destination for the section 1271 % text in the case where a section has no node, but it doesn't 1272 % seem worth the trouble, since most documents are normally structured. 1273 \edef\pdfoutlinedest{#3}% 1274 \ifx\pdfoutlinedest\empty 1275 \def\pdfoutlinedest{#4}% 1276 \else 1277 \txiescapepdf\pdfoutlinedest 1278 \fi 1279 % 1280 % Also escape PDF chars in the display string. 1281 \edef\pdfoutlinetext{#1}% 1282 \txiescapepdf\pdfoutlinetext 1283 % 1284 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}% 1285 } 1286 % 1287 \def\pdfmakeoutlines{% 1288 \begingroup 1289 % Read toc silently, to get counts of subentries for \pdfoutline. 1290 \def\partentry##1##2##3##4{}% ignore parts in the outlines 1291 \def\numchapentry##1##2##3##4{% 1292 \def\thischapnum{##2}% 1293 \def\thissecnum{0}% 1294 \def\thissubsecnum{0}% 1295 }% 1296 \def\numsecentry##1##2##3##4{% 1297 \advancenumber{chap\thischapnum}% 1298 \def\thissecnum{##2}% 1299 \def\thissubsecnum{0}% 1300 }% 1301 \def\numsubsecentry##1##2##3##4{% 1302 \advancenumber{sec\thissecnum}% 1303 \def\thissubsecnum{##2}% 1304 }% 1305 \def\numsubsubsecentry##1##2##3##4{% 1306 \advancenumber{subsec\thissubsecnum}% 1307 }% 1308 \def\thischapnum{0}% 1309 \def\thissecnum{0}% 1310 \def\thissubsecnum{0}% 1311 % 1312 % use \def rather than \let here because we redefine \chapentry et 1313 % al. a second time, below. 1314 \def\appentry{\numchapentry}% 1315 \def\appsecentry{\numsecentry}% 1316 \def\appsubsecentry{\numsubsecentry}% 1317 \def\appsubsubsecentry{\numsubsubsecentry}% 1318 \def\unnchapentry{\numchapentry}% 1319 \def\unnsecentry{\numsecentry}% 1320 \def\unnsubsecentry{\numsubsecentry}% 1321 \def\unnsubsubsecentry{\numsubsubsecentry}% 1322 \readdatafile{toc}% 1323 % 1324 % Read toc second time, this time actually producing the outlines. 1325 % The `-' means take the \expnumber as the absolute number of 1326 % subentries, which we calculated on our first read of the .toc above. 1327 % 1328 % We use the node names as the destinations. 1329 \def\numchapentry##1##2##3##4{% 1330 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% 1331 \def\numsecentry##1##2##3##4{% 1332 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% 1333 \def\numsubsecentry##1##2##3##4{% 1334 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% 1335 \def\numsubsubsecentry##1##2##3##4{% count is always zero 1336 \dopdfoutline{##1}{}{##3}{##4}}% 1337 % 1338 % PDF outlines are displayed using system fonts, instead of 1339 % document fonts. Therefore we cannot use special characters, 1340 % since the encoding is unknown. For example, the eogonek from 1341 % Latin 2 (0xea) gets translated to a | character. Info from 1342 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. 1343 % 1344 % TODO this right, we have to translate 8-bit characters to 1345 % their "best" equivalent, based on the @documentencoding. Too 1346 % much work for too little return. Just use the ASCII equivalents 1347 % we use for the index sort strings. 1348 % 1349 \indexnofonts 1350 \setupdatafile 1351 % We can have normal brace characters in the PDF outlines, unlike 1352 % Texinfo index files. So set that up. 1353 \def\{{\lbracecharliteral}% 1354 \def\}{\rbracecharliteral}% 1355 \catcode`\\=\active \otherbackslash 1356 \input \tocreadfilename 1357 \endgroup 1358 } 1359 {\catcode`[=1 \catcode`]=2 1360 \catcode`{=\other \catcode`}=\other 1361 \gdef\lbracecharliteral[{]% 1362 \gdef\rbracecharliteral[}]% 1363 ] 1364 % 1365 \def\skipspaces#1{\def\PP{#1}\def\D{|}% 1366 \ifx\PP\D\let\nextsp\relax 1367 \else\let\nextsp\skipspaces 1368 \addtokens{\filename}{\PP}% 1369 \advance\filenamelength by 1 1370 \fi 1371 \nextsp} 1372 \def\getfilename#1{% 1373 \filenamelength=0 1374 % If we don't expand the argument now, \skipspaces will get 1375 % snagged on things like "@value{foo}". 1376 \edef\temp{#1}% 1377 \expandafter\skipspaces\temp|\relax 1378 } 1379 \ifnum\pdftexversion < 14 1380 \let \startlink \pdfannotlink 1381 \else 1382 \let \startlink \pdfstartlink 1383 \fi 1384 % make a live url in pdf output. 1385 \def\pdfurl#1{% 1386 \begingroup 1387 % it seems we really need yet another set of dummies; have not 1388 % tried to figure out what each command should do in the context 1389 % of @url. for now, just make @/ a no-op, that's the only one 1390 % people have actually reported a problem with. 1391 % 1392 \normalturnoffactive 1393 \def\@{@}% 1394 \let\/=\empty 1395 \makevalueexpandable 1396 % do we want to go so far as to use \indexnofonts instead of just 1397 % special-casing \var here? 1398 \def\var##1{##1}% 1399 % 1400 \leavevmode\setcolor{\urlcolor}% 1401 \startlink attr{/Border [0 0 0]}% 1402 user{/Subtype /Link /A << /S /URI /URI (#1) >>}% 1403 \endgroup} 1404 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} 1405 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} 1406 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} 1407 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} 1408 \def\maketoks{% 1409 \expandafter\poptoks\the\toksA|ENDTOKS|\relax 1410 \ifx\first0\adn0 1411 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 1412 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 1413 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 1414 \else 1415 \ifnum0=\countA\else\makelink\fi 1416 \ifx\first.\let\next=\done\else 1417 \let\next=\maketoks 1418 \addtokens{\toksB}{\the\toksD} 1419 \ifx\first,\addtokens{\toksB}{\space}\fi 1420 \fi 1421 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 1422 \next} 1423 \def\makelink{\addtokens{\toksB}% 1424 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} 1425 \def\pdflink#1{% 1426 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} 1427 \setcolor{\linkcolor}#1\endlink} 1428 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} 1429\else 1430 % non-pdf mode 1431 \let\pdfmkdest = \gobble 1432 \let\pdfurl = \gobble 1433 \let\endlink = \relax 1434 \let\setcolor = \gobble 1435 \let\pdfsetcolor = \gobble 1436 \let\pdfmakeoutlines = \relax 1437\fi % \ifx\pdfoutput 1438 1439 1440\message{fonts,} 1441 1442% Change the current font style to #1, remembering it in \curfontstyle. 1443% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in 1444% italics, not bold italics. 1445% 1446\def\setfontstyle#1{% 1447 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. 1448 \csname ten#1\endcsname % change the current font 1449} 1450 1451% Select #1 fonts with the current style. 1452% 1453\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} 1454 1455\def\rm{\fam=0 \setfontstyle{rm}} 1456\def\it{\fam=\itfam \setfontstyle{it}} 1457\def\sl{\fam=\slfam \setfontstyle{sl}} 1458\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} 1459\def\tt{\fam=\ttfam \setfontstyle{tt}} 1460 1461% Unfortunately, we have to override this for titles and the like, since 1462% in those cases "rm" is bold. Sigh. 1463\def\rmisbold{\rm\def\curfontstyle{bf}} 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 1475% Set the baselineskip to #1, and the lineskip and strut size 1476% correspondingly. There is no deep meaning behind these magic numbers 1477% used as factors; they just match (closely enough) what Knuth defined. 1478% 1479\def\lineskipfactor{.08333} 1480\def\strutheightpercent{.70833} 1481\def\strutdepthpercent {.29167} 1482% 1483% can get a sort of poor man's double spacing by redefining this. 1484\def\baselinefactor{1} 1485% 1486\newdimen\textleading 1487\def\setleading#1{% 1488 \dimen0 = #1\relax 1489 \normalbaselineskip = \baselinefactor\dimen0 1490 \normallineskip = \lineskipfactor\normalbaselineskip 1491 \normalbaselines 1492 \setbox\strutbox =\hbox{% 1493 \vrule width0pt height\strutheightpercent\baselineskip 1494 depth \strutdepthpercent \baselineskip 1495 }% 1496} 1497 1498% PDF CMaps. See also LaTeX's t1.cmap. 1499% 1500% do nothing with this by default. 1501\expandafter\let\csname cmapOT1\endcsname\gobble 1502\expandafter\let\csname cmapOT1IT\endcsname\gobble 1503\expandafter\let\csname cmapOT1TT\endcsname\gobble 1504 1505% if we are producing pdf, and we have \pdffontattr, then define cmaps. 1506% (\pdffontattr was introduced many years ago, but people still run 1507% older pdftex's; it's easy to conditionalize, so we do.) 1508\ifpdf \ifx\pdffontattr\thisisundefined \else 1509 \begingroup 1510 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. 1511 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap 1512%%DocumentNeededResources: ProcSet (CIDInit) 1513%%IncludeResource: ProcSet (CIDInit) 1514%%BeginResource: CMap (TeX-OT1-0) 1515%%Title: (TeX-OT1-0 TeX OT1 0) 1516%%Version: 1.000 1517%%EndComments 1518/CIDInit /ProcSet findresource begin 151912 dict begin 1520begincmap 1521/CIDSystemInfo 1522<< /Registry (TeX) 1523/Ordering (OT1) 1524/Supplement 0 1525>> def 1526/CMapName /TeX-OT1-0 def 1527/CMapType 2 def 15281 begincodespacerange 1529<00> <7F> 1530endcodespacerange 15318 beginbfrange 1532<00> <01> <0393> 1533<09> <0A> <03A8> 1534<23> <26> <0023> 1535<28> <3B> <0028> 1536<3F> <5B> <003F> 1537<5D> <5E> <005D> 1538<61> <7A> <0061> 1539<7B> <7C> <2013> 1540endbfrange 154140 beginbfchar 1542<02> <0398> 1543<03> <039B> 1544<04> <039E> 1545<05> <03A0> 1546<06> <03A3> 1547<07> <03D2> 1548<08> <03A6> 1549<0B> <00660066> 1550<0C> <00660069> 1551<0D> <0066006C> 1552<0E> <006600660069> 1553<0F> <00660066006C> 1554<10> <0131> 1555<11> <0237> 1556<12> <0060> 1557<13> <00B4> 1558<14> <02C7> 1559<15> <02D8> 1560<16> <00AF> 1561<17> <02DA> 1562<18> <00B8> 1563<19> <00DF> 1564<1A> <00E6> 1565<1B> <0153> 1566<1C> <00F8> 1567<1D> <00C6> 1568<1E> <0152> 1569<1F> <00D8> 1570<21> <0021> 1571<22> <201D> 1572<27> <2019> 1573<3C> <00A1> 1574<3D> <003D> 1575<3E> <00BF> 1576<5C> <201C> 1577<5F> <02D9> 1578<60> <2018> 1579<7D> <02DD> 1580<7E> <007E> 1581<7F> <00A8> 1582endbfchar 1583endcmap 1584CMapName currentdict /CMap defineresource pop 1585end 1586end 1587%%EndResource 1588%%EOF 1589 }\endgroup 1590 \expandafter\edef\csname cmapOT1\endcsname#1{% 1591 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% 1592 }% 1593% 1594% \cmapOT1IT 1595 \begingroup 1596 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. 1597 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap 1598%%DocumentNeededResources: ProcSet (CIDInit) 1599%%IncludeResource: ProcSet (CIDInit) 1600%%BeginResource: CMap (TeX-OT1IT-0) 1601%%Title: (TeX-OT1IT-0 TeX OT1IT 0) 1602%%Version: 1.000 1603%%EndComments 1604/CIDInit /ProcSet findresource begin 160512 dict begin 1606begincmap 1607/CIDSystemInfo 1608<< /Registry (TeX) 1609/Ordering (OT1IT) 1610/Supplement 0 1611>> def 1612/CMapName /TeX-OT1IT-0 def 1613/CMapType 2 def 16141 begincodespacerange 1615<00> <7F> 1616endcodespacerange 16178 beginbfrange 1618<00> <01> <0393> 1619<09> <0A> <03A8> 1620<25> <26> <0025> 1621<28> <3B> <0028> 1622<3F> <5B> <003F> 1623<5D> <5E> <005D> 1624<61> <7A> <0061> 1625<7B> <7C> <2013> 1626endbfrange 162742 beginbfchar 1628<02> <0398> 1629<03> <039B> 1630<04> <039E> 1631<05> <03A0> 1632<06> <03A3> 1633<07> <03D2> 1634<08> <03A6> 1635<0B> <00660066> 1636<0C> <00660069> 1637<0D> <0066006C> 1638<0E> <006600660069> 1639<0F> <00660066006C> 1640<10> <0131> 1641<11> <0237> 1642<12> <0060> 1643<13> <00B4> 1644<14> <02C7> 1645<15> <02D8> 1646<16> <00AF> 1647<17> <02DA> 1648<18> <00B8> 1649<19> <00DF> 1650<1A> <00E6> 1651<1B> <0153> 1652<1C> <00F8> 1653<1D> <00C6> 1654<1E> <0152> 1655<1F> <00D8> 1656<21> <0021> 1657<22> <201D> 1658<23> <0023> 1659<24> <00A3> 1660<27> <2019> 1661<3C> <00A1> 1662<3D> <003D> 1663<3E> <00BF> 1664<5C> <201C> 1665<5F> <02D9> 1666<60> <2018> 1667<7D> <02DD> 1668<7E> <007E> 1669<7F> <00A8> 1670endbfchar 1671endcmap 1672CMapName currentdict /CMap defineresource pop 1673end 1674end 1675%%EndResource 1676%%EOF 1677 }\endgroup 1678 \expandafter\edef\csname cmapOT1IT\endcsname#1{% 1679 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% 1680 }% 1681% 1682% \cmapOT1TT 1683 \begingroup 1684 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. 1685 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap 1686%%DocumentNeededResources: ProcSet (CIDInit) 1687%%IncludeResource: ProcSet (CIDInit) 1688%%BeginResource: CMap (TeX-OT1TT-0) 1689%%Title: (TeX-OT1TT-0 TeX OT1TT 0) 1690%%Version: 1.000 1691%%EndComments 1692/CIDInit /ProcSet findresource begin 169312 dict begin 1694begincmap 1695/CIDSystemInfo 1696<< /Registry (TeX) 1697/Ordering (OT1TT) 1698/Supplement 0 1699>> def 1700/CMapName /TeX-OT1TT-0 def 1701/CMapType 2 def 17021 begincodespacerange 1703<00> <7F> 1704endcodespacerange 17055 beginbfrange 1706<00> <01> <0393> 1707<09> <0A> <03A8> 1708<21> <26> <0021> 1709<28> <5F> <0028> 1710<61> <7E> <0061> 1711endbfrange 171232 beginbfchar 1713<02> <0398> 1714<03> <039B> 1715<04> <039E> 1716<05> <03A0> 1717<06> <03A3> 1718<07> <03D2> 1719<08> <03A6> 1720<0B> <2191> 1721<0C> <2193> 1722<0D> <0027> 1723<0E> <00A1> 1724<0F> <00BF> 1725<10> <0131> 1726<11> <0237> 1727<12> <0060> 1728<13> <00B4> 1729<14> <02C7> 1730<15> <02D8> 1731<16> <00AF> 1732<17> <02DA> 1733<18> <00B8> 1734<19> <00DF> 1735<1A> <00E6> 1736<1B> <0153> 1737<1C> <00F8> 1738<1D> <00C6> 1739<1E> <0152> 1740<1F> <00D8> 1741<20> <2423> 1742<27> <2019> 1743<60> <2018> 1744<7F> <00A8> 1745endbfchar 1746endcmap 1747CMapName currentdict /CMap defineresource pop 1748end 1749end 1750%%EndResource 1751%%EOF 1752 }\endgroup 1753 \expandafter\edef\csname cmapOT1TT\endcsname#1{% 1754 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% 1755 }% 1756\fi\fi 1757 1758 1759% Set the font macro #1 to the font named \fontprefix#2. 1760% #3 is the font's design size, #4 is a scale factor, #5 is the CMap 1761% encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit). 1762% Example: 1763% #1 = \textrm 1764% #2 = \rmshape 1765% #3 = 10 1766% #4 = \mainmagstep 1767% #5 = OT1 1768% 1769\def\setfont#1#2#3#4#5{% 1770 \font#1=\fontprefix#2#3 scaled #4 1771 \csname cmap#5\endcsname#1% 1772} 1773% This is what gets called when #5 of \setfont is empty. 1774\let\cmap\gobble 1775% 1776% (end of cmaps) 1777 1778% Use cm as the default font prefix. 1779% To specify the font prefix, you must define \fontprefix 1780% before you read in texinfo.tex. 1781\ifx\fontprefix\thisisundefined 1782\def\fontprefix{cm} 1783\fi 1784% Support font families that don't use the same naming scheme as CM. 1785\def\rmshape{r} 1786\def\rmbshape{bx} % where the normal face is bold 1787\def\bfshape{b} 1788\def\bxshape{bx} 1789\def\ttshape{tt} 1790\def\ttbshape{tt} 1791\def\ttslshape{sltt} 1792\def\itshape{ti} 1793\def\itbshape{bxti} 1794\def\slshape{sl} 1795\def\slbshape{bxsl} 1796\def\sfshape{ss} 1797\def\sfbshape{ss} 1798\def\scshape{csc} 1799\def\scbshape{csc} 1800 1801% Definitions for a main text size of 11pt. (The default in Texinfo.) 1802% 1803\def\definetextfontsizexi{% 1804% Text fonts (11.2pt, magstep1). 1805\def\textnominalsize{11pt} 1806\edef\mainmagstep{\magstephalf} 1807\setfont\textrm\rmshape{10}{\mainmagstep}{OT1} 1808\setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT} 1809\setfont\textbf\bfshape{10}{\mainmagstep}{OT1} 1810\setfont\textit\itshape{10}{\mainmagstep}{OT1IT} 1811\setfont\textsl\slshape{10}{\mainmagstep}{OT1} 1812\setfont\textsf\sfshape{10}{\mainmagstep}{OT1} 1813\setfont\textsc\scshape{10}{\mainmagstep}{OT1} 1814\setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT} 1815\font\texti=cmmi10 scaled \mainmagstep 1816\font\textsy=cmsy10 scaled \mainmagstep 1817\def\textecsize{1095} 1818 1819% A few fonts for @defun names and args. 1820\setfont\defbf\bfshape{10}{\magstep1}{OT1} 1821\setfont\deftt\ttshape{10}{\magstep1}{OT1TT} 1822\setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT} 1823\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} 1824 1825% Fonts for indices, footnotes, small examples (9pt). 1826\def\smallnominalsize{9pt} 1827\setfont\smallrm\rmshape{9}{1000}{OT1} 1828\setfont\smalltt\ttshape{9}{1000}{OT1TT} 1829\setfont\smallbf\bfshape{10}{900}{OT1} 1830\setfont\smallit\itshape{9}{1000}{OT1IT} 1831\setfont\smallsl\slshape{9}{1000}{OT1} 1832\setfont\smallsf\sfshape{9}{1000}{OT1} 1833\setfont\smallsc\scshape{10}{900}{OT1} 1834\setfont\smallttsl\ttslshape{10}{900}{OT1TT} 1835\font\smalli=cmmi9 1836\font\smallsy=cmsy9 1837\def\smallecsize{0900} 1838 1839% Fonts for small examples (8pt). 1840\def\smallernominalsize{8pt} 1841\setfont\smallerrm\rmshape{8}{1000}{OT1} 1842\setfont\smallertt\ttshape{8}{1000}{OT1TT} 1843\setfont\smallerbf\bfshape{10}{800}{OT1} 1844\setfont\smallerit\itshape{8}{1000}{OT1IT} 1845\setfont\smallersl\slshape{8}{1000}{OT1} 1846\setfont\smallersf\sfshape{8}{1000}{OT1} 1847\setfont\smallersc\scshape{10}{800}{OT1} 1848\setfont\smallerttsl\ttslshape{10}{800}{OT1TT} 1849\font\smalleri=cmmi8 1850\font\smallersy=cmsy8 1851\def\smallerecsize{0800} 1852 1853% Fonts for title page (20.4pt): 1854\def\titlenominalsize{20pt} 1855\setfont\titlerm\rmbshape{12}{\magstep3}{OT1} 1856\setfont\titleit\itbshape{10}{\magstep4}{OT1IT} 1857\setfont\titlesl\slbshape{10}{\magstep4}{OT1} 1858\setfont\titlett\ttbshape{12}{\magstep3}{OT1TT} 1859\setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT} 1860\setfont\titlesf\sfbshape{17}{\magstep1}{OT1} 1861\let\titlebf=\titlerm 1862\setfont\titlesc\scbshape{10}{\magstep4}{OT1} 1863\font\titlei=cmmi12 scaled \magstep3 1864\font\titlesy=cmsy10 scaled \magstep4 1865\def\titleecsize{2074} 1866 1867% Chapter (and unnumbered) fonts (17.28pt). 1868\def\chapnominalsize{17pt} 1869\setfont\chaprm\rmbshape{12}{\magstep2}{OT1} 1870\setfont\chapit\itbshape{10}{\magstep3}{OT1IT} 1871\setfont\chapsl\slbshape{10}{\magstep3}{OT1} 1872\setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT} 1873\setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT} 1874\setfont\chapsf\sfbshape{17}{1000}{OT1} 1875\let\chapbf=\chaprm 1876\setfont\chapsc\scbshape{10}{\magstep3}{OT1} 1877\font\chapi=cmmi12 scaled \magstep2 1878\font\chapsy=cmsy10 scaled \magstep3 1879\def\chapecsize{1728} 1880 1881% Section fonts (14.4pt). 1882\def\secnominalsize{14pt} 1883\setfont\secrm\rmbshape{12}{\magstep1}{OT1} 1884\setfont\secit\itbshape{10}{\magstep2}{OT1IT} 1885\setfont\secsl\slbshape{10}{\magstep2}{OT1} 1886\setfont\sectt\ttbshape{12}{\magstep1}{OT1TT} 1887\setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT} 1888\setfont\secsf\sfbshape{12}{\magstep1}{OT1} 1889\let\secbf\secrm 1890\setfont\secsc\scbshape{10}{\magstep2}{OT1} 1891\font\seci=cmmi12 scaled \magstep1 1892\font\secsy=cmsy10 scaled \magstep2 1893\def\sececsize{1440} 1894 1895% Subsection fonts (13.15pt). 1896\def\ssecnominalsize{13pt} 1897\setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1} 1898\setfont\ssecit\itbshape{10}{1315}{OT1IT} 1899\setfont\ssecsl\slbshape{10}{1315}{OT1} 1900\setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT} 1901\setfont\ssecttsl\ttslshape{10}{1315}{OT1TT} 1902\setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1} 1903\let\ssecbf\ssecrm 1904\setfont\ssecsc\scbshape{10}{1315}{OT1} 1905\font\sseci=cmmi12 scaled \magstephalf 1906\font\ssecsy=cmsy10 scaled 1315 1907\def\ssececsize{1200} 1908 1909% Reduced fonts for @acro in text (10pt). 1910\def\reducednominalsize{10pt} 1911\setfont\reducedrm\rmshape{10}{1000}{OT1} 1912\setfont\reducedtt\ttshape{10}{1000}{OT1TT} 1913\setfont\reducedbf\bfshape{10}{1000}{OT1} 1914\setfont\reducedit\itshape{10}{1000}{OT1IT} 1915\setfont\reducedsl\slshape{10}{1000}{OT1} 1916\setfont\reducedsf\sfshape{10}{1000}{OT1} 1917\setfont\reducedsc\scshape{10}{1000}{OT1} 1918\setfont\reducedttsl\ttslshape{10}{1000}{OT1TT} 1919\font\reducedi=cmmi10 1920\font\reducedsy=cmsy10 1921\def\reducedecsize{1000} 1922 1923\textleading = 13.2pt % line spacing for 11pt CM 1924\textfonts % reset the current fonts 1925\rm 1926} % end of 11pt text font size definitions, \definetextfontsizexi 1927 1928 1929% Definitions to make the main text be 10pt Computer Modern, with 1930% section, chapter, etc., sizes following suit. This is for the GNU 1931% Press printing of the Emacs 22 manual. Maybe other manuals in the 1932% future. Used with @smallbook, which sets the leading to 12pt. 1933% 1934\def\definetextfontsizex{% 1935% Text fonts (10pt). 1936\def\textnominalsize{10pt} 1937\edef\mainmagstep{1000} 1938\setfont\textrm\rmshape{10}{\mainmagstep}{OT1} 1939\setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT} 1940\setfont\textbf\bfshape{10}{\mainmagstep}{OT1} 1941\setfont\textit\itshape{10}{\mainmagstep}{OT1IT} 1942\setfont\textsl\slshape{10}{\mainmagstep}{OT1} 1943\setfont\textsf\sfshape{10}{\mainmagstep}{OT1} 1944\setfont\textsc\scshape{10}{\mainmagstep}{OT1} 1945\setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT} 1946\font\texti=cmmi10 scaled \mainmagstep 1947\font\textsy=cmsy10 scaled \mainmagstep 1948\def\textecsize{1000} 1949 1950% A few fonts for @defun names and args. 1951\setfont\defbf\bfshape{10}{\magstephalf}{OT1} 1952\setfont\deftt\ttshape{10}{\magstephalf}{OT1TT} 1953\setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT} 1954\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} 1955 1956% Fonts for indices, footnotes, small examples (9pt). 1957\def\smallnominalsize{9pt} 1958\setfont\smallrm\rmshape{9}{1000}{OT1} 1959\setfont\smalltt\ttshape{9}{1000}{OT1TT} 1960\setfont\smallbf\bfshape{10}{900}{OT1} 1961\setfont\smallit\itshape{9}{1000}{OT1IT} 1962\setfont\smallsl\slshape{9}{1000}{OT1} 1963\setfont\smallsf\sfshape{9}{1000}{OT1} 1964\setfont\smallsc\scshape{10}{900}{OT1} 1965\setfont\smallttsl\ttslshape{10}{900}{OT1TT} 1966\font\smalli=cmmi9 1967\font\smallsy=cmsy9 1968\def\smallecsize{0900} 1969 1970% Fonts for small examples (8pt). 1971\def\smallernominalsize{8pt} 1972\setfont\smallerrm\rmshape{8}{1000}{OT1} 1973\setfont\smallertt\ttshape{8}{1000}{OT1TT} 1974\setfont\smallerbf\bfshape{10}{800}{OT1} 1975\setfont\smallerit\itshape{8}{1000}{OT1IT} 1976\setfont\smallersl\slshape{8}{1000}{OT1} 1977\setfont\smallersf\sfshape{8}{1000}{OT1} 1978\setfont\smallersc\scshape{10}{800}{OT1} 1979\setfont\smallerttsl\ttslshape{10}{800}{OT1TT} 1980\font\smalleri=cmmi8 1981\font\smallersy=cmsy8 1982\def\smallerecsize{0800} 1983 1984% Fonts for title page (20.4pt): 1985\def\titlenominalsize{20pt} 1986\setfont\titlerm\rmbshape{12}{\magstep3}{OT1} 1987\setfont\titleit\itbshape{10}{\magstep4}{OT1IT} 1988\setfont\titlesl\slbshape{10}{\magstep4}{OT1} 1989\setfont\titlett\ttbshape{12}{\magstep3}{OT1TT} 1990\setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT} 1991\setfont\titlesf\sfbshape{17}{\magstep1}{OT1} 1992\let\titlebf=\titlerm 1993\setfont\titlesc\scbshape{10}{\magstep4}{OT1} 1994\font\titlei=cmmi12 scaled \magstep3 1995\font\titlesy=cmsy10 scaled \magstep4 1996\def\titleecsize{2074} 1997 1998% Chapter fonts (14.4pt). 1999\def\chapnominalsize{14pt} 2000\setfont\chaprm\rmbshape{12}{\magstep1}{OT1} 2001\setfont\chapit\itbshape{10}{\magstep2}{OT1IT} 2002\setfont\chapsl\slbshape{10}{\magstep2}{OT1} 2003\setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT} 2004\setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT} 2005\setfont\chapsf\sfbshape{12}{\magstep1}{OT1} 2006\let\chapbf\chaprm 2007\setfont\chapsc\scbshape{10}{\magstep2}{OT1} 2008\font\chapi=cmmi12 scaled \magstep1 2009\font\chapsy=cmsy10 scaled \magstep2 2010\def\chapecsize{1440} 2011 2012% Section fonts (12pt). 2013\def\secnominalsize{12pt} 2014\setfont\secrm\rmbshape{12}{1000}{OT1} 2015\setfont\secit\itbshape{10}{\magstep1}{OT1IT} 2016\setfont\secsl\slbshape{10}{\magstep1}{OT1} 2017\setfont\sectt\ttbshape{12}{1000}{OT1TT} 2018\setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT} 2019\setfont\secsf\sfbshape{12}{1000}{OT1} 2020\let\secbf\secrm 2021\setfont\secsc\scbshape{10}{\magstep1}{OT1} 2022\font\seci=cmmi12 2023\font\secsy=cmsy10 scaled \magstep1 2024\def\sececsize{1200} 2025 2026% Subsection fonts (10pt). 2027\def\ssecnominalsize{10pt} 2028\setfont\ssecrm\rmbshape{10}{1000}{OT1} 2029\setfont\ssecit\itbshape{10}{1000}{OT1IT} 2030\setfont\ssecsl\slbshape{10}{1000}{OT1} 2031\setfont\ssectt\ttbshape{10}{1000}{OT1TT} 2032\setfont\ssecttsl\ttslshape{10}{1000}{OT1TT} 2033\setfont\ssecsf\sfbshape{10}{1000}{OT1} 2034\let\ssecbf\ssecrm 2035\setfont\ssecsc\scbshape{10}{1000}{OT1} 2036\font\sseci=cmmi10 2037\font\ssecsy=cmsy10 2038\def\ssececsize{1000} 2039 2040% Reduced fonts for @acro in text (9pt). 2041\def\reducednominalsize{9pt} 2042\setfont\reducedrm\rmshape{9}{1000}{OT1} 2043\setfont\reducedtt\ttshape{9}{1000}{OT1TT} 2044\setfont\reducedbf\bfshape{10}{900}{OT1} 2045\setfont\reducedit\itshape{9}{1000}{OT1IT} 2046\setfont\reducedsl\slshape{9}{1000}{OT1} 2047\setfont\reducedsf\sfshape{9}{1000}{OT1} 2048\setfont\reducedsc\scshape{10}{900}{OT1} 2049\setfont\reducedttsl\ttslshape{10}{900}{OT1TT} 2050\font\reducedi=cmmi9 2051\font\reducedsy=cmsy9 2052\def\reducedecsize{0900} 2053 2054\divide\parskip by 2 % reduce space between paragraphs 2055\textleading = 12pt % line spacing for 10pt CM 2056\textfonts % reset the current fonts 2057\rm 2058} % end of 10pt text font size definitions, \definetextfontsizex 2059 2060 2061% We provide the user-level command 2062% @fonttextsize 10 2063% (or 11) to redefine the text font size. pt is assumed. 2064% 2065\def\xiword{11} 2066\def\xword{10} 2067\def\xwordpt{10pt} 2068% 2069\parseargdef\fonttextsize{% 2070 \def\textsizearg{#1}% 2071 %\wlog{doing @fonttextsize \textsizearg}% 2072 % 2073 % Set \globaldefs so that documents can use this inside @tex, since 2074 % makeinfo 4.8 does not support it, but we need it nonetheless. 2075 % 2076 \begingroup \globaldefs=1 2077 \ifx\textsizearg\xword \definetextfontsizex 2078 \else \ifx\textsizearg\xiword \definetextfontsizexi 2079 \else 2080 \errhelp=\EMsimple 2081 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'} 2082 \fi\fi 2083 \endgroup 2084} 2085 2086% In order for the font changes to affect most math symbols and letters, 2087% we have to define the \textfont of the standard families. We don't 2088% bother to reset \scriptfont and \scriptscriptfont; awaiting user need. 2089% 2090\def\resetmathfonts{% 2091 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy 2092 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf 2093 \textfont\ttfam=\tentt \textfont\sffam=\tensf 2094} 2095 2096% The font-changing commands redefine the meanings of \tenSTYLE, instead 2097% of just \STYLE. We do this because \STYLE needs to also set the 2098% current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire 2099% \tenSTYLE to set the current font. 2100% 2101% Each font-changing command also sets the names \lsize (one size lower) 2102% and \lllsize (three sizes lower). These relative commands are used 2103% in, e.g., the LaTeX logo and acronyms. 2104% 2105% This all needs generalizing, badly. 2106% 2107\def\textfonts{% 2108 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl 2109 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc 2110 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy 2111 \let\tenttsl=\textttsl 2112 \def\curfontsize{text}% 2113 \def\lsize{reduced}\def\lllsize{smaller}% 2114 \resetmathfonts \setleading{\textleading}} 2115\def\titlefonts{% 2116 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl 2117 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc 2118 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy 2119 \let\tenttsl=\titlettsl 2120 \def\curfontsize{title}% 2121 \def\lsize{chap}\def\lllsize{subsec}% 2122 \resetmathfonts \setleading{27pt}} 2123\def\titlefont#1{{\titlefonts\rmisbold #1}} 2124\def\chapfonts{% 2125 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl 2126 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc 2127 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy 2128 \let\tenttsl=\chapttsl 2129 \def\curfontsize{chap}% 2130 \def\lsize{sec}\def\lllsize{text}% 2131 \resetmathfonts \setleading{19pt}} 2132\def\secfonts{% 2133 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl 2134 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc 2135 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy 2136 \let\tenttsl=\secttsl 2137 \def\curfontsize{sec}% 2138 \def\lsize{subsec}\def\lllsize{reduced}% 2139 \resetmathfonts \setleading{17pt}} 2140\def\subsecfonts{% 2141 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl 2142 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc 2143 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy 2144 \let\tenttsl=\ssecttsl 2145 \def\curfontsize{ssec}% 2146 \def\lsize{text}\def\lllsize{small}% 2147 \resetmathfonts \setleading{15pt}} 2148\let\subsubsecfonts = \subsecfonts 2149\def\reducedfonts{% 2150 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl 2151 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc 2152 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy 2153 \let\tenttsl=\reducedttsl 2154 \def\curfontsize{reduced}% 2155 \def\lsize{small}\def\lllsize{smaller}% 2156 \resetmathfonts \setleading{10.5pt}} 2157\def\smallfonts{% 2158 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl 2159 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc 2160 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy 2161 \let\tenttsl=\smallttsl 2162 \def\curfontsize{small}% 2163 \def\lsize{smaller}\def\lllsize{smaller}% 2164 \resetmathfonts \setleading{10.5pt}} 2165\def\smallerfonts{% 2166 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl 2167 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc 2168 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy 2169 \let\tenttsl=\smallerttsl 2170 \def\curfontsize{smaller}% 2171 \def\lsize{smaller}\def\lllsize{smaller}% 2172 \resetmathfonts \setleading{9.5pt}} 2173 2174% Fonts for short table of contents. 2175\setfont\shortcontrm\rmshape{12}{1000}{OT1} 2176\setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12 2177\setfont\shortcontsl\slshape{12}{1000}{OT1} 2178\setfont\shortconttt\ttshape{12}{1000}{OT1TT} 2179 2180% Define these just so they can be easily changed for other fonts. 2181\def\angleleft{$\langle$} 2182\def\angleright{$\rangle$} 2183 2184% Set the fonts to use with the @small... environments. 2185\let\smallexamplefonts = \smallfonts 2186 2187% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample 2188% can fit this many characters: 2189% 8.5x11=86 smallbook=72 a4=90 a5=69 2190% If we use \scriptfonts (8pt), then we can fit this many characters: 2191% 8.5x11=90+ smallbook=80 a4=90+ a5=77 2192% For me, subjectively, the few extra characters that fit aren't worth 2193% the additional smallness of 8pt. So I'm making the default 9pt. 2194% 2195% By the way, for comparison, here's what fits with @example (10pt): 2196% 8.5x11=71 smallbook=60 a4=75 a5=58 2197% --karl, 24jan03. 2198 2199% Set up the default fonts, so we can use them for creating boxes. 2200% 2201\definetextfontsizexi 2202 2203 2204\message{markup,} 2205 2206% Check if we are currently using a typewriter font. Since all the 2207% Computer Modern typewriter fonts have zero interword stretch (and 2208% shrink), and it is reasonable to expect all typewriter fonts to have 2209% this property, we can check that font parameter. 2210% 2211\def\ifmonospace{\ifdim\fontdimen3\font=0pt } 2212 2213% Markup style infrastructure. \defmarkupstylesetup\INITMACRO will 2214% define and register \INITMACRO to be called on markup style changes. 2215% \INITMACRO can check \currentmarkupstyle for the innermost 2216% style and the set of \ifmarkupSTYLE switches for all styles 2217% currently in effect. 2218\newif\ifmarkupvar 2219\newif\ifmarkupsamp 2220\newif\ifmarkupkey 2221%\newif\ifmarkupfile % @file == @samp. 2222%\newif\ifmarkupoption % @option == @samp. 2223\newif\ifmarkupcode 2224\newif\ifmarkupkbd 2225%\newif\ifmarkupenv % @env == @code. 2226%\newif\ifmarkupcommand % @command == @code. 2227\newif\ifmarkuptex % @tex (and part of @math, for now). 2228\newif\ifmarkupexample 2229\newif\ifmarkupverb 2230\newif\ifmarkupverbatim 2231 2232\let\currentmarkupstyle\empty 2233 2234\def\setupmarkupstyle#1{% 2235 \csname markup#1true\endcsname 2236 \def\currentmarkupstyle{#1}% 2237 \markupstylesetup 2238} 2239 2240\let\markupstylesetup\empty 2241 2242\def\defmarkupstylesetup#1{% 2243 \expandafter\def\expandafter\markupstylesetup 2244 \expandafter{\markupstylesetup #1}% 2245 \def#1% 2246} 2247 2248% Markup style setup for left and right quotes. 2249\defmarkupstylesetup\markupsetuplq{% 2250 \expandafter\let\expandafter \temp 2251 \csname markupsetuplq\currentmarkupstyle\endcsname 2252 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi 2253} 2254 2255\defmarkupstylesetup\markupsetuprq{% 2256 \expandafter\let\expandafter \temp 2257 \csname markupsetuprq\currentmarkupstyle\endcsname 2258 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi 2259} 2260 2261{ 2262\catcode`\'=\active 2263\catcode`\`=\active 2264 2265\gdef\markupsetuplqdefault{\let`\lq} 2266\gdef\markupsetuprqdefault{\let'\rq} 2267 2268\gdef\markupsetcodequoteleft{\let`\codequoteleft} 2269\gdef\markupsetcodequoteright{\let'\codequoteright} 2270} 2271 2272\let\markupsetuplqcode \markupsetcodequoteleft 2273\let\markupsetuprqcode \markupsetcodequoteright 2274% 2275\let\markupsetuplqexample \markupsetcodequoteleft 2276\let\markupsetuprqexample \markupsetcodequoteright 2277% 2278\let\markupsetuplqkbd \markupsetcodequoteleft 2279\let\markupsetuprqkbd \markupsetcodequoteright 2280% 2281\let\markupsetuplqsamp \markupsetcodequoteleft 2282\let\markupsetuprqsamp \markupsetcodequoteright 2283% 2284\let\markupsetuplqverb \markupsetcodequoteleft 2285\let\markupsetuprqverb \markupsetcodequoteright 2286% 2287\let\markupsetuplqverbatim \markupsetcodequoteleft 2288\let\markupsetuprqverbatim \markupsetcodequoteright 2289 2290% Allow an option to not use regular directed right quote/apostrophe 2291% (char 0x27), but instead the undirected quote from cmtt (char 0x0d). 2292% The undirected quote is ugly, so don't make it the default, but it 2293% works for pasting with more pdf viewers (at least evince), the 2294% lilypond developers report. xpdf does work with the regular 0x27. 2295% 2296\def\codequoteright{% 2297 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax 2298 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax 2299 '% 2300 \else \char'15 \fi 2301 \else \char'15 \fi 2302} 2303% 2304% and a similar option for the left quote char vs. a grave accent. 2305% Modern fonts display ASCII 0x60 as a grave accent, so some people like 2306% the code environments to do likewise. 2307% 2308\def\codequoteleft{% 2309 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax 2310 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax 2311 % [Knuth] pp. 380,381,391 2312 % \relax disables Spanish ligatures ?` and !` of \tt font. 2313 \relax`% 2314 \else \char'22 \fi 2315 \else \char'22 \fi 2316} 2317 2318% Commands to set the quote options. 2319% 2320\parseargdef\codequoteundirected{% 2321 \def\temp{#1}% 2322 \ifx\temp\onword 2323 \expandafter\let\csname SETtxicodequoteundirected\endcsname 2324 = t% 2325 \else\ifx\temp\offword 2326 \expandafter\let\csname SETtxicodequoteundirected\endcsname 2327 = \relax 2328 \else 2329 \errhelp = \EMsimple 2330 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}% 2331 \fi\fi 2332} 2333% 2334\parseargdef\codequotebacktick{% 2335 \def\temp{#1}% 2336 \ifx\temp\onword 2337 \expandafter\let\csname SETtxicodequotebacktick\endcsname 2338 = t% 2339 \else\ifx\temp\offword 2340 \expandafter\let\csname SETtxicodequotebacktick\endcsname 2341 = \relax 2342 \else 2343 \errhelp = \EMsimple 2344 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}% 2345 \fi\fi 2346} 2347 2348% [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font. 2349\def\noligaturesquoteleft{\relax\lq} 2350 2351% Count depth in font-changes, for error checks 2352\newcount\fontdepth \fontdepth=0 2353 2354% Font commands. 2355 2356% #1 is the font command (\sl or \it), #2 is the text to slant. 2357% If we are in a monospaced environment, however, 1) always use \ttsl, 2358% and 2) do not add an italic correction. 2359\def\dosmartslant#1#2{% 2360 \ifusingtt 2361 {{\ttsl #2}\let\next=\relax}% 2362 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}% 2363 \next 2364} 2365\def\smartslanted{\dosmartslant\sl} 2366\def\smartitalic{\dosmartslant\it} 2367 2368% Output an italic correction unless \next (presumed to be the following 2369% character) is such as not to need one. 2370\def\smartitaliccorrection{% 2371 \ifx\next,% 2372 \else\ifx\next-% 2373 \else\ifx\next.% 2374 \else\ifx\next\.% 2375 \else\ifx\next\comma% 2376 \else\ptexslash 2377 \fi\fi\fi\fi\fi 2378 \aftersmartic 2379} 2380 2381% Unconditional use \ttsl, and no ic. @var is set to this for defuns. 2382\def\ttslanted#1{{\ttsl #1}} 2383 2384% @cite is like \smartslanted except unconditionally use \sl. We never want 2385% ttsl for book titles, do we? 2386\def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection} 2387 2388\def\aftersmartic{} 2389\def\var#1{% 2390 \let\saveaftersmartic = \aftersmartic 2391 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}% 2392 \smartslanted{#1}% 2393} 2394 2395\let\i=\smartitalic 2396\let\slanted=\smartslanted 2397\let\dfn=\smartslanted 2398\let\emph=\smartitalic 2399 2400% Explicit font changes: @r, @sc, undocumented @ii. 2401\def\r#1{{\rm #1}} % roman font 2402\def\sc#1{{\smallcaps#1}} % smallcaps font 2403\def\ii#1{{\it #1}} % italic font 2404 2405% @b, explicit bold. Also @strong. 2406\def\b#1{{\bf #1}} 2407\let\strong=\b 2408 2409% @sansserif, explicit sans. 2410\def\sansserif#1{{\sf #1}} 2411 2412% We can't just use \exhyphenpenalty, because that only has effect at 2413% the end of a paragraph. Restore normal hyphenation at the end of the 2414% group within which \nohyphenation is presumably called. 2415% 2416\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} 2417\def\restorehyphenation{\hyphenchar\font = `- } 2418 2419% Set sfcode to normal for the chars that usually have another value. 2420% Can't use plain's \frenchspacing because it uses the `\x notation, and 2421% sometimes \x has an active definition that messes things up. 2422% 2423\catcode`@=11 2424 \def\plainfrenchspacing{% 2425 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m 2426 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m 2427 \def\endofsentencespacefactor{1000}% for @. and friends 2428 } 2429 \def\plainnonfrenchspacing{% 2430 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000 2431 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250 2432 \def\endofsentencespacefactor{3000}% for @. and friends 2433 } 2434\catcode`@=\other 2435\def\endofsentencespacefactor{3000}% default 2436 2437% @t, explicit typewriter. 2438\def\t#1{% 2439 {\tt \rawbackslash \plainfrenchspacing #1}% 2440 \null 2441} 2442 2443% @samp. 2444\def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}} 2445 2446% @indicateurl is \samp, that is, with quotes. 2447\let\indicateurl=\samp 2448 2449% @code (and similar) prints in typewriter, but with spaces the same 2450% size as normal in the surrounding text, without hyphenation, etc. 2451% This is a subroutine for that. 2452\def\tclose#1{% 2453 {% 2454 % Change normal interword space to be same as for the current font. 2455 \spaceskip = \fontdimen2\font 2456 % 2457 % Switch to typewriter. 2458 \tt 2459 % 2460 % But `\ ' produces the large typewriter interword space. 2461 \def\ {{\spaceskip = 0pt{} }}% 2462 % 2463 % Turn off hyphenation. 2464 \nohyphenation 2465 % 2466 \rawbackslash 2467 \plainfrenchspacing 2468 #1% 2469 }% 2470 \null % reset spacefactor to 1000 2471} 2472 2473% We *must* turn on hyphenation at `-' and `_' in @code. 2474% (But see \codedashfinish below.) 2475% Otherwise, it is too hard to avoid overfull hboxes 2476% in the Emacs manual, the Library manual, etc. 2477% 2478% Unfortunately, TeX uses one parameter (\hyphenchar) to control 2479% both hyphenation at - and hyphenation within words. 2480% We must therefore turn them both off (\tclose does that) 2481% and arrange explicitly to hyphenate at a dash. -- rms. 2482{ 2483 \catcode`\-=\active \catcode`\_=\active 2484 \catcode`\'=\active \catcode`\`=\active 2485 \global\let'=\rq \global\let`=\lq % default definitions 2486 % 2487 \global\def\code{\begingroup 2488 \setupmarkupstyle{code}% 2489 % The following should really be moved into \setupmarkupstyle handlers. 2490 \catcode\dashChar=\active \catcode\underChar=\active 2491 \ifallowcodebreaks 2492 \let-\codedash 2493 \let_\codeunder 2494 \else 2495 \let-\normaldash 2496 \let_\realunder 2497 \fi 2498 % Given -foo (with a single dash), we do not want to allow a break 2499 % after the hyphen. 2500 \global\let\codedashprev=\codedash 2501 % 2502 \codex 2503 } 2504 % 2505 \gdef\codedash{\futurelet\next\codedashfinish} 2506 \gdef\codedashfinish{% 2507 \normaldash % always output the dash character itself. 2508 % 2509 % Now, output a discretionary to allow a line break, unless 2510 % (a) the next character is a -, or 2511 % (b) the preceding character is a -. 2512 % E.g., given --posix, we do not want to allow a break after either -. 2513 % Given --foo-bar, we do want to allow a break between the - and the b. 2514 \ifx\next\codedash \else 2515 \ifx\codedashprev\codedash 2516 \else \discretionary{}{}{}\fi 2517 \fi 2518 % we need the space after the = for the case when \next itself is a 2519 % space token; it would get swallowed otherwise. As in @code{- a}. 2520 \global\let\codedashprev= \next 2521 } 2522} 2523\def\normaldash{-} 2524% 2525\def\codex #1{\tclose{#1}\endgroup} 2526 2527\def\codeunder{% 2528 % this is all so @math{@code{var_name}+1} can work. In math mode, _ 2529 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) 2530 % will therefore expand the active definition of _, which is us 2531 % (inside @code that is), therefore an endless loop. 2532 \ifusingtt{\ifmmode 2533 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. 2534 \else\normalunderscore \fi 2535 \discretionary{}{}{}}% 2536 {\_}% 2537} 2538 2539% An additional complication: the above will allow breaks after, e.g., 2540% each of the four underscores in __typeof__. This is bad. 2541% @allowcodebreaks provides a document-level way to turn breaking at - 2542% and _ on and off. 2543% 2544\newif\ifallowcodebreaks \allowcodebreakstrue 2545 2546\def\keywordtrue{true} 2547\def\keywordfalse{false} 2548 2549\parseargdef\allowcodebreaks{% 2550 \def\txiarg{#1}% 2551 \ifx\txiarg\keywordtrue 2552 \allowcodebreakstrue 2553 \else\ifx\txiarg\keywordfalse 2554 \allowcodebreaksfalse 2555 \else 2556 \errhelp = \EMsimple 2557 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}% 2558 \fi\fi 2559} 2560 2561% For @command, @env, @file, @option quotes seem unnecessary, 2562% so use \code rather than \samp. 2563\let\command=\code 2564\let\env=\code 2565\let\file=\code 2566\let\option=\code 2567 2568% @uref (abbreviation for `urlref') aka @url takes an optional 2569% (comma-separated) second argument specifying the text to display and 2570% an optional third arg as text to display instead of (rather than in 2571% addition to) the url itself. First (mandatory) arg is the url. 2572 2573% TeX-only option to allow changing PDF output to show only the second 2574% arg (if given), and not the url (which is then just the link target). 2575\newif\ifurefurlonlylink 2576 2577% The main macro is \urefbreak, which allows breaking at expected 2578% places within the url. (There used to be another version, which 2579% didn't support automatic breaking.) 2580\def\urefbreak{\begingroup \urefcatcodes \dourefbreak} 2581\let\uref=\urefbreak 2582% 2583\def\dourefbreak#1{\urefbreakfinish #1,,,\finish} 2584\def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example 2585 \unsepspaces 2586 \pdfurl{#1}% 2587 \setbox0 = \hbox{\ignorespaces #3}% 2588 \ifdim\wd0 > 0pt 2589 \unhbox0 % third arg given, show only that 2590 \else 2591 \setbox0 = \hbox{\ignorespaces #2}% look for second arg 2592 \ifdim\wd0 > 0pt 2593 \ifpdf 2594 \ifurefurlonlylink 2595 % PDF plus option to not display url, show just arg 2596 \unhbox0 2597 \else 2598 % PDF, normally display both arg and url for consistency, 2599 % visibility, if the pdf is eventually used to print, etc. 2600 \unhbox0\ (\urefcode{#1})% 2601 \fi 2602 \else 2603 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url 2604 \fi 2605 \else 2606 \urefcode{#1}% only url given, so show it 2607 \fi 2608 \fi 2609 \endlink 2610\endgroup} 2611 2612% Allow line breaks around only a few characters (only). 2613\def\urefcatcodes{% 2614 \catcode\ampChar=\active \catcode\dotChar=\active 2615 \catcode\hashChar=\active \catcode\questChar=\active 2616 \catcode\slashChar=\active 2617} 2618{ 2619 \urefcatcodes 2620 % 2621 \global\def\urefcode{\begingroup 2622 \setupmarkupstyle{code}% 2623 \urefcatcodes 2624 \let&\urefcodeamp 2625 \let.\urefcodedot 2626 \let#\urefcodehash 2627 \let?\urefcodequest 2628 \let/\urefcodeslash 2629 \codex 2630 } 2631 % 2632 % By default, they are just regular characters. 2633 \global\def&{\normalamp} 2634 \global\def.{\normaldot} 2635 \global\def#{\normalhash} 2636 \global\def?{\normalquest} 2637 \global\def/{\normalslash} 2638} 2639 2640% we put a little stretch before and after the breakable chars, to help 2641% line breaking of long url's. The unequal skips make look better in 2642% cmtt at least, especially for dots. 2643\def\urefprestretchamount{.13em} 2644\def\urefpoststretchamount{.1em} 2645\def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax} 2646\def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax} 2647% 2648\def\urefcodeamp{\urefprestretch \&\urefpoststretch} 2649\def\urefcodedot{\urefprestretch .\urefpoststretch} 2650\def\urefcodehash{\urefprestretch \#\urefpoststretch} 2651\def\urefcodequest{\urefprestretch ?\urefpoststretch} 2652\def\urefcodeslash{\futurelet\next\urefcodeslashfinish} 2653{ 2654 \catcode`\/=\active 2655 \global\def\urefcodeslashfinish{% 2656 \urefprestretch \slashChar 2657 % Allow line break only after the final / in a sequence of 2658 % slashes, to avoid line break between the slashes in http://. 2659 \ifx\next/\else \urefpoststretch \fi 2660 } 2661} 2662 2663% One more complication: by default we'll break after the special 2664% characters, but some people like to break before the special chars, so 2665% allow that. Also allow no breaking at all, for manual control. 2666% 2667\parseargdef\urefbreakstyle{% 2668 \def\txiarg{#1}% 2669 \ifx\txiarg\wordnone 2670 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak} 2671 \else\ifx\txiarg\wordbefore 2672 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak} 2673 \else\ifx\txiarg\wordafter 2674 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak} 2675 \else 2676 \errhelp = \EMsimple 2677 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}% 2678 \fi\fi\fi 2679} 2680\def\wordafter{after} 2681\def\wordbefore{before} 2682\def\wordnone{none} 2683 2684\urefbreakstyle after 2685 2686% @url synonym for @uref, since that's how everyone uses it. 2687% 2688\let\url=\uref 2689 2690% rms does not like angle brackets --karl, 17may97. 2691% So now @email is just like @uref, unless we are pdf. 2692% 2693%\def\email#1{\angleleft{\tt #1}\angleright} 2694\ifpdf 2695 \def\email#1{\doemail#1,,\finish} 2696 \def\doemail#1,#2,#3\finish{\begingroup 2697 \unsepspaces 2698 \pdfurl{mailto:#1}% 2699 \setbox0 = \hbox{\ignorespaces #2}% 2700 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi 2701 \endlink 2702 \endgroup} 2703\else 2704 \let\email=\uref 2705\fi 2706 2707% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), 2708% `example' (@kbd uses ttsl only inside of @example and friends), 2709% or `code' (@kbd uses normal tty font always). 2710\parseargdef\kbdinputstyle{% 2711 \def\txiarg{#1}% 2712 \ifx\txiarg\worddistinct 2713 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% 2714 \else\ifx\txiarg\wordexample 2715 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% 2716 \else\ifx\txiarg\wordcode 2717 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% 2718 \else 2719 \errhelp = \EMsimple 2720 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}% 2721 \fi\fi\fi 2722} 2723\def\worddistinct{distinct} 2724\def\wordexample{example} 2725\def\wordcode{code} 2726 2727% Default is `distinct'. 2728\kbdinputstyle distinct 2729 2730% @kbd is like @code, except that if the argument is just one @key command, 2731% then @kbd has no effect. 2732\def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}} 2733 2734\def\xkey{\key} 2735\def\kbdsub#1#2#3\par{% 2736 \def\one{#1}\def\three{#3}\def\threex{??}% 2737 \ifx\one\xkey\ifx\threex\three \key{#2}% 2738 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi 2739 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi 2740} 2741 2742% definition of @key that produces a lozenge. Doesn't adjust to text size. 2743%\setfont\keyrm\rmshape{8}{1000}{OT1} 2744%\font\keysy=cmsy9 2745%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% 2746% \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% 2747% \vbox{\hrule\kern-0.4pt 2748% \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% 2749% \kern-0.4pt\hrule}% 2750% \kern-.06em\raise0.4pt\hbox{\angleright}}}} 2751 2752% definition of @key with no lozenge. If the current font is already 2753% monospace, don't change it; that way, we respect @kbdinputstyle. But 2754% if it isn't monospace, then use \tt. 2755% 2756\def\key#1{{\setupmarkupstyle{key}% 2757 \nohyphenation 2758 \ifmonospace\else\tt\fi 2759 #1}\null} 2760 2761% @clicksequence{File @click{} Open ...} 2762\def\clicksequence#1{\begingroup #1\endgroup} 2763 2764% @clickstyle @arrow (by default) 2765\parseargdef\clickstyle{\def\click{#1}} 2766\def\click{\arrow} 2767 2768% Typeset a dimension, e.g., `in' or `pt'. The only reason for the 2769% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. 2770% 2771\def\dmn#1{\thinspace #1} 2772 2773% @l was never documented to mean ``switch to the Lisp font'', 2774% and it is not used as such in any manual I can find. We need it for 2775% Polish suppressed-l. --karl, 22sep96. 2776%\def\l#1{{\li #1}\null} 2777 2778% @acronym for "FBI", "NATO", and the like. 2779% We print this one point size smaller, since it's intended for 2780% all-uppercase. 2781% 2782\def\acronym#1{\doacronym #1,,\finish} 2783\def\doacronym#1,#2,#3\finish{% 2784 {\selectfonts\lsize #1}% 2785 \def\temp{#2}% 2786 \ifx\temp\empty \else 2787 \space ({\unsepspaces \ignorespaces \temp \unskip})% 2788 \fi 2789 \null % reset \spacefactor=1000 2790} 2791 2792% @abbr for "Comput. J." and the like. 2793% No font change, but don't do end-of-sentence spacing. 2794% 2795\def\abbr#1{\doabbr #1,,\finish} 2796\def\doabbr#1,#2,#3\finish{% 2797 {\plainfrenchspacing #1}% 2798 \def\temp{#2}% 2799 \ifx\temp\empty \else 2800 \space ({\unsepspaces \ignorespaces \temp \unskip})% 2801 \fi 2802 \null % reset \spacefactor=1000 2803} 2804 2805% @asis just yields its argument. Used with @table, for example. 2806% 2807\def\asis#1{#1} 2808 2809% @math outputs its argument in math mode. 2810% 2811% One complication: _ usually means subscripts, but it could also mean 2812% an actual _ character, as in @math{@var{some_variable} + 1}. So make 2813% _ active, and distinguish by seeing if the current family is \slfam, 2814% which is what @var uses. 2815{ 2816 \catcode`\_ = \active 2817 \gdef\mathunderscore{% 2818 \catcode`\_=\active 2819 \def_{\ifnum\fam=\slfam \_\else\sb\fi}% 2820 } 2821} 2822% Another complication: we want \\ (and @\) to output a math (or tt) \. 2823% FYI, plain.tex uses \\ as a temporary control sequence (for no 2824% particular reason), but this is not advertised and we don't care. 2825% 2826% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. 2827\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} 2828% 2829\def\math{% 2830 \tex 2831 \mathunderscore 2832 \let\\ = \mathbackslash 2833 \mathactive 2834 % make the texinfo accent commands work in math mode 2835 \let\"=\ddot 2836 \let\'=\acute 2837 \let\==\bar 2838 \let\^=\hat 2839 \let\`=\grave 2840 \let\u=\breve 2841 \let\v=\check 2842 \let\~=\tilde 2843 \let\dotaccent=\dot 2844 % have to provide another name for sup operator 2845 \let\mathopsup=\sup 2846 $\finishmath 2847} 2848\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. 2849 2850% Some active characters (such as <) are spaced differently in math. 2851% We have to reset their definitions in case the @math was an argument 2852% to a command which sets the catcodes (such as @item or @section). 2853% 2854{ 2855 \catcode`^ = \active 2856 \catcode`< = \active 2857 \catcode`> = \active 2858 \catcode`+ = \active 2859 \catcode`' = \active 2860 \gdef\mathactive{% 2861 \let^ = \ptexhat 2862 \let< = \ptexless 2863 \let> = \ptexgtr 2864 \let+ = \ptexplus 2865 \let' = \ptexquoteright 2866 } 2867} 2868 2869% for @sub and @sup, if in math mode, just do a normal sub/superscript. 2870% If in text, use math to place as sub/superscript, but switch 2871% into text mode, with smaller fonts. This is a different font than the 2872% one used for real math sub/superscripts (8pt vs. 7pt), but let's not 2873% fix it (significant additions to font machinery) until someone notices. 2874% 2875\def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi} 2876\def\finishsub#1{$\sb{\hbox{\selectfonts\lllsize #1}}$}% 2877% 2878\def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi} 2879\def\finishsup#1{$\ptexsp{\hbox{\selectfonts\lllsize #1}}$}% 2880 2881% ctrl is no longer a Texinfo command, but leave this definition for fun. 2882\def\ctrl #1{{\tt \rawbackslash \hat}#1} 2883 2884% @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}. 2885% Ignore unless FMTNAME == tex; then it is like @iftex and @tex, 2886% except specified as a normal braced arg, so no newlines to worry about. 2887% 2888\def\outfmtnametex{tex} 2889% 2890\long\def\inlinefmt#1{\doinlinefmt #1,\finish} 2891\long\def\doinlinefmt#1,#2,\finish{% 2892 \def\inlinefmtname{#1}% 2893 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi 2894} 2895% 2896% @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if 2897% FMTNAME is tex, else ELSE-TEXT. 2898\long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish} 2899\long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{% 2900 \def\inlinefmtname{#1}% 2901 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi 2902} 2903% 2904% For raw, must switch into @tex before parsing the argument, to avoid 2905% setting catcodes prematurely. Doing it this way means that, for 2906% example, @inlineraw{html, foo{bar} gets a parse error instead of being 2907% ignored. But this isn't important because if people want a literal 2908% *right* brace they would have to use a command anyway, so they may as 2909% well use a command to get a left brace too. We could re-use the 2910% delimiter character idea from \verb, but it seems like overkill. 2911% 2912\long\def\inlineraw{\tex \doinlineraw} 2913\long\def\doinlineraw#1{\doinlinerawtwo #1,\finish} 2914\def\doinlinerawtwo#1,#2,\finish{% 2915 \def\inlinerawname{#1}% 2916 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi 2917 \endgroup % close group opened by \tex. 2918} 2919 2920% @inlineifset{VAR, TEXT} expands TEXT if VAR is @set. 2921% 2922\long\def\inlineifset#1{\doinlineifset #1,\finish} 2923\long\def\doinlineifset#1,#2,\finish{% 2924 \def\inlinevarname{#1}% 2925 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax 2926 \else\ignorespaces#2\fi 2927} 2928 2929% @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set. 2930% 2931\long\def\inlineifclear#1{\doinlineifclear #1,\finish} 2932\long\def\doinlineifclear#1,#2,\finish{% 2933 \def\inlinevarname{#1}% 2934 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi 2935} 2936 2937 2938\message{glyphs,} 2939% and logos. 2940 2941% @@ prints an @, as does @atchar{}. 2942\def\@{\char64 } 2943\let\atchar=\@ 2944 2945% @{ @} @lbracechar{} @rbracechar{} all generate brace characters. 2946% Unless we're in typewriter, use \ecfont because the CM text fonts do 2947% not have braces, and we don't want to switch into math. 2948\def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}} 2949\def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}} 2950\let\{=\mylbrace \let\lbracechar=\{ 2951\let\}=\myrbrace \let\rbracechar=\} 2952\begingroup 2953 % Definitions to produce \{ and \} commands for indices, 2954 % and @{ and @} for the aux/toc files. 2955 \catcode`\{ = \other \catcode`\} = \other 2956 \catcode`\[ = 1 \catcode`\] = 2 2957 \catcode`\! = 0 \catcode`\\ = \other 2958 !gdef!lbracecmd[\{]% 2959 !gdef!rbracecmd[\}]% 2960 !gdef!lbraceatcmd[@{]% 2961 !gdef!rbraceatcmd[@}]% 2962!endgroup 2963 2964% @comma{} to avoid , parsing problems. 2965\let\comma = , 2966 2967% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent 2968% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. 2969\let\, = \ptexc 2970\let\dotaccent = \ptexdot 2971\def\ringaccent#1{{\accent23 #1}} 2972\let\tieaccent = \ptext 2973\let\ubaraccent = \ptexb 2974\let\udotaccent = \d 2975 2976% Other special characters: @questiondown @exclamdown @ordf @ordm 2977% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. 2978\def\questiondown{?`} 2979\def\exclamdown{!`} 2980\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} 2981\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} 2982 2983% Dotless i and dotless j, used for accents. 2984\def\imacro{i} 2985\def\jmacro{j} 2986\def\dotless#1{% 2987 \def\temp{#1}% 2988 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi 2989 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi 2990 \else \errmessage{@dotless can be used only with i or j}% 2991 \fi\fi 2992} 2993 2994% The \TeX{} logo, as in plain, but resetting the spacing so that a 2995% period following counts as ending a sentence. (Idea found in latex.) 2996% 2997\edef\TeX{\TeX \spacefactor=1000 } 2998 2999% @LaTeX{} logo. Not quite the same results as the definition in 3000% latex.ltx, since we use a different font for the raised A; it's most 3001% convenient for us to use an explicitly smaller font, rather than using 3002% the \scriptstyle font (since we don't reset \scriptstyle and 3003% \scriptscriptstyle). 3004% 3005\def\LaTeX{% 3006 L\kern-.36em 3007 {\setbox0=\hbox{T}% 3008 \vbox to \ht0{\hbox{% 3009 \ifx\textnominalsize\xwordpt 3010 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX. 3011 % Revert to plain's \scriptsize, which is 7pt. 3012 \count255=\the\fam $\fam\count255 \scriptstyle A$% 3013 \else 3014 % For 11pt, we can use our lllsize. 3015 \selectfonts\lllsize A% 3016 \fi 3017 }% 3018 \vss 3019 }}% 3020 \kern-.15em 3021 \TeX 3022} 3023 3024% Some math mode symbols. 3025\def\bullet{$\ptexbullet$} 3026\def\geq{\ifmmode \ge\else $\ge$\fi} 3027\def\leq{\ifmmode \le\else $\le$\fi} 3028\def\minus{\ifmmode -\else $-$\fi} 3029 3030% @dots{} outputs an ellipsis using the current font. 3031% We do .5em per period so that it has the same spacing in the cm 3032% typewriter fonts as three actual period characters; on the other hand, 3033% in other typewriter fonts three periods are wider than 1.5em. So do 3034% whichever is larger. 3035% 3036\def\dots{% 3037 \leavevmode 3038 \setbox0=\hbox{...}% get width of three periods 3039 \ifdim\wd0 > 1.5em 3040 \dimen0 = \wd0 3041 \else 3042 \dimen0 = 1.5em 3043 \fi 3044 \hbox to \dimen0{% 3045 \hskip 0pt plus.25fil 3046 .\hskip 0pt plus1fil 3047 .\hskip 0pt plus1fil 3048 .\hskip 0pt plus.5fil 3049 }% 3050} 3051 3052% @enddots{} is an end-of-sentence ellipsis. 3053% 3054\def\enddots{% 3055 \dots 3056 \spacefactor=\endofsentencespacefactor 3057} 3058 3059% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. 3060% 3061% Since these characters are used in examples, they should be an even number of 3062% \tt widths. Each \tt character is 1en, so two makes it 1em. 3063% 3064\def\point{$\star$} 3065\def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}} 3066\def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} 3067\def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}} 3068\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} 3069\def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}} 3070 3071% The @error{} command. 3072% Adapted from the TeXbook's \boxit. 3073% 3074\newbox\errorbox 3075% 3076{\tentt \global\dimen0 = 3em}% Width of the box. 3077\dimen2 = .55pt % Thickness of rules 3078% The text. (`r' is open on the right, `e' somewhat less so on the left.) 3079\setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt} 3080% 3081\setbox\errorbox=\hbox to \dimen0{\hfil 3082 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. 3083 \advance\hsize by -2\dimen2 % Rules. 3084 \vbox{% 3085 \hrule height\dimen2 3086 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. 3087 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. 3088 \kern3pt\vrule width\dimen2}% Space to right. 3089 \hrule height\dimen2} 3090 \hfil} 3091% 3092\def\error{\leavevmode\lower.7ex\copy\errorbox} 3093 3094% @pounds{} is a sterling sign, which Knuth put in the CM italic font. 3095% 3096\def\pounds{{\it\$}} 3097 3098% @euro{} comes from a separate font, depending on the current style. 3099% We use the free feym* fonts from the eurosym package by Henrik 3100% Theiling, which support regular, slanted, bold and bold slanted (and 3101% "outlined" (blackboard board, sort of) versions, which we don't need). 3102% It is available from http://www.ctan.org/tex-archive/fonts/eurosym. 3103% 3104% Although only regular is the truly official Euro symbol, we ignore 3105% that. The Euro is designed to be slightly taller than the regular 3106% font height. 3107% 3108% feymr - regular 3109% feymo - slanted 3110% feybr - bold 3111% feybo - bold slanted 3112% 3113% There is no good (free) typewriter version, to my knowledge. 3114% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide. 3115% Hmm. 3116% 3117% Also doesn't work in math. Do we need to do math with euro symbols? 3118% Hope not. 3119% 3120% 3121\def\euro{{\eurofont e}} 3122\def\eurofont{% 3123 % We set the font at each command, rather than predefining it in 3124 % \textfonts and the other font-switching commands, so that 3125 % installations which never need the symbol don't have to have the 3126 % font installed. 3127 % 3128 % There is only one designed size (nominal 10pt), so we always scale 3129 % that to the current nominal size. 3130 % 3131 % By the way, simply using "at 1em" works for cmr10 and the like, but 3132 % does not work for cmbx10 and other extended/shrunken fonts. 3133 % 3134 \def\eurosize{\csname\curfontsize nominalsize\endcsname}% 3135 % 3136 \ifx\curfontstyle\bfstylename 3137 % bold: 3138 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize 3139 \else 3140 % regular: 3141 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize 3142 \fi 3143 \thiseurofont 3144} 3145 3146% Glyphs from the EC fonts. We don't use \let for the aliases, because 3147% sometimes we redefine the original macro, and the alias should reflect 3148% the redefinition. 3149% 3150% Use LaTeX names for the Icelandic letters. 3151\def\DH{{\ecfont \char"D0}} % Eth 3152\def\dh{{\ecfont \char"F0}} % eth 3153\def\TH{{\ecfont \char"DE}} % Thorn 3154\def\th{{\ecfont \char"FE}} % thorn 3155% 3156\def\guillemetleft{{\ecfont \char"13}} 3157\def\guillemotleft{\guillemetleft} 3158\def\guillemetright{{\ecfont \char"14}} 3159\def\guillemotright{\guillemetright} 3160\def\guilsinglleft{{\ecfont \char"0E}} 3161\def\guilsinglright{{\ecfont \char"0F}} 3162\def\quotedblbase{{\ecfont \char"12}} 3163\def\quotesinglbase{{\ecfont \char"0D}} 3164% 3165% This positioning is not perfect (see the ogonek LaTeX package), but 3166% we have the precomposed glyphs for the most common cases. We put the 3167% tests to use those glyphs in the single \ogonek macro so we have fewer 3168% dummy definitions to worry about for index entries, etc. 3169% 3170% ogonek is also used with other letters in Lithuanian (IOU), but using 3171% the precomposed glyphs for those is not so easy since they aren't in 3172% the same EC font. 3173\def\ogonek#1{{% 3174 \def\temp{#1}% 3175 \ifx\temp\macrocharA\Aogonek 3176 \else\ifx\temp\macrochara\aogonek 3177 \else\ifx\temp\macrocharE\Eogonek 3178 \else\ifx\temp\macrochare\eogonek 3179 \else 3180 \ecfont \setbox0=\hbox{#1}% 3181 \ifdim\ht0=1ex\accent"0C #1% 3182 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}% 3183 \fi 3184 \fi\fi\fi\fi 3185 }% 3186} 3187\def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A} 3188\def\aogonek{{\ecfont \char"A1}}\def\macrochara{a} 3189\def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E} 3190\def\eogonek{{\ecfont \char"A6}}\def\macrochare{e} 3191% 3192% Use the ec* fonts (cm-super in outline format) for non-CM glyphs. 3193\def\ecfont{% 3194 % We can't distinguish serif/sans and italic/slanted, but this 3195 % is used for crude hacks anyway (like adding French and German 3196 % quotes to documents typeset with CM, where we lose kerning), so 3197 % hopefully nobody will notice/care. 3198 \edef\ecsize{\csname\curfontsize ecsize\endcsname}% 3199 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}% 3200 \ifmonospace 3201 % typewriter: 3202 \font\thisecfont = ectt\ecsize \space at \nominalsize 3203 \else 3204 \ifx\curfontstyle\bfstylename 3205 % bold: 3206 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize 3207 \else 3208 % regular: 3209 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize 3210 \fi 3211 \fi 3212 \thisecfont 3213} 3214 3215% @registeredsymbol - R in a circle. The font for the R should really 3216% be smaller yet, but lllsize is the best we can do for now. 3217% Adapted from the plain.tex definition of \copyright. 3218% 3219\def\registeredsymbol{% 3220 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% 3221 \hfil\crcr\Orb}}% 3222 }$% 3223} 3224 3225% @textdegree - the normal degrees sign. 3226% 3227\def\textdegree{$^\circ$} 3228 3229% Laurent Siebenmann reports \Orb undefined with: 3230% Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38 3231% so we'll define it if necessary. 3232% 3233\ifx\Orb\thisisundefined 3234\def\Orb{\mathhexbox20D} 3235\fi 3236 3237% Quotes. 3238\chardef\quotedblleft="5C 3239\chardef\quotedblright=`\" 3240\chardef\quoteleft=`\` 3241\chardef\quoteright=`\' 3242 3243 3244\message{page headings,} 3245 3246\newskip\titlepagetopglue \titlepagetopglue = 1.5in 3247\newskip\titlepagebottomglue \titlepagebottomglue = 2pc 3248 3249% First the title page. Must do @settitle before @titlepage. 3250\newif\ifseenauthor 3251\newif\iffinishedtitlepage 3252 3253% Do an implicit @contents or @shortcontents after @end titlepage if the 3254% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. 3255% 3256\newif\ifsetcontentsaftertitlepage 3257 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue 3258\newif\ifsetshortcontentsaftertitlepage 3259 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue 3260 3261\parseargdef\shorttitlepage{% 3262 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}% 3263 \endgroup\page\hbox{}\page} 3264 3265\envdef\titlepage{% 3266 % Open one extra group, as we want to close it in the middle of \Etitlepage. 3267 \begingroup 3268 \parindent=0pt \textfonts 3269 % Leave some space at the very top of the page. 3270 \vglue\titlepagetopglue 3271 % No rule at page bottom unless we print one at the top with @title. 3272 \finishedtitlepagetrue 3273 % 3274 % Most title ``pages'' are actually two pages long, with space 3275 % at the top of the second. We don't want the ragged left on the second. 3276 \let\oldpage = \page 3277 \def\page{% 3278 \iffinishedtitlepage\else 3279 \finishtitlepage 3280 \fi 3281 \let\page = \oldpage 3282 \page 3283 \null 3284 }% 3285} 3286 3287\def\Etitlepage{% 3288 \iffinishedtitlepage\else 3289 \finishtitlepage 3290 \fi 3291 % It is important to do the page break before ending the group, 3292 % because the headline and footline are only empty inside the group. 3293 % If we use the new definition of \page, we always get a blank page 3294 % after the title page, which we certainly don't want. 3295 \oldpage 3296 \endgroup 3297 % 3298 % Need this before the \...aftertitlepage checks so that if they are 3299 % in effect the toc pages will come out with page numbers. 3300 \HEADINGSon 3301 % 3302 % If they want short, they certainly want long too. 3303 \ifsetshortcontentsaftertitlepage 3304 \shortcontents 3305 \contents 3306 \global\let\shortcontents = \relax 3307 \global\let\contents = \relax 3308 \fi 3309 % 3310 \ifsetcontentsaftertitlepage 3311 \contents 3312 \global\let\contents = \relax 3313 \global\let\shortcontents = \relax 3314 \fi 3315} 3316 3317\def\finishtitlepage{% 3318 \vskip4pt \hrule height 2pt width \hsize 3319 \vskip\titlepagebottomglue 3320 \finishedtitlepagetrue 3321} 3322 3323% Settings used for typesetting titles: no hyphenation, no indentation, 3324% don't worry much about spacing, ragged right. This should be used 3325% inside a \vbox, and fonts need to be set appropriately first. Because 3326% it is always used for titles, nothing else, we call \rmisbold. \par 3327% should be specified before the end of the \vbox, since a vbox is a group. 3328% 3329\def\raggedtitlesettings{% 3330 \rmisbold 3331 \hyphenpenalty=10000 3332 \parindent=0pt 3333 \tolerance=5000 3334 \ptexraggedright 3335} 3336 3337% Macros to be used within @titlepage: 3338 3339\let\subtitlerm=\tenrm 3340\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} 3341 3342\parseargdef\title{% 3343 \checkenv\titlepage 3344 \vbox{\titlefonts \raggedtitlesettings #1\par}% 3345 % print a rule at the page bottom also. 3346 \finishedtitlepagefalse 3347 \vskip4pt \hrule height 4pt width \hsize \vskip4pt 3348} 3349 3350\parseargdef\subtitle{% 3351 \checkenv\titlepage 3352 {\subtitlefont \rightline{#1}}% 3353} 3354 3355% @author should come last, but may come many times. 3356% It can also be used inside @quotation. 3357% 3358\parseargdef\author{% 3359 \def\temp{\quotation}% 3360 \ifx\thisenv\temp 3361 \def\quotationauthor{#1}% printed in \Equotation. 3362 \else 3363 \checkenv\titlepage 3364 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi 3365 {\secfonts\rmisbold \leftline{#1}}% 3366 \fi 3367} 3368 3369 3370% Set up page headings and footings. 3371 3372\let\thispage=\folio 3373 3374\newtoks\evenheadline % headline on even pages 3375\newtoks\oddheadline % headline on odd pages 3376\newtoks\evenfootline % footline on even pages 3377\newtoks\oddfootline % footline on odd pages 3378 3379% Now make TeX use those variables 3380\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline 3381 \else \the\evenheadline \fi}} 3382\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline 3383 \else \the\evenfootline \fi}\HEADINGShook} 3384\let\HEADINGShook=\relax 3385 3386% Commands to set those variables. 3387% For example, this is what @headings on does 3388% @evenheading @thistitle|@thispage|@thischapter 3389% @oddheading @thischapter|@thispage|@thistitle 3390% @evenfooting @thisfile|| 3391% @oddfooting ||@thisfile 3392 3393 3394\def\evenheading{\parsearg\evenheadingxxx} 3395\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} 3396\def\evenheadingyyy #1\|#2\|#3\|#4\finish{% 3397\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 3398 3399\def\oddheading{\parsearg\oddheadingxxx} 3400\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} 3401\def\oddheadingyyy #1\|#2\|#3\|#4\finish{% 3402\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 3403 3404\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% 3405 3406\def\evenfooting{\parsearg\evenfootingxxx} 3407\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} 3408\def\evenfootingyyy #1\|#2\|#3\|#4\finish{% 3409\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 3410 3411\def\oddfooting{\parsearg\oddfootingxxx} 3412\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} 3413\def\oddfootingyyy #1\|#2\|#3\|#4\finish{% 3414 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% 3415 % 3416 % Leave some space for the footline. Hopefully ok to assume 3417 % @evenfooting will not be used by itself. 3418 \global\advance\pageheight by -12pt 3419 \global\advance\vsize by -12pt 3420} 3421 3422\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} 3423 3424% @evenheadingmarks top \thischapter <- chapter at the top of a page 3425% @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page 3426% 3427% The same set of arguments for: 3428% 3429% @oddheadingmarks 3430% @evenfootingmarks 3431% @oddfootingmarks 3432% @everyheadingmarks 3433% @everyfootingmarks 3434 3435\def\evenheadingmarks{\headingmarks{even}{heading}} 3436\def\oddheadingmarks{\headingmarks{odd}{heading}} 3437\def\evenfootingmarks{\headingmarks{even}{footing}} 3438\def\oddfootingmarks{\headingmarks{odd}{footing}} 3439\def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1} 3440 \headingmarks{odd}{heading}{#1} } 3441\def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1} 3442 \headingmarks{odd}{footing}{#1} } 3443% #1 = even/odd, #2 = heading/footing, #3 = top/bottom. 3444\def\headingmarks#1#2#3 {% 3445 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname 3446 \global\expandafter\let\csname get#1#2marks\endcsname \temp 3447} 3448 3449\everyheadingmarks bottom 3450\everyfootingmarks bottom 3451 3452% @headings double turns headings on for double-sided printing. 3453% @headings single turns headings on for single-sided printing. 3454% @headings off turns them off. 3455% @headings on same as @headings double, retained for compatibility. 3456% @headings after turns on double-sided headings after this page. 3457% @headings doubleafter turns on double-sided headings after this page. 3458% @headings singleafter turns on single-sided headings after this page. 3459% By default, they are off at the start of a document, 3460% and turned `on' after @end titlepage. 3461 3462\def\headings #1 {\csname HEADINGS#1\endcsname} 3463 3464\def\headingsoff{% non-global headings elimination 3465 \evenheadline={\hfil}\evenfootline={\hfil}% 3466 \oddheadline={\hfil}\oddfootline={\hfil}% 3467} 3468 3469\def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting 3470\HEADINGSoff % it's the default 3471 3472% When we turn headings on, set the page number to 1. 3473% For double-sided printing, put current file name in lower left corner, 3474% chapter name on inside top of right hand pages, document 3475% title on inside top of left hand pages, and page numbers on outside top 3476% edge of all pages. 3477\def\HEADINGSdouble{% 3478\global\pageno=1 3479\global\evenfootline={\hfil} 3480\global\oddfootline={\hfil} 3481\global\evenheadline={\line{\folio\hfil\thistitle}} 3482\global\oddheadline={\line{\thischapter\hfil\folio}} 3483\global\let\contentsalignmacro = \chapoddpage 3484} 3485\let\contentsalignmacro = \chappager 3486 3487% For single-sided printing, chapter title goes across top left of page, 3488% page number on top right. 3489\def\HEADINGSsingle{% 3490\global\pageno=1 3491\global\evenfootline={\hfil} 3492\global\oddfootline={\hfil} 3493\global\evenheadline={\line{\thischapter\hfil\folio}} 3494\global\oddheadline={\line{\thischapter\hfil\folio}} 3495\global\let\contentsalignmacro = \chappager 3496} 3497\def\HEADINGSon{\HEADINGSdouble} 3498 3499\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} 3500\let\HEADINGSdoubleafter=\HEADINGSafter 3501\def\HEADINGSdoublex{% 3502\global\evenfootline={\hfil} 3503\global\oddfootline={\hfil} 3504\global\evenheadline={\line{\folio\hfil\thistitle}} 3505\global\oddheadline={\line{\thischapter\hfil\folio}} 3506\global\let\contentsalignmacro = \chapoddpage 3507} 3508 3509\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} 3510\def\HEADINGSsinglex{% 3511\global\evenfootline={\hfil} 3512\global\oddfootline={\hfil} 3513\global\evenheadline={\line{\thischapter\hfil\folio}} 3514\global\oddheadline={\line{\thischapter\hfil\folio}} 3515\global\let\contentsalignmacro = \chappager 3516} 3517 3518% Subroutines used in generating headings 3519% This produces Day Month Year style of output. 3520% Only define if not already defined, in case a txi-??.tex file has set 3521% up a different format (e.g., txi-cs.tex does this). 3522\ifx\today\thisisundefined 3523\def\today{% 3524 \number\day\space 3525 \ifcase\month 3526 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr 3527 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug 3528 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec 3529 \fi 3530 \space\number\year} 3531\fi 3532 3533% @settitle line... specifies the title of the document, for headings. 3534% It generates no output of its own. 3535\def\thistitle{\putwordNoTitle} 3536\def\settitle{\parsearg{\gdef\thistitle}} 3537 3538 3539\message{tables,} 3540% Tables -- @table, @ftable, @vtable, @item(x). 3541 3542% default indentation of table text 3543\newdimen\tableindent \tableindent=.8in 3544% default indentation of @itemize and @enumerate text 3545\newdimen\itemindent \itemindent=.3in 3546% margin between end of table item and start of table text. 3547\newdimen\itemmargin \itemmargin=.1in 3548 3549% used internally for \itemindent minus \itemmargin 3550\newdimen\itemmax 3551 3552% Note @table, @ftable, and @vtable define @item, @itemx, etc., with 3553% these defs. 3554% They also define \itemindex 3555% to index the item name in whatever manner is desired (perhaps none). 3556 3557\newif\ifitemxneedsnegativevskip 3558 3559\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} 3560 3561\def\internalBitem{\smallbreak \parsearg\itemzzz} 3562\def\internalBitemx{\itemxpar \parsearg\itemzzz} 3563 3564\def\itemzzz #1{\begingroup % 3565 \advance\hsize by -\rightskip 3566 \advance\hsize by -\tableindent 3567 \setbox0=\hbox{\itemindicate{#1}}% 3568 \itemindex{#1}% 3569 \nobreak % This prevents a break before @itemx. 3570 % 3571 % If the item text does not fit in the space we have, put it on a line 3572 % by itself, and do not allow a page break either before or after that 3573 % line. We do not start a paragraph here because then if the next 3574 % command is, e.g., @kindex, the whatsit would get put into the 3575 % horizontal list on a line by itself, resulting in extra blank space. 3576 \ifdim \wd0>\itemmax 3577 % 3578 % Make this a paragraph so we get the \parskip glue and wrapping, 3579 % but leave it ragged-right. 3580 \begingroup 3581 \advance\leftskip by-\tableindent 3582 \advance\hsize by\tableindent 3583 \advance\rightskip by0pt plus1fil\relax 3584 \leavevmode\unhbox0\par 3585 \endgroup 3586 % 3587 % We're going to be starting a paragraph, but we don't want the 3588 % \parskip glue -- logically it's part of the @item we just started. 3589 \nobreak \vskip-\parskip 3590 % 3591 % Stop a page break at the \parskip glue coming up. However, if 3592 % what follows is an environment such as @example, there will be no 3593 % \parskip glue; then the negative vskip we just inserted would 3594 % cause the example and the item to crash together. So we use this 3595 % bizarre value of 10001 as a signal to \aboveenvbreak to insert 3596 % \parskip glue after all. Section titles are handled this way also. 3597 % 3598 \penalty 10001 3599 \endgroup 3600 \itemxneedsnegativevskipfalse 3601 \else 3602 % The item text fits into the space. Start a paragraph, so that the 3603 % following text (if any) will end up on the same line. 3604 \noindent 3605 % Do this with kerns and \unhbox so that if there is a footnote in 3606 % the item text, it can migrate to the main vertical list and 3607 % eventually be printed. 3608 \nobreak\kern-\tableindent 3609 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 3610 \unhbox0 3611 \nobreak\kern\dimen0 3612 \endgroup 3613 \itemxneedsnegativevskiptrue 3614 \fi 3615} 3616 3617\def\item{\errmessage{@item while not in a list environment}} 3618\def\itemx{\errmessage{@itemx while not in a list environment}} 3619 3620% @table, @ftable, @vtable. 3621\envdef\table{% 3622 \let\itemindex\gobble 3623 \tablecheck{table}% 3624} 3625\envdef\ftable{% 3626 \def\itemindex ##1{\doind {fn}{\code{##1}}}% 3627 \tablecheck{ftable}% 3628} 3629\envdef\vtable{% 3630 \def\itemindex ##1{\doind {vr}{\code{##1}}}% 3631 \tablecheck{vtable}% 3632} 3633\def\tablecheck#1{% 3634 \ifnum \the\catcode`\^^M=\active 3635 \endgroup 3636 \errmessage{This command won't work in this context; perhaps the problem is 3637 that we are \inenvironment\thisenv}% 3638 \def\next{\doignore{#1}}% 3639 \else 3640 \let\next\tablex 3641 \fi 3642 \next 3643} 3644\def\tablex#1{% 3645 \def\itemindicate{#1}% 3646 \parsearg\tabley 3647} 3648\def\tabley#1{% 3649 {% 3650 \makevalueexpandable 3651 \edef\temp{\noexpand\tablez #1\space\space\space}% 3652 \expandafter 3653 }\temp \endtablez 3654} 3655\def\tablez #1 #2 #3 #4\endtablez{% 3656 \aboveenvbreak 3657 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi 3658 \ifnum 0#2>0 \tableindent=#2\mil \fi 3659 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi 3660 \itemmax=\tableindent 3661 \advance \itemmax by -\itemmargin 3662 \advance \leftskip by \tableindent 3663 \exdentamount=\tableindent 3664 \parindent = 0pt 3665 \parskip = \smallskipamount 3666 \ifdim \parskip=0pt \parskip=2pt \fi 3667 \let\item = \internalBitem 3668 \let\itemx = \internalBitemx 3669} 3670\def\Etable{\endgraf\afterenvbreak} 3671\let\Eftable\Etable 3672\let\Evtable\Etable 3673\let\Eitemize\Etable 3674\let\Eenumerate\Etable 3675 3676% This is the counter used by @enumerate, which is really @itemize 3677 3678\newcount \itemno 3679 3680\envdef\itemize{\parsearg\doitemize} 3681 3682\def\doitemize#1{% 3683 \aboveenvbreak 3684 \itemmax=\itemindent 3685 \advance\itemmax by -\itemmargin 3686 \advance\leftskip by \itemindent 3687 \exdentamount=\itemindent 3688 \parindent=0pt 3689 \parskip=\smallskipamount 3690 \ifdim\parskip=0pt \parskip=2pt \fi 3691 % 3692 % Try typesetting the item mark so that if the document erroneously says 3693 % something like @itemize @samp (intending @table), there's an error 3694 % right away at the @itemize. It's not the best error message in the 3695 % world, but it's better than leaving it to the @item. This means if 3696 % the user wants an empty mark, they have to say @w{} not just @w. 3697 \def\itemcontents{#1}% 3698 \setbox0 = \hbox{\itemcontents}% 3699 % 3700 % @itemize with no arg is equivalent to @itemize @bullet. 3701 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi 3702 % 3703 \let\item=\itemizeitem 3704} 3705 3706% Definition of @item while inside @itemize and @enumerate. 3707% 3708\def\itemizeitem{% 3709 \advance\itemno by 1 % for enumerations 3710 {\let\par=\endgraf \smallbreak}% reasonable place to break 3711 {% 3712 % If the document has an @itemize directly after a section title, a 3713 % \nobreak will be last on the list, and \sectionheading will have 3714 % done a \vskip-\parskip. In that case, we don't want to zero 3715 % parskip, or the item text will crash with the heading. On the 3716 % other hand, when there is normal text preceding the item (as there 3717 % usually is), we do want to zero parskip, or there would be too much 3718 % space. In that case, we won't have a \nobreak before. At least 3719 % that's the theory. 3720 \ifnum\lastpenalty<10000 \parskip=0in \fi 3721 \noindent 3722 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% 3723 % 3724 \vadjust{\penalty 1200}}% not good to break after first line of item. 3725 \flushcr 3726} 3727 3728% \splitoff TOKENS\endmark defines \first to be the first token in 3729% TOKENS, and \rest to be the remainder. 3730% 3731\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% 3732 3733% Allow an optional argument of an uppercase letter, lowercase letter, 3734% or number, to specify the first label in the enumerated list. No 3735% argument is the same as `1'. 3736% 3737\envparseargdef\enumerate{\enumeratey #1 \endenumeratey} 3738\def\enumeratey #1 #2\endenumeratey{% 3739 % If we were given no argument, pretend we were given `1'. 3740 \def\thearg{#1}% 3741 \ifx\thearg\empty \def\thearg{1}\fi 3742 % 3743 % Detect if the argument is a single token. If so, it might be a 3744 % letter. Otherwise, the only valid thing it can be is a number. 3745 % (We will always have one token, because of the test we just made. 3746 % This is a good thing, since \splitoff doesn't work given nothing at 3747 % all -- the first parameter is undelimited.) 3748 \expandafter\splitoff\thearg\endmark 3749 \ifx\rest\empty 3750 % Only one token in the argument. It could still be anything. 3751 % A ``lowercase letter'' is one whose \lccode is nonzero. 3752 % An ``uppercase letter'' is one whose \lccode is both nonzero, and 3753 % not equal to itself. 3754 % Otherwise, we assume it's a number. 3755 % 3756 % We need the \relax at the end of the \ifnum lines to stop TeX from 3757 % continuing to look for a <number>. 3758 % 3759 \ifnum\lccode\expandafter`\thearg=0\relax 3760 \numericenumerate % a number (we hope) 3761 \else 3762 % It's a letter. 3763 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax 3764 \lowercaseenumerate % lowercase letter 3765 \else 3766 \uppercaseenumerate % uppercase letter 3767 \fi 3768 \fi 3769 \else 3770 % Multiple tokens in the argument. We hope it's a number. 3771 \numericenumerate 3772 \fi 3773} 3774 3775% An @enumerate whose labels are integers. The starting integer is 3776% given in \thearg. 3777% 3778\def\numericenumerate{% 3779 \itemno = \thearg 3780 \startenumeration{\the\itemno}% 3781} 3782 3783% The starting (lowercase) letter is in \thearg. 3784\def\lowercaseenumerate{% 3785 \itemno = \expandafter`\thearg 3786 \startenumeration{% 3787 % Be sure we're not beyond the end of the alphabet. 3788 \ifnum\itemno=0 3789 \errmessage{No more lowercase letters in @enumerate; get a bigger 3790 alphabet}% 3791 \fi 3792 \char\lccode\itemno 3793 }% 3794} 3795 3796% The starting (uppercase) letter is in \thearg. 3797\def\uppercaseenumerate{% 3798 \itemno = \expandafter`\thearg 3799 \startenumeration{% 3800 % Be sure we're not beyond the end of the alphabet. 3801 \ifnum\itemno=0 3802 \errmessage{No more uppercase letters in @enumerate; get a bigger 3803 alphabet} 3804 \fi 3805 \char\uccode\itemno 3806 }% 3807} 3808 3809% Call \doitemize, adding a period to the first argument and supplying the 3810% common last two arguments. Also subtract one from the initial value in 3811% \itemno, since @item increments \itemno. 3812% 3813\def\startenumeration#1{% 3814 \advance\itemno by -1 3815 \doitemize{#1.}\flushcr 3816} 3817 3818% @alphaenumerate and @capsenumerate are abbreviations for giving an arg 3819% to @enumerate. 3820% 3821\def\alphaenumerate{\enumerate{a}} 3822\def\capsenumerate{\enumerate{A}} 3823\def\Ealphaenumerate{\Eenumerate} 3824\def\Ecapsenumerate{\Eenumerate} 3825 3826 3827% @multitable macros 3828% Amy Hendrickson, 8/18/94, 3/6/96 3829% 3830% @multitable ... @end multitable will make as many columns as desired. 3831% Contents of each column will wrap at width given in preamble. Width 3832% can be specified either with sample text given in a template line, 3833% or in percent of \hsize, the current width of text on page. 3834 3835% Table can continue over pages but will only break between lines. 3836 3837% To make preamble: 3838% 3839% Either define widths of columns in terms of percent of \hsize: 3840% @multitable @columnfractions .25 .3 .45 3841% @item ... 3842% 3843% Numbers following @columnfractions are the percent of the total 3844% current hsize to be used for each column. You may use as many 3845% columns as desired. 3846 3847 3848% Or use a template: 3849% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 3850% @item ... 3851% using the widest term desired in each column. 3852 3853% Each new table line starts with @item, each subsequent new column 3854% starts with @tab. Empty columns may be produced by supplying @tab's 3855% with nothing between them for as many times as empty columns are needed, 3856% ie, @tab@tab@tab will produce two empty columns. 3857 3858% @item, @tab do not need to be on their own lines, but it will not hurt 3859% if they are. 3860 3861% Sample multitable: 3862 3863% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 3864% @item first col stuff @tab second col stuff @tab third col 3865% @item 3866% first col stuff 3867% @tab 3868% second col stuff 3869% @tab 3870% third col 3871% @item first col stuff @tab second col stuff 3872% @tab Many paragraphs of text may be used in any column. 3873% 3874% They will wrap at the width determined by the template. 3875% @item@tab@tab This will be in third column. 3876% @end multitable 3877 3878% Default dimensions may be reset by user. 3879% @multitableparskip is vertical space between paragraphs in table. 3880% @multitableparindent is paragraph indent in table. 3881% @multitablecolmargin is horizontal space to be left between columns. 3882% @multitablelinespace is space to leave between table items, baseline 3883% to baseline. 3884% 0pt means it depends on current normal line spacing. 3885% 3886\newskip\multitableparskip 3887\newskip\multitableparindent 3888\newdimen\multitablecolspace 3889\newskip\multitablelinespace 3890\multitableparskip=0pt 3891\multitableparindent=6pt 3892\multitablecolspace=12pt 3893\multitablelinespace=0pt 3894 3895% Macros used to set up halign preamble: 3896% 3897\let\endsetuptable\relax 3898\def\xendsetuptable{\endsetuptable} 3899\let\columnfractions\relax 3900\def\xcolumnfractions{\columnfractions} 3901\newif\ifsetpercent 3902 3903% #1 is the @columnfraction, usually a decimal number like .5, but might 3904% be just 1. We just use it, whatever it is. 3905% 3906\def\pickupwholefraction#1 {% 3907 \global\advance\colcount by 1 3908 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% 3909 \setuptable 3910} 3911 3912\newcount\colcount 3913\def\setuptable#1{% 3914 \def\firstarg{#1}% 3915 \ifx\firstarg\xendsetuptable 3916 \let\go = \relax 3917 \else 3918 \ifx\firstarg\xcolumnfractions 3919 \global\setpercenttrue 3920 \else 3921 \ifsetpercent 3922 \let\go\pickupwholefraction 3923 \else 3924 \global\advance\colcount by 1 3925 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a 3926 % separator; typically that is always in the input, anyway. 3927 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% 3928 \fi 3929 \fi 3930 \ifx\go\pickupwholefraction 3931 % Put the argument back for the \pickupwholefraction call, so 3932 % we'll always have a period there to be parsed. 3933 \def\go{\pickupwholefraction#1}% 3934 \else 3935 \let\go = \setuptable 3936 \fi% 3937 \fi 3938 \go 3939} 3940 3941% multitable-only commands. 3942% 3943% @headitem starts a heading row, which we typeset in bold. Assignments 3944% have to be global since we are inside the implicit group of an 3945% alignment entry. \everycr below resets \everytab so we don't have to 3946% undo it ourselves. 3947\def\headitemfont{\b}% for people to use in the template row; not changeable 3948\def\headitem{% 3949 \checkenv\multitable 3950 \crcr 3951 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings 3952 \global\everytab={\bf}% can't use \headitemfont since the parsing differs 3953 \the\everytab % for the first item 3954}% 3955% 3956% default for tables with no headings. 3957\let\headitemcrhook=\relax 3958% 3959% A \tab used to include \hskip1sp. But then the space in a template 3960% line is not enough. That is bad. So let's go back to just `&' until 3961% we again encounter the problem the 1sp was intended to solve. 3962% --karl, nathan@acm.org, 20apr99. 3963\def\tab{\checkenv\multitable &\the\everytab}% 3964 3965% @multitable ... @end multitable definitions: 3966% 3967\newtoks\everytab % insert after every tab. 3968% 3969\envdef\multitable{% 3970 \vskip\parskip 3971 \startsavinginserts 3972 % 3973 % @item within a multitable starts a normal row. 3974 % We use \def instead of \let so that if one of the multitable entries 3975 % contains an @itemize, we don't choke on the \item (seen as \crcr aka 3976 % \endtemplate) expanding \doitemize. 3977 \def\item{\crcr}% 3978 % 3979 \tolerance=9500 3980 \hbadness=9500 3981 \setmultitablespacing 3982 \parskip=\multitableparskip 3983 \parindent=\multitableparindent 3984 \overfullrule=0pt 3985 \global\colcount=0 3986 % 3987 \everycr = {% 3988 \noalign{% 3989 \global\everytab={}% Reset from possible headitem. 3990 \global\colcount=0 % Reset the column counter. 3991 % 3992 % Check for saved footnotes, etc.: 3993 \checkinserts 3994 % 3995 % Perhaps a \nobreak, then reset: 3996 \headitemcrhook 3997 \global\let\headitemcrhook=\relax 3998 }% 3999 }% 4000 % 4001 \parsearg\domultitable 4002} 4003\def\domultitable#1{% 4004 % To parse everything between @multitable and @item: 4005 \setuptable#1 \endsetuptable 4006 % 4007 % This preamble sets up a generic column definition, which will 4008 % be used as many times as user calls for columns. 4009 % \vtop will set a single line and will also let text wrap and 4010 % continue for many paragraphs if desired. 4011 \halign\bgroup &% 4012 \global\advance\colcount by 1 4013 \multistrut 4014 \vtop{% 4015 % Use the current \colcount to find the correct column width: 4016 \hsize=\expandafter\csname col\the\colcount\endcsname 4017 % 4018 % In order to keep entries from bumping into each other 4019 % we will add a \leftskip of \multitablecolspace to all columns after 4020 % the first one. 4021 % 4022 % If a template has been used, we will add \multitablecolspace 4023 % to the width of each template entry. 4024 % 4025 % If the user has set preamble in terms of percent of \hsize we will 4026 % use that dimension as the width of the column, and the \leftskip 4027 % will keep entries from bumping into each other. Table will start at 4028 % left margin and final column will justify at right margin. 4029 % 4030 % Make sure we don't inherit \rightskip from the outer environment. 4031 \rightskip=0pt 4032 \ifnum\colcount=1 4033 % The first column will be indented with the surrounding text. 4034 \advance\hsize by\leftskip 4035 \else 4036 \ifsetpercent \else 4037 % If user has not set preamble in terms of percent of \hsize 4038 % we will advance \hsize by \multitablecolspace. 4039 \advance\hsize by \multitablecolspace 4040 \fi 4041 % In either case we will make \leftskip=\multitablecolspace: 4042 \leftskip=\multitablecolspace 4043 \fi 4044 % Ignoring space at the beginning and end avoids an occasional spurious 4045 % blank line, when TeX decides to break the line at the space before the 4046 % box from the multistrut, so the strut ends up on a line by itself. 4047 % For example: 4048 % @multitable @columnfractions .11 .89 4049 % @item @code{#} 4050 % @tab Legal holiday which is valid in major parts of the whole country. 4051 % Is automatically provided with highlighting sequences respectively 4052 % marking characters. 4053 \noindent\ignorespaces##\unskip\multistrut 4054 }\cr 4055} 4056\def\Emultitable{% 4057 \crcr 4058 \egroup % end the \halign 4059 \global\setpercentfalse 4060} 4061 4062\def\setmultitablespacing{% 4063 \def\multistrut{\strut}% just use the standard line spacing 4064 % 4065 % Compute \multitablelinespace (if not defined by user) for use in 4066 % \multitableparskip calculation. We used define \multistrut based on 4067 % this, but (ironically) that caused the spacing to be off. 4068 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100. 4069\ifdim\multitablelinespace=0pt 4070\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip 4071\global\advance\multitablelinespace by-\ht0 4072\fi 4073% Test to see if parskip is larger than space between lines of 4074% table. If not, do nothing. 4075% If so, set to same dimension as multitablelinespace. 4076\ifdim\multitableparskip>\multitablelinespace 4077\global\multitableparskip=\multitablelinespace 4078\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller 4079 % than skip between lines in the table. 4080\fi% 4081\ifdim\multitableparskip=0pt 4082\global\multitableparskip=\multitablelinespace 4083\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller 4084 % than skip between lines in the table. 4085\fi} 4086 4087 4088\message{conditionals,} 4089 4090% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, 4091% @ifnotxml always succeed. They currently do nothing; we don't 4092% attempt to check whether the conditionals are properly nested. But we 4093% have to remember that they are conditionals, so that @end doesn't 4094% attempt to close an environment group. 4095% 4096\def\makecond#1{% 4097 \expandafter\let\csname #1\endcsname = \relax 4098 \expandafter\let\csname iscond.#1\endcsname = 1 4099} 4100\makecond{iftex} 4101\makecond{ifnotdocbook} 4102\makecond{ifnothtml} 4103\makecond{ifnotinfo} 4104\makecond{ifnotplaintext} 4105\makecond{ifnotxml} 4106 4107% Ignore @ignore, @ifhtml, @ifinfo, and the like. 4108% 4109\def\direntry{\doignore{direntry}} 4110\def\documentdescription{\doignore{documentdescription}} 4111\def\docbook{\doignore{docbook}} 4112\def\html{\doignore{html}} 4113\def\ifdocbook{\doignore{ifdocbook}} 4114\def\ifhtml{\doignore{ifhtml}} 4115\def\ifinfo{\doignore{ifinfo}} 4116\def\ifnottex{\doignore{ifnottex}} 4117\def\ifplaintext{\doignore{ifplaintext}} 4118\def\ifxml{\doignore{ifxml}} 4119\def\ignore{\doignore{ignore}} 4120\def\menu{\doignore{menu}} 4121\def\xml{\doignore{xml}} 4122 4123% Ignore text until a line `@end #1', keeping track of nested conditionals. 4124% 4125% A count to remember the depth of nesting. 4126\newcount\doignorecount 4127 4128\def\doignore#1{\begingroup 4129 % Scan in ``verbatim'' mode: 4130 \obeylines 4131 \catcode`\@ = \other 4132 \catcode`\{ = \other 4133 \catcode`\} = \other 4134 % 4135 % Make sure that spaces turn into tokens that match what \doignoretext wants. 4136 \spaceisspace 4137 % 4138 % Count number of #1's that we've seen. 4139 \doignorecount = 0 4140 % 4141 % Swallow text until we reach the matching `@end #1'. 4142 \dodoignore{#1}% 4143} 4144 4145{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. 4146 \obeylines % 4147 % 4148 \gdef\dodoignore#1{% 4149 % #1 contains the command name as a string, e.g., `ifinfo'. 4150 % 4151 % Define a command to find the next `@end #1'. 4152 \long\def\doignoretext##1^^M@end #1{% 4153 \doignoretextyyy##1^^M@#1\_STOP_}% 4154 % 4155 % And this command to find another #1 command, at the beginning of a 4156 % line. (Otherwise, we would consider a line `@c @ifset', for 4157 % example, to count as an @ifset for nesting.) 4158 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% 4159 % 4160 % And now expand that command. 4161 \doignoretext ^^M% 4162 }% 4163} 4164 4165\def\doignoreyyy#1{% 4166 \def\temp{#1}% 4167 \ifx\temp\empty % Nothing found. 4168 \let\next\doignoretextzzz 4169 \else % Found a nested condition, ... 4170 \advance\doignorecount by 1 4171 \let\next\doignoretextyyy % ..., look for another. 4172 % If we're here, #1 ends with ^^M\ifinfo (for example). 4173 \fi 4174 \next #1% the token \_STOP_ is present just after this macro. 4175} 4176 4177% We have to swallow the remaining "\_STOP_". 4178% 4179\def\doignoretextzzz#1{% 4180 \ifnum\doignorecount = 0 % We have just found the outermost @end. 4181 \let\next\enddoignore 4182 \else % Still inside a nested condition. 4183 \advance\doignorecount by -1 4184 \let\next\doignoretext % Look for the next @end. 4185 \fi 4186 \next 4187} 4188 4189% Finish off ignored text. 4190{ \obeylines% 4191 % Ignore anything after the last `@end #1'; this matters in verbatim 4192 % environments, where otherwise the newline after an ignored conditional 4193 % would result in a blank line in the output. 4194 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}% 4195} 4196 4197 4198% @set VAR sets the variable VAR to an empty value. 4199% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. 4200% 4201% Since we want to separate VAR from REST-OF-LINE (which might be 4202% empty), we can't just use \parsearg; we have to insert a space of our 4203% own to delimit the rest of the line, and then take it out again if we 4204% didn't need it. 4205% We rely on the fact that \parsearg sets \catcode`\ =10. 4206% 4207\parseargdef\set{\setyyy#1 \endsetyyy} 4208\def\setyyy#1 #2\endsetyyy{% 4209 {% 4210 \makevalueexpandable 4211 \def\temp{#2}% 4212 \edef\next{\gdef\makecsname{SET#1}}% 4213 \ifx\temp\empty 4214 \next{}% 4215 \else 4216 \setzzz#2\endsetzzz 4217 \fi 4218 }% 4219} 4220% Remove the trailing space \setxxx inserted. 4221\def\setzzz#1 \endsetzzz{\next{#1}} 4222 4223% @clear VAR clears (i.e., unsets) the variable VAR. 4224% 4225\parseargdef\clear{% 4226 {% 4227 \makevalueexpandable 4228 \global\expandafter\let\csname SET#1\endcsname=\relax 4229 }% 4230} 4231 4232% @value{foo} gets the text saved in variable foo. 4233\def\value{\begingroup\makevalueexpandable\valuexxx} 4234\def\valuexxx#1{\expandablevalue{#1}\endgroup} 4235{ 4236 \catcode`\-=\active \catcode`\_=\active 4237 % 4238 \gdef\makevalueexpandable{% 4239 \let\value = \expandablevalue 4240 % We don't want these characters active, ... 4241 \catcode`\-=\other \catcode`\_=\other 4242 % ..., but we might end up with active ones in the argument if 4243 % we're called from @code, as @code{@value{foo-bar_}}, though. 4244 % So \let them to their normal equivalents. 4245 \let-\normaldash \let_\normalunderscore 4246 } 4247} 4248 4249% We have this subroutine so that we can handle at least some @value's 4250% properly in indexes (we call \makevalueexpandable in \indexdummies). 4251% The command has to be fully expandable (if the variable is set), since 4252% the result winds up in the index file. This means that if the 4253% variable's value contains other Texinfo commands, it's almost certain 4254% it will fail (although perhaps we could fix that with sufficient work 4255% to do a one-level expansion on the result, instead of complete). 4256% 4257% Unfortunately, this has the consequence that when _ is in the *value* 4258% of an @set, it does not print properly in the roman fonts (get the cmr 4259% dot accent at position 126 instead). No fix comes to mind, and it's 4260% been this way since 2003 or earlier, so just ignore it. 4261% 4262\def\expandablevalue#1{% 4263 \expandafter\ifx\csname SET#1\endcsname\relax 4264 {[No value for ``#1'']}% 4265 \message{Variable `#1', used in @value, is not set.}% 4266 \else 4267 \csname SET#1\endcsname 4268 \fi 4269} 4270 4271% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined 4272% with @set. 4273% 4274% To get the special treatment we need for `@end ifset,' we call 4275% \makecond and then redefine. 4276% 4277\makecond{ifset} 4278\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} 4279\def\doifset#1#2{% 4280 {% 4281 \makevalueexpandable 4282 \let\next=\empty 4283 \expandafter\ifx\csname SET#2\endcsname\relax 4284 #1% If not set, redefine \next. 4285 \fi 4286 \expandafter 4287 }\next 4288} 4289\def\ifsetfail{\doignore{ifset}} 4290 4291% @ifclear VAR ... @end executes the `...' iff VAR has never been 4292% defined with @set, or has been undefined with @clear. 4293% 4294% The `\else' inside the `\doifset' parameter is a trick to reuse the 4295% above code: if the variable is not set, do nothing, if it is set, 4296% then redefine \next to \ifclearfail. 4297% 4298\makecond{ifclear} 4299\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} 4300\def\ifclearfail{\doignore{ifclear}} 4301 4302% @ifcommandisdefined CMD ... @end executes the `...' if CMD (written 4303% without the @) is in fact defined. We can only feasibly check at the 4304% TeX level, so something like `mathcode' is going to considered 4305% defined even though it is not a Texinfo command. 4306% 4307\makecond{ifcommanddefined} 4308\def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}} 4309% 4310\def\doifcmddefined#1#2{{% 4311 \makevalueexpandable 4312 \let\next=\empty 4313 \expandafter\ifx\csname #2\endcsname\relax 4314 #1% If not defined, \let\next as above. 4315 \fi 4316 \expandafter 4317 }\next 4318} 4319\def\ifcmddefinedfail{\doignore{ifcommanddefined}} 4320 4321% @ifcommandnotdefined CMD ... handled similar to @ifclear above. 4322\makecond{ifcommandnotdefined} 4323\def\ifcommandnotdefined{% 4324 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}} 4325\def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}} 4326 4327% Set the `txicommandconditionals' variable, so documents have a way to 4328% test if the @ifcommand...defined conditionals are available. 4329\set txicommandconditionals 4330 4331% @dircategory CATEGORY -- specify a category of the dir file 4332% which this file should belong to. Ignore this in TeX. 4333\let\dircategory=\comment 4334 4335% @defininfoenclose. 4336\let\definfoenclose=\comment 4337 4338 4339\message{indexing,} 4340% Index generation facilities 4341 4342% Define \newwrite to be identical to plain tex's \newwrite 4343% except not \outer, so it can be used within macros and \if's. 4344\edef\newwrite{\makecsname{ptexnewwrite}} 4345 4346% \newindex {foo} defines an index named foo. 4347% It automatically defines \fooindex such that 4348% \fooindex ...rest of line... puts an entry in the index foo. 4349% It also defines \fooindfile to be the number of the output channel for 4350% the file that accumulates this index. The file's extension is foo. 4351% The name of an index should be no more than 2 characters long 4352% for the sake of vms. 4353% 4354\def\newindex#1{% 4355 \iflinks 4356 \expandafter\newwrite \csname#1indfile\endcsname 4357 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file 4358 \fi 4359 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index 4360 \noexpand\doindex{#1}} 4361} 4362 4363% @defindex foo == \newindex{foo} 4364% 4365\def\defindex{\parsearg\newindex} 4366 4367% Define @defcodeindex, like @defindex except put all entries in @code. 4368% 4369\def\defcodeindex{\parsearg\newcodeindex} 4370% 4371\def\newcodeindex#1{% 4372 \iflinks 4373 \expandafter\newwrite \csname#1indfile\endcsname 4374 \openout \csname#1indfile\endcsname \jobname.#1 4375 \fi 4376 \expandafter\xdef\csname#1index\endcsname{% 4377 \noexpand\docodeindex{#1}}% 4378} 4379 4380 4381% @synindex foo bar makes index foo feed into index bar. 4382% Do this instead of @defindex foo if you don't want it as a separate index. 4383% 4384% @syncodeindex foo bar similar, but put all entries made for index foo 4385% inside @code. 4386% 4387\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} 4388\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} 4389 4390% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), 4391% #3 the target index (bar). 4392\def\dosynindex#1#2#3{% 4393 % Only do \closeout if we haven't already done it, else we'll end up 4394 % closing the target index. 4395 \expandafter \ifx\csname donesynindex#2\endcsname \relax 4396 % The \closeout helps reduce unnecessary open files; the limit on the 4397 % Acorn RISC OS is a mere 16 files. 4398 \expandafter\closeout\csname#2indfile\endcsname 4399 \expandafter\let\csname donesynindex#2\endcsname = 1 4400 \fi 4401 % redefine \fooindfile: 4402 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname 4403 \expandafter\let\csname#2indfile\endcsname=\temp 4404 % redefine \fooindex: 4405 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% 4406} 4407 4408% Define \doindex, the driver for all \fooindex macros. 4409% Argument #1 is generated by the calling \fooindex macro, 4410% and it is "foo", the name of the index. 4411 4412% \doindex just uses \parsearg; it calls \doind for the actual work. 4413% This is because \doind is more useful to call from other macros. 4414 4415% There is also \dosubind {index}{topic}{subtopic} 4416% which makes an entry in a two-level index such as the operation index. 4417 4418\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} 4419\def\singleindexer #1{\doind{\indexname}{#1}} 4420 4421% like the previous two, but they put @code around the argument. 4422\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} 4423\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} 4424 4425% Take care of Texinfo commands that can appear in an index entry. 4426% Since there are some commands we want to expand, and others we don't, 4427% we have to laboriously prevent expansion for those that we don't. 4428% 4429\def\indexdummies{% 4430 \escapechar = `\\ % use backslash in output files. 4431 \def\@{@}% change to @@ when we switch to @ as escape char in index files. 4432 \def\ {\realbackslash\space }% 4433 % 4434 % Need these unexpandable (because we define \tt as a dummy) 4435 % definitions when @{ or @} appear in index entry text. Also, more 4436 % complicated, when \tex is in effect and \{ is a \delimiter again. 4437 % We can't use \lbracecmd and \rbracecmd because texindex assumes 4438 % braces and backslashes are used only as delimiters. Perhaps we 4439 % should use @lbracechar and @rbracechar? 4440 \def\{{{\tt\char123}}% 4441 \def\}{{\tt\char125}}% 4442 % 4443 % I don't entirely understand this, but when an index entry is 4444 % generated from a macro call, the \endinput which \scanmacro inserts 4445 % causes processing to be prematurely terminated. This is, 4446 % apparently, because \indexsorttmp is fully expanded, and \endinput 4447 % is an expandable command. The redefinition below makes \endinput 4448 % disappear altogether for that purpose -- although logging shows that 4449 % processing continues to some further point. On the other hand, it 4450 % seems \endinput does not hurt in the printed index arg, since that 4451 % is still getting written without apparent harm. 4452 % 4453 % Sample source (mac-idx3.tex, reported by Graham Percival to 4454 % help-texinfo, 22may06): 4455 % @macro funindex {WORD} 4456 % @findex xyz 4457 % @end macro 4458 % ... 4459 % @funindex commtest 4460 % This is not enough to reproduce the bug, but it gives the flavor. 4461 % 4462 % Sample whatsit resulting: 4463 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}} 4464 % 4465 % So: 4466 \let\endinput = \empty 4467 % 4468 % Do the redefinitions. 4469 \commondummies 4470} 4471 4472% For the aux and toc files, @ is the escape character. So we want to 4473% redefine everything using @ as the escape character (instead of 4474% \realbackslash, still used for index files). When everything uses @, 4475% this will be simpler. 4476% 4477\def\atdummies{% 4478 \def\@{@@}% 4479 \def\ {@ }% 4480 \let\{ = \lbraceatcmd 4481 \let\} = \rbraceatcmd 4482 % 4483 % Do the redefinitions. 4484 \commondummies 4485 \otherbackslash 4486} 4487 4488% Called from \indexdummies and \atdummies. 4489% 4490\def\commondummies{% 4491 % 4492 % \definedummyword defines \#1 as \string\#1\space, thus effectively 4493 % preventing its expansion. This is used only for control words, 4494 % not control letters, because the \space would be incorrect for 4495 % control characters, but is needed to separate the control word 4496 % from whatever follows. 4497 % 4498 % For control letters, we have \definedummyletter, which omits the 4499 % space. 4500 % 4501 % These can be used both for control words that take an argument and 4502 % those that do not. If it is followed by {arg} in the input, then 4503 % that will dutifully get written to the index (or wherever). 4504 % 4505 \def\definedummyword ##1{\def##1{\string##1\space}}% 4506 \def\definedummyletter##1{\def##1{\string##1}}% 4507 \let\definedummyaccent\definedummyletter 4508 % 4509 \commondummiesnofonts 4510 % 4511 \definedummyletter\_% 4512 \definedummyletter\-% 4513 % 4514 % Non-English letters. 4515 \definedummyword\AA 4516 \definedummyword\AE 4517 \definedummyword\DH 4518 \definedummyword\L 4519 \definedummyword\O 4520 \definedummyword\OE 4521 \definedummyword\TH 4522 \definedummyword\aa 4523 \definedummyword\ae 4524 \definedummyword\dh 4525 \definedummyword\exclamdown 4526 \definedummyword\l 4527 \definedummyword\o 4528 \definedummyword\oe 4529 \definedummyword\ordf 4530 \definedummyword\ordm 4531 \definedummyword\questiondown 4532 \definedummyword\ss 4533 \definedummyword\th 4534 % 4535 % Although these internal commands shouldn't show up, sometimes they do. 4536 \definedummyword\bf 4537 \definedummyword\gtr 4538 \definedummyword\hat 4539 \definedummyword\less 4540 \definedummyword\sf 4541 \definedummyword\sl 4542 \definedummyword\tclose 4543 \definedummyword\tt 4544 % 4545 \definedummyword\LaTeX 4546 \definedummyword\TeX 4547 % 4548 % Assorted special characters. 4549 \definedummyword\arrow 4550 \definedummyword\bullet 4551 \definedummyword\comma 4552 \definedummyword\copyright 4553 \definedummyword\registeredsymbol 4554 \definedummyword\dots 4555 \definedummyword\enddots 4556 \definedummyword\entrybreak 4557 \definedummyword\equiv 4558 \definedummyword\error 4559 \definedummyword\euro 4560 \definedummyword\expansion 4561 \definedummyword\geq 4562 \definedummyword\guillemetleft 4563 \definedummyword\guillemetright 4564 \definedummyword\guilsinglleft 4565 \definedummyword\guilsinglright 4566 \definedummyword\lbracechar 4567 \definedummyword\leq 4568 \definedummyword\minus 4569 \definedummyword\ogonek 4570 \definedummyword\pounds 4571 \definedummyword\point 4572 \definedummyword\print 4573 \definedummyword\quotedblbase 4574 \definedummyword\quotedblleft 4575 \definedummyword\quotedblright 4576 \definedummyword\quoteleft 4577 \definedummyword\quoteright 4578 \definedummyword\quotesinglbase 4579 \definedummyword\rbracechar 4580 \definedummyword\result 4581 \definedummyword\textdegree 4582 % 4583 % We want to disable all macros so that they are not expanded by \write. 4584 \macrolist 4585 % 4586 \normalturnoffactive 4587 % 4588 % Handle some cases of @value -- where it does not contain any 4589 % (non-fully-expandable) commands. 4590 \makevalueexpandable 4591} 4592 4593% \commondummiesnofonts: common to \commondummies and \indexnofonts. 4594% 4595\def\commondummiesnofonts{% 4596 % Control letters and accents. 4597 \definedummyletter\!% 4598 \definedummyaccent\"% 4599 \definedummyaccent\'% 4600 \definedummyletter\*% 4601 \definedummyaccent\,% 4602 \definedummyletter\.% 4603 \definedummyletter\/% 4604 \definedummyletter\:% 4605 \definedummyaccent\=% 4606 \definedummyletter\?% 4607 \definedummyaccent\^% 4608 \definedummyaccent\`% 4609 \definedummyaccent\~% 4610 \definedummyword\u 4611 \definedummyword\v 4612 \definedummyword\H 4613 \definedummyword\dotaccent 4614 \definedummyword\ogonek 4615 \definedummyword\ringaccent 4616 \definedummyword\tieaccent 4617 \definedummyword\ubaraccent 4618 \definedummyword\udotaccent 4619 \definedummyword\dotless 4620 % 4621 % Texinfo font commands. 4622 \definedummyword\b 4623 \definedummyword\i 4624 \definedummyword\r 4625 \definedummyword\sansserif 4626 \definedummyword\sc 4627 \definedummyword\slanted 4628 \definedummyword\t 4629 % 4630 % Commands that take arguments. 4631 \definedummyword\abbr 4632 \definedummyword\acronym 4633 \definedummyword\anchor 4634 \definedummyword\cite 4635 \definedummyword\code 4636 \definedummyword\command 4637 \definedummyword\dfn 4638 \definedummyword\dmn 4639 \definedummyword\email 4640 \definedummyword\emph 4641 \definedummyword\env 4642 \definedummyword\file 4643 \definedummyword\image 4644 \definedummyword\indicateurl 4645 \definedummyword\inforef 4646 \definedummyword\kbd 4647 \definedummyword\key 4648 \definedummyword\math 4649 \definedummyword\option 4650 \definedummyword\pxref 4651 \definedummyword\ref 4652 \definedummyword\samp 4653 \definedummyword\strong 4654 \definedummyword\tie 4655 \definedummyword\uref 4656 \definedummyword\url 4657 \definedummyword\var 4658 \definedummyword\verb 4659 \definedummyword\w 4660 \definedummyword\xref 4661 % 4662 % Consider: 4663 % @macro mkind{arg1,arg2} 4664 % @cindex \arg2\ 4665 % @end macro 4666 % @mkind{foo, bar} 4667 % The space after the comma will end up in the temporary definition 4668 % that we make for arg2 (see \parsemargdef ff.). We want all this to be 4669 % expanded for the sake of the index, so we end up just seeing "bar". 4670 \let\xeatspaces = \eatspaces 4671} 4672 4673% For testing: output @{ and @} in index sort strings as \{ and \}. 4674\newif\ifusebracesinindexes 4675 4676% \indexnofonts is used when outputting the strings to sort the index 4677% by, and when constructing control sequence names. It eliminates all 4678% control sequences and just writes whatever the best ASCII sort string 4679% would be for a given command (usually its argument). 4680% 4681\def\indexnofonts{% 4682 % Accent commands should become @asis. 4683 \def\definedummyaccent##1{\let##1\asis}% 4684 % We can just ignore other control letters. 4685 \def\definedummyletter##1{\let##1\empty}% 4686 % All control words become @asis by default; overrides below. 4687 \let\definedummyword\definedummyaccent 4688 % 4689 \commondummiesnofonts 4690 % 4691 % Don't no-op \tt, since it isn't a user-level command 4692 % and is used in the definitions of the active chars like <, >, |, etc. 4693 % Likewise with the other plain tex font commands. 4694 %\let\tt=\asis 4695 % 4696 \def\ { }% 4697 \def\@{@}% 4698 \def\_{\normalunderscore}% 4699 \def\-{}% @- shouldn't affect sorting 4700 % 4701 % Unfortunately, texindex is not prepared to handle braces in the 4702 % content at all. So for index sorting, we map @{ and @} to strings 4703 % starting with |, since that ASCII character is between ASCII { and }. 4704 \ifusebracesinindexes 4705 \def\lbracechar{\lbracecmd}% 4706 \def\rbracechar{\rbracecmd}% 4707 \else 4708 \def\lbracechar{|a}% 4709 \def\rbracechar{|b}% 4710 \fi 4711 \let\{=\lbracechar 4712 \let\}=\rbracechar 4713 % 4714 % 4715 % Non-English letters. 4716 \def\AA{AA}% 4717 \def\AE{AE}% 4718 \def\DH{DZZ}% 4719 \def\L{L}% 4720 \def\OE{OE}% 4721 \def\O{O}% 4722 \def\TH{ZZZ}% 4723 \def\aa{aa}% 4724 \def\ae{ae}% 4725 \def\dh{dzz}% 4726 \def\exclamdown{!}% 4727 \def\l{l}% 4728 \def\oe{oe}% 4729 \def\ordf{a}% 4730 \def\ordm{o}% 4731 \def\o{o}% 4732 \def\questiondown{?}% 4733 \def\ss{ss}% 4734 \def\th{zzz}% 4735 % 4736 \def\LaTeX{LaTeX}% 4737 \def\TeX{TeX}% 4738 % 4739 % Assorted special characters. 4740 % (The following {} will end up in the sort string, but that's ok.) 4741 \def\arrow{->}% 4742 \def\bullet{bullet}% 4743 \def\comma{,}% 4744 \def\copyright{copyright}% 4745 \def\dots{...}% 4746 \def\enddots{...}% 4747 \def\equiv{==}% 4748 \def\error{error}% 4749 \def\euro{euro}% 4750 \def\expansion{==>}% 4751 \def\geq{>=}% 4752 \def\guillemetleft{<<}% 4753 \def\guillemetright{>>}% 4754 \def\guilsinglleft{<}% 4755 \def\guilsinglright{>}% 4756 \def\leq{<=}% 4757 \def\minus{-}% 4758 \def\point{.}% 4759 \def\pounds{pounds}% 4760 \def\print{-|}% 4761 \def\quotedblbase{"}% 4762 \def\quotedblleft{"}% 4763 \def\quotedblright{"}% 4764 \def\quoteleft{`}% 4765 \def\quoteright{'}% 4766 \def\quotesinglbase{,}% 4767 \def\registeredsymbol{R}% 4768 \def\result{=>}% 4769 \def\textdegree{o}% 4770 % 4771 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax 4772 \else \indexlquoteignore \fi 4773 % 4774 % We need to get rid of all macros, leaving only the arguments (if present). 4775 % Of course this is not nearly correct, but it is the best we can do for now. 4776 % makeinfo does not expand macros in the argument to @deffn, which ends up 4777 % writing an index entry, and texindex isn't prepared for an index sort entry 4778 % that starts with \. 4779 % 4780 % Since macro invocations are followed by braces, we can just redefine them 4781 % to take a single TeX argument. The case of a macro invocation that 4782 % goes to end-of-line is not handled. 4783 % 4784 \macrolist 4785} 4786 4787% Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us 4788% ignore left quotes in the sort term. 4789{\catcode`\`=\active 4790 \gdef\indexlquoteignore{\let`=\empty}} 4791 4792\let\indexbackslash=0 %overridden during \printindex. 4793\let\SETmarginindex=\relax % put index entries in margin (undocumented)? 4794 4795% Most index entries go through here, but \dosubind is the general case. 4796% #1 is the index name, #2 is the entry text. 4797\def\doind#1#2{\dosubind{#1}{#2}{}} 4798 4799% Workhorse for all \fooindexes. 4800% #1 is name of index, #2 is stuff to put there, #3 is subentry -- 4801% empty if called from \doind, as we usually are (the main exception 4802% is with most defuns, which call us directly). 4803% 4804\def\dosubind#1#2#3{% 4805 \iflinks 4806 {% 4807 % Store the main index entry text (including the third arg). 4808 \toks0 = {#2}% 4809 % If third arg is present, precede it with a space. 4810 \def\thirdarg{#3}% 4811 \ifx\thirdarg\empty \else 4812 \toks0 = \expandafter{\the\toks0 \space #3}% 4813 \fi 4814 % 4815 \edef\writeto{\csname#1indfile\endcsname}% 4816 % 4817 \safewhatsit\dosubindwrite 4818 }% 4819 \fi 4820} 4821 4822% Write the entry in \toks0 to the index file: 4823% 4824\def\dosubindwrite{% 4825 % Put the index entry in the margin if desired. 4826 \ifx\SETmarginindex\relax\else 4827 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% 4828 \fi 4829 % 4830 % Remember, we are within a group. 4831 \indexdummies % Must do this here, since \bf, etc expand at this stage 4832 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now 4833 % so it will be output as is; and it will print as backslash. 4834 % 4835 % Process the index entry with all font commands turned off, to 4836 % get the string to sort by. 4837 {\indexnofonts 4838 \edef\temp{\the\toks0}% need full expansion 4839 \xdef\indexsorttmp{\temp}% 4840 }% 4841 % 4842 % Set up the complete index entry, with both the sort key and 4843 % the original text, including any font commands. We write 4844 % three arguments to \entry to the .?? file (four in the 4845 % subentry case), texindex reduces to two when writing the .??s 4846 % sorted result. 4847 \edef\temp{% 4848 \write\writeto{% 4849 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% 4850 }% 4851 \temp 4852} 4853 4854% Take care of unwanted page breaks/skips around a whatsit: 4855% 4856% If a skip is the last thing on the list now, preserve it 4857% by backing up by \lastskip, doing the \write, then inserting 4858% the skip again. Otherwise, the whatsit generated by the 4859% \write or \pdfdest will make \lastskip zero. The result is that 4860% sequences like this: 4861% @end defun 4862% @tindex whatever 4863% @defun ... 4864% will have extra space inserted, because the \medbreak in the 4865% start of the @defun won't see the skip inserted by the @end of 4866% the previous defun. 4867% 4868% But don't do any of this if we're not in vertical mode. We 4869% don't want to do a \vskip and prematurely end a paragraph. 4870% 4871% Avoid page breaks due to these extra skips, too. 4872% 4873% But wait, there is a catch there: 4874% We'll have to check whether \lastskip is zero skip. \ifdim is not 4875% sufficient for this purpose, as it ignores stretch and shrink parts 4876% of the skip. The only way seems to be to check the textual 4877% representation of the skip. 4878% 4879% The following is almost like \def\zeroskipmacro{0.0pt} except that 4880% the ``p'' and ``t'' characters have catcode \other, not 11 (letter). 4881% 4882\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} 4883% 4884\newskip\whatsitskip 4885\newcount\whatsitpenalty 4886% 4887% ..., ready, GO: 4888% 4889\def\safewhatsit#1{\ifhmode 4890 #1% 4891 \else 4892 % \lastskip and \lastpenalty cannot both be nonzero simultaneously. 4893 \whatsitskip = \lastskip 4894 \edef\lastskipmacro{\the\lastskip}% 4895 \whatsitpenalty = \lastpenalty 4896 % 4897 % If \lastskip is nonzero, that means the last item was a 4898 % skip. And since a skip is discardable, that means this 4899 % -\whatsitskip glue we're inserting is preceded by a 4900 % non-discardable item, therefore it is not a potential 4901 % breakpoint, therefore no \nobreak needed. 4902 \ifx\lastskipmacro\zeroskipmacro 4903 \else 4904 \vskip-\whatsitskip 4905 \fi 4906 % 4907 #1% 4908 % 4909 \ifx\lastskipmacro\zeroskipmacro 4910 % If \lastskip was zero, perhaps the last item was a penalty, and 4911 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want 4912 % to re-insert the same penalty (values >10000 are used for various 4913 % signals); since we just inserted a non-discardable item, any 4914 % following glue (such as a \parskip) would be a breakpoint. For example: 4915 % @deffn deffn-whatever 4916 % @vindex index-whatever 4917 % Description. 4918 % would allow a break between the index-whatever whatsit 4919 % and the "Description." paragraph. 4920 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi 4921 \else 4922 % On the other hand, if we had a nonzero \lastskip, 4923 % this make-up glue would be preceded by a non-discardable item 4924 % (the whatsit from the \write), so we must insert a \nobreak. 4925 \nobreak\vskip\whatsitskip 4926 \fi 4927\fi} 4928 4929% The index entry written in the file actually looks like 4930% \entry {sortstring}{page}{topic} 4931% or 4932% \entry {sortstring}{page}{topic}{subtopic} 4933% The texindex program reads in these files and writes files 4934% containing these kinds of lines: 4935% \initial {c} 4936% before the first topic whose initial is c 4937% \entry {topic}{pagelist} 4938% for a topic that is used without subtopics 4939% \primary {topic} 4940% for the beginning of a topic that is used with subtopics 4941% \secondary {subtopic}{pagelist} 4942% for each subtopic. 4943 4944% Define the user-accessible indexing commands 4945% @findex, @vindex, @kindex, @cindex. 4946 4947\def\findex {\fnindex} 4948\def\kindex {\kyindex} 4949\def\cindex {\cpindex} 4950\def\vindex {\vrindex} 4951\def\tindex {\tpindex} 4952\def\pindex {\pgindex} 4953 4954\def\cindexsub {\begingroup\obeylines\cindexsub} 4955{\obeylines % 4956\gdef\cindexsub "#1" #2^^M{\endgroup % 4957\dosubind{cp}{#2}{#1}}} 4958 4959% Define the macros used in formatting output of the sorted index material. 4960 4961% @printindex causes a particular index (the ??s file) to get printed. 4962% It does not print any chapter heading (usually an @unnumbered). 4963% 4964\parseargdef\printindex{\begingroup 4965 \dobreak \chapheadingskip{10000}% 4966 % 4967 \smallfonts \rm 4968 \tolerance = 9500 4969 \plainfrenchspacing 4970 \everypar = {}% don't want the \kern\-parindent from indentation suppression. 4971 % 4972 % See if the index file exists and is nonempty. 4973 % Change catcode of @ here so that if the index file contains 4974 % \initial {@} 4975 % as its first line, TeX doesn't complain about mismatched braces 4976 % (because it thinks @} is a control sequence). 4977 \catcode`\@ = 11 4978 \openin 1 \jobname.#1s 4979 \ifeof 1 4980 % \enddoublecolumns gets confused if there is no text in the index, 4981 % and it loses the chapter title and the aux file entries for the 4982 % index. The easiest way to prevent this problem is to make sure 4983 % there is some text. 4984 \putwordIndexNonexistent 4985 \else 4986 % 4987 % If the index file exists but is empty, then \openin leaves \ifeof 4988 % false. We have to make TeX try to read something from the file, so 4989 % it can discover if there is anything in it. 4990 \read 1 to \temp 4991 \ifeof 1 4992 \putwordIndexIsEmpty 4993 \else 4994 % Index files are almost Texinfo source, but we use \ as the escape 4995 % character. It would be better to use @, but that's too big a change 4996 % to make right now. 4997 \def\indexbackslash{\backslashcurfont}% 4998 \catcode`\\ = 0 4999 \escapechar = `\\ 5000 \begindoublecolumns 5001 \input \jobname.#1s 5002 \enddoublecolumns 5003 \fi 5004 \fi 5005 \closein 1 5006\endgroup} 5007 5008% These macros are used by the sorted index file itself. 5009% Change them to control the appearance of the index. 5010 5011\def\initial#1{{% 5012 % Some minor font changes for the special characters. 5013 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt 5014 % 5015 % Remove any glue we may have, we'll be inserting our own. 5016 \removelastskip 5017 % 5018 % We like breaks before the index initials, so insert a bonus. 5019 \nobreak 5020 \vskip 0pt plus 3\baselineskip 5021 \penalty 0 5022 \vskip 0pt plus -3\baselineskip 5023 % 5024 % Typeset the initial. Making this add up to a whole number of 5025 % baselineskips increases the chance of the dots lining up from column 5026 % to column. It still won't often be perfect, because of the stretch 5027 % we need before each entry, but it's better. 5028 % 5029 % No shrink because it confuses \balancecolumns. 5030 \vskip 1.67\baselineskip plus .5\baselineskip 5031 \leftline{\secbf #1}% 5032 % Do our best not to break after the initial. 5033 \nobreak 5034 \vskip .33\baselineskip plus .1\baselineskip 5035}} 5036 5037% \entry typesets a paragraph consisting of the text (#1), dot leaders, and 5038% then page number (#2) flushed to the right margin. It is used for index 5039% and table of contents entries. The paragraph is indented by \leftskip. 5040% 5041% A straightforward implementation would start like this: 5042% \def\entry#1#2{... 5043% But this freezes the catcodes in the argument, and can cause problems to 5044% @code, which sets - active. This problem was fixed by a kludge--- 5045% ``-'' was active throughout whole index, but this isn't really right. 5046% The right solution is to prevent \entry from swallowing the whole text. 5047% --kasal, 21nov03 5048\def\entry{% 5049 \begingroup 5050 % 5051 % Start a new paragraph if necessary, so our assignments below can't 5052 % affect previous text. 5053 \par 5054 % 5055 % Do not fill out the last line with white space. 5056 \parfillskip = 0in 5057 % 5058 % No extra space above this paragraph. 5059 \parskip = 0in 5060 % 5061 % Do not prefer a separate line ending with a hyphen to fewer lines. 5062 \finalhyphendemerits = 0 5063 % 5064 % \hangindent is only relevant when the entry text and page number 5065 % don't both fit on one line. In that case, bob suggests starting the 5066 % dots pretty far over on the line. Unfortunately, a large 5067 % indentation looks wrong when the entry text itself is broken across 5068 % lines. So we use a small indentation and put up with long leaders. 5069 % 5070 % \hangafter is reset to 1 (which is the value we want) at the start 5071 % of each paragraph, so we need not do anything with that. 5072 \hangindent = 2em 5073 % 5074 % When the entry text needs to be broken, just fill out the first line 5075 % with blank space. 5076 \rightskip = 0pt plus1fil 5077 % 5078 % A bit of stretch before each entry for the benefit of balancing 5079 % columns. 5080 \vskip 0pt plus1pt 5081 % 5082 % When reading the text of entry, convert explicit line breaks 5083 % from @* into spaces. The user might give these in long section 5084 % titles, for instance. 5085 \def\*{\unskip\space\ignorespaces}% 5086 \def\entrybreak{\hfil\break}% 5087 % 5088 % Swallow the left brace of the text (first parameter): 5089 \afterassignment\doentry 5090 \let\temp = 5091} 5092\def\entrybreak{\unskip\space\ignorespaces}% 5093\def\doentry{% 5094 \bgroup % Instead of the swallowed brace. 5095 \noindent 5096 \aftergroup\finishentry 5097 % And now comes the text of the entry. 5098} 5099\def\finishentry#1{% 5100 % #1 is the page number. 5101 % 5102 % The following is kludged to not output a line of dots in the index if 5103 % there are no page numbers. The next person who breaks this will be 5104 % cursed by a Unix daemon. 5105 \setbox\boxA = \hbox{#1}% 5106 \ifdim\wd\boxA = 0pt 5107 \ % 5108 \else 5109 % 5110 % If we must, put the page number on a line of its own, and fill out 5111 % this line with blank space. (The \hfil is overwhelmed with the 5112 % fill leaders glue in \indexdotfill if the page number does fit.) 5113 \hfil\penalty50 5114 \null\nobreak\indexdotfill % Have leaders before the page number. 5115 % 5116 % The `\ ' here is removed by the implicit \unskip that TeX does as 5117 % part of (the primitive) \par. Without it, a spurious underfull 5118 % \hbox ensues. 5119 \ifpdf 5120 \pdfgettoks#1.% 5121 \ \the\toksA 5122 \else 5123 \ #1% 5124 \fi 5125 \fi 5126 \par 5127 \endgroup 5128} 5129 5130% Like plain.tex's \dotfill, except uses up at least 1 em. 5131\def\indexdotfill{\cleaders 5132 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill} 5133 5134\def\primary #1{\line{#1\hfil}} 5135 5136\newskip\secondaryindent \secondaryindent=0.5cm 5137\def\secondary#1#2{{% 5138 \parfillskip=0in 5139 \parskip=0in 5140 \hangindent=1in 5141 \hangafter=1 5142 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill 5143 \ifpdf 5144 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. 5145 \else 5146 #2 5147 \fi 5148 \par 5149}} 5150 5151% Define two-column mode, which we use to typeset indexes. 5152% Adapted from the TeXbook, page 416, which is to say, 5153% the manmac.tex format used to print the TeXbook itself. 5154\catcode`\@=11 5155 5156\newbox\partialpage 5157\newdimen\doublecolumnhsize 5158 5159\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns 5160 % Grab any single-column material above us. 5161 \output = {% 5162 % 5163 % Here is a possibility not foreseen in manmac: if we accumulate a 5164 % whole lot of material, we might end up calling this \output 5165 % routine twice in a row (see the doublecol-lose test, which is 5166 % essentially a couple of indexes with @setchapternewpage off). In 5167 % that case we just ship out what is in \partialpage with the normal 5168 % output routine. Generally, \partialpage will be empty when this 5169 % runs and this will be a no-op. See the indexspread.tex test case. 5170 \ifvoid\partialpage \else 5171 \onepageout{\pagecontents\partialpage}% 5172 \fi 5173 % 5174 \global\setbox\partialpage = \vbox{% 5175 % Unvbox the main output page. 5176 \unvbox\PAGE 5177 \kern-\topskip \kern\baselineskip 5178 }% 5179 }% 5180 \eject % run that output routine to set \partialpage 5181 % 5182 % Use the double-column output routine for subsequent pages. 5183 \output = {\doublecolumnout}% 5184 % 5185 % Change the page size parameters. We could do this once outside this 5186 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 5187 % format, but then we repeat the same computation. Repeating a couple 5188 % of assignments once per index is clearly meaningless for the 5189 % execution time, so we may as well do it in one place. 5190 % 5191 % First we halve the line length, less a little for the gutter between 5192 % the columns. We compute the gutter based on the line length, so it 5193 % changes automatically with the paper format. The magic constant 5194 % below is chosen so that the gutter has the same value (well, +-<1pt) 5195 % as it did when we hard-coded it. 5196 % 5197 % We put the result in a separate register, \doublecolumhsize, so we 5198 % can restore it in \pagesofar, after \hsize itself has (potentially) 5199 % been clobbered. 5200 % 5201 \doublecolumnhsize = \hsize 5202 \advance\doublecolumnhsize by -.04154\hsize 5203 \divide\doublecolumnhsize by 2 5204 \hsize = \doublecolumnhsize 5205 % 5206 % Double the \vsize as well. (We don't need a separate register here, 5207 % since nobody clobbers \vsize.) 5208 \vsize = 2\vsize 5209} 5210 5211% The double-column output routine for all double-column pages except 5212% the last. 5213% 5214\def\doublecolumnout{% 5215 \splittopskip=\topskip \splitmaxdepth=\maxdepth 5216 % Get the available space for the double columns -- the normal 5217 % (undoubled) page height minus any material left over from the 5218 % previous page. 5219 \dimen@ = \vsize 5220 \divide\dimen@ by 2 5221 \advance\dimen@ by -\ht\partialpage 5222 % 5223 % box0 will be the left-hand column, box2 the right. 5224 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ 5225 \onepageout\pagesofar 5226 \unvbox255 5227 \penalty\outputpenalty 5228} 5229% 5230% Re-output the contents of the output page -- any previous material, 5231% followed by the two boxes we just split, in box0 and box2. 5232\def\pagesofar{% 5233 \unvbox\partialpage 5234 % 5235 \hsize = \doublecolumnhsize 5236 \wd0=\hsize \wd2=\hsize 5237 \hbox to\pagewidth{\box0\hfil\box2}% 5238} 5239% 5240% All done with double columns. 5241\def\enddoublecolumns{% 5242 % The following penalty ensures that the page builder is exercised 5243 % _before_ we change the output routine. This is necessary in the 5244 % following situation: 5245 % 5246 % The last section of the index consists only of a single entry. 5247 % Before this section, \pagetotal is less than \pagegoal, so no 5248 % break occurs before the last section starts. However, the last 5249 % section, consisting of \initial and the single \entry, does not 5250 % fit on the page and has to be broken off. Without the following 5251 % penalty the page builder will not be exercised until \eject 5252 % below, and by that time we'll already have changed the output 5253 % routine to the \balancecolumns version, so the next-to-last 5254 % double-column page will be processed with \balancecolumns, which 5255 % is wrong: The two columns will go to the main vertical list, with 5256 % the broken-off section in the recent contributions. As soon as 5257 % the output routine finishes, TeX starts reconsidering the page 5258 % break. The two columns and the broken-off section both fit on the 5259 % page, because the two columns now take up only half of the page 5260 % goal. When TeX sees \eject from below which follows the final 5261 % section, it invokes the new output routine that we've set after 5262 % \balancecolumns below; \onepageout will try to fit the two columns 5263 % and the final section into the vbox of \pageheight (see 5264 % \pagebody), causing an overfull box. 5265 % 5266 % Note that glue won't work here, because glue does not exercise the 5267 % page builder, unlike penalties (see The TeXbook, pp. 280-281). 5268 \penalty0 5269 % 5270 \output = {% 5271 % Split the last of the double-column material. Leave it on the 5272 % current page, no automatic page break. 5273 \balancecolumns 5274 % 5275 % If we end up splitting too much material for the current page, 5276 % though, there will be another page break right after this \output 5277 % invocation ends. Having called \balancecolumns once, we do not 5278 % want to call it again. Therefore, reset \output to its normal 5279 % definition right away. (We hope \balancecolumns will never be 5280 % called on to balance too much material, but if it is, this makes 5281 % the output somewhat more palatable.) 5282 \global\output = {\onepageout{\pagecontents\PAGE}}% 5283 }% 5284 \eject 5285 \endgroup % started in \begindoublecolumns 5286 % 5287 % \pagegoal was set to the doubled \vsize above, since we restarted 5288 % the current page. We're now back to normal single-column 5289 % typesetting, so reset \pagegoal to the normal \vsize (after the 5290 % \endgroup where \vsize got restored). 5291 \pagegoal = \vsize 5292} 5293% 5294% Called at the end of the double column material. 5295\def\balancecolumns{% 5296 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. 5297 \dimen@ = \ht0 5298 \advance\dimen@ by \topskip 5299 \advance\dimen@ by-\baselineskip 5300 \divide\dimen@ by 2 % target to split to 5301 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% 5302 \splittopskip = \topskip 5303 % Loop until we get a decent breakpoint. 5304 {% 5305 \vbadness = 10000 5306 \loop 5307 \global\setbox3 = \copy0 5308 \global\setbox1 = \vsplit3 to \dimen@ 5309 \ifdim\ht3>\dimen@ 5310 \global\advance\dimen@ by 1pt 5311 \repeat 5312 }% 5313 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% 5314 \setbox0=\vbox to\dimen@{\unvbox1}% 5315 \setbox2=\vbox to\dimen@{\unvbox3}% 5316 % 5317 \pagesofar 5318} 5319\catcode`\@ = \other 5320 5321 5322\message{sectioning,} 5323% Chapters, sections, etc. 5324 5325% Let's start with @part. 5326\outer\parseargdef\part{\partzzz{#1}} 5327\def\partzzz#1{% 5328 \chapoddpage 5329 \null 5330 \vskip.3\vsize % move it down on the page a bit 5331 \begingroup 5332 \noindent \titlefonts\rmisbold #1\par % the text 5333 \let\lastnode=\empty % no node to associate with 5334 \writetocentry{part}{#1}{}% but put it in the toc 5335 \headingsoff % no headline or footline on the part page 5336 \chapoddpage 5337 \endgroup 5338} 5339 5340% \unnumberedno is an oxymoron. But we count the unnumbered 5341% sections so that we can refer to them unambiguously in the pdf 5342% outlines by their "section number". We avoid collisions with chapter 5343% numbers by starting them at 10000. (If a document ever has 10000 5344% chapters, we're in trouble anyway, I'm sure.) 5345\newcount\unnumberedno \unnumberedno = 10000 5346\newcount\chapno 5347\newcount\secno \secno=0 5348\newcount\subsecno \subsecno=0 5349\newcount\subsubsecno \subsubsecno=0 5350 5351% This counter is funny since it counts through charcodes of letters A, B, ... 5352\newcount\appendixno \appendixno = `\@ 5353% 5354% \def\appendixletter{\char\the\appendixno} 5355% We do the following ugly conditional instead of the above simple 5356% construct for the sake of pdftex, which needs the actual 5357% letter in the expansion, not just typeset. 5358% 5359\def\appendixletter{% 5360 \ifnum\appendixno=`A A% 5361 \else\ifnum\appendixno=`B B% 5362 \else\ifnum\appendixno=`C C% 5363 \else\ifnum\appendixno=`D D% 5364 \else\ifnum\appendixno=`E E% 5365 \else\ifnum\appendixno=`F F% 5366 \else\ifnum\appendixno=`G G% 5367 \else\ifnum\appendixno=`H H% 5368 \else\ifnum\appendixno=`I I% 5369 \else\ifnum\appendixno=`J J% 5370 \else\ifnum\appendixno=`K K% 5371 \else\ifnum\appendixno=`L L% 5372 \else\ifnum\appendixno=`M M% 5373 \else\ifnum\appendixno=`N N% 5374 \else\ifnum\appendixno=`O O% 5375 \else\ifnum\appendixno=`P P% 5376 \else\ifnum\appendixno=`Q Q% 5377 \else\ifnum\appendixno=`R R% 5378 \else\ifnum\appendixno=`S S% 5379 \else\ifnum\appendixno=`T T% 5380 \else\ifnum\appendixno=`U U% 5381 \else\ifnum\appendixno=`V V% 5382 \else\ifnum\appendixno=`W W% 5383 \else\ifnum\appendixno=`X X% 5384 \else\ifnum\appendixno=`Y Y% 5385 \else\ifnum\appendixno=`Z Z% 5386 % The \the is necessary, despite appearances, because \appendixletter is 5387 % expanded while writing the .toc file. \char\appendixno is not 5388 % expandable, thus it is written literally, thus all appendixes come out 5389 % with the same letter (or @) in the toc without it. 5390 \else\char\the\appendixno 5391 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 5392 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} 5393 5394% Each @chapter defines these (using marks) as the number+name, number 5395% and name of the chapter. Page headings and footings can use 5396% these. @section does likewise. 5397\def\thischapter{} 5398\def\thischapternum{} 5399\def\thischaptername{} 5400\def\thissection{} 5401\def\thissectionnum{} 5402\def\thissectionname{} 5403 5404\newcount\absseclevel % used to calculate proper heading level 5405\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count 5406 5407% @raisesections: treat @section as chapter, @subsection as section, etc. 5408\def\raisesections{\global\advance\secbase by -1} 5409\let\up=\raisesections % original BFox name 5410 5411% @lowersections: treat @chapter as section, @section as subsection, etc. 5412\def\lowersections{\global\advance\secbase by 1} 5413\let\down=\lowersections % original BFox name 5414 5415% we only have subsub. 5416\chardef\maxseclevel = 3 5417% 5418% A numbered section within an unnumbered changes to unnumbered too. 5419% To achieve this, remember the "biggest" unnum. sec. we are currently in: 5420\chardef\unnlevel = \maxseclevel 5421% 5422% Trace whether the current chapter is an appendix or not: 5423% \chapheadtype is "N" or "A", unnumbered chapters are ignored. 5424\def\chapheadtype{N} 5425 5426% Choose a heading macro 5427% #1 is heading type 5428% #2 is heading level 5429% #3 is text for heading 5430\def\genhead#1#2#3{% 5431 % Compute the abs. sec. level: 5432 \absseclevel=#2 5433 \advance\absseclevel by \secbase 5434 % Make sure \absseclevel doesn't fall outside the range: 5435 \ifnum \absseclevel < 0 5436 \absseclevel = 0 5437 \else 5438 \ifnum \absseclevel > 3 5439 \absseclevel = 3 5440 \fi 5441 \fi 5442 % The heading type: 5443 \def\headtype{#1}% 5444 \if \headtype U% 5445 \ifnum \absseclevel < \unnlevel 5446 \chardef\unnlevel = \absseclevel 5447 \fi 5448 \else 5449 % Check for appendix sections: 5450 \ifnum \absseclevel = 0 5451 \edef\chapheadtype{\headtype}% 5452 \else 5453 \if \headtype A\if \chapheadtype N% 5454 \errmessage{@appendix... within a non-appendix chapter}% 5455 \fi\fi 5456 \fi 5457 % Check for numbered within unnumbered: 5458 \ifnum \absseclevel > \unnlevel 5459 \def\headtype{U}% 5460 \else 5461 \chardef\unnlevel = 3 5462 \fi 5463 \fi 5464 % Now print the heading: 5465 \if \headtype U% 5466 \ifcase\absseclevel 5467 \unnumberedzzz{#3}% 5468 \or \unnumberedseczzz{#3}% 5469 \or \unnumberedsubseczzz{#3}% 5470 \or \unnumberedsubsubseczzz{#3}% 5471 \fi 5472 \else 5473 \if \headtype A% 5474 \ifcase\absseclevel 5475 \appendixzzz{#3}% 5476 \or \appendixsectionzzz{#3}% 5477 \or \appendixsubseczzz{#3}% 5478 \or \appendixsubsubseczzz{#3}% 5479 \fi 5480 \else 5481 \ifcase\absseclevel 5482 \chapterzzz{#3}% 5483 \or \seczzz{#3}% 5484 \or \numberedsubseczzz{#3}% 5485 \or \numberedsubsubseczzz{#3}% 5486 \fi 5487 \fi 5488 \fi 5489 \suppressfirstparagraphindent 5490} 5491 5492% an interface: 5493\def\numhead{\genhead N} 5494\def\apphead{\genhead A} 5495\def\unnmhead{\genhead U} 5496 5497% @chapter, @appendix, @unnumbered. Increment top-level counter, reset 5498% all lower-level sectioning counters to zero. 5499% 5500% Also set \chaplevelprefix, which we prepend to @float sequence numbers 5501% (e.g., figures), q.v. By default (before any chapter), that is empty. 5502\let\chaplevelprefix = \empty 5503% 5504\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz 5505\def\chapterzzz#1{% 5506 % section resetting is \global in case the chapter is in a group, such 5507 % as an @include file. 5508 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 5509 \global\advance\chapno by 1 5510 % 5511 % Used for \float. 5512 \gdef\chaplevelprefix{\the\chapno.}% 5513 \resetallfloatnos 5514 % 5515 % \putwordChapter can contain complex things in translations. 5516 \toks0=\expandafter{\putwordChapter}% 5517 \message{\the\toks0 \space \the\chapno}% 5518 % 5519 % Write the actual heading. 5520 \chapmacro{#1}{Ynumbered}{\the\chapno}% 5521 % 5522 % So @section and the like are numbered underneath this chapter. 5523 \global\let\section = \numberedsec 5524 \global\let\subsection = \numberedsubsec 5525 \global\let\subsubsection = \numberedsubsubsec 5526} 5527 5528\outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz 5529% 5530\def\appendixzzz#1{% 5531 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 5532 \global\advance\appendixno by 1 5533 \gdef\chaplevelprefix{\appendixletter.}% 5534 \resetallfloatnos 5535 % 5536 % \putwordAppendix can contain complex things in translations. 5537 \toks0=\expandafter{\putwordAppendix}% 5538 \message{\the\toks0 \space \appendixletter}% 5539 % 5540 \chapmacro{#1}{Yappendix}{\appendixletter}% 5541 % 5542 \global\let\section = \appendixsec 5543 \global\let\subsection = \appendixsubsec 5544 \global\let\subsubsection = \appendixsubsubsec 5545} 5546 5547% normally unnmhead0 calls unnumberedzzz: 5548\outer\parseargdef\unnumbered{\unnmhead0{#1}} 5549\def\unnumberedzzz#1{% 5550 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 5551 \global\advance\unnumberedno by 1 5552 % 5553 % Since an unnumbered has no number, no prefix for figures. 5554 \global\let\chaplevelprefix = \empty 5555 \resetallfloatnos 5556 % 5557 % This used to be simply \message{#1}, but TeX fully expands the 5558 % argument to \message. Therefore, if #1 contained @-commands, TeX 5559 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX 5560 % expanded @cite (which turns out to cause errors because \cite is meant 5561 % to be executed, not expanded). 5562 % 5563 % Anyway, we don't want the fully-expanded definition of @cite to appear 5564 % as a result of the \message, we just want `@cite' itself. We use 5565 % \the<toks register> to achieve this: TeX expands \the<toks> only once, 5566 % simply yielding the contents of <toks register>. (We also do this for 5567 % the toc entries.) 5568 \toks0 = {#1}% 5569 \message{(\the\toks0)}% 5570 % 5571 \chapmacro{#1}{Ynothing}{\the\unnumberedno}% 5572 % 5573 \global\let\section = \unnumberedsec 5574 \global\let\subsection = \unnumberedsubsec 5575 \global\let\subsubsection = \unnumberedsubsubsec 5576} 5577 5578% @centerchap is like @unnumbered, but the heading is centered. 5579\outer\parseargdef\centerchap{% 5580 % Well, we could do the following in a group, but that would break 5581 % an assumption that \chapmacro is called at the outermost level. 5582 % Thus we are safer this way: --kasal, 24feb04 5583 \let\centerparametersmaybe = \centerparameters 5584 \unnmhead0{#1}% 5585 \let\centerparametersmaybe = \relax 5586} 5587 5588% @top is like @unnumbered. 5589\let\top\unnumbered 5590 5591% Sections. 5592% 5593\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz 5594\def\seczzz#1{% 5595 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 5596 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% 5597} 5598 5599% normally calls appendixsectionzzz: 5600\outer\parseargdef\appendixsection{\apphead1{#1}} 5601\def\appendixsectionzzz#1{% 5602 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 5603 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% 5604} 5605\let\appendixsec\appendixsection 5606 5607% normally calls unnumberedseczzz: 5608\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} 5609\def\unnumberedseczzz#1{% 5610 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 5611 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% 5612} 5613 5614% Subsections. 5615% 5616% normally calls numberedsubseczzz: 5617\outer\parseargdef\numberedsubsec{\numhead2{#1}} 5618\def\numberedsubseczzz#1{% 5619 \global\subsubsecno=0 \global\advance\subsecno by 1 5620 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% 5621} 5622 5623% normally calls appendixsubseczzz: 5624\outer\parseargdef\appendixsubsec{\apphead2{#1}} 5625\def\appendixsubseczzz#1{% 5626 \global\subsubsecno=0 \global\advance\subsecno by 1 5627 \sectionheading{#1}{subsec}{Yappendix}% 5628 {\appendixletter.\the\secno.\the\subsecno}% 5629} 5630 5631% normally calls unnumberedsubseczzz: 5632\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} 5633\def\unnumberedsubseczzz#1{% 5634 \global\subsubsecno=0 \global\advance\subsecno by 1 5635 \sectionheading{#1}{subsec}{Ynothing}% 5636 {\the\unnumberedno.\the\secno.\the\subsecno}% 5637} 5638 5639% Subsubsections. 5640% 5641% normally numberedsubsubseczzz: 5642\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} 5643\def\numberedsubsubseczzz#1{% 5644 \global\advance\subsubsecno by 1 5645 \sectionheading{#1}{subsubsec}{Ynumbered}% 5646 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% 5647} 5648 5649% normally appendixsubsubseczzz: 5650\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} 5651\def\appendixsubsubseczzz#1{% 5652 \global\advance\subsubsecno by 1 5653 \sectionheading{#1}{subsubsec}{Yappendix}% 5654 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% 5655} 5656 5657% normally unnumberedsubsubseczzz: 5658\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} 5659\def\unnumberedsubsubseczzz#1{% 5660 \global\advance\subsubsecno by 1 5661 \sectionheading{#1}{subsubsec}{Ynothing}% 5662 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% 5663} 5664 5665% These macros control what the section commands do, according 5666% to what kind of chapter we are in (ordinary, appendix, or unnumbered). 5667% Define them by default for a numbered chapter. 5668\let\section = \numberedsec 5669\let\subsection = \numberedsubsec 5670\let\subsubsection = \numberedsubsubsec 5671 5672% Define @majorheading, @heading and @subheading 5673 5674\def\majorheading{% 5675 {\advance\chapheadingskip by 10pt \chapbreak }% 5676 \parsearg\chapheadingzzz 5677} 5678 5679\def\chapheading{\chapbreak \parsearg\chapheadingzzz} 5680\def\chapheadingzzz#1{% 5681 \vbox{\chapfonts \raggedtitlesettings #1\par}% 5682 \nobreak\bigskip \nobreak 5683 \suppressfirstparagraphindent 5684} 5685 5686% @heading, @subheading, @subsubheading. 5687\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} 5688 \suppressfirstparagraphindent} 5689\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} 5690 \suppressfirstparagraphindent} 5691\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} 5692 \suppressfirstparagraphindent} 5693 5694% These macros generate a chapter, section, etc. heading only 5695% (including whitespace, linebreaking, etc. around it), 5696% given all the information in convenient, parsed form. 5697 5698% Args are the skip and penalty (usually negative) 5699\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} 5700 5701% Parameter controlling skip before chapter headings (if needed) 5702\newskip\chapheadingskip 5703 5704% Define plain chapter starts, and page on/off switching for it. 5705\def\chapbreak{\dobreak \chapheadingskip {-4000}} 5706\def\chappager{\par\vfill\supereject} 5707% Because \domark is called before \chapoddpage, the filler page will 5708% get the headings for the next chapter, which is wrong. But we don't 5709% care -- we just disable all headings on the filler page. 5710\def\chapoddpage{% 5711 \chappager 5712 \ifodd\pageno \else 5713 \begingroup 5714 \headingsoff 5715 \null 5716 \chappager 5717 \endgroup 5718 \fi 5719} 5720 5721\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} 5722 5723\def\CHAPPAGoff{% 5724\global\let\contentsalignmacro = \chappager 5725\global\let\pchapsepmacro=\chapbreak 5726\global\let\pagealignmacro=\chappager} 5727 5728\def\CHAPPAGon{% 5729\global\let\contentsalignmacro = \chappager 5730\global\let\pchapsepmacro=\chappager 5731\global\let\pagealignmacro=\chappager 5732\global\def\HEADINGSon{\HEADINGSsingle}} 5733 5734\def\CHAPPAGodd{% 5735\global\let\contentsalignmacro = \chapoddpage 5736\global\let\pchapsepmacro=\chapoddpage 5737\global\let\pagealignmacro=\chapoddpage 5738\global\def\HEADINGSon{\HEADINGSdouble}} 5739 5740\CHAPPAGon 5741 5742% Chapter opening. 5743% 5744% #1 is the text, #2 is the section type (Ynumbered, Ynothing, 5745% Yappendix, Yomitfromtoc), #3 the chapter number. 5746% Not used for @heading series. 5747% 5748% To test against our argument. 5749\def\Ynothingkeyword{Ynothing} 5750\def\Yappendixkeyword{Yappendix} 5751\def\Yomitfromtockeyword{Yomitfromtoc} 5752% 5753\def\chapmacro#1#2#3{% 5754 \checkenv{}% chapters, etc., should not start inside an environment. 5755 % 5756 % Insert the first mark before the heading break (see notes for \domark). 5757 \let\prevchapterdefs=\lastchapterdefs 5758 \let\prevsectiondefs=\lastsectiondefs 5759 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}% 5760 \gdef\thissection{}}% 5761 % 5762 \def\temptype{#2}% 5763 \ifx\temptype\Ynothingkeyword 5764 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% 5765 \gdef\thischapter{\thischaptername}}% 5766 \else\ifx\temptype\Yomitfromtockeyword 5767 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% 5768 \gdef\thischapter{}}% 5769 \else\ifx\temptype\Yappendixkeyword 5770 \toks0={#1}% 5771 \xdef\lastchapterdefs{% 5772 \gdef\noexpand\thischaptername{\the\toks0}% 5773 \gdef\noexpand\thischapternum{\appendixletter}% 5774 % \noexpand\putwordAppendix avoids expanding indigestible 5775 % commands in some of the translations. 5776 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{} 5777 \noexpand\thischapternum: 5778 \noexpand\thischaptername}% 5779 }% 5780 \else 5781 \toks0={#1}% 5782 \xdef\lastchapterdefs{% 5783 \gdef\noexpand\thischaptername{\the\toks0}% 5784 \gdef\noexpand\thischapternum{\the\chapno}% 5785 % \noexpand\putwordChapter avoids expanding indigestible 5786 % commands in some of the translations. 5787 \gdef\noexpand\thischapter{\noexpand\putwordChapter{} 5788 \noexpand\thischapternum: 5789 \noexpand\thischaptername}% 5790 }% 5791 \fi\fi\fi 5792 % 5793 % Output the mark. Pass it through \safewhatsit, to take care of 5794 % the preceding space. 5795 \safewhatsit\domark 5796 % 5797 % Insert the chapter heading break. 5798 \pchapsepmacro 5799 % 5800 % Now the second mark, after the heading break. No break points 5801 % between here and the heading. 5802 \let\prevchapterdefs=\lastchapterdefs 5803 \let\prevsectiondefs=\lastsectiondefs 5804 \domark 5805 % 5806 {% 5807 \chapfonts \rmisbold 5808 \let\footnote=\errfootnoteheading % give better error message 5809 % 5810 % Have to define \lastsection before calling \donoderef, because the 5811 % xref code eventually uses it. On the other hand, it has to be called 5812 % after \pchapsepmacro, or the headline will change too soon. 5813 \gdef\lastsection{#1}% 5814 % 5815 % Only insert the separating space if we have a chapter/appendix 5816 % number, and don't print the unnumbered ``number''. 5817 \ifx\temptype\Ynothingkeyword 5818 \setbox0 = \hbox{}% 5819 \def\toctype{unnchap}% 5820 \else\ifx\temptype\Yomitfromtockeyword 5821 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry 5822 \def\toctype{omit}% 5823 \else\ifx\temptype\Yappendixkeyword 5824 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% 5825 \def\toctype{app}% 5826 \else 5827 \setbox0 = \hbox{#3\enspace}% 5828 \def\toctype{numchap}% 5829 \fi\fi\fi 5830 % 5831 % Write the toc entry for this chapter. Must come before the 5832 % \donoderef, because we include the current node name in the toc 5833 % entry, and \donoderef resets it to empty. 5834 \writetocentry{\toctype}{#1}{#3}% 5835 % 5836 % For pdftex, we have to write out the node definition (aka, make 5837 % the pdfdest) after any page break, but before the actual text has 5838 % been typeset. If the destination for the pdf outline is after the 5839 % text, then jumping from the outline may wind up with the text not 5840 % being visible, for instance under high magnification. 5841 \donoderef{#2}% 5842 % 5843 % Typeset the actual heading. 5844 \nobreak % Avoid page breaks at the interline glue. 5845 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe 5846 \unhbox0 #1\par}% 5847 }% 5848 \nobreak\bigskip % no page break after a chapter title 5849 \nobreak 5850} 5851 5852% @centerchap -- centered and unnumbered. 5853\let\centerparametersmaybe = \relax 5854\def\centerparameters{% 5855 \advance\rightskip by 3\rightskip 5856 \leftskip = \rightskip 5857 \parfillskip = 0pt 5858} 5859 5860 5861% I don't think this chapter style is supported any more, so I'm not 5862% updating it with the new noderef stuff. We'll see. --karl, 11aug03. 5863% 5864\def\setchapterstyle #1 {\csname CHAPF#1\endcsname} 5865% 5866\def\unnchfopen #1{% 5867 \chapoddpage 5868 \vbox{\chapfonts \raggedtitlesettings #1\par}% 5869 \nobreak\bigskip\nobreak 5870} 5871\def\chfopen #1#2{\chapoddpage {\chapfonts 5872\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% 5873\par\penalty 5000 % 5874} 5875\def\centerchfopen #1{% 5876 \chapoddpage 5877 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}% 5878 \nobreak\bigskip \nobreak 5879} 5880\def\CHAPFopen{% 5881 \global\let\chapmacro=\chfopen 5882 \global\let\centerchapmacro=\centerchfopen} 5883 5884 5885% Section titles. These macros combine the section number parts and 5886% call the generic \sectionheading to do the printing. 5887% 5888\newskip\secheadingskip 5889\def\secheadingbreak{\dobreak \secheadingskip{-1000}} 5890 5891% Subsection titles. 5892\newskip\subsecheadingskip 5893\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} 5894 5895% Subsubsection titles. 5896\def\subsubsecheadingskip{\subsecheadingskip} 5897\def\subsubsecheadingbreak{\subsecheadingbreak} 5898 5899 5900% Print any size, any type, section title. 5901% 5902% #1 is the text of the title, 5903% #2 is the section level (sec/subsec/subsubsec), 5904% #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc), 5905% #4 is the section number. 5906% 5907\def\seckeyword{sec} 5908% 5909\def\sectionheading#1#2#3#4{% 5910 {% 5911 \def\sectionlevel{#2}% 5912 \def\temptype{#3}% 5913 % 5914 % It is ok for the @heading series commands to appear inside an 5915 % environment (it's been historically allowed, though the logic is 5916 % dubious), but not the others. 5917 \ifx\temptype\Yomitfromtockeyword\else 5918 \checkenv{}% non-@*heading should not be in an environment. 5919 \fi 5920 \let\footnote=\errfootnoteheading 5921 % 5922 % Switch to the right set of fonts. 5923 \csname #2fonts\endcsname \rmisbold 5924 % 5925 % Insert first mark before the heading break (see notes for \domark). 5926 \let\prevsectiondefs=\lastsectiondefs 5927 \ifx\temptype\Ynothingkeyword 5928 \ifx\sectionlevel\seckeyword 5929 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}% 5930 \gdef\thissection{\thissectionname}}% 5931 \fi 5932 \else\ifx\temptype\Yomitfromtockeyword 5933 % Don't redefine \thissection. 5934 \else\ifx\temptype\Yappendixkeyword 5935 \ifx\sectionlevel\seckeyword 5936 \toks0={#1}% 5937 \xdef\lastsectiondefs{% 5938 \gdef\noexpand\thissectionname{\the\toks0}% 5939 \gdef\noexpand\thissectionnum{#4}% 5940 % \noexpand\putwordSection avoids expanding indigestible 5941 % commands in some of the translations. 5942 \gdef\noexpand\thissection{\noexpand\putwordSection{} 5943 \noexpand\thissectionnum: 5944 \noexpand\thissectionname}% 5945 }% 5946 \fi 5947 \else 5948 \ifx\sectionlevel\seckeyword 5949 \toks0={#1}% 5950 \xdef\lastsectiondefs{% 5951 \gdef\noexpand\thissectionname{\the\toks0}% 5952 \gdef\noexpand\thissectionnum{#4}% 5953 % \noexpand\putwordSection avoids expanding indigestible 5954 % commands in some of the translations. 5955 \gdef\noexpand\thissection{\noexpand\putwordSection{} 5956 \noexpand\thissectionnum: 5957 \noexpand\thissectionname}% 5958 }% 5959 \fi 5960 \fi\fi\fi 5961 % 5962 % Go into vertical mode. Usually we'll already be there, but we 5963 % don't want the following whatsit to end up in a preceding paragraph 5964 % if the document didn't happen to have a blank line. 5965 \par 5966 % 5967 % Output the mark. Pass it through \safewhatsit, to take care of 5968 % the preceding space. 5969 \safewhatsit\domark 5970 % 5971 % Insert space above the heading. 5972 \csname #2headingbreak\endcsname 5973 % 5974 % Now the second mark, after the heading break. No break points 5975 % between here and the heading. 5976 \global\let\prevsectiondefs=\lastsectiondefs 5977 \domark 5978 % 5979 % Only insert the space after the number if we have a section number. 5980 \ifx\temptype\Ynothingkeyword 5981 \setbox0 = \hbox{}% 5982 \def\toctype{unn}% 5983 \gdef\lastsection{#1}% 5984 \else\ifx\temptype\Yomitfromtockeyword 5985 % for @headings -- no section number, don't include in toc, 5986 % and don't redefine \lastsection. 5987 \setbox0 = \hbox{}% 5988 \def\toctype{omit}% 5989 \let\sectionlevel=\empty 5990 \else\ifx\temptype\Yappendixkeyword 5991 \setbox0 = \hbox{#4\enspace}% 5992 \def\toctype{app}% 5993 \gdef\lastsection{#1}% 5994 \else 5995 \setbox0 = \hbox{#4\enspace}% 5996 \def\toctype{num}% 5997 \gdef\lastsection{#1}% 5998 \fi\fi\fi 5999 % 6000 % Write the toc entry (before \donoderef). See comments in \chapmacro. 6001 \writetocentry{\toctype\sectionlevel}{#1}{#4}% 6002 % 6003 % Write the node reference (= pdf destination for pdftex). 6004 % Again, see comments in \chapmacro. 6005 \donoderef{#3}% 6006 % 6007 % Interline glue will be inserted when the vbox is completed. 6008 % That glue will be a valid breakpoint for the page, since it'll be 6009 % preceded by a whatsit (usually from the \donoderef, or from the 6010 % \writetocentry if there was no node). We don't want to allow that 6011 % break, since then the whatsits could end up on page n while the 6012 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000. 6013 \nobreak 6014 % 6015 % Output the actual section heading. 6016 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright 6017 \hangindent=\wd0 % zero if no section number 6018 \unhbox0 #1}% 6019 }% 6020 % Add extra space after the heading -- half of whatever came above it. 6021 % Don't allow stretch, though. 6022 \kern .5 \csname #2headingskip\endcsname 6023 % 6024 % Do not let the kern be a potential breakpoint, as it would be if it 6025 % was followed by glue. 6026 \nobreak 6027 % 6028 % We'll almost certainly start a paragraph next, so don't let that 6029 % glue accumulate. (Not a breakpoint because it's preceded by a 6030 % discardable item.) However, when a paragraph is not started next 6031 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out 6032 % or the negative glue will cause weirdly wrong output, typically 6033 % obscuring the section heading with something else. 6034 \vskip-\parskip 6035 % 6036 % This is so the last item on the main vertical list is a known 6037 % \penalty > 10000, so \startdefun, etc., can recognize the situation 6038 % and do the needful. 6039 \penalty 10001 6040} 6041 6042 6043\message{toc,} 6044% Table of contents. 6045\newwrite\tocfile 6046 6047% Write an entry to the toc file, opening it if necessary. 6048% Called from @chapter, etc. 6049% 6050% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} 6051% We append the current node name (if any) and page number as additional 6052% arguments for the \{chap,sec,...}entry macros which will eventually 6053% read this. The node name is used in the pdf outlines as the 6054% destination to jump to. 6055% 6056% We open the .toc file for writing here instead of at @setfilename (or 6057% any other fixed time) so that @contents can be anywhere in the document. 6058% But if #1 is `omit', then we don't do anything. This is used for the 6059% table of contents chapter openings themselves. 6060% 6061\newif\iftocfileopened 6062\def\omitkeyword{omit}% 6063% 6064\def\writetocentry#1#2#3{% 6065 \edef\writetoctype{#1}% 6066 \ifx\writetoctype\omitkeyword \else 6067 \iftocfileopened\else 6068 \immediate\openout\tocfile = \jobname.toc 6069 \global\tocfileopenedtrue 6070 \fi 6071 % 6072 \iflinks 6073 {\atdummies 6074 \edef\temp{% 6075 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}% 6076 \temp 6077 }% 6078 \fi 6079 \fi 6080 % 6081 % Tell \shipout to create a pdf destination on each page, if we're 6082 % writing pdf. These are used in the table of contents. We can't 6083 % just write one on every page because the title pages are numbered 6084 % 1 and 2 (the page numbers aren't printed), and so are the first 6085 % two pages of the document. Thus, we'd have two destinations named 6086 % `1', and two named `2'. 6087 \ifpdf \global\pdfmakepagedesttrue \fi 6088} 6089 6090 6091% These characters do not print properly in the Computer Modern roman 6092% fonts, so we must take special care. This is more or less redundant 6093% with the Texinfo input format setup at the end of this file. 6094% 6095\def\activecatcodes{% 6096 \catcode`\"=\active 6097 \catcode`\$=\active 6098 \catcode`\<=\active 6099 \catcode`\>=\active 6100 \catcode`\\=\active 6101 \catcode`\^=\active 6102 \catcode`\_=\active 6103 \catcode`\|=\active 6104 \catcode`\~=\active 6105} 6106 6107 6108% Read the toc file, which is essentially Texinfo input. 6109\def\readtocfile{% 6110 \setupdatafile 6111 \activecatcodes 6112 \input \tocreadfilename 6113} 6114 6115\newskip\contentsrightmargin \contentsrightmargin=1in 6116\newcount\savepageno 6117\newcount\lastnegativepageno \lastnegativepageno = -1 6118 6119% Prepare to read what we've written to \tocfile. 6120% 6121\def\startcontents#1{% 6122 % If @setchapternewpage on, and @headings double, the contents should 6123 % start on an odd page, unlike chapters. Thus, we maintain 6124 % \contentsalignmacro in parallel with \pagealignmacro. 6125 % From: Torbjorn Granlund <tege@matematik.su.se> 6126 \contentsalignmacro 6127 \immediate\closeout\tocfile 6128 % 6129 % Don't need to put `Contents' or `Short Contents' in the headline. 6130 % It is abundantly clear what they are. 6131 \chapmacro{#1}{Yomitfromtoc}{}% 6132 % 6133 \savepageno = \pageno 6134 \begingroup % Set up to handle contents files properly. 6135 \raggedbottom % Worry more about breakpoints than the bottom. 6136 \advance\hsize by -\contentsrightmargin % Don't use the full line length. 6137 % 6138 % Roman numerals for page numbers. 6139 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi 6140} 6141 6142% redefined for the two-volume lispref. We always output on 6143% \jobname.toc even if this is redefined. 6144% 6145\def\tocreadfilename{\jobname.toc} 6146 6147% Normal (long) toc. 6148% 6149\def\contents{% 6150 \startcontents{\putwordTOC}% 6151 \openin 1 \tocreadfilename\space 6152 \ifeof 1 \else 6153 \readtocfile 6154 \fi 6155 \vfill \eject 6156 \contentsalignmacro % in case @setchapternewpage odd is in effect 6157 \ifeof 1 \else 6158 \pdfmakeoutlines 6159 \fi 6160 \closein 1 6161 \endgroup 6162 \lastnegativepageno = \pageno 6163 \global\pageno = \savepageno 6164} 6165 6166% And just the chapters. 6167\def\summarycontents{% 6168 \startcontents{\putwordShortTOC}% 6169 % 6170 \let\partentry = \shortpartentry 6171 \let\numchapentry = \shortchapentry 6172 \let\appentry = \shortchapentry 6173 \let\unnchapentry = \shortunnchapentry 6174 % We want a true roman here for the page numbers. 6175 \secfonts 6176 \let\rm=\shortcontrm \let\bf=\shortcontbf 6177 \let\sl=\shortcontsl \let\tt=\shortconttt 6178 \rm 6179 \hyphenpenalty = 10000 6180 \advance\baselineskip by 1pt % Open it up a little. 6181 \def\numsecentry##1##2##3##4{} 6182 \let\appsecentry = \numsecentry 6183 \let\unnsecentry = \numsecentry 6184 \let\numsubsecentry = \numsecentry 6185 \let\appsubsecentry = \numsecentry 6186 \let\unnsubsecentry = \numsecentry 6187 \let\numsubsubsecentry = \numsecentry 6188 \let\appsubsubsecentry = \numsecentry 6189 \let\unnsubsubsecentry = \numsecentry 6190 \openin 1 \tocreadfilename\space 6191 \ifeof 1 \else 6192 \readtocfile 6193 \fi 6194 \closein 1 6195 \vfill \eject 6196 \contentsalignmacro % in case @setchapternewpage odd is in effect 6197 \endgroup 6198 \lastnegativepageno = \pageno 6199 \global\pageno = \savepageno 6200} 6201\let\shortcontents = \summarycontents 6202 6203% Typeset the label for a chapter or appendix for the short contents. 6204% The arg is, e.g., `A' for an appendix, or `3' for a chapter. 6205% 6206\def\shortchaplabel#1{% 6207 % This space should be enough, since a single number is .5em, and the 6208 % widest letter (M) is 1em, at least in the Computer Modern fonts. 6209 % But use \hss just in case. 6210 % (This space doesn't include the extra space that gets added after 6211 % the label; that gets put in by \shortchapentry above.) 6212 % 6213 % We'd like to right-justify chapter numbers, but that looks strange 6214 % with appendix letters. And right-justifying numbers and 6215 % left-justifying letters looks strange when there is less than 10 6216 % chapters. Have to read the whole toc once to know how many chapters 6217 % there are before deciding ... 6218 \hbox to 1em{#1\hss}% 6219} 6220 6221% These macros generate individual entries in the table of contents. 6222% The first argument is the chapter or section name. 6223% The last argument is the page number. 6224% The arguments in between are the chapter number, section number, ... 6225 6226% Parts, in the main contents. Replace the part number, which doesn't 6227% exist, with an empty box. Let's hope all the numbers have the same width. 6228% Also ignore the page number, which is conventionally not printed. 6229\def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}} 6230\def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}} 6231% 6232% Parts, in the short toc. 6233\def\shortpartentry#1#2#3#4{% 6234 \penalty-300 6235 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip 6236 \shortchapentry{{\bf #1}}{\numeralbox}{}{}% 6237} 6238 6239% Chapters, in the main contents. 6240\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} 6241% 6242% Chapters, in the short toc. 6243% See comments in \dochapentry re vbox and related settings. 6244\def\shortchapentry#1#2#3#4{% 6245 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% 6246} 6247 6248% Appendices, in the main contents. 6249% Need the word Appendix, and a fixed-size box. 6250% 6251\def\appendixbox#1{% 6252 % We use M since it's probably the widest letter. 6253 \setbox0 = \hbox{\putwordAppendix{} M}% 6254 \hbox to \wd0{\putwordAppendix{} #1\hss}} 6255% 6256\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} 6257 6258% Unnumbered chapters. 6259\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} 6260\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} 6261 6262% Sections. 6263\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} 6264\let\appsecentry=\numsecentry 6265\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} 6266 6267% Subsections. 6268\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} 6269\let\appsubsecentry=\numsubsecentry 6270\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} 6271 6272% And subsubsections. 6273\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} 6274\let\appsubsubsecentry=\numsubsubsecentry 6275\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} 6276 6277% This parameter controls the indentation of the various levels. 6278% Same as \defaultparindent. 6279\newdimen\tocindent \tocindent = 15pt 6280 6281% Now for the actual typesetting. In all these, #1 is the text and #2 is the 6282% page number. 6283% 6284% If the toc has to be broken over pages, we want it to be at chapters 6285% if at all possible; hence the \penalty. 6286\def\dochapentry#1#2{% 6287 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip 6288 \begingroup 6289 \chapentryfonts 6290 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 6291 \endgroup 6292 \nobreak\vskip .25\baselineskip plus.1\baselineskip 6293} 6294 6295\def\dosecentry#1#2{\begingroup 6296 \secentryfonts \leftskip=\tocindent 6297 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 6298\endgroup} 6299 6300\def\dosubsecentry#1#2{\begingroup 6301 \subsecentryfonts \leftskip=2\tocindent 6302 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 6303\endgroup} 6304 6305\def\dosubsubsecentry#1#2{\begingroup 6306 \subsubsecentryfonts \leftskip=3\tocindent 6307 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 6308\endgroup} 6309 6310% We use the same \entry macro as for the index entries. 6311\let\tocentry = \entry 6312 6313% Space between chapter (or whatever) number and the title. 6314\def\labelspace{\hskip1em \relax} 6315 6316\def\dopageno#1{{\rm #1}} 6317\def\doshortpageno#1{{\rm #1}} 6318 6319\def\chapentryfonts{\secfonts \rm} 6320\def\secentryfonts{\textfonts} 6321\def\subsecentryfonts{\textfonts} 6322\def\subsubsecentryfonts{\textfonts} 6323 6324 6325\message{environments,} 6326% @foo ... @end foo. 6327 6328% @tex ... @end tex escapes into raw TeX temporarily. 6329% One exception: @ is still an escape character, so that @end tex works. 6330% But \@ or @@ will get a plain @ character. 6331 6332\envdef\tex{% 6333 \setupmarkupstyle{tex}% 6334 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 6335 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 6336 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie 6337 \catcode `\%=14 6338 \catcode `\+=\other 6339 \catcode `\"=\other 6340 \catcode `\|=\other 6341 \catcode `\<=\other 6342 \catcode `\>=\other 6343 \catcode `\`=\other 6344 \catcode `\'=\other 6345 \escapechar=`\\ 6346 % 6347 % ' is active in math mode (mathcode"8000). So reset it, and all our 6348 % other math active characters (just in case), to plain's definitions. 6349 \mathactive 6350 % 6351 % Inverse of the list at the beginning of the file. 6352 \let\b=\ptexb 6353 \let\bullet=\ptexbullet 6354 \let\c=\ptexc 6355 \let\,=\ptexcomma 6356 \let\.=\ptexdot 6357 \let\dots=\ptexdots 6358 \let\equiv=\ptexequiv 6359 \let\!=\ptexexclam 6360 \let\i=\ptexi 6361 \let\indent=\ptexindent 6362 \let\noindent=\ptexnoindent 6363 \let\{=\ptexlbrace 6364 \let\+=\tabalign 6365 \let\}=\ptexrbrace 6366 \let\/=\ptexslash 6367 \let\sp=\ptexsp 6368 \let\*=\ptexstar 6369 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode 6370 \let\t=\ptext 6371 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer 6372 \let\frenchspacing=\plainfrenchspacing 6373 % 6374 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% 6375 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% 6376 \def\@{@}% 6377} 6378% There is no need to define \Etex. 6379 6380% Define @lisp ... @end lisp. 6381% @lisp environment forms a group so it can rebind things, 6382% including the definition of @end lisp (which normally is erroneous). 6383 6384% Amount to narrow the margins by for @lisp. 6385\newskip\lispnarrowing \lispnarrowing=0.4in 6386 6387% This is the definition that ^^M gets inside @lisp, @example, and other 6388% such environments. \null is better than a space, since it doesn't 6389% have any width. 6390\def\lisppar{\null\endgraf} 6391 6392% This space is always present above and below environments. 6393\newskip\envskipamount \envskipamount = 0pt 6394 6395% Make spacing and below environment symmetrical. We use \parskip here 6396% to help in doing that, since in @example-like environments \parskip 6397% is reset to zero; thus the \afterenvbreak inserts no space -- but the 6398% start of the next paragraph will insert \parskip. 6399% 6400\def\aboveenvbreak{{% 6401 % =10000 instead of <10000 because of a special case in \itemzzz and 6402 % \sectionheading, q.v. 6403 \ifnum \lastpenalty=10000 \else 6404 \advance\envskipamount by \parskip 6405 \endgraf 6406 \ifdim\lastskip<\envskipamount 6407 \removelastskip 6408 % it's not a good place to break if the last penalty was \nobreak 6409 % or better ... 6410 \ifnum\lastpenalty<10000 \penalty-50 \fi 6411 \vskip\envskipamount 6412 \fi 6413 \fi 6414}} 6415 6416\let\afterenvbreak = \aboveenvbreak 6417 6418% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will 6419% also clear it, so that its embedded environments do the narrowing again. 6420\let\nonarrowing=\relax 6421 6422% @cartouche ... @end cartouche: draw rectangle w/rounded corners around 6423% environment contents. 6424\font\circle=lcircle10 6425\newdimen\circthick 6426\newdimen\cartouter\newdimen\cartinner 6427\newskip\normbskip\newskip\normpskip\newskip\normlskip 6428\circthick=\fontdimen8\circle 6429% 6430\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth 6431\def\ctr{{\hskip 6pt\circle\char'010}} 6432\def\cbl{{\circle\char'012\hskip -6pt}} 6433\def\cbr{{\hskip 6pt\circle\char'011}} 6434\def\carttop{\hbox to \cartouter{\hskip\lskip 6435 \ctl\leaders\hrule height\circthick\hfil\ctr 6436 \hskip\rskip}} 6437\def\cartbot{\hbox to \cartouter{\hskip\lskip 6438 \cbl\leaders\hrule height\circthick\hfil\cbr 6439 \hskip\rskip}} 6440% 6441\newskip\lskip\newskip\rskip 6442 6443\envdef\cartouche{% 6444 \ifhmode\par\fi % can't be in the midst of a paragraph. 6445 \startsavinginserts 6446 \lskip=\leftskip \rskip=\rightskip 6447 \leftskip=0pt\rightskip=0pt % we want these *outside*. 6448 \cartinner=\hsize \advance\cartinner by-\lskip 6449 \advance\cartinner by-\rskip 6450 \cartouter=\hsize 6451 \advance\cartouter by 18.4pt % allow for 3pt kerns on either 6452 % side, and for 6pt waste from 6453 % each corner char, and rule thickness 6454 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip 6455 % 6456 % If this cartouche directly follows a sectioning command, we need the 6457 % \parskip glue (backspaced over by default) or the cartouche can 6458 % collide with the section heading. 6459 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi 6460 % 6461 \vbox\bgroup 6462 \baselineskip=0pt\parskip=0pt\lineskip=0pt 6463 \carttop 6464 \hbox\bgroup 6465 \hskip\lskip 6466 \vrule\kern3pt 6467 \vbox\bgroup 6468 \kern3pt 6469 \hsize=\cartinner 6470 \baselineskip=\normbskip 6471 \lineskip=\normlskip 6472 \parskip=\normpskip 6473 \vskip -\parskip 6474 \comment % For explanation, see the end of def\group. 6475} 6476\def\Ecartouche{% 6477 \ifhmode\par\fi 6478 \kern3pt 6479 \egroup 6480 \kern3pt\vrule 6481 \hskip\rskip 6482 \egroup 6483 \cartbot 6484 \egroup 6485 \checkinserts 6486} 6487 6488 6489% This macro is called at the beginning of all the @example variants, 6490% inside a group. 6491\newdimen\nonfillparindent 6492\def\nonfillstart{% 6493 \aboveenvbreak 6494 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy 6495 \sepspaces % Make spaces be word-separators rather than space tokens. 6496 \let\par = \lisppar % don't ignore blank lines 6497 \obeylines % each line of input is a line of output 6498 \parskip = 0pt 6499 % Turn off paragraph indentation but redefine \indent to emulate 6500 % the normal \indent. 6501 \nonfillparindent=\parindent 6502 \parindent = 0pt 6503 \let\indent\nonfillindent 6504 % 6505 \emergencystretch = 0pt % don't try to avoid overfull boxes 6506 \ifx\nonarrowing\relax 6507 \advance \leftskip by \lispnarrowing 6508 \exdentamount=\lispnarrowing 6509 \else 6510 \let\nonarrowing = \relax 6511 \fi 6512 \let\exdent=\nofillexdent 6513} 6514 6515\begingroup 6516\obeyspaces 6517% We want to swallow spaces (but not other tokens) after the fake 6518% @indent in our nonfill-environments, where spaces are normally 6519% active and set to @tie, resulting in them not being ignored after 6520% @indent. 6521\gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}% 6522\gdef\nonfillindentcheck{% 6523\ifx\temp % 6524\expandafter\nonfillindentgobble% 6525\else% 6526\leavevmode\nonfillindentbox% 6527\fi% 6528}% 6529\endgroup 6530\def\nonfillindentgobble#1{\nonfillindent} 6531\def\nonfillindentbox{\hbox to \nonfillparindent{\hss}} 6532 6533% If you want all examples etc. small: @set dispenvsize small. 6534% If you want even small examples the full size: @set dispenvsize nosmall. 6535% This affects the following displayed environments: 6536% @example, @display, @format, @lisp 6537% 6538\def\smallword{small} 6539\def\nosmallword{nosmall} 6540\let\SETdispenvsize\relax 6541\def\setnormaldispenv{% 6542 \ifx\SETdispenvsize\smallword 6543 % end paragraph for sake of leading, in case document has no blank 6544 % line. This is redundant with what happens in \aboveenvbreak, but 6545 % we need to do it before changing the fonts, and it's inconvenient 6546 % to change the fonts afterward. 6547 \ifnum \lastpenalty=10000 \else \endgraf \fi 6548 \smallexamplefonts \rm 6549 \fi 6550} 6551\def\setsmalldispenv{% 6552 \ifx\SETdispenvsize\nosmallword 6553 \else 6554 \ifnum \lastpenalty=10000 \else \endgraf \fi 6555 \smallexamplefonts \rm 6556 \fi 6557} 6558 6559% We often define two environments, @foo and @smallfoo. 6560% Let's do it in one command. #1 is the env name, #2 the definition. 6561\def\makedispenvdef#1#2{% 6562 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}% 6563 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}% 6564 \expandafter\let\csname E#1\endcsname \afterenvbreak 6565 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak 6566} 6567 6568% Define two environment synonyms (#1 and #2) for an environment. 6569\def\maketwodispenvdef#1#2#3{% 6570 \makedispenvdef{#1}{#3}% 6571 \makedispenvdef{#2}{#3}% 6572} 6573% 6574% @lisp: indented, narrowed, typewriter font; 6575% @example: same as @lisp. 6576% 6577% @smallexample and @smalllisp: use smaller fonts. 6578% Originally contributed by Pavel@xerox. 6579% 6580\maketwodispenvdef{lisp}{example}{% 6581 \nonfillstart 6582 \tt\setupmarkupstyle{example}% 6583 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. 6584 \gobble % eat return 6585} 6586% @display/@smalldisplay: same as @lisp except keep current font. 6587% 6588\makedispenvdef{display}{% 6589 \nonfillstart 6590 \gobble 6591} 6592 6593% @format/@smallformat: same as @display except don't narrow margins. 6594% 6595\makedispenvdef{format}{% 6596 \let\nonarrowing = t% 6597 \nonfillstart 6598 \gobble 6599} 6600 6601% @flushleft: same as @format, but doesn't obey \SETdispenvsize. 6602\envdef\flushleft{% 6603 \let\nonarrowing = t% 6604 \nonfillstart 6605 \gobble 6606} 6607\let\Eflushleft = \afterenvbreak 6608 6609% @flushright. 6610% 6611\envdef\flushright{% 6612 \let\nonarrowing = t% 6613 \nonfillstart 6614 \advance\leftskip by 0pt plus 1fill\relax 6615 \gobble 6616} 6617\let\Eflushright = \afterenvbreak 6618 6619 6620% @raggedright does more-or-less normal line breaking but no right 6621% justification. From plain.tex. Don't stretch around special 6622% characters in urls in this environment, since the stretch at the right 6623% should be enough. 6624\envdef\raggedright{% 6625 \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax 6626 \def\urefprestretchamount{0pt}% 6627 \def\urefpoststretchamount{0pt}% 6628} 6629\let\Eraggedright\par 6630 6631\envdef\raggedleft{% 6632 \parindent=0pt \leftskip0pt plus2em 6633 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt 6634 \hbadness=10000 % Last line will usually be underfull, so turn off 6635 % badness reporting. 6636} 6637\let\Eraggedleft\par 6638 6639\envdef\raggedcenter{% 6640 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em 6641 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt 6642 \hbadness=10000 % Last line will usually be underfull, so turn off 6643 % badness reporting. 6644} 6645\let\Eraggedcenter\par 6646 6647 6648% @quotation does normal linebreaking (hence we can't use \nonfillstart) 6649% and narrows the margins. We keep \parskip nonzero in general, since 6650% we're doing normal filling. So, when using \aboveenvbreak and 6651% \afterenvbreak, temporarily make \parskip 0. 6652% 6653\makedispenvdef{quotation}{\quotationstart} 6654% 6655\def\quotationstart{% 6656 \indentedblockstart % same as \indentedblock, but increase right margin too. 6657 \ifx\nonarrowing\relax 6658 \advance\rightskip by \lispnarrowing 6659 \fi 6660 \parsearg\quotationlabel 6661} 6662 6663% We have retained a nonzero parskip for the environment, since we're 6664% doing normal filling. 6665% 6666\def\Equotation{% 6667 \par 6668 \ifx\quotationauthor\thisisundefined\else 6669 % indent a bit. 6670 \leftline{\kern 2\leftskip \sl ---\quotationauthor}% 6671 \fi 6672 {\parskip=0pt \afterenvbreak}% 6673} 6674\def\Esmallquotation{\Equotation} 6675 6676% If we're given an argument, typeset it in bold with a colon after. 6677\def\quotationlabel#1{% 6678 \def\temp{#1}% 6679 \ifx\temp\empty \else 6680 {\bf #1: }% 6681 \fi 6682} 6683 6684% @indentedblock is like @quotation, but indents only on the left and 6685% has no optional argument. 6686% 6687\makedispenvdef{indentedblock}{\indentedblockstart} 6688% 6689\def\indentedblockstart{% 6690 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip 6691 \parindent=0pt 6692 % 6693 % @cartouche defines \nonarrowing to inhibit narrowing at next level down. 6694 \ifx\nonarrowing\relax 6695 \advance\leftskip by \lispnarrowing 6696 \exdentamount = \lispnarrowing 6697 \else 6698 \let\nonarrowing = \relax 6699 \fi 6700} 6701 6702% Keep a nonzero parskip for the environment, since we're doing normal filling. 6703% 6704\def\Eindentedblock{% 6705 \par 6706 {\parskip=0pt \afterenvbreak}% 6707} 6708\def\Esmallindentedblock{\Eindentedblock} 6709 6710 6711% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} 6712% If we want to allow any <char> as delimiter, 6713% we need the curly braces so that makeinfo sees the @verb command, eg: 6714% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org 6715% 6716% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. 6717% 6718% [Knuth] p.344; only we need to do the other characters Texinfo sets 6719% active too. Otherwise, they get lost as the first character on a 6720% verbatim line. 6721\def\dospecials{% 6722 \do\ \do\\\do\{\do\}\do\$\do\&% 6723 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% 6724 \do\<\do\>\do\|\do\@\do+\do\"% 6725 % Don't do the quotes -- if we do, @set txicodequoteundirected and 6726 % @set txicodequotebacktick will not have effect on @verb and 6727 % @verbatim, and ?` and !` ligatures won't get disabled. 6728 %\do\`\do\'% 6729} 6730% 6731% [Knuth] p. 380 6732\def\uncatcodespecials{% 6733 \def\do##1{\catcode`##1=\other}\dospecials} 6734% 6735% Setup for the @verb command. 6736% 6737% Eight spaces for a tab 6738\begingroup 6739 \catcode`\^^I=\active 6740 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} 6741\endgroup 6742% 6743\def\setupverb{% 6744 \tt % easiest (and conventionally used) font for verbatim 6745 \def\par{\leavevmode\endgraf}% 6746 \setupmarkupstyle{verb}% 6747 \tabeightspaces 6748 % Respect line breaks, 6749 % print special symbols as themselves, and 6750 % make each space count 6751 % must do in this order: 6752 \obeylines \uncatcodespecials \sepspaces 6753} 6754 6755% Setup for the @verbatim environment 6756% 6757% Real tab expansion. 6758\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount 6759% 6760% We typeset each line of the verbatim in an \hbox, so we can handle 6761% tabs. The \global is in case the verbatim line starts with an accent, 6762% or some other command that starts with a begin-group. Otherwise, the 6763% entire \verbbox would disappear at the corresponding end-group, before 6764% it is typeset. Meanwhile, we can't have nested verbatim commands 6765% (can we?), so the \global won't be overwriting itself. 6766\newbox\verbbox 6767\def\starttabbox{\global\setbox\verbbox=\hbox\bgroup} 6768% 6769\begingroup 6770 \catcode`\^^I=\active 6771 \gdef\tabexpand{% 6772 \catcode`\^^I=\active 6773 \def^^I{\leavevmode\egroup 6774 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab 6775 \divide\dimen\verbbox by\tabw 6776 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw 6777 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw 6778 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox 6779 }% 6780 } 6781\endgroup 6782 6783% start the verbatim environment. 6784\def\setupverbatim{% 6785 \let\nonarrowing = t% 6786 \nonfillstart 6787 \tt % easiest (and conventionally used) font for verbatim 6788 % The \leavevmode here is for blank lines. Otherwise, we would 6789 % never \starttabox and the \egroup would end verbatim mode. 6790 \def\par{\leavevmode\egroup\box\verbbox\endgraf}% 6791 \tabexpand 6792 \setupmarkupstyle{verbatim}% 6793 % Respect line breaks, 6794 % print special symbols as themselves, and 6795 % make each space count. 6796 % Must do in this order: 6797 \obeylines \uncatcodespecials \sepspaces 6798 \everypar{\starttabbox}% 6799} 6800 6801% Do the @verb magic: verbatim text is quoted by unique 6802% delimiter characters. Before first delimiter expect a 6803% right brace, after last delimiter expect closing brace: 6804% 6805% \def\doverb'{'<char>#1<char>'}'{#1} 6806% 6807% [Knuth] p. 382; only eat outer {} 6808\begingroup 6809 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other 6810 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] 6811\endgroup 6812% 6813\def\verb{\begingroup\setupverb\doverb} 6814% 6815% 6816% Do the @verbatim magic: define the macro \doverbatim so that 6817% the (first) argument ends when '@end verbatim' is reached, ie: 6818% 6819% \def\doverbatim#1@end verbatim{#1} 6820% 6821% For Texinfo it's a lot easier than for LaTeX, 6822% because texinfo's \verbatim doesn't stop at '\end{verbatim}': 6823% we need not redefine '\', '{' and '}'. 6824% 6825% Inspired by LaTeX's verbatim command set [latex.ltx] 6826% 6827\begingroup 6828 \catcode`\ =\active 6829 \obeylines % 6830 % ignore everything up to the first ^^M, that's the newline at the end 6831 % of the @verbatim input line itself. Otherwise we get an extra blank 6832 % line in the output. 6833 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% 6834 % We really want {...\end verbatim} in the body of the macro, but 6835 % without the active space; thus we have to use \xdef and \gobble. 6836\endgroup 6837% 6838\envdef\verbatim{% 6839 \setupverbatim\doverbatim 6840} 6841\let\Everbatim = \afterenvbreak 6842 6843 6844% @verbatiminclude FILE - insert text of file in verbatim environment. 6845% 6846\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} 6847% 6848\def\doverbatiminclude#1{% 6849 {% 6850 \makevalueexpandable 6851 \setupverbatim 6852 \indexnofonts % Allow `@@' and other weird things in file names. 6853 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}% 6854 \input #1 6855 \afterenvbreak 6856 }% 6857} 6858 6859% @copying ... @end copying. 6860% Save the text away for @insertcopying later. 6861% 6862% We save the uninterpreted tokens, rather than creating a box. 6863% Saving the text in a box would be much easier, but then all the 6864% typesetting commands (@smallbook, font changes, etc.) have to be done 6865% beforehand -- and a) we want @copying to be done first in the source 6866% file; b) letting users define the frontmatter in as flexible order as 6867% possible is very desirable. 6868% 6869\def\copying{\checkenv{}\begingroup\scanargctxt\docopying} 6870\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}} 6871% 6872\def\insertcopying{% 6873 \begingroup 6874 \parindent = 0pt % paragraph indentation looks wrong on title page 6875 \scanexp\copyingtext 6876 \endgroup 6877} 6878 6879 6880\message{defuns,} 6881% @defun etc. 6882 6883\newskip\defbodyindent \defbodyindent=.4in 6884\newskip\defargsindent \defargsindent=50pt 6885\newskip\deflastargmargin \deflastargmargin=18pt 6886\newcount\defunpenalty 6887 6888% Start the processing of @deffn: 6889\def\startdefun{% 6890 \ifnum\lastpenalty<10000 6891 \medbreak 6892 \defunpenalty=10003 % Will keep this @deffn together with the 6893 % following @def command, see below. 6894 \else 6895 % If there are two @def commands in a row, we'll have a \nobreak, 6896 % which is there to keep the function description together with its 6897 % header. But if there's nothing but headers, we need to allow a 6898 % break somewhere. Check specifically for penalty 10002, inserted 6899 % by \printdefunline, instead of 10000, since the sectioning 6900 % commands also insert a nobreak penalty, and we don't want to allow 6901 % a break between a section heading and a defun. 6902 % 6903 % As a further refinement, we avoid "club" headers by signalling 6904 % with penalty of 10003 after the very first @deffn in the 6905 % sequence (see above), and penalty of 10002 after any following 6906 % @def command. 6907 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi 6908 % 6909 % Similarly, after a section heading, do not allow a break. 6910 % But do insert the glue. 6911 \medskip % preceded by discardable penalty, so not a breakpoint 6912 \fi 6913 % 6914 \parindent=0in 6915 \advance\leftskip by \defbodyindent 6916 \exdentamount=\defbodyindent 6917} 6918 6919\def\dodefunx#1{% 6920 % First, check whether we are in the right environment: 6921 \checkenv#1% 6922 % 6923 % As above, allow line break if we have multiple x headers in a row. 6924 % It's not a great place, though. 6925 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi 6926 % 6927 % And now, it's time to reuse the body of the original defun: 6928 \expandafter\gobbledefun#1% 6929} 6930\def\gobbledefun#1\startdefun{} 6931 6932% \printdefunline \deffnheader{text} 6933% 6934\def\printdefunline#1#2{% 6935 \begingroup 6936 % call \deffnheader: 6937 #1#2 \endheader 6938 % common ending: 6939 \interlinepenalty = 10000 6940 \advance\rightskip by 0pt plus 1fil\relax 6941 \endgraf 6942 \nobreak\vskip -\parskip 6943 \penalty\defunpenalty % signal to \startdefun and \dodefunx 6944 % Some of the @defun-type tags do not enable magic parentheses, 6945 % rendering the following check redundant. But we don't optimize. 6946 \checkparencounts 6947 \endgroup 6948} 6949 6950\def\Edefun{\endgraf\medbreak} 6951 6952% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; 6953% the only thing remaining is to define \deffnheader. 6954% 6955\def\makedefun#1{% 6956 \expandafter\let\csname E#1\endcsname = \Edefun 6957 \edef\temp{\noexpand\domakedefun 6958 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% 6959 \temp 6960} 6961 6962% \domakedefun \deffn \deffnx \deffnheader 6963% 6964% Define \deffn and \deffnx, without parameters. 6965% \deffnheader has to be defined explicitly. 6966% 6967\def\domakedefun#1#2#3{% 6968 \envdef#1{% 6969 \startdefun 6970 \doingtypefnfalse % distinguish typed functions from all else 6971 \parseargusing\activeparens{\printdefunline#3}% 6972 }% 6973 \def#2{\dodefunx#1}% 6974 \def#3% 6975} 6976 6977\newif\ifdoingtypefn % doing typed function? 6978\newif\ifrettypeownline % typeset return type on its own line? 6979 6980% @deftypefnnewline on|off says whether the return type of typed functions 6981% are printed on their own line. This affects @deftypefn, @deftypefun, 6982% @deftypeop, and @deftypemethod. 6983% 6984\parseargdef\deftypefnnewline{% 6985 \def\temp{#1}% 6986 \ifx\temp\onword 6987 \expandafter\let\csname SETtxideftypefnnl\endcsname 6988 = \empty 6989 \else\ifx\temp\offword 6990 \expandafter\let\csname SETtxideftypefnnl\endcsname 6991 = \relax 6992 \else 6993 \errhelp = \EMsimple 6994 \errmessage{Unknown @txideftypefnnl value `\temp', 6995 must be on|off}% 6996 \fi\fi 6997} 6998 6999% Untyped functions: 7000 7001% @deffn category name args 7002\makedefun{deffn}{\deffngeneral{}} 7003 7004% @deffn category class name args 7005\makedefun{defop}#1 {\defopon{#1\ \putwordon}} 7006 7007% \defopon {category on}class name args 7008\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } 7009 7010% \deffngeneral {subind}category name args 7011% 7012\def\deffngeneral#1#2 #3 #4\endheader{% 7013 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. 7014 \dosubind{fn}{\code{#3}}{#1}% 7015 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% 7016} 7017 7018% Typed functions: 7019 7020% @deftypefn category type name args 7021\makedefun{deftypefn}{\deftypefngeneral{}} 7022 7023% @deftypeop category class type name args 7024\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} 7025 7026% \deftypeopon {category on}class type name args 7027\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } 7028 7029% \deftypefngeneral {subind}category type name args 7030% 7031\def\deftypefngeneral#1#2 #3 #4 #5\endheader{% 7032 \dosubind{fn}{\code{#4}}{#1}% 7033 \doingtypefntrue 7034 \defname{#2}{#3}{#4}\defunargs{#5\unskip}% 7035} 7036 7037% Typed variables: 7038 7039% @deftypevr category type var args 7040\makedefun{deftypevr}{\deftypecvgeneral{}} 7041 7042% @deftypecv category class type var args 7043\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} 7044 7045% \deftypecvof {category of}class type var args 7046\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } 7047 7048% \deftypecvgeneral {subind}category type var args 7049% 7050\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% 7051 \dosubind{vr}{\code{#4}}{#1}% 7052 \defname{#2}{#3}{#4}\defunargs{#5\unskip}% 7053} 7054 7055% Untyped variables: 7056 7057% @defvr category var args 7058\makedefun{defvr}#1 {\deftypevrheader{#1} {} } 7059 7060% @defcv category class var args 7061\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} 7062 7063% \defcvof {category of}class var args 7064\def\defcvof#1#2 {\deftypecvof{#1}#2 {} } 7065 7066% Types: 7067 7068% @deftp category name args 7069\makedefun{deftp}#1 #2 #3\endheader{% 7070 \doind{tp}{\code{#2}}% 7071 \defname{#1}{}{#2}\defunargs{#3\unskip}% 7072} 7073 7074% Remaining @defun-like shortcuts: 7075\makedefun{defun}{\deffnheader{\putwordDeffunc} } 7076\makedefun{defmac}{\deffnheader{\putwordDefmac} } 7077\makedefun{defspec}{\deffnheader{\putwordDefspec} } 7078\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } 7079\makedefun{defvar}{\defvrheader{\putwordDefvar} } 7080\makedefun{defopt}{\defvrheader{\putwordDefopt} } 7081\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } 7082\makedefun{defmethod}{\defopon\putwordMethodon} 7083\makedefun{deftypemethod}{\deftypeopon\putwordMethodon} 7084\makedefun{defivar}{\defcvof\putwordInstanceVariableof} 7085\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} 7086 7087% \defname, which formats the name of the @def (not the args). 7088% #1 is the category, such as "Function". 7089% #2 is the return type, if any. 7090% #3 is the function name. 7091% 7092% We are followed by (but not passed) the arguments, if any. 7093% 7094\def\defname#1#2#3{% 7095 \par 7096 % Get the values of \leftskip and \rightskip as they were outside the @def... 7097 \advance\leftskip by -\defbodyindent 7098 % 7099 % Determine if we are typesetting the return type of a typed function 7100 % on a line by itself. 7101 \rettypeownlinefalse 7102 \ifdoingtypefn % doing a typed function specifically? 7103 % then check user option for putting return type on its own line: 7104 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else 7105 \rettypeownlinetrue 7106 \fi 7107 \fi 7108 % 7109 % How we'll format the category name. Putting it in brackets helps 7110 % distinguish it from the body text that may end up on the next line 7111 % just below it. 7112 \def\temp{#1}% 7113 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} 7114 % 7115 % Figure out line sizes for the paragraph shape. We'll always have at 7116 % least two. 7117 \tempnum = 2 7118 % 7119 % The first line needs space for \box0; but if \rightskip is nonzero, 7120 % we need only space for the part of \box0 which exceeds it: 7121 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip 7122 % 7123 % If doing a return type on its own line, we'll have another line. 7124 \ifrettypeownline 7125 \advance\tempnum by 1 7126 \def\maybeshapeline{0in \hsize}% 7127 \else 7128 \def\maybeshapeline{}% 7129 \fi 7130 % 7131 % The continuations: 7132 \dimen2=\hsize \advance\dimen2 by -\defargsindent 7133 % 7134 % The final paragraph shape: 7135 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2 7136 % 7137 % Put the category name at the right margin. 7138 \noindent 7139 \hbox to 0pt{% 7140 \hfil\box0 \kern-\hsize 7141 % \hsize has to be shortened this way: 7142 \kern\leftskip 7143 % Intentionally do not respect \rightskip, since we need the space. 7144 }% 7145 % 7146 % Allow all lines to be underfull without complaint: 7147 \tolerance=10000 \hbadness=10000 7148 \exdentamount=\defbodyindent 7149 {% 7150 % defun fonts. We use typewriter by default (used to be bold) because: 7151 % . we're printing identifiers, they should be in tt in principle. 7152 % . in languages with many accents, such as Czech or French, it's 7153 % common to leave accents off identifiers. The result looks ok in 7154 % tt, but exceedingly strange in rm. 7155 % . we don't want -- and --- to be treated as ligatures. 7156 % . this still does not fix the ?` and !` ligatures, but so far no 7157 % one has made identifiers using them :). 7158 \df \tt 7159 \def\temp{#2}% text of the return type 7160 \ifx\temp\empty\else 7161 \tclose{\temp}% typeset the return type 7162 \ifrettypeownline 7163 % put return type on its own line; prohibit line break following: 7164 \hfil\vadjust{\nobreak}\break 7165 \else 7166 \space % type on same line, so just followed by a space 7167 \fi 7168 \fi % no return type 7169 #3% output function name 7170 }% 7171 {\rm\enskip}% hskip 0.5 em of \tenrm 7172 % 7173 \boldbrax 7174 % arguments will be output next, if any. 7175} 7176 7177% Print arguments in slanted roman (not ttsl), inconsistently with using 7178% tt for the name. This is because literal text is sometimes needed in 7179% the argument list (groff manual), and ttsl and tt are not very 7180% distinguishable. Prevent hyphenation at `-' chars. 7181% 7182\def\defunargs#1{% 7183 % use sl by default (not ttsl), 7184 % tt for the names. 7185 \df \sl \hyphenchar\font=0 7186 % 7187 % On the other hand, if an argument has two dashes (for instance), we 7188 % want a way to get ttsl. We used to recommend @var for that, so 7189 % leave the code in, but it's strange for @var to lead to typewriter. 7190 % Nowadays we recommend @code, since the difference between a ttsl hyphen 7191 % and a tt hyphen is pretty tiny. @code also disables ?` !`. 7192 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}% 7193 #1% 7194 \sl\hyphenchar\font=45 7195} 7196 7197% We want ()&[] to print specially on the defun line. 7198% 7199\def\activeparens{% 7200 \catcode`\(=\active \catcode`\)=\active 7201 \catcode`\[=\active \catcode`\]=\active 7202 \catcode`\&=\active 7203} 7204 7205% Make control sequences which act like normal parenthesis chars. 7206\let\lparen = ( \let\rparen = ) 7207 7208% Be sure that we always have a definition for `(', etc. For example, 7209% if the fn name has parens in it, \boldbrax will not be in effect yet, 7210% so TeX would otherwise complain about undefined control sequence. 7211{ 7212 \activeparens 7213 \global\let(=\lparen \global\let)=\rparen 7214 \global\let[=\lbrack \global\let]=\rbrack 7215 \global\let& = \& 7216 7217 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} 7218 \gdef\magicamp{\let&=\amprm} 7219} 7220 7221\newcount\parencount 7222 7223% If we encounter &foo, then turn on ()-hacking afterwards 7224\newif\ifampseen 7225\def\amprm#1 {\ampseentrue{\bf\ }} 7226 7227\def\parenfont{% 7228 \ifampseen 7229 % At the first level, print parens in roman, 7230 % otherwise use the default font. 7231 \ifnum \parencount=1 \rm \fi 7232 \else 7233 % The \sf parens (in \boldbrax) actually are a little bolder than 7234 % the contained text. This is especially needed for [ and ] . 7235 \sf 7236 \fi 7237} 7238\def\infirstlevel#1{% 7239 \ifampseen 7240 \ifnum\parencount=1 7241 #1% 7242 \fi 7243 \fi 7244} 7245\def\bfafterword#1 {#1 \bf} 7246 7247\def\opnr{% 7248 \global\advance\parencount by 1 7249 {\parenfont(}% 7250 \infirstlevel \bfafterword 7251} 7252\def\clnr{% 7253 {\parenfont)}% 7254 \infirstlevel \sl 7255 \global\advance\parencount by -1 7256} 7257 7258\newcount\brackcount 7259\def\lbrb{% 7260 \global\advance\brackcount by 1 7261 {\bf[}% 7262} 7263\def\rbrb{% 7264 {\bf]}% 7265 \global\advance\brackcount by -1 7266} 7267 7268\def\checkparencounts{% 7269 \ifnum\parencount=0 \else \badparencount \fi 7270 \ifnum\brackcount=0 \else \badbrackcount \fi 7271} 7272% these should not use \errmessage; the glibc manual, at least, actually 7273% has such constructs (when documenting function pointers). 7274\def\badparencount{% 7275 \message{Warning: unbalanced parentheses in @def...}% 7276 \global\parencount=0 7277} 7278\def\badbrackcount{% 7279 \message{Warning: unbalanced square brackets in @def...}% 7280 \global\brackcount=0 7281} 7282 7283 7284\message{macros,} 7285% @macro. 7286 7287% To do this right we need a feature of e-TeX, \scantokens, 7288% which we arrange to emulate with a temporary file in ordinary TeX. 7289\ifx\eTeXversion\thisisundefined 7290 \newwrite\macscribble 7291 \def\scantokens#1{% 7292 \toks0={#1}% 7293 \immediate\openout\macscribble=\jobname.tmp 7294 \immediate\write\macscribble{\the\toks0}% 7295 \immediate\closeout\macscribble 7296 \input \jobname.tmp 7297 } 7298\fi 7299 7300\def\scanmacro#1{\begingroup 7301 \newlinechar`\^^M 7302 \let\xeatspaces\eatspaces 7303 % 7304 % Undo catcode changes of \startcontents and \doprintindex 7305 % When called from @insertcopying or (short)caption, we need active 7306 % backslash to get it printed correctly. Previously, we had 7307 % \catcode`\\=\other instead. We'll see whether a problem appears 7308 % with macro expansion. --kasal, 19aug04 7309 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ 7310 % 7311 % ... and for \example: 7312 \spaceisspace 7313 % 7314 % The \empty here causes a following catcode 5 newline to be eaten as 7315 % part of reading whitespace after a control sequence. It does not 7316 % eat a catcode 13 newline. There's no good way to handle the two 7317 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX 7318 % would then have different behavior). See the Macro Details node in 7319 % the manual for the workaround we recommend for macros and 7320 % line-oriented commands. 7321 % 7322 \scantokens{#1\empty}% 7323\endgroup} 7324 7325\def\scanexp#1{% 7326 \edef\temp{\noexpand\scanmacro{#1}}% 7327 \temp 7328} 7329 7330\newcount\paramno % Count of parameters 7331\newtoks\macname % Macro name 7332\newif\ifrecursive % Is it recursive? 7333 7334% List of all defined macros in the form 7335% \definedummyword\macro1\definedummyword\macro2... 7336% Currently is also contains all @aliases; the list can be split 7337% if there is a need. 7338\def\macrolist{} 7339 7340% Add the macro to \macrolist 7341\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname} 7342\def\addtomacrolistxxx#1{% 7343 \toks0 = \expandafter{\macrolist\definedummyword#1}% 7344 \xdef\macrolist{\the\toks0}% 7345} 7346 7347% Utility routines. 7348% This does \let #1 = #2, with \csnames; that is, 7349% \let \csname#1\endcsname = \csname#2\endcsname 7350% (except of course we have to play expansion games). 7351% 7352\def\cslet#1#2{% 7353 \expandafter\let 7354 \csname#1\expandafter\endcsname 7355 \csname#2\endcsname 7356} 7357 7358% Trim leading and trailing spaces off a string. 7359% Concepts from aro-bend problem 15 (see CTAN). 7360{\catcode`\@=11 7361\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} 7362\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} 7363\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} 7364\def\unbrace#1{#1} 7365\unbrace{\gdef\trim@@@ #1 } #2@{#1} 7366} 7367 7368% Trim a single trailing ^^M off a string. 7369{\catcode`\^^M=\other \catcode`\Q=3% 7370\gdef\eatcr #1{\eatcra #1Q^^MQ}% 7371\gdef\eatcra#1^^MQ{\eatcrb#1Q}% 7372\gdef\eatcrb#1Q#2Q{#1}% 7373} 7374 7375% Macro bodies are absorbed as an argument in a context where 7376% all characters are catcode 10, 11 or 12, except \ which is active 7377% (as in normal texinfo). It is necessary to change the definition of \ 7378% to recognize macro arguments; this is the job of \mbodybackslash. 7379% 7380% Non-ASCII encodings make 8-bit characters active, so un-activate 7381% them to avoid their expansion. Must do this non-globally, to 7382% confine the change to the current group. 7383% 7384% It's necessary to have hard CRs when the macro is executed. This is 7385% done by making ^^M (\endlinechar) catcode 12 when reading the macro 7386% body, and then making it the \newlinechar in \scanmacro. 7387% 7388\def\scanctxt{% used as subroutine 7389 \catcode`\"=\other 7390 \catcode`\+=\other 7391 \catcode`\<=\other 7392 \catcode`\>=\other 7393 \catcode`\@=\other 7394 \catcode`\^=\other 7395 \catcode`\_=\other 7396 \catcode`\|=\other 7397 \catcode`\~=\other 7398 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi 7399} 7400 7401\def\scanargctxt{% used for copying and captions, not macros. 7402 \scanctxt 7403 \catcode`\\=\other 7404 \catcode`\^^M=\other 7405} 7406 7407\def\macrobodyctxt{% used for @macro definitions 7408 \scanctxt 7409 \catcode`\{=\other 7410 \catcode`\}=\other 7411 \catcode`\^^M=\other 7412 \usembodybackslash 7413} 7414 7415\def\macroargctxt{% used when scanning invocations 7416 \scanctxt 7417 \catcode`\\=0 7418} 7419% why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes" 7420% for the single characters \ { }. Thus, we end up with the "commands" 7421% that would be written @\ @{ @} in a Texinfo document. 7422% 7423% We already have @{ and @}. For @\, we define it here, and only for 7424% this purpose, to produce a typewriter backslash (so, the @\ that we 7425% define for @math can't be used with @macro calls): 7426% 7427\def\\{\normalbackslash}% 7428% 7429% We would like to do this for \, too, since that is what makeinfo does. 7430% But it is not possible, because Texinfo already has a command @, for a 7431% cedilla accent. Documents must use @comma{} instead. 7432% 7433% \anythingelse will almost certainly be an error of some kind. 7434 7435% \mbodybackslash is the definition of \ in @macro bodies. 7436% It maps \foo\ => \csname macarg.foo\endcsname => #N 7437% where N is the macro parameter number. 7438% We define \csname macarg.\endcsname to be \realbackslash, so 7439% \\ in macro replacement text gets you a backslash. 7440% 7441{\catcode`@=0 @catcode`@\=@active 7442 @gdef@usembodybackslash{@let\=@mbodybackslash} 7443 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} 7444} 7445\expandafter\def\csname macarg.\endcsname{\realbackslash} 7446 7447\def\margbackslash#1{\char`\#1 } 7448 7449\def\macro{\recursivefalse\parsearg\macroxxx} 7450\def\rmacro{\recursivetrue\parsearg\macroxxx} 7451 7452\def\macroxxx#1{% 7453 \getargs{#1}% now \macname is the macname and \argl the arglist 7454 \ifx\argl\empty % no arguments 7455 \paramno=0\relax 7456 \else 7457 \expandafter\parsemargdef \argl;% 7458 \if\paramno>256\relax 7459 \ifx\eTeXversion\thisisundefined 7460 \errhelp = \EMsimple 7461 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments} 7462 \fi 7463 \fi 7464 \fi 7465 \if1\csname ismacro.\the\macname\endcsname 7466 \message{Warning: redefining \the\macname}% 7467 \else 7468 \expandafter\ifx\csname \the\macname\endcsname \relax 7469 \else \errmessage{Macro name \the\macname\space already defined}\fi 7470 \global\cslet{macsave.\the\macname}{\the\macname}% 7471 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% 7472 \addtomacrolist{\the\macname}% 7473 \fi 7474 \begingroup \macrobodyctxt 7475 \ifrecursive \expandafter\parsermacbody 7476 \else \expandafter\parsemacbody 7477 \fi} 7478 7479\parseargdef\unmacro{% 7480 \if1\csname ismacro.#1\endcsname 7481 \global\cslet{#1}{macsave.#1}% 7482 \global\expandafter\let \csname ismacro.#1\endcsname=0% 7483 % Remove the macro name from \macrolist: 7484 \begingroup 7485 \expandafter\let\csname#1\endcsname \relax 7486 \let\definedummyword\unmacrodo 7487 \xdef\macrolist{\macrolist}% 7488 \endgroup 7489 \else 7490 \errmessage{Macro #1 not defined}% 7491 \fi 7492} 7493 7494% Called by \do from \dounmacro on each macro. The idea is to omit any 7495% macro definitions that have been changed to \relax. 7496% 7497\def\unmacrodo#1{% 7498 \ifx #1\relax 7499 % remove this 7500 \else 7501 \noexpand\definedummyword \noexpand#1% 7502 \fi 7503} 7504 7505% This makes use of the obscure feature that if the last token of a 7506% <parameter list> is #, then the preceding argument is delimited by 7507% an opening brace, and that opening brace is not consumed. 7508\def\getargs#1{\getargsxxx#1{}} 7509\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} 7510\def\getmacname#1 #2\relax{\macname={#1}} 7511\def\getmacargs#1{\def\argl{#1}} 7512 7513% For macro processing make @ a letter so that we can make Texinfo private macro names. 7514\edef\texiatcatcode{\the\catcode`\@} 7515\catcode `@=11\relax 7516 7517% Parse the optional {params} list. Set up \paramno and \paramlist 7518% so \defmacro knows what to do. Define \macarg.BLAH for each BLAH 7519% in the params list to some hook where the argument is to be expanded. If 7520% there are less than 10 arguments that hook is to be replaced by ##N where N 7521% is the position in that list, that is to say the macro arguments are to be 7522% defined `a la TeX in the macro body. 7523% 7524% That gets used by \mbodybackslash (above). 7525% 7526% We need to get `macro parameter char #' into several definitions. 7527% The technique used is stolen from LaTeX: let \hash be something 7528% unexpandable, insert that wherever you need a #, and then redefine 7529% it to # just before using the token list produced. 7530% 7531% The same technique is used to protect \eatspaces till just before 7532% the macro is used. 7533% 7534% If there are 10 or more arguments, a different technique is used, where the 7535% hook remains in the body, and when macro is to be expanded the body is 7536% processed again to replace the arguments. 7537% 7538% In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the 7539% argument N value and then \edef the body (nothing else will expand because of 7540% the catcode regime underwhich the body was input). 7541% 7542% If you compile with TeX (not eTeX), and you have macros with 10 or more 7543% arguments, no macro can have more than 256 arguments (else error). 7544\def\parsemargdef#1;{% 7545 \paramno=0\def\paramlist{}% 7546 \let\hash\relax 7547 \let\xeatspaces\relax 7548 \parsemargdefxxx#1,;,% 7549 % In case that there are 10 or more arguments we parse again the arguments 7550 % list to set new definitions for the \macarg.BLAH macros corresponding to 7551 % each BLAH argument. It was anyhow needed to parse already once this list 7552 % in order to count the arguments, and as macros with at most 9 arguments 7553 % are by far more frequent than macro with 10 or more arguments, defining 7554 % twice the \macarg.BLAH macros does not cost too much processing power. 7555 \ifnum\paramno<10\relax\else 7556 \paramno0\relax 7557 \parsemmanyargdef@@#1,;,% 10 or more arguments 7558 \fi 7559} 7560\def\parsemargdefxxx#1,{% 7561 \if#1;\let\next=\relax 7562 \else \let\next=\parsemargdefxxx 7563 \advance\paramno by 1 7564 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname 7565 {\xeatspaces{\hash\the\paramno}}% 7566 \edef\paramlist{\paramlist\hash\the\paramno,}% 7567 \fi\next} 7568 7569\def\parsemmanyargdef@@#1,{% 7570 \if#1;\let\next=\relax 7571 \else 7572 \let\next=\parsemmanyargdef@@ 7573 \edef\tempb{\eatspaces{#1}}% 7574 \expandafter\def\expandafter\tempa 7575 \expandafter{\csname macarg.\tempb\endcsname}% 7576 % Note that we need some extra \noexpand\noexpand, this is because we 7577 % don't want \the to be expanded in the \parsermacbody as it uses an 7578 % \xdef . 7579 \expandafter\edef\tempa 7580 {\noexpand\noexpand\noexpand\the\toks\the\paramno}% 7581 \advance\paramno by 1\relax 7582 \fi\next} 7583 7584% These two commands read recursive and nonrecursive macro bodies. 7585% (They're different since rec and nonrec macros end differently.) 7586% 7587 7588\catcode `\@\texiatcatcode 7589\long\def\parsemacbody#1@end macro% 7590{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 7591\long\def\parsermacbody#1@end rmacro% 7592{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 7593\catcode `\@=11\relax 7594 7595\let\endargs@\relax 7596\let\nil@\relax 7597\def\nilm@{\nil@}% 7598\long\def\nillm@{\nil@}% 7599 7600% This macro is expanded during the Texinfo macro expansion, not during its 7601% definition. It gets all the arguments values and assigns them to macros 7602% macarg.ARGNAME 7603% 7604% #1 is the macro name 7605% #2 is the list of argument names 7606% #3 is the list of argument values 7607\def\getargvals@#1#2#3{% 7608 \def\macargdeflist@{}% 7609 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion. 7610 \def\paramlist{#2,\nil@}% 7611 \def\macroname{#1}% 7612 \begingroup 7613 \macroargctxt 7614 \def\argvaluelist{#3,\nil@}% 7615 \def\@tempa{#3}% 7616 \ifx\@tempa\empty 7617 \setemptyargvalues@ 7618 \else 7619 \getargvals@@ 7620 \fi 7621} 7622 7623% 7624\def\getargvals@@{% 7625 \ifx\paramlist\nilm@ 7626 % Some sanity check needed here that \argvaluelist is also empty. 7627 \ifx\argvaluelist\nillm@ 7628 \else 7629 \errhelp = \EMsimple 7630 \errmessage{Too many arguments in macro `\macroname'!}% 7631 \fi 7632 \let\next\macargexpandinbody@ 7633 \else 7634 \ifx\argvaluelist\nillm@ 7635 % No more arguments values passed to macro. Set remaining named-arg 7636 % macros to empty. 7637 \let\next\setemptyargvalues@ 7638 \else 7639 % pop current arg name into \@tempb 7640 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}% 7641 \expandafter\@tempa\expandafter{\paramlist}% 7642 % pop current argument value into \@tempc 7643 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}% 7644 \expandafter\@tempa\expandafter{\argvaluelist}% 7645 % Here \@tempb is the current arg name and \@tempc is the current arg value. 7646 % First place the new argument macro definition into \@tempd 7647 \expandafter\macname\expandafter{\@tempc}% 7648 \expandafter\let\csname macarg.\@tempb\endcsname\relax 7649 \expandafter\def\expandafter\@tempe\expandafter{% 7650 \csname macarg.\@tempb\endcsname}% 7651 \edef\@tempd{\long\def\@tempe{\the\macname}}% 7652 \push@\@tempd\macargdeflist@ 7653 \let\next\getargvals@@ 7654 \fi 7655 \fi 7656 \next 7657} 7658 7659\def\push@#1#2{% 7660 \expandafter\expandafter\expandafter\def 7661 \expandafter\expandafter\expandafter#2% 7662 \expandafter\expandafter\expandafter{% 7663 \expandafter#1#2}% 7664} 7665 7666% Replace arguments by their values in the macro body, and place the result 7667% in macro \@tempa 7668\def\macvalstoargs@{% 7669 % To do this we use the property that token registers that are \the'ed 7670 % within an \edef expand only once. So we are going to place all argument 7671 % values into respective token registers. 7672 % 7673 % First we save the token context, and initialize argument numbering. 7674 \begingroup 7675 \paramno0\relax 7676 % Then, for each argument number #N, we place the corresponding argument 7677 % value into a new token list register \toks#N 7678 \expandafter\putargsintokens@\saveparamlist@,;,% 7679 % Then, we expand the body so that argument are replaced by their 7680 % values. The trick for values not to be expanded themselves is that they 7681 % are within tokens and that tokens expand only once in an \edef . 7682 \edef\@tempc{\csname mac.\macroname .body\endcsname}% 7683 % Now we restore the token stack pointer to free the token list registers 7684 % which we have used, but we make sure that expanded body is saved after 7685 % group. 7686 \expandafter 7687 \endgroup 7688 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}% 7689 } 7690 7691\def\macargexpandinbody@{% 7692 %% Define the named-macro outside of this group and then close this group. 7693 \expandafter 7694 \endgroup 7695 \macargdeflist@ 7696 % First the replace in body the macro arguments by their values, the result 7697 % is in \@tempa . 7698 \macvalstoargs@ 7699 % Then we point at the \norecurse or \gobble (for recursive) macro value 7700 % with \@tempb . 7701 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname 7702 % Depending on whether it is recursive or not, we need some tailing 7703 % \egroup . 7704 \ifx\@tempb\gobble 7705 \let\@tempc\relax 7706 \else 7707 \let\@tempc\egroup 7708 \fi 7709 % And now we do the real job: 7710 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}% 7711 \@tempd 7712} 7713 7714\def\putargsintokens@#1,{% 7715 \if#1;\let\next\relax 7716 \else 7717 \let\next\putargsintokens@ 7718 % First we allocate the new token list register, and give it a temporary 7719 % alias \@tempb . 7720 \toksdef\@tempb\the\paramno 7721 % Then we place the argument value into that token list register. 7722 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname 7723 \expandafter\@tempb\expandafter{\@tempa}% 7724 \advance\paramno by 1\relax 7725 \fi 7726 \next 7727} 7728 7729% Save the token stack pointer into macro #1 7730\def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}} 7731% Restore the token stack pointer from number in macro #1 7732\def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax} 7733% newtoks that can be used non \outer . 7734\def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi} 7735 7736% Tailing missing arguments are set to empty 7737\def\setemptyargvalues@{% 7738 \ifx\paramlist\nilm@ 7739 \let\next\macargexpandinbody@ 7740 \else 7741 \expandafter\setemptyargvaluesparser@\paramlist\endargs@ 7742 \let\next\setemptyargvalues@ 7743 \fi 7744 \next 7745} 7746 7747\def\setemptyargvaluesparser@#1,#2\endargs@{% 7748 \expandafter\def\expandafter\@tempa\expandafter{% 7749 \expandafter\def\csname macarg.#1\endcsname{}}% 7750 \push@\@tempa\macargdeflist@ 7751 \def\paramlist{#2}% 7752} 7753 7754% #1 is the element target macro 7755% #2 is the list macro 7756% #3,#4\endargs@ is the list value 7757\def\pop@#1#2#3,#4\endargs@{% 7758 \def#1{#3}% 7759 \def#2{#4}% 7760} 7761\long\def\longpop@#1#2#3,#4\endargs@{% 7762 \long\def#1{#3}% 7763 \long\def#2{#4}% 7764} 7765 7766% This defines a Texinfo @macro. There are eight cases: recursive and 7767% nonrecursive macros of zero, one, up to nine, and many arguments. 7768% Much magic with \expandafter here. 7769% \xdef is used so that macro definitions will survive the file 7770% they're defined in; @include reads the file inside a group. 7771% 7772\def\defmacro{% 7773 \let\hash=##% convert placeholders to macro parameter chars 7774 \ifrecursive 7775 \ifcase\paramno 7776 % 0 7777 \expandafter\xdef\csname\the\macname\endcsname{% 7778 \noexpand\scanmacro{\temp}}% 7779 \or % 1 7780 \expandafter\xdef\csname\the\macname\endcsname{% 7781 \bgroup\noexpand\macroargctxt 7782 \noexpand\braceorline 7783 \expandafter\noexpand\csname\the\macname xxx\endcsname}% 7784 \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 7785 \egroup\noexpand\scanmacro{\temp}}% 7786 \else 7787 \ifnum\paramno<10\relax % at most 9 7788 \expandafter\xdef\csname\the\macname\endcsname{% 7789 \bgroup\noexpand\macroargctxt 7790 \noexpand\csname\the\macname xx\endcsname}% 7791 \expandafter\xdef\csname\the\macname xx\endcsname##1{% 7792 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 7793 \expandafter\expandafter 7794 \expandafter\xdef 7795 \expandafter\expandafter 7796 \csname\the\macname xxx\endcsname 7797 \paramlist{\egroup\noexpand\scanmacro{\temp}}% 7798 \else % 10 or more 7799 \expandafter\xdef\csname\the\macname\endcsname{% 7800 \noexpand\getargvals@{\the\macname}{\argl}% 7801 }% 7802 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp 7803 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble 7804 \fi 7805 \fi 7806 \else 7807 \ifcase\paramno 7808 % 0 7809 \expandafter\xdef\csname\the\macname\endcsname{% 7810 \noexpand\norecurse{\the\macname}% 7811 \noexpand\scanmacro{\temp}\egroup}% 7812 \or % 1 7813 \expandafter\xdef\csname\the\macname\endcsname{% 7814 \bgroup\noexpand\macroargctxt 7815 \noexpand\braceorline 7816 \expandafter\noexpand\csname\the\macname xxx\endcsname}% 7817 \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 7818 \egroup 7819 \noexpand\norecurse{\the\macname}% 7820 \noexpand\scanmacro{\temp}\egroup}% 7821 \else % at most 9 7822 \ifnum\paramno<10\relax 7823 \expandafter\xdef\csname\the\macname\endcsname{% 7824 \bgroup\noexpand\macroargctxt 7825 \expandafter\noexpand\csname\the\macname xx\endcsname}% 7826 \expandafter\xdef\csname\the\macname xx\endcsname##1{% 7827 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 7828 \expandafter\expandafter 7829 \expandafter\xdef 7830 \expandafter\expandafter 7831 \csname\the\macname xxx\endcsname 7832 \paramlist{% 7833 \egroup 7834 \noexpand\norecurse{\the\macname}% 7835 \noexpand\scanmacro{\temp}\egroup}% 7836 \else % 10 or more: 7837 \expandafter\xdef\csname\the\macname\endcsname{% 7838 \noexpand\getargvals@{\the\macname}{\argl}% 7839 }% 7840 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp 7841 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse 7842 \fi 7843 \fi 7844 \fi} 7845 7846\catcode `\@\texiatcatcode\relax 7847 7848\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} 7849 7850% \braceorline decides whether the next nonwhitespace character is a 7851% {. If so it reads up to the closing }, if not, it reads the whole 7852% line. Whatever was read is then fed to the next control sequence 7853% as an argument (by \parsebrace or \parsearg). 7854% 7855\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} 7856\def\braceorlinexxx{% 7857 \ifx\nchar\bgroup\else 7858 \expandafter\parsearg 7859 \fi \macnamexxx} 7860 7861 7862% @alias. 7863% We need some trickery to remove the optional spaces around the equal 7864% sign. Make them active and then expand them all to nothing. 7865% 7866\def\alias{\parseargusing\obeyspaces\aliasxxx} 7867\def\aliasxxx #1{\aliasyyy#1\relax} 7868\def\aliasyyy #1=#2\relax{% 7869 {% 7870 \expandafter\let\obeyedspace=\empty 7871 \addtomacrolist{#1}% 7872 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% 7873 }% 7874 \next 7875} 7876 7877 7878\message{cross references,} 7879 7880\newwrite\auxfile 7881\newif\ifhavexrefs % True if xref values are known. 7882\newif\ifwarnedxrefs % True if we warned once that they aren't known. 7883 7884% @inforef is relatively simple. 7885\def\inforef #1{\inforefzzz #1,,,,**} 7886\def\inforefzzz #1,#2,#3,#4**{% 7887 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, 7888 node \samp{\ignorespaces#1{}}} 7889 7890% @node's only job in TeX is to define \lastnode, which is used in 7891% cross-references. The @node line might or might not have commas, and 7892% might or might not have spaces before the first comma, like: 7893% @node foo , bar , ... 7894% We don't want such trailing spaces in the node name. 7895% 7896\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse} 7897% 7898% also remove a trailing comma, in case of something like this: 7899% @node Help-Cross, , , Cross-refs 7900\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse} 7901\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}} 7902 7903\let\nwnode=\node 7904\let\lastnode=\empty 7905 7906% Write a cross-reference definition for the current node. #1 is the 7907% type (Ynumbered, Yappendix, Ynothing). 7908% 7909\def\donoderef#1{% 7910 \ifx\lastnode\empty\else 7911 \setref{\lastnode}{#1}% 7912 \global\let\lastnode=\empty 7913 \fi 7914} 7915 7916% @anchor{NAME} -- define xref target at arbitrary point. 7917% 7918\newcount\savesfregister 7919% 7920\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} 7921\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} 7922\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} 7923 7924% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an 7925% anchor), which consists of three parts: 7926% 1) NAME-title - the current sectioning name taken from \lastsection, 7927% or the anchor name. 7928% 2) NAME-snt - section number and type, passed as the SNT arg, or 7929% empty for anchors. 7930% 3) NAME-pg - the page number. 7931% 7932% This is called from \donoderef, \anchor, and \dofloat. In the case of 7933% floats, there is an additional part, which is not written here: 7934% 4) NAME-lof - the text as it should appear in a @listoffloats. 7935% 7936\def\setref#1#2{% 7937 \pdfmkdest{#1}% 7938 \iflinks 7939 {% 7940 \atdummies % preserve commands, but don't expand them 7941 \edef\writexrdef##1##2{% 7942 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef 7943 ##1}{##2}}% these are parameters of \writexrdef 7944 }% 7945 \toks0 = \expandafter{\lastsection}% 7946 \immediate \writexrdef{title}{\the\toks0 }% 7947 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. 7948 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout 7949 }% 7950 \fi 7951} 7952 7953% @xrefautosectiontitle on|off says whether @section(ing) names are used 7954% automatically in xrefs, if the third arg is not explicitly specified. 7955% This was provided as a "secret" @set xref-automatic-section-title 7956% variable, now it's official. 7957% 7958\parseargdef\xrefautomaticsectiontitle{% 7959 \def\temp{#1}% 7960 \ifx\temp\onword 7961 \expandafter\let\csname SETxref-automatic-section-title\endcsname 7962 = \empty 7963 \else\ifx\temp\offword 7964 \expandafter\let\csname SETxref-automatic-section-title\endcsname 7965 = \relax 7966 \else 7967 \errhelp = \EMsimple 7968 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp', 7969 must be on|off}% 7970 \fi\fi 7971} 7972 7973% 7974% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is 7975% the node name, #2 the name of the Info cross-reference, #3 the printed 7976% node name, #4 the name of the Info file, #5 the name of the printed 7977% manual. All but the node name can be omitted. 7978% 7979\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} 7980\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} 7981\def\ref#1{\xrefX[#1,,,,,,,]} 7982% 7983\newbox\toprefbox 7984\newbox\printedrefnamebox 7985\newbox\infofilenamebox 7986\newbox\printedmanualbox 7987% 7988\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup 7989 \unsepspaces 7990 % 7991 % Get args without leading/trailing spaces. 7992 \def\printedrefname{\ignorespaces #3}% 7993 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}% 7994 % 7995 \def\infofilename{\ignorespaces #4}% 7996 \setbox\infofilenamebox = \hbox{\infofilename\unskip}% 7997 % 7998 \def\printedmanual{\ignorespaces #5}% 7999 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}% 8000 % 8001 % If the printed reference name (arg #3) was not explicitly given in 8002 % the @xref, figure out what we want to use. 8003 \ifdim \wd\printedrefnamebox = 0pt 8004 % No printed node name was explicitly given. 8005 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax 8006 % Not auto section-title: use node name inside the square brackets. 8007 \def\printedrefname{\ignorespaces #1}% 8008 \else 8009 % Auto section-title: use chapter/section title inside 8010 % the square brackets if we have it. 8011 \ifdim \wd\printedmanualbox > 0pt 8012 % It is in another manual, so we don't have it; use node name. 8013 \def\printedrefname{\ignorespaces #1}% 8014 \else 8015 \ifhavexrefs 8016 % We (should) know the real title if we have the xref values. 8017 \def\printedrefname{\refx{#1-title}{}}% 8018 \else 8019 % Otherwise just copy the Info node name. 8020 \def\printedrefname{\ignorespaces #1}% 8021 \fi% 8022 \fi 8023 \fi 8024 \fi 8025 % 8026 % Make link in pdf output. 8027 \ifpdf 8028 {\indexnofonts 8029 \turnoffactive 8030 \makevalueexpandable 8031 % This expands tokens, so do it after making catcode changes, so _ 8032 % etc. don't get their TeX definitions. This ignores all spaces in 8033 % #4, including (wrongly) those in the middle of the filename. 8034 \getfilename{#4}% 8035 % 8036 % This (wrongly) does not take account of leading or trailing 8037 % spaces in #1, which should be ignored. 8038 \edef\pdfxrefdest{#1}% 8039 \ifx\pdfxrefdest\empty 8040 \def\pdfxrefdest{Top}% no empty targets 8041 \else 8042 \txiescapepdf\pdfxrefdest % escape PDF special chars 8043 \fi 8044 % 8045 \leavevmode 8046 \startlink attr{/Border [0 0 0]}% 8047 \ifnum\filenamelength>0 8048 goto file{\the\filename.pdf} name{\pdfxrefdest}% 8049 \else 8050 goto name{\pdfmkpgn{\pdfxrefdest}}% 8051 \fi 8052 }% 8053 \setcolor{\linkcolor}% 8054 \fi 8055 % 8056 % Float references are printed completely differently: "Figure 1.2" 8057 % instead of "[somenode], p.3". We distinguish them by the 8058 % LABEL-title being set to a magic string. 8059 {% 8060 % Have to otherify everything special to allow the \csname to 8061 % include an _ in the xref name, etc. 8062 \indexnofonts 8063 \turnoffactive 8064 \expandafter\global\expandafter\let\expandafter\Xthisreftitle 8065 \csname XR#1-title\endcsname 8066 }% 8067 \iffloat\Xthisreftitle 8068 % If the user specified the print name (third arg) to the ref, 8069 % print it instead of our usual "Figure 1.2". 8070 \ifdim\wd\printedrefnamebox = 0pt 8071 \refx{#1-snt}{}% 8072 \else 8073 \printedrefname 8074 \fi 8075 % 8076 % If the user also gave the printed manual name (fifth arg), append 8077 % "in MANUALNAME". 8078 \ifdim \wd\printedmanualbox > 0pt 8079 \space \putwordin{} \cite{\printedmanual}% 8080 \fi 8081 \else 8082 % node/anchor (non-float) references. 8083 % 8084 % If we use \unhbox to print the node names, TeX does not insert 8085 % empty discretionaries after hyphens, which means that it will not 8086 % find a line break at a hyphen in a node names. Since some manuals 8087 % are best written with fairly long node names, containing hyphens, 8088 % this is a loss. Therefore, we give the text of the node name 8089 % again, so it is as if TeX is seeing it for the first time. 8090 % 8091 \ifdim \wd\printedmanualbox > 0pt 8092 % Cross-manual reference with a printed manual name. 8093 % 8094 \crossmanualxref{\cite{\printedmanual\unskip}}% 8095 % 8096 \else\ifdim \wd\infofilenamebox > 0pt 8097 % Cross-manual reference with only an info filename (arg 4), no 8098 % printed manual name (arg 5). This is essentially the same as 8099 % the case above; we output the filename, since we have nothing else. 8100 % 8101 \crossmanualxref{\code{\infofilename\unskip}}% 8102 % 8103 \else 8104 % Reference within this manual. 8105 % 8106 % _ (for example) has to be the character _ for the purposes of the 8107 % control sequence corresponding to the node, but it has to expand 8108 % into the usual \leavevmode...\vrule stuff for purposes of 8109 % printing. So we \turnoffactive for the \refx-snt, back on for the 8110 % printing, back off for the \refx-pg. 8111 {\turnoffactive 8112 % Only output a following space if the -snt ref is nonempty; for 8113 % @unnumbered and @anchor, it won't be. 8114 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% 8115 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi 8116 }% 8117 % output the `[mynode]' via the macro below so it can be overridden. 8118 \xrefprintnodename\printedrefname 8119 % 8120 % But we always want a comma and a space: 8121 ,\space 8122 % 8123 % output the `page 3'. 8124 \turnoffactive \putwordpage\tie\refx{#1-pg}{}% 8125 \fi\fi 8126 \fi 8127 \endlink 8128\endgroup} 8129 8130% Output a cross-manual xref to #1. Used just above (twice). 8131% 8132% Only include the text "Section ``foo'' in" if the foo is neither 8133% missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply 8134% "see The Foo Manual", the idea being to refer to the whole manual. 8135% 8136% But, this being TeX, we can't easily compare our node name against the 8137% string "Top" while ignoring the possible spaces before and after in 8138% the input. By adding the arbitrary 7sp below, we make it much less 8139% likely that a real node name would have the same width as "Top" (e.g., 8140% in a monospaced font). Hopefully it will never happen in practice. 8141% 8142% For the same basic reason, we retypeset the "Top" at every 8143% reference, since the current font is indeterminate. 8144% 8145\def\crossmanualxref#1{% 8146 \setbox\toprefbox = \hbox{Top\kern7sp}% 8147 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}% 8148 \ifdim \wd2 > 7sp % nonempty? 8149 \ifdim \wd2 = \wd\toprefbox \else % same as Top? 8150 \putwordSection{} ``\printedrefname'' \putwordin{}\space 8151 \fi 8152 \fi 8153 #1% 8154} 8155 8156% This macro is called from \xrefX for the `[nodename]' part of xref 8157% output. It's a separate macro only so it can be changed more easily, 8158% since square brackets don't work well in some documents. Particularly 8159% one that Bob is working on :). 8160% 8161\def\xrefprintnodename#1{[#1]} 8162 8163% Things referred to by \setref. 8164% 8165\def\Ynothing{} 8166\def\Yomitfromtoc{} 8167\def\Ynumbered{% 8168 \ifnum\secno=0 8169 \putwordChapter@tie \the\chapno 8170 \else \ifnum\subsecno=0 8171 \putwordSection@tie \the\chapno.\the\secno 8172 \else \ifnum\subsubsecno=0 8173 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno 8174 \else 8175 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno 8176 \fi\fi\fi 8177} 8178\def\Yappendix{% 8179 \ifnum\secno=0 8180 \putwordAppendix@tie @char\the\appendixno{}% 8181 \else \ifnum\subsecno=0 8182 \putwordSection@tie @char\the\appendixno.\the\secno 8183 \else \ifnum\subsubsecno=0 8184 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno 8185 \else 8186 \putwordSection@tie 8187 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno 8188 \fi\fi\fi 8189} 8190 8191% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. 8192% If its value is nonempty, SUFFIX is output afterward. 8193% 8194\def\refx#1#2{% 8195 {% 8196 \indexnofonts 8197 \otherbackslash 8198 \expandafter\global\expandafter\let\expandafter\thisrefX 8199 \csname XR#1\endcsname 8200 }% 8201 \ifx\thisrefX\relax 8202 % If not defined, say something at least. 8203 \angleleft un\-de\-fined\angleright 8204 \iflinks 8205 \ifhavexrefs 8206 {\toks0 = {#1}% avoid expansion of possibly-complex value 8207 \message{\linenumber Undefined cross reference `\the\toks0'.}}% 8208 \else 8209 \ifwarnedxrefs\else 8210 \global\warnedxrefstrue 8211 \message{Cross reference values unknown; you must run TeX again.}% 8212 \fi 8213 \fi 8214 \fi 8215 \else 8216 % It's defined, so just use it. 8217 \thisrefX 8218 \fi 8219 #2% Output the suffix in any case. 8220} 8221 8222% This is the macro invoked by entries in the aux file. Usually it's 8223% just a \def (we prepend XR to the control sequence name to avoid 8224% collisions). But if this is a float type, we have more work to do. 8225% 8226\def\xrdef#1#2{% 8227 {% The node name might contain 8-bit characters, which in our current 8228 % implementation are changed to commands like @'e. Don't let these 8229 % mess up the control sequence name. 8230 \indexnofonts 8231 \turnoffactive 8232 \xdef\safexrefname{#1}% 8233 }% 8234 % 8235 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref 8236 % 8237 % Was that xref control sequence that we just defined for a float? 8238 \expandafter\iffloat\csname XR\safexrefname\endcsname 8239 % it was a float, and we have the (safe) float type in \iffloattype. 8240 \expandafter\let\expandafter\floatlist 8241 \csname floatlist\iffloattype\endcsname 8242 % 8243 % Is this the first time we've seen this float type? 8244 \expandafter\ifx\floatlist\relax 8245 \toks0 = {\do}% yes, so just \do 8246 \else 8247 % had it before, so preserve previous elements in list. 8248 \toks0 = \expandafter{\floatlist\do}% 8249 \fi 8250 % 8251 % Remember this xref in the control sequence \floatlistFLOATTYPE, 8252 % for later use in \listoffloats. 8253 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0 8254 {\safexrefname}}% 8255 \fi 8256} 8257 8258% Read the last existing aux file, if any. No error if none exists. 8259% 8260\def\tryauxfile{% 8261 \openin 1 \jobname.aux 8262 \ifeof 1 \else 8263 \readdatafile{aux}% 8264 \global\havexrefstrue 8265 \fi 8266 \closein 1 8267} 8268 8269\def\setupdatafile{% 8270 \catcode`\^^@=\other 8271 \catcode`\^^A=\other 8272 \catcode`\^^B=\other 8273 \catcode`\^^C=\other 8274 \catcode`\^^D=\other 8275 \catcode`\^^E=\other 8276 \catcode`\^^F=\other 8277 \catcode`\^^G=\other 8278 \catcode`\^^H=\other 8279 \catcode`\^^K=\other 8280 \catcode`\^^L=\other 8281 \catcode`\^^N=\other 8282 \catcode`\^^P=\other 8283 \catcode`\^^Q=\other 8284 \catcode`\^^R=\other 8285 \catcode`\^^S=\other 8286 \catcode`\^^T=\other 8287 \catcode`\^^U=\other 8288 \catcode`\^^V=\other 8289 \catcode`\^^W=\other 8290 \catcode`\^^X=\other 8291 \catcode`\^^Z=\other 8292 \catcode`\^^[=\other 8293 \catcode`\^^\=\other 8294 \catcode`\^^]=\other 8295 \catcode`\^^^=\other 8296 \catcode`\^^_=\other 8297 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. 8298 % in xref tags, i.e., node names. But since ^^e4 notation isn't 8299 % supported in the main text, it doesn't seem desirable. Furthermore, 8300 % that is not enough: for node names that actually contain a ^ 8301 % character, we would end up writing a line like this: 'xrdef {'hat 8302 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first 8303 % argument, and \hat is not an expandable control sequence. It could 8304 % all be worked out, but why? Either we support ^^ or we don't. 8305 % 8306 % The other change necessary for this was to define \auxhat: 8307 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter 8308 % and then to call \auxhat in \setq. 8309 % 8310 \catcode`\^=\other 8311 % 8312 % Special characters. Should be turned off anyway, but... 8313 \catcode`\~=\other 8314 \catcode`\[=\other 8315 \catcode`\]=\other 8316 \catcode`\"=\other 8317 \catcode`\_=\other 8318 \catcode`\|=\other 8319 \catcode`\<=\other 8320 \catcode`\>=\other 8321 \catcode`\$=\other 8322 \catcode`\#=\other 8323 \catcode`\&=\other 8324 \catcode`\%=\other 8325 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off 8326 % 8327 % This is to support \ in node names and titles, since the \ 8328 % characters end up in a \csname. It's easier than 8329 % leaving it active and making its active definition an actual \ 8330 % character. What I don't understand is why it works in the *value* 8331 % of the xrdef. Seems like it should be a catcode12 \, and that 8332 % should not typeset properly. But it works, so I'm moving on for 8333 % now. --karl, 15jan04. 8334 \catcode`\\=\other 8335 % 8336 % Make the characters 128-255 be printing characters. 8337 {% 8338 \count1=128 8339 \def\loop{% 8340 \catcode\count1=\other 8341 \advance\count1 by 1 8342 \ifnum \count1<256 \loop \fi 8343 }% 8344 }% 8345 % 8346 % @ is our escape character in .aux files, and we need braces. 8347 \catcode`\{=1 8348 \catcode`\}=2 8349 \catcode`\@=0 8350} 8351 8352\def\readdatafile#1{% 8353\begingroup 8354 \setupdatafile 8355 \input\jobname.#1 8356\endgroup} 8357 8358 8359\message{insertions,} 8360% including footnotes. 8361 8362\newcount \footnoteno 8363 8364% The trailing space in the following definition for supereject is 8365% vital for proper filling; pages come out unaligned when you do a 8366% pagealignmacro call if that space before the closing brace is 8367% removed. (Generally, numeric constants should always be followed by a 8368% space to prevent strange expansion errors.) 8369\def\supereject{\par\penalty -20000\footnoteno =0 } 8370 8371% @footnotestyle is meaningful for Info output only. 8372\let\footnotestyle=\comment 8373 8374{\catcode `\@=11 8375% 8376% Auto-number footnotes. Otherwise like plain. 8377\gdef\footnote{% 8378 \global\advance\footnoteno by \@ne 8379 \edef\thisfootno{$^{\the\footnoteno}$}% 8380 % 8381 % In case the footnote comes at the end of a sentence, preserve the 8382 % extra spacing after we do the footnote number. 8383 \let\@sf\empty 8384 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi 8385 % 8386 % Remove inadvertent blank space before typesetting the footnote number. 8387 \unskip 8388 \thisfootno\@sf 8389 \dofootnote 8390}% 8391 8392% Don't bother with the trickery in plain.tex to not require the 8393% footnote text as a parameter. Our footnotes don't need to be so general. 8394% 8395% Oh yes, they do; otherwise, @ifset (and anything else that uses 8396% \parseargline) fails inside footnotes because the tokens are fixed when 8397% the footnote is read. --karl, 16nov96. 8398% 8399\gdef\dofootnote{% 8400 \insert\footins\bgroup 8401 % 8402 % Nested footnotes are not supported in TeX, that would take a lot 8403 % more work. (\startsavinginserts does not suffice.) 8404 \let\footnote=\errfootnotenest 8405 % 8406 % We want to typeset this text as a normal paragraph, even if the 8407 % footnote reference occurs in (for example) a display environment. 8408 % So reset some parameters. 8409 \hsize=\pagewidth 8410 \interlinepenalty\interfootnotelinepenalty 8411 \splittopskip\ht\strutbox % top baseline for broken footnotes 8412 \splitmaxdepth\dp\strutbox 8413 \floatingpenalty\@MM 8414 \leftskip\z@skip 8415 \rightskip\z@skip 8416 \spaceskip\z@skip 8417 \xspaceskip\z@skip 8418 \parindent\defaultparindent 8419 % 8420 \smallfonts \rm 8421 % 8422 % Because we use hanging indentation in footnotes, a @noindent appears 8423 % to exdent this text, so make it be a no-op. makeinfo does not use 8424 % hanging indentation so @noindent can still be needed within footnote 8425 % text after an @example or the like (not that this is good style). 8426 \let\noindent = \relax 8427 % 8428 % Hang the footnote text off the number. Use \everypar in case the 8429 % footnote extends for more than one paragraph. 8430 \everypar = {\hang}% 8431 \textindent{\thisfootno}% 8432 % 8433 % Don't crash into the line above the footnote text. Since this 8434 % expands into a box, it must come within the paragraph, lest it 8435 % provide a place where TeX can split the footnote. 8436 \footstrut 8437 % 8438 % Invoke rest of plain TeX footnote routine. 8439 \futurelet\next\fo@t 8440} 8441}%end \catcode `\@=11 8442 8443\def\errfootnotenest{% 8444 \errhelp=\EMsimple 8445 \errmessage{Nested footnotes not supported in texinfo.tex, 8446 even though they work in makeinfo; sorry} 8447} 8448 8449\def\errfootnoteheading{% 8450 \errhelp=\EMsimple 8451 \errmessage{Footnotes in chapters, sections, etc., are not supported} 8452} 8453 8454% In case a @footnote appears in a vbox, save the footnote text and create 8455% the real \insert just after the vbox finished. Otherwise, the insertion 8456% would be lost. 8457% Similarly, if a @footnote appears inside an alignment, save the footnote 8458% text to a box and make the \insert when a row of the table is finished. 8459% And the same can be done for other insert classes. --kasal, 16nov03. 8460% 8461% Replace the \insert primitive by a cheating macro. 8462% Deeper inside, just make sure that the saved insertions are not spilled 8463% out prematurely. 8464% 8465\def\startsavinginserts{% 8466 \ifx \insert\ptexinsert 8467 \let\insert\saveinsert 8468 \else 8469 \let\checkinserts\relax 8470 \fi 8471} 8472 8473% This \insert replacement works for both \insert\footins{foo} and 8474% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. 8475% 8476\def\saveinsert#1{% 8477 \edef\next{\noexpand\savetobox \makeSAVEname#1}% 8478 \afterassignment\next 8479 % swallow the left brace 8480 \let\temp = 8481} 8482\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} 8483\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} 8484 8485\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} 8486 8487\def\placesaveins#1{% 8488 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname 8489 {\box#1}% 8490} 8491 8492% eat @SAVE -- beware, all of them have catcode \other: 8493{ 8494 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) 8495 \gdef\gobblesave @SAVE{} 8496} 8497 8498% initialization: 8499\def\newsaveins #1{% 8500 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% 8501 \next 8502} 8503\def\newsaveinsX #1{% 8504 \csname newbox\endcsname #1% 8505 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts 8506 \checksaveins #1}% 8507} 8508 8509% initialize: 8510\let\checkinserts\empty 8511\newsaveins\footins 8512\newsaveins\margin 8513 8514 8515% @image. We use the macros from epsf.tex to support this. 8516% If epsf.tex is not installed and @image is used, we complain. 8517% 8518% Check for and read epsf.tex up front. If we read it only at @image 8519% time, we might be inside a group, and then its definitions would get 8520% undone and the next image would fail. 8521\openin 1 = epsf.tex 8522\ifeof 1 \else 8523 % Do not bother showing banner with epsf.tex v2.7k (available in 8524 % doc/epsf.tex and on ctan). 8525 \def\epsfannounce{\toks0 = }% 8526 \input epsf.tex 8527\fi 8528\closein 1 8529% 8530% We will only complain once about lack of epsf.tex. 8531\newif\ifwarnednoepsf 8532\newhelp\noepsfhelp{epsf.tex must be installed for images to 8533 work. It is also included in the Texinfo distribution, or you can get 8534 it from ftp://tug.org/tex/epsf.tex.} 8535% 8536\def\image#1{% 8537 \ifx\epsfbox\thisisundefined 8538 \ifwarnednoepsf \else 8539 \errhelp = \noepsfhelp 8540 \errmessage{epsf.tex not found, images will be ignored}% 8541 \global\warnednoepsftrue 8542 \fi 8543 \else 8544 \imagexxx #1,,,,,\finish 8545 \fi 8546} 8547% 8548% Arguments to @image: 8549% #1 is (mandatory) image filename; we tack on .eps extension. 8550% #2 is (optional) width, #3 is (optional) height. 8551% #4 is (ignored optional) html alt text. 8552% #5 is (ignored optional) extension. 8553% #6 is just the usual extra ignored arg for parsing stuff. 8554\newif\ifimagevmode 8555\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup 8556 \catcode`\^^M = 5 % in case we're inside an example 8557 \normalturnoffactive % allow _ et al. in names 8558 % If the image is by itself, center it. 8559 \ifvmode 8560 \imagevmodetrue 8561 \else \ifx\centersub\centerV 8562 % for @center @image, we need a vbox so we can have our vertical space 8563 \imagevmodetrue 8564 \vbox\bgroup % vbox has better behavior than vtop herev 8565 \fi\fi 8566 % 8567 \ifimagevmode 8568 \nobreak\medskip 8569 % Usually we'll have text after the image which will insert 8570 % \parskip glue, so insert it here too to equalize the space 8571 % above and below. 8572 \nobreak\vskip\parskip 8573 \nobreak 8574 \fi 8575 % 8576 % Leave vertical mode so that indentation from an enclosing 8577 % environment such as @quotation is respected. 8578 % However, if we're at the top level, we don't want the 8579 % normal paragraph indentation. 8580 % On the other hand, if we are in the case of @center @image, we don't 8581 % want to start a paragraph, which will create a hsize-width box and 8582 % eradicate the centering. 8583 \ifx\centersub\centerV\else \noindent \fi 8584 % 8585 % Output the image. 8586 \ifpdf 8587 \dopdfimage{#1}{#2}{#3}% 8588 \else 8589 % \epsfbox itself resets \epsf?size at each figure. 8590 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi 8591 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi 8592 \epsfbox{#1.eps}% 8593 \fi 8594 % 8595 \ifimagevmode 8596 \medskip % space after a standalone image 8597 \fi 8598 \ifx\centersub\centerV \egroup \fi 8599\endgroup} 8600 8601 8602% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables, 8603% etc. We don't actually implement floating yet, we always include the 8604% float "here". But it seemed the best name for the future. 8605% 8606\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish} 8607 8608% There may be a space before second and/or third parameter; delete it. 8609\def\eatcommaspace#1, {#1,} 8610 8611% #1 is the optional FLOATTYPE, the text label for this float, typically 8612% "Figure", "Table", "Example", etc. Can't contain commas. If omitted, 8613% this float will not be numbered and cannot be referred to. 8614% 8615% #2 is the optional xref label. Also must be present for the float to 8616% be referable. 8617% 8618% #3 is the optional positioning argument; for now, it is ignored. It 8619% will somehow specify the positions allowed to float to (here, top, bottom). 8620% 8621% We keep a separate counter for each FLOATTYPE, which we reset at each 8622% chapter-level command. 8623\let\resetallfloatnos=\empty 8624% 8625\def\dofloat#1,#2,#3,#4\finish{% 8626 \let\thiscaption=\empty 8627 \let\thisshortcaption=\empty 8628 % 8629 % don't lose footnotes inside @float. 8630 % 8631 % BEWARE: when the floats start float, we have to issue warning whenever an 8632 % insert appears inside a float which could possibly float. --kasal, 26may04 8633 % 8634 \startsavinginserts 8635 % 8636 % We can't be used inside a paragraph. 8637 \par 8638 % 8639 \vtop\bgroup 8640 \def\floattype{#1}% 8641 \def\floatlabel{#2}% 8642 \def\floatloc{#3}% we do nothing with this yet. 8643 % 8644 \ifx\floattype\empty 8645 \let\safefloattype=\empty 8646 \else 8647 {% 8648 % the floattype might have accents or other special characters, 8649 % but we need to use it in a control sequence name. 8650 \indexnofonts 8651 \turnoffactive 8652 \xdef\safefloattype{\floattype}% 8653 }% 8654 \fi 8655 % 8656 % If label is given but no type, we handle that as the empty type. 8657 \ifx\floatlabel\empty \else 8658 % We want each FLOATTYPE to be numbered separately (Figure 1, 8659 % Table 1, Figure 2, ...). (And if no label, no number.) 8660 % 8661 \expandafter\getfloatno\csname\safefloattype floatno\endcsname 8662 \global\advance\floatno by 1 8663 % 8664 {% 8665 % This magic value for \lastsection is output by \setref as the 8666 % XREFLABEL-title value. \xrefX uses it to distinguish float 8667 % labels (which have a completely different output format) from 8668 % node and anchor labels. And \xrdef uses it to construct the 8669 % lists of floats. 8670 % 8671 \edef\lastsection{\floatmagic=\safefloattype}% 8672 \setref{\floatlabel}{Yfloat}% 8673 }% 8674 \fi 8675 % 8676 % start with \parskip glue, I guess. 8677 \vskip\parskip 8678 % 8679 % Don't suppress indentation if a float happens to start a section. 8680 \restorefirstparagraphindent 8681} 8682 8683% we have these possibilities: 8684% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap 8685% @float Foo,lbl & no caption: Foo 1.1 8686% @float Foo & @caption{Cap}: Foo: Cap 8687% @float Foo & no caption: Foo 8688% @float ,lbl & Caption{Cap}: 1.1: Cap 8689% @float ,lbl & no caption: 1.1 8690% @float & @caption{Cap}: Cap 8691% @float & no caption: 8692% 8693\def\Efloat{% 8694 \let\floatident = \empty 8695 % 8696 % In all cases, if we have a float type, it comes first. 8697 \ifx\floattype\empty \else \def\floatident{\floattype}\fi 8698 % 8699 % If we have an xref label, the number comes next. 8700 \ifx\floatlabel\empty \else 8701 \ifx\floattype\empty \else % if also had float type, need tie first. 8702 \appendtomacro\floatident{\tie}% 8703 \fi 8704 % the number. 8705 \appendtomacro\floatident{\chaplevelprefix\the\floatno}% 8706 \fi 8707 % 8708 % Start the printed caption with what we've constructed in 8709 % \floatident, but keep it separate; we need \floatident again. 8710 \let\captionline = \floatident 8711 % 8712 \ifx\thiscaption\empty \else 8713 \ifx\floatident\empty \else 8714 \appendtomacro\captionline{: }% had ident, so need a colon between 8715 \fi 8716 % 8717 % caption text. 8718 \appendtomacro\captionline{\scanexp\thiscaption}% 8719 \fi 8720 % 8721 % If we have anything to print, print it, with space before. 8722 % Eventually this needs to become an \insert. 8723 \ifx\captionline\empty \else 8724 \vskip.5\parskip 8725 \captionline 8726 % 8727 % Space below caption. 8728 \vskip\parskip 8729 \fi 8730 % 8731 % If have an xref label, write the list of floats info. Do this 8732 % after the caption, to avoid chance of it being a breakpoint. 8733 \ifx\floatlabel\empty \else 8734 % Write the text that goes in the lof to the aux file as 8735 % \floatlabel-lof. Besides \floatident, we include the short 8736 % caption if specified, else the full caption if specified, else nothing. 8737 {% 8738 \atdummies 8739 % 8740 % since we read the caption text in the macro world, where ^^M 8741 % is turned into a normal character, we have to scan it back, so 8742 % we don't write the literal three characters "^^M" into the aux file. 8743 \scanexp{% 8744 \xdef\noexpand\gtemp{% 8745 \ifx\thisshortcaption\empty 8746 \thiscaption 8747 \else 8748 \thisshortcaption 8749 \fi 8750 }% 8751 }% 8752 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident 8753 \ifx\gtemp\empty \else : \gtemp \fi}}% 8754 }% 8755 \fi 8756 \egroup % end of \vtop 8757 % 8758 % place the captured inserts 8759 % 8760 % BEWARE: when the floats start floating, we have to issue warning 8761 % whenever an insert appears inside a float which could possibly 8762 % float. --kasal, 26may04 8763 % 8764 \checkinserts 8765} 8766 8767% Append the tokens #2 to the definition of macro #1, not expanding either. 8768% 8769\def\appendtomacro#1#2{% 8770 \expandafter\def\expandafter#1\expandafter{#1#2}% 8771} 8772 8773% @caption, @shortcaption 8774% 8775\def\caption{\docaption\thiscaption} 8776\def\shortcaption{\docaption\thisshortcaption} 8777\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption} 8778\def\defcaption#1#2{\egroup \def#1{#2}} 8779 8780% The parameter is the control sequence identifying the counter we are 8781% going to use. Create it if it doesn't exist and assign it to \floatno. 8782\def\getfloatno#1{% 8783 \ifx#1\relax 8784 % Haven't seen this figure type before. 8785 \csname newcount\endcsname #1% 8786 % 8787 % Remember to reset this floatno at the next chap. 8788 \expandafter\gdef\expandafter\resetallfloatnos 8789 \expandafter{\resetallfloatnos #1=0 }% 8790 \fi 8791 \let\floatno#1% 8792} 8793 8794% \setref calls this to get the XREFLABEL-snt value. We want an @xref 8795% to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we 8796% first read the @float command. 8797% 8798\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% 8799 8800% Magic string used for the XREFLABEL-title value, so \xrefX can 8801% distinguish floats from other xref types. 8802\def\floatmagic{!!float!!} 8803 8804% #1 is the control sequence we are passed; we expand into a conditional 8805% which is true if #1 represents a float ref. That is, the magic 8806% \lastsection value which we \setref above. 8807% 8808\def\iffloat#1{\expandafter\doiffloat#1==\finish} 8809% 8810% #1 is (maybe) the \floatmagic string. If so, #2 will be the 8811% (safe) float type for this float. We set \iffloattype to #2. 8812% 8813\def\doiffloat#1=#2=#3\finish{% 8814 \def\temp{#1}% 8815 \def\iffloattype{#2}% 8816 \ifx\temp\floatmagic 8817} 8818 8819% @listoffloats FLOATTYPE - print a list of floats like a table of contents. 8820% 8821\parseargdef\listoffloats{% 8822 \def\floattype{#1}% floattype 8823 {% 8824 % the floattype might have accents or other special characters, 8825 % but we need to use it in a control sequence name. 8826 \indexnofonts 8827 \turnoffactive 8828 \xdef\safefloattype{\floattype}% 8829 }% 8830 % 8831 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. 8832 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax 8833 \ifhavexrefs 8834 % if the user said @listoffloats foo but never @float foo. 8835 \message{\linenumber No `\safefloattype' floats to list.}% 8836 \fi 8837 \else 8838 \begingroup 8839 \leftskip=\tocindent % indent these entries like a toc 8840 \let\do=\listoffloatsdo 8841 \csname floatlist\safefloattype\endcsname 8842 \endgroup 8843 \fi 8844} 8845 8846% This is called on each entry in a list of floats. We're passed the 8847% xref label, in the form LABEL-title, which is how we save it in the 8848% aux file. We strip off the -title and look up \XRLABEL-lof, which 8849% has the text we're supposed to typeset here. 8850% 8851% Figures without xref labels will not be included in the list (since 8852% they won't appear in the aux file). 8853% 8854\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} 8855\def\listoffloatsdoentry#1-title\finish{{% 8856 % Can't fully expand XR#1-lof because it can contain anything. Just 8857 % pass the control sequence. On the other hand, XR#1-pg is just the 8858 % page number, and we want to fully expand that so we can get a link 8859 % in pdf output. 8860 \toksA = \expandafter{\csname XR#1-lof\endcsname}% 8861 % 8862 % use the same \entry macro we use to generate the TOC and index. 8863 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}% 8864 \writeentry 8865}} 8866 8867 8868\message{localization,} 8869 8870% For single-language documents, @documentlanguage is usually given very 8871% early, just after @documentencoding. Single argument is the language 8872% (de) or locale (de_DE) abbreviation. 8873% 8874{ 8875 \catcode`\_ = \active 8876 \globaldefs=1 8877\parseargdef\documentlanguage{% 8878 \tex % read txi-??.tex file in plain TeX. 8879 % Read the file by the name they passed if it exists. 8880 \let_ = \normalunderscore % normal _ character for filename test 8881 \openin 1 txi-#1.tex 8882 \ifeof 1 8883 \documentlanguagetrywithoutunderscore #1_\finish 8884 \else 8885 \globaldefs = 1 % everything in the txi-LL files needs to persist 8886 \input txi-#1.tex 8887 \fi 8888 \closein 1 8889 \endgroup % end raw TeX 8890} 8891% 8892% If they passed de_DE, and txi-de_DE.tex doesn't exist, 8893% try txi-de.tex. 8894% 8895\gdef\documentlanguagetrywithoutunderscore#1_#2\finish{% 8896 \openin 1 txi-#1.tex 8897 \ifeof 1 8898 \errhelp = \nolanghelp 8899 \errmessage{Cannot read language file txi-#1.tex}% 8900 \else 8901 \globaldefs = 1 % everything in the txi-LL files needs to persist 8902 \input txi-#1.tex 8903 \fi 8904 \closein 1 8905} 8906}% end of special _ catcode 8907% 8908\newhelp\nolanghelp{The given language definition file cannot be found or 8909is empty. Maybe you need to install it? Putting it in the current 8910directory should work if nowhere else does.} 8911 8912% This macro is called from txi-??.tex files; the first argument is the 8913% \language name to set (without the "\lang@" prefix), the second and 8914% third args are \{left,right}hyphenmin. 8915% 8916% The language names to pass are determined when the format is built. 8917% See the etex.log file created at that time, e.g., 8918% /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log. 8919% 8920% With TeX Live 2008, etex now includes hyphenation patterns for all 8921% available languages. This means we can support hyphenation in 8922% Texinfo, at least to some extent. (This still doesn't solve the 8923% accented characters problem.) 8924% 8925\catcode`@=11 8926\def\txisetlanguage#1#2#3{% 8927 % do not set the language if the name is undefined in the current TeX. 8928 \expandafter\ifx\csname lang@#1\endcsname \relax 8929 \message{no patterns for #1}% 8930 \else 8931 \global\language = \csname lang@#1\endcsname 8932 \fi 8933 % but there is no harm in adjusting the hyphenmin values regardless. 8934 \global\lefthyphenmin = #2\relax 8935 \global\righthyphenmin = #3\relax 8936} 8937 8938% Helpers for encodings. 8939% Set the catcode of characters 128 through 255 to the specified number. 8940% 8941\def\setnonasciicharscatcode#1{% 8942 \count255=128 8943 \loop\ifnum\count255<256 8944 \global\catcode\count255=#1\relax 8945 \advance\count255 by 1 8946 \repeat 8947} 8948 8949\def\setnonasciicharscatcodenonglobal#1{% 8950 \count255=128 8951 \loop\ifnum\count255<256 8952 \catcode\count255=#1\relax 8953 \advance\count255 by 1 8954 \repeat 8955} 8956 8957% @documentencoding sets the definition of non-ASCII characters 8958% according to the specified encoding. 8959% 8960\parseargdef\documentencoding{% 8961 % Encoding being declared for the document. 8962 \def\declaredencoding{\csname #1.enc\endcsname}% 8963 % 8964 % Supported encodings: names converted to tokens in order to be able 8965 % to compare them with \ifx. 8966 \def\ascii{\csname US-ASCII.enc\endcsname}% 8967 \def\latnine{\csname ISO-8859-15.enc\endcsname}% 8968 \def\latone{\csname ISO-8859-1.enc\endcsname}% 8969 \def\lattwo{\csname ISO-8859-2.enc\endcsname}% 8970 \def\utfeight{\csname UTF-8.enc\endcsname}% 8971 % 8972 \ifx \declaredencoding \ascii 8973 \asciichardefs 8974 % 8975 \else \ifx \declaredencoding \lattwo 8976 \setnonasciicharscatcode\active 8977 \lattwochardefs 8978 % 8979 \else \ifx \declaredencoding \latone 8980 \setnonasciicharscatcode\active 8981 \latonechardefs 8982 % 8983 \else \ifx \declaredencoding \latnine 8984 \setnonasciicharscatcode\active 8985 \latninechardefs 8986 % 8987 \else \ifx \declaredencoding \utfeight 8988 \setnonasciicharscatcode\active 8989 \utfeightchardefs 8990 % 8991 \else 8992 \message{Unknown document encoding #1, ignoring.}% 8993 % 8994 \fi % utfeight 8995 \fi % latnine 8996 \fi % latone 8997 \fi % lattwo 8998 \fi % ascii 8999} 9000 9001% A message to be logged when using a character that isn't available 9002% the default font encoding (OT1). 9003% 9004\def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}} 9005 9006% Take account of \c (plain) vs. \, (Texinfo) difference. 9007\def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi} 9008 9009% First, make active non-ASCII characters in order for them to be 9010% correctly categorized when TeX reads the replacement text of 9011% macros containing the character definitions. 9012\setnonasciicharscatcode\active 9013% 9014% Latin1 (ISO-8859-1) character definitions. 9015\def\latonechardefs{% 9016 \gdef^^a0{\tie} 9017 \gdef^^a1{\exclamdown} 9018 \gdef^^a2{\missingcharmsg{CENT SIGN}} 9019 \gdef^^a3{{\pounds}} 9020 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} 9021 \gdef^^a5{\missingcharmsg{YEN SIGN}} 9022 \gdef^^a6{\missingcharmsg{BROKEN BAR}} 9023 \gdef^^a7{\S} 9024 \gdef^^a8{\"{}} 9025 \gdef^^a9{\copyright} 9026 \gdef^^aa{\ordf} 9027 \gdef^^ab{\guillemetleft} 9028 \gdef^^ac{$\lnot$} 9029 \gdef^^ad{\-} 9030 \gdef^^ae{\registeredsymbol} 9031 \gdef^^af{\={}} 9032 % 9033 \gdef^^b0{\textdegree} 9034 \gdef^^b1{$\pm$} 9035 \gdef^^b2{$^2$} 9036 \gdef^^b3{$^3$} 9037 \gdef^^b4{\'{}} 9038 \gdef^^b5{$\mu$} 9039 \gdef^^b6{\P} 9040 % 9041 \gdef^^b7{$^.$} 9042 \gdef^^b8{\cedilla\ } 9043 \gdef^^b9{$^1$} 9044 \gdef^^ba{\ordm} 9045 % 9046 \gdef^^bb{\guillemetright} 9047 \gdef^^bc{$1\over4$} 9048 \gdef^^bd{$1\over2$} 9049 \gdef^^be{$3\over4$} 9050 \gdef^^bf{\questiondown} 9051 % 9052 \gdef^^c0{\`A} 9053 \gdef^^c1{\'A} 9054 \gdef^^c2{\^A} 9055 \gdef^^c3{\~A} 9056 \gdef^^c4{\"A} 9057 \gdef^^c5{\ringaccent A} 9058 \gdef^^c6{\AE} 9059 \gdef^^c7{\cedilla C} 9060 \gdef^^c8{\`E} 9061 \gdef^^c9{\'E} 9062 \gdef^^ca{\^E} 9063 \gdef^^cb{\"E} 9064 \gdef^^cc{\`I} 9065 \gdef^^cd{\'I} 9066 \gdef^^ce{\^I} 9067 \gdef^^cf{\"I} 9068 % 9069 \gdef^^d0{\DH} 9070 \gdef^^d1{\~N} 9071 \gdef^^d2{\`O} 9072 \gdef^^d3{\'O} 9073 \gdef^^d4{\^O} 9074 \gdef^^d5{\~O} 9075 \gdef^^d6{\"O} 9076 \gdef^^d7{$\times$} 9077 \gdef^^d8{\O} 9078 \gdef^^d9{\`U} 9079 \gdef^^da{\'U} 9080 \gdef^^db{\^U} 9081 \gdef^^dc{\"U} 9082 \gdef^^dd{\'Y} 9083 \gdef^^de{\TH} 9084 \gdef^^df{\ss} 9085 % 9086 \gdef^^e0{\`a} 9087 \gdef^^e1{\'a} 9088 \gdef^^e2{\^a} 9089 \gdef^^e3{\~a} 9090 \gdef^^e4{\"a} 9091 \gdef^^e5{\ringaccent a} 9092 \gdef^^e6{\ae} 9093 \gdef^^e7{\cedilla c} 9094 \gdef^^e8{\`e} 9095 \gdef^^e9{\'e} 9096 \gdef^^ea{\^e} 9097 \gdef^^eb{\"e} 9098 \gdef^^ec{\`{\dotless i}} 9099 \gdef^^ed{\'{\dotless i}} 9100 \gdef^^ee{\^{\dotless i}} 9101 \gdef^^ef{\"{\dotless i}} 9102 % 9103 \gdef^^f0{\dh} 9104 \gdef^^f1{\~n} 9105 \gdef^^f2{\`o} 9106 \gdef^^f3{\'o} 9107 \gdef^^f4{\^o} 9108 \gdef^^f5{\~o} 9109 \gdef^^f6{\"o} 9110 \gdef^^f7{$\div$} 9111 \gdef^^f8{\o} 9112 \gdef^^f9{\`u} 9113 \gdef^^fa{\'u} 9114 \gdef^^fb{\^u} 9115 \gdef^^fc{\"u} 9116 \gdef^^fd{\'y} 9117 \gdef^^fe{\th} 9118 \gdef^^ff{\"y} 9119} 9120 9121% Latin9 (ISO-8859-15) encoding character definitions. 9122\def\latninechardefs{% 9123 % Encoding is almost identical to Latin1. 9124 \latonechardefs 9125 % 9126 \gdef^^a4{\euro} 9127 \gdef^^a6{\v S} 9128 \gdef^^a8{\v s} 9129 \gdef^^b4{\v Z} 9130 \gdef^^b8{\v z} 9131 \gdef^^bc{\OE} 9132 \gdef^^bd{\oe} 9133 \gdef^^be{\"Y} 9134} 9135 9136% Latin2 (ISO-8859-2) character definitions. 9137\def\lattwochardefs{% 9138 \gdef^^a0{\tie} 9139 \gdef^^a1{\ogonek{A}} 9140 \gdef^^a2{\u{}} 9141 \gdef^^a3{\L} 9142 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} 9143 \gdef^^a5{\v L} 9144 \gdef^^a6{\'S} 9145 \gdef^^a7{\S} 9146 \gdef^^a8{\"{}} 9147 \gdef^^a9{\v S} 9148 \gdef^^aa{\cedilla S} 9149 \gdef^^ab{\v T} 9150 \gdef^^ac{\'Z} 9151 \gdef^^ad{\-} 9152 \gdef^^ae{\v Z} 9153 \gdef^^af{\dotaccent Z} 9154 % 9155 \gdef^^b0{\textdegree} 9156 \gdef^^b1{\ogonek{a}} 9157 \gdef^^b2{\ogonek{ }} 9158 \gdef^^b3{\l} 9159 \gdef^^b4{\'{}} 9160 \gdef^^b5{\v l} 9161 \gdef^^b6{\'s} 9162 \gdef^^b7{\v{}} 9163 \gdef^^b8{\cedilla\ } 9164 \gdef^^b9{\v s} 9165 \gdef^^ba{\cedilla s} 9166 \gdef^^bb{\v t} 9167 \gdef^^bc{\'z} 9168 \gdef^^bd{\H{}} 9169 \gdef^^be{\v z} 9170 \gdef^^bf{\dotaccent z} 9171 % 9172 \gdef^^c0{\'R} 9173 \gdef^^c1{\'A} 9174 \gdef^^c2{\^A} 9175 \gdef^^c3{\u A} 9176 \gdef^^c4{\"A} 9177 \gdef^^c5{\'L} 9178 \gdef^^c6{\'C} 9179 \gdef^^c7{\cedilla C} 9180 \gdef^^c8{\v C} 9181 \gdef^^c9{\'E} 9182 \gdef^^ca{\ogonek{E}} 9183 \gdef^^cb{\"E} 9184 \gdef^^cc{\v E} 9185 \gdef^^cd{\'I} 9186 \gdef^^ce{\^I} 9187 \gdef^^cf{\v D} 9188 % 9189 \gdef^^d0{\DH} 9190 \gdef^^d1{\'N} 9191 \gdef^^d2{\v N} 9192 \gdef^^d3{\'O} 9193 \gdef^^d4{\^O} 9194 \gdef^^d5{\H O} 9195 \gdef^^d6{\"O} 9196 \gdef^^d7{$\times$} 9197 \gdef^^d8{\v R} 9198 \gdef^^d9{\ringaccent U} 9199 \gdef^^da{\'U} 9200 \gdef^^db{\H U} 9201 \gdef^^dc{\"U} 9202 \gdef^^dd{\'Y} 9203 \gdef^^de{\cedilla T} 9204 \gdef^^df{\ss} 9205 % 9206 \gdef^^e0{\'r} 9207 \gdef^^e1{\'a} 9208 \gdef^^e2{\^a} 9209 \gdef^^e3{\u a} 9210 \gdef^^e4{\"a} 9211 \gdef^^e5{\'l} 9212 \gdef^^e6{\'c} 9213 \gdef^^e7{\cedilla c} 9214 \gdef^^e8{\v c} 9215 \gdef^^e9{\'e} 9216 \gdef^^ea{\ogonek{e}} 9217 \gdef^^eb{\"e} 9218 \gdef^^ec{\v e} 9219 \gdef^^ed{\'{\dotless{i}}} 9220 \gdef^^ee{\^{\dotless{i}}} 9221 \gdef^^ef{\v d} 9222 % 9223 \gdef^^f0{\dh} 9224 \gdef^^f1{\'n} 9225 \gdef^^f2{\v n} 9226 \gdef^^f3{\'o} 9227 \gdef^^f4{\^o} 9228 \gdef^^f5{\H o} 9229 \gdef^^f6{\"o} 9230 \gdef^^f7{$\div$} 9231 \gdef^^f8{\v r} 9232 \gdef^^f9{\ringaccent u} 9233 \gdef^^fa{\'u} 9234 \gdef^^fb{\H u} 9235 \gdef^^fc{\"u} 9236 \gdef^^fd{\'y} 9237 \gdef^^fe{\cedilla t} 9238 \gdef^^ff{\dotaccent{}} 9239} 9240 9241% UTF-8 character definitions. 9242% 9243% This code to support UTF-8 is based on LaTeX's utf8.def, with some 9244% changes for Texinfo conventions. It is included here under the GPL by 9245% permission from Frank Mittelbach and the LaTeX team. 9246% 9247\newcount\countUTFx 9248\newcount\countUTFy 9249\newcount\countUTFz 9250 9251\gdef\UTFviiiTwoOctets#1#2{\expandafter 9252 \UTFviiiDefined\csname u8:#1\string #2\endcsname} 9253% 9254\gdef\UTFviiiThreeOctets#1#2#3{\expandafter 9255 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname} 9256% 9257\gdef\UTFviiiFourOctets#1#2#3#4{\expandafter 9258 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname} 9259 9260\gdef\UTFviiiDefined#1{% 9261 \ifx #1\relax 9262 \message{\linenumber Unicode char \string #1 not defined for Texinfo}% 9263 \else 9264 \expandafter #1% 9265 \fi 9266} 9267 9268\begingroup 9269 \catcode`\~13 9270 \catcode`\"12 9271 9272 \def\UTFviiiLoop{% 9273 \global\catcode\countUTFx\active 9274 \uccode`\~\countUTFx 9275 \uppercase\expandafter{\UTFviiiTmp}% 9276 \advance\countUTFx by 1 9277 \ifnum\countUTFx < \countUTFy 9278 \expandafter\UTFviiiLoop 9279 \fi} 9280 9281 \countUTFx = "C2 9282 \countUTFy = "E0 9283 \def\UTFviiiTmp{% 9284 \xdef~{\noexpand\UTFviiiTwoOctets\string~}} 9285 \UTFviiiLoop 9286 9287 \countUTFx = "E0 9288 \countUTFy = "F0 9289 \def\UTFviiiTmp{% 9290 \xdef~{\noexpand\UTFviiiThreeOctets\string~}} 9291 \UTFviiiLoop 9292 9293 \countUTFx = "F0 9294 \countUTFy = "F4 9295 \def\UTFviiiTmp{% 9296 \xdef~{\noexpand\UTFviiiFourOctets\string~}} 9297 \UTFviiiLoop 9298\endgroup 9299 9300\def\globallet{\global\let} % save some \expandafter's below 9301 9302% @U{xxxx} to produce U+xxxx, if we support it. 9303\def\U#1{% 9304 \expandafter\ifx\csname uni:#1\endcsname \relax 9305 \errhelp = \EMsimple 9306 \errmessage{Unicode character U+#1 not supported, sorry}% 9307 \else 9308 \csname uni:#1\endcsname 9309 \fi 9310} 9311 9312\begingroup 9313 \catcode`\"=12 9314 \catcode`\<=12 9315 \catcode`\.=12 9316 \catcode`\,=12 9317 \catcode`\;=12 9318 \catcode`\!=12 9319 \catcode`\~=13 9320 \gdef\DeclareUnicodeCharacter#1#2{% 9321 \countUTFz = "#1\relax 9322 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% 9323 \begingroup 9324 \parseXMLCharref 9325 \def\UTFviiiTwoOctets##1##2{% 9326 \csname u8:##1\string ##2\endcsname}% 9327 \def\UTFviiiThreeOctets##1##2##3{% 9328 \csname u8:##1\string ##2\string ##3\endcsname}% 9329 \def\UTFviiiFourOctets##1##2##3##4{% 9330 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}% 9331 \expandafter\expandafter\expandafter\expandafter 9332 \expandafter\expandafter\expandafter 9333 \gdef\UTFviiiTmp{#2}% 9334 % define an additional control sequence for this code point. 9335 \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp 9336 \endgroup} 9337 9338 \gdef\parseXMLCharref{% 9339 \ifnum\countUTFz < "A0\relax 9340 \errhelp = \EMsimple 9341 \errmessage{Cannot define Unicode char value < 00A0}% 9342 \else\ifnum\countUTFz < "800\relax 9343 \parseUTFviiiA,% 9344 \parseUTFviiiB C\UTFviiiTwoOctets.,% 9345 \else\ifnum\countUTFz < "10000\relax 9346 \parseUTFviiiA;% 9347 \parseUTFviiiA,% 9348 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}% 9349 \else 9350 \parseUTFviiiA;% 9351 \parseUTFviiiA,% 9352 \parseUTFviiiA!% 9353 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}% 9354 \fi\fi\fi 9355 } 9356 9357 \gdef\parseUTFviiiA#1{% 9358 \countUTFx = \countUTFz 9359 \divide\countUTFz by 64 9360 \countUTFy = \countUTFz 9361 \multiply\countUTFz by 64 9362 \advance\countUTFx by -\countUTFz 9363 \advance\countUTFx by 128 9364 \uccode `#1\countUTFx 9365 \countUTFz = \countUTFy} 9366 9367 \gdef\parseUTFviiiB#1#2#3#4{% 9368 \advance\countUTFz by "#10\relax 9369 \uccode `#3\countUTFz 9370 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}} 9371\endgroup 9372 9373\def\utfeightchardefs{% 9374 \DeclareUnicodeCharacter{00A0}{\tie} 9375 \DeclareUnicodeCharacter{00A1}{\exclamdown} 9376 \DeclareUnicodeCharacter{00A3}{\pounds} 9377 \DeclareUnicodeCharacter{00A8}{\"{ }} 9378 \DeclareUnicodeCharacter{00A9}{\copyright} 9379 \DeclareUnicodeCharacter{00AA}{\ordf} 9380 \DeclareUnicodeCharacter{00AB}{\guillemetleft} 9381 \DeclareUnicodeCharacter{00AD}{\-} 9382 \DeclareUnicodeCharacter{00AE}{\registeredsymbol} 9383 \DeclareUnicodeCharacter{00AF}{\={ }} 9384 9385 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }} 9386 \DeclareUnicodeCharacter{00B4}{\'{ }} 9387 \DeclareUnicodeCharacter{00B8}{\cedilla{ }} 9388 \DeclareUnicodeCharacter{00BA}{\ordm} 9389 \DeclareUnicodeCharacter{00BB}{\guillemetright} 9390 \DeclareUnicodeCharacter{00BF}{\questiondown} 9391 9392 \DeclareUnicodeCharacter{00C0}{\`A} 9393 \DeclareUnicodeCharacter{00C1}{\'A} 9394 \DeclareUnicodeCharacter{00C2}{\^A} 9395 \DeclareUnicodeCharacter{00C3}{\~A} 9396 \DeclareUnicodeCharacter{00C4}{\"A} 9397 \DeclareUnicodeCharacter{00C5}{\AA} 9398 \DeclareUnicodeCharacter{00C6}{\AE} 9399 \DeclareUnicodeCharacter{00C7}{\cedilla{C}} 9400 \DeclareUnicodeCharacter{00C8}{\`E} 9401 \DeclareUnicodeCharacter{00C9}{\'E} 9402 \DeclareUnicodeCharacter{00CA}{\^E} 9403 \DeclareUnicodeCharacter{00CB}{\"E} 9404 \DeclareUnicodeCharacter{00CC}{\`I} 9405 \DeclareUnicodeCharacter{00CD}{\'I} 9406 \DeclareUnicodeCharacter{00CE}{\^I} 9407 \DeclareUnicodeCharacter{00CF}{\"I} 9408 9409 \DeclareUnicodeCharacter{00D0}{\DH} 9410 \DeclareUnicodeCharacter{00D1}{\~N} 9411 \DeclareUnicodeCharacter{00D2}{\`O} 9412 \DeclareUnicodeCharacter{00D3}{\'O} 9413 \DeclareUnicodeCharacter{00D4}{\^O} 9414 \DeclareUnicodeCharacter{00D5}{\~O} 9415 \DeclareUnicodeCharacter{00D6}{\"O} 9416 \DeclareUnicodeCharacter{00D8}{\O} 9417 \DeclareUnicodeCharacter{00D9}{\`U} 9418 \DeclareUnicodeCharacter{00DA}{\'U} 9419 \DeclareUnicodeCharacter{00DB}{\^U} 9420 \DeclareUnicodeCharacter{00DC}{\"U} 9421 \DeclareUnicodeCharacter{00DD}{\'Y} 9422 \DeclareUnicodeCharacter{00DE}{\TH} 9423 \DeclareUnicodeCharacter{00DF}{\ss} 9424 9425 \DeclareUnicodeCharacter{00E0}{\`a} 9426 \DeclareUnicodeCharacter{00E1}{\'a} 9427 \DeclareUnicodeCharacter{00E2}{\^a} 9428 \DeclareUnicodeCharacter{00E3}{\~a} 9429 \DeclareUnicodeCharacter{00E4}{\"a} 9430 \DeclareUnicodeCharacter{00E5}{\aa} 9431 \DeclareUnicodeCharacter{00E6}{\ae} 9432 \DeclareUnicodeCharacter{00E7}{\cedilla{c}} 9433 \DeclareUnicodeCharacter{00E8}{\`e} 9434 \DeclareUnicodeCharacter{00E9}{\'e} 9435 \DeclareUnicodeCharacter{00EA}{\^e} 9436 \DeclareUnicodeCharacter{00EB}{\"e} 9437 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}} 9438 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}} 9439 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}} 9440 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}} 9441 9442 \DeclareUnicodeCharacter{00F0}{\dh} 9443 \DeclareUnicodeCharacter{00F1}{\~n} 9444 \DeclareUnicodeCharacter{00F2}{\`o} 9445 \DeclareUnicodeCharacter{00F3}{\'o} 9446 \DeclareUnicodeCharacter{00F4}{\^o} 9447 \DeclareUnicodeCharacter{00F5}{\~o} 9448 \DeclareUnicodeCharacter{00F6}{\"o} 9449 \DeclareUnicodeCharacter{00F8}{\o} 9450 \DeclareUnicodeCharacter{00F9}{\`u} 9451 \DeclareUnicodeCharacter{00FA}{\'u} 9452 \DeclareUnicodeCharacter{00FB}{\^u} 9453 \DeclareUnicodeCharacter{00FC}{\"u} 9454 \DeclareUnicodeCharacter{00FD}{\'y} 9455 \DeclareUnicodeCharacter{00FE}{\th} 9456 \DeclareUnicodeCharacter{00FF}{\"y} 9457 9458 \DeclareUnicodeCharacter{0100}{\=A} 9459 \DeclareUnicodeCharacter{0101}{\=a} 9460 \DeclareUnicodeCharacter{0102}{\u{A}} 9461 \DeclareUnicodeCharacter{0103}{\u{a}} 9462 \DeclareUnicodeCharacter{0104}{\ogonek{A}} 9463 \DeclareUnicodeCharacter{0105}{\ogonek{a}} 9464 \DeclareUnicodeCharacter{0106}{\'C} 9465 \DeclareUnicodeCharacter{0107}{\'c} 9466 \DeclareUnicodeCharacter{0108}{\^C} 9467 \DeclareUnicodeCharacter{0109}{\^c} 9468 \DeclareUnicodeCharacter{0118}{\ogonek{E}} 9469 \DeclareUnicodeCharacter{0119}{\ogonek{e}} 9470 \DeclareUnicodeCharacter{010A}{\dotaccent{C}} 9471 \DeclareUnicodeCharacter{010B}{\dotaccent{c}} 9472 \DeclareUnicodeCharacter{010C}{\v{C}} 9473 \DeclareUnicodeCharacter{010D}{\v{c}} 9474 \DeclareUnicodeCharacter{010E}{\v{D}} 9475 9476 \DeclareUnicodeCharacter{0112}{\=E} 9477 \DeclareUnicodeCharacter{0113}{\=e} 9478 \DeclareUnicodeCharacter{0114}{\u{E}} 9479 \DeclareUnicodeCharacter{0115}{\u{e}} 9480 \DeclareUnicodeCharacter{0116}{\dotaccent{E}} 9481 \DeclareUnicodeCharacter{0117}{\dotaccent{e}} 9482 \DeclareUnicodeCharacter{011A}{\v{E}} 9483 \DeclareUnicodeCharacter{011B}{\v{e}} 9484 \DeclareUnicodeCharacter{011C}{\^G} 9485 \DeclareUnicodeCharacter{011D}{\^g} 9486 \DeclareUnicodeCharacter{011E}{\u{G}} 9487 \DeclareUnicodeCharacter{011F}{\u{g}} 9488 9489 \DeclareUnicodeCharacter{0120}{\dotaccent{G}} 9490 \DeclareUnicodeCharacter{0121}{\dotaccent{g}} 9491 \DeclareUnicodeCharacter{0124}{\^H} 9492 \DeclareUnicodeCharacter{0125}{\^h} 9493 \DeclareUnicodeCharacter{0128}{\~I} 9494 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}} 9495 \DeclareUnicodeCharacter{012A}{\=I} 9496 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}} 9497 \DeclareUnicodeCharacter{012C}{\u{I}} 9498 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}} 9499 9500 \DeclareUnicodeCharacter{0130}{\dotaccent{I}} 9501 \DeclareUnicodeCharacter{0131}{\dotless{i}} 9502 \DeclareUnicodeCharacter{0132}{IJ} 9503 \DeclareUnicodeCharacter{0133}{ij} 9504 \DeclareUnicodeCharacter{0134}{\^J} 9505 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}} 9506 \DeclareUnicodeCharacter{0139}{\'L} 9507 \DeclareUnicodeCharacter{013A}{\'l} 9508 9509 \DeclareUnicodeCharacter{0141}{\L} 9510 \DeclareUnicodeCharacter{0142}{\l} 9511 \DeclareUnicodeCharacter{0143}{\'N} 9512 \DeclareUnicodeCharacter{0144}{\'n} 9513 \DeclareUnicodeCharacter{0147}{\v{N}} 9514 \DeclareUnicodeCharacter{0148}{\v{n}} 9515 \DeclareUnicodeCharacter{014C}{\=O} 9516 \DeclareUnicodeCharacter{014D}{\=o} 9517 \DeclareUnicodeCharacter{014E}{\u{O}} 9518 \DeclareUnicodeCharacter{014F}{\u{o}} 9519 9520 \DeclareUnicodeCharacter{0150}{\H{O}} 9521 \DeclareUnicodeCharacter{0151}{\H{o}} 9522 \DeclareUnicodeCharacter{0152}{\OE} 9523 \DeclareUnicodeCharacter{0153}{\oe} 9524 \DeclareUnicodeCharacter{0154}{\'R} 9525 \DeclareUnicodeCharacter{0155}{\'r} 9526 \DeclareUnicodeCharacter{0158}{\v{R}} 9527 \DeclareUnicodeCharacter{0159}{\v{r}} 9528 \DeclareUnicodeCharacter{015A}{\'S} 9529 \DeclareUnicodeCharacter{015B}{\'s} 9530 \DeclareUnicodeCharacter{015C}{\^S} 9531 \DeclareUnicodeCharacter{015D}{\^s} 9532 \DeclareUnicodeCharacter{015E}{\cedilla{S}} 9533 \DeclareUnicodeCharacter{015F}{\cedilla{s}} 9534 9535 \DeclareUnicodeCharacter{0160}{\v{S}} 9536 \DeclareUnicodeCharacter{0161}{\v{s}} 9537 \DeclareUnicodeCharacter{0162}{\cedilla{t}} 9538 \DeclareUnicodeCharacter{0163}{\cedilla{T}} 9539 \DeclareUnicodeCharacter{0164}{\v{T}} 9540 9541 \DeclareUnicodeCharacter{0168}{\~U} 9542 \DeclareUnicodeCharacter{0169}{\~u} 9543 \DeclareUnicodeCharacter{016A}{\=U} 9544 \DeclareUnicodeCharacter{016B}{\=u} 9545 \DeclareUnicodeCharacter{016C}{\u{U}} 9546 \DeclareUnicodeCharacter{016D}{\u{u}} 9547 \DeclareUnicodeCharacter{016E}{\ringaccent{U}} 9548 \DeclareUnicodeCharacter{016F}{\ringaccent{u}} 9549 9550 \DeclareUnicodeCharacter{0170}{\H{U}} 9551 \DeclareUnicodeCharacter{0171}{\H{u}} 9552 \DeclareUnicodeCharacter{0174}{\^W} 9553 \DeclareUnicodeCharacter{0175}{\^w} 9554 \DeclareUnicodeCharacter{0176}{\^Y} 9555 \DeclareUnicodeCharacter{0177}{\^y} 9556 \DeclareUnicodeCharacter{0178}{\"Y} 9557 \DeclareUnicodeCharacter{0179}{\'Z} 9558 \DeclareUnicodeCharacter{017A}{\'z} 9559 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}} 9560 \DeclareUnicodeCharacter{017C}{\dotaccent{z}} 9561 \DeclareUnicodeCharacter{017D}{\v{Z}} 9562 \DeclareUnicodeCharacter{017E}{\v{z}} 9563 9564 \DeclareUnicodeCharacter{01C4}{D\v{Z}} 9565 \DeclareUnicodeCharacter{01C5}{D\v{z}} 9566 \DeclareUnicodeCharacter{01C6}{d\v{z}} 9567 \DeclareUnicodeCharacter{01C7}{LJ} 9568 \DeclareUnicodeCharacter{01C8}{Lj} 9569 \DeclareUnicodeCharacter{01C9}{lj} 9570 \DeclareUnicodeCharacter{01CA}{NJ} 9571 \DeclareUnicodeCharacter{01CB}{Nj} 9572 \DeclareUnicodeCharacter{01CC}{nj} 9573 \DeclareUnicodeCharacter{01CD}{\v{A}} 9574 \DeclareUnicodeCharacter{01CE}{\v{a}} 9575 \DeclareUnicodeCharacter{01CF}{\v{I}} 9576 9577 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}} 9578 \DeclareUnicodeCharacter{01D1}{\v{O}} 9579 \DeclareUnicodeCharacter{01D2}{\v{o}} 9580 \DeclareUnicodeCharacter{01D3}{\v{U}} 9581 \DeclareUnicodeCharacter{01D4}{\v{u}} 9582 9583 \DeclareUnicodeCharacter{01E2}{\={\AE}} 9584 \DeclareUnicodeCharacter{01E3}{\={\ae}} 9585 \DeclareUnicodeCharacter{01E6}{\v{G}} 9586 \DeclareUnicodeCharacter{01E7}{\v{g}} 9587 \DeclareUnicodeCharacter{01E8}{\v{K}} 9588 \DeclareUnicodeCharacter{01E9}{\v{k}} 9589 9590 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}} 9591 \DeclareUnicodeCharacter{01F1}{DZ} 9592 \DeclareUnicodeCharacter{01F2}{Dz} 9593 \DeclareUnicodeCharacter{01F3}{dz} 9594 \DeclareUnicodeCharacter{01F4}{\'G} 9595 \DeclareUnicodeCharacter{01F5}{\'g} 9596 \DeclareUnicodeCharacter{01F8}{\`N} 9597 \DeclareUnicodeCharacter{01F9}{\`n} 9598 \DeclareUnicodeCharacter{01FC}{\'{\AE}} 9599 \DeclareUnicodeCharacter{01FD}{\'{\ae}} 9600 \DeclareUnicodeCharacter{01FE}{\'{\O}} 9601 \DeclareUnicodeCharacter{01FF}{\'{\o}} 9602 9603 \DeclareUnicodeCharacter{021E}{\v{H}} 9604 \DeclareUnicodeCharacter{021F}{\v{h}} 9605 9606 \DeclareUnicodeCharacter{0226}{\dotaccent{A}} 9607 \DeclareUnicodeCharacter{0227}{\dotaccent{a}} 9608 \DeclareUnicodeCharacter{0228}{\cedilla{E}} 9609 \DeclareUnicodeCharacter{0229}{\cedilla{e}} 9610 \DeclareUnicodeCharacter{022E}{\dotaccent{O}} 9611 \DeclareUnicodeCharacter{022F}{\dotaccent{o}} 9612 9613 \DeclareUnicodeCharacter{0232}{\=Y} 9614 \DeclareUnicodeCharacter{0233}{\=y} 9615 \DeclareUnicodeCharacter{0237}{\dotless{j}} 9616 9617 \DeclareUnicodeCharacter{02DB}{\ogonek{ }} 9618 9619 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}} 9620 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}} 9621 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}} 9622 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}} 9623 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}} 9624 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}} 9625 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}} 9626 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}} 9627 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}} 9628 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}} 9629 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}} 9630 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}} 9631 9632 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}} 9633 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}} 9634 9635 \DeclareUnicodeCharacter{1E20}{\=G} 9636 \DeclareUnicodeCharacter{1E21}{\=g} 9637 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}} 9638 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}} 9639 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}} 9640 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}} 9641 \DeclareUnicodeCharacter{1E26}{\"H} 9642 \DeclareUnicodeCharacter{1E27}{\"h} 9643 9644 \DeclareUnicodeCharacter{1E30}{\'K} 9645 \DeclareUnicodeCharacter{1E31}{\'k} 9646 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}} 9647 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}} 9648 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}} 9649 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}} 9650 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}} 9651 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}} 9652 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}} 9653 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}} 9654 \DeclareUnicodeCharacter{1E3E}{\'M} 9655 \DeclareUnicodeCharacter{1E3F}{\'m} 9656 9657 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}} 9658 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}} 9659 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}} 9660 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}} 9661 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}} 9662 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}} 9663 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}} 9664 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}} 9665 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}} 9666 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}} 9667 9668 \DeclareUnicodeCharacter{1E54}{\'P} 9669 \DeclareUnicodeCharacter{1E55}{\'p} 9670 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}} 9671 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}} 9672 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}} 9673 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}} 9674 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}} 9675 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}} 9676 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}} 9677 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}} 9678 9679 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}} 9680 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}} 9681 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}} 9682 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}} 9683 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}} 9684 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}} 9685 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}} 9686 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}} 9687 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}} 9688 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}} 9689 9690 \DeclareUnicodeCharacter{1E7C}{\~V} 9691 \DeclareUnicodeCharacter{1E7D}{\~v} 9692 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}} 9693 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}} 9694 9695 \DeclareUnicodeCharacter{1E80}{\`W} 9696 \DeclareUnicodeCharacter{1E81}{\`w} 9697 \DeclareUnicodeCharacter{1E82}{\'W} 9698 \DeclareUnicodeCharacter{1E83}{\'w} 9699 \DeclareUnicodeCharacter{1E84}{\"W} 9700 \DeclareUnicodeCharacter{1E85}{\"w} 9701 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}} 9702 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}} 9703 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}} 9704 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}} 9705 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}} 9706 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}} 9707 \DeclareUnicodeCharacter{1E8C}{\"X} 9708 \DeclareUnicodeCharacter{1E8D}{\"x} 9709 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}} 9710 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}} 9711 9712 \DeclareUnicodeCharacter{1E90}{\^Z} 9713 \DeclareUnicodeCharacter{1E91}{\^z} 9714 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}} 9715 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}} 9716 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}} 9717 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}} 9718 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}} 9719 \DeclareUnicodeCharacter{1E97}{\"t} 9720 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}} 9721 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}} 9722 9723 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}} 9724 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}} 9725 9726 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}} 9727 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}} 9728 \DeclareUnicodeCharacter{1EBC}{\~E} 9729 \DeclareUnicodeCharacter{1EBD}{\~e} 9730 9731 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}} 9732 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}} 9733 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}} 9734 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}} 9735 9736 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}} 9737 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}} 9738 9739 \DeclareUnicodeCharacter{1EF2}{\`Y} 9740 \DeclareUnicodeCharacter{1EF3}{\`y} 9741 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}} 9742 9743 \DeclareUnicodeCharacter{1EF8}{\~Y} 9744 \DeclareUnicodeCharacter{1EF9}{\~y} 9745 9746 \DeclareUnicodeCharacter{2013}{--} 9747 \DeclareUnicodeCharacter{2014}{---} 9748 \DeclareUnicodeCharacter{2018}{\quoteleft} 9749 \DeclareUnicodeCharacter{2019}{\quoteright} 9750 \DeclareUnicodeCharacter{201A}{\quotesinglbase} 9751 \DeclareUnicodeCharacter{201C}{\quotedblleft} 9752 \DeclareUnicodeCharacter{201D}{\quotedblright} 9753 \DeclareUnicodeCharacter{201E}{\quotedblbase} 9754 \DeclareUnicodeCharacter{2022}{\bullet} 9755 \DeclareUnicodeCharacter{2026}{\dots} 9756 \DeclareUnicodeCharacter{2039}{\guilsinglleft} 9757 \DeclareUnicodeCharacter{203A}{\guilsinglright} 9758 \DeclareUnicodeCharacter{20AC}{\euro} 9759 9760 \DeclareUnicodeCharacter{2192}{\expansion} 9761 \DeclareUnicodeCharacter{21D2}{\result} 9762 9763 \DeclareUnicodeCharacter{2212}{\minus} 9764 \DeclareUnicodeCharacter{2217}{\point} 9765 \DeclareUnicodeCharacter{2261}{\equiv} 9766}% end of \utfeightchardefs 9767 9768 9769% US-ASCII character definitions. 9770\def\asciichardefs{% nothing need be done 9771 \relax 9772} 9773 9774% Make non-ASCII characters printable again for compatibility with 9775% existing Texinfo documents that may use them, even without declaring a 9776% document encoding. 9777% 9778\setnonasciicharscatcode \other 9779 9780 9781\message{formatting,} 9782 9783\newdimen\defaultparindent \defaultparindent = 15pt 9784 9785\chapheadingskip = 15pt plus 4pt minus 2pt 9786\secheadingskip = 12pt plus 3pt minus 2pt 9787\subsecheadingskip = 9pt plus 2pt minus 2pt 9788 9789% Prevent underfull vbox error messages. 9790\vbadness = 10000 9791 9792% Don't be very finicky about underfull hboxes, either. 9793\hbadness = 6666 9794 9795% Following George Bush, get rid of widows and orphans. 9796\widowpenalty=10000 9797\clubpenalty=10000 9798 9799% Use TeX 3.0's \emergencystretch to help line breaking, but if we're 9800% using an old version of TeX, don't do anything. We want the amount of 9801% stretch added to depend on the line length, hence the dependence on 9802% \hsize. We call this whenever the paper size is set. 9803% 9804\def\setemergencystretch{% 9805 \ifx\emergencystretch\thisisundefined 9806 % Allow us to assign to \emergencystretch anyway. 9807 \def\emergencystretch{\dimen0}% 9808 \else 9809 \emergencystretch = .15\hsize 9810 \fi 9811} 9812 9813% Parameters in order: 1) textheight; 2) textwidth; 9814% 3) voffset; 4) hoffset; 5) binding offset; 6) topskip; 9815% 7) physical page height; 8) physical page width. 9816% 9817% We also call \setleading{\textleading}, so the caller should define 9818% \textleading. The caller should also set \parskip. 9819% 9820\def\internalpagesizes#1#2#3#4#5#6#7#8{% 9821 \voffset = #3\relax 9822 \topskip = #6\relax 9823 \splittopskip = \topskip 9824 % 9825 \vsize = #1\relax 9826 \advance\vsize by \topskip 9827 \outervsize = \vsize 9828 \advance\outervsize by 2\topandbottommargin 9829 \pageheight = \vsize 9830 % 9831 \hsize = #2\relax 9832 \outerhsize = \hsize 9833 \advance\outerhsize by 0.5in 9834 \pagewidth = \hsize 9835 % 9836 \normaloffset = #4\relax 9837 \bindingoffset = #5\relax 9838 % 9839 \ifpdf 9840 \pdfpageheight #7\relax 9841 \pdfpagewidth #8\relax 9842 % if we don't reset these, they will remain at "1 true in" of 9843 % whatever layout pdftex was dumped with. 9844 \pdfhorigin = 1 true in 9845 \pdfvorigin = 1 true in 9846 \fi 9847 % 9848 \setleading{\textleading} 9849 % 9850 \parindent = \defaultparindent 9851 \setemergencystretch 9852} 9853 9854% @letterpaper (the default). 9855\def\letterpaper{{\globaldefs = 1 9856 \parskip = 3pt plus 2pt minus 1pt 9857 \textleading = 13.2pt 9858 % 9859 % If page is nothing but text, make it come out even. 9860 \internalpagesizes{607.2pt}{6in}% that's 46 lines 9861 {\voffset}{.25in}% 9862 {\bindingoffset}{36pt}% 9863 {11in}{8.5in}% 9864}} 9865 9866% Use @smallbook to reset parameters for 7x9.25 trim size. 9867\def\smallbook{{\globaldefs = 1 9868 \parskip = 2pt plus 1pt 9869 \textleading = 12pt 9870 % 9871 \internalpagesizes{7.5in}{5in}% 9872 {-.2in}{0in}% 9873 {\bindingoffset}{16pt}% 9874 {9.25in}{7in}% 9875 % 9876 \lispnarrowing = 0.3in 9877 \tolerance = 700 9878 \hfuzz = 1pt 9879 \contentsrightmargin = 0pt 9880 \defbodyindent = .5cm 9881}} 9882 9883% Use @smallerbook to reset parameters for 6x9 trim size. 9884% (Just testing, parameters still in flux.) 9885\def\smallerbook{{\globaldefs = 1 9886 \parskip = 1.5pt plus 1pt 9887 \textleading = 12pt 9888 % 9889 \internalpagesizes{7.4in}{4.8in}% 9890 {-.2in}{-.4in}% 9891 {0pt}{14pt}% 9892 {9in}{6in}% 9893 % 9894 \lispnarrowing = 0.25in 9895 \tolerance = 700 9896 \hfuzz = 1pt 9897 \contentsrightmargin = 0pt 9898 \defbodyindent = .4cm 9899}} 9900 9901% Use @afourpaper to print on European A4 paper. 9902\def\afourpaper{{\globaldefs = 1 9903 \parskip = 3pt plus 2pt minus 1pt 9904 \textleading = 13.2pt 9905 % 9906 % Double-side printing via postscript on Laserjet 4050 9907 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. 9908 % To change the settings for a different printer or situation, adjust 9909 % \normaloffset until the front-side and back-side texts align. Then 9910 % do the same for \bindingoffset. You can set these for testing in 9911 % your texinfo source file like this: 9912 % @tex 9913 % \global\normaloffset = -6mm 9914 % \global\bindingoffset = 10mm 9915 % @end tex 9916 \internalpagesizes{673.2pt}{160mm}% that's 51 lines 9917 {\voffset}{\hoffset}% 9918 {\bindingoffset}{44pt}% 9919 {297mm}{210mm}% 9920 % 9921 \tolerance = 700 9922 \hfuzz = 1pt 9923 \contentsrightmargin = 0pt 9924 \defbodyindent = 5mm 9925}} 9926 9927% Use @afivepaper to print on European A5 paper. 9928% From romildo@urano.iceb.ufop.br, 2 July 2000. 9929% He also recommends making @example and @lisp be small. 9930\def\afivepaper{{\globaldefs = 1 9931 \parskip = 2pt plus 1pt minus 0.1pt 9932 \textleading = 12.5pt 9933 % 9934 \internalpagesizes{160mm}{120mm}% 9935 {\voffset}{\hoffset}% 9936 {\bindingoffset}{8pt}% 9937 {210mm}{148mm}% 9938 % 9939 \lispnarrowing = 0.2in 9940 \tolerance = 800 9941 \hfuzz = 1.2pt 9942 \contentsrightmargin = 0pt 9943 \defbodyindent = 2mm 9944 \tableindent = 12mm 9945}} 9946 9947% A specific text layout, 24x15cm overall, intended for A4 paper. 9948\def\afourlatex{{\globaldefs = 1 9949 \afourpaper 9950 \internalpagesizes{237mm}{150mm}% 9951 {\voffset}{4.6mm}% 9952 {\bindingoffset}{7mm}% 9953 {297mm}{210mm}% 9954 % 9955 % Must explicitly reset to 0 because we call \afourpaper. 9956 \globaldefs = 0 9957}} 9958 9959% Use @afourwide to print on A4 paper in landscape format. 9960\def\afourwide{{\globaldefs = 1 9961 \afourpaper 9962 \internalpagesizes{241mm}{165mm}% 9963 {\voffset}{-2.95mm}% 9964 {\bindingoffset}{7mm}% 9965 {297mm}{210mm}% 9966 \globaldefs = 0 9967}} 9968 9969% @pagesizes TEXTHEIGHT[,TEXTWIDTH] 9970% Perhaps we should allow setting the margins, \topskip, \parskip, 9971% and/or leading, also. Or perhaps we should compute them somehow. 9972% 9973\parseargdef\pagesizes{\pagesizesyyy #1,,\finish} 9974\def\pagesizesyyy#1,#2,#3\finish{{% 9975 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi 9976 \globaldefs = 1 9977 % 9978 \parskip = 3pt plus 2pt minus 1pt 9979 \setleading{\textleading}% 9980 % 9981 \dimen0 = #1\relax 9982 \advance\dimen0 by \voffset 9983 % 9984 \dimen2 = \hsize 9985 \advance\dimen2 by \normaloffset 9986 % 9987 \internalpagesizes{#1}{\hsize}% 9988 {\voffset}{\normaloffset}% 9989 {\bindingoffset}{44pt}% 9990 {\dimen0}{\dimen2}% 9991}} 9992 9993% Set default to letter. 9994% 9995\letterpaper 9996 9997 9998\message{and turning on texinfo input format.} 9999 10000\def^^L{\par} % remove \outer, so ^L can appear in an @comment 10001 10002% DEL is a comment character, in case @c does not suffice. 10003\catcode`\^^? = 14 10004 10005% Define macros to output various characters with catcode for normal text. 10006\catcode`\"=\other \def\normaldoublequote{"} 10007\catcode`\$=\other \def\normaldollar{$}%$ font-lock fix 10008\catcode`\+=\other \def\normalplus{+} 10009\catcode`\<=\other \def\normalless{<} 10010\catcode`\>=\other \def\normalgreater{>} 10011\catcode`\^=\other \def\normalcaret{^} 10012\catcode`\_=\other \def\normalunderscore{_} 10013\catcode`\|=\other \def\normalverticalbar{|} 10014\catcode`\~=\other \def\normaltilde{~} 10015 10016% This macro is used to make a character print one way in \tt 10017% (where it can probably be output as-is), and another way in other fonts, 10018% where something hairier probably needs to be done. 10019% 10020% #1 is what to print if we are indeed using \tt; #2 is what to print 10021% otherwise. Since all the Computer Modern typewriter fonts have zero 10022% interword stretch (and shrink), and it is reasonable to expect all 10023% typewriter fonts to have this, we can check that font parameter. 10024% 10025\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} 10026 10027% Same as above, but check for italic font. Actually this also catches 10028% non-italic slanted fonts since it is impossible to distinguish them from 10029% italic fonts. But since this is only used by $ and it uses \sl anyway 10030% this is not a problem. 10031\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} 10032 10033% Turn off all special characters except @ 10034% (and those which the user can use as if they were ordinary). 10035% Most of these we simply print from the \tt font, but for some, we can 10036% use math or other variants that look better in normal text. 10037 10038\catcode`\"=\active 10039\def\activedoublequote{{\tt\char34}} 10040\let"=\activedoublequote 10041\catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde 10042\chardef\hat=`\^ 10043\catcode`\^=\active \def\activehat{{\tt \hat}} \let^ = \activehat 10044 10045\catcode`\_=\active 10046\def_{\ifusingtt\normalunderscore\_} 10047\let\realunder=_ 10048% Subroutine for the previous macro. 10049\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } 10050 10051\catcode`\|=\active 10052\def|{{\tt\char124}} 10053 10054\chardef \less=`\< 10055\catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless 10056\chardef \gtr=`\> 10057\catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr 10058\catcode`\+=\active \def+{{\tt \char 43}} 10059\catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix 10060 10061% used for headline/footline in the output routine, in case the page 10062% breaks in the middle of an @tex block. 10063\def\texinfochars{% 10064 \let< = \activeless 10065 \let> = \activegtr 10066 \let~ = \activetilde 10067 \let^ = \activehat 10068 \markupsetuplqdefault \markupsetuprqdefault 10069 \let\b = \strong 10070 \let\i = \smartitalic 10071 % in principle, all other definitions in \tex have to be undone too. 10072} 10073 10074% If a .fmt file is being used, characters that might appear in a file 10075% name cannot be active until we have parsed the command line. 10076% So turn them off again, and have \everyjob (or @setfilename) turn them on. 10077% \otherifyactive is called near the end of this file. 10078\def\otherifyactive{\catcode`+=\other \catcode`\_=\other} 10079 10080% Used sometimes to turn off (effectively) the active characters even after 10081% parsing them. 10082\def\turnoffactive{% 10083 \normalturnoffactive 10084 \otherbackslash 10085} 10086 10087\catcode`\@=0 10088 10089% \backslashcurfont outputs one backslash character in current font, 10090% as in \char`\\. 10091\global\chardef\backslashcurfont=`\\ 10092\global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work 10093 10094% \realbackslash is an actual character `\' with catcode other, and 10095% \doublebackslash is two of them (for the pdf outlines). 10096{\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}} 10097 10098% In texinfo, backslash is an active character; it prints the backslash 10099% in fixed width font. 10100\catcode`\\=\active % @ for escape char from now on. 10101 10102% The story here is that in math mode, the \char of \backslashcurfont 10103% ends up printing the roman \ from the math symbol font (because \char 10104% in math mode uses the \mathcode, and plain.tex sets 10105% \mathcode`\\="026E). It seems better for @backslashchar{} to always 10106% print a typewriter backslash, hence we use an explicit \mathchar, 10107% which is the decimal equivalent of "715c (class 7, e.g., use \fam; 10108% ignored family value; char position "5C). We can't use " for the 10109% usual hex value because it has already been made active. 10110@def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}} 10111@let@backslashchar = @normalbackslash % @backslashchar{} is for user documents. 10112 10113% On startup, @fixbackslash assigns: 10114% @let \ = @normalbackslash 10115% \rawbackslash defines an active \ to do \backslashcurfont. 10116% \otherbackslash defines an active \ to be a literal `\' character with 10117% catcode other. We switch back and forth between these. 10118@gdef@rawbackslash{@let\=@backslashcurfont} 10119@gdef@otherbackslash{@let\=@realbackslash} 10120 10121% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of 10122% the literal character `\'. Also revert - to its normal character, in 10123% case the active - from code has slipped in. 10124% 10125{@catcode`- = @active 10126 @gdef@normalturnoffactive{% 10127 @let-=@normaldash 10128 @let"=@normaldoublequote 10129 @let$=@normaldollar %$ font-lock fix 10130 @let+=@normalplus 10131 @let<=@normalless 10132 @let>=@normalgreater 10133 @let\=@normalbackslash 10134 @let^=@normalcaret 10135 @let_=@normalunderscore 10136 @let|=@normalverticalbar 10137 @let~=@normaltilde 10138 @markupsetuplqdefault 10139 @markupsetuprqdefault 10140 @unsepspaces 10141 } 10142} 10143 10144% Make _ and + \other characters, temporarily. 10145% This is canceled by @fixbackslash. 10146@otherifyactive 10147 10148% If a .fmt file is being used, we don't want the `\input texinfo' to show up. 10149% That is what \eatinput is for; after that, the `\' should revert to printing 10150% a backslash. 10151% 10152@gdef@eatinput input texinfo{@fixbackslash} 10153@global@let\ = @eatinput 10154 10155% On the other hand, perhaps the file did not have a `\input texinfo'. Then 10156% the first `\' in the file would cause an error. This macro tries to fix 10157% that, assuming it is called before the first `\' could plausibly occur. 10158% Also turn back on active characters that might appear in the input 10159% file name, in case not using a pre-dumped format. 10160% 10161@gdef@fixbackslash{% 10162 @ifx\@eatinput @let\ = @normalbackslash @fi 10163 @catcode`+=@active 10164 @catcode`@_=@active 10165} 10166 10167% Say @foo, not \foo, in error messages. 10168@escapechar = `@@ 10169 10170% These (along with & and #) are made active for url-breaking, so need 10171% active definitions as the normal characters. 10172@def@normaldot{.} 10173@def@normalquest{?} 10174@def@normalslash{/} 10175 10176% These look ok in all fonts, so just make them not special. 10177% @hashchar{} gets its own user-level command, because of #line. 10178@catcode`@& = @other @def@normalamp{&} 10179@catcode`@# = @other @def@normalhash{#} 10180@catcode`@% = @other @def@normalpercent{%} 10181 10182@let @hashchar = @normalhash 10183 10184@c Finally, make ` and ' active, so that txicodequoteundirected and 10185@c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we 10186@c don't make ` and ' active, @code will not get them as active chars. 10187@c Do this last of all since we use ` in the previous @catcode assignments. 10188@catcode`@'=@active 10189@catcode`@`=@active 10190@markupsetuplqdefault 10191@markupsetuprqdefault 10192 10193@c Local variables: 10194@c eval: (add-hook 'write-file-hooks 'time-stamp) 10195@c page-delimiter: "^\\\\message" 10196@c time-stamp-start: "def\\\\texinfoversion{" 10197@c time-stamp-format: "%:y-%02m-%02d.%02H" 10198@c time-stamp-end: "}" 10199@c End: 10200 10201@c vim:sw=2: 10202 10203@ignore 10204 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 10205@end ignore 10206
