diff options
| author | Robert J. Chassell | 2006-08-21 19:04:39 +0000 |
|---|---|---|
| committer | Robert J. Chassell | 2006-08-21 19:04:39 +0000 |
| commit | c7025fef3924ad9f33d342a79bf34e7583683c53 (patch) | |
| tree | ddddde1a4850bc7bf8a01a075fad528ccf0d1ccb | |
| parent | 2476f3153d0ea6da997e743a0775c9b9974c4cc3 (diff) | |
| download | emacs-c7025fef3924ad9f33d342a79bf34e7583683c53.tar.gz emacs-c7025fef3924ad9f33d342a79bf34e7583683c53.zip | |
texinfo.tex: deleted file and pointed emacs-lisp-intro.texi towards ../man/texinfo.tex
| -rw-r--r-- | lispintro/texinfo.tex | 7226 |
1 files changed, 0 insertions, 7226 deletions
diff --git a/lispintro/texinfo.tex b/lispintro/texinfo.tex deleted file mode 100644 index a77ed16f93b..00000000000 --- a/lispintro/texinfo.tex +++ /dev/null | |||
| @@ -1,7226 +0,0 @@ | |||
| 1 | % texinfo.tex -- TeX macros to handle Texinfo files. | ||
| 2 | % | ||
| 3 | % Load plain if necessary, i.e., if running under initex. | ||
| 4 | \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi | ||
| 5 | % | ||
| 6 | \def\texinfoversion{2006-02-13.16} | ||
| 7 | % | ||
| 8 | % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, | ||
| 9 | % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free | ||
| 10 | % Software Foundation, Inc. | ||
| 11 | % | ||
| 12 | % This texinfo.tex file is free software; you can redistribute it and/or | ||
| 13 | % modify it under the terms of the GNU General Public License as | ||
| 14 | % published by the Free Software Foundation; either version 2, or (at | ||
| 15 | % your option) any later version. | ||
| 16 | % | ||
| 17 | % This texinfo.tex file is distributed in the hope that it will be | ||
| 18 | % useful, but WITHOUT ANY WARRANTY; without even the implied warranty | ||
| 19 | % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| 20 | % General Public License for more details. | ||
| 21 | % | ||
| 22 | % You should have received a copy of the GNU General Public License | ||
| 23 | % along with this texinfo.tex file; see the file COPYING. If not, write | ||
| 24 | % to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | ||
| 25 | % Boston, MA 02110-1301, USA. | ||
| 26 | % | ||
| 27 | % As a special exception, when this file is read by TeX when processing | ||
| 28 | % a Texinfo source document, you may use the result without | ||
| 29 | % restriction. (This has been our intent since Texinfo was invented.) | ||
| 30 | % | ||
| 31 | % Please try the latest version of texinfo.tex before submitting bug | ||
| 32 | % reports; you can get the latest version from: | ||
| 33 | % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or | ||
| 34 | % ftp://tug.org/tex/texinfo.tex | ||
| 35 | % (and all CTAN mirrors, see http://www.ctan.org). | ||
| 36 | % The texinfo.tex in any given distribution could well be out | ||
| 37 | % of date, so if that's what you're using, please check. | ||
| 38 | % | ||
| 39 | % Send bug reports to bug-texinfo@gnu.org. Please include including a | ||
| 40 | % complete document in each bug report with which we can reproduce the | ||
| 41 | % problem. Patches are, of course, greatly appreciated. | ||
| 42 | % | ||
| 43 | % To process a Texinfo manual with TeX, it's most reliable to use the | ||
| 44 | % texi2dvi shell script that comes with the distribution. For a simple | ||
| 45 | % manual foo.texi, however, you can get away with this: | ||
| 46 | % tex foo.texi | ||
| 47 | % texindex foo.?? | ||
| 48 | % tex foo.texi | ||
| 49 | % tex foo.texi | ||
| 50 | % dvips foo.dvi -o # or whatever; this makes foo.ps. | ||
| 51 | % The extra TeX runs get the cross-reference information correct. | ||
| 52 | % Sometimes one run after texindex suffices, and sometimes you need more | ||
| 53 | % than two; texi2dvi does it as many times as necessary. | ||
| 54 | % | ||
| 55 | % It is possible to adapt texinfo.tex for other languages, to some | ||
| 56 | % extent. You can get the existing language-specific files from the | ||
| 57 | % full Texinfo distribution. | ||
| 58 | % | ||
| 59 | % The GNU Texinfo home page is http://www.gnu.org/software/texinfo. | ||
| 60 | |||
| 61 | |||
| 62 | \message{Loading texinfo [version \texinfoversion]:} | ||
| 63 | |||
| 64 | % If in a .fmt file, print the version number | ||
| 65 | % and turn on active characters that we couldn't do earlier because | ||
| 66 | % they might have appeared in the input file name. | ||
| 67 | \everyjob{\message{[Texinfo version \texinfoversion]}% | ||
| 68 | \catcode`+=\active \catcode`\_=\active} | ||
| 69 | |||
| 70 | \message{Basics,} | ||
| 71 | \chardef\other=12 | ||
| 72 | |||
| 73 | % We never want plain's \outer definition of \+ in Texinfo. | ||
| 74 | % For @tex, we can use \tabalign. | ||
| 75 | \let\+ = \relax | ||
| 76 | |||
| 77 | % Save some plain tex macros whose names we will redefine. | ||
| 78 | \let\ptexb=\b | ||
| 79 | \let\ptexbullet=\bullet | ||
| 80 | \let\ptexc=\c | ||
| 81 | \let\ptexcomma=\, | ||
| 82 | \let\ptexdot=\. | ||
| 83 | \let\ptexdots=\dots | ||
| 84 | \let\ptexend=\end | ||
| 85 | \let\ptexequiv=\equiv | ||
| 86 | \let\ptexexclam=\! | ||
| 87 | \let\ptexfootnote=\footnote | ||
| 88 | \let\ptexgtr=> | ||
| 89 | \let\ptexhat=^ | ||
| 90 | \let\ptexi=\i | ||
| 91 | \let\ptexindent=\indent | ||
| 92 | \let\ptexinsert=\insert | ||
| 93 | \let\ptexlbrace=\{ | ||
| 94 | \let\ptexless=< | ||
| 95 | \let\ptexnewwrite\newwrite | ||
| 96 | \let\ptexnoindent=\noindent | ||
| 97 | \let\ptexplus=+ | ||
| 98 | \let\ptexrbrace=\} | ||
| 99 | \let\ptexslash=\/ | ||
| 100 | \let\ptexstar=\* | ||
| 101 | \let\ptext=\t | ||
| 102 | |||
| 103 | % If this character appears in an error message or help string, it | ||
| 104 | % starts a new line in the output. | ||
| 105 | \newlinechar = `^^J | ||
| 106 | |||
| 107 | % Use TeX 3.0's \inputlineno to get the line number, for better error | ||
| 108 | % messages, but if we're using an old version of TeX, don't do anything. | ||
| 109 | % | ||
| 110 | \ifx\inputlineno\thisisundefined | ||
| 111 | \let\linenumber = \empty % Pre-3.0. | ||
| 112 | \else | ||
| 113 | \def\linenumber{l.\the\inputlineno:\space} | ||
| 114 | \fi | ||
| 115 | |||
| 116 | % Set up fixed words for English if not already set. | ||
| 117 | \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi | ||
| 118 | \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi | ||
| 119 | \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi | ||
| 120 | \ifx\putwordin\undefined \gdef\putwordin{in}\fi | ||
| 121 | \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi | ||
| 122 | \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi | ||
| 123 | \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi | ||
| 124 | \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi | ||
| 125 | \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi | ||
| 126 | \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi | ||
| 127 | \ifx\putwordof\undefined \gdef\putwordof{of}\fi | ||
| 128 | \ifx\putwordon\undefined \gdef\putwordon{on}\fi | ||
| 129 | \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi | ||
| 130 | \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi | ||
| 131 | \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi | ||
| 132 | \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi | ||
| 133 | \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi | ||
| 134 | \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi | ||
| 135 | \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi | ||
| 136 | % | ||
| 137 | \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi | ||
| 138 | \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi | ||
| 139 | \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi | ||
| 140 | \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi | ||
| 141 | \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi | ||
| 142 | \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi | ||
| 143 | \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi | ||
| 144 | \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi | ||
| 145 | \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi | ||
| 146 | \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi | ||
| 147 | \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi | ||
| 148 | \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi | ||
| 149 | % | ||
| 150 | \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi | ||
| 151 | \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi | ||
| 152 | \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi | ||
| 153 | \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi | ||
| 154 | \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi | ||
| 155 | |||
| 156 | % Since the category of space is not known, we have to be careful. | ||
| 157 | \chardef\spacecat = 10 | ||
| 158 | \def\spaceisspace{\catcode`\ =\spacecat} | ||
| 159 | |||
| 160 | % Ignore a token. | ||
| 161 | % | ||
| 162 | \def\gobble#1{} | ||
| 163 | |||
| 164 | % The following is used inside several \edef's. | ||
| 165 | \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} | ||
| 166 | |||
| 167 | % Hyphenation fixes. | ||
| 168 | \hyphenation{ | ||
| 169 | Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script | ||
| 170 | ap-pen-dix bit-map bit-maps | ||
| 171 | data-base data-bases eshell fall-ing half-way long-est man-u-script | ||
| 172 | man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm | ||
| 173 | par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces | ||
| 174 | spell-ing spell-ings | ||
| 175 | stand-alone strong-est time-stamp time-stamps which-ever white-space | ||
| 176 | wide-spread wrap-around | ||
| 177 | } | ||
| 178 | |||
| 179 | % Margin to add to right of even pages, to left of odd pages. | ||
| 180 | \newdimen\bindingoffset | ||
| 181 | \newdimen\normaloffset | ||
| 182 | \newdimen\pagewidth \newdimen\pageheight | ||
| 183 | |||
| 184 | % For a final copy, take out the rectangles | ||
| 185 | % that mark overfull boxes (in case you have decided | ||
| 186 | % that the text looks ok even though it passes the margin). | ||
| 187 | % | ||
| 188 | \def\finalout{\overfullrule=0pt} | ||
| 189 | |||
| 190 | % @| inserts a changebar to the left of the current line. It should | ||
| 191 | % surround any changed text. This approach does *not* work if the | ||
| 192 | % change spans more than two lines of output. To handle that, we would | ||
| 193 | % have adopt a much more difficult approach (putting marks into the main | ||
| 194 | % vertical list for the beginning and end of each change). | ||
| 195 | % | ||
| 196 | \def\|{% | ||
| 197 | % \vadjust can only be used in horizontal mode. | ||
| 198 | \leavevmode | ||
| 199 | % | ||
| 200 | % Append this vertical mode material after the current line in the output. | ||
| 201 | \vadjust{% | ||
| 202 | % We want to insert a rule with the height and depth of the current | ||
| 203 | % leading; that is exactly what \strutbox is supposed to record. | ||
| 204 | \vskip-\baselineskip | ||
| 205 | % | ||
| 206 | % \vadjust-items are inserted at the left edge of the type. So | ||
| 207 | % the \llap here moves out into the left-hand margin. | ||
| 208 | \llap{% | ||
| 209 | % | ||
| 210 | % For a thicker or thinner bar, change the `1pt'. | ||
| 211 | \vrule height\baselineskip width1pt | ||
| 212 | % | ||
| 213 | % This is the space between the bar and the text. | ||
| 214 | \hskip 12pt | ||
| 215 | }% | ||
| 216 | }% | ||
| 217 | } | ||
| 218 | |||
| 219 | % Sometimes it is convenient to have everything in the transcript file | ||
| 220 | % and nothing on the terminal. We don't just call \tracingall here, | ||
| 221 | % since that produces some useless output on the terminal. We also make | ||
| 222 | % some effort to order the tracing commands to reduce output in the log | ||
| 223 | % file; cf. trace.sty in LaTeX. | ||
| 224 | % | ||
| 225 | \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% | ||
| 226 | \def\loggingall{% | ||
| 227 | \tracingstats2 | ||
| 228 | \tracingpages1 | ||
| 229 | \tracinglostchars2 % 2 gives us more in etex | ||
| 230 | \tracingparagraphs1 | ||
| 231 | \tracingoutput1 | ||
| 232 | \tracingmacros2 | ||
| 233 | \tracingrestores1 | ||
| 234 | \showboxbreadth\maxdimen \showboxdepth\maxdimen | ||
| 235 | \ifx\eTeXversion\undefined\else % etex gives us more logging | ||
| 236 | \tracingscantokens1 | ||
| 237 | \tracingifs1 | ||
| 238 | \tracinggroups1 | ||
| 239 | \tracingnesting2 | ||
| 240 | \tracingassigns1 | ||
| 241 | \fi | ||
| 242 | \tracingcommands3 % 3 gives us more in etex | ||
| 243 | \errorcontextlines16 | ||
| 244 | }% | ||
| 245 | |||
| 246 | % add check for \lastpenalty to plain's definitions. If the last thing | ||
| 247 | % we did was a \nobreak, we don't want to insert more space. | ||
| 248 | % | ||
| 249 | \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount | ||
| 250 | \removelastskip\penalty-50\smallskip\fi\fi} | ||
| 251 | \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount | ||
| 252 | \removelastskip\penalty-100\medskip\fi\fi} | ||
| 253 | \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount | ||
| 254 | \removelastskip\penalty-200\bigskip\fi\fi} | ||
| 255 | |||
| 256 | % For @cropmarks command. | ||
| 257 | % Do @cropmarks to get crop marks. | ||
| 258 | % | ||
| 259 | \newif\ifcropmarks | ||
| 260 | \let\cropmarks = \cropmarkstrue | ||
| 261 | % | ||
| 262 | % Dimensions to add cropmarks at corners. | ||
| 263 | % Added by P. A. MacKay, 12 Nov. 1986 | ||
| 264 | % | ||
| 265 | \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines | ||
| 266 | \newdimen\cornerlong \cornerlong=1pc | ||
| 267 | \newdimen\cornerthick \cornerthick=.3pt | ||
| 268 | \newdimen\topandbottommargin \topandbottommargin=.75in | ||
| 269 | |||
| 270 | % Main output routine. | ||
| 271 | \chardef\PAGE = 255 | ||
| 272 | \output = {\onepageout{\pagecontents\PAGE}} | ||
| 273 | |||
| 274 | \newbox\headlinebox | ||
| 275 | \newbox\footlinebox | ||
| 276 | |||
| 277 | % \onepageout takes a vbox as an argument. Note that \pagecontents | ||
| 278 | % does insertions, but you have to call it yourself. | ||
| 279 | \def\onepageout#1{% | ||
| 280 | \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi | ||
| 281 | % | ||
| 282 | \ifodd\pageno \advance\hoffset by \bindingoffset | ||
| 283 | \else \advance\hoffset by -\bindingoffset\fi | ||
| 284 | % | ||
| 285 | % Do this outside of the \shipout so @code etc. will be expanded in | ||
| 286 | % the headline as they should be, not taken literally (outputting ''code). | ||
| 287 | \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% | ||
| 288 | \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% | ||
| 289 | % | ||
| 290 | {% | ||
| 291 | % Have to do this stuff outside the \shipout because we want it to | ||
| 292 | % take effect in \write's, yet the group defined by the \vbox ends | ||
| 293 | % before the \shipout runs. | ||
| 294 | % | ||
| 295 | \indexdummies % don't expand commands in the output. | ||
| 296 | \normalturnoffactive % \ in index entries must not stay \, e.g., if | ||
| 297 | % the page break happens to be in the middle of an example. | ||
| 298 | % We don't want .vr (or whatever) entries like this: | ||
| 299 | % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} | ||
| 300 | % "\acronym" won't work when it's read back in; | ||
| 301 | % it needs to be | ||
| 302 | % {\code {{\tt \backslashcurfont }acronym} | ||
| 303 | \shipout\vbox{% | ||
| 304 | % Do this early so pdf references go to the beginning of the page. | ||
| 305 | \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi | ||
| 306 | % | ||
| 307 | \ifcropmarks \vbox to \outervsize\bgroup | ||
| 308 | \hsize = \outerhsize | ||
| 309 | \vskip-\topandbottommargin | ||
| 310 | \vtop to0pt{% | ||
| 311 | \line{\ewtop\hfil\ewtop}% | ||
| 312 | \nointerlineskip | ||
| 313 | \line{% | ||
| 314 | \vbox{\moveleft\cornerthick\nstop}% | ||
| 315 | \hfill | ||
| 316 | \vbox{\moveright\cornerthick\nstop}% | ||
| 317 | }% | ||
| 318 | \vss}% | ||
| 319 | \vskip\topandbottommargin | ||
| 320 | \line\bgroup | ||
| 321 | \hfil % center the page within the outer (page) hsize. | ||
| 322 | \ifodd\pageno\hskip\bindingoffset\fi | ||
| 323 | \vbox\bgroup | ||
| 324 | \fi | ||
| 325 | % | ||
| 326 | \unvbox\headlinebox | ||
| 327 | \pagebody{#1}% | ||
| 328 | \ifdim\ht\footlinebox > 0pt | ||
| 329 | % Only leave this space if the footline is nonempty. | ||
| 330 | % (We lessened \vsize for it in \oddfootingxxx.) | ||
| 331 | % The \baselineskip=24pt in plain's \makefootline has no effect. | ||
| 332 | \vskip 2\baselineskip | ||
| 333 | \unvbox\footlinebox | ||
| 334 | \fi | ||
| 335 | % | ||
| 336 | \ifcropmarks | ||
| 337 | \egroup % end of \vbox\bgroup | ||
| 338 | \hfil\egroup % end of (centering) \line\bgroup | ||
| 339 | \vskip\topandbottommargin plus1fill minus1fill | ||
| 340 | \boxmaxdepth = \cornerthick | ||
| 341 | \vbox to0pt{\vss | ||
| 342 | \line{% | ||
| 343 | \vbox{\moveleft\cornerthick\nsbot}% | ||
| 344 | \hfill | ||
| 345 | \vbox{\moveright\cornerthick\nsbot}% | ||
| 346 | }% | ||
| 347 | \nointerlineskip | ||
| 348 | \line{\ewbot\hfil\ewbot}% | ||
| 349 | }% | ||
| 350 | \egroup % \vbox from first cropmarks clause | ||
| 351 | \fi | ||
| 352 | }% end of \shipout\vbox | ||
| 353 | }% end of group with \indexdummies | ||
| 354 | \advancepageno | ||
| 355 | \ifnum\outputpenalty>-20000 \else\dosupereject\fi | ||
| 356 | } | ||
| 357 | |||
| 358 | \newinsert\margin \dimen\margin=\maxdimen | ||
| 359 | |||
| 360 | \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} | ||
| 361 | {\catcode`\@ =11 | ||
| 362 | \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi | ||
| 363 | % marginal hacks, juha@viisa.uucp (Juha Takala) | ||
| 364 | \ifvoid\margin\else % marginal info is present | ||
| 365 | \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi | ||
| 366 | \dimen@=\dp#1 \unvbox#1 | ||
| 367 | \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi | ||
| 368 | \ifr@ggedbottom \kern-\dimen@ \vfil \fi} | ||
| 369 | } | ||
| 370 | |||
| 371 | % Here are the rules for the cropmarks. Note that they are | ||
| 372 | % offset so that the space between them is truly \outerhsize or \outervsize | ||
| 373 | % (P. A. MacKay, 12 November, 1986) | ||
| 374 | % | ||
| 375 | \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} | ||
| 376 | \def\nstop{\vbox | ||
| 377 | {\hrule height\cornerthick depth\cornerlong width\cornerthick}} | ||
| 378 | \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} | ||
| 379 | \def\nsbot{\vbox | ||
| 380 | {\hrule height\cornerlong depth\cornerthick width\cornerthick}} | ||
| 381 | |||
| 382 | % Parse an argument, then pass it to #1. The argument is the rest of | ||
| 383 | % the input line (except we remove a trailing comment). #1 should be a | ||
| 384 | % macro which expects an ordinary undelimited TeX argument. | ||
| 385 | % | ||
| 386 | \def\parsearg{\parseargusing{}} | ||
| 387 | \def\parseargusing#1#2{% | ||
| 388 | \def\next{#2}% | ||
| 389 | \begingroup | ||
| 390 | \obeylines | ||
| 391 | \spaceisspace | ||
| 392 | #1% | ||
| 393 | \parseargline\empty% Insert the \empty token, see \finishparsearg below. | ||
| 394 | } | ||
| 395 | |||
| 396 | {\obeylines % | ||
| 397 | \gdef\parseargline#1^^M{% | ||
| 398 | \endgroup % End of the group started in \parsearg. | ||
| 399 | \argremovecomment #1\comment\ArgTerm% | ||
| 400 | }% | ||
| 401 | } | ||
| 402 | |||
| 403 | % First remove any @comment, then any @c comment. | ||
| 404 | \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} | ||
| 405 | \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} | ||
| 406 | |||
| 407 | % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space. | ||
| 408 | % | ||
| 409 | % \argremovec might leave us with trailing space, e.g., | ||
| 410 | % @end itemize @c foo | ||
| 411 | % This space token undergoes the same procedure and is eventually removed | ||
| 412 | % by \finishparsearg. | ||
| 413 | % | ||
| 414 | \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} | ||
| 415 | \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} | ||
| 416 | \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% | ||
| 417 | \def\temp{#3}% | ||
| 418 | \ifx\temp\empty | ||
| 419 | % We cannot use \next here, as it holds the macro to run; | ||
| 420 | % thus we reuse \temp. | ||
| 421 | \let\temp\finishparsearg | ||
| 422 | \else | ||
| 423 | \let\temp\argcheckspaces | ||
| 424 | \fi | ||
| 425 | % Put the space token in: | ||
| 426 | \temp#1 #3\ArgTerm | ||
| 427 | } | ||
| 428 | |||
| 429 | % If a _delimited_ argument is enclosed in braces, they get stripped; so | ||
| 430 | % to get _exactly_ the rest of the line, we had to prevent such situation. | ||
| 431 | % We prepended an \empty token at the very beginning and we expand it now, | ||
| 432 | % just before passing the control to \next. | ||
| 433 | % (Similarily, we have to think about #3 of \argcheckspacesY above: it is | ||
| 434 | % either the null string, or it ends with \^^M---thus there is no danger | ||
| 435 | % that a pair of braces would be stripped. | ||
| 436 | % | ||
| 437 | % But first, we have to remove the trailing space token. | ||
| 438 | % | ||
| 439 | \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}} | ||
| 440 | |||
| 441 | % \parseargdef\foo{...} | ||
| 442 | % is roughly equivalent to | ||
| 443 | % \def\foo{\parsearg\Xfoo} | ||
| 444 | % \def\Xfoo#1{...} | ||
| 445 | % | ||
| 446 | % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my | ||
| 447 | % favourite TeX trick. --kasal, 16nov03 | ||
| 448 | |||
| 449 | \def\parseargdef#1{% | ||
| 450 | \expandafter \doparseargdef \csname\string#1\endcsname #1% | ||
| 451 | } | ||
| 452 | \def\doparseargdef#1#2{% | ||
| 453 | \def#2{\parsearg#1}% | ||
| 454 | \def#1##1% | ||
| 455 | } | ||
| 456 | |||
| 457 | % Several utility definitions with active space: | ||
| 458 | { | ||
| 459 | \obeyspaces | ||
| 460 | \gdef\obeyedspace{ } | ||
| 461 | |||
| 462 | % Make each space character in the input produce a normal interword | ||
| 463 | % space in the output. Don't allow a line break at this space, as this | ||
| 464 | % is used only in environments like @example, where each line of input | ||
| 465 | % should produce a line of output anyway. | ||
| 466 | % | ||
| 467 | \gdef\sepspaces{\obeyspaces\let =\tie} | ||
| 468 | |||
| 469 | % If an index command is used in an @example environment, any spaces | ||
| 470 | % therein should become regular spaces in the raw index file, not the | ||
| 471 | % expansion of \tie (\leavevmode \penalty \@M \ ). | ||
| 472 | \gdef\unsepspaces{\let =\space} | ||
| 473 | } | ||
| 474 | |||
| 475 | |||
| 476 | \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} | ||
| 477 | |||
| 478 | % Define the framework for environments in texinfo.tex. It's used like this: | ||
| 479 | % | ||
| 480 | % \envdef\foo{...} | ||
| 481 | % \def\Efoo{...} | ||
| 482 | % | ||
| 483 | % It's the responsibility of \envdef to insert \begingroup before the | ||
| 484 | % actual body; @end closes the group after calling \Efoo. \envdef also | ||
| 485 | % defines \thisenv, so the current environment is known; @end checks | ||
| 486 | % whether the environment name matches. The \checkenv macro can also be | ||
| 487 | % used to check whether the current environment is the one expected. | ||
| 488 | % | ||
| 489 | % Non-false conditionals (@iftex, @ifset) don't fit into this, so they | ||
| 490 | % are not treated as enviroments; they don't open a group. (The | ||
| 491 | % implementation of @end takes care not to call \endgroup in this | ||
| 492 | % special case.) | ||
| 493 | |||
| 494 | |||
| 495 | % At runtime, environments start with this: | ||
| 496 | \def\startenvironment#1{\begingroup\def\thisenv{#1}} | ||
| 497 | % initialize | ||
| 498 | \let\thisenv\empty | ||
| 499 | |||
| 500 | % ... but they get defined via ``\envdef\foo{...}'': | ||
| 501 | \long\def\envdef#1#2{\def#1{\startenvironment#1#2}} | ||
| 502 | \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} | ||
| 503 | |||
| 504 | % Check whether we're in the right environment: | ||
| 505 | \def\checkenv#1{% | ||
| 506 | \def\temp{#1}% | ||
| 507 | \ifx\thisenv\temp | ||
| 508 | \else | ||
| 509 | \badenverr | ||
| 510 | \fi | ||
| 511 | } | ||
| 512 | |||
| 513 | % Evironment mismatch, #1 expected: | ||
| 514 | \def\badenverr{% | ||
| 515 | \errhelp = \EMsimple | ||
| 516 | \errmessage{This command can appear only \inenvironment\temp, | ||
| 517 | not \inenvironment\thisenv}% | ||
| 518 | } | ||
| 519 | \def\inenvironment#1{% | ||
| 520 | \ifx#1\empty | ||
| 521 | out of any environment% | ||
| 522 | \else | ||
| 523 | in environment \expandafter\string#1% | ||
| 524 | \fi | ||
| 525 | } | ||
| 526 | |||
| 527 | % @end foo executes the definition of \Efoo. | ||
| 528 | % But first, it executes a specialized version of \checkenv | ||
| 529 | % | ||
| 530 | \parseargdef\end{% | ||
| 531 | \if 1\csname iscond.#1\endcsname | ||
| 532 | \else | ||
| 533 | % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 | ||
| 534 | \expandafter\checkenv\csname#1\endcsname | ||
| 535 | \csname E#1\endcsname | ||
| 536 | \endgroup | ||
| 537 | \fi | ||
| 538 | } | ||
| 539 | |||
| 540 | \newhelp\EMsimple{Press RETURN to continue.} | ||
| 541 | |||
| 542 | |||
| 543 | %% Simple single-character @ commands | ||
| 544 | |||
| 545 | % @@ prints an @ | ||
| 546 | % Kludge this until the fonts are right (grr). | ||
| 547 | \def\@{{\tt\char64}} | ||
| 548 | |||
| 549 | % This is turned off because it was never documented | ||
| 550 | % and you can use @w{...} around a quote to suppress ligatures. | ||
| 551 | %% Define @` and @' to be the same as ` and ' | ||
| 552 | %% but suppressing ligatures. | ||
| 553 | %\def\`{{`}} | ||
| 554 | %\def\'{{'}} | ||
| 555 | |||
| 556 | % Used to generate quoted braces. | ||
| 557 | \def\mylbrace {{\tt\char123}} | ||
| 558 | \def\myrbrace {{\tt\char125}} | ||
| 559 | \let\{=\mylbrace | ||
| 560 | \let\}=\myrbrace | ||
| 561 | \begingroup | ||
| 562 | % Definitions to produce \{ and \} commands for indices, | ||
| 563 | % and @{ and @} for the aux/toc files. | ||
| 564 | \catcode`\{ = \other \catcode`\} = \other | ||
| 565 | \catcode`\[ = 1 \catcode`\] = 2 | ||
| 566 | \catcode`\! = 0 \catcode`\\ = \other | ||
| 567 | !gdef!lbracecmd[\{]% | ||
| 568 | !gdef!rbracecmd[\}]% | ||
| 569 | !gdef!lbraceatcmd[@{]% | ||
| 570 | !gdef!rbraceatcmd[@}]% | ||
| 571 | !endgroup | ||
| 572 | |||
| 573 | % @comma{} to avoid , parsing problems. | ||
| 574 | \let\comma = , | ||
| 575 | |||
| 576 | % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent | ||
| 577 | % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. | ||
| 578 | \let\, = \c | ||
| 579 | \let\dotaccent = \. | ||
| 580 | \def\ringaccent#1{{\accent23 #1}} | ||
| 581 | \let\tieaccent = \t | ||
| 582 | \let\ubaraccent = \b | ||
| 583 | \let\udotaccent = \d | ||
| 584 | |||
| 585 | % Other special characters: @questiondown @exclamdown @ordf @ordm | ||
| 586 | % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. | ||
| 587 | \def\questiondown{?`} | ||
| 588 | \def\exclamdown{!`} | ||
| 589 | \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} | ||
| 590 | \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} | ||
| 591 | |||
| 592 | % Dotless i and dotless j, used for accents. | ||
| 593 | \def\imacro{i} | ||
| 594 | \def\jmacro{j} | ||
| 595 | \def\dotless#1{% | ||
| 596 | \def\temp{#1}% | ||
| 597 | \ifx\temp\imacro \ptexi | ||
| 598 | \else\ifx\temp\jmacro \j | ||
| 599 | \else \errmessage{@dotless can be used only with i or j}% | ||
| 600 | \fi\fi | ||
| 601 | } | ||
| 602 | |||
| 603 | % The \TeX{} logo, as in plain, but resetting the spacing so that a | ||
| 604 | % period following counts as ending a sentence. (Idea found in latex.) | ||
| 605 | % | ||
| 606 | \edef\TeX{\TeX \spacefactor=1000 } | ||
| 607 | |||
| 608 | % @LaTeX{} logo. Not quite the same results as the definition in | ||
| 609 | % latex.ltx, since we use a different font for the raised A; it's most | ||
| 610 | % convenient for us to use an explicitly smaller font, rather than using | ||
| 611 | % the \scriptstyle font (since we don't reset \scriptstyle and | ||
| 612 | % \scriptscriptstyle). | ||
| 613 | % | ||
| 614 | \def\LaTeX{% | ||
| 615 | L\kern-.36em | ||
| 616 | {\setbox0=\hbox{T}% | ||
| 617 | \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}% | ||
| 618 | \kern-.15em | ||
| 619 | \TeX | ||
| 620 | } | ||
| 621 | |||
| 622 | % Be sure we're in horizontal mode when doing a tie, since we make space | ||
| 623 | % equivalent to this in @example-like environments. Otherwise, a space | ||
| 624 | % at the beginning of a line will start with \penalty -- and | ||
| 625 | % since \penalty is valid in vertical mode, we'd end up putting the | ||
| 626 | % penalty on the vertical list instead of in the new paragraph. | ||
| 627 | {\catcode`@ = 11 | ||
| 628 | % Avoid using \@M directly, because that causes trouble | ||
| 629 | % if the definition is written into an index file. | ||
| 630 | \global\let\tiepenalty = \@M | ||
| 631 | \gdef\tie{\leavevmode\penalty\tiepenalty\ } | ||
| 632 | } | ||
| 633 | |||
| 634 | % @: forces normal size whitespace following. | ||
| 635 | \def\:{\spacefactor=1000 } | ||
| 636 | |||
| 637 | % @* forces a line break. | ||
| 638 | \def\*{\hfil\break\hbox{}\ignorespaces} | ||
| 639 | |||
| 640 | % @/ allows a line break. | ||
| 641 | \let\/=\allowbreak | ||
| 642 | |||
| 643 | % @. is an end-of-sentence period. | ||
| 644 | \def\.{.\spacefactor=\endofsentencespacefactor\space} | ||
| 645 | |||
| 646 | % @! is an end-of-sentence bang. | ||
| 647 | \def\!{!\spacefactor=\endofsentencespacefactor\space} | ||
| 648 | |||
| 649 | % @? is an end-of-sentence query. | ||
| 650 | \def\?{?\spacefactor=\endofsentencespacefactor\space} | ||
| 651 | |||
| 652 | % @frenchspacing on|off says whether to put extra space after punctuation. | ||
| 653 | % | ||
| 654 | \def\onword{on} | ||
| 655 | \def\offword{off} | ||
| 656 | % | ||
| 657 | \parseargdef\frenchspacing{% | ||
| 658 | \def\temp{#1}% | ||
| 659 | \ifx\temp\onword \plainfrenchspacing | ||
| 660 | \else\ifx\temp\offword \plainnonfrenchspacing | ||
| 661 | \else | ||
| 662 | \errhelp = \EMsimple | ||
| 663 | \errmessage{Unknown @frenchspacing option `\temp', must be on/off}% | ||
| 664 | \fi\fi | ||
| 665 | } | ||
| 666 | |||
| 667 | % @w prevents a word break. Without the \leavevmode, @w at the | ||
| 668 | % beginning of a paragraph, when TeX is still in vertical mode, would | ||
| 669 | % produce a whole line of output instead of starting the paragraph. | ||
| 670 | \def\w#1{\leavevmode\hbox{#1}} | ||
| 671 | |||
| 672 | % @group ... @end group forces ... to be all on one page, by enclosing | ||
| 673 | % it in a TeX vbox. We use \vtop instead of \vbox to construct the box | ||
| 674 | % to keep its height that of a normal line. According to the rules for | ||
| 675 | % \topskip (p.114 of the TeXbook), the glue inserted is | ||
| 676 | % max (\topskip - \ht (first item), 0). If that height is large, | ||
| 677 | % therefore, no glue is inserted, and the space between the headline and | ||
| 678 | % the text is small, which looks bad. | ||
| 679 | % | ||
| 680 | % Another complication is that the group might be very large. This can | ||
| 681 | % cause the glue on the previous page to be unduly stretched, because it | ||
| 682 | % does not have much material. In this case, it's better to add an | ||
| 683 | % explicit \vfill so that the extra space is at the bottom. The | ||
| 684 | % threshold for doing this is if the group is more than \vfilllimit | ||
| 685 | % percent of a page (\vfilllimit can be changed inside of @tex). | ||
| 686 | % | ||
| 687 | \newbox\groupbox | ||
| 688 | \def\vfilllimit{0.7} | ||
| 689 | % | ||
| 690 | \envdef\group{% | ||
| 691 | \ifnum\catcode`\^^M=\active \else | ||
| 692 | \errhelp = \groupinvalidhelp | ||
| 693 | \errmessage{@group invalid in context where filling is enabled}% | ||
| 694 | \fi | ||
| 695 | \startsavinginserts | ||
| 696 | % | ||
| 697 | \setbox\groupbox = \vtop\bgroup | ||
| 698 | % Do @comment since we are called inside an environment such as | ||
| 699 | % @example, where each end-of-line in the input causes an | ||
| 700 | % end-of-line in the output. We don't want the end-of-line after | ||
| 701 | % the `@group' to put extra space in the output. Since @group | ||
| 702 | % should appear on a line by itself (according to the Texinfo | ||
| 703 | % manual), we don't worry about eating any user text. | ||
| 704 | \comment | ||
| 705 | } | ||
| 706 | % | ||
| 707 | % The \vtop produces a box with normal height and large depth; thus, TeX puts | ||
| 708 | % \baselineskip glue before it, and (when the next line of text is done) | ||
| 709 | % \lineskip glue after it. Thus, space below is not quite equal to space | ||
| 710 | % above. But it's pretty close. | ||
| 711 | \def\Egroup{% | ||
| 712 | % To get correct interline space between the last line of the group | ||
| 713 | % and the first line afterwards, we have to propagate \prevdepth. | ||
| 714 | \endgraf % Not \par, as it may have been set to \lisppar. | ||
| 715 | \global\dimen1 = \prevdepth | ||
| 716 | \egroup % End the \vtop. | ||
| 717 | % \dimen0 is the vertical size of the group's box. | ||
| 718 | \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox | ||
| 719 | % \dimen2 is how much space is left on the page (more or less). | ||
| 720 | \dimen2 = \pageheight \advance\dimen2 by -\pagetotal | ||
| 721 | % if the group doesn't fit on the current page, and it's a big big | ||
| 722 | % group, force a page break. | ||
| 723 | \ifdim \dimen0 > \dimen2 | ||
| 724 | \ifdim \pagetotal < \vfilllimit\pageheight | ||
| 725 | \page | ||
| 726 | \fi | ||
| 727 | \fi | ||
| 728 | \box\groupbox | ||
| 729 | \prevdepth = \dimen1 | ||
| 730 | \checkinserts | ||
| 731 | } | ||
| 732 | % | ||
| 733 | % TeX puts in an \escapechar (i.e., `@') at the beginning of the help | ||
| 734 | % message, so this ends up printing `@group can only ...'. | ||
| 735 | % | ||
| 736 | \newhelp\groupinvalidhelp{% | ||
| 737 | group can only be used in environments such as @example,^^J% | ||
| 738 | where each line of input produces a line of output.} | ||
| 739 | |||
| 740 | % @need space-in-mils | ||
| 741 | % forces a page break if there is not space-in-mils remaining. | ||
| 742 | |||
| 743 | \newdimen\mil \mil=0.001in | ||
| 744 | |||
| 745 | % Old definition--didn't work. | ||
| 746 | %\parseargdef\need{\par % | ||
| 747 | %% This method tries to make TeX break the page naturally | ||
| 748 | %% if the depth of the box does not fit. | ||
| 749 | %{\baselineskip=0pt% | ||
| 750 | %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak | ||
| 751 | %\prevdepth=-1000pt | ||
| 752 | %}} | ||
| 753 | |||
| 754 | \parseargdef\need{% | ||
| 755 | % Ensure vertical mode, so we don't make a big box in the middle of a | ||
| 756 | % paragraph. | ||
| 757 | \par | ||
| 758 | % | ||
| 759 | % If the @need value is less than one line space, it's useless. | ||
| 760 | \dimen0 = #1\mil | ||
| 761 | \dimen2 = \ht\strutbox | ||
| 762 | \advance\dimen2 by \dp\strutbox | ||
| 763 | \ifdim\dimen0 > \dimen2 | ||
| 764 | % | ||
| 765 | % Do a \strut just to make the height of this box be normal, so the | ||
| 766 | % normal leading is inserted relative to the preceding line. | ||
| 767 | % And a page break here is fine. | ||
| 768 | \vtop to #1\mil{\strut\vfil}% | ||
| 769 | % | ||
| 770 | % TeX does not even consider page breaks if a penalty added to the | ||
| 771 | % main vertical list is 10000 or more. But in order to see if the | ||
| 772 | % empty box we just added fits on the page, we must make it consider | ||
| 773 | % page breaks. On the other hand, we don't want to actually break the | ||
| 774 | % page after the empty box. So we use a penalty of 9999. | ||
| 775 | % | ||
| 776 | % There is an extremely small chance that TeX will actually break the | ||
| 777 | % page at this \penalty, if there are no other feasible breakpoints in | ||
| 778 | % sight. (If the user is using lots of big @group commands, which | ||
| 779 | % almost-but-not-quite fill up a page, TeX will have a hard time doing | ||
| 780 | % good page breaking, for example.) However, I could not construct an | ||
| 781 | % example where a page broke at this \penalty; if it happens in a real | ||
| 782 | % document, then we can reconsider our strategy. | ||
| 783 | \penalty9999 | ||
| 784 | % | ||
| 785 | % Back up by the size of the box, whether we did a page break or not. | ||
| 786 | \kern -#1\mil | ||
| 787 | % | ||
| 788 | % Do not allow a page break right after this kern. | ||
| 789 | \nobreak | ||
| 790 | \fi | ||
| 791 | } | ||
| 792 | |||
| 793 | % @br forces paragraph break (and is undocumented). | ||
| 794 | |||
| 795 | \let\br = \par | ||
| 796 | |||
| 797 | % @page forces the start of a new page. | ||
| 798 | % | ||
| 799 | \def\page{\par\vfill\supereject} | ||
| 800 | |||
| 801 | % @exdent text.... | ||
| 802 | % outputs text on separate line in roman font, starting at standard page margin | ||
| 803 | |||
| 804 | % This records the amount of indent in the innermost environment. | ||
| 805 | % That's how much \exdent should take out. | ||
| 806 | \newskip\exdentamount | ||
| 807 | |||
| 808 | % This defn is used inside fill environments such as @defun. | ||
| 809 | \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} | ||
| 810 | |||
| 811 | % This defn is used inside nofill environments such as @example. | ||
| 812 | \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount | ||
| 813 | \leftline{\hskip\leftskip{\rm#1}}}} | ||
| 814 | |||
| 815 | % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current | ||
| 816 | % paragraph. For more general purposes, use the \margin insertion | ||
| 817 | % class. WHICH is `l' or `r'. | ||
| 818 | % | ||
| 819 | \newskip\inmarginspacing \inmarginspacing=1cm | ||
| 820 | \def\strutdepth{\dp\strutbox} | ||
| 821 | % | ||
| 822 | \def\doinmargin#1#2{\strut\vadjust{% | ||
| 823 | \nobreak | ||
| 824 | \kern-\strutdepth | ||
| 825 | \vtop to \strutdepth{% | ||
| 826 | \baselineskip=\strutdepth | ||
| 827 | \vss | ||
| 828 | % if you have multiple lines of stuff to put here, you'll need to | ||
| 829 | % make the vbox yourself of the appropriate size. | ||
| 830 | \ifx#1l% | ||
| 831 | \llap{\ignorespaces #2\hskip\inmarginspacing}% | ||
| 832 | \else | ||
| 833 | \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% | ||
| 834 | \fi | ||
| 835 | \null | ||
| 836 | }% | ||
| 837 | }} | ||
| 838 | \def\inleftmargin{\doinmargin l} | ||
| 839 | \def\inrightmargin{\doinmargin r} | ||
| 840 | % | ||
| 841 | % @inmargin{TEXT [, RIGHT-TEXT]} | ||
| 842 | % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; | ||
| 843 | % else use TEXT for both). | ||
| 844 | % | ||
| 845 | \def\inmargin#1{\parseinmargin #1,,\finish} | ||
| 846 | \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. | ||
| 847 | \setbox0 = \hbox{\ignorespaces #2}% | ||
| 848 | \ifdim\wd0 > 0pt | ||
| 849 | \def\lefttext{#1}% have both texts | ||
| 850 | \def\righttext{#2}% | ||
| 851 | \else | ||
| 852 | \def\lefttext{#1}% have only one text | ||
| 853 | \def\righttext{#1}% | ||
| 854 | \fi | ||
| 855 | % | ||
| 856 | \ifodd\pageno | ||
| 857 | \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin | ||
| 858 | \else | ||
| 859 | \def\temp{\inleftmargin\lefttext}% | ||
| 860 | \fi | ||
| 861 | \temp | ||
| 862 | } | ||
| 863 | |||
| 864 | % @include file insert text of that file as input. | ||
| 865 | % | ||
| 866 | \def\include{\parseargusing\filenamecatcodes\includezzz} | ||
| 867 | \def\includezzz#1{% | ||
| 868 | \pushthisfilestack | ||
| 869 | \def\thisfile{#1}% | ||
| 870 | {% | ||
| 871 | \makevalueexpandable | ||
| 872 | \def\temp{\input #1 }% | ||
| 873 | \expandafter | ||
| 874 | }\temp | ||
| 875 | \popthisfilestack | ||
| 876 | } | ||
| 877 | \def\filenamecatcodes{% | ||
| 878 | \catcode`\\=\other | ||
| 879 | \catcode`~=\other | ||
| 880 | \catcode`^=\other | ||
| 881 | \catcode`_=\other | ||
| 882 | \catcode`|=\other | ||
| 883 | \catcode`<=\other | ||
| 884 | \catcode`>=\other | ||
| 885 | \catcode`+=\other | ||
| 886 | \catcode`-=\other | ||
| 887 | } | ||
| 888 | |||
| 889 | \def\pushthisfilestack{% | ||
| 890 | \expandafter\pushthisfilestackX\popthisfilestack\StackTerm | ||
| 891 | } | ||
| 892 | \def\pushthisfilestackX{% | ||
| 893 | \expandafter\pushthisfilestackY\thisfile\StackTerm | ||
| 894 | } | ||
| 895 | \def\pushthisfilestackY #1\StackTerm #2\StackTerm {% | ||
| 896 | \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% | ||
| 897 | } | ||
| 898 | |||
| 899 | \def\popthisfilestack{\errthisfilestackempty} | ||
| 900 | \def\errthisfilestackempty{\errmessage{Internal error: | ||
| 901 | the stack of filenames is empty.}} | ||
| 902 | |||
| 903 | \def\thisfile{} | ||
| 904 | |||
| 905 | % @center line | ||
| 906 | % outputs that line, centered. | ||
| 907 | % | ||
| 908 | \parseargdef\center{% | ||
| 909 | \ifhmode | ||
| 910 | \let\next\centerH | ||
| 911 | \else | ||
| 912 | \let\next\centerV | ||
| 913 | \fi | ||
| 914 | \next{\hfil \ignorespaces#1\unskip \hfil}% | ||
| 915 | } | ||
| 916 | \def\centerH#1{% | ||
| 917 | {% | ||
| 918 | \hfil\break | ||
| 919 | \advance\hsize by -\leftskip | ||
| 920 | \advance\hsize by -\rightskip | ||
| 921 | \line{#1}% | ||
| 922 | \break | ||
| 923 | }% | ||
| 924 | } | ||
| 925 | \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}} | ||
| 926 | |||
| 927 | % @sp n outputs n lines of vertical space | ||
| 928 | |||
| 929 | \parseargdef\sp{\vskip #1\baselineskip} | ||
| 930 | |||
| 931 | % @comment ...line which is ignored... | ||
| 932 | % @c is the same as @comment | ||
| 933 | % @ignore ... @end ignore is another way to write a comment | ||
| 934 | |||
| 935 | \def\comment{\begingroup \catcode`\^^M=\other% | ||
| 936 | \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% | ||
| 937 | \commentxxx} | ||
| 938 | {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} | ||
| 939 | |||
| 940 | \let\c=\comment | ||
| 941 | |||
| 942 | % @paragraphindent NCHARS | ||
| 943 | % We'll use ems for NCHARS, close enough. | ||
| 944 | % NCHARS can also be the word `asis' or `none'. | ||
| 945 | % We cannot feasibly implement @paragraphindent asis, though. | ||
| 946 | % | ||
| 947 | \def\asisword{asis} % no translation, these are keywords | ||
| 948 | \def\noneword{none} | ||
| 949 | % | ||
| 950 | \parseargdef\paragraphindent{% | ||
| 951 | \def\temp{#1}% | ||
| 952 | \ifx\temp\asisword | ||
| 953 | \else | ||
| 954 | \ifx\temp\noneword | ||
| 955 | \defaultparindent = 0pt | ||
| 956 | \else | ||
| 957 | \defaultparindent = #1em | ||
| 958 | \fi | ||
| 959 | \fi | ||
| 960 | \parindent = \defaultparindent | ||
| 961 | } | ||
| 962 | |||
| 963 | % @exampleindent NCHARS | ||
| 964 | % We'll use ems for NCHARS like @paragraphindent. | ||
| 965 | % It seems @exampleindent asis isn't necessary, but | ||
| 966 | % I preserve it to make it similar to @paragraphindent. | ||
| 967 | \parseargdef\exampleindent{% | ||
| 968 | \def\temp{#1}% | ||
| 969 | \ifx\temp\asisword | ||
| 970 | \else | ||
| 971 | \ifx\temp\noneword | ||
| 972 | \lispnarrowing = 0pt | ||
| 973 | \else | ||
| 974 | \lispnarrowing = #1em | ||
| 975 | \fi | ||
| 976 | \fi | ||
| 977 | } | ||
| 978 | |||
| 979 | % @firstparagraphindent WORD | ||
| 980 | % If WORD is `none', then suppress indentation of the first paragraph | ||
| 981 | % after a section heading. If WORD is `insert', then do indent at such | ||
| 982 | % paragraphs. | ||
| 983 | % | ||
| 984 | % The paragraph indentation is suppressed or not by calling | ||
| 985 | % \suppressfirstparagraphindent, which the sectioning commands do. | ||
| 986 | % We switch the definition of this back and forth according to WORD. | ||
| 987 | % By default, we suppress indentation. | ||
| 988 | % | ||
| 989 | \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} | ||
| 990 | \def\insertword{insert} | ||
| 991 | % | ||
| 992 | \parseargdef\firstparagraphindent{% | ||
| 993 | \def\temp{#1}% | ||
| 994 | \ifx\temp\noneword | ||
| 995 | \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent | ||
| 996 | \else\ifx\temp\insertword | ||
| 997 | \let\suppressfirstparagraphindent = \relax | ||
| 998 | \else | ||
| 999 | \errhelp = \EMsimple | ||
| 1000 | \errmessage{Unknown @firstparagraphindent option `\temp'}% | ||
| 1001 | \fi\fi | ||
| 1002 | } | ||
| 1003 | |||
| 1004 | % Here is how we actually suppress indentation. Redefine \everypar to | ||
| 1005 | % \kern backwards by \parindent, and then reset itself to empty. | ||
| 1006 | % | ||
| 1007 | % We also make \indent itself not actually do anything until the next | ||
| 1008 | % paragraph. | ||
| 1009 | % | ||
| 1010 | \gdef\dosuppressfirstparagraphindent{% | ||
| 1011 | \gdef\indent{% | ||
| 1012 | \restorefirstparagraphindent | ||
| 1013 | \indent | ||
| 1014 | }% | ||
| 1015 | \gdef\noindent{% | ||
| 1016 | \restorefirstparagraphindent | ||
| 1017 | \noindent | ||
| 1018 | }% | ||
| 1019 | \global\everypar = {% | ||
| 1020 | \kern -\parindent | ||
| 1021 | \restorefirstparagraphindent | ||
| 1022 | }% | ||
| 1023 | } | ||
| 1024 | |||
| 1025 | \gdef\restorefirstparagraphindent{% | ||
| 1026 | \global \let \indent = \ptexindent | ||
| 1027 | \global \let \noindent = \ptexnoindent | ||
| 1028 | \global \everypar = {}% | ||
| 1029 | } | ||
| 1030 | |||
| 1031 | |||
| 1032 | % @asis just yields its argument. Used with @table, for example. | ||
| 1033 | % | ||
| 1034 | \def\asis#1{#1} | ||
| 1035 | |||
| 1036 | % @math outputs its argument in math mode. | ||
| 1037 | % | ||
| 1038 | % One complication: _ usually means subscripts, but it could also mean | ||
| 1039 | % an actual _ character, as in @math{@var{some_variable} + 1}. So make | ||
| 1040 | % _ active, and distinguish by seeing if the current family is \slfam, | ||
| 1041 | % which is what @var uses. | ||
| 1042 | { | ||
| 1043 | \catcode`\_ = \active | ||
| 1044 | \gdef\mathunderscore{% | ||
| 1045 | \catcode`\_=\active | ||
| 1046 | \def_{\ifnum\fam=\slfam \_\else\sb\fi}% | ||
| 1047 | } | ||
| 1048 | } | ||
| 1049 | % Another complication: we want \\ (and @\) to output a \ character. | ||
| 1050 | % FYI, plain.tex uses \\ as a temporary control sequence (why?), but | ||
| 1051 | % this is not advertised and we don't care. Texinfo does not | ||
| 1052 | % otherwise define @\. | ||
| 1053 | % | ||
| 1054 | % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. | ||
| 1055 | \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} | ||
| 1056 | % | ||
| 1057 | \def\math{% | ||
| 1058 | \tex | ||
| 1059 | \mathunderscore | ||
| 1060 | \let\\ = \mathbackslash | ||
| 1061 | \mathactive | ||
| 1062 | $\finishmath | ||
| 1063 | } | ||
| 1064 | \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. | ||
| 1065 | |||
| 1066 | % Some active characters (such as <) are spaced differently in math. | ||
| 1067 | % We have to reset their definitions in case the @math was an argument | ||
| 1068 | % to a command which sets the catcodes (such as @item or @section). | ||
| 1069 | % | ||
| 1070 | { | ||
| 1071 | \catcode`^ = \active | ||
| 1072 | \catcode`< = \active | ||
| 1073 | \catcode`> = \active | ||
| 1074 | \catcode`+ = \active | ||
| 1075 | \gdef\mathactive{% | ||
| 1076 | \let^ = \ptexhat | ||
| 1077 | \let< = \ptexless | ||
| 1078 | \let> = \ptexgtr | ||
| 1079 | \let+ = \ptexplus | ||
| 1080 | } | ||
| 1081 | } | ||
| 1082 | |||
| 1083 | % @bullet and @minus need the same treatment as @math, just above. | ||
| 1084 | \def\bullet{$\ptexbullet$} | ||
| 1085 | \def\minus{$-$} | ||
| 1086 | |||
| 1087 | % @dots{} outputs an ellipsis using the current font. | ||
| 1088 | % We do .5em per period so that it has the same spacing in a typewriter | ||
| 1089 | % font as three actual period characters. | ||
| 1090 | % | ||
| 1091 | \def\dots{% | ||
| 1092 | \leavevmode | ||
| 1093 | \hbox to 1.5em{% | ||
| 1094 | \hskip 0pt plus 0.25fil | ||
| 1095 | .\hfil.\hfil.% | ||
| 1096 | \hskip 0pt plus 0.5fil | ||
| 1097 | }% | ||
| 1098 | } | ||
| 1099 | |||
| 1100 | % @enddots{} is an end-of-sentence ellipsis. | ||
| 1101 | % | ||
| 1102 | \def\enddots{% | ||
| 1103 | \dots | ||
| 1104 | \spacefactor=\endofsentencespacefactor | ||
| 1105 | } | ||
| 1106 | |||
| 1107 | % @comma{} is so commas can be inserted into text without messing up | ||
| 1108 | % Texinfo's parsing. | ||
| 1109 | % | ||
| 1110 | \let\comma = , | ||
| 1111 | |||
| 1112 | % @refill is a no-op. | ||
| 1113 | \let\refill=\relax | ||
| 1114 | |||
| 1115 | % If working on a large document in chapters, it is convenient to | ||
| 1116 | % be able to disable indexing, cross-referencing, and contents, for test runs. | ||
| 1117 | % This is done with @novalidate (before @setfilename). | ||
| 1118 | % | ||
| 1119 | \newif\iflinks \linkstrue % by default we want the aux files. | ||
| 1120 | \let\novalidate = \linksfalse | ||
| 1121 | |||
| 1122 | % @setfilename is done at the beginning of every texinfo file. | ||
| 1123 | % So open here the files we need to have open while reading the input. | ||
| 1124 | % This makes it possible to make a .fmt file for texinfo. | ||
| 1125 | \def\setfilename{% | ||
| 1126 | \fixbackslash % Turn off hack to swallow `\input texinfo'. | ||
| 1127 | \iflinks | ||
| 1128 | \tryauxfile | ||
| 1129 | % Open the new aux file. TeX will close it automatically at exit. | ||
| 1130 | \immediate\openout\auxfile=\jobname.aux | ||
| 1131 | \fi % \openindices needs to do some work in any case. | ||
| 1132 | \openindices | ||
| 1133 | \let\setfilename=\comment % Ignore extra @setfilename cmds. | ||
| 1134 | % | ||
| 1135 | % If texinfo.cnf is present on the system, read it. | ||
| 1136 | % Useful for site-wide @afourpaper, etc. | ||
| 1137 | \openin 1 texinfo.cnf | ||
| 1138 | \ifeof 1 \else \input texinfo.cnf \fi | ||
| 1139 | \closein 1 | ||
| 1140 | % | ||
| 1141 | \comment % Ignore the actual filename. | ||
| 1142 | } | ||
| 1143 | |||
| 1144 | % Called from \setfilename. | ||
| 1145 | % | ||
| 1146 | \def\openindices{% | ||
| 1147 | \newindex{cp}% | ||
| 1148 | \newcodeindex{fn}% | ||
| 1149 | \newcodeindex{vr}% | ||
| 1150 | \newcodeindex{tp}% | ||
| 1151 | \newcodeindex{ky}% | ||
| 1152 | \newcodeindex{pg}% | ||
| 1153 | } | ||
| 1154 | |||
| 1155 | % @bye. | ||
| 1156 | \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} | ||
| 1157 | |||
| 1158 | |||
| 1159 | \message{pdf,} | ||
| 1160 | % adobe `portable' document format | ||
| 1161 | \newcount\tempnum | ||
| 1162 | \newcount\lnkcount | ||
| 1163 | \newtoks\filename | ||
| 1164 | \newcount\filenamelength | ||
| 1165 | \newcount\pgn | ||
| 1166 | \newtoks\toksA | ||
| 1167 | \newtoks\toksB | ||
| 1168 | \newtoks\toksC | ||
| 1169 | \newtoks\toksD | ||
| 1170 | \newbox\boxA | ||
| 1171 | \newcount\countA | ||
| 1172 | \newif\ifpdf | ||
| 1173 | \newif\ifpdfmakepagedest | ||
| 1174 | |||
| 1175 | % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 | ||
| 1176 | % can be set). So we test for \relax and 0 as well as \undefined, | ||
| 1177 | % borrowed from ifpdf.sty. | ||
| 1178 | \ifx\pdfoutput\undefined | ||
| 1179 | \else | ||
| 1180 | \ifx\pdfoutput\relax | ||
| 1181 | \else | ||
| 1182 | \ifcase\pdfoutput | ||
| 1183 | \else | ||
| 1184 | \pdftrue | ||
| 1185 | \fi | ||
| 1186 | \fi | ||
| 1187 | \fi | ||
| 1188 | |||
| 1189 | % PDF uses PostScript string constants for the names of xref targets, | ||
| 1190 | % for display in the outlines, and in other places. Thus, we have to | ||
| 1191 | % double any backslashes. Otherwise, a name like "\node" will be | ||
| 1192 | % interpreted as a newline (\n), followed by o, d, e. Not good. | ||
| 1193 | % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html | ||
| 1194 | % (and related messages, the final outcome is that it is up to the TeX | ||
| 1195 | % user to double the backslashes and otherwise make the string valid, so | ||
| 1196 | % that's what we do). | ||
| 1197 | |||
| 1198 | % double active backslashes. | ||
| 1199 | % | ||
| 1200 | {\catcode`\@=0 \catcode`\\=\active | ||
| 1201 | @gdef@activebackslashdouble{% | ||
| 1202 | @catcode`@\=@active | ||
| 1203 | @let\=@doublebackslash} | ||
| 1204 | } | ||
| 1205 | |||
| 1206 | % To handle parens, we must adopt a different approach, since parens are | ||
| 1207 | % not active characters. hyperref.dtx (which has the same problem as | ||
| 1208 | % us) handles it with this amazing macro to replace tokens. I've | ||
| 1209 | % tinkered with it a little for texinfo, but it's definitely from there. | ||
| 1210 | % | ||
| 1211 | % #1 is the tokens to replace. | ||
| 1212 | % #2 is the replacement. | ||
| 1213 | % #3 is the control sequence with the string. | ||
| 1214 | % | ||
| 1215 | \def\HyPsdSubst#1#2#3{% | ||
| 1216 | \def\HyPsdReplace##1#1##2\END{% | ||
| 1217 | ##1% | ||
| 1218 | \ifx\\##2\\% | ||
| 1219 | \else | ||
| 1220 | #2% | ||
| 1221 | \HyReturnAfterFi{% | ||
| 1222 | \HyPsdReplace##2\END | ||
| 1223 | }% | ||
| 1224 | \fi | ||
| 1225 | }% | ||
| 1226 | \xdef#3{\expandafter\HyPsdReplace#3#1\END}% | ||
| 1227 | } | ||
| 1228 | \long\def\HyReturnAfterFi#1\fi{\fi#1} | ||
| 1229 | |||
| 1230 | % #1 is a control sequence in which to do the replacements. | ||
| 1231 | \def\backslashparens#1{% | ||
| 1232 | \xdef#1{#1}% redefine it as its expansion; the definition is simply | ||
| 1233 | % \lastnode when called from \setref -> \pdfmkdest. | ||
| 1234 | \HyPsdSubst{(}{\realbackslash(}{#1}% | ||
| 1235 | \HyPsdSubst{)}{\realbackslash)}{#1}% | ||
| 1236 | } | ||
| 1237 | |||
| 1238 | \ifpdf | ||
| 1239 | \input pdfcolor | ||
| 1240 | \pdfcatalog{/PageMode /UseOutlines}% | ||
| 1241 | \def\dopdfimage#1#2#3{% | ||
| 1242 | \def\imagewidth{#2}% | ||
| 1243 | \def\imageheight{#3}% | ||
| 1244 | % without \immediate, pdftex seg faults when the same image is | ||
| 1245 | % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) | ||
| 1246 | \ifnum\pdftexversion < 14 | ||
| 1247 | \immediate\pdfimage | ||
| 1248 | \else | ||
| 1249 | \immediate\pdfximage | ||
| 1250 | \fi | ||
| 1251 | \ifx\empty\imagewidth\else width \imagewidth \fi | ||
| 1252 | \ifx\empty\imageheight\else height \imageheight \fi | ||
| 1253 | \ifnum\pdftexversion<13 | ||
| 1254 | #1.pdf% | ||
| 1255 | \else | ||
| 1256 | {#1.pdf}% | ||
| 1257 | \fi | ||
| 1258 | \ifnum\pdftexversion < 14 \else | ||
| 1259 | \pdfrefximage \pdflastximage | ||
| 1260 | \fi} | ||
| 1261 | \def\pdfmkdest#1{{% | ||
| 1262 | % We have to set dummies so commands such as @code, and characters | ||
| 1263 | % such as \, aren't expanded when present in a section title. | ||
| 1264 | \atdummies | ||
| 1265 | \activebackslashdouble | ||
| 1266 | \def\pdfdestname{#1}% | ||
| 1267 | \backslashparens\pdfdestname | ||
| 1268 | \pdfdest name{\pdfdestname} xyz% | ||
| 1269 | }}% | ||
| 1270 | % | ||
| 1271 | % used to mark target names; must be expandable. | ||
| 1272 | \def\pdfmkpgn#1{#1}% | ||
| 1273 | % | ||
| 1274 | \let\linkcolor = \Blue % was Cyan, but that seems light? | ||
| 1275 | \def\endlink{\Black\pdfendlink} | ||
| 1276 | % Adding outlines to PDF; macros for calculating structure of outlines | ||
| 1277 | % come from Petr Olsak | ||
| 1278 | \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% | ||
| 1279 | \else \csname#1\endcsname \fi} | ||
| 1280 | \def\advancenumber#1{\tempnum=\expnumber{#1}\relax | ||
| 1281 | \advance\tempnum by 1 | ||
| 1282 | \expandafter\xdef\csname#1\endcsname{\the\tempnum}} | ||
| 1283 | % | ||
| 1284 | % #1 is the section text, which is what will be displayed in the | ||
| 1285 | % outline by the pdf viewer. #2 is the pdf expression for the number | ||
| 1286 | % of subentries (or empty, for subsubsections). #3 is the node text, | ||
| 1287 | % which might be empty if this toc entry had no corresponding node. | ||
| 1288 | % #4 is the page number | ||
| 1289 | % | ||
| 1290 | \def\dopdfoutline#1#2#3#4{% | ||
| 1291 | % Generate a link to the node text if that exists; else, use the | ||
| 1292 | % page number. We could generate a destination for the section | ||
| 1293 | % text in the case where a section has no node, but it doesn't | ||
| 1294 | % seem worth the trouble, since most documents are normally structured. | ||
| 1295 | \def\pdfoutlinedest{#3}% | ||
| 1296 | \ifx\pdfoutlinedest\empty | ||
| 1297 | \def\pdfoutlinedest{#4}% | ||
| 1298 | \else | ||
| 1299 | % Doubled backslashes in the name. | ||
| 1300 | {\activebackslashdouble \xdef\pdfoutlinedest{#3}% | ||
| 1301 | \backslashparens\pdfoutlinedest}% | ||
| 1302 | \fi | ||
| 1303 | % | ||
| 1304 | % Also double the backslashes in the display string. | ||
| 1305 | {\activebackslashdouble \xdef\pdfoutlinetext{#1}% | ||
| 1306 | \backslashparens\pdfoutlinetext}% | ||
| 1307 | % | ||
| 1308 | \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}% | ||
| 1309 | } | ||
| 1310 | % | ||
| 1311 | \def\pdfmakeoutlines{% | ||
| 1312 | \begingroup | ||
| 1313 | % Thanh's hack / proper braces in bookmarks | ||
| 1314 | \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace | ||
| 1315 | \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace | ||
| 1316 | % | ||
| 1317 | % Read toc silently, to get counts of subentries for \pdfoutline. | ||
| 1318 | \def\numchapentry##1##2##3##4{% | ||
| 1319 | \def\thischapnum{##2}% | ||
| 1320 | \def\thissecnum{0}% | ||
| 1321 | \def\thissubsecnum{0}% | ||
| 1322 | }% | ||
| 1323 | \def\numsecentry##1##2##3##4{% | ||
| 1324 | \advancenumber{chap\thischapnum}% | ||
| 1325 | \def\thissecnum{##2}% | ||
| 1326 | \def\thissubsecnum{0}% | ||
| 1327 | }% | ||
| 1328 | \def\numsubsecentry##1##2##3##4{% | ||
| 1329 | \advancenumber{sec\thissecnum}% | ||
| 1330 | \def\thissubsecnum{##2}% | ||
| 1331 | }% | ||
| 1332 | \def\numsubsubsecentry##1##2##3##4{% | ||
| 1333 | \advancenumber{subsec\thissubsecnum}% | ||
| 1334 | }% | ||
| 1335 | \def\thischapnum{0}% | ||
| 1336 | \def\thissecnum{0}% | ||
| 1337 | \def\thissubsecnum{0}% | ||
| 1338 | % | ||
| 1339 | % use \def rather than \let here because we redefine \chapentry et | ||
| 1340 | % al. a second time, below. | ||
| 1341 | \def\appentry{\numchapentry}% | ||
| 1342 | \def\appsecentry{\numsecentry}% | ||
| 1343 | \def\appsubsecentry{\numsubsecentry}% | ||
| 1344 | \def\appsubsubsecentry{\numsubsubsecentry}% | ||
| 1345 | \def\unnchapentry{\numchapentry}% | ||
| 1346 | \def\unnsecentry{\numsecentry}% | ||
| 1347 | \def\unnsubsecentry{\numsubsecentry}% | ||
| 1348 | \def\unnsubsubsecentry{\numsubsubsecentry}% | ||
| 1349 | \readdatafile{toc}% | ||
| 1350 | % | ||
| 1351 | % Read toc second time, this time actually producing the outlines. | ||
| 1352 | % The `-' means take the \expnumber as the absolute number of | ||
| 1353 | % subentries, which we calculated on our first read of the .toc above. | ||
| 1354 | % | ||
| 1355 | % We use the node names as the destinations. | ||
| 1356 | \def\numchapentry##1##2##3##4{% | ||
| 1357 | \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% | ||
| 1358 | \def\numsecentry##1##2##3##4{% | ||
| 1359 | \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% | ||
| 1360 | \def\numsubsecentry##1##2##3##4{% | ||
| 1361 | \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% | ||
| 1362 | \def\numsubsubsecentry##1##2##3##4{% count is always zero | ||
| 1363 | \dopdfoutline{##1}{}{##3}{##4}}% | ||
| 1364 | % | ||
| 1365 | % PDF outlines are displayed using system fonts, instead of | ||
| 1366 | % document fonts. Therefore we cannot use special characters, | ||
| 1367 | % since the encoding is unknown. For example, the eogonek from | ||
| 1368 | % Latin 2 (0xea) gets translated to a | character. Info from | ||
| 1369 | % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. | ||
| 1370 | % | ||
| 1371 | % xx to do this right, we have to translate 8-bit characters to | ||
| 1372 | % their "best" equivalent, based on the @documentencoding. Right | ||
| 1373 | % now, I guess we'll just let the pdf reader have its way. | ||
| 1374 | \indexnofonts | ||
| 1375 | \setupdatafile | ||
| 1376 | \catcode`\\=\active \otherbackslash | ||
| 1377 | \input \jobname.toc | ||
| 1378 | \endgroup | ||
| 1379 | } | ||
| 1380 | % | ||
| 1381 | \def\skipspaces#1{\def\PP{#1}\def\D{|}% | ||
| 1382 | \ifx\PP\D\let\nextsp\relax | ||
| 1383 | \else\let\nextsp\skipspaces | ||
| 1384 | \ifx\p\space\else\addtokens{\filename}{\PP}% | ||
| 1385 | \advance\filenamelength by 1 | ||
| 1386 | \fi | ||
| 1387 | \fi | ||
| 1388 | \nextsp} | ||
| 1389 | \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} | ||
| 1390 | \ifnum\pdftexversion < 14 | ||
| 1391 | \let \startlink \pdfannotlink | ||
| 1392 | \else | ||
| 1393 | \let \startlink \pdfstartlink | ||
| 1394 | \fi | ||
| 1395 | % make a live url in pdf output. | ||
| 1396 | \def\pdfurl#1{% | ||
| 1397 | \begingroup | ||
| 1398 | % it seems we really need yet another set of dummies; have not | ||
| 1399 | % tried to figure out what each command should do in the context | ||
| 1400 | % of @url. for now, just make @/ a no-op, that's the only one | ||
| 1401 | % people have actually reported a problem with. | ||
| 1402 | % | ||
| 1403 | \normalturnoffactive | ||
| 1404 | \def\@{@}% | ||
| 1405 | \let\/=\empty | ||
| 1406 | \makevalueexpandable | ||
| 1407 | \leavevmode\Red | ||
| 1408 | \startlink attr{/Border [0 0 0]}% | ||
| 1409 | user{/Subtype /Link /A << /S /URI /URI (#1) >>}% | ||
| 1410 | \endgroup} | ||
| 1411 | \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} | ||
| 1412 | \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} | ||
| 1413 | \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} | ||
| 1414 | \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} | ||
| 1415 | \def\maketoks{% | ||
| 1416 | \expandafter\poptoks\the\toksA|ENDTOKS|\relax | ||
| 1417 | \ifx\first0\adn0 | ||
| 1418 | \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 | ||
| 1419 | \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 | ||
| 1420 | \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 | ||
| 1421 | \else | ||
| 1422 | \ifnum0=\countA\else\makelink\fi | ||
| 1423 | \ifx\first.\let\next=\done\else | ||
| 1424 | \let\next=\maketoks | ||
| 1425 | \addtokens{\toksB}{\the\toksD} | ||
| 1426 | \ifx\first,\addtokens{\toksB}{\space}\fi | ||
| 1427 | \fi | ||
| 1428 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi | ||
| 1429 | \next} | ||
| 1430 | \def\makelink{\addtokens{\toksB}% | ||
| 1431 | {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} | ||
| 1432 | \def\pdflink#1{% | ||
| 1433 | \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} | ||
| 1434 | \linkcolor #1\endlink} | ||
| 1435 | \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} | ||
| 1436 | \else | ||
| 1437 | \let\pdfmkdest = \gobble | ||
| 1438 | \let\pdfurl = \gobble | ||
| 1439 | \let\endlink = \relax | ||
| 1440 | \let\linkcolor = \relax | ||
| 1441 | \let\pdfmakeoutlines = \relax | ||
| 1442 | \fi % \ifx\pdfoutput | ||
| 1443 | |||
| 1444 | |||
| 1445 | \message{fonts,} | ||
| 1446 | |||
| 1447 | % Change the current font style to #1, remembering it in \curfontstyle. | ||
| 1448 | % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in | ||
| 1449 | % italics, not bold italics. | ||
| 1450 | % | ||
| 1451 | \def\setfontstyle#1{% | ||
| 1452 | \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. | ||
| 1453 | \csname ten#1\endcsname % change the current font | ||
| 1454 | } | ||
| 1455 | |||
| 1456 | % Select #1 fonts with the current style. | ||
| 1457 | % | ||
| 1458 | \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} | ||
| 1459 | |||
| 1460 | \def\rm{\fam=0 \setfontstyle{rm}} | ||
| 1461 | \def\it{\fam=\itfam \setfontstyle{it}} | ||
| 1462 | \def\sl{\fam=\slfam \setfontstyle{sl}} | ||
| 1463 | \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} | ||
| 1464 | \def\tt{\fam=\ttfam \setfontstyle{tt}} | ||
| 1465 | |||
| 1466 | % Texinfo sort of supports the sans serif font style, which plain TeX does not. | ||
| 1467 | % So we set up a \sf. | ||
| 1468 | \newfam\sffam | ||
| 1469 | \def\sf{\fam=\sffam \setfontstyle{sf}} | ||
| 1470 | \let\li = \sf % Sometimes we call it \li, not \sf. | ||
| 1471 | |||
| 1472 | % We don't need math for this font style. | ||
| 1473 | \def\ttsl{\setfontstyle{ttsl}} | ||
| 1474 | |||
| 1475 | % Default leading. | ||
| 1476 | \newdimen\textleading \textleading = 13.2pt | ||
| 1477 | |||
| 1478 | % Set the baselineskip to #1, and the lineskip and strut size | ||
| 1479 | % correspondingly. There is no deep meaning behind these magic numbers | ||
| 1480 | % used as factors; they just match (closely enough) what Knuth defined. | ||
| 1481 | % | ||
| 1482 | \def\lineskipfactor{.08333} | ||
| 1483 | \def\strutheightpercent{.70833} | ||
| 1484 | \def\strutdepthpercent {.29167} | ||
| 1485 | % | ||
| 1486 | \def\setleading#1{% | ||
| 1487 | \normalbaselineskip = #1\relax | ||
| 1488 | \normallineskip = \lineskipfactor\normalbaselineskip | ||
| 1489 | \normalbaselines | ||
| 1490 | \setbox\strutbox =\hbox{% | ||
| 1491 | \vrule width0pt height\strutheightpercent\baselineskip | ||
| 1492 | depth \strutdepthpercent \baselineskip | ||
| 1493 | }% | ||
| 1494 | } | ||
| 1495 | |||
| 1496 | % Set the font macro #1 to the font named #2, adding on the | ||
| 1497 | % specified font prefix (normally `cm'). | ||
| 1498 | % #3 is the font's design size, #4 is a scale factor | ||
| 1499 | \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} | ||
| 1500 | |||
| 1501 | % Use cm as the default font prefix. | ||
| 1502 | % To specify the font prefix, you must define \fontprefix | ||
| 1503 | % before you read in texinfo.tex. | ||
| 1504 | \ifx\fontprefix\undefined | ||
| 1505 | \def\fontprefix{cm} | ||
| 1506 | \fi | ||
| 1507 | % Support font families that don't use the same naming scheme as CM. | ||
| 1508 | \def\rmshape{r} | ||
| 1509 | \def\rmbshape{bx} %where the normal face is bold | ||
| 1510 | \def\bfshape{b} | ||
| 1511 | \def\bxshape{bx} | ||
| 1512 | \def\ttshape{tt} | ||
| 1513 | \def\ttbshape{tt} | ||
| 1514 | \def\ttslshape{sltt} | ||
| 1515 | \def\itshape{ti} | ||
| 1516 | \def\itbshape{bxti} | ||
| 1517 | \def\slshape{sl} | ||
| 1518 | \def\slbshape{bxsl} | ||
| 1519 | \def\sfshape{ss} | ||
| 1520 | \def\sfbshape{ss} | ||
| 1521 | \def\scshape{csc} | ||
| 1522 | \def\scbshape{csc} | ||
| 1523 | |||
| 1524 | % Text fonts (11.2pt, magstep1). | ||
| 1525 | \def\textnominalsize{11pt} | ||
| 1526 | \edef\mainmagstep{\magstephalf} | ||
| 1527 | \setfont\textrm\rmshape{10}{\mainmagstep} | ||
| 1528 | \setfont\texttt\ttshape{10}{\mainmagstep} | ||
| 1529 | \setfont\textbf\bfshape{10}{\mainmagstep} | ||
| 1530 | \setfont\textit\itshape{10}{\mainmagstep} | ||
| 1531 | \setfont\textsl\slshape{10}{\mainmagstep} | ||
| 1532 | \setfont\textsf\sfshape{10}{\mainmagstep} | ||
| 1533 | \setfont\textsc\scshape{10}{\mainmagstep} | ||
| 1534 | \setfont\textttsl\ttslshape{10}{\mainmagstep} | ||
| 1535 | \font\texti=cmmi10 scaled \mainmagstep | ||
| 1536 | \font\textsy=cmsy10 scaled \mainmagstep | ||
| 1537 | |||
| 1538 | % A few fonts for @defun names and args. | ||
| 1539 | \setfont\defbf\bfshape{10}{\magstep1} | ||
| 1540 | \setfont\deftt\ttshape{10}{\magstep1} | ||
| 1541 | \setfont\defttsl\ttslshape{10}{\magstep1} | ||
| 1542 | \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} | ||
| 1543 | |||
| 1544 | % Fonts for indices, footnotes, small examples (9pt). | ||
| 1545 | \def\smallnominalsize{9pt} | ||
| 1546 | \setfont\smallrm\rmshape{9}{1000} | ||
| 1547 | \setfont\smalltt\ttshape{9}{1000} | ||
| 1548 | \setfont\smallbf\bfshape{10}{900} | ||
| 1549 | \setfont\smallit\itshape{9}{1000} | ||
| 1550 | \setfont\smallsl\slshape{9}{1000} | ||
| 1551 | \setfont\smallsf\sfshape{9}{1000} | ||
| 1552 | \setfont\smallsc\scshape{10}{900} | ||
| 1553 | \setfont\smallttsl\ttslshape{10}{900} | ||
| 1554 | \font\smalli=cmmi9 | ||
| 1555 | \font\smallsy=cmsy9 | ||
| 1556 | |||
| 1557 | % Fonts for small examples (8pt). | ||
| 1558 | \def\smallernominalsize{8pt} | ||
| 1559 | \setfont\smallerrm\rmshape{8}{1000} | ||
| 1560 | \setfont\smallertt\ttshape{8}{1000} | ||
| 1561 | \setfont\smallerbf\bfshape{10}{800} | ||
| 1562 | \setfont\smallerit\itshape{8}{1000} | ||
| 1563 | \setfont\smallersl\slshape{8}{1000} | ||
| 1564 | \setfont\smallersf\sfshape{8}{1000} | ||
| 1565 | \setfont\smallersc\scshape{10}{800} | ||
| 1566 | \setfont\smallerttsl\ttslshape{10}{800} | ||
| 1567 | \font\smalleri=cmmi8 | ||
| 1568 | \font\smallersy=cmsy8 | ||
| 1569 | |||
| 1570 | % Fonts for title page (20.4pt): | ||
| 1571 | \def\titlenominalsize{20pt} | ||
| 1572 | \setfont\titlerm\rmbshape{12}{\magstep3} | ||
| 1573 | \setfont\titleit\itbshape{10}{\magstep4} | ||
| 1574 | \setfont\titlesl\slbshape{10}{\magstep4} | ||
| 1575 | \setfont\titlett\ttbshape{12}{\magstep3} | ||
| 1576 | \setfont\titlettsl\ttslshape{10}{\magstep4} | ||
| 1577 | \setfont\titlesf\sfbshape{17}{\magstep1} | ||
| 1578 | \let\titlebf=\titlerm | ||
| 1579 | \setfont\titlesc\scbshape{10}{\magstep4} | ||
| 1580 | \font\titlei=cmmi12 scaled \magstep3 | ||
| 1581 | \font\titlesy=cmsy10 scaled \magstep4 | ||
| 1582 | \def\authorrm{\secrm} | ||
| 1583 | \def\authortt{\sectt} | ||
| 1584 | |||
| 1585 | % Chapter (and unnumbered) fonts (17.28pt). | ||
| 1586 | \def\chapnominalsize{17pt} | ||
| 1587 | \setfont\chaprm\rmbshape{12}{\magstep2} | ||
| 1588 | \setfont\chapit\itbshape{10}{\magstep3} | ||
| 1589 | \setfont\chapsl\slbshape{10}{\magstep3} | ||
| 1590 | \setfont\chaptt\ttbshape{12}{\magstep2} | ||
| 1591 | \setfont\chapttsl\ttslshape{10}{\magstep3} | ||
| 1592 | \setfont\chapsf\sfbshape{17}{1000} | ||
| 1593 | \let\chapbf=\chaprm | ||
| 1594 | \setfont\chapsc\scbshape{10}{\magstep3} | ||
| 1595 | \font\chapi=cmmi12 scaled \magstep2 | ||
| 1596 | \font\chapsy=cmsy10 scaled \magstep3 | ||
| 1597 | |||
| 1598 | % Section fonts (14.4pt). | ||
| 1599 | \def\secnominalsize{14pt} | ||
| 1600 | \setfont\secrm\rmbshape{12}{\magstep1} | ||
| 1601 | \setfont\secit\itbshape{10}{\magstep2} | ||
| 1602 | \setfont\secsl\slbshape{10}{\magstep2} | ||
| 1603 | \setfont\sectt\ttbshape{12}{\magstep1} | ||
| 1604 | \setfont\secttsl\ttslshape{10}{\magstep2} | ||
| 1605 | \setfont\secsf\sfbshape{12}{\magstep1} | ||
| 1606 | \let\secbf\secrm | ||
| 1607 | \setfont\secsc\scbshape{10}{\magstep2} | ||
| 1608 | \font\seci=cmmi12 scaled \magstep1 | ||
| 1609 | \font\secsy=cmsy10 scaled \magstep2 | ||
| 1610 | |||
| 1611 | % Subsection fonts (13.15pt). | ||
| 1612 | \def\ssecnominalsize{13pt} | ||
| 1613 | \setfont\ssecrm\rmbshape{12}{\magstephalf} | ||
| 1614 | \setfont\ssecit\itbshape{10}{1315} | ||
| 1615 | \setfont\ssecsl\slbshape{10}{1315} | ||
| 1616 | \setfont\ssectt\ttbshape{12}{\magstephalf} | ||
| 1617 | \setfont\ssecttsl\ttslshape{10}{1315} | ||
| 1618 | \setfont\ssecsf\sfbshape{12}{\magstephalf} | ||
| 1619 | \let\ssecbf\ssecrm | ||
| 1620 | \setfont\ssecsc\scbshape{10}{1315} | ||
| 1621 | \font\sseci=cmmi12 scaled \magstephalf | ||
| 1622 | \font\ssecsy=cmsy10 scaled 1315 | ||
| 1623 | |||
| 1624 | % Reduced fonts for @acro in text (10pt). | ||
| 1625 | \def\reducednominalsize{10pt} | ||
| 1626 | \setfont\reducedrm\rmshape{10}{1000} | ||
| 1627 | \setfont\reducedtt\ttshape{10}{1000} | ||
| 1628 | \setfont\reducedbf\bfshape{10}{1000} | ||
| 1629 | \setfont\reducedit\itshape{10}{1000} | ||
| 1630 | \setfont\reducedsl\slshape{10}{1000} | ||
| 1631 | \setfont\reducedsf\sfshape{10}{1000} | ||
| 1632 | \setfont\reducedsc\scshape{10}{1000} | ||
| 1633 | \setfont\reducedttsl\ttslshape{10}{1000} | ||
| 1634 | \font\reducedi=cmmi10 | ||
| 1635 | \font\reducedsy=cmsy10 | ||
| 1636 | |||
| 1637 | % In order for the font changes to affect most math symbols and letters, | ||
| 1638 | % we have to define the \textfont of the standard families. Since | ||
| 1639 | % texinfo doesn't allow for producing subscripts and superscripts except | ||
| 1640 | % in the main text, we don't bother to reset \scriptfont and | ||
| 1641 | % \scriptscriptfont (which would also require loading a lot more fonts). | ||
| 1642 | % | ||
| 1643 | \def\resetmathfonts{% | ||
| 1644 | \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy | ||
| 1645 | \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf | ||
| 1646 | \textfont\ttfam=\tentt \textfont\sffam=\tensf | ||
| 1647 | } | ||
| 1648 | |||
| 1649 | % The font-changing commands redefine the meanings of \tenSTYLE, instead | ||
| 1650 | % of just \STYLE. We do this because \STYLE needs to also set the | ||
| 1651 | % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire | ||
| 1652 | % \tenSTYLE to set the current font. | ||
| 1653 | % | ||
| 1654 | % Each font-changing command also sets the names \lsize (one size lower) | ||
| 1655 | % and \lllsize (three sizes lower). These relative commands are used in | ||
| 1656 | % the LaTeX logo and acronyms. | ||
| 1657 | % | ||
| 1658 | % This all needs generalizing, badly. | ||
| 1659 | % | ||
| 1660 | \def\textfonts{% | ||
| 1661 | \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl | ||
| 1662 | \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc | ||
| 1663 | \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy | ||
| 1664 | \let\tenttsl=\textttsl | ||
| 1665 | \def\curfontsize{text}% | ||
| 1666 | \def\lsize{reduced}\def\lllsize{smaller}% | ||
| 1667 | \resetmathfonts \setleading{\textleading}} | ||
| 1668 | \def\titlefonts{% | ||
| 1669 | \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl | ||
| 1670 | \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc | ||
| 1671 | \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy | ||
| 1672 | \let\tenttsl=\titlettsl | ||
| 1673 | \def\curfontsize{title}% | ||
| 1674 | \def\lsize{chap}\def\lllsize{subsec}% | ||
| 1675 | \resetmathfonts \setleading{25pt}} | ||
| 1676 | \def\titlefont#1{{\titlefonts\rm #1}} | ||
| 1677 | \def\chapfonts{% | ||
| 1678 | \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl | ||
| 1679 | \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc | ||
| 1680 | \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy | ||
| 1681 | \let\tenttsl=\chapttsl | ||
| 1682 | \def\curfontsize{chap}% | ||
| 1683 | \def\lsize{sec}\def\lllsize{text}% | ||
| 1684 | \resetmathfonts \setleading{19pt}} | ||
| 1685 | \def\secfonts{% | ||
| 1686 | \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl | ||
| 1687 | \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc | ||
| 1688 | \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy | ||
| 1689 | \let\tenttsl=\secttsl | ||
| 1690 | \def\curfontsize{sec}% | ||
| 1691 | \def\lsize{subsec}\def\lllsize{reduced}% | ||
| 1692 | \resetmathfonts \setleading{16pt}} | ||
| 1693 | \def\subsecfonts{% | ||
| 1694 | \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl | ||
| 1695 | \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc | ||
| 1696 | \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy | ||
| 1697 | \let\tenttsl=\ssecttsl | ||
| 1698 | \def\curfontsize{ssec}% | ||
| 1699 | \def\lsize{text}\def\lllsize{small}% | ||
| 1700 | \resetmathfonts \setleading{15pt}} | ||
| 1701 | \let\subsubsecfonts = \subsecfonts | ||
| 1702 | \def\reducedfonts{% | ||
| 1703 | \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl | ||
| 1704 | \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc | ||
| 1705 | \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy | ||
| 1706 | \let\tenttsl=\reducedttsl | ||
| 1707 | \def\curfontsize{reduced}% | ||
| 1708 | \def\lsize{small}\def\lllsize{smaller}% | ||
| 1709 | \resetmathfonts \setleading{10.5pt}} | ||
| 1710 | \def\smallfonts{% | ||
| 1711 | \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl | ||
| 1712 | \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc | ||
| 1713 | \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy | ||
| 1714 | \let\tenttsl=\smallttsl | ||
| 1715 | \def\curfontsize{small}% | ||
| 1716 | \def\lsize{smaller}\def\lllsize{smaller}% | ||
| 1717 | \resetmathfonts \setleading{10.5pt}} | ||
| 1718 | \def\smallerfonts{% | ||
| 1719 | \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl | ||
| 1720 | \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc | ||
| 1721 | \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy | ||
| 1722 | \let\tenttsl=\smallerttsl | ||
| 1723 | \def\curfontsize{smaller}% | ||
| 1724 | \def\lsize{smaller}\def\lllsize{smaller}% | ||
| 1725 | \resetmathfonts \setleading{9.5pt}} | ||
| 1726 | |||
| 1727 | % Set the fonts to use with the @small... environments. | ||
| 1728 | \let\smallexamplefonts = \smallfonts | ||
| 1729 | |||
| 1730 | % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample | ||
| 1731 | % can fit this many characters: | ||
| 1732 | % 8.5x11=86 smallbook=72 a4=90 a5=69 | ||
| 1733 | % If we use \scriptfonts (8pt), then we can fit this many characters: | ||
| 1734 | % 8.5x11=90+ smallbook=80 a4=90+ a5=77 | ||
| 1735 | % For me, subjectively, the few extra characters that fit aren't worth | ||
| 1736 | % the additional smallness of 8pt. So I'm making the default 9pt. | ||
| 1737 | % | ||
| 1738 | % By the way, for comparison, here's what fits with @example (10pt): | ||
| 1739 | % 8.5x11=71 smallbook=60 a4=75 a5=58 | ||
| 1740 | % | ||
| 1741 | % I wish the USA used A4 paper. | ||
| 1742 | % --karl, 24jan03. | ||
| 1743 | |||
| 1744 | |||
| 1745 | % Set up the default fonts, so we can use them for creating boxes. | ||
| 1746 | % | ||
| 1747 | \textfonts \rm | ||
| 1748 | |||
| 1749 | % Define these so they can be easily changed for other fonts. | ||
| 1750 | \def\angleleft{$\langle$} | ||
| 1751 | \def\angleright{$\rangle$} | ||
| 1752 | |||
| 1753 | % Count depth in font-changes, for error checks | ||
| 1754 | \newcount\fontdepth \fontdepth=0 | ||
| 1755 | |||
| 1756 | % Fonts for short table of contents. | ||
| 1757 | \setfont\shortcontrm\rmshape{12}{1000} | ||
| 1758 | \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12 | ||
| 1759 | \setfont\shortcontsl\slshape{12}{1000} | ||
| 1760 | \setfont\shortconttt\ttshape{12}{1000} | ||
| 1761 | |||
| 1762 | %% Add scribe-like font environments, plus @l for inline lisp (usually sans | ||
| 1763 | %% serif) and @ii for TeX italic | ||
| 1764 | |||
| 1765 | % \smartitalic{ARG} outputs arg in italics, followed by an italic correction | ||
| 1766 | % unless the following character is such as not to need one. | ||
| 1767 | \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else | ||
| 1768 | \ptexslash\fi\fi\fi} | ||
| 1769 | \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} | ||
| 1770 | \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} | ||
| 1771 | |||
| 1772 | % like \smartslanted except unconditionally uses \ttsl. | ||
| 1773 | % @var is set to this for defun arguments. | ||
| 1774 | \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} | ||
| 1775 | |||
| 1776 | % like \smartslanted except unconditionally use \sl. We never want | ||
| 1777 | % ttsl for book titles, do we? | ||
| 1778 | \def\cite#1{{\sl #1}\futurelet\next\smartitalicx} | ||
| 1779 | |||
| 1780 | \let\i=\smartitalic | ||
| 1781 | \let\slanted=\smartslanted | ||
| 1782 | \let\var=\smartslanted | ||
| 1783 | \let\dfn=\smartslanted | ||
| 1784 | \let\emph=\smartitalic | ||
| 1785 | |||
| 1786 | % @b, explicit bold. | ||
| 1787 | \def\b#1{{\bf #1}} | ||
| 1788 | \let\strong=\b | ||
| 1789 | |||
| 1790 | % @sansserif, explicit sans. | ||
| 1791 | \def\sansserif#1{{\sf #1}} | ||
| 1792 | |||
| 1793 | % We can't just use \exhyphenpenalty, because that only has effect at | ||
| 1794 | % the end of a paragraph. Restore normal hyphenation at the end of the | ||
| 1795 | % group within which \nohyphenation is presumably called. | ||
| 1796 | % | ||
| 1797 | \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} | ||
| 1798 | \def\restorehyphenation{\hyphenchar\font = `- } | ||
| 1799 | |||
| 1800 | % Set sfcode to normal for the chars that usually have another value. | ||
| 1801 | % Can't use plain's \frenchspacing because it uses the `\x notation, and | ||
| 1802 | % sometimes \x has an active definition that messes things up. | ||
| 1803 | % | ||
| 1804 | \chardef\colonChar = `\: | ||
| 1805 | \chardef\commaChar = `\, | ||
| 1806 | \chardef\dotChar = `\. | ||
| 1807 | \chardef\exclamChar= `\! | ||
| 1808 | \chardef\questChar = `\? | ||
| 1809 | \chardef\semiChar = `\; | ||
| 1810 | % | ||
| 1811 | \catcode`@=11 | ||
| 1812 | \def\plainfrenchspacing{% | ||
| 1813 | \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m | ||
| 1814 | \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m | ||
| 1815 | \def\endofsentencespacefactor{1000}% for @. and friends | ||
| 1816 | } | ||
| 1817 | \def\plainnonfrenchspacing{% | ||
| 1818 | \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000 | ||
| 1819 | \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250 | ||
| 1820 | \def\endofsentencespacefactor{3000}% for @. and friends | ||
| 1821 | } | ||
| 1822 | \catcode`@=\other | ||
| 1823 | \def\endofsentencespacefactor{3000}% default | ||
| 1824 | |||
| 1825 | \def\t#1{% | ||
| 1826 | {\tt \rawbackslash \plainfrenchspacing #1}% | ||
| 1827 | \null | ||
| 1828 | } | ||
| 1829 | \def\samp#1{`\tclose{#1}'\null} | ||
| 1830 | \setfont\keyrm\rmshape{8}{1000} | ||
| 1831 | \font\keysy=cmsy9 | ||
| 1832 | \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% | ||
| 1833 | \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% | ||
| 1834 | \vbox{\hrule\kern-0.4pt | ||
| 1835 | \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% | ||
| 1836 | \kern-0.4pt\hrule}% | ||
| 1837 | \kern-.06em\raise0.4pt\hbox{\angleright}}}} | ||
| 1838 | % The old definition, with no lozenge: | ||
| 1839 | %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} | ||
| 1840 | \def\ctrl #1{{\tt \rawbackslash \hat}#1} | ||
| 1841 | |||
| 1842 | % @file, @option are the same as @samp. | ||
| 1843 | \let\file=\samp | ||
| 1844 | \let\option=\samp | ||
| 1845 | |||
| 1846 | % @code is a modification of @t, | ||
| 1847 | % which makes spaces the same size as normal in the surrounding text. | ||
| 1848 | \def\tclose#1{% | ||
| 1849 | {% | ||
| 1850 | % Change normal interword space to be same as for the current font. | ||
| 1851 | \spaceskip = \fontdimen2\font | ||
| 1852 | % | ||
| 1853 | % Switch to typewriter. | ||
| 1854 | \tt | ||
| 1855 | % | ||
| 1856 | % But `\ ' produces the large typewriter interword space. | ||
| 1857 | \def\ {{\spaceskip = 0pt{} }}% | ||
| 1858 | % | ||
| 1859 | % Turn off hyphenation. | ||
| 1860 | \nohyphenation | ||
| 1861 | % | ||
| 1862 | \rawbackslash | ||
| 1863 | \plainfrenchspacing | ||
| 1864 | #1% | ||
| 1865 | }% | ||
| 1866 | \null | ||
| 1867 | } | ||
| 1868 | |||
| 1869 | % We *must* turn on hyphenation at `-' and `_' in @code. | ||
| 1870 | % Otherwise, it is too hard to avoid overfull hboxes | ||
| 1871 | % in the Emacs manual, the Library manual, etc. | ||
| 1872 | |||
| 1873 | % Unfortunately, TeX uses one parameter (\hyphenchar) to control | ||
| 1874 | % both hyphenation at - and hyphenation within words. | ||
| 1875 | % We must therefore turn them both off (\tclose does that) | ||
| 1876 | % and arrange explicitly to hyphenate at a dash. | ||
| 1877 | % -- rms. | ||
| 1878 | { | ||
| 1879 | \catcode`\-=\active | ||
| 1880 | \catcode`\_=\active | ||
| 1881 | % | ||
| 1882 | \global\def\code{\begingroup | ||
| 1883 | \catcode`\-=\active \catcode`\_=\active | ||
| 1884 | \ifallowcodebreaks | ||
| 1885 | \let-\codedash | ||
| 1886 | \let_\codeunder | ||
| 1887 | \else | ||
| 1888 | \let-\realdash | ||
| 1889 | \let_\realunder | ||
| 1890 | \fi | ||
| 1891 | \codex | ||
| 1892 | } | ||
| 1893 | } | ||
| 1894 | |||
| 1895 | \def\realdash{-} | ||
| 1896 | \def\codedash{-\discretionary{}{}{}} | ||
| 1897 | \def\codeunder{% | ||
| 1898 | % this is all so @math{@code{var_name}+1} can work. In math mode, _ | ||
| 1899 | % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) | ||
| 1900 | % will therefore expand the active definition of _, which is us | ||
| 1901 | % (inside @code that is), therefore an endless loop. | ||
| 1902 | \ifusingtt{\ifmmode | ||
| 1903 | \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. | ||
| 1904 | \else\normalunderscore \fi | ||
| 1905 | \discretionary{}{}{}}% | ||
| 1906 | {\_}% | ||
| 1907 | } | ||
| 1908 | \def\codex #1{\tclose{#1}\endgroup} | ||
| 1909 | |||
| 1910 | % An additional complication: the above will allow breaks after, e.g., | ||
| 1911 | % each of the four underscores in __typeof__. This is undesirable in | ||
| 1912 | % some manuals, especially if they don't have long identifiers in | ||
| 1913 | % general. @allowcodebreaks provides a way to control this. | ||
| 1914 | % | ||
| 1915 | \newif\ifallowcodebreaks \allowcodebreakstrue | ||
| 1916 | |||
| 1917 | \def\keywordtrue{true} | ||
| 1918 | \def\keywordfalse{false} | ||
| 1919 | |||
| 1920 | \parseargdef\allowcodebreaks{% | ||
| 1921 | \def\txiarg{#1}% | ||
| 1922 | \ifx\txiarg\keywordtrue | ||
| 1923 | \allowcodebreakstrue | ||
| 1924 | \else\ifx\txiarg\keywordfalse | ||
| 1925 | \allowcodebreaksfalse | ||
| 1926 | \else | ||
| 1927 | \errhelp = \EMsimple | ||
| 1928 | \errmessage{Unknown @allowcodebreaks option `\txiarg'}% | ||
| 1929 | \fi\fi | ||
| 1930 | } | ||
| 1931 | |||
| 1932 | % @kbd is like @code, except that if the argument is just one @key command, | ||
| 1933 | % then @kbd has no effect. | ||
| 1934 | |||
| 1935 | % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), | ||
| 1936 | % `example' (@kbd uses ttsl only inside of @example and friends), | ||
| 1937 | % or `code' (@kbd uses normal tty font always). | ||
| 1938 | \parseargdef\kbdinputstyle{% | ||
| 1939 | \def\txiarg{#1}% | ||
| 1940 | \ifx\txiarg\worddistinct | ||
| 1941 | \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% | ||
| 1942 | \else\ifx\txiarg\wordexample | ||
| 1943 | \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% | ||
| 1944 | \else\ifx\txiarg\wordcode | ||
| 1945 | \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% | ||
| 1946 | \else | ||
| 1947 | \errhelp = \EMsimple | ||
| 1948 | \errmessage{Unknown @kbdinputstyle option `\txiarg'}% | ||
| 1949 | \fi\fi\fi | ||
| 1950 | } | ||
| 1951 | \def\worddistinct{distinct} | ||
| 1952 | \def\wordexample{example} | ||
| 1953 | \def\wordcode{code} | ||
| 1954 | |||
| 1955 | % Default is `distinct.' | ||
| 1956 | \kbdinputstyle distinct | ||
| 1957 | |||
| 1958 | \def\xkey{\key} | ||
| 1959 | \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% | ||
| 1960 | \ifx\one\xkey\ifx\threex\three \key{#2}% | ||
| 1961 | \else{\tclose{\kbdfont\look}}\fi | ||
| 1962 | \else{\tclose{\kbdfont\look}}\fi} | ||
| 1963 | |||
| 1964 | % For @indicateurl, @env, @command quotes seem unnecessary, so use \code. | ||
| 1965 | \let\indicateurl=\code | ||
| 1966 | \let\env=\code | ||
| 1967 | \let\command=\code | ||
| 1968 | |||
| 1969 | % @uref (abbreviation for `urlref') takes an optional (comma-separated) | ||
| 1970 | % second argument specifying the text to display and an optional third | ||
| 1971 | % arg as text to display instead of (rather than in addition to) the url | ||
| 1972 | % itself. First (mandatory) arg is the url. Perhaps eventually put in | ||
| 1973 | % a hypertex \special here. | ||
| 1974 | % | ||
| 1975 | \def\uref#1{\douref #1,,,\finish} | ||
| 1976 | \def\douref#1,#2,#3,#4\finish{\begingroup | ||
| 1977 | \unsepspaces | ||
| 1978 | \pdfurl{#1}% | ||
| 1979 | \setbox0 = \hbox{\ignorespaces #3}% | ||
| 1980 | \ifdim\wd0 > 0pt | ||
| 1981 | \unhbox0 % third arg given, show only that | ||
| 1982 | \else | ||
| 1983 | \setbox0 = \hbox{\ignorespaces #2}% | ||
| 1984 | \ifdim\wd0 > 0pt | ||
| 1985 | \ifpdf | ||
| 1986 | \unhbox0 % PDF: 2nd arg given, show only it | ||
| 1987 | \else | ||
| 1988 | \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url | ||
| 1989 | \fi | ||
| 1990 | \else | ||
| 1991 | \code{#1}% only url given, so show it | ||
| 1992 | \fi | ||
| 1993 | \fi | ||
| 1994 | \endlink | ||
| 1995 | \endgroup} | ||
| 1996 | |||
| 1997 | % @url synonym for @uref, since that's how everyone uses it. | ||
| 1998 | % | ||
| 1999 | \let\url=\uref | ||
| 2000 | |||
| 2001 | % rms does not like angle brackets --karl, 17may97. | ||
| 2002 | % So now @email is just like @uref, unless we are pdf. | ||
| 2003 | % | ||
| 2004 | %\def\email#1{\angleleft{\tt #1}\angleright} | ||
| 2005 | \ifpdf | ||
| 2006 | \def\email#1{\doemail#1,,\finish} | ||
| 2007 | \def\doemail#1,#2,#3\finish{\begingroup | ||
| 2008 | \unsepspaces | ||
| 2009 | \pdfurl{mailto:#1}% | ||
| 2010 | \setbox0 = \hbox{\ignorespaces #2}% | ||
| 2011 | \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi | ||
| 2012 | \endlink | ||
| 2013 | \endgroup} | ||
| 2014 | \else | ||
| 2015 | \let\email=\uref | ||
| 2016 | \fi | ||
| 2017 | |||
| 2018 | % Check if we are currently using a typewriter font. Since all the | ||
| 2019 | % Computer Modern typewriter fonts have zero interword stretch (and | ||
| 2020 | % shrink), and it is reasonable to expect all typewriter fonts to have | ||
| 2021 | % this property, we can check that font parameter. | ||
| 2022 | % | ||
| 2023 | \def\ifmonospace{\ifdim\fontdimen3\font=0pt } | ||
| 2024 | |||
| 2025 | % Typeset a dimension, e.g., `in' or `pt'. The only reason for the | ||
| 2026 | % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. | ||
| 2027 | % | ||
| 2028 | \def\dmn#1{\thinspace #1} | ||
| 2029 | |||
| 2030 | \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} | ||
| 2031 | |||
| 2032 | % @l was never documented to mean ``switch to the Lisp font'', | ||
| 2033 | % and it is not used as such in any manual I can find. We need it for | ||
| 2034 | % Polish suppressed-l. --karl, 22sep96. | ||
| 2035 | %\def\l#1{{\li #1}\null} | ||
| 2036 | |||
| 2037 | % Explicit font changes: @r, @sc, undocumented @ii. | ||
| 2038 | \def\r#1{{\rm #1}} % roman font | ||
| 2039 | \def\sc#1{{\smallcaps#1}} % smallcaps font | ||
| 2040 | \def\ii#1{{\it #1}} % italic font | ||
| 2041 | |||
| 2042 | % @acronym for "FBI", "NATO", and the like. | ||
| 2043 | % We print this one point size smaller, since it's intended for | ||
| 2044 | % all-uppercase. | ||
| 2045 | % | ||
| 2046 | \def\acronym#1{\doacronym #1,,\finish} | ||
| 2047 | \def\doacronym#1,#2,#3\finish{% | ||
| 2048 | {\selectfonts\lsize #1}% | ||
| 2049 | \def\temp{#2}% | ||
| 2050 | \ifx\temp\empty \else | ||
| 2051 | \space ({\unsepspaces \ignorespaces \temp \unskip})% | ||
| 2052 | \fi | ||
| 2053 | } | ||
| 2054 | |||
| 2055 | % @abbr for "Comput. J." and the like. | ||
| 2056 | % No font change, but don't do end-of-sentence spacing. | ||
| 2057 | % | ||
| 2058 | \def\abbr#1{\doabbr #1,,\finish} | ||
| 2059 | \def\doabbr#1,#2,#3\finish{% | ||
| 2060 | {\plainfrenchspacing #1}% | ||
| 2061 | \def\temp{#2}% | ||
| 2062 | \ifx\temp\empty \else | ||
| 2063 | \space ({\unsepspaces \ignorespaces \temp \unskip})% | ||
| 2064 | \fi | ||
| 2065 | } | ||
| 2066 | |||
| 2067 | % @pounds{} is a sterling sign, which Knuth put in the CM italic font. | ||
| 2068 | % | ||
| 2069 | \def\pounds{{\it\$}} | ||
| 2070 | |||
| 2071 | % @euro{} comes from a separate font, depending on the current style. | ||
| 2072 | % We use the free feym* fonts from the eurosym package by Henrik | ||
| 2073 | % Theiling, which support regular, slanted, bold and bold slanted (and | ||
| 2074 | % "outlined" (blackboard board, sort of) versions, which we don't need). | ||
| 2075 | % It is available from http://www.ctan.org/tex-archive/fonts/eurosym. | ||
| 2076 | % | ||
| 2077 | % Although only regular is the truly official Euro symbol, we ignore | ||
| 2078 | % that. The Euro is designed to be slightly taller than the regular | ||
| 2079 | % font height. | ||
| 2080 | % | ||
| 2081 | % feymr - regular | ||
| 2082 | % feymo - slanted | ||
| 2083 | % feybr - bold | ||
| 2084 | % feybo - bold slanted | ||
| 2085 | % | ||
| 2086 | % There is no good (free) typewriter version, to my knowledge. | ||
| 2087 | % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide. | ||
| 2088 | % Hmm. | ||
| 2089 | % | ||
| 2090 | % Also doesn't work in math. Do we need to do math with euro symbols? | ||
| 2091 | % Hope not. | ||
| 2092 | % | ||
| 2093 | % | ||
| 2094 | \def\euro{{\eurofont e}} | ||
| 2095 | \def\eurofont{% | ||
| 2096 | % We set the font at each command, rather than predefining it in | ||
| 2097 | % \textfonts and the other font-switching commands, so that | ||
| 2098 | % installations which never need the symbol don't have to have the | ||
| 2099 | % font installed. | ||
| 2100 | % | ||
| 2101 | % There is only one designed size (nominal 10pt), so we always scale | ||
| 2102 | % that to the current nominal size. | ||
| 2103 | % | ||
| 2104 | % By the way, simply using "at 1em" works for cmr10 and the like, but | ||
| 2105 | % does not work for cmbx10 and other extended/shrunken fonts. | ||
| 2106 | % | ||
| 2107 | \def\eurosize{\csname\curfontsize nominalsize\endcsname}% | ||
| 2108 | % | ||
| 2109 | \ifx\curfontstyle\bfstylename | ||
| 2110 | % bold: | ||
| 2111 | \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize | ||
| 2112 | \else | ||
| 2113 | % regular: | ||
| 2114 | \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize | ||
| 2115 | \fi | ||
| 2116 | \thiseurofont | ||
| 2117 | } | ||
| 2118 | |||
| 2119 | % @registeredsymbol - R in a circle. The font for the R should really | ||
| 2120 | % be smaller yet, but lllsize is the best we can do for now. | ||
| 2121 | % Adapted from the plain.tex definition of \copyright. | ||
| 2122 | % | ||
| 2123 | \def\registeredsymbol{% | ||
| 2124 | $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% | ||
| 2125 | \hfil\crcr\Orb}}% | ||
| 2126 | }$% | ||
| 2127 | } | ||
| 2128 | |||
| 2129 | % Laurent Siebenmann reports \Orb undefined with: | ||
| 2130 | % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38 | ||
| 2131 | % so we'll define it if necessary. | ||
| 2132 | % | ||
| 2133 | \ifx\Orb\undefined | ||
| 2134 | \def\Orb{\mathhexbox20D} | ||
| 2135 | \fi | ||
| 2136 | |||
| 2137 | |||
| 2138 | \message{page headings,} | ||
| 2139 | |||
| 2140 | \newskip\titlepagetopglue \titlepagetopglue = 1.5in | ||
| 2141 | \newskip\titlepagebottomglue \titlepagebottomglue = 2pc | ||
| 2142 | |||
| 2143 | % First the title page. Must do @settitle before @titlepage. | ||
| 2144 | \newif\ifseenauthor | ||
| 2145 | \newif\iffinishedtitlepage | ||
| 2146 | |||
| 2147 | % Do an implicit @contents or @shortcontents after @end titlepage if the | ||
| 2148 | % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. | ||
| 2149 | % | ||
| 2150 | \newif\ifsetcontentsaftertitlepage | ||
| 2151 | \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue | ||
| 2152 | \newif\ifsetshortcontentsaftertitlepage | ||
| 2153 | \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue | ||
| 2154 | |||
| 2155 | \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% | ||
| 2156 | \endgroup\page\hbox{}\page} | ||
| 2157 | |||
| 2158 | \envdef\titlepage{% | ||
| 2159 | % Open one extra group, as we want to close it in the middle of \Etitlepage. | ||
| 2160 | \begingroup | ||
| 2161 | \parindent=0pt \textfonts | ||
| 2162 | % Leave some space at the very top of the page. | ||
| 2163 | \vglue\titlepagetopglue | ||
| 2164 | % No rule at page bottom unless we print one at the top with @title. | ||
| 2165 | \finishedtitlepagetrue | ||
| 2166 | % | ||
| 2167 | % Most title ``pages'' are actually two pages long, with space | ||
| 2168 | % at the top of the second. We don't want the ragged left on the second. | ||
| 2169 | \let\oldpage = \page | ||
| 2170 | \def\page{% | ||
| 2171 | \iffinishedtitlepage\else | ||
| 2172 | \finishtitlepage | ||
| 2173 | \fi | ||
| 2174 | \let\page = \oldpage | ||
| 2175 | \page | ||
| 2176 | \null | ||
| 2177 | }% | ||
| 2178 | } | ||
| 2179 | |||
| 2180 | \def\Etitlepage{% | ||
| 2181 | \iffinishedtitlepage\else | ||
| 2182 | \finishtitlepage | ||
| 2183 | \fi | ||
| 2184 | % It is important to do the page break before ending the group, | ||
| 2185 | % because the headline and footline are only empty inside the group. | ||
| 2186 | % If we use the new definition of \page, we always get a blank page | ||
| 2187 | % after the title page, which we certainly don't want. | ||
| 2188 | \oldpage | ||
| 2189 | \endgroup | ||
| 2190 | % | ||
| 2191 | % Need this before the \...aftertitlepage checks so that if they are | ||
| 2192 | % in effect the toc pages will come out with page numbers. | ||
| 2193 | \HEADINGSon | ||
| 2194 | % | ||
| 2195 | % If they want short, they certainly want long too. | ||
| 2196 | \ifsetshortcontentsaftertitlepage | ||
| 2197 | \shortcontents | ||
| 2198 | \contents | ||
| 2199 | \global\let\shortcontents = \relax | ||
| 2200 | \global\let\contents = \relax | ||
| 2201 | \fi | ||
| 2202 | % | ||
| 2203 | \ifsetcontentsaftertitlepage | ||
| 2204 | \contents | ||
| 2205 | \global\let\contents = \relax | ||
| 2206 | \global\let\shortcontents = \relax | ||
| 2207 | \fi | ||
| 2208 | } | ||
| 2209 | |||
| 2210 | \def\finishtitlepage{% | ||
| 2211 | \vskip4pt \hrule height 2pt width \hsize | ||
| 2212 | \vskip\titlepagebottomglue | ||
| 2213 | \finishedtitlepagetrue | ||
| 2214 | } | ||
| 2215 | |||
| 2216 | %%% Macros to be used within @titlepage: | ||
| 2217 | |||
| 2218 | \let\subtitlerm=\tenrm | ||
| 2219 | \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} | ||
| 2220 | |||
| 2221 | \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines | ||
| 2222 | \let\tt=\authortt} | ||
| 2223 | |||
| 2224 | \parseargdef\title{% | ||
| 2225 | \checkenv\titlepage | ||
| 2226 | \leftline{\titlefonts\rm #1} | ||
| 2227 | % print a rule at the page bottom also. | ||
| 2228 | \finishedtitlepagefalse | ||
| 2229 | \vskip4pt \hrule height 4pt width \hsize \vskip4pt | ||
| 2230 | } | ||
| 2231 | |||
| 2232 | \parseargdef\subtitle{% | ||
| 2233 | \checkenv\titlepage | ||
| 2234 | {\subtitlefont \rightline{#1}}% | ||
| 2235 | } | ||
| 2236 | |||
| 2237 | % @author should come last, but may come many times. | ||
| 2238 | % It can also be used inside @quotation. | ||
| 2239 | % | ||
| 2240 | \parseargdef\author{% | ||
| 2241 | \def\temp{\quotation}% | ||
| 2242 | \ifx\thisenv\temp | ||
| 2243 | \def\quotationauthor{#1}% printed in \Equotation. | ||
| 2244 | \else | ||
| 2245 | \checkenv\titlepage | ||
| 2246 | \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi | ||
| 2247 | {\authorfont \leftline{#1}}% | ||
| 2248 | \fi | ||
| 2249 | } | ||
| 2250 | |||
| 2251 | |||
| 2252 | %%% Set up page headings and footings. | ||
| 2253 | |||
| 2254 | \let\thispage=\folio | ||
| 2255 | |||
| 2256 | \newtoks\evenheadline % headline on even pages | ||
| 2257 | \newtoks\oddheadline % headline on odd pages | ||
| 2258 | \newtoks\evenfootline % footline on even pages | ||
| 2259 | \newtoks\oddfootline % footline on odd pages | ||
| 2260 | |||
| 2261 | % Now make TeX use those variables | ||
| 2262 | \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline | ||
| 2263 | \else \the\evenheadline \fi}} | ||
| 2264 | \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline | ||
| 2265 | \else \the\evenfootline \fi}\HEADINGShook} | ||
| 2266 | \let\HEADINGShook=\relax | ||
| 2267 | |||
| 2268 | % Commands to set those variables. | ||
| 2269 | % For example, this is what @headings on does | ||
| 2270 | % @evenheading @thistitle|@thispage|@thischapter | ||
| 2271 | % @oddheading @thischapter|@thispage|@thistitle | ||
| 2272 | % @evenfooting @thisfile|| | ||
| 2273 | % @oddfooting ||@thisfile | ||
| 2274 | |||
| 2275 | |||
| 2276 | \def\evenheading{\parsearg\evenheadingxxx} | ||
| 2277 | \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} | ||
| 2278 | \def\evenheadingyyy #1\|#2\|#3\|#4\finish{% | ||
| 2279 | \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} | ||
| 2280 | |||
| 2281 | \def\oddheading{\parsearg\oddheadingxxx} | ||
| 2282 | \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} | ||
| 2283 | \def\oddheadingyyy #1\|#2\|#3\|#4\finish{% | ||
| 2284 | \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} | ||
| 2285 | |||
| 2286 | \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% | ||
| 2287 | |||
| 2288 | \def\evenfooting{\parsearg\evenfootingxxx} | ||
| 2289 | \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} | ||
| 2290 | \def\evenfootingyyy #1\|#2\|#3\|#4\finish{% | ||
| 2291 | \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} | ||
| 2292 | |||
| 2293 | \def\oddfooting{\parsearg\oddfootingxxx} | ||
| 2294 | \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} | ||
| 2295 | \def\oddfootingyyy #1\|#2\|#3\|#4\finish{% | ||
| 2296 | \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% | ||
| 2297 | % | ||
| 2298 | % Leave some space for the footline. Hopefully ok to assume | ||
| 2299 | % @evenfooting will not be used by itself. | ||
| 2300 | \global\advance\pageheight by -\baselineskip | ||
| 2301 | \global\advance\vsize by -\baselineskip | ||
| 2302 | } | ||
| 2303 | |||
| 2304 | \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} | ||
| 2305 | |||
| 2306 | |||
| 2307 | % @headings double turns headings on for double-sided printing. | ||
| 2308 | % @headings single turns headings on for single-sided printing. | ||
| 2309 | % @headings off turns them off. | ||
| 2310 | % @headings on same as @headings double, retained for compatibility. | ||
| 2311 | % @headings after turns on double-sided headings after this page. | ||
| 2312 | % @headings doubleafter turns on double-sided headings after this page. | ||
| 2313 | % @headings singleafter turns on single-sided headings after this page. | ||
| 2314 | % By default, they are off at the start of a document, | ||
| 2315 | % and turned `on' after @end titlepage. | ||
| 2316 | |||
| 2317 | \def\headings #1 {\csname HEADINGS#1\endcsname} | ||
| 2318 | |||
| 2319 | \def\HEADINGSoff{% | ||
| 2320 | \global\evenheadline={\hfil} \global\evenfootline={\hfil} | ||
| 2321 | \global\oddheadline={\hfil} \global\oddfootline={\hfil}} | ||
| 2322 | \HEADINGSoff | ||
| 2323 | % When we turn headings on, set the page number to 1. | ||
| 2324 | % For double-sided printing, put current file name in lower left corner, | ||
| 2325 | % chapter name on inside top of right hand pages, document | ||
| 2326 | % title on inside top of left hand pages, and page numbers on outside top | ||
| 2327 | % edge of all pages. | ||
| 2328 | \def\HEADINGSdouble{% | ||
| 2329 | \global\pageno=1 | ||
| 2330 | \global\evenfootline={\hfil} | ||
| 2331 | \global\oddfootline={\hfil} | ||
| 2332 | \global\evenheadline={\line{\folio\hfil\thistitle}} | ||
| 2333 | \global\oddheadline={\line{\thischapter\hfil\folio}} | ||
| 2334 | \global\let\contentsalignmacro = \chapoddpage | ||
| 2335 | } | ||
| 2336 | \let\contentsalignmacro = \chappager | ||
| 2337 | |||
| 2338 | % For single-sided printing, chapter title goes across top left of page, | ||
| 2339 | % page number on top right. | ||
| 2340 | \def\HEADINGSsingle{% | ||
| 2341 | \global\pageno=1 | ||
| 2342 | \global\evenfootline={\hfil} | ||
| 2343 | \global\oddfootline={\hfil} | ||
| 2344 | \global\evenheadline={\line{\thischapter\hfil\folio}} | ||
| 2345 | \global\oddheadline={\line{\thischapter\hfil\folio}} | ||
| 2346 | \global\let\contentsalignmacro = \chappager | ||
| 2347 | } | ||
| 2348 | \def\HEADINGSon{\HEADINGSdouble} | ||
| 2349 | |||
| 2350 | \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} | ||
| 2351 | \let\HEADINGSdoubleafter=\HEADINGSafter | ||
| 2352 | \def\HEADINGSdoublex{% | ||
| 2353 | \global\evenfootline={\hfil} | ||
| 2354 | \global\oddfootline={\hfil} | ||
| 2355 | \global\evenheadline={\line{\folio\hfil\thistitle}} | ||
| 2356 | \global\oddheadline={\line{\thischapter\hfil\folio}} | ||
| 2357 | \global\let\contentsalignmacro = \chapoddpage | ||
| 2358 | } | ||
| 2359 | |||
| 2360 | \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} | ||
| 2361 | \def\HEADINGSsinglex{% | ||
| 2362 | \global\evenfootline={\hfil} | ||
| 2363 | \global\oddfootline={\hfil} | ||
| 2364 | \global\evenheadline={\line{\thischapter\hfil\folio}} | ||
| 2365 | \global\oddheadline={\line{\thischapter\hfil\folio}} | ||
| 2366 | \global\let\contentsalignmacro = \chappager | ||
| 2367 | } | ||
| 2368 | |||
| 2369 | % Subroutines used in generating headings | ||
| 2370 | % This produces Day Month Year style of output. | ||
| 2371 | % Only define if not already defined, in case a txi-??.tex file has set | ||
| 2372 | % up a different format (e.g., txi-cs.tex does this). | ||
| 2373 | \ifx\today\undefined | ||
| 2374 | \def\today{% | ||
| 2375 | \number\day\space | ||
| 2376 | \ifcase\month | ||
| 2377 | \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr | ||
| 2378 | \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug | ||
| 2379 | \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec | ||
| 2380 | \fi | ||
| 2381 | \space\number\year} | ||
| 2382 | \fi | ||
| 2383 | |||
| 2384 | % @settitle line... specifies the title of the document, for headings. | ||
| 2385 | % It generates no output of its own. | ||
| 2386 | \def\thistitle{\putwordNoTitle} | ||
| 2387 | \def\settitle{\parsearg{\gdef\thistitle}} | ||
| 2388 | |||
| 2389 | |||
| 2390 | \message{tables,} | ||
| 2391 | % Tables -- @table, @ftable, @vtable, @item(x). | ||
| 2392 | |||
| 2393 | % default indentation of table text | ||
| 2394 | \newdimen\tableindent \tableindent=.8in | ||
| 2395 | % default indentation of @itemize and @enumerate text | ||
| 2396 | \newdimen\itemindent \itemindent=.3in | ||
| 2397 | % margin between end of table item and start of table text. | ||
| 2398 | \newdimen\itemmargin \itemmargin=.1in | ||
| 2399 | |||
| 2400 | % used internally for \itemindent minus \itemmargin | ||
| 2401 | \newdimen\itemmax | ||
| 2402 | |||
| 2403 | % Note @table, @ftable, and @vtable define @item, @itemx, etc., with | ||
| 2404 | % these defs. | ||
| 2405 | % They also define \itemindex | ||
| 2406 | % to index the item name in whatever manner is desired (perhaps none). | ||
| 2407 | |||
| 2408 | \newif\ifitemxneedsnegativevskip | ||
| 2409 | |||
| 2410 | \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} | ||
| 2411 | |||
| 2412 | \def\internalBitem{\smallbreak \parsearg\itemzzz} | ||
| 2413 | \def\internalBitemx{\itemxpar \parsearg\itemzzz} | ||
| 2414 | |||
| 2415 | \def\itemzzz #1{\begingroup % | ||
| 2416 | \advance\hsize by -\rightskip | ||
| 2417 | \advance\hsize by -\tableindent | ||
| 2418 | \setbox0=\hbox{\itemindicate{#1}}% | ||
| 2419 | \itemindex{#1}% | ||
| 2420 | \nobreak % This prevents a break before @itemx. | ||
| 2421 | % | ||
| 2422 | % If the item text does not fit in the space we have, put it on a line | ||
| 2423 | % by itself, and do not allow a page break either before or after that | ||
| 2424 | % line. We do not start a paragraph here because then if the next | ||
| 2425 | % command is, e.g., @kindex, the whatsit would get put into the | ||
| 2426 | % horizontal list on a line by itself, resulting in extra blank space. | ||
| 2427 | \ifdim \wd0>\itemmax | ||
| 2428 | % | ||
| 2429 | % Make this a paragraph so we get the \parskip glue and wrapping, | ||
| 2430 | % but leave it ragged-right. | ||
| 2431 | \begingroup | ||
| 2432 | \advance\leftskip by-\tableindent | ||
| 2433 | \advance\hsize by\tableindent | ||
| 2434 | \advance\rightskip by0pt plus1fil | ||
| 2435 | \leavevmode\unhbox0\par | ||
| 2436 | \endgroup | ||
| 2437 | % | ||
| 2438 | % We're going to be starting a paragraph, but we don't want the | ||
| 2439 | % \parskip glue -- logically it's part of the @item we just started. | ||
| 2440 | \nobreak \vskip-\parskip | ||
| 2441 | % | ||
| 2442 | % Stop a page break at the \parskip glue coming up. However, if | ||
| 2443 | % what follows is an environment such as @example, there will be no | ||
| 2444 | % \parskip glue; then the negative vskip we just inserted would | ||
| 2445 | % cause the example and the item to crash together. So we use this | ||
| 2446 | % bizarre value of 10001 as a signal to \aboveenvbreak to insert | ||
| 2447 | % \parskip glue after all. Section titles are handled this way also. | ||
| 2448 | % | ||
| 2449 | \penalty 10001 | ||
| 2450 | \endgroup | ||
| 2451 | \itemxneedsnegativevskipfalse | ||
| 2452 | \else | ||
| 2453 | % The item text fits into the space. Start a paragraph, so that the | ||
| 2454 | % following text (if any) will end up on the same line. | ||
| 2455 | \noindent | ||
| 2456 | % Do this with kerns and \unhbox so that if there is a footnote in | ||
| 2457 | % the item text, it can migrate to the main vertical list and | ||
| 2458 | % eventually be printed. | ||
| 2459 | \nobreak\kern-\tableindent | ||
| 2460 | \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 | ||
| 2461 | \unhbox0 | ||
| 2462 | \nobreak\kern\dimen0 | ||
| 2463 | \endgroup | ||
| 2464 | \itemxneedsnegativevskiptrue | ||
| 2465 | \fi | ||
| 2466 | } | ||
| 2467 | |||
| 2468 | \def\item{\errmessage{@item while not in a list environment}} | ||
| 2469 | \def\itemx{\errmessage{@itemx while not in a list environment}} | ||
| 2470 | |||
| 2471 | % @table, @ftable, @vtable. | ||
| 2472 | \envdef\table{% | ||
| 2473 | \let\itemindex\gobble | ||
| 2474 | \tablecheck{table}% | ||
| 2475 | } | ||
| 2476 | \envdef\ftable{% | ||
| 2477 | \def\itemindex ##1{\doind {fn}{\code{##1}}}% | ||
| 2478 | \tablecheck{ftable}% | ||
| 2479 | } | ||
| 2480 | \envdef\vtable{% | ||
| 2481 | \def\itemindex ##1{\doind {vr}{\code{##1}}}% | ||
| 2482 | \tablecheck{vtable}% | ||
| 2483 | } | ||
| 2484 | \def\tablecheck#1{% | ||
| 2485 | \ifnum \the\catcode`\^^M=\active | ||
| 2486 | \endgroup | ||
| 2487 | \errmessage{This command won't work in this context; perhaps the problem is | ||
| 2488 | that we are \inenvironment\thisenv}% | ||
| 2489 | \def\next{\doignore{#1}}% | ||
| 2490 | \else | ||
| 2491 | \let\next\tablex | ||
| 2492 | \fi | ||
| 2493 | \next | ||
| 2494 | } | ||
| 2495 | \def\tablex#1{% | ||
| 2496 | \def\itemindicate{#1}% | ||
| 2497 | \parsearg\tabley | ||
| 2498 | } | ||
| 2499 | \def\tabley#1{% | ||
| 2500 | {% | ||
| 2501 | \makevalueexpandable | ||
| 2502 | \edef\temp{\noexpand\tablez #1\space\space\space}% | ||
| 2503 | \expandafter | ||
| 2504 | }\temp \endtablez | ||
| 2505 | } | ||
| 2506 | \def\tablez #1 #2 #3 #4\endtablez{% | ||
| 2507 | \aboveenvbreak | ||
| 2508 | \ifnum 0#1>0 \advance \leftskip by #1\mil \fi | ||
| 2509 | \ifnum 0#2>0 \tableindent=#2\mil \fi | ||
| 2510 | \ifnum 0#3>0 \advance \rightskip by #3\mil \fi | ||
| 2511 | \itemmax=\tableindent | ||
| 2512 | \advance \itemmax by -\itemmargin | ||
| 2513 | \advance \leftskip by \tableindent | ||
| 2514 | \exdentamount=\tableindent | ||
| 2515 | \parindent = 0pt | ||
| 2516 | \parskip = \smallskipamount | ||
| 2517 | \ifdim \parskip=0pt \parskip=2pt \fi | ||
| 2518 | \let\item = \internalBitem | ||
| 2519 | \let\itemx = \internalBitemx | ||
| 2520 | } | ||
| 2521 | \def\Etable{\endgraf\afterenvbreak} | ||
| 2522 | \let\Eftable\Etable | ||
| 2523 | \let\Evtable\Etable | ||
| 2524 | \let\Eitemize\Etable | ||
| 2525 | \let\Eenumerate\Etable | ||
| 2526 | |||
| 2527 | % This is the counter used by @enumerate, which is really @itemize | ||
| 2528 | |||
| 2529 | \newcount \itemno | ||
| 2530 | |||
| 2531 | \envdef\itemize{\parsearg\doitemize} | ||
| 2532 | |||
| 2533 | \def\doitemize#1{% | ||
| 2534 | \aboveenvbreak | ||
| 2535 | \itemmax=\itemindent | ||
| 2536 | \advance\itemmax by -\itemmargin | ||
| 2537 | \advance\leftskip by \itemindent | ||
| 2538 | \exdentamount=\itemindent | ||
| 2539 | \parindent=0pt | ||
| 2540 | \parskip=\smallskipamount | ||
| 2541 | \ifdim\parskip=0pt \parskip=2pt \fi | ||
| 2542 | \def\itemcontents{#1}% | ||
| 2543 | % @itemize with no arg is equivalent to @itemize @bullet. | ||
| 2544 | \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi | ||
| 2545 | \let\item=\itemizeitem | ||
| 2546 | } | ||
| 2547 | |||
| 2548 | % Definition of @item while inside @itemize and @enumerate. | ||
| 2549 | % | ||
| 2550 | \def\itemizeitem{% | ||
| 2551 | \advance\itemno by 1 % for enumerations | ||
| 2552 | {\let\par=\endgraf \smallbreak}% reasonable place to break | ||
| 2553 | {% | ||
| 2554 | % If the document has an @itemize directly after a section title, a | ||
| 2555 | % \nobreak will be last on the list, and \sectionheading will have | ||
| 2556 | % done a \vskip-\parskip. In that case, we don't want to zero | ||
| 2557 | % parskip, or the item text will crash with the heading. On the | ||
| 2558 | % other hand, when there is normal text preceding the item (as there | ||
| 2559 | % usually is), we do want to zero parskip, or there would be too much | ||
| 2560 | % space. In that case, we won't have a \nobreak before. At least | ||
| 2561 | % that's the theory. | ||
| 2562 | \ifnum\lastpenalty<10000 \parskip=0in \fi | ||
| 2563 | \noindent | ||
| 2564 | \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% | ||
| 2565 | \vadjust{\penalty 1200}}% not good to break after first line of item. | ||
| 2566 | \flushcr | ||
| 2567 | } | ||
| 2568 | |||
| 2569 | % \splitoff TOKENS\endmark defines \first to be the first token in | ||
| 2570 | % TOKENS, and \rest to be the remainder. | ||
| 2571 | % | ||
| 2572 | \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% | ||
| 2573 | |||
| 2574 | % Allow an optional argument of an uppercase letter, lowercase letter, | ||
| 2575 | % or number, to specify the first label in the enumerated list. No | ||
| 2576 | % argument is the same as `1'. | ||
| 2577 | % | ||
| 2578 | \envparseargdef\enumerate{\enumeratey #1 \endenumeratey} | ||
| 2579 | \def\enumeratey #1 #2\endenumeratey{% | ||
| 2580 | % If we were given no argument, pretend we were given `1'. | ||
| 2581 | \def\thearg{#1}% | ||
| 2582 | \ifx\thearg\empty \def\thearg{1}\fi | ||
| 2583 | % | ||
| 2584 | % Detect if the argument is a single token. If so, it might be a | ||
| 2585 | % letter. Otherwise, the only valid thing it can be is a number. | ||
| 2586 | % (We will always have one token, because of the test we just made. | ||
| 2587 | % This is a good thing, since \splitoff doesn't work given nothing at | ||
| 2588 | % all -- the first parameter is undelimited.) | ||
| 2589 | \expandafter\splitoff\thearg\endmark | ||
| 2590 | \ifx\rest\empty | ||
| 2591 | % Only one token in the argument. It could still be anything. | ||
| 2592 | % A ``lowercase letter'' is one whose \lccode is nonzero. | ||
| 2593 | % An ``uppercase letter'' is one whose \lccode is both nonzero, and | ||
| 2594 | % not equal to itself. | ||
| 2595 | % Otherwise, we assume it's a number. | ||
| 2596 | % | ||
| 2597 | % We need the \relax at the end of the \ifnum lines to stop TeX from | ||
| 2598 | % continuing to look for a <number>. | ||
| 2599 | % | ||
| 2600 | \ifnum\lccode\expandafter`\thearg=0\relax | ||
| 2601 | \numericenumerate % a number (we hope) | ||
| 2602 | \else | ||
| 2603 | % It's a letter. | ||
| 2604 | \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax | ||
| 2605 | \lowercaseenumerate % lowercase letter | ||
| 2606 | \else | ||
| 2607 | \uppercaseenumerate % uppercase letter | ||
| 2608 | \fi | ||
| 2609 | \fi | ||
| 2610 | \else | ||
| 2611 | % Multiple tokens in the argument. We hope it's a number. | ||
| 2612 | \numericenumerate | ||
| 2613 | \fi | ||
| 2614 | } | ||
| 2615 | |||
| 2616 | % An @enumerate whose labels are integers. The starting integer is | ||
| 2617 | % given in \thearg. | ||
| 2618 | % | ||
| 2619 | \def\numericenumerate{% | ||
| 2620 | \itemno = \thearg | ||
| 2621 | \startenumeration{\the\itemno}% | ||
| 2622 | } | ||
| 2623 | |||
| 2624 | % The starting (lowercase) letter is in \thearg. | ||
| 2625 | \def\lowercaseenumerate{% | ||
| 2626 | \itemno = \expandafter`\thearg | ||
| 2627 | \startenumeration{% | ||
| 2628 | % Be sure we're not beyond the end of the alphabet. | ||
| 2629 | \ifnum\itemno=0 | ||
| 2630 | \errmessage{No more lowercase letters in @enumerate; get a bigger | ||
| 2631 | alphabet}% | ||
| 2632 | \fi | ||
| 2633 | \char\lccode\itemno | ||
| 2634 | }% | ||
| 2635 | } | ||
| 2636 | |||
| 2637 | % The starting (uppercase) letter is in \thearg. | ||
| 2638 | \def\uppercaseenumerate{% | ||
| 2639 | \itemno = \expandafter`\thearg | ||
| 2640 | \startenumeration{% | ||
| 2641 | % Be sure we're not beyond the end of the alphabet. | ||
| 2642 | \ifnum\itemno=0 | ||
| 2643 | \errmessage{No more uppercase letters in @enumerate; get a bigger | ||
| 2644 | alphabet} | ||
| 2645 | \fi | ||
| 2646 | \char\uccode\itemno | ||
| 2647 | }% | ||
| 2648 | } | ||
| 2649 | |||
| 2650 | % Call \doitemize, adding a period to the first argument and supplying the | ||
| 2651 | % common last two arguments. Also subtract one from the initial value in | ||
| 2652 | % \itemno, since @item increments \itemno. | ||
| 2653 | % | ||
| 2654 | \def\startenumeration#1{% | ||
| 2655 | \advance\itemno by -1 | ||
| 2656 | \doitemize{#1.}\flushcr | ||
| 2657 | } | ||
| 2658 | |||
| 2659 | % @alphaenumerate and @capsenumerate are abbreviations for giving an arg | ||
| 2660 | % to @enumerate. | ||
| 2661 | % | ||
| 2662 | \def\alphaenumerate{\enumerate{a}} | ||
| 2663 | \def\capsenumerate{\enumerate{A}} | ||
| 2664 | \def\Ealphaenumerate{\Eenumerate} | ||
| 2665 | \def\Ecapsenumerate{\Eenumerate} | ||
| 2666 | |||
| 2667 | |||
| 2668 | % @multitable macros | ||
| 2669 | % Amy Hendrickson, 8/18/94, 3/6/96 | ||
| 2670 | % | ||
| 2671 | % @multitable ... @end multitable will make as many columns as desired. | ||
| 2672 | % Contents of each column will wrap at width given in preamble. Width | ||
| 2673 | % can be specified either with sample text given in a template line, | ||
| 2674 | % or in percent of \hsize, the current width of text on page. | ||
| 2675 | |||
| 2676 | % Table can continue over pages but will only break between lines. | ||
| 2677 | |||
| 2678 | % To make preamble: | ||
| 2679 | % | ||
| 2680 | % Either define widths of columns in terms of percent of \hsize: | ||
| 2681 | % @multitable @columnfractions .25 .3 .45 | ||
| 2682 | % @item ... | ||
| 2683 | % | ||
| 2684 | % Numbers following @columnfractions are the percent of the total | ||
| 2685 | % current hsize to be used for each column. You may use as many | ||
| 2686 | % columns as desired. | ||
| 2687 | |||
| 2688 | |||
| 2689 | % Or use a template: | ||
| 2690 | % @multitable {Column 1 template} {Column 2 template} {Column 3 template} | ||
| 2691 | % @item ... | ||
| 2692 | % using the widest term desired in each column. | ||
| 2693 | |||
| 2694 | % Each new table line starts with @item, each subsequent new column | ||
| 2695 | % starts with @tab. Empty columns may be produced by supplying @tab's | ||
| 2696 | % with nothing between them for as many times as empty columns are needed, | ||
| 2697 | % ie, @tab@tab@tab will produce two empty columns. | ||
| 2698 | |||
| 2699 | % @item, @tab do not need to be on their own lines, but it will not hurt | ||
| 2700 | % if they are. | ||
| 2701 | |||
| 2702 | % Sample multitable: | ||
| 2703 | |||
| 2704 | % @multitable {Column 1 template} {Column 2 template} {Column 3 template} | ||
| 2705 | % @item first col stuff @tab second col stuff @tab third col | ||
| 2706 | % @item | ||
| 2707 | % first col stuff | ||
| 2708 | % @tab | ||
| 2709 | % second col stuff | ||
| 2710 | % @tab | ||
| 2711 | % third col | ||
| 2712 | % @item first col stuff @tab second col stuff | ||
| 2713 | % @tab Many paragraphs of text may be used in any column. | ||
| 2714 | % | ||
| 2715 | % They will wrap at the width determined by the template. | ||
| 2716 | % @item@tab@tab This will be in third column. | ||
| 2717 | % @end multitable | ||
| 2718 | |||
| 2719 | % Default dimensions may be reset by user. | ||
| 2720 | % @multitableparskip is vertical space between paragraphs in table. | ||
| 2721 | % @multitableparindent is paragraph indent in table. | ||
| 2722 | % @multitablecolmargin is horizontal space to be left between columns. | ||
| 2723 | % @multitablelinespace is space to leave between table items, baseline | ||
| 2724 | % to baseline. | ||
| 2725 | % 0pt means it depends on current normal line spacing. | ||
| 2726 | % | ||
| 2727 | \newskip\multitableparskip | ||
| 2728 | \newskip\multitableparindent | ||
| 2729 | \newdimen\multitablecolspace | ||
| 2730 | \newskip\multitablelinespace | ||
| 2731 | \multitableparskip=0pt | ||
| 2732 | \multitableparindent=6pt | ||
| 2733 | \multitablecolspace=12pt | ||
| 2734 | \multitablelinespace=0pt | ||
| 2735 | |||
| 2736 | % Macros used to set up halign preamble: | ||
| 2737 | % | ||
| 2738 | \let\endsetuptable\relax | ||
| 2739 | \def\xendsetuptable{\endsetuptable} | ||
| 2740 | \let\columnfractions\relax | ||
| 2741 | \def\xcolumnfractions{\columnfractions} | ||
| 2742 | \newif\ifsetpercent | ||
| 2743 | |||
| 2744 | % #1 is the @columnfraction, usually a decimal number like .5, but might | ||
| 2745 | % be just 1. We just use it, whatever it is. | ||
| 2746 | % | ||
| 2747 | \def\pickupwholefraction#1 {% | ||
| 2748 | \global\advance\colcount by 1 | ||
| 2749 | \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% | ||
| 2750 | \setuptable | ||
| 2751 | } | ||
| 2752 | |||
| 2753 | \newcount\colcount | ||
| 2754 | \def\setuptable#1{% | ||
| 2755 | \def\firstarg{#1}% | ||
| 2756 | \ifx\firstarg\xendsetuptable | ||
| 2757 | \let\go = \relax | ||
| 2758 | \else | ||
| 2759 | \ifx\firstarg\xcolumnfractions | ||
| 2760 | \global\setpercenttrue | ||
| 2761 | \else | ||
| 2762 | \ifsetpercent | ||
| 2763 | \let\go\pickupwholefraction | ||
| 2764 | \else | ||
| 2765 | \global\advance\colcount by 1 | ||
| 2766 | \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a | ||
| 2767 | % separator; typically that is always in the input, anyway. | ||
| 2768 | \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% | ||
| 2769 | \fi | ||
| 2770 | \fi | ||
| 2771 | \ifx\go\pickupwholefraction | ||
| 2772 | % Put the argument back for the \pickupwholefraction call, so | ||
| 2773 | % we'll always have a period there to be parsed. | ||
| 2774 | \def\go{\pickupwholefraction#1}% | ||
| 2775 | \else | ||
| 2776 | \let\go = \setuptable | ||
| 2777 | \fi% | ||
| 2778 | \fi | ||
| 2779 | \go | ||
| 2780 | } | ||
| 2781 | |||
| 2782 | % multitable-only commands. | ||
| 2783 | % | ||
| 2784 | % @headitem starts a heading row, which we typeset in bold. | ||
| 2785 | % Assignments have to be global since we are inside the implicit group | ||
| 2786 | % of an alignment entry. Note that \everycr resets \everytab. | ||
| 2787 | \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}% | ||
| 2788 | % | ||
| 2789 | % A \tab used to include \hskip1sp. But then the space in a template | ||
| 2790 | % line is not enough. That is bad. So let's go back to just `&' until | ||
| 2791 | % we encounter the problem it was intended to solve again. | ||
| 2792 | % --karl, nathan@acm.org, 20apr99. | ||
| 2793 | \def\tab{\checkenv\multitable &\the\everytab}% | ||
| 2794 | |||
| 2795 | % @multitable ... @end multitable definitions: | ||
| 2796 | % | ||
| 2797 | \newtoks\everytab % insert after every tab. | ||
| 2798 | % | ||
| 2799 | \envdef\multitable{% | ||
| 2800 | \vskip\parskip | ||
| 2801 | \startsavinginserts | ||
| 2802 | % | ||
| 2803 | % @item within a multitable starts a normal row. | ||
| 2804 | % We use \def instead of \let so that if one of the multitable entries | ||
| 2805 | % contains an @itemize, we don't choke on the \item (seen as \crcr aka | ||
| 2806 | % \endtemplate) expanding \doitemize. | ||
| 2807 | \def\item{\crcr}% | ||
| 2808 | % | ||
| 2809 | \tolerance=9500 | ||
| 2810 | \hbadness=9500 | ||
| 2811 | \setmultitablespacing | ||
| 2812 | \parskip=\multitableparskip | ||
| 2813 | \parindent=\multitableparindent | ||
| 2814 | \overfullrule=0pt | ||
| 2815 | \global\colcount=0 | ||
| 2816 | % | ||
| 2817 | \everycr = {% | ||
| 2818 | \noalign{% | ||
| 2819 | \global\everytab={}% | ||
| 2820 | \global\colcount=0 % Reset the column counter. | ||
| 2821 | % Check for saved footnotes, etc. | ||
| 2822 | \checkinserts | ||
| 2823 | % Keeps underfull box messages off when table breaks over pages. | ||
| 2824 | %\filbreak | ||
| 2825 | % Maybe so, but it also creates really weird page breaks when the | ||
| 2826 | % table breaks over pages. Wouldn't \vfil be better? Wait until the | ||
| 2827 | % problem manifests itself, so it can be fixed for real --karl. | ||
| 2828 | }% | ||
| 2829 | }% | ||
| 2830 | % | ||
| 2831 | \parsearg\domultitable | ||
| 2832 | } | ||
| 2833 | \def\domultitable#1{% | ||
| 2834 | % To parse everything between @multitable and @item: | ||
| 2835 | \setuptable#1 \endsetuptable | ||
| 2836 | % | ||
| 2837 | % This preamble sets up a generic column definition, which will | ||
| 2838 | % be used as many times as user calls for columns. | ||
| 2839 | % \vtop will set a single line and will also let text wrap and | ||
| 2840 | % continue for many paragraphs if desired. | ||
| 2841 | \halign\bgroup &% | ||
| 2842 | \global\advance\colcount by 1 | ||
| 2843 | \multistrut | ||
| 2844 | \vtop{% | ||
| 2845 | % Use the current \colcount to find the correct column width: | ||
| 2846 | \hsize=\expandafter\csname col\the\colcount\endcsname | ||
| 2847 | % | ||
| 2848 | % In order to keep entries from bumping into each other | ||
| 2849 | % we will add a \leftskip of \multitablecolspace to all columns after | ||
| 2850 | % the first one. | ||
| 2851 | % | ||
| 2852 | % If a template has been used, we will add \multitablecolspace | ||
| 2853 | % to the width of each template entry. | ||
| 2854 | % | ||
| 2855 | % If the user has set preamble in terms of percent of \hsize we will | ||
| 2856 | % use that dimension as the width of the column, and the \leftskip | ||
| 2857 | % will keep entries from bumping into each other. Table will start at | ||
| 2858 | % left margin and final column will justify at right margin. | ||
| 2859 | % | ||
| 2860 | % Make sure we don't inherit \rightskip from the outer environment. | ||
| 2861 | \rightskip=0pt | ||
| 2862 | \ifnum\colcount=1 | ||
| 2863 | % The first column will be indented with the surrounding text. | ||
| 2864 | \advance\hsize by\leftskip | ||
| 2865 | \else | ||
| 2866 | \ifsetpercent \else | ||
| 2867 | % If user has not set preamble in terms of percent of \hsize | ||
| 2868 | % we will advance \hsize by \multitablecolspace. | ||
| 2869 | \advance\hsize by \multitablecolspace | ||
| 2870 | \fi | ||
| 2871 | % In either case we will make \leftskip=\multitablecolspace: | ||
| 2872 | \leftskip=\multitablecolspace | ||
| 2873 | \fi | ||
| 2874 | % Ignoring space at the beginning and end avoids an occasional spurious | ||
| 2875 | % blank line, when TeX decides to break the line at the space before the | ||
| 2876 | % box from the multistrut, so the strut ends up on a line by itself. | ||
| 2877 | % For example: | ||
| 2878 | % @multitable @columnfractions .11 .89 | ||
| 2879 | % @item @code{#} | ||
| 2880 | % @tab Legal holiday which is valid in major parts of the whole country. | ||
| 2881 | % Is automatically provided with highlighting sequences respectively | ||
| 2882 | % marking characters. | ||
| 2883 | \noindent\ignorespaces##\unskip\multistrut | ||
| 2884 | }\cr | ||
| 2885 | } | ||
| 2886 | \def\Emultitable{% | ||
| 2887 | \crcr | ||
| 2888 | \egroup % end the \halign | ||
| 2889 | \global\setpercentfalse | ||
| 2890 | } | ||
| 2891 | |||
| 2892 | \def\setmultitablespacing{% | ||
| 2893 | \def\multistrut{\strut}% just use the standard line spacing | ||
| 2894 | % | ||
| 2895 | % Compute \multitablelinespace (if not defined by user) for use in | ||
| 2896 | % \multitableparskip calculation. We used define \multistrut based on | ||
| 2897 | % this, but (ironically) that caused the spacing to be off. | ||
| 2898 | % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100. | ||
| 2899 | \ifdim\multitablelinespace=0pt | ||
| 2900 | \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip | ||
| 2901 | \global\advance\multitablelinespace by-\ht0 | ||
| 2902 | \fi | ||
| 2903 | %% Test to see if parskip is larger than space between lines of | ||
| 2904 | %% table. If not, do nothing. | ||
| 2905 | %% If so, set to same dimension as multitablelinespace. | ||
| 2906 | \ifdim\multitableparskip>\multitablelinespace | ||
| 2907 | \global\multitableparskip=\multitablelinespace | ||
| 2908 | \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller | ||
| 2909 | %% than skip between lines in the table. | ||
| 2910 | \fi% | ||
| 2911 | \ifdim\multitableparskip=0pt | ||
| 2912 | \global\multitableparskip=\multitablelinespace | ||
| 2913 | \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller | ||
| 2914 | %% than skip between lines in the table. | ||
| 2915 | \fi} | ||
| 2916 | |||
| 2917 | |||
| 2918 | \message{conditionals,} | ||
| 2919 | |||
| 2920 | % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, | ||
| 2921 | % @ifnotxml always succeed. They currently do nothing; we don't | ||
| 2922 | % attempt to check whether the conditionals are properly nested. But we | ||
| 2923 | % have to remember that they are conditionals, so that @end doesn't | ||
| 2924 | % attempt to close an environment group. | ||
| 2925 | % | ||
| 2926 | \def\makecond#1{% | ||
| 2927 | \expandafter\let\csname #1\endcsname = \relax | ||
| 2928 | \expandafter\let\csname iscond.#1\endcsname = 1 | ||
| 2929 | } | ||
| 2930 | \makecond{iftex} | ||
| 2931 | \makecond{ifnotdocbook} | ||
| 2932 | \makecond{ifnothtml} | ||
| 2933 | \makecond{ifnotinfo} | ||
| 2934 | \makecond{ifnotplaintext} | ||
| 2935 | \makecond{ifnotxml} | ||
| 2936 | |||
| 2937 | % Ignore @ignore, @ifhtml, @ifinfo, and the like. | ||
| 2938 | % | ||
| 2939 | \def\direntry{\doignore{direntry}} | ||
| 2940 | \def\documentdescription{\doignore{documentdescription}} | ||
| 2941 | \def\docbook{\doignore{docbook}} | ||
| 2942 | \def\html{\doignore{html}} | ||
| 2943 | \def\ifdocbook{\doignore{ifdocbook}} | ||
| 2944 | \def\ifhtml{\doignore{ifhtml}} | ||
| 2945 | \def\ifinfo{\doignore{ifinfo}} | ||
| 2946 | \def\ifnottex{\doignore{ifnottex}} | ||
| 2947 | \def\ifplaintext{\doignore{ifplaintext}} | ||
| 2948 | \def\ifxml{\doignore{ifxml}} | ||
| 2949 | \def\ignore{\doignore{ignore}} | ||
| 2950 | \def\menu{\doignore{menu}} | ||
| 2951 | \def\xml{\doignore{xml}} | ||
| 2952 | |||
| 2953 | % Ignore text until a line `@end #1', keeping track of nested conditionals. | ||
| 2954 | % | ||
| 2955 | % A count to remember the depth of nesting. | ||
| 2956 | \newcount\doignorecount | ||
| 2957 | |||
| 2958 | \def\doignore#1{\begingroup | ||
| 2959 | % Scan in ``verbatim'' mode: | ||
| 2960 | \obeylines | ||
| 2961 | \catcode`\@ = \other | ||
| 2962 | \catcode`\{ = \other | ||
| 2963 | \catcode`\} = \other | ||
| 2964 | % | ||
| 2965 | % Make sure that spaces turn into tokens that match what \doignoretext wants. | ||
| 2966 | \spaceisspace | ||
| 2967 | % | ||
| 2968 | % Count number of #1's that we've seen. | ||
| 2969 | \doignorecount = 0 | ||
| 2970 | % | ||
| 2971 | % Swallow text until we reach the matching `@end #1'. | ||
| 2972 | \dodoignore{#1}% | ||
| 2973 | } | ||
| 2974 | |||
| 2975 | { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. | ||
| 2976 | \obeylines % | ||
| 2977 | % | ||
| 2978 | \gdef\dodoignore#1{% | ||
| 2979 | % #1 contains the command name as a string, e.g., `ifinfo'. | ||
| 2980 | % | ||
| 2981 | % Define a command to find the next `@end #1'. | ||
| 2982 | \long\def\doignoretext##1^^M@end #1{% | ||
| 2983 | \doignoretextyyy##1^^M@#1\_STOP_}% | ||
| 2984 | % | ||
| 2985 | % And this command to find another #1 command, at the beginning of a | ||
| 2986 | % line. (Otherwise, we would consider a line `@c @ifset', for | ||
| 2987 | % example, to count as an @ifset for nesting.) | ||
| 2988 | \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% | ||
| 2989 | % | ||
| 2990 | % And now expand that command. | ||
| 2991 | \doignoretext ^^M% | ||
| 2992 | }% | ||
| 2993 | } | ||
| 2994 | |||
| 2995 | \def\doignoreyyy#1{% | ||
| 2996 | \def\temp{#1}% | ||
| 2997 | \ifx\temp\empty % Nothing found. | ||
| 2998 | \let\next\doignoretextzzz | ||
| 2999 | \else % Found a nested condition, ... | ||
| 3000 | \advance\doignorecount by 1 | ||
| 3001 | \let\next\doignoretextyyy % ..., look for another. | ||
| 3002 | % If we're here, #1 ends with ^^M\ifinfo (for example). | ||
| 3003 | \fi | ||
| 3004 | \next #1% the token \_STOP_ is present just after this macro. | ||
| 3005 | } | ||
| 3006 | |||
| 3007 | % We have to swallow the remaining "\_STOP_". | ||
| 3008 | % | ||
| 3009 | \def\doignoretextzzz#1{% | ||
| 3010 | \ifnum\doignorecount = 0 % We have just found the outermost @end. | ||
| 3011 | \let\next\enddoignore | ||
| 3012 | \else % Still inside a nested condition. | ||
| 3013 | \advance\doignorecount by -1 | ||
| 3014 | \let\next\doignoretext % Look for the next @end. | ||
| 3015 | \fi | ||
| 3016 | \next | ||
| 3017 | } | ||
| 3018 | |||
| 3019 | % Finish off ignored text. | ||
| 3020 | { \obeylines% | ||
| 3021 | % Ignore anything after the last `@end #1'; this matters in verbatim | ||
| 3022 | % environments, where otherwise the newline after an ignored conditional | ||
| 3023 | % would result in a blank line in the output. | ||
| 3024 | \gdef\enddoignore#1^^M{\endgroup\ignorespaces}% | ||
| 3025 | } | ||
| 3026 | |||
| 3027 | |||
| 3028 | % @set VAR sets the variable VAR to an empty value. | ||
| 3029 | % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. | ||
| 3030 | % | ||
| 3031 | % Since we want to separate VAR from REST-OF-LINE (which might be | ||
| 3032 | % empty), we can't just use \parsearg; we have to insert a space of our | ||
| 3033 | % own to delimit the rest of the line, and then take it out again if we | ||
| 3034 | % didn't need it. | ||
| 3035 | % We rely on the fact that \parsearg sets \catcode`\ =10. | ||
| 3036 | % | ||
| 3037 | \parseargdef\set{\setyyy#1 \endsetyyy} | ||
| 3038 | \def\setyyy#1 #2\endsetyyy{% | ||
| 3039 | {% | ||
| 3040 | \makevalueexpandable | ||
| 3041 | \def\temp{#2}% | ||
| 3042 | \edef\next{\gdef\makecsname{SET#1}}% | ||
| 3043 | \ifx\temp\empty | ||
| 3044 | \next{}% | ||
| 3045 | \else | ||
| 3046 | \setzzz#2\endsetzzz | ||
| 3047 | \fi | ||
| 3048 | }% | ||
| 3049 | } | ||
| 3050 | % Remove the trailing space \setxxx inserted. | ||
| 3051 | \def\setzzz#1 \endsetzzz{\next{#1}} | ||
| 3052 | |||
| 3053 | % @clear VAR clears (i.e., unsets) the variable VAR. | ||
| 3054 | % | ||
| 3055 | \parseargdef\clear{% | ||
| 3056 | {% | ||
| 3057 | \makevalueexpandable | ||
| 3058 | \global\expandafter\let\csname SET#1\endcsname=\relax | ||
| 3059 | }% | ||
| 3060 | } | ||
| 3061 | |||
| 3062 | % @value{foo} gets the text saved in variable foo. | ||
| 3063 | \def\value{\begingroup\makevalueexpandable\valuexxx} | ||
| 3064 | \def\valuexxx#1{\expandablevalue{#1}\endgroup} | ||
| 3065 | { | ||
| 3066 | \catcode`\- = \active \catcode`\_ = \active | ||
| 3067 | % | ||
| 3068 | \gdef\makevalueexpandable{% | ||
| 3069 | \let\value = \expandablevalue | ||
| 3070 | % We don't want these characters active, ... | ||
| 3071 | \catcode`\-=\other \catcode`\_=\other | ||
| 3072 | % ..., but we might end up with active ones in the argument if | ||
| 3073 | % we're called from @code, as @code{@value{foo-bar_}}, though. | ||
| 3074 | % So \let them to their normal equivalents. | ||
| 3075 | \let-\realdash \let_\normalunderscore | ||
| 3076 | } | ||
| 3077 | } | ||
| 3078 | |||
| 3079 | % We have this subroutine so that we can handle at least some @value's | ||
| 3080 | % properly in indexes (we call \makevalueexpandable in \indexdummies). | ||
| 3081 | % The command has to be fully expandable (if the variable is set), since | ||
| 3082 | % the result winds up in the index file. This means that if the | ||
| 3083 | % variable's value contains other Texinfo commands, it's almost certain | ||
| 3084 | % it will fail (although perhaps we could fix that with sufficient work | ||
| 3085 | % to do a one-level expansion on the result, instead of complete). | ||
| 3086 | % | ||
| 3087 | \def\expandablevalue#1{% | ||
| 3088 | \expandafter\ifx\csname SET#1\endcsname\relax | ||
| 3089 | {[No value for ``#1'']}% | ||
| 3090 | \message{Variable `#1', used in @value, is not set.}% | ||
| 3091 | \else | ||
| 3092 | \csname SET#1\endcsname | ||
| 3093 | \fi | ||
| 3094 | } | ||
| 3095 | |||
| 3096 | % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined | ||
| 3097 | % with @set. | ||
| 3098 | % | ||
| 3099 | % To get special treatment of `@end ifset,' call \makeond and the redefine. | ||
| 3100 | % | ||
| 3101 | \makecond{ifset} | ||
| 3102 | \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} | ||
| 3103 | \def\doifset#1#2{% | ||
| 3104 | {% | ||
| 3105 | \makevalueexpandable | ||
| 3106 | \let\next=\empty | ||
| 3107 | \expandafter\ifx\csname SET#2\endcsname\relax | ||
| 3108 | #1% If not set, redefine \next. | ||
| 3109 | \fi | ||
| 3110 | \expandafter | ||
| 3111 | }\next | ||
| 3112 | } | ||
| 3113 | \def\ifsetfail{\doignore{ifset}} | ||
| 3114 | |||
| 3115 | % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been | ||
| 3116 | % defined with @set, or has been undefined with @clear. | ||
| 3117 | % | ||
| 3118 | % The `\else' inside the `\doifset' parameter is a trick to reuse the | ||
| 3119 | % above code: if the variable is not set, do nothing, if it is set, | ||
| 3120 | % then redefine \next to \ifclearfail. | ||
| 3121 | % | ||
| 3122 | \makecond{ifclear} | ||
| 3123 | \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} | ||
| 3124 | \def\ifclearfail{\doignore{ifclear}} | ||
| 3125 | |||
| 3126 | % @dircategory CATEGORY -- specify a category of the dir file | ||
| 3127 | % which this file should belong to. Ignore this in TeX. | ||
| 3128 | \let\dircategory=\comment | ||
| 3129 | |||
| 3130 | % @defininfoenclose. | ||
| 3131 | \let\definfoenclose=\comment | ||
| 3132 | |||
| 3133 | |||
| 3134 | \message{indexing,} | ||
| 3135 | % Index generation facilities | ||
| 3136 | |||
| 3137 | % Define \newwrite to be identical to plain tex's \newwrite | ||
| 3138 | % except not \outer, so it can be used within macros and \if's. | ||
| 3139 | \edef\newwrite{\makecsname{ptexnewwrite}} | ||
| 3140 | |||
| 3141 | % \newindex {foo} defines an index named foo. | ||
| 3142 | % It automatically defines \fooindex such that | ||
| 3143 | % \fooindex ...rest of line... puts an entry in the index foo. | ||
| 3144 | % It also defines \fooindfile to be the number of the output channel for | ||
| 3145 | % the file that accumulates this index. The file's extension is foo. | ||
| 3146 | % The name of an index should be no more than 2 characters long | ||
| 3147 | % for the sake of vms. | ||
| 3148 | % | ||
| 3149 | \def\newindex#1{% | ||
| 3150 | \iflinks | ||
| 3151 | \expandafter\newwrite \csname#1indfile\endcsname | ||
| 3152 | \openout \csname#1indfile\endcsname \jobname.#1 % Open the file | ||
| 3153 | \fi | ||
| 3154 | \expandafter\xdef\csname#1index\endcsname{% % Define @#1index | ||
| 3155 | \noexpand\doindex{#1}} | ||
| 3156 | } | ||
| 3157 | |||
| 3158 | % @defindex foo == \newindex{foo} | ||
| 3159 | % | ||
| 3160 | \def\defindex{\parsearg\newindex} | ||
| 3161 | |||
| 3162 | % Define @defcodeindex, like @defindex except put all entries in @code. | ||
| 3163 | % | ||
| 3164 | \def\defcodeindex{\parsearg\newcodeindex} | ||
| 3165 | % | ||
| 3166 | \def\newcodeindex#1{% | ||
| 3167 | \iflinks | ||
| 3168 | \expandafter\newwrite \csname#1indfile\endcsname | ||
| 3169 | \openout \csname#1indfile\endcsname \jobname.#1 | ||
| 3170 | \fi | ||
| 3171 | \expandafter\xdef\csname#1index\endcsname{% | ||
| 3172 | \noexpand\docodeindex{#1}}% | ||
| 3173 | } | ||
| 3174 | |||
| 3175 | |||
| 3176 | % @synindex foo bar makes index foo feed into index bar. | ||
| 3177 | % Do this instead of @defindex foo if you don't want it as a separate index. | ||
| 3178 | % | ||
| 3179 | % @syncodeindex foo bar similar, but put all entries made for index foo | ||
| 3180 | % inside @code. | ||
| 3181 | % | ||
| 3182 | \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} | ||
| 3183 | \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} | ||
| 3184 | |||
| 3185 | % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), | ||
| 3186 | % #3 the target index (bar). | ||
| 3187 | \def\dosynindex#1#2#3{% | ||
| 3188 | % Only do \closeout if we haven't already done it, else we'll end up | ||
| 3189 | % closing the target index. | ||
| 3190 | \expandafter \ifx\csname donesynindex#2\endcsname \undefined | ||
| 3191 | % The \closeout helps reduce unnecessary open files; the limit on the | ||
| 3192 | % Acorn RISC OS is a mere 16 files. | ||
| 3193 | \expandafter\closeout\csname#2indfile\endcsname | ||
| 3194 | \expandafter\let\csname\donesynindex#2\endcsname = 1 | ||
| 3195 | \fi | ||
| 3196 | % redefine \fooindfile: | ||
| 3197 | \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname | ||
| 3198 | \expandafter\let\csname#2indfile\endcsname=\temp | ||
| 3199 | % redefine \fooindex: | ||
| 3200 | \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% | ||
| 3201 | } | ||
| 3202 | |||
| 3203 | % Define \doindex, the driver for all \fooindex macros. | ||
| 3204 | % Argument #1 is generated by the calling \fooindex macro, | ||
| 3205 | % and it is "foo", the name of the index. | ||
| 3206 | |||
| 3207 | % \doindex just uses \parsearg; it calls \doind for the actual work. | ||
| 3208 | % This is because \doind is more useful to call from other macros. | ||
| 3209 | |||
| 3210 | % There is also \dosubind {index}{topic}{subtopic} | ||
| 3211 | % which makes an entry in a two-level index such as the operation index. | ||
| 3212 | |||
| 3213 | \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} | ||
| 3214 | \def\singleindexer #1{\doind{\indexname}{#1}} | ||
| 3215 | |||
| 3216 | % like the previous two, but they put @code around the argument. | ||
| 3217 | \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} | ||
| 3218 | \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} | ||
| 3219 | |||
| 3220 | % Take care of Texinfo commands that can appear in an index entry. | ||
| 3221 | % Since there are some commands we want to expand, and others we don't, | ||
| 3222 | % we have to laboriously prevent expansion for those that we don't. | ||
| 3223 | % | ||
| 3224 | \def\indexdummies{% | ||
| 3225 | \escapechar = `\\ % use backslash in output files. | ||
| 3226 | \def\@{@}% change to @@ when we switch to @ as escape char in index files. | ||
| 3227 | \def\ {\realbackslash\space }% | ||
| 3228 | % Need these in case \tex is in effect and \{ is a \delimiter again. | ||
| 3229 | % But can't use \lbracecmd and \rbracecmd because texindex assumes | ||
| 3230 | % braces and backslashes are used only as delimiters. | ||
| 3231 | \let\{ = \mylbrace | ||
| 3232 | \let\} = \myrbrace | ||
| 3233 | % | ||
| 3234 | % Do the redefinitions. | ||
| 3235 | \commondummies | ||
| 3236 | } | ||
| 3237 | |||
| 3238 | % For the aux and toc files, @ is the escape character. So we want to | ||
| 3239 | % redefine everything using @ as the escape character (instead of | ||
| 3240 | % \realbackslash, still used for index files). When everything uses @, | ||
| 3241 | % this will be simpler. | ||
| 3242 | % | ||
| 3243 | \def\atdummies{% | ||
| 3244 | \def\@{@@}% | ||
| 3245 | \def\ {@ }% | ||
| 3246 | \let\{ = \lbraceatcmd | ||
| 3247 | \let\} = \rbraceatcmd | ||
| 3248 | % | ||
| 3249 | % Do the redefinitions. | ||
| 3250 | \commondummies | ||
| 3251 | \otherbackslash | ||
| 3252 | } | ||
| 3253 | |||
| 3254 | % Called from \indexdummies and \atdummies. | ||
| 3255 | % | ||
| 3256 | \def\commondummies{% | ||
| 3257 | % | ||
| 3258 | % \definedummyword defines \#1 as \string\#1\space, thus effectively | ||
| 3259 | % preventing its expansion. This is used only for control% words, | ||
| 3260 | % not control letters, because the \space would be incorrect for | ||
| 3261 | % control characters, but is needed to separate the control word | ||
| 3262 | % from whatever follows. | ||
| 3263 | % | ||
| 3264 | % For control letters, we have \definedummyletter, which omits the | ||
| 3265 | % space. | ||
| 3266 | % | ||
| 3267 | % These can be used both for control words that take an argument and | ||
| 3268 | % those that do not. If it is followed by {arg} in the input, then | ||
| 3269 | % that will dutifully get written to the index (or wherever). | ||
| 3270 | % | ||
| 3271 | \def\definedummyword ##1{\def##1{\string##1\space}}% | ||
| 3272 | \def\definedummyletter##1{\def##1{\string##1}}% | ||
| 3273 | \let\definedummyaccent\definedummyletter | ||
| 3274 | % | ||
| 3275 | \commondummiesnofonts | ||
| 3276 | % | ||
| 3277 | \definedummyletter\_% | ||
| 3278 | % | ||
| 3279 | % Non-English letters. | ||
| 3280 | \definedummyword\AA | ||
| 3281 | \definedummyword\AE | ||
| 3282 | \definedummyword\L | ||
| 3283 | \definedummyword\OE | ||
| 3284 | \definedummyword\O | ||
| 3285 | \definedummyword\aa | ||
| 3286 | \definedummyword\ae | ||
| 3287 | \definedummyword\l | ||
| 3288 | \definedummyword\oe | ||
| 3289 | \definedummyword\o | ||
| 3290 | \definedummyword\ss | ||
| 3291 | \definedummyword\exclamdown | ||
| 3292 | \definedummyword\questiondown | ||
| 3293 | \definedummyword\ordf | ||
| 3294 | \definedummyword\ordm | ||
| 3295 | % | ||
| 3296 | % Although these internal commands shouldn't show up, sometimes they do. | ||
| 3297 | \definedummyword\bf | ||
| 3298 | \definedummyword\gtr | ||
| 3299 | \definedummyword\hat | ||
| 3300 | \definedummyword\less | ||
| 3301 | \definedummyword\sf | ||
| 3302 | \definedummyword\sl | ||
| 3303 | \definedummyword\tclose | ||
| 3304 | \definedummyword\tt | ||
| 3305 | % | ||
| 3306 | \definedummyword\LaTeX | ||
| 3307 | \definedummyword\TeX | ||
| 3308 | % | ||
| 3309 | % Assorted special characters. | ||
| 3310 | \definedummyword\bullet | ||
| 3311 | \definedummyword\comma | ||
| 3312 | \definedummyword\copyright | ||
| 3313 | \definedummyword\registeredsymbol | ||
| 3314 | \definedummyword\dots | ||
| 3315 | \definedummyword\enddots | ||
| 3316 | \definedummyword\equiv | ||
| 3317 | \definedummyword\error | ||
| 3318 | \definedummyword\euro | ||
| 3319 | \definedummyword\expansion | ||
| 3320 | \definedummyword\minus | ||
| 3321 | \definedummyword\pounds | ||
| 3322 | \definedummyword\point | ||
| 3323 | \definedummyword\print | ||
| 3324 | \definedummyword\result | ||
| 3325 | % | ||
| 3326 | % We want to disable all macros so that they are not expanded by \write. | ||
| 3327 | \macrolist | ||
| 3328 | % | ||
| 3329 | \normalturnoffactive | ||
| 3330 | % | ||
| 3331 | % Handle some cases of @value -- where it does not contain any | ||
| 3332 | % (non-fully-expandable) commands. | ||
| 3333 | \makevalueexpandable | ||
| 3334 | } | ||
| 3335 | |||
| 3336 | % \commondummiesnofonts: common to \commondummies and \indexnofonts. | ||
| 3337 | % | ||
| 3338 | \def\commondummiesnofonts{% | ||
| 3339 | % Control letters and accents. | ||
| 3340 | \definedummyletter\!% | ||
| 3341 | \definedummyaccent\"% | ||
| 3342 | \definedummyaccent\'% | ||
| 3343 | \definedummyletter\*% | ||
| 3344 | \definedummyaccent\,% | ||
| 3345 | \definedummyletter\.% | ||
| 3346 | \definedummyletter\/% | ||
| 3347 | \definedummyletter\:% | ||
| 3348 | \definedummyaccent\=% | ||
| 3349 | \definedummyletter\?% | ||
| 3350 | \definedummyaccent\^% | ||
| 3351 | \definedummyaccent\`% | ||
| 3352 | \definedummyaccent\~% | ||
| 3353 | \definedummyword\u | ||
| 3354 | \definedummyword\v | ||
| 3355 | \definedummyword\H | ||
| 3356 | \definedummyword\dotaccent | ||
| 3357 | \definedummyword\ringaccent | ||
| 3358 | \definedummyword\tieaccent | ||
| 3359 | \definedummyword\ubaraccent | ||
| 3360 | \definedummyword\udotaccent | ||
| 3361 | \definedummyword\dotless | ||
| 3362 | % | ||
| 3363 | % Texinfo font commands. | ||
| 3364 | \definedummyword\b | ||
| 3365 | \definedummyword\i | ||
| 3366 | \definedummyword\r | ||
| 3367 | \definedummyword\sc | ||
| 3368 | \definedummyword\t | ||
| 3369 | % | ||
| 3370 | % Commands that take arguments. | ||
| 3371 | \definedummyword\acronym | ||
| 3372 | \definedummyword\cite | ||
| 3373 | \definedummyword\code | ||
| 3374 | \definedummyword\command | ||
| 3375 | \definedummyword\dfn | ||
| 3376 | \definedummyword\emph | ||
| 3377 | \definedummyword\env | ||
| 3378 | \definedummyword\file | ||
| 3379 | \definedummyword\kbd | ||
| 3380 | \definedummyword\key | ||
| 3381 | \definedummyword\math | ||
| 3382 | \definedummyword\option | ||
| 3383 | \definedummyword\pxref | ||
| 3384 | \definedummyword\ref | ||
| 3385 | \definedummyword\samp | ||
| 3386 | \definedummyword\strong | ||
| 3387 | \definedummyword\tie | ||
| 3388 | \definedummyword\uref | ||
| 3389 | \definedummyword\url | ||
| 3390 | \definedummyword\var | ||
| 3391 | \definedummyword\verb | ||
| 3392 | \definedummyword\w | ||
| 3393 | \definedummyword\xref | ||
| 3394 | } | ||
| 3395 | |||
| 3396 | % \indexnofonts is used when outputting the strings to sort the index | ||
| 3397 | % by, and when constructing control sequence names. It eliminates all | ||
| 3398 | % control sequences and just writes whatever the best ASCII sort string | ||
| 3399 | % would be for a given command (usually its argument). | ||
| 3400 | % | ||
| 3401 | \def\indexnofonts{% | ||
| 3402 | % Accent commands should become @asis. | ||
| 3403 | \def\definedummyaccent##1{\let##1\asis}% | ||
| 3404 | % We can just ignore other control letters. | ||
| 3405 | \def\definedummyletter##1{\let##1\empty}% | ||
| 3406 | % Hopefully, all control words can become @asis. | ||
| 3407 | \let\definedummyword\definedummyaccent | ||
| 3408 | % | ||
| 3409 | \commondummiesnofonts | ||
| 3410 | % | ||
| 3411 | % Don't no-op \tt, since it isn't a user-level command | ||
| 3412 | % and is used in the definitions of the active chars like <, >, |, etc. | ||
| 3413 | % Likewise with the other plain tex font commands. | ||
| 3414 | %\let\tt=\asis | ||
| 3415 | % | ||
| 3416 | \def\ { }% | ||
| 3417 | \def\@{@}% | ||
| 3418 | % how to handle braces? | ||
| 3419 | \def\_{\normalunderscore}% | ||
| 3420 | % | ||
| 3421 | % Non-English letters. | ||
| 3422 | \def\AA{AA}% | ||
| 3423 | \def\AE{AE}% | ||
| 3424 | \def\L{L}% | ||
| 3425 | \def\OE{OE}% | ||
| 3426 | \def\O{O}% | ||
| 3427 | \def\aa{aa}% | ||
| 3428 | \def\ae{ae}% | ||
| 3429 | \def\l{l}% | ||
| 3430 | \def\oe{oe}% | ||
| 3431 | \def\o{o}% | ||
| 3432 | \def\ss{ss}% | ||
| 3433 | \def\exclamdown{!}% | ||
| 3434 | \def\questiondown{?}% | ||
| 3435 | \def\ordf{a}% | ||
| 3436 | \def\ordm{o}% | ||
| 3437 | % | ||
| 3438 | \def\LaTeX{LaTeX}% | ||
| 3439 | \def\TeX{TeX}% | ||
| 3440 | % | ||
| 3441 | % Assorted special characters. | ||
| 3442 | % (The following {} will end up in the sort string, but that's ok.) | ||
| 3443 | \def\bullet{bullet}% | ||
| 3444 | \def\comma{,}% | ||
| 3445 | \def\copyright{copyright}% | ||
| 3446 | \def\registeredsymbol{R}% | ||
| 3447 | \def\dots{...}% | ||
| 3448 | \def\enddots{...}% | ||
| 3449 | \def\equiv{==}% | ||
| 3450 | \def\error{error}% | ||
| 3451 | \def\euro{euro}% | ||
| 3452 | \def\expansion{==>}% | ||
| 3453 | \def\minus{-}% | ||
| 3454 | \def\pounds{pounds}% | ||
| 3455 | \def\point{.}% | ||
| 3456 | \def\print{-|}% | ||
| 3457 | \def\result{=>}% | ||
| 3458 | % | ||
| 3459 | % We need to get rid of all macros, leaving only the arguments (if present). | ||
| 3460 | % Of course this is not nearly correct, but it is the best we can do for now. | ||
| 3461 | % makeinfo does not expand macros in the argument to @deffn, which ends up | ||
| 3462 | % writing an index entry, and texindex isn't prepared for an index sort entry | ||
| 3463 | % that starts with \. | ||
| 3464 | % | ||
| 3465 | % Since macro invocations are followed by braces, we can just redefine them | ||
| 3466 | % to take a single TeX argument. The case of a macro invocation that | ||
| 3467 | % goes to end-of-line is not handled. | ||
| 3468 | % | ||
| 3469 | \macrolist | ||
| 3470 | } | ||
| 3471 | |||
| 3472 | \let\indexbackslash=0 %overridden during \printindex. | ||
| 3473 | \let\SETmarginindex=\relax % put index entries in margin (undocumented)? | ||
| 3474 | |||
| 3475 | % Most index entries go through here, but \dosubind is the general case. | ||
| 3476 | % #1 is the index name, #2 is the entry text. | ||
| 3477 | \def\doind#1#2{\dosubind{#1}{#2}{}} | ||
| 3478 | |||
| 3479 | % Workhorse for all \fooindexes. | ||
| 3480 | % #1 is name of index, #2 is stuff to put there, #3 is subentry -- | ||
| 3481 | % empty if called from \doind, as we usually are (the main exception | ||
| 3482 | % is with most defuns, which call us directly). | ||
| 3483 | % | ||
| 3484 | \def\dosubind#1#2#3{% | ||
| 3485 | \iflinks | ||
| 3486 | {% | ||
| 3487 | % Store the main index entry text (including the third arg). | ||
| 3488 | \toks0 = {#2}% | ||
| 3489 | % If third arg is present, precede it with a space. | ||
| 3490 | \def\thirdarg{#3}% | ||
| 3491 | \ifx\thirdarg\empty \else | ||
| 3492 | \toks0 = \expandafter{\the\toks0 \space #3}% | ||
| 3493 | \fi | ||
| 3494 | % | ||
| 3495 | \edef\writeto{\csname#1indfile\endcsname}% | ||
| 3496 | % | ||
| 3497 | \ifvmode | ||
| 3498 | \dosubindsanitize | ||
| 3499 | \else | ||
| 3500 | \dosubindwrite | ||
| 3501 | \fi | ||
| 3502 | }% | ||
| 3503 | \fi | ||
| 3504 | } | ||
| 3505 | |||
| 3506 | % Write the entry in \toks0 to the index file: | ||
| 3507 | % | ||
| 3508 | \def\dosubindwrite{% | ||
| 3509 | % Put the index entry in the margin if desired. | ||
| 3510 | \ifx\SETmarginindex\relax\else | ||
| 3511 | \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% | ||
| 3512 | \fi | ||
| 3513 | % | ||
| 3514 | % Remember, we are within a group. | ||
| 3515 | \indexdummies % Must do this here, since \bf, etc expand at this stage | ||
| 3516 | \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now | ||
| 3517 | % so it will be output as is; and it will print as backslash. | ||
| 3518 | % | ||
| 3519 | % Process the index entry with all font commands turned off, to | ||
| 3520 | % get the string to sort by. | ||
| 3521 | {\indexnofonts | ||
| 3522 | \edef\temp{\the\toks0}% need full expansion | ||
| 3523 | \xdef\indexsorttmp{\temp}% | ||
| 3524 | }% | ||
| 3525 | % | ||
| 3526 | % Set up the complete index entry, with both the sort key and | ||
| 3527 | % the original text, including any font commands. We write | ||
| 3528 | % three arguments to \entry to the .?? file (four in the | ||
| 3529 | % subentry case), texindex reduces to two when writing the .??s | ||
| 3530 | % sorted result. | ||
| 3531 | \edef\temp{% | ||
| 3532 | \write\writeto{% | ||
| 3533 | \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% | ||
| 3534 | }% | ||
| 3535 | \temp | ||
| 3536 | } | ||
| 3537 | |||
| 3538 | % Take care of unwanted page breaks: | ||
| 3539 | % | ||
| 3540 | % If a skip is the last thing on the list now, preserve it | ||
| 3541 | % by backing up by \lastskip, doing the \write, then inserting | ||
| 3542 | % the skip again. Otherwise, the whatsit generated by the | ||
| 3543 | % \write will make \lastskip zero. The result is that sequences | ||
| 3544 | % like this: | ||
| 3545 | % @end defun | ||
| 3546 | % @tindex whatever | ||
| 3547 | % @defun ... | ||
| 3548 | % will have extra space inserted, because the \medbreak in the | ||
| 3549 | % start of the @defun won't see the skip inserted by the @end of | ||
| 3550 | % the previous defun. | ||
| 3551 | % | ||
| 3552 | % But don't do any of this if we're not in vertical mode. We | ||
| 3553 | % don't want to do a \vskip and prematurely end a paragraph. | ||
| 3554 | % | ||
| 3555 | % Avoid page breaks due to these extra skips, too. | ||
| 3556 | % | ||
| 3557 | % But wait, there is a catch there: | ||
| 3558 | % We'll have to check whether \lastskip is zero skip. \ifdim is not | ||
| 3559 | % sufficient for this purpose, as it ignores stretch and shrink parts | ||
| 3560 | % of the skip. The only way seems to be to check the textual | ||
| 3561 | % representation of the skip. | ||
| 3562 | % | ||
| 3563 | % The following is almost like \def\zeroskipmacro{0.0pt} except that | ||
| 3564 | % the ``p'' and ``t'' characters have catcode \other, not 11 (letter). | ||
| 3565 | % | ||
| 3566 | \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} | ||
| 3567 | % | ||
| 3568 | % ..., ready, GO: | ||
| 3569 | % | ||
| 3570 | \def\dosubindsanitize{% | ||
| 3571 | % \lastskip and \lastpenalty cannot both be nonzero simultaneously. | ||
| 3572 | \skip0 = \lastskip | ||
| 3573 | \edef\lastskipmacro{\the\lastskip}% | ||
| 3574 | \count255 = \lastpenalty | ||
| 3575 | % | ||
| 3576 | % If \lastskip is nonzero, that means the last item was a | ||
| 3577 | % skip. And since a skip is discardable, that means this | ||
| 3578 | % -\skip0 glue we're inserting is preceded by a | ||
| 3579 | % non-discardable item, therefore it is not a potential | ||
| 3580 | % breakpoint, therefore no \nobreak needed. | ||
| 3581 | \ifx\lastskipmacro\zeroskipmacro | ||
| 3582 | \else | ||
| 3583 | \vskip-\skip0 | ||
| 3584 | \fi | ||
| 3585 | % | ||
| 3586 | \dosubindwrite | ||
| 3587 | % | ||
| 3588 | \ifx\lastskipmacro\zeroskipmacro | ||
| 3589 | % If \lastskip was zero, perhaps the last item was a penalty, and | ||
| 3590 | % perhaps it was >=10000, e.g., a \nobreak. In that case, we want | ||
| 3591 | % to re-insert the same penalty (values >10000 are used for various | ||
| 3592 | % signals); since we just inserted a non-discardable item, any | ||
| 3593 | % following glue (such as a \parskip) would be a breakpoint. For example: | ||
| 3594 | % | ||
| 3595 | % @deffn deffn-whatever | ||
| 3596 | % @vindex index-whatever | ||
| 3597 | % Description. | ||
| 3598 | % would allow a break between the index-whatever whatsit | ||
| 3599 | % and the "Description." paragraph. | ||
| 3600 | \ifnum\count255>9999 \penalty\count255 \fi | ||
| 3601 | \else | ||
| 3602 | % On the other hand, if we had a nonzero \lastskip, | ||
| 3603 | % this make-up glue would be preceded by a non-discardable item | ||
| 3604 | % (the whatsit from the \write), so we must insert a \nobreak. | ||
| 3605 | \nobreak\vskip\skip0 | ||
| 3606 | \fi | ||
| 3607 | } | ||
| 3608 | |||
| 3609 | % The index entry written in the file actually looks like | ||
| 3610 | % \entry {sortstring}{page}{topic} | ||
| 3611 | % or | ||
| 3612 | % \entry {sortstring}{page}{topic}{subtopic} | ||
| 3613 | % The texindex program reads in these files and writes files | ||
| 3614 | % containing these kinds of lines: | ||
| 3615 | % \initial {c} | ||
| 3616 | % before the first topic whose initial is c | ||
| 3617 | % \entry {topic}{pagelist} | ||
| 3618 | % for a topic that is used without subtopics | ||
| 3619 | % \primary {topic} | ||
| 3620 | % for the beginning of a topic that is used with subtopics | ||
| 3621 | % \secondary {subtopic}{pagelist} | ||
| 3622 | % for each subtopic. | ||
| 3623 | |||
| 3624 | % Define the user-accessible indexing commands | ||
| 3625 | % @findex, @vindex, @kindex, @cindex. | ||
| 3626 | |||
| 3627 | \def\findex {\fnindex} | ||
| 3628 | \def\kindex {\kyindex} | ||
| 3629 | \def\cindex {\cpindex} | ||
| 3630 | \def\vindex {\vrindex} | ||
| 3631 | \def\tindex {\tpindex} | ||
| 3632 | \def\pindex {\pgindex} | ||
| 3633 | |||
| 3634 | \def\cindexsub {\begingroup\obeylines\cindexsub} | ||
| 3635 | {\obeylines % | ||
| 3636 | \gdef\cindexsub "#1" #2^^M{\endgroup % | ||
| 3637 | \dosubind{cp}{#2}{#1}}} | ||
| 3638 | |||
| 3639 | % Define the macros used in formatting output of the sorted index material. | ||
| 3640 | |||
| 3641 | % @printindex causes a particular index (the ??s file) to get printed. | ||
| 3642 | % It does not print any chapter heading (usually an @unnumbered). | ||
| 3643 | % | ||
| 3644 | \parseargdef\printindex{\begingroup | ||
| 3645 | \dobreak \chapheadingskip{10000}% | ||
| 3646 | % | ||
| 3647 | \smallfonts \rm | ||
| 3648 | \tolerance = 9500 | ||
| 3649 | \everypar = {}% don't want the \kern\-parindent from indentation suppression. | ||
| 3650 | % | ||
| 3651 | % See if the index file exists and is nonempty. | ||
| 3652 | % Change catcode of @ here so that if the index file contains | ||
| 3653 | % \initial {@} | ||
| 3654 | % as its first line, TeX doesn't complain about mismatched braces | ||
| 3655 | % (because it thinks @} is a control sequence). | ||
| 3656 | \catcode`\@ = 11 | ||
| 3657 | \openin 1 \jobname.#1s | ||
| 3658 | \ifeof 1 | ||
| 3659 | % \enddoublecolumns gets confused if there is no text in the index, | ||
| 3660 | % and it loses the chapter title and the aux file entries for the | ||
| 3661 | % index. The easiest way to prevent this problem is to make sure | ||
| 3662 | % there is some text. | ||
| 3663 | \putwordIndexNonexistent | ||
| 3664 | \else | ||
| 3665 | % | ||
| 3666 | % If the index file exists but is empty, then \openin leaves \ifeof | ||
| 3667 | % false. We have to make TeX try to read something from the file, so | ||
| 3668 | % it can discover if there is anything in it. | ||
| 3669 | \read 1 to \temp | ||
| 3670 | \ifeof 1 | ||
| 3671 | \putwordIndexIsEmpty | ||
| 3672 | \else | ||
| 3673 | % Index files are almost Texinfo source, but we use \ as the escape | ||
| 3674 | % character. It would be better to use @, but that's too big a change | ||
| 3675 | % to make right now. | ||
| 3676 | \def\indexbackslash{\backslashcurfont}% | ||
| 3677 | \catcode`\\ = 0 | ||
| 3678 | \escapechar = `\\ | ||
| 3679 | \begindoublecolumns | ||
| 3680 | \input \jobname.#1s | ||
| 3681 | \enddoublecolumns | ||
| 3682 | \fi | ||
| 3683 | \fi | ||
| 3684 | \closein 1 | ||
| 3685 | \endgroup} | ||
| 3686 | |||
| 3687 | % These macros are used by the sorted index file itself. | ||
| 3688 | % Change them to control the appearance of the index. | ||
| 3689 | |||
| 3690 | \def\initial#1{{% | ||
| 3691 | % Some minor font changes for the special characters. | ||
| 3692 | \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt | ||
| 3693 | % | ||
| 3694 | % Remove any glue we may have, we'll be inserting our own. | ||
| 3695 | \removelastskip | ||
| 3696 | % | ||
| 3697 | % We like breaks before the index initials, so insert a bonus. | ||
| 3698 | \nobreak | ||
| 3699 | \vskip 0pt plus 3\baselineskip | ||
| 3700 | \penalty 0 | ||
| 3701 | \vskip 0pt plus -3\baselineskip | ||
| 3702 | % | ||
| 3703 | % Typeset the initial. Making this add up to a whole number of | ||
| 3704 | % baselineskips increases the chance of the dots lining up from column | ||
| 3705 | % to column. It still won't often be perfect, because of the stretch | ||
| 3706 | % we need before each entry, but it's better. | ||
| 3707 | % | ||
| 3708 | % No shrink because it confuses \balancecolumns. | ||
| 3709 | \vskip 1.67\baselineskip plus .5\baselineskip | ||
| 3710 | \leftline{\secbf #1}% | ||
| 3711 | % Do our best not to break after the initial. | ||
| 3712 | \nobreak | ||
| 3713 | \vskip .33\baselineskip plus .1\baselineskip | ||
| 3714 | }} | ||
| 3715 | |||
| 3716 | % \entry typesets a paragraph consisting of the text (#1), dot leaders, and | ||
| 3717 | % then page number (#2) flushed to the right margin. It is used for index | ||
| 3718 | % and table of contents entries. The paragraph is indented by \leftskip. | ||
| 3719 | % | ||
| 3720 | % A straightforward implementation would start like this: | ||
| 3721 | % \def\entry#1#2{... | ||
| 3722 | % But this frozes the catcodes in the argument, and can cause problems to | ||
| 3723 | % @code, which sets - active. This problem was fixed by a kludge--- | ||
| 3724 | % ``-'' was active throughout whole index, but this isn't really right. | ||
| 3725 | % | ||
| 3726 | % The right solution is to prevent \entry from swallowing the whole text. | ||
| 3727 | % --kasal, 21nov03 | ||
| 3728 | \def\entry{% | ||
| 3729 | \begingroup | ||
| 3730 | % | ||
| 3731 | % Start a new paragraph if necessary, so our assignments below can't | ||
| 3732 | % affect previous text. | ||
| 3733 | \par | ||
| 3734 | % | ||
| 3735 | % Do not fill out the last line with white space. | ||
| 3736 | \parfillskip = 0in | ||
| 3737 | % | ||
| 3738 | % No extra space above this paragraph. | ||
| 3739 | \parskip = 0in | ||
| 3740 | % | ||
| 3741 | % Do not prefer a separate line ending with a hyphen to fewer lines. | ||
| 3742 | \finalhyphendemerits = 0 | ||
| 3743 | % | ||
| 3744 | % \hangindent is only relevant when the entry text and page number | ||
| 3745 | % don't both fit on one line. In that case, bob suggests starting the | ||
| 3746 | % dots pretty far over on the line. Unfortunately, a large | ||
| 3747 | % indentation looks wrong when the entry text itself is broken across | ||
| 3748 | % lines. So we use a small indentation and put up with long leaders. | ||
| 3749 | % | ||
| 3750 | % \hangafter is reset to 1 (which is the value we want) at the start | ||
| 3751 | % of each paragraph, so we need not do anything with that. | ||
| 3752 | \hangindent = 2em | ||
| 3753 | % | ||
| 3754 | % When the entry text needs to be broken, just fill out the first line | ||
| 3755 | % with blank space. | ||
| 3756 | \rightskip = 0pt plus1fil | ||
| 3757 | % | ||
| 3758 | % A bit of stretch before each entry for the benefit of balancing | ||
| 3759 | % columns. | ||
| 3760 | \vskip 0pt plus1pt | ||
| 3761 | % | ||
| 3762 | % Swallow the left brace of the text (first parameter): | ||
| 3763 | \afterassignment\doentry | ||
| 3764 | \let\temp = | ||
| 3765 | } | ||
| 3766 | \def\doentry{% | ||
| 3767 | \bgroup % Instead of the swallowed brace. | ||
| 3768 | \noindent | ||
| 3769 | \aftergroup\finishentry | ||
| 3770 | % And now comes the text of the entry. | ||
| 3771 | } | ||
| 3772 | \def\finishentry#1{% | ||
| 3773 | % #1 is the page number. | ||
| 3774 | % | ||
| 3775 | % The following is kludged to not output a line of dots in the index if | ||
| 3776 | % there are no page numbers. The next person who breaks this will be | ||
| 3777 | % cursed by a Unix daemon. | ||
| 3778 | \def\tempa{{\rm }}% | ||
| 3779 | \def\tempb{#1}% | ||
| 3780 | \edef\tempc{\tempa}% | ||
| 3781 | \edef\tempd{\tempb}% | ||
| 3782 | \ifx\tempc\tempd | ||
| 3783 | \ % | ||
| 3784 | \else | ||
| 3785 | % | ||
| 3786 | % If we must, put the page number on a line of its own, and fill out | ||
| 3787 | % this line with blank space. (The \hfil is overwhelmed with the | ||
| 3788 | % fill leaders glue in \indexdotfill if the page number does fit.) | ||
| 3789 | \hfil\penalty50 | ||
| 3790 | \null\nobreak\indexdotfill % Have leaders before the page number. | ||
| 3791 | % | ||
| 3792 | % The `\ ' here is removed by the implicit \unskip that TeX does as | ||
| 3793 | % part of (the primitive) \par. Without it, a spurious underfull | ||
| 3794 | % \hbox ensues. | ||
| 3795 | \ifpdf | ||
| 3796 | \pdfgettoks#1.% | ||
| 3797 | \ \the\toksA | ||
| 3798 | \else | ||
| 3799 | \ #1% | ||
| 3800 | \fi | ||
| 3801 | \fi | ||
| 3802 | \par | ||
| 3803 | \endgroup | ||
| 3804 | } | ||
| 3805 | |||
| 3806 | % Like \dotfill except takes at least 1 em. | ||
| 3807 | \def\indexdotfill{\cleaders | ||
| 3808 | \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill} | ||
| 3809 | |||
| 3810 | \def\primary #1{\line{#1\hfil}} | ||
| 3811 | |||
| 3812 | \newskip\secondaryindent \secondaryindent=0.5cm | ||
| 3813 | \def\secondary#1#2{{% | ||
| 3814 | \parfillskip=0in | ||
| 3815 | \parskip=0in | ||
| 3816 | \hangindent=1in | ||
| 3817 | \hangafter=1 | ||
| 3818 | \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill | ||
| 3819 | \ifpdf | ||
| 3820 | \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. | ||
| 3821 | \else | ||
| 3822 | #2 | ||
| 3823 | \fi | ||
| 3824 | \par | ||
| 3825 | }} | ||
| 3826 | |||
| 3827 | % Define two-column mode, which we use to typeset indexes. | ||
| 3828 | % Adapted from the TeXbook, page 416, which is to say, | ||
| 3829 | % the manmac.tex format used to print the TeXbook itself. | ||
| 3830 | \catcode`\@=11 | ||
| 3831 | |||
| 3832 | \newbox\partialpage | ||
| 3833 | \newdimen\doublecolumnhsize | ||
| 3834 | |||
| 3835 | \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns | ||
| 3836 | % Grab any single-column material above us. | ||
| 3837 | \output = {% | ||
| 3838 | % | ||
| 3839 | % Here is a possibility not foreseen in manmac: if we accumulate a | ||
| 3840 | % whole lot of material, we might end up calling this \output | ||
| 3841 | % routine twice in a row (see the doublecol-lose test, which is | ||
| 3842 | % essentially a couple of indexes with @setchapternewpage off). In | ||
| 3843 | % that case we just ship out what is in \partialpage with the normal | ||
| 3844 | % output routine. Generally, \partialpage will be empty when this | ||
| 3845 | % runs and this will be a no-op. See the indexspread.tex test case. | ||
| 3846 | \ifvoid\partialpage \else | ||
| 3847 | \onepageout{\pagecontents\partialpage}% | ||
| 3848 | \fi | ||
| 3849 | % | ||
| 3850 | \global\setbox\partialpage = \vbox{% | ||
| 3851 | % Unvbox the main output page. | ||
| 3852 | \unvbox\PAGE | ||
| 3853 | \kern-\topskip \kern\baselineskip | ||
| 3854 | }% | ||
| 3855 | }% | ||
| 3856 | \eject % run that output routine to set \partialpage | ||
| 3857 | % | ||
| 3858 | % Use the double-column output routine for subsequent pages. | ||
| 3859 | \output = {\doublecolumnout}% | ||
| 3860 | % | ||
| 3861 | % Change the page size parameters. We could do this once outside this | ||
| 3862 | % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 | ||
| 3863 | % format, but then we repeat the same computation. Repeating a couple | ||
| 3864 | % of assignments once per index is clearly meaningless for the | ||
| 3865 | % execution time, so we may as well do it in one place. | ||
| 3866 | % | ||
| 3867 | % First we halve the line length, less a little for the gutter between | ||
| 3868 | % the columns. We compute the gutter based on the line length, so it | ||
| 3869 | % changes automatically with the paper format. The magic constant | ||
| 3870 | % below is chosen so that the gutter has the same value (well, +-<1pt) | ||
| 3871 | % as it did when we hard-coded it. | ||
| 3872 | % | ||
| 3873 | % We put the result in a separate register, \doublecolumhsize, so we | ||
| 3874 | % can restore it in \pagesofar, after \hsize itself has (potentially) | ||
| 3875 | % been clobbered. | ||
| 3876 | % | ||
| 3877 | \doublecolumnhsize = \hsize | ||
| 3878 | \advance\doublecolumnhsize by -.04154\hsize | ||
| 3879 | \divide\doublecolumnhsize by 2 | ||
| 3880 | \hsize = \doublecolumnhsize | ||
| 3881 | % | ||
| 3882 | % Double the \vsize as well. (We don't need a separate register here, | ||
| 3883 | % since nobody clobbers \vsize.) | ||
| 3884 | \vsize = 2\vsize | ||
| 3885 | } | ||
| 3886 | |||
| 3887 | % The double-column output routine for all double-column pages except | ||
| 3888 | % the last. | ||
| 3889 | % | ||
| 3890 | \def\doublecolumnout{% | ||
| 3891 | \splittopskip=\topskip \splitmaxdepth=\maxdepth | ||
| 3892 | % Get the available space for the double columns -- the normal | ||
| 3893 | % (undoubled) page height minus any material left over from the | ||
| 3894 | % previous page. | ||
| 3895 | \dimen@ = \vsize | ||
| 3896 | \divide\dimen@ by 2 | ||
| 3897 | \advance\dimen@ by -\ht\partialpage | ||
| 3898 | % | ||
| 3899 | % box0 will be the left-hand column, box2 the right. | ||
| 3900 | \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ | ||
| 3901 | \onepageout\pagesofar | ||
| 3902 | \unvbox255 | ||
| 3903 | \penalty\outputpenalty | ||
| 3904 | } | ||
| 3905 | % | ||
| 3906 | % Re-output the contents of the output page -- any previous material, | ||
| 3907 | % followed by the two boxes we just split, in box0 and box2. | ||
| 3908 | \def\pagesofar{% | ||
| 3909 | \unvbox\partialpage | ||
| 3910 | % | ||
| 3911 | \hsize = \doublecolumnhsize | ||
| 3912 | \wd0=\hsize \wd2=\hsize | ||
| 3913 | \hbox to\pagewidth{\box0\hfil\box2}% | ||
| 3914 | } | ||
| 3915 | % | ||
| 3916 | % All done with double columns. | ||
| 3917 | \def\enddoublecolumns{% | ||
| 3918 | \output = {% | ||
| 3919 | % Split the last of the double-column material. Leave it on the | ||
| 3920 | % current page, no automatic page break. | ||
| 3921 | \balancecolumns | ||
| 3922 | % | ||
| 3923 | % If we end up splitting too much material for the current page, | ||
| 3924 | % though, there will be another page break right after this \output | ||
| 3925 | % invocation ends. Having called \balancecolumns once, we do not | ||
| 3926 | % want to call it again. Therefore, reset \output to its normal | ||
| 3927 | % definition right away. (We hope \balancecolumns will never be | ||
| 3928 | % called on to balance too much material, but if it is, this makes | ||
| 3929 | % the output somewhat more palatable.) | ||
| 3930 | \global\output = {\onepageout{\pagecontents\PAGE}}% | ||
| 3931 | }% | ||
| 3932 | \eject | ||
| 3933 | \endgroup % started in \begindoublecolumns | ||
| 3934 | % | ||
| 3935 | % \pagegoal was set to the doubled \vsize above, since we restarted | ||
| 3936 | % the current page. We're now back to normal single-column | ||
| 3937 | % typesetting, so reset \pagegoal to the normal \vsize (after the | ||
| 3938 | % \endgroup where \vsize got restored). | ||
| 3939 | \pagegoal = \vsize | ||
| 3940 | } | ||
| 3941 | % | ||
| 3942 | % Called at the end of the double column material. | ||
| 3943 | \def\balancecolumns{% | ||
| 3944 | \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. | ||
| 3945 | \dimen@ = \ht0 | ||
| 3946 | \advance\dimen@ by \topskip | ||
| 3947 | \advance\dimen@ by-\baselineskip | ||
| 3948 | \divide\dimen@ by 2 % target to split to | ||
| 3949 | %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% | ||
| 3950 | \splittopskip = \topskip | ||
| 3951 | % Loop until we get a decent breakpoint. | ||
| 3952 | {% | ||
| 3953 | \vbadness = 10000 | ||
| 3954 | \loop | ||
| 3955 | \global\setbox3 = \copy0 | ||
| 3956 | \global\setbox1 = \vsplit3 to \dimen@ | ||
| 3957 | \ifdim\ht3>\dimen@ | ||
| 3958 | \global\advance\dimen@ by 1pt | ||
| 3959 | \repeat | ||
| 3960 | }% | ||
| 3961 | %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% | ||
| 3962 | \setbox0=\vbox to\dimen@{\unvbox1}% | ||
| 3963 | \setbox2=\vbox to\dimen@{\unvbox3}% | ||
| 3964 | % | ||
| 3965 | \pagesofar | ||
| 3966 | } | ||
| 3967 | \catcode`\@ = \other | ||
| 3968 | |||
| 3969 | |||
| 3970 | \message{sectioning,} | ||
| 3971 | % Chapters, sections, etc. | ||
| 3972 | |||
| 3973 | % \unnumberedno is an oxymoron, of course. But we count the unnumbered | ||
| 3974 | % sections so that we can refer to them unambiguously in the pdf | ||
| 3975 | % outlines by their "section number". We avoid collisions with chapter | ||
| 3976 | % numbers by starting them at 10000. (If a document ever has 10000 | ||
| 3977 | % chapters, we're in trouble anyway, I'm sure.) | ||
| 3978 | \newcount\unnumberedno \unnumberedno = 10000 | ||
| 3979 | \newcount\chapno | ||
| 3980 | \newcount\secno \secno=0 | ||
| 3981 | \newcount\subsecno \subsecno=0 | ||
| 3982 | \newcount\subsubsecno \subsubsecno=0 | ||
| 3983 | |||
| 3984 | % This counter is funny since it counts through charcodes of letters A, B, ... | ||
| 3985 | \newcount\appendixno \appendixno = `\@ | ||
| 3986 | % | ||
| 3987 | % \def\appendixletter{\char\the\appendixno} | ||
| 3988 | % We do the following ugly conditional instead of the above simple | ||
| 3989 | % construct for the sake of pdftex, which needs the actual | ||
| 3990 | % letter in the expansion, not just typeset. | ||
| 3991 | % | ||
| 3992 | \def\appendixletter{% | ||
| 3993 | \ifnum\appendixno=`A A% | ||
| 3994 | \else\ifnum\appendixno=`B B% | ||
| 3995 | \else\ifnum\appendixno=`C C% | ||
| 3996 | \else\ifnum\appendixno=`D D% | ||
| 3997 | \else\ifnum\appendixno=`E E% | ||
| 3998 | \else\ifnum\appendixno=`F F% | ||
| 3999 | \else\ifnum\appendixno=`G G% | ||
| 4000 | \else\ifnum\appendixno=`H H% | ||
| 4001 | \else\ifnum\appendixno=`I I% | ||
| 4002 | \else\ifnum\appendixno=`J J% | ||
| 4003 | \else\ifnum\appendixno=`K K% | ||
| 4004 | \else\ifnum\appendixno=`L L% | ||
| 4005 | \else\ifnum\appendixno=`M M% | ||
| 4006 | \else\ifnum\appendixno=`N N% | ||
| 4007 | \else\ifnum\appendixno=`O O% | ||
| 4008 | \else\ifnum\appendixno=`P P% | ||
| 4009 | \else\ifnum\appendixno=`Q Q% | ||
| 4010 | \else\ifnum\appendixno=`R R% | ||
| 4011 | \else\ifnum\appendixno=`S S% | ||
| 4012 | \else\ifnum\appendixno=`T T% | ||
| 4013 | \else\ifnum\appendixno=`U U% | ||
| 4014 | \else\ifnum\appendixno=`V V% | ||
| 4015 | \else\ifnum\appendixno=`W W% | ||
| 4016 | \else\ifnum\appendixno=`X X% | ||
| 4017 | \else\ifnum\appendixno=`Y Y% | ||
| 4018 | \else\ifnum\appendixno=`Z Z% | ||
| 4019 | % The \the is necessary, despite appearances, because \appendixletter is | ||
| 4020 | % expanded while writing the .toc file. \char\appendixno is not | ||
| 4021 | % expandable, thus it is written literally, thus all appendixes come out | ||
| 4022 | % with the same letter (or @) in the toc without it. | ||
| 4023 | \else\char\the\appendixno | ||
| 4024 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi | ||
| 4025 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} | ||
| 4026 | |||
| 4027 | % Each @chapter defines this as the name of the chapter. | ||
| 4028 | % page headings and footings can use it. @section does likewise. | ||
| 4029 | % However, they are not reliable, because we don't use marks. | ||
| 4030 | \def\thischapter{} | ||
| 4031 | \def\thissection{} | ||
| 4032 | |||
| 4033 | \newcount\absseclevel % used to calculate proper heading level | ||
| 4034 | \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count | ||
| 4035 | |||
| 4036 | % @raisesections: treat @section as chapter, @subsection as section, etc. | ||
| 4037 | \def\raisesections{\global\advance\secbase by -1} | ||
| 4038 | \let\up=\raisesections % original BFox name | ||
| 4039 | |||
| 4040 | % @lowersections: treat @chapter as section, @section as subsection, etc. | ||
| 4041 | \def\lowersections{\global\advance\secbase by 1} | ||
| 4042 | \let\down=\lowersections % original BFox name | ||
| 4043 | |||
| 4044 | % we only have subsub. | ||
| 4045 | \chardef\maxseclevel = 3 | ||
| 4046 | % | ||
| 4047 | % A numbered section within an unnumbered changes to unnumbered too. | ||
| 4048 | % To achive this, remember the "biggest" unnum. sec. we are currently in: | ||
| 4049 | \chardef\unmlevel = \maxseclevel | ||
| 4050 | % | ||
| 4051 | % Trace whether the current chapter is an appendix or not: | ||
| 4052 | % \chapheadtype is "N" or "A", unnumbered chapters are ignored. | ||
| 4053 | \def\chapheadtype{N} | ||
| 4054 | |||
| 4055 | % Choose a heading macro | ||
| 4056 | % #1 is heading type | ||
| 4057 | % #2 is heading level | ||
| 4058 | % #3 is text for heading | ||
| 4059 | \def\genhead#1#2#3{% | ||
| 4060 | % Compute the abs. sec. level: | ||
| 4061 | \absseclevel=#2 | ||
| 4062 | \advance\absseclevel by \secbase | ||
| 4063 | % Make sure \absseclevel doesn't fall outside the range: | ||
| 4064 | \ifnum \absseclevel < 0 | ||
| 4065 | \absseclevel = 0 | ||
| 4066 | \else | ||
| 4067 | \ifnum \absseclevel > 3 | ||
| 4068 | \absseclevel = 3 | ||
| 4069 | \fi | ||
| 4070 | \fi | ||
| 4071 | % The heading type: | ||
| 4072 | \def\headtype{#1}% | ||
| 4073 | \if \headtype U% | ||
| 4074 | \ifnum \absseclevel < \unmlevel | ||
| 4075 | \chardef\unmlevel = \absseclevel | ||
| 4076 | \fi | ||
| 4077 | \else | ||
| 4078 | % Check for appendix sections: | ||
| 4079 | \ifnum \absseclevel = 0 | ||
| 4080 | \edef\chapheadtype{\headtype}% | ||
| 4081 | \else | ||
| 4082 | \if \headtype A\if \chapheadtype N% | ||
| 4083 | \errmessage{@appendix... within a non-appendix chapter}% | ||
| 4084 | \fi\fi | ||
| 4085 | \fi | ||
| 4086 | % Check for numbered within unnumbered: | ||
| 4087 | \ifnum \absseclevel > \unmlevel | ||
| 4088 | \def\headtype{U}% | ||
| 4089 | \else | ||
| 4090 | \chardef\unmlevel = 3 | ||
| 4091 | \fi | ||
| 4092 | \fi | ||
| 4093 | % Now print the heading: | ||
| 4094 | \if \headtype U% | ||
| 4095 | \ifcase\absseclevel | ||
| 4096 | \unnumberedzzz{#3}% | ||
| 4097 | \or \unnumberedseczzz{#3}% | ||
| 4098 | \or \unnumberedsubseczzz{#3}% | ||
| 4099 | \or \unnumberedsubsubseczzz{#3}% | ||
| 4100 | \fi | ||
| 4101 | \else | ||
| 4102 | \if \headtype A% | ||
| 4103 | \ifcase\absseclevel | ||
| 4104 | \appendixzzz{#3}% | ||
| 4105 | \or \appendixsectionzzz{#3}% | ||
| 4106 | \or \appendixsubseczzz{#3}% | ||
| 4107 | \or \appendixsubsubseczzz{#3}% | ||
| 4108 | \fi | ||
| 4109 | \else | ||
| 4110 | \ifcase\absseclevel | ||
| 4111 | \chapterzzz{#3}% | ||
| 4112 | \or \seczzz{#3}% | ||
| 4113 | \or \numberedsubseczzz{#3}% | ||
| 4114 | \or \numberedsubsubseczzz{#3}% | ||
| 4115 | \fi | ||
| 4116 | \fi | ||
| 4117 | \fi | ||
| 4118 | \suppressfirstparagraphindent | ||
| 4119 | } | ||
| 4120 | |||
| 4121 | % an interface: | ||
| 4122 | \def\numhead{\genhead N} | ||
| 4123 | \def\apphead{\genhead A} | ||
| 4124 | \def\unnmhead{\genhead U} | ||
| 4125 | |||
| 4126 | % @chapter, @appendix, @unnumbered. Increment top-level counter, reset | ||
| 4127 | % all lower-level sectioning counters to zero. | ||
| 4128 | % | ||
| 4129 | % Also set \chaplevelprefix, which we prepend to @float sequence numbers | ||
| 4130 | % (e.g., figures), q.v. By default (before any chapter), that is empty. | ||
| 4131 | \let\chaplevelprefix = \empty | ||
| 4132 | % | ||
| 4133 | \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz | ||
| 4134 | \def\chapterzzz#1{% | ||
| 4135 | % section resetting is \global in case the chapter is in a group, such | ||
| 4136 | % as an @include file. | ||
| 4137 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 | ||
| 4138 | \global\advance\chapno by 1 | ||
| 4139 | % | ||
| 4140 | % Used for \float. | ||
| 4141 | \gdef\chaplevelprefix{\the\chapno.}% | ||
| 4142 | \resetallfloatnos | ||
| 4143 | % | ||
| 4144 | \message{\putwordChapter\space \the\chapno}% | ||
| 4145 | % | ||
| 4146 | % Write the actual heading. | ||
| 4147 | \chapmacro{#1}{Ynumbered}{\the\chapno}% | ||
| 4148 | % | ||
| 4149 | % So @section and the like are numbered underneath this chapter. | ||
| 4150 | \global\let\section = \numberedsec | ||
| 4151 | \global\let\subsection = \numberedsubsec | ||
| 4152 | \global\let\subsubsection = \numberedsubsubsec | ||
| 4153 | } | ||
| 4154 | |||
| 4155 | \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz | ||
| 4156 | \def\appendixzzz#1{% | ||
| 4157 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 | ||
| 4158 | \global\advance\appendixno by 1 | ||
| 4159 | \gdef\chaplevelprefix{\appendixletter.}% | ||
| 4160 | \resetallfloatnos | ||
| 4161 | % | ||
| 4162 | \def\appendixnum{\putwordAppendix\space \appendixletter}% | ||
| 4163 | \message{\appendixnum}% | ||
| 4164 | % | ||
| 4165 | \chapmacro{#1}{Yappendix}{\appendixletter}% | ||
| 4166 | % | ||
| 4167 | \global\let\section = \appendixsec | ||
| 4168 | \global\let\subsection = \appendixsubsec | ||
| 4169 | \global\let\subsubsection = \appendixsubsubsec | ||
| 4170 | } | ||
| 4171 | |||
| 4172 | \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz | ||
| 4173 | \def\unnumberedzzz#1{% | ||
| 4174 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 | ||
| 4175 | \global\advance\unnumberedno by 1 | ||
| 4176 | % | ||
| 4177 | % Since an unnumbered has no number, no prefix for figures. | ||
| 4178 | \global\let\chaplevelprefix = \empty | ||
| 4179 | \resetallfloatnos | ||
| 4180 | % | ||
| 4181 | % This used to be simply \message{#1}, but TeX fully expands the | ||
| 4182 | % argument to \message. Therefore, if #1 contained @-commands, TeX | ||
| 4183 | % expanded them. For example, in `@unnumbered The @cite{Book}', TeX | ||
| 4184 | % expanded @cite (which turns out to cause errors because \cite is meant | ||
| 4185 | % to be executed, not expanded). | ||
| 4186 | % | ||
| 4187 | % Anyway, we don't want the fully-expanded definition of @cite to appear | ||
| 4188 | % as a result of the \message, we just want `@cite' itself. We use | ||
| 4189 | % \the<toks register> to achieve this: TeX expands \the<toks> only once, | ||
| 4190 | % simply yielding the contents of <toks register>. (We also do this for | ||
| 4191 | % the toc entries.) | ||
| 4192 | \toks0 = {#1}% | ||
| 4193 | \message{(\the\toks0)}% | ||
| 4194 | % | ||
| 4195 | \chapmacro{#1}{Ynothing}{\the\unnumberedno}% | ||
| 4196 | % | ||
| 4197 | \global\let\section = \unnumberedsec | ||
| 4198 | \global\let\subsection = \unnumberedsubsec | ||
| 4199 | \global\let\subsubsection = \unnumberedsubsubsec | ||
| 4200 | } | ||
| 4201 | |||
| 4202 | % @centerchap is like @unnumbered, but the heading is centered. | ||
| 4203 | \outer\parseargdef\centerchap{% | ||
| 4204 | % Well, we could do the following in a group, but that would break | ||
| 4205 | % an assumption that \chapmacro is called at the outermost level. | ||
| 4206 | % Thus we are safer this way: --kasal, 24feb04 | ||
| 4207 | \let\centerparametersmaybe = \centerparameters | ||
| 4208 | \unnmhead0{#1}% | ||
| 4209 | \let\centerparametersmaybe = \relax | ||
| 4210 | } | ||
| 4211 | |||
| 4212 | % @top is like @unnumbered. | ||
| 4213 | \let\top\unnumbered | ||
| 4214 | |||
| 4215 | % Sections. | ||
| 4216 | \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz | ||
| 4217 | \def\seczzz#1{% | ||
| 4218 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 | ||
| 4219 | \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% | ||
| 4220 | } | ||
| 4221 | |||
| 4222 | \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz | ||
| 4223 | \def\appendixsectionzzz#1{% | ||
| 4224 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 | ||
| 4225 | \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% | ||
| 4226 | } | ||
| 4227 | \let\appendixsec\appendixsection | ||
| 4228 | |||
| 4229 | \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz | ||
| 4230 | \def\unnumberedseczzz#1{% | ||
| 4231 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 | ||
| 4232 | \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% | ||
| 4233 | } | ||
| 4234 | |||
| 4235 | % Subsections. | ||
| 4236 | \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz | ||
| 4237 | \def\numberedsubseczzz#1{% | ||
| 4238 | \global\subsubsecno=0 \global\advance\subsecno by 1 | ||
| 4239 | \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% | ||
| 4240 | } | ||
| 4241 | |||
| 4242 | \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz | ||
| 4243 | \def\appendixsubseczzz#1{% | ||
| 4244 | \global\subsubsecno=0 \global\advance\subsecno by 1 | ||
| 4245 | \sectionheading{#1}{subsec}{Yappendix}% | ||
| 4246 | {\appendixletter.\the\secno.\the\subsecno}% | ||
| 4247 | } | ||
| 4248 | |||
| 4249 | \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz | ||
| 4250 | \def\unnumberedsubseczzz#1{% | ||
| 4251 | \global\subsubsecno=0 \global\advance\subsecno by 1 | ||
| 4252 | \sectionheading{#1}{subsec}{Ynothing}% | ||
| 4253 | {\the\unnumberedno.\the\secno.\the\subsecno}% | ||
| 4254 | } | ||
| 4255 | |||
| 4256 | % Subsubsections. | ||
| 4257 | \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz | ||
| 4258 | \def\numberedsubsubseczzz#1{% | ||
| 4259 | \global\advance\subsubsecno by 1 | ||
| 4260 | \sectionheading{#1}{subsubsec}{Ynumbered}% | ||
| 4261 | {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% | ||
| 4262 | } | ||
| 4263 | |||
| 4264 | \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz | ||
| 4265 | \def\appendixsubsubseczzz#1{% | ||
| 4266 | \global\advance\subsubsecno by 1 | ||
| 4267 | \sectionheading{#1}{subsubsec}{Yappendix}% | ||
| 4268 | {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% | ||
| 4269 | } | ||
| 4270 | |||
| 4271 | \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz | ||
| 4272 | \def\unnumberedsubsubseczzz#1{% | ||
| 4273 | \global\advance\subsubsecno by 1 | ||
| 4274 | \sectionheading{#1}{subsubsec}{Ynothing}% | ||
| 4275 | {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% | ||
| 4276 | } | ||
| 4277 | |||
| 4278 | % These macros control what the section commands do, according | ||
| 4279 | % to what kind of chapter we are in (ordinary, appendix, or unnumbered). | ||
| 4280 | % Define them by default for a numbered chapter. | ||
| 4281 | \let\section = \numberedsec | ||
| 4282 | \let\subsection = \numberedsubsec | ||
| 4283 | \let\subsubsection = \numberedsubsubsec | ||
| 4284 | |||
| 4285 | % Define @majorheading, @heading and @subheading | ||
| 4286 | |||
| 4287 | % NOTE on use of \vbox for chapter headings, section headings, and such: | ||
| 4288 | % 1) We use \vbox rather than the earlier \line to permit | ||
| 4289 | % overlong headings to fold. | ||
| 4290 | % 2) \hyphenpenalty is set to 10000 because hyphenation in a | ||
| 4291 | % heading is obnoxious; this forbids it. | ||
| 4292 | % 3) Likewise, headings look best if no \parindent is used, and | ||
| 4293 | % if justification is not attempted. Hence \raggedright. | ||
| 4294 | |||
| 4295 | |||
| 4296 | \def\majorheading{% | ||
| 4297 | {\advance\chapheadingskip by 10pt \chapbreak }% | ||
| 4298 | \parsearg\chapheadingzzz | ||
| 4299 | } | ||
| 4300 | |||
| 4301 | \def\chapheading{\chapbreak \parsearg\chapheadingzzz} | ||
| 4302 | \def\chapheadingzzz#1{% | ||
| 4303 | {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 | ||
| 4304 | \parindent=0pt\raggedright | ||
| 4305 | \rm #1\hfill}}% | ||
| 4306 | \bigskip \par\penalty 200\relax | ||
| 4307 | \suppressfirstparagraphindent | ||
| 4308 | } | ||
| 4309 | |||
| 4310 | % @heading, @subheading, @subsubheading. | ||
| 4311 | \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} | ||
| 4312 | \suppressfirstparagraphindent} | ||
| 4313 | \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} | ||
| 4314 | \suppressfirstparagraphindent} | ||
| 4315 | \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} | ||
| 4316 | \suppressfirstparagraphindent} | ||
| 4317 | |||
| 4318 | % These macros generate a chapter, section, etc. heading only | ||
| 4319 | % (including whitespace, linebreaking, etc. around it), | ||
| 4320 | % given all the information in convenient, parsed form. | ||
| 4321 | |||
| 4322 | %%% Args are the skip and penalty (usually negative) | ||
| 4323 | \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} | ||
| 4324 | |||
| 4325 | %%% Define plain chapter starts, and page on/off switching for it | ||
| 4326 | % Parameter controlling skip before chapter headings (if needed) | ||
| 4327 | |||
| 4328 | \newskip\chapheadingskip | ||
| 4329 | |||
| 4330 | \def\chapbreak{\dobreak \chapheadingskip {-4000}} | ||
| 4331 | \def\chappager{\par\vfill\supereject} | ||
| 4332 | \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} | ||
| 4333 | |||
| 4334 | \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} | ||
| 4335 | |||
| 4336 | \def\CHAPPAGoff{% | ||
| 4337 | \global\let\contentsalignmacro = \chappager | ||
| 4338 | \global\let\pchapsepmacro=\chapbreak | ||
| 4339 | \global\let\pagealignmacro=\chappager} | ||
| 4340 | |||
| 4341 | \def\CHAPPAGon{% | ||
| 4342 | \global\let\contentsalignmacro = \chappager | ||
| 4343 | \global\let\pchapsepmacro=\chappager | ||
| 4344 | \global\let\pagealignmacro=\chappager | ||
| 4345 | \global\def\HEADINGSon{\HEADINGSsingle}} | ||
| 4346 | |||
| 4347 | \def\CHAPPAGodd{% | ||
| 4348 | \global\let\contentsalignmacro = \chapoddpage | ||
| 4349 | \global\let\pchapsepmacro=\chapoddpage | ||
| 4350 | \global\let\pagealignmacro=\chapoddpage | ||
| 4351 | \global\def\HEADINGSon{\HEADINGSdouble}} | ||
| 4352 | |||
| 4353 | \CHAPPAGon | ||
| 4354 | |||
| 4355 | % Chapter opening. | ||
| 4356 | % | ||
| 4357 | % #1 is the text, #2 is the section type (Ynumbered, Ynothing, | ||
| 4358 | % Yappendix, Yomitfromtoc), #3 the chapter number. | ||
| 4359 | % | ||
| 4360 | % To test against our argument. | ||
| 4361 | \def\Ynothingkeyword{Ynothing} | ||
| 4362 | \def\Yomitfromtockeyword{Yomitfromtoc} | ||
| 4363 | \def\Yappendixkeyword{Yappendix} | ||
| 4364 | % | ||
| 4365 | \def\chapmacro#1#2#3{% | ||
| 4366 | \pchapsepmacro | ||
| 4367 | {% | ||
| 4368 | \chapfonts \rm | ||
| 4369 | % | ||
| 4370 | % Have to define \thissection before calling \donoderef, because the | ||
| 4371 | % xref code eventually uses it. On the other hand, it has to be called | ||
| 4372 | % after \pchapsepmacro, or the headline will change too soon. | ||
| 4373 | \gdef\thissection{#1}% | ||
| 4374 | \gdef\thischaptername{#1}% | ||
| 4375 | % | ||
| 4376 | % Only insert the separating space if we have a chapter/appendix | ||
| 4377 | % number, and don't print the unnumbered ``number''. | ||
| 4378 | \def\temptype{#2}% | ||
| 4379 | \ifx\temptype\Ynothingkeyword | ||
| 4380 | \setbox0 = \hbox{}% | ||
| 4381 | \def\toctype{unnchap}% | ||
| 4382 | \gdef\thischapter{#1}% | ||
| 4383 | \else\ifx\temptype\Yomitfromtockeyword | ||
| 4384 | \setbox0 = \hbox{}% contents like unnumbered, but no toc entry | ||
| 4385 | \def\toctype{omit}% | ||
| 4386 | \gdef\thischapter{}% | ||
| 4387 | \else\ifx\temptype\Yappendixkeyword | ||
| 4388 | \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% | ||
| 4389 | \def\toctype{app}% | ||
| 4390 | % We don't substitute the actual chapter name into \thischapter | ||
| 4391 | % because we don't want its macros evaluated now. And we don't | ||
| 4392 | % use \thissection because that changes with each section. | ||
| 4393 | % | ||
| 4394 | \xdef\thischapter{\putwordAppendix{} \appendixletter: | ||
| 4395 | \noexpand\thischaptername}% | ||
| 4396 | \else | ||
| 4397 | \setbox0 = \hbox{#3\enspace}% | ||
| 4398 | \def\toctype{numchap}% | ||
| 4399 | \xdef\thischapter{\putwordChapter{} \the\chapno: | ||
| 4400 | \noexpand\thischaptername}% | ||
| 4401 | \fi\fi\fi | ||
| 4402 | % | ||
| 4403 | % Write the toc entry for this chapter. Must come before the | ||
| 4404 | % \donoderef, because we include the current node name in the toc | ||
| 4405 | % entry, and \donoderef resets it to empty. | ||
| 4406 | \writetocentry{\toctype}{#1}{#3}% | ||
| 4407 | % | ||
| 4408 | % For pdftex, we have to write out the node definition (aka, make | ||
| 4409 | % the pdfdest) after any page break, but before the actual text has | ||
| 4410 | % been typeset. If the destination for the pdf outline is after the | ||
| 4411 | % text, then jumping from the outline may wind up with the text not | ||
| 4412 | % being visible, for instance under high magnification. | ||
| 4413 | \donoderef{#2}% | ||
| 4414 | % | ||
| 4415 | % Typeset the actual heading. | ||
| 4416 | \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright | ||
| 4417 | \hangindent=\wd0 \centerparametersmaybe | ||
| 4418 | \unhbox0 #1\par}% | ||
| 4419 | }% | ||
| 4420 | \nobreak\bigskip % no page break after a chapter title | ||
| 4421 | \nobreak | ||
| 4422 | } | ||
| 4423 | |||
| 4424 | % @centerchap -- centered and unnumbered. | ||
| 4425 | \let\centerparametersmaybe = \relax | ||
| 4426 | \def\centerparameters{% | ||
| 4427 | \advance\rightskip by 3\rightskip | ||
| 4428 | \leftskip = \rightskip | ||
| 4429 | \parfillskip = 0pt | ||
| 4430 | } | ||
| 4431 | |||
| 4432 | |||
| 4433 | % I don't think this chapter style is supported any more, so I'm not | ||
| 4434 | % updating it with the new noderef stuff. We'll see. --karl, 11aug03. | ||
| 4435 | % | ||
| 4436 | \def\setchapterstyle #1 {\csname CHAPF#1\endcsname} | ||
| 4437 | % | ||
| 4438 | \def\unnchfopen #1{% | ||
| 4439 | \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 | ||
| 4440 | \parindent=0pt\raggedright | ||
| 4441 | \rm #1\hfill}}\bigskip \par\nobreak | ||
| 4442 | } | ||
| 4443 | \def\chfopen #1#2{\chapoddpage {\chapfonts | ||
| 4444 | \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% | ||
| 4445 | \par\penalty 5000 % | ||
| 4446 | } | ||
| 4447 | \def\centerchfopen #1{% | ||
| 4448 | \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 | ||
| 4449 | \parindent=0pt | ||
| 4450 | \hfill {\rm #1}\hfill}}\bigskip \par\nobreak | ||
| 4451 | } | ||
| 4452 | \def\CHAPFopen{% | ||
| 4453 | \global\let\chapmacro=\chfopen | ||
| 4454 | \global\let\centerchapmacro=\centerchfopen} | ||
| 4455 | |||
| 4456 | |||
| 4457 | % Section titles. These macros combine the section number parts and | ||
| 4458 | % call the generic \sectionheading to do the printing. | ||
| 4459 | % | ||
| 4460 | \newskip\secheadingskip | ||
| 4461 | \def\secheadingbreak{\dobreak \secheadingskip{-1000}} | ||
| 4462 | |||
| 4463 | % Subsection titles. | ||
| 4464 | \newskip\subsecheadingskip | ||
| 4465 | \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} | ||
| 4466 | |||
| 4467 | % Subsubsection titles. | ||
| 4468 | \def\subsubsecheadingskip{\subsecheadingskip} | ||
| 4469 | \def\subsubsecheadingbreak{\subsecheadingbreak} | ||
| 4470 | |||
| 4471 | |||
| 4472 | % Print any size, any type, section title. | ||
| 4473 | % | ||
| 4474 | % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is | ||
| 4475 | % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the | ||
| 4476 | % section number. | ||
| 4477 | % | ||
| 4478 | \def\sectionheading#1#2#3#4{% | ||
| 4479 | {% | ||
| 4480 | % Switch to the right set of fonts. | ||
| 4481 | \csname #2fonts\endcsname \rm | ||
| 4482 | % | ||
| 4483 | % Insert space above the heading. | ||
| 4484 | \csname #2headingbreak\endcsname | ||
| 4485 | % | ||
| 4486 | % Only insert the space after the number if we have a section number. | ||
| 4487 | \def\sectionlevel{#2}% | ||
| 4488 | \def\temptype{#3}% | ||
| 4489 | % | ||
| 4490 | \ifx\temptype\Ynothingkeyword | ||
| 4491 | \setbox0 = \hbox{}% | ||
| 4492 | \def\toctype{unn}% | ||
| 4493 | \gdef\thissection{#1}% | ||
| 4494 | \else\ifx\temptype\Yomitfromtockeyword | ||
| 4495 | % for @headings -- no section number, don't include in toc, | ||
| 4496 | % and don't redefine \thissection. | ||
| 4497 | \setbox0 = \hbox{}% | ||
| 4498 | \def\toctype{omit}% | ||
| 4499 | \let\sectionlevel=\empty | ||
| 4500 | \else\ifx\temptype\Yappendixkeyword | ||
| 4501 | \setbox0 = \hbox{#4\enspace}% | ||
| 4502 | \def\toctype{app}% | ||
| 4503 | \gdef\thissection{#1}% | ||
| 4504 | \else | ||
| 4505 | \setbox0 = \hbox{#4\enspace}% | ||
| 4506 | \def\toctype{num}% | ||
| 4507 | \gdef\thissection{#1}% | ||
| 4508 | \fi\fi\fi | ||
| 4509 | % | ||
| 4510 | % Write the toc entry (before \donoderef). See comments in \chapmacro. | ||
| 4511 | \writetocentry{\toctype\sectionlevel}{#1}{#4}% | ||
| 4512 | % | ||
| 4513 | % Write the node reference (= pdf destination for pdftex). | ||
| 4514 | % Again, see comments in \chapmacro. | ||
| 4515 | \donoderef{#3}% | ||
| 4516 | % | ||
| 4517 | % Interline glue will be inserted when the vbox is completed. | ||
| 4518 | % That glue will be a valid breakpoint for the page, since it'll be | ||
| 4519 | % preceded by a whatsit (usually from the \donoderef, or from the | ||
| 4520 | % \writetocentry if there was no node). We don't want to allow that | ||
| 4521 | % break, since then the whatsits could end up on page n while the | ||
| 4522 | % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000. | ||
| 4523 | \nobreak | ||
| 4524 | % | ||
| 4525 | % Output the actual section heading. | ||
| 4526 | \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright | ||
| 4527 | \hangindent=\wd0 % zero if no section number | ||
| 4528 | \unhbox0 #1}% | ||
| 4529 | }% | ||
| 4530 | % Add extra space after the heading -- half of whatever came above it. | ||
| 4531 | % Don't allow stretch, though. | ||
| 4532 | \kern .5 \csname #2headingskip\endcsname | ||
| 4533 | % | ||
| 4534 | % Do not let the kern be a potential breakpoint, as it would be if it | ||
| 4535 | % was followed by glue. | ||
| 4536 | \nobreak | ||
| 4537 | % | ||
| 4538 | % We'll almost certainly start a paragraph next, so don't let that | ||
| 4539 | % glue accumulate. (Not a breakpoint because it's preceded by a | ||
| 4540 | % discardable item.) | ||
| 4541 | \vskip-\parskip | ||
| 4542 | % | ||
| 4543 | % This is purely so the last item on the list is a known \penalty > | ||
| 4544 | % 10000. This is so \startdefun can avoid allowing breakpoints after | ||
| 4545 | % section headings. Otherwise, it would insert a valid breakpoint between: | ||
| 4546 | % | ||
| 4547 | % @section sec-whatever | ||
| 4548 | % @deffn def-whatever | ||
| 4549 | \penalty 10001 | ||
| 4550 | } | ||
| 4551 | |||
| 4552 | |||
| 4553 | \message{toc,} | ||
| 4554 | % Table of contents. | ||
| 4555 | \newwrite\tocfile | ||
| 4556 | |||
| 4557 | % Write an entry to the toc file, opening it if necessary. | ||
| 4558 | % Called from @chapter, etc. | ||
| 4559 | % | ||
| 4560 | % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} | ||
| 4561 | % We append the current node name (if any) and page number as additional | ||
| 4562 | % arguments for the \{chap,sec,...}entry macros which will eventually | ||
| 4563 | % read this. The node name is used in the pdf outlines as the | ||
| 4564 | % destination to jump to. | ||
| 4565 | % | ||
| 4566 | % We open the .toc file for writing here instead of at @setfilename (or | ||
| 4567 | % any other fixed time) so that @contents can be anywhere in the document. | ||
| 4568 | % But if #1 is `omit', then we don't do anything. This is used for the | ||
| 4569 | % table of contents chapter openings themselves. | ||
| 4570 | % | ||
| 4571 | \newif\iftocfileopened | ||
| 4572 | \def\omitkeyword{omit}% | ||
| 4573 | % | ||
| 4574 | \def\writetocentry#1#2#3{% | ||
| 4575 | \edef\writetoctype{#1}% | ||
| 4576 | \ifx\writetoctype\omitkeyword \else | ||
| 4577 | \iftocfileopened\else | ||
| 4578 | \immediate\openout\tocfile = \jobname.toc | ||
| 4579 | \global\tocfileopenedtrue | ||
| 4580 | \fi | ||
| 4581 | % | ||
| 4582 | \iflinks | ||
| 4583 | {\atdummies | ||
| 4584 | \edef\temp{% | ||
| 4585 | \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}% | ||
| 4586 | \temp | ||
| 4587 | }% | ||
| 4588 | \fi | ||
| 4589 | \fi | ||
| 4590 | % | ||
| 4591 | % Tell \shipout to create a pdf destination on each page, if we're | ||
| 4592 | % writing pdf. These are used in the table of contents. We can't | ||
| 4593 | % just write one on every page because the title pages are numbered | ||
| 4594 | % 1 and 2 (the page numbers aren't printed), and so are the first | ||
| 4595 | % two pages of the document. Thus, we'd have two destinations named | ||
| 4596 | % `1', and two named `2'. | ||
| 4597 | \ifpdf \global\pdfmakepagedesttrue \fi | ||
| 4598 | } | ||
| 4599 | |||
| 4600 | |||
| 4601 | % These characters do not print properly in the Computer Modern roman | ||
| 4602 | % fonts, so we must take special care. This is more or less redundant | ||
| 4603 | % with the Texinfo input format setup at the end of this file. | ||
| 4604 | % | ||
| 4605 | \def\activecatcodes{% | ||
| 4606 | \catcode`\"=\active | ||
| 4607 | \catcode`\$=\active | ||
| 4608 | \catcode`\<=\active | ||
| 4609 | \catcode`\>=\active | ||
| 4610 | \catcode`\\=\active | ||
| 4611 | \catcode`\^=\active | ||
| 4612 | \catcode`\_=\active | ||
| 4613 | \catcode`\|=\active | ||
| 4614 | \catcode`\~=\active | ||
| 4615 | } | ||
| 4616 | |||
| 4617 | |||
| 4618 | % Read the toc file, which is essentially Texinfo input. | ||
| 4619 | \def\readtocfile{% | ||
| 4620 | \setupdatafile | ||
| 4621 | \activecatcodes | ||
| 4622 | \input \jobname.toc | ||
| 4623 | } | ||
| 4624 | |||
| 4625 | \newskip\contentsrightmargin \contentsrightmargin=1in | ||
| 4626 | \newcount\savepageno | ||
| 4627 | \newcount\lastnegativepageno \lastnegativepageno = -1 | ||
| 4628 | |||
| 4629 | % Prepare to read what we've written to \tocfile. | ||
| 4630 | % | ||
| 4631 | \def\startcontents#1{% | ||
| 4632 | % If @setchapternewpage on, and @headings double, the contents should | ||
| 4633 | % start on an odd page, unlike chapters. Thus, we maintain | ||
| 4634 | % \contentsalignmacro in parallel with \pagealignmacro. | ||
| 4635 | % From: Torbjorn Granlund <tege@matematik.su.se> | ||
| 4636 | \contentsalignmacro | ||
| 4637 | \immediate\closeout\tocfile | ||
| 4638 | % | ||
| 4639 | % Don't need to put `Contents' or `Short Contents' in the headline. | ||
| 4640 | % It is abundantly clear what they are. | ||
| 4641 | \def\thischapter{}% | ||
| 4642 | \chapmacro{#1}{Yomitfromtoc}{}% | ||
| 4643 | % | ||
| 4644 | \savepageno = \pageno | ||
| 4645 | \begingroup % Set up to handle contents files properly. | ||
| 4646 | \raggedbottom % Worry more about breakpoints than the bottom. | ||
| 4647 | \advance\hsize by -\contentsrightmargin % Don't use the full line length. | ||
| 4648 | % | ||
| 4649 | % Roman numerals for page numbers. | ||
| 4650 | \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi | ||
| 4651 | } | ||
| 4652 | |||
| 4653 | |||
| 4654 | % Normal (long) toc. | ||
| 4655 | \def\contents{% | ||
| 4656 | \startcontents{\putwordTOC}% | ||
| 4657 | \openin 1 \jobname.toc | ||
| 4658 | \ifeof 1 \else | ||
| 4659 | \readtocfile | ||
| 4660 | \fi | ||
| 4661 | \vfill \eject | ||
| 4662 | \contentsalignmacro % in case @setchapternewpage odd is in effect | ||
| 4663 | \ifeof 1 \else | ||
| 4664 | \pdfmakeoutlines | ||
| 4665 | \fi | ||
| 4666 | \closein 1 | ||
| 4667 | \endgroup | ||
| 4668 | \lastnegativepageno = \pageno | ||
| 4669 | \global\pageno = \savepageno | ||
| 4670 | } | ||
| 4671 | |||
| 4672 | % And just the chapters. | ||
| 4673 | \def\summarycontents{% | ||
| 4674 | \startcontents{\putwordShortTOC}% | ||
| 4675 | % | ||
| 4676 | \let\numchapentry = \shortchapentry | ||
| 4677 | \let\appentry = \shortchapentry | ||
| 4678 | \let\unnchapentry = \shortunnchapentry | ||
| 4679 | % We want a true roman here for the page numbers. | ||
| 4680 | \secfonts | ||
| 4681 | \let\rm=\shortcontrm \let\bf=\shortcontbf | ||
| 4682 | \let\sl=\shortcontsl \let\tt=\shortconttt | ||
| 4683 | \rm | ||
| 4684 | \hyphenpenalty = 10000 | ||
| 4685 | \advance\baselineskip by 1pt % Open it up a little. | ||
| 4686 | \def\numsecentry##1##2##3##4{} | ||
| 4687 | \let\appsecentry = \numsecentry | ||
| 4688 | \let\unnsecentry = \numsecentry | ||
| 4689 | \let\numsubsecentry = \numsecentry | ||
| 4690 | \let\appsubsecentry = \numsecentry | ||
| 4691 | \let\unnsubsecentry = \numsecentry | ||
| 4692 | \let\numsubsubsecentry = \numsecentry | ||
| 4693 | \let\appsubsubsecentry = \numsecentry | ||
| 4694 | \let\unnsubsubsecentry = \numsecentry | ||
| 4695 | \openin 1 \jobname.toc | ||
| 4696 | \ifeof 1 \else | ||
| 4697 | \readtocfile | ||
| 4698 | \fi | ||
| 4699 | \closein 1 | ||
| 4700 | \vfill \eject | ||
| 4701 | \contentsalignmacro % in case @setchapternewpage odd is in effect | ||
| 4702 | \endgroup | ||
| 4703 | \lastnegativepageno = \pageno | ||
| 4704 | \global\pageno = \savepageno | ||
| 4705 | } | ||
| 4706 | \let\shortcontents = \summarycontents | ||
| 4707 | |||
| 4708 | % Typeset the label for a chapter or appendix for the short contents. | ||
| 4709 | % The arg is, e.g., `A' for an appendix, or `3' for a chapter. | ||
| 4710 | % | ||
| 4711 | \def\shortchaplabel#1{% | ||
| 4712 | % This space should be enough, since a single number is .5em, and the | ||
| 4713 | % widest letter (M) is 1em, at least in the Computer Modern fonts. | ||
| 4714 | % But use \hss just in case. | ||
| 4715 | % (This space doesn't include the extra space that gets added after | ||
| 4716 | % the label; that gets put in by \shortchapentry above.) | ||
| 4717 | % | ||
| 4718 | % We'd like to right-justify chapter numbers, but that looks strange | ||
| 4719 | % with appendix letters. And right-justifying numbers and | ||
| 4720 | % left-justifying letters looks strange when there is less than 10 | ||
| 4721 | % chapters. Have to read the whole toc once to know how many chapters | ||
| 4722 | % there are before deciding ... | ||
| 4723 | \hbox to 1em{#1\hss}% | ||
| 4724 | } | ||
| 4725 | |||
| 4726 | % These macros generate individual entries in the table of contents. | ||
| 4727 | % The first argument is the chapter or section name. | ||
| 4728 | % The last argument is the page number. | ||
| 4729 | % The arguments in between are the chapter number, section number, ... | ||
| 4730 | |||
| 4731 | % Chapters, in the main contents. | ||
| 4732 | \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} | ||
| 4733 | % | ||
| 4734 | % Chapters, in the short toc. | ||
| 4735 | % See comments in \dochapentry re vbox and related settings. | ||
| 4736 | \def\shortchapentry#1#2#3#4{% | ||
| 4737 | \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% | ||
| 4738 | } | ||
| 4739 | |||
| 4740 | % Appendices, in the main contents. | ||
| 4741 | % Need the word Appendix, and a fixed-size box. | ||
| 4742 | % | ||
| 4743 | \def\appendixbox#1{% | ||
| 4744 | % We use M since it's probably the widest letter. | ||
| 4745 | \setbox0 = \hbox{\putwordAppendix{} M}% | ||
| 4746 | \hbox to \wd0{\putwordAppendix{} #1\hss}} | ||
| 4747 | % | ||
| 4748 | \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} | ||
| 4749 | |||
| 4750 | % Unnumbered chapters. | ||
| 4751 | \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} | ||
| 4752 | \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} | ||
| 4753 | |||
| 4754 | % Sections. | ||
| 4755 | \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} | ||
| 4756 | \let\appsecentry=\numsecentry | ||
| 4757 | \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} | ||
| 4758 | |||
| 4759 | % Subsections. | ||
| 4760 | \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} | ||
| 4761 | \let\appsubsecentry=\numsubsecentry | ||
| 4762 | \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} | ||
| 4763 | |||
| 4764 | % And subsubsections. | ||
| 4765 | \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} | ||
| 4766 | \let\appsubsubsecentry=\numsubsubsecentry | ||
| 4767 | \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} | ||
| 4768 | |||
| 4769 | % This parameter controls the indentation of the various levels. | ||
| 4770 | % Same as \defaultparindent. | ||
| 4771 | \newdimen\tocindent \tocindent = 15pt | ||
| 4772 | |||
| 4773 | % Now for the actual typesetting. In all these, #1 is the text and #2 is the | ||
| 4774 | % page number. | ||
| 4775 | % | ||
| 4776 | % If the toc has to be broken over pages, we want it to be at chapters | ||
| 4777 | % if at all possible; hence the \penalty. | ||
| 4778 | \def\dochapentry#1#2{% | ||
| 4779 | \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip | ||
| 4780 | \begingroup | ||
| 4781 | \chapentryfonts | ||
| 4782 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | ||
| 4783 | \endgroup | ||
| 4784 | \nobreak\vskip .25\baselineskip plus.1\baselineskip | ||
| 4785 | } | ||
| 4786 | |||
| 4787 | \def\dosecentry#1#2{\begingroup | ||
| 4788 | \secentryfonts \leftskip=\tocindent | ||
| 4789 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | ||
| 4790 | \endgroup} | ||
| 4791 | |||
| 4792 | \def\dosubsecentry#1#2{\begingroup | ||
| 4793 | \subsecentryfonts \leftskip=2\tocindent | ||
| 4794 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | ||
| 4795 | \endgroup} | ||
| 4796 | |||
| 4797 | \def\dosubsubsecentry#1#2{\begingroup | ||
| 4798 | \subsubsecentryfonts \leftskip=3\tocindent | ||
| 4799 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | ||
| 4800 | \endgroup} | ||
| 4801 | |||
| 4802 | % We use the same \entry macro as for the index entries. | ||
| 4803 | \let\tocentry = \entry | ||
| 4804 | |||
| 4805 | % Space between chapter (or whatever) number and the title. | ||
| 4806 | \def\labelspace{\hskip1em \relax} | ||
| 4807 | |||
| 4808 | \def\dopageno#1{{\rm #1}} | ||
| 4809 | \def\doshortpageno#1{{\rm #1}} | ||
| 4810 | |||
| 4811 | \def\chapentryfonts{\secfonts \rm} | ||
| 4812 | \def\secentryfonts{\textfonts} | ||
| 4813 | \def\subsecentryfonts{\textfonts} | ||
| 4814 | \def\subsubsecentryfonts{\textfonts} | ||
| 4815 | |||
| 4816 | |||
| 4817 | \message{environments,} | ||
| 4818 | % @foo ... @end foo. | ||
| 4819 | |||
| 4820 | % @point{}, @result{}, @expansion{}, @print{}, @equiv{}. | ||
| 4821 | % | ||
| 4822 | % Since these characters are used in examples, it should be an even number of | ||
| 4823 | % \tt widths. Each \tt character is 1en, so two makes it 1em. | ||
| 4824 | % | ||
| 4825 | \def\point{$\star$} | ||
| 4826 | \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} | ||
| 4827 | \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} | ||
| 4828 | \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} | ||
| 4829 | \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} | ||
| 4830 | |||
| 4831 | % The @error{} command. | ||
| 4832 | % Adapted from the TeXbook's \boxit. | ||
| 4833 | % | ||
| 4834 | \newbox\errorbox | ||
| 4835 | % | ||
| 4836 | {\tentt \global\dimen0 = 3em}% Width of the box. | ||
| 4837 | \dimen2 = .55pt % Thickness of rules | ||
| 4838 | % The text. (`r' is open on the right, `e' somewhat less so on the left.) | ||
| 4839 | \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} | ||
| 4840 | % | ||
| 4841 | \setbox\errorbox=\hbox to \dimen0{\hfil | ||
| 4842 | \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. | ||
| 4843 | \advance\hsize by -2\dimen2 % Rules. | ||
| 4844 | \vbox{% | ||
| 4845 | \hrule height\dimen2 | ||
| 4846 | \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. | ||
| 4847 | \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. | ||
| 4848 | \kern3pt\vrule width\dimen2}% Space to right. | ||
| 4849 | \hrule height\dimen2} | ||
| 4850 | \hfil} | ||
| 4851 | % | ||
| 4852 | \def\error{\leavevmode\lower.7ex\copy\errorbox} | ||
| 4853 | |||
| 4854 | % @tex ... @end tex escapes into raw Tex temporarily. | ||
| 4855 | % One exception: @ is still an escape character, so that @end tex works. | ||
| 4856 | % But \@ or @@ will get a plain tex @ character. | ||
| 4857 | |||
| 4858 | \envdef\tex{% | ||
| 4859 | \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 | ||
| 4860 | \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 | ||
| 4861 | \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie | ||
| 4862 | \catcode `\%=14 | ||
| 4863 | \catcode `\+=\other | ||
| 4864 | \catcode `\"=\other | ||
| 4865 | \catcode `\|=\other | ||
| 4866 | \catcode `\<=\other | ||
| 4867 | \catcode `\>=\other | ||
| 4868 | \escapechar=`\\ | ||
| 4869 | % | ||
| 4870 | \let\b=\ptexb | ||
| 4871 | \let\bullet=\ptexbullet | ||
| 4872 | \let\c=\ptexc | ||
| 4873 | \let\,=\ptexcomma | ||
| 4874 | \let\.=\ptexdot | ||
| 4875 | \let\dots=\ptexdots | ||
| 4876 | \let\equiv=\ptexequiv | ||
| 4877 | \let\!=\ptexexclam | ||
| 4878 | \let\i=\ptexi | ||
| 4879 | \let\indent=\ptexindent | ||
| 4880 | \let\noindent=\ptexnoindent | ||
| 4881 | \let\{=\ptexlbrace | ||
| 4882 | \let\+=\tabalign | ||
| 4883 | \let\}=\ptexrbrace | ||
| 4884 | \let\/=\ptexslash | ||
| 4885 | \let\*=\ptexstar | ||
| 4886 | \let\t=\ptext | ||
| 4887 | \let\frenchspacing=\plainfrenchspacing | ||
| 4888 | % | ||
| 4889 | \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% | ||
| 4890 | \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% | ||
| 4891 | \def\@{@}% | ||
| 4892 | } | ||
| 4893 | % There is no need to define \Etex. | ||
| 4894 | |||
| 4895 | % Define @lisp ... @end lisp. | ||
| 4896 | % @lisp environment forms a group so it can rebind things, | ||
| 4897 | % including the definition of @end lisp (which normally is erroneous). | ||
| 4898 | |||
| 4899 | % Amount to narrow the margins by for @lisp. | ||
| 4900 | \newskip\lispnarrowing \lispnarrowing=0.4in | ||
| 4901 | |||
| 4902 | % This is the definition that ^^M gets inside @lisp, @example, and other | ||
| 4903 | % such environments. \null is better than a space, since it doesn't | ||
| 4904 | % have any width. | ||
| 4905 | \def\lisppar{\null\endgraf} | ||
| 4906 | |||
| 4907 | % This space is always present above and below environments. | ||
| 4908 | \newskip\envskipamount \envskipamount = 0pt | ||
| 4909 | |||
| 4910 | % Make spacing and below environment symmetrical. We use \parskip here | ||
| 4911 | % to help in doing that, since in @example-like environments \parskip | ||
| 4912 | % is reset to zero; thus the \afterenvbreak inserts no space -- but the | ||
| 4913 | % start of the next paragraph will insert \parskip. | ||
| 4914 | % | ||
| 4915 | \def\aboveenvbreak{{% | ||
| 4916 | % =10000 instead of <10000 because of a special case in \itemzzz and | ||
| 4917 | % \sectionheading, q.v. | ||
| 4918 | \ifnum \lastpenalty=10000 \else | ||
| 4919 | \advance\envskipamount by \parskip | ||
| 4920 | \endgraf | ||
| 4921 | \ifdim\lastskip<\envskipamount | ||
| 4922 | \removelastskip | ||
| 4923 | % it's not a good place to break if the last penalty was \nobreak | ||
| 4924 | % or better ... | ||
| 4925 | \ifnum\lastpenalty<10000 \penalty-50 \fi | ||
| 4926 | \vskip\envskipamount | ||
| 4927 | \fi | ||
| 4928 | \fi | ||
| 4929 | }} | ||
| 4930 | |||
| 4931 | \let\afterenvbreak = \aboveenvbreak | ||
| 4932 | |||
| 4933 | % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will | ||
| 4934 | % also clear it, so that its embedded environments do the narrowing again. | ||
| 4935 | \let\nonarrowing=\relax | ||
| 4936 | |||
| 4937 | % @cartouche ... @end cartouche: draw rectangle w/rounded corners around | ||
| 4938 | % environment contents. | ||
| 4939 | \font\circle=lcircle10 | ||
| 4940 | \newdimen\circthick | ||
| 4941 | \newdimen\cartouter\newdimen\cartinner | ||
| 4942 | \newskip\normbskip\newskip\normpskip\newskip\normlskip | ||
| 4943 | \circthick=\fontdimen8\circle | ||
| 4944 | % | ||
| 4945 | \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth | ||
| 4946 | \def\ctr{{\hskip 6pt\circle\char'010}} | ||
| 4947 | \def\cbl{{\circle\char'012\hskip -6pt}} | ||
| 4948 | \def\cbr{{\hskip 6pt\circle\char'011}} | ||
| 4949 | \def\carttop{\hbox to \cartouter{\hskip\lskip | ||
| 4950 | \ctl\leaders\hrule height\circthick\hfil\ctr | ||
| 4951 | \hskip\rskip}} | ||
| 4952 | \def\cartbot{\hbox to \cartouter{\hskip\lskip | ||
| 4953 | \cbl\leaders\hrule height\circthick\hfil\cbr | ||
| 4954 | \hskip\rskip}} | ||
| 4955 | % | ||
| 4956 | \newskip\lskip\newskip\rskip | ||
| 4957 | |||
| 4958 | \envdef\cartouche{% | ||
| 4959 | \ifhmode\par\fi % can't be in the midst of a paragraph. | ||
| 4960 | \startsavinginserts | ||
| 4961 | \lskip=\leftskip \rskip=\rightskip | ||
| 4962 | \leftskip=0pt\rightskip=0pt % we want these *outside*. | ||
| 4963 | \cartinner=\hsize \advance\cartinner by-\lskip | ||
| 4964 | \advance\cartinner by-\rskip | ||
| 4965 | \cartouter=\hsize | ||
| 4966 | \advance\cartouter by 18.4pt % allow for 3pt kerns on either | ||
| 4967 | % side, and for 6pt waste from | ||
| 4968 | % each corner char, and rule thickness | ||
| 4969 | \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip | ||
| 4970 | % Flag to tell @lisp, etc., not to narrow margin. | ||
| 4971 | \let\nonarrowing = t% | ||
| 4972 | \vbox\bgroup | ||
| 4973 | \baselineskip=0pt\parskip=0pt\lineskip=0pt | ||
| 4974 | \carttop | ||
| 4975 | \hbox\bgroup | ||
| 4976 | \hskip\lskip | ||
| 4977 | \vrule\kern3pt | ||
| 4978 | \vbox\bgroup | ||
| 4979 | \kern3pt | ||
| 4980 | \hsize=\cartinner | ||
| 4981 | \baselineskip=\normbskip | ||
| 4982 | \lineskip=\normlskip | ||
| 4983 | \parskip=\normpskip | ||
| 4984 | \vskip -\parskip | ||
| 4985 | \comment % For explanation, see the end of \def\group. | ||
| 4986 | } | ||
| 4987 | \def\Ecartouche{% | ||
| 4988 | \ifhmode\par\fi | ||
| 4989 | \kern3pt | ||
| 4990 | \egroup | ||
| 4991 | \kern3pt\vrule | ||
| 4992 | \hskip\rskip | ||
| 4993 | \egroup | ||
| 4994 | \cartbot | ||
| 4995 | \egroup | ||
| 4996 | \checkinserts | ||
| 4997 | } | ||
| 4998 | |||
| 4999 | |||
| 5000 | % This macro is called at the beginning of all the @example variants, | ||
| 5001 | % inside a group. | ||
| 5002 | \def\nonfillstart{% | ||
| 5003 | \aboveenvbreak | ||
| 5004 | \hfuzz = 12pt % Don't be fussy | ||
| 5005 | \sepspaces % Make spaces be word-separators rather than space tokens. | ||
| 5006 | \let\par = \lisppar % don't ignore blank lines | ||
| 5007 | \obeylines % each line of input is a line of output | ||
| 5008 | \parskip = 0pt | ||
| 5009 | \parindent = 0pt | ||
| 5010 | \emergencystretch = 0pt % don't try to avoid overfull boxes | ||
| 5011 | \ifx\nonarrowing\relax | ||
| 5012 | \advance \leftskip by \lispnarrowing | ||
| 5013 | \exdentamount=\lispnarrowing | ||
| 5014 | \else | ||
| 5015 | \let\nonarrowing = \relax | ||
| 5016 | \fi | ||
| 5017 | \let\exdent=\nofillexdent | ||
| 5018 | } | ||
| 5019 | |||
| 5020 | % If you want all examples etc. small: @set dispenvsize small. | ||
| 5021 | % If you want even small examples the full size: @set dispenvsize nosmall. | ||
| 5022 | % This affects the following displayed environments: | ||
| 5023 | % @example, @display, @format, @lisp | ||
| 5024 | % | ||
| 5025 | \def\smallword{small} | ||
| 5026 | \def\nosmallword{nosmall} | ||
| 5027 | \let\SETdispenvsize\relax | ||
| 5028 | \def\setnormaldispenv{% | ||
| 5029 | \ifx\SETdispenvsize\smallword | ||
| 5030 | \smallexamplefonts \rm | ||
| 5031 | \fi | ||
| 5032 | } | ||
| 5033 | \def\setsmalldispenv{% | ||
| 5034 | \ifx\SETdispenvsize\nosmallword | ||
| 5035 | \else | ||
| 5036 | \smallexamplefonts \rm | ||
| 5037 | \fi | ||
| 5038 | } | ||
| 5039 | |||
| 5040 | % We often define two environments, @foo and @smallfoo. | ||
| 5041 | % Let's do it by one command: | ||
| 5042 | \def\makedispenv #1#2{ | ||
| 5043 | \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2} | ||
| 5044 | \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2} | ||
| 5045 | \expandafter\let\csname E#1\endcsname \afterenvbreak | ||
| 5046 | \expandafter\let\csname Esmall#1\endcsname \afterenvbreak | ||
| 5047 | } | ||
| 5048 | |||
| 5049 | % Define two synonyms: | ||
| 5050 | \def\maketwodispenvs #1#2#3{ | ||
| 5051 | \makedispenv{#1}{#3} | ||
| 5052 | \makedispenv{#2}{#3} | ||
| 5053 | } | ||
| 5054 | |||
| 5055 | % @lisp: indented, narrowed, typewriter font; @example: same as @lisp. | ||
| 5056 | % | ||
| 5057 | % @smallexample and @smalllisp: use smaller fonts. | ||
| 5058 | % Originally contributed by Pavel@xerox. | ||
| 5059 | % | ||
| 5060 | \maketwodispenvs {lisp}{example}{% | ||
| 5061 | \nonfillstart | ||
| 5062 | \tt | ||
| 5063 | \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. | ||
| 5064 | \gobble % eat return | ||
| 5065 | } | ||
| 5066 | |||
| 5067 | % @display/@smalldisplay: same as @lisp except keep current font. | ||
| 5068 | % | ||
| 5069 | \makedispenv {display}{% | ||
| 5070 | \nonfillstart | ||
| 5071 | \gobble | ||
| 5072 | } | ||
| 5073 | |||
| 5074 | % @format/@smallformat: same as @display except don't narrow margins. | ||
| 5075 | % | ||
| 5076 | \makedispenv{format}{% | ||
| 5077 | \let\nonarrowing = t% | ||
| 5078 | \nonfillstart | ||
| 5079 | \gobble | ||
| 5080 | } | ||
| 5081 | |||
| 5082 | % @flushleft: same as @format, but doesn't obey \SETdispenvsize. | ||
| 5083 | \envdef\flushleft{% | ||
| 5084 | \let\nonarrowing = t% | ||
| 5085 | \nonfillstart | ||
| 5086 | \gobble | ||
| 5087 | } | ||
| 5088 | \let\Eflushleft = \afterenvbreak | ||
| 5089 | |||
| 5090 | % @flushright. | ||
| 5091 | % | ||
| 5092 | \envdef\flushright{% | ||
| 5093 | \let\nonarrowing = t% | ||
| 5094 | \nonfillstart | ||
| 5095 | \advance\leftskip by 0pt plus 1fill | ||
| 5096 | \gobble | ||
| 5097 | } | ||
| 5098 | \let\Eflushright = \afterenvbreak | ||
| 5099 | |||
| 5100 | |||
| 5101 | % @quotation does normal linebreaking (hence we can't use \nonfillstart) | ||
| 5102 | % and narrows the margins. We keep \parskip nonzero in general, since | ||
| 5103 | % we're doing normal filling. So, when using \aboveenvbreak and | ||
| 5104 | % \afterenvbreak, temporarily make \parskip 0. | ||
| 5105 | % | ||
| 5106 | \envdef\quotation{% | ||
| 5107 | {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip | ||
| 5108 | \parindent=0pt | ||
| 5109 | % | ||
| 5110 | % @cartouche defines \nonarrowing to inhibit narrowing at next level down. | ||
| 5111 | \ifx\nonarrowing\relax | ||
| 5112 | \advance\leftskip by \lispnarrowing | ||
| 5113 | \advance\rightskip by \lispnarrowing | ||
| 5114 | \exdentamount = \lispnarrowing | ||
| 5115 | \else | ||
| 5116 | \let\nonarrowing = \relax | ||
| 5117 | \fi | ||
| 5118 | \parsearg\quotationlabel | ||
| 5119 | } | ||
| 5120 | |||
| 5121 | % We have retained a nonzero parskip for the environment, since we're | ||
| 5122 | % doing normal filling. | ||
| 5123 | % | ||
| 5124 | \def\Equotation{% | ||
| 5125 | \par | ||
| 5126 | \ifx\quotationauthor\undefined\else | ||
| 5127 | % indent a bit. | ||
| 5128 | \leftline{\kern 2\leftskip \sl ---\quotationauthor}% | ||
| 5129 | \fi | ||
| 5130 | {\parskip=0pt \afterenvbreak}% | ||
| 5131 | } | ||
| 5132 | |||
| 5133 | % If we're given an argument, typeset it in bold with a colon after. | ||
| 5134 | \def\quotationlabel#1{% | ||
| 5135 | \def\temp{#1}% | ||
| 5136 | \ifx\temp\empty \else | ||
| 5137 | {\bf #1: }% | ||
| 5138 | \fi | ||
| 5139 | } | ||
| 5140 | |||
| 5141 | |||
| 5142 | % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} | ||
| 5143 | % If we want to allow any <char> as delimiter, | ||
| 5144 | % we need the curly braces so that makeinfo sees the @verb command, eg: | ||
| 5145 | % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org | ||
| 5146 | % | ||
| 5147 | % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. | ||
| 5148 | % | ||
| 5149 | % [Knuth] p.344; only we need to do the other characters Texinfo sets | ||
| 5150 | % active too. Otherwise, they get lost as the first character on a | ||
| 5151 | % verbatim line. | ||
| 5152 | \def\dospecials{% | ||
| 5153 | \do\ \do\\\do\{\do\}\do\$\do\&% | ||
| 5154 | \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% | ||
| 5155 | \do\<\do\>\do\|\do\@\do+\do\"% | ||
| 5156 | } | ||
| 5157 | % | ||
| 5158 | % [Knuth] p. 380 | ||
| 5159 | \def\uncatcodespecials{% | ||
| 5160 | \def\do##1{\catcode`##1=\other}\dospecials} | ||
| 5161 | % | ||
| 5162 | % [Knuth] pp. 380,381,391 | ||
| 5163 | % Disable Spanish ligatures ?` and !` of \tt font | ||
| 5164 | \begingroup | ||
| 5165 | \catcode`\`=\active\gdef`{\relax\lq} | ||
| 5166 | \endgroup | ||
| 5167 | % | ||
| 5168 | % Setup for the @verb command. | ||
| 5169 | % | ||
| 5170 | % Eight spaces for a tab | ||
| 5171 | \begingroup | ||
| 5172 | \catcode`\^^I=\active | ||
| 5173 | \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} | ||
| 5174 | \endgroup | ||
| 5175 | % | ||
| 5176 | \def\setupverb{% | ||
| 5177 | \tt % easiest (and conventionally used) font for verbatim | ||
| 5178 | \def\par{\leavevmode\endgraf}% | ||
| 5179 | \catcode`\`=\active | ||
| 5180 | \tabeightspaces | ||
| 5181 | % Respect line breaks, | ||
| 5182 | % print special symbols as themselves, and | ||
| 5183 | % make each space count | ||
| 5184 | % must do in this order: | ||
| 5185 | \obeylines \uncatcodespecials \sepspaces | ||
| 5186 | } | ||
| 5187 | |||
| 5188 | % Setup for the @verbatim environment | ||
| 5189 | % | ||
| 5190 | % Real tab expansion | ||
| 5191 | \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount | ||
| 5192 | % | ||
| 5193 | \def\starttabbox{\setbox0=\hbox\bgroup} | ||
| 5194 | \begingroup | ||
| 5195 | \catcode`\^^I=\active | ||
| 5196 | \gdef\tabexpand{% | ||
| 5197 | \catcode`\^^I=\active | ||
| 5198 | \def^^I{\leavevmode\egroup | ||
| 5199 | \dimen0=\wd0 % the width so far, or since the previous tab | ||
| 5200 | \divide\dimen0 by\tabw | ||
| 5201 | \multiply\dimen0 by\tabw % compute previous multiple of \tabw | ||
| 5202 | \advance\dimen0 by\tabw % advance to next multiple of \tabw | ||
| 5203 | \wd0=\dimen0 \box0 \starttabbox | ||
| 5204 | }% | ||
| 5205 | } | ||
| 5206 | \endgroup | ||
| 5207 | \def\setupverbatim{% | ||
| 5208 | \let\nonarrowing = t% | ||
| 5209 | \nonfillstart | ||
| 5210 | % Easiest (and conventionally used) font for verbatim | ||
| 5211 | \tt | ||
| 5212 | \def\par{\leavevmode\egroup\box0\endgraf}% | ||
| 5213 | \catcode`\`=\active | ||
| 5214 | \tabexpand | ||
| 5215 | % Respect line breaks, | ||
| 5216 | % print special symbols as themselves, and | ||
| 5217 | % make each space count | ||
| 5218 | % must do in this order: | ||
| 5219 | \obeylines \uncatcodespecials \sepspaces | ||
| 5220 | \everypar{\starttabbox}% | ||
| 5221 | } | ||
| 5222 | |||
| 5223 | % Do the @verb magic: verbatim text is quoted by unique | ||
| 5224 | % delimiter characters. Before first delimiter expect a | ||
| 5225 | % right brace, after last delimiter expect closing brace: | ||
| 5226 | % | ||
| 5227 | % \def\doverb'{'<char>#1<char>'}'{#1} | ||
| 5228 | % | ||
| 5229 | % [Knuth] p. 382; only eat outer {} | ||
| 5230 | \begingroup | ||
| 5231 | \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other | ||
| 5232 | \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] | ||
| 5233 | \endgroup | ||
| 5234 | % | ||
| 5235 | \def\verb{\begingroup\setupverb\doverb} | ||
| 5236 | % | ||
| 5237 | % | ||
| 5238 | % Do the @verbatim magic: define the macro \doverbatim so that | ||
| 5239 | % the (first) argument ends when '@end verbatim' is reached, ie: | ||
| 5240 | % | ||
| 5241 | % \def\doverbatim#1@end verbatim{#1} | ||
| 5242 | % | ||
| 5243 | % For Texinfo it's a lot easier than for LaTeX, | ||
| 5244 | % because texinfo's \verbatim doesn't stop at '\end{verbatim}': | ||
| 5245 | % we need not redefine '\', '{' and '}'. | ||
| 5246 | % | ||
| 5247 | % Inspired by LaTeX's verbatim command set [latex.ltx] | ||
| 5248 | % | ||
| 5249 | \begingroup | ||
| 5250 | \catcode`\ =\active | ||
| 5251 | \obeylines % | ||
| 5252 | % ignore everything up to the first ^^M, that's the newline at the end | ||
| 5253 | % of the @verbatim input line itself. Otherwise we get an extra blank | ||
| 5254 | % line in the output. | ||
| 5255 | \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% | ||
| 5256 | % We really want {...\end verbatim} in the body of the macro, but | ||
| 5257 | % without the active space; thus we have to use \xdef and \gobble. | ||
| 5258 | \endgroup | ||
| 5259 | % | ||
| 5260 | \envdef\verbatim{% | ||
| 5261 | \setupverbatim\doverbatim | ||
| 5262 | } | ||
| 5263 | \let\Everbatim = \afterenvbreak | ||
| 5264 | |||
| 5265 | |||
| 5266 | % @verbatiminclude FILE - insert text of file in verbatim environment. | ||
| 5267 | % | ||
| 5268 | \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} | ||
| 5269 | % | ||
| 5270 | \def\doverbatiminclude#1{% | ||
| 5271 | {% | ||
| 5272 | \makevalueexpandable | ||
| 5273 | \setupverbatim | ||
| 5274 | \input #1 | ||
| 5275 | \afterenvbreak | ||
| 5276 | }% | ||
| 5277 | } | ||
| 5278 | |||
| 5279 | % @copying ... @end copying. | ||
| 5280 | % Save the text away for @insertcopying later. | ||
| 5281 | % | ||
| 5282 | % We save the uninterpreted tokens, rather than creating a box. | ||
| 5283 | % Saving the text in a box would be much easier, but then all the | ||
| 5284 | % typesetting commands (@smallbook, font changes, etc.) have to be done | ||
| 5285 | % beforehand -- and a) we want @copying to be done first in the source | ||
| 5286 | % file; b) letting users define the frontmatter in as flexible order as | ||
| 5287 | % possible is very desirable. | ||
| 5288 | % | ||
| 5289 | \def\copying{\checkenv{}\begingroup\scanargctxt\docopying} | ||
| 5290 | \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}} | ||
| 5291 | % | ||
| 5292 | \def\insertcopying{% | ||
| 5293 | \begingroup | ||
| 5294 | \parindent = 0pt % paragraph indentation looks wrong on title page | ||
| 5295 | \scanexp\copyingtext | ||
| 5296 | \endgroup | ||
| 5297 | } | ||
| 5298 | |||
| 5299 | \message{defuns,} | ||
| 5300 | % @defun etc. | ||
| 5301 | |||
| 5302 | \newskip\defbodyindent \defbodyindent=.4in | ||
| 5303 | \newskip\defargsindent \defargsindent=50pt | ||
| 5304 | \newskip\deflastargmargin \deflastargmargin=18pt | ||
| 5305 | |||
| 5306 | % Start the processing of @deffn: | ||
| 5307 | \def\startdefun{% | ||
| 5308 | \ifnum\lastpenalty<10000 | ||
| 5309 | \medbreak | ||
| 5310 | \else | ||
| 5311 | % If there are two @def commands in a row, we'll have a \nobreak, | ||
| 5312 | % which is there to keep the function description together with its | ||
| 5313 | % header. But if there's nothing but headers, we need to allow a | ||
| 5314 | % break somewhere. Check specifically for penalty 10002, inserted | ||
| 5315 | % by \defargscommonending, instead of 10000, since the sectioning | ||
| 5316 | % commands also insert a nobreak penalty, and we don't want to allow | ||
| 5317 | % a break between a section heading and a defun. | ||
| 5318 | % | ||
| 5319 | \ifnum\lastpenalty=10002 \penalty2000 \fi | ||
| 5320 | % | ||
| 5321 | % Similarly, after a section heading, do not allow a break. | ||
| 5322 | % But do insert the glue. | ||
| 5323 | \medskip % preceded by discardable penalty, so not a breakpoint | ||
| 5324 | \fi | ||
| 5325 | % | ||
| 5326 | \parindent=0in | ||
| 5327 | \advance\leftskip by \defbodyindent | ||
| 5328 | \exdentamount=\defbodyindent | ||
| 5329 | } | ||
| 5330 | |||
| 5331 | \def\dodefunx#1{% | ||
| 5332 | % First, check whether we are in the right environment: | ||
| 5333 | \checkenv#1% | ||
| 5334 | % | ||
| 5335 | % As above, allow line break if we have multiple x headers in a row. | ||
| 5336 | % It's not a great place, though. | ||
| 5337 | \ifnum\lastpenalty=10002 \penalty3000 \fi | ||
| 5338 | % | ||
| 5339 | % And now, it's time to reuse the body of the original defun: | ||
| 5340 | \expandafter\gobbledefun#1% | ||
| 5341 | } | ||
| 5342 | \def\gobbledefun#1\startdefun{} | ||
| 5343 | |||
| 5344 | % \printdefunline \deffnheader{text} | ||
| 5345 | % | ||
| 5346 | \def\printdefunline#1#2{% | ||
| 5347 | \begingroup | ||
| 5348 | % call \deffnheader: | ||
| 5349 | #1#2 \endheader | ||
| 5350 | % common ending: | ||
| 5351 | \interlinepenalty = 10000 | ||
| 5352 | \advance\rightskip by 0pt plus 1fil | ||
| 5353 | \endgraf | ||
| 5354 | \nobreak\vskip -\parskip | ||
| 5355 | \penalty 10002 % signal to \startdefun and \dodefunx | ||
| 5356 | % Some of the @defun-type tags do not enable magic parentheses, | ||
| 5357 | % rendering the following check redundant. But we don't optimize. | ||
| 5358 | \checkparencounts | ||
| 5359 | \endgroup | ||
| 5360 | } | ||
| 5361 | |||
| 5362 | \def\Edefun{\endgraf\medbreak} | ||
| 5363 | |||
| 5364 | % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; | ||
| 5365 | % the only thing remainnig is to define \deffnheader. | ||
| 5366 | % | ||
| 5367 | \def\makedefun#1{% | ||
| 5368 | \expandafter\let\csname E#1\endcsname = \Edefun | ||
| 5369 | \edef\temp{\noexpand\domakedefun | ||
| 5370 | \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% | ||
| 5371 | \temp | ||
| 5372 | } | ||
| 5373 | |||
| 5374 | % \domakedefun \deffn \deffnx \deffnheader | ||
| 5375 | % | ||
| 5376 | % Define \deffn and \deffnx, without parameters. | ||
| 5377 | % \deffnheader has to be defined explicitly. | ||
| 5378 | % | ||
| 5379 | \def\domakedefun#1#2#3{% | ||
| 5380 | \envdef#1{% | ||
| 5381 | \startdefun | ||
| 5382 | \parseargusing\activeparens{\printdefunline#3}% | ||
| 5383 | }% | ||
| 5384 | \def#2{\dodefunx#1}% | ||
| 5385 | \def#3% | ||
| 5386 | } | ||
| 5387 | |||
| 5388 | %%% Untyped functions: | ||
| 5389 | |||
| 5390 | % @deffn category name args | ||
| 5391 | \makedefun{deffn}{\deffngeneral{}} | ||
| 5392 | |||
| 5393 | % @deffn category class name args | ||
| 5394 | \makedefun{defop}#1 {\defopon{#1\ \putwordon}} | ||
| 5395 | |||
| 5396 | % \defopon {category on}class name args | ||
| 5397 | \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } | ||
| 5398 | |||
| 5399 | % \deffngeneral {subind}category name args | ||
| 5400 | % | ||
| 5401 | \def\deffngeneral#1#2 #3 #4\endheader{% | ||
| 5402 | % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. | ||
| 5403 | \dosubind{fn}{\code{#3}}{#1}% | ||
| 5404 | \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% | ||
| 5405 | } | ||
| 5406 | |||
| 5407 | %%% Typed functions: | ||
| 5408 | |||
| 5409 | % @deftypefn category type name args | ||
| 5410 | \makedefun{deftypefn}{\deftypefngeneral{}} | ||
| 5411 | |||
| 5412 | % @deftypeop category class type name args | ||
| 5413 | \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} | ||
| 5414 | |||
| 5415 | % \deftypeopon {category on}class type name args | ||
| 5416 | \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } | ||
| 5417 | |||
| 5418 | % \deftypefngeneral {subind}category type name args | ||
| 5419 | % | ||
| 5420 | \def\deftypefngeneral#1#2 #3 #4 #5\endheader{% | ||
| 5421 | \dosubind{fn}{\code{#4}}{#1}% | ||
| 5422 | \defname{#2}{#3}{#4}\defunargs{#5\unskip}% | ||
| 5423 | } | ||
| 5424 | |||
| 5425 | %%% Typed variables: | ||
| 5426 | |||
| 5427 | % @deftypevr category type var args | ||
| 5428 | \makedefun{deftypevr}{\deftypecvgeneral{}} | ||
| 5429 | |||
| 5430 | % @deftypecv category class type var args | ||
| 5431 | \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} | ||
| 5432 | |||
| 5433 | % \deftypecvof {category of}class type var args | ||
| 5434 | \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } | ||
| 5435 | |||
| 5436 | % \deftypecvgeneral {subind}category type var args | ||
| 5437 | % | ||
| 5438 | \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% | ||
| 5439 | \dosubind{vr}{\code{#4}}{#1}% | ||
| 5440 | \defname{#2}{#3}{#4}\defunargs{#5\unskip}% | ||
| 5441 | } | ||
| 5442 | |||
| 5443 | %%% Untyped variables: | ||
| 5444 | |||
| 5445 | % @defvr category var args | ||
| 5446 | \makedefun{defvr}#1 {\deftypevrheader{#1} {} } | ||
| 5447 | |||
| 5448 | % @defcv category class var args | ||
| 5449 | \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} | ||
| 5450 | |||
| 5451 | % \defcvof {category of}class var args | ||
| 5452 | \def\defcvof#1#2 {\deftypecvof{#1}#2 {} } | ||
| 5453 | |||
| 5454 | %%% Type: | ||
| 5455 | % @deftp category name args | ||
| 5456 | \makedefun{deftp}#1 #2 #3\endheader{% | ||
| 5457 | \doind{tp}{\code{#2}}% | ||
| 5458 | \defname{#1}{}{#2}\defunargs{#3\unskip}% | ||
| 5459 | } | ||
| 5460 | |||
| 5461 | % Remaining @defun-like shortcuts: | ||
| 5462 | \makedefun{defun}{\deffnheader{\putwordDeffunc} } | ||
| 5463 | \makedefun{defmac}{\deffnheader{\putwordDefmac} } | ||
| 5464 | \makedefun{defspec}{\deffnheader{\putwordDefspec} } | ||
| 5465 | \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } | ||
| 5466 | \makedefun{defvar}{\defvrheader{\putwordDefvar} } | ||
| 5467 | \makedefun{defopt}{\defvrheader{\putwordDefopt} } | ||
| 5468 | \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } | ||
| 5469 | \makedefun{defmethod}{\defopon\putwordMethodon} | ||
| 5470 | \makedefun{deftypemethod}{\deftypeopon\putwordMethodon} | ||
| 5471 | \makedefun{defivar}{\defcvof\putwordInstanceVariableof} | ||
| 5472 | \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} | ||
| 5473 | |||
| 5474 | % \defname, which formats the name of the @def (not the args). | ||
| 5475 | % #1 is the category, such as "Function". | ||
| 5476 | % #2 is the return type, if any. | ||
| 5477 | % #3 is the function name. | ||
| 5478 | % | ||
| 5479 | % We are followed by (but not passed) the arguments, if any. | ||
| 5480 | % | ||
| 5481 | \def\defname#1#2#3{% | ||
| 5482 | % Get the values of \leftskip and \rightskip as they were outside the @def... | ||
| 5483 | \advance\leftskip by -\defbodyindent | ||
| 5484 | % | ||
| 5485 | % How we'll format the type name. Putting it in brackets helps | ||
| 5486 | % distinguish it from the body text that may end up on the next line | ||
| 5487 | % just below it. | ||
| 5488 | \def\temp{#1}% | ||
| 5489 | \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} | ||
| 5490 | % | ||
| 5491 | % Figure out line sizes for the paragraph shape. | ||
| 5492 | % The first line needs space for \box0; but if \rightskip is nonzero, | ||
| 5493 | % we need only space for the part of \box0 which exceeds it: | ||
| 5494 | \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip | ||
| 5495 | % The continuations: | ||
| 5496 | \dimen2=\hsize \advance\dimen2 by -\defargsindent | ||
| 5497 | % (plain.tex says that \dimen1 should be used only as global.) | ||
| 5498 | \parshape 2 0in \dimen0 \defargsindent \dimen2 | ||
| 5499 | % | ||
| 5500 | % Put the type name to the right margin. | ||
| 5501 | \noindent | ||
| 5502 | \hbox to 0pt{% | ||
| 5503 | \hfil\box0 \kern-\hsize | ||
| 5504 | % \hsize has to be shortened this way: | ||
| 5505 | \kern\leftskip | ||
| 5506 | % Intentionally do not respect \rightskip, since we need the space. | ||
| 5507 | }% | ||
| 5508 | % | ||
| 5509 | % Allow all lines to be underfull without complaint: | ||
| 5510 | \tolerance=10000 \hbadness=10000 | ||
| 5511 | \exdentamount=\defbodyindent | ||
| 5512 | {% | ||
| 5513 | % defun fonts. We use typewriter by default (used to be bold) because: | ||
| 5514 | % . we're printing identifiers, they should be in tt in principle. | ||
| 5515 | % . in languages with many accents, such as Czech or French, it's | ||
| 5516 | % common to leave accents off identifiers. The result looks ok in | ||
| 5517 | % tt, but exceedingly strange in rm. | ||
| 5518 | % . we don't want -- and --- to be treated as ligatures. | ||
| 5519 | % . this still does not fix the ?` and !` ligatures, but so far no | ||
| 5520 | % one has made identifiers using them :). | ||
| 5521 | \df \tt | ||
| 5522 | \def\temp{#2}% return value type | ||
| 5523 | \ifx\temp\empty\else \tclose{\temp} \fi | ||
| 5524 | #3% output function name | ||
| 5525 | }% | ||
| 5526 | {\rm\enskip}% hskip 0.5 em of \tenrm | ||
| 5527 | % | ||
| 5528 | \boldbrax | ||
| 5529 | % arguments will be output next, if any. | ||
| 5530 | } | ||
| 5531 | |||
| 5532 | % Print arguments in slanted roman (not ttsl), inconsistently with using | ||
| 5533 | % tt for the name. This is because literal text is sometimes needed in | ||
| 5534 | % the argument list (groff manual), and ttsl and tt are not very | ||
| 5535 | % distinguishable. Prevent hyphenation at `-' chars. | ||
| 5536 | % | ||
| 5537 | \def\defunargs#1{% | ||
| 5538 | % use sl by default (not ttsl), | ||
| 5539 | % tt for the names. | ||
| 5540 | \df \sl \hyphenchar\font=0 | ||
| 5541 | % | ||
| 5542 | % On the other hand, if an argument has two dashes (for instance), we | ||
| 5543 | % want a way to get ttsl. Let's try @var for that. | ||
| 5544 | \let\var=\ttslanted | ||
| 5545 | #1% | ||
| 5546 | \sl\hyphenchar\font=45 | ||
| 5547 | } | ||
| 5548 | |||
| 5549 | % We want ()&[] to print specially on the defun line. | ||
| 5550 | % | ||
| 5551 | \def\activeparens{% | ||
| 5552 | \catcode`\(=\active \catcode`\)=\active | ||
| 5553 | \catcode`\[=\active \catcode`\]=\active | ||
| 5554 | \catcode`\&=\active | ||
| 5555 | } | ||
| 5556 | |||
| 5557 | % Make control sequences which act like normal parenthesis chars. | ||
| 5558 | \let\lparen = ( \let\rparen = ) | ||
| 5559 | |||
| 5560 | % Be sure that we always have a definition for `(', etc. For example, | ||
| 5561 | % if the fn name has parens in it, \boldbrax will not be in effect yet, | ||
| 5562 | % so TeX would otherwise complain about undefined control sequence. | ||
| 5563 | { | ||
| 5564 | \activeparens | ||
| 5565 | \global\let(=\lparen \global\let)=\rparen | ||
| 5566 | \global\let[=\lbrack \global\let]=\rbrack | ||
| 5567 | \global\let& = \& | ||
| 5568 | |||
| 5569 | \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} | ||
| 5570 | \gdef\magicamp{\let&=\amprm} | ||
| 5571 | } | ||
| 5572 | |||
| 5573 | \newcount\parencount | ||
| 5574 | |||
| 5575 | % If we encounter &foo, then turn on ()-hacking afterwards | ||
| 5576 | \newif\ifampseen | ||
| 5577 | \def\amprm#1 {\ampseentrue{\bf\ }} | ||
| 5578 | |||
| 5579 | \def\parenfont{% | ||
| 5580 | \ifampseen | ||
| 5581 | % At the first level, print parens in roman, | ||
| 5582 | % otherwise use the default font. | ||
| 5583 | \ifnum \parencount=1 \rm \fi | ||
| 5584 | \else | ||
| 5585 | % The \sf parens (in \boldbrax) actually are a little bolder than | ||
| 5586 | % the contained text. This is especially needed for [ and ] . | ||
| 5587 | \sf | ||
| 5588 | \fi | ||
| 5589 | } | ||
| 5590 | \def\infirstlevel#1{% | ||
| 5591 | \ifampseen | ||
| 5592 | \ifnum\parencount=1 | ||
| 5593 | #1% | ||
| 5594 | \fi | ||
| 5595 | \fi | ||
| 5596 | } | ||
| 5597 | \def\bfafterword#1 {#1 \bf} | ||
| 5598 | |||
| 5599 | \def\opnr{% | ||
| 5600 | \global\advance\parencount by 1 | ||
| 5601 | {\parenfont(}% | ||
| 5602 | \infirstlevel \bfafterword | ||
| 5603 | } | ||
| 5604 | \def\clnr{% | ||
| 5605 | {\parenfont)}% | ||
| 5606 | \infirstlevel \sl | ||
| 5607 | \global\advance\parencount by -1 | ||
| 5608 | } | ||
| 5609 | |||
| 5610 | \newcount\brackcount | ||
| 5611 | \def\lbrb{% | ||
| 5612 | \global\advance\brackcount by 1 | ||
| 5613 | {\bf[}% | ||
| 5614 | } | ||
| 5615 | \def\rbrb{% | ||
| 5616 | {\bf]}% | ||
| 5617 | \global\advance\brackcount by -1 | ||
| 5618 | } | ||
| 5619 | |||
| 5620 | \def\checkparencounts{% | ||
| 5621 | \ifnum\parencount=0 \else \badparencount \fi | ||
| 5622 | \ifnum\brackcount=0 \else \badbrackcount \fi | ||
| 5623 | } | ||
| 5624 | \def\badparencount{% | ||
| 5625 | \errmessage{Unbalanced parentheses in @def}% | ||
| 5626 | \global\parencount=0 | ||
| 5627 | } | ||
| 5628 | \def\badbrackcount{% | ||
| 5629 | \errmessage{Unbalanced square braces in @def}% | ||
| 5630 | \global\brackcount=0 | ||
| 5631 | } | ||
| 5632 | |||
| 5633 | |||
| 5634 | \message{macros,} | ||
| 5635 | % @macro. | ||
| 5636 | |||
| 5637 | % To do this right we need a feature of e-TeX, \scantokens, | ||
| 5638 | % which we arrange to emulate with a temporary file in ordinary TeX. | ||
| 5639 | \ifx\eTeXversion\undefined | ||
| 5640 | \newwrite\macscribble | ||
| 5641 | \def\scantokens#1{% | ||
| 5642 | \toks0={#1}% | ||
| 5643 | \immediate\openout\macscribble=\jobname.tmp | ||
| 5644 | \immediate\write\macscribble{\the\toks0}% | ||
| 5645 | \immediate\closeout\macscribble | ||
| 5646 | \input \jobname.tmp | ||
| 5647 | } | ||
| 5648 | \fi | ||
| 5649 | |||
| 5650 | \def\scanmacro#1{% | ||
| 5651 | \begingroup | ||
| 5652 | \newlinechar`\^^M | ||
| 5653 | \let\xeatspaces\eatspaces | ||
| 5654 | % Undo catcode changes of \startcontents and \doprintindex | ||
| 5655 | % When called from @insertcopying or (short)caption, we need active | ||
| 5656 | % backslash to get it printed correctly. Previously, we had | ||
| 5657 | % \catcode`\\=\other instead. We'll see whether a problem appears | ||
| 5658 | % with macro expansion. --kasal, 19aug04 | ||
| 5659 | \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ | ||
| 5660 | % ... and \example | ||
| 5661 | \spaceisspace | ||
| 5662 | % | ||
| 5663 | % Append \endinput to make sure that TeX does not see the ending newline. | ||
| 5664 | % | ||
| 5665 | % I've verified that it is necessary both for e-TeX and for ordinary TeX | ||
| 5666 | % --kasal, 29nov03 | ||
| 5667 | \scantokens{#1\endinput}% | ||
| 5668 | \endgroup | ||
| 5669 | } | ||
| 5670 | |||
| 5671 | \def\scanexp#1{% | ||
| 5672 | \edef\temp{\noexpand\scanmacro{#1}}% | ||
| 5673 | \temp | ||
| 5674 | } | ||
| 5675 | |||
| 5676 | \newcount\paramno % Count of parameters | ||
| 5677 | \newtoks\macname % Macro name | ||
| 5678 | \newif\ifrecursive % Is it recursive? | ||
| 5679 | |||
| 5680 | % List of all defined macros in the form | ||
| 5681 | % \definedummyword\macro1\definedummyword\macro2... | ||
| 5682 | % Currently is also contains all @aliases; the list can be split | ||
| 5683 | % if there is a need. | ||
| 5684 | \def\macrolist{} | ||
| 5685 | |||
| 5686 | % Add the macro to \macrolist | ||
| 5687 | \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname} | ||
| 5688 | \def\addtomacrolistxxx#1{% | ||
| 5689 | \toks0 = \expandafter{\macrolist\definedummyword#1}% | ||
| 5690 | \xdef\macrolist{\the\toks0}% | ||
| 5691 | } | ||
| 5692 | |||
| 5693 | % Utility routines. | ||
| 5694 | % This does \let #1 = #2, with \csnames; that is, | ||
| 5695 | % \let \csname#1\endcsname = \csname#2\endcsname | ||
| 5696 | % (except of course we have to play expansion games). | ||
| 5697 | % | ||
| 5698 | \def\cslet#1#2{% | ||
| 5699 | \expandafter\let | ||
| 5700 | \csname#1\expandafter\endcsname | ||
| 5701 | \csname#2\endcsname | ||
| 5702 | } | ||
| 5703 | |||
| 5704 | % Trim leading and trailing spaces off a string. | ||
| 5705 | % Concepts from aro-bend problem 15 (see CTAN). | ||
| 5706 | {\catcode`\@=11 | ||
| 5707 | \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} | ||
| 5708 | \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} | ||
| 5709 | \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} | ||
| 5710 | \def\unbrace#1{#1} | ||
| 5711 | \unbrace{\gdef\trim@@@ #1 } #2@{#1} | ||
| 5712 | } | ||
| 5713 | |||
| 5714 | % Trim a single trailing ^^M off a string. | ||
| 5715 | {\catcode`\^^M=\other \catcode`\Q=3% | ||
| 5716 | \gdef\eatcr #1{\eatcra #1Q^^MQ}% | ||
| 5717 | \gdef\eatcra#1^^MQ{\eatcrb#1Q}% | ||
| 5718 | \gdef\eatcrb#1Q#2Q{#1}% | ||
| 5719 | } | ||
| 5720 | |||
| 5721 | % Macro bodies are absorbed as an argument in a context where | ||
| 5722 | % all characters are catcode 10, 11 or 12, except \ which is active | ||
| 5723 | % (as in normal texinfo). It is necessary to change the definition of \. | ||
| 5724 | |||
| 5725 | % It's necessary to have hard CRs when the macro is executed. This is | ||
| 5726 | % done by making ^^M (\endlinechar) catcode 12 when reading the macro | ||
| 5727 | % body, and then making it the \newlinechar in \scanmacro. | ||
| 5728 | |||
| 5729 | \def\scanctxt{% | ||
| 5730 | \catcode`\"=\other | ||
| 5731 | \catcode`\+=\other | ||
| 5732 | \catcode`\<=\other | ||
| 5733 | \catcode`\>=\other | ||
| 5734 | \catcode`\@=\other | ||
| 5735 | \catcode`\^=\other | ||
| 5736 | \catcode`\_=\other | ||
| 5737 | \catcode`\|=\other | ||
| 5738 | \catcode`\~=\other | ||
| 5739 | } | ||
| 5740 | |||
| 5741 | \def\scanargctxt{% | ||
| 5742 | \scanctxt | ||
| 5743 | \catcode`\\=\other | ||
| 5744 | \catcode`\^^M=\other | ||
| 5745 | } | ||
| 5746 | |||
| 5747 | \def\macrobodyctxt{% | ||
| 5748 | \scanctxt | ||
| 5749 | \catcode`\{=\other | ||
| 5750 | \catcode`\}=\other | ||
| 5751 | \catcode`\^^M=\other | ||
| 5752 | \usembodybackslash | ||
| 5753 | } | ||
| 5754 | |||
| 5755 | \def\macroargctxt{% | ||
| 5756 | \scanctxt | ||
| 5757 | \catcode`\\=\other | ||
| 5758 | } | ||
| 5759 | |||
| 5760 | % \mbodybackslash is the definition of \ in @macro bodies. | ||
| 5761 | % It maps \foo\ => \csname macarg.foo\endcsname => #N | ||
| 5762 | % where N is the macro parameter number. | ||
| 5763 | % We define \csname macarg.\endcsname to be \realbackslash, so | ||
| 5764 | % \\ in macro replacement text gets you a backslash. | ||
| 5765 | |||
| 5766 | {\catcode`@=0 @catcode`@\=@active | ||
| 5767 | @gdef@usembodybackslash{@let\=@mbodybackslash} | ||
| 5768 | @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} | ||
| 5769 | } | ||
| 5770 | \expandafter\def\csname macarg.\endcsname{\realbackslash} | ||
| 5771 | |||
| 5772 | \def\macro{\recursivefalse\parsearg\macroxxx} | ||
| 5773 | \def\rmacro{\recursivetrue\parsearg\macroxxx} | ||
| 5774 | |||
| 5775 | \def\macroxxx#1{% | ||
| 5776 | \getargs{#1}% now \macname is the macname and \argl the arglist | ||
| 5777 | \ifx\argl\empty % no arguments | ||
| 5778 | \paramno=0% | ||
| 5779 | \else | ||
| 5780 | \expandafter\parsemargdef \argl;% | ||
| 5781 | \fi | ||
| 5782 | \if1\csname ismacro.\the\macname\endcsname | ||
| 5783 | \message{Warning: redefining \the\macname}% | ||
| 5784 | \else | ||
| 5785 | \expandafter\ifx\csname \the\macname\endcsname \relax | ||
| 5786 | \else \errmessage{Macro name \the\macname\space already defined}\fi | ||
| 5787 | \global\cslet{macsave.\the\macname}{\the\macname}% | ||
| 5788 | \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% | ||
| 5789 | \addtomacrolist{\the\macname}% | ||
| 5790 | \fi | ||
| 5791 | \begingroup \macrobodyctxt | ||
| 5792 | \ifrecursive \expandafter\parsermacbody | ||
| 5793 | \else \expandafter\parsemacbody | ||
| 5794 | \fi} | ||
| 5795 | |||
| 5796 | \parseargdef\unmacro{% | ||
| 5797 | \if1\csname ismacro.#1\endcsname | ||
| 5798 | \global\cslet{#1}{macsave.#1}% | ||
| 5799 | \global\expandafter\let \csname ismacro.#1\endcsname=0% | ||
| 5800 | % Remove the macro name from \macrolist: | ||
| 5801 | \begingroup | ||
| 5802 | \expandafter\let\csname#1\endcsname \relax | ||
| 5803 | \let\definedummyword\unmacrodo | ||
| 5804 | \xdef\macrolist{\macrolist}% | ||
| 5805 | \endgroup | ||
| 5806 | \else | ||
| 5807 | \errmessage{Macro #1 not defined}% | ||
| 5808 | \fi | ||
| 5809 | } | ||
| 5810 | |||
| 5811 | % Called by \do from \dounmacro on each macro. The idea is to omit any | ||
| 5812 | % macro definitions that have been changed to \relax. | ||
| 5813 | % | ||
| 5814 | \def\unmacrodo#1{% | ||
| 5815 | \ifx #1\relax | ||
| 5816 | % remove this | ||
| 5817 | \else | ||
| 5818 | \noexpand\definedummyword \noexpand#1% | ||
| 5819 | \fi | ||
| 5820 | } | ||
| 5821 | |||
| 5822 | % This makes use of the obscure feature that if the last token of a | ||
| 5823 | % <parameter list> is #, then the preceding argument is delimited by | ||
| 5824 | % an opening brace, and that opening brace is not consumed. | ||
| 5825 | \def\getargs#1{\getargsxxx#1{}} | ||
| 5826 | \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} | ||
| 5827 | \def\getmacname #1 #2\relax{\macname={#1}} | ||
| 5828 | \def\getmacargs#1{\def\argl{#1}} | ||
| 5829 | |||
| 5830 | % Parse the optional {params} list. Set up \paramno and \paramlist | ||
| 5831 | % so \defmacro knows what to do. Define \macarg.blah for each blah | ||
| 5832 | % in the params list, to be ##N where N is the position in that list. | ||
| 5833 | % That gets used by \mbodybackslash (above). | ||
| 5834 | |||
| 5835 | % We need to get `macro parameter char #' into several definitions. | ||
| 5836 | % The technique used is stolen from LaTeX: let \hash be something | ||
| 5837 | % unexpandable, insert that wherever you need a #, and then redefine | ||
| 5838 | % it to # just before using the token list produced. | ||
| 5839 | % | ||
| 5840 | % The same technique is used to protect \eatspaces till just before | ||
| 5841 | % the macro is used. | ||
| 5842 | |||
| 5843 | \def\parsemargdef#1;{\paramno=0\def\paramlist{}% | ||
| 5844 | \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} | ||
| 5845 | \def\parsemargdefxxx#1,{% | ||
| 5846 | \if#1;\let\next=\relax | ||
| 5847 | \else \let\next=\parsemargdefxxx | ||
| 5848 | \advance\paramno by 1% | ||
| 5849 | \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname | ||
| 5850 | {\xeatspaces{\hash\the\paramno}}% | ||
| 5851 | \edef\paramlist{\paramlist\hash\the\paramno,}% | ||
| 5852 | \fi\next} | ||
| 5853 | |||
| 5854 | % These two commands read recursive and nonrecursive macro bodies. | ||
| 5855 | % (They're different since rec and nonrec macros end differently.) | ||
| 5856 | |||
| 5857 | \long\def\parsemacbody#1@end macro% | ||
| 5858 | {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% | ||
| 5859 | \long\def\parsermacbody#1@end rmacro% | ||
| 5860 | {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% | ||
| 5861 | |||
| 5862 | % This defines the macro itself. There are six cases: recursive and | ||
| 5863 | % nonrecursive macros of zero, one, and many arguments. | ||
| 5864 | % Much magic with \expandafter here. | ||
| 5865 | % \xdef is used so that macro definitions will survive the file | ||
| 5866 | % they're defined in; @include reads the file inside a group. | ||
| 5867 | \def\defmacro{% | ||
| 5868 | \let\hash=##% convert placeholders to macro parameter chars | ||
| 5869 | \ifrecursive | ||
| 5870 | \ifcase\paramno | ||
| 5871 | % 0 | ||
| 5872 | \expandafter\xdef\csname\the\macname\endcsname{% | ||
| 5873 | \noexpand\scanmacro{\temp}}% | ||
| 5874 | \or % 1 | ||
| 5875 | \expandafter\xdef\csname\the\macname\endcsname{% | ||
| 5876 | \bgroup\noexpand\macroargctxt | ||
| 5877 | \noexpand\braceorline | ||
| 5878 | \expandafter\noexpand\csname\the\macname xxx\endcsname}% | ||
| 5879 | \expandafter\xdef\csname\the\macname xxx\endcsname##1{% | ||
| 5880 | \egroup\noexpand\scanmacro{\temp}}% | ||
| 5881 | \else % many | ||
| 5882 | \expandafter\xdef\csname\the\macname\endcsname{% | ||
| 5883 | \bgroup\noexpand\macroargctxt | ||
| 5884 | \noexpand\csname\the\macname xx\endcsname}% | ||
| 5885 | \expandafter\xdef\csname\the\macname xx\endcsname##1{% | ||
| 5886 | \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% | ||
| 5887 | \expandafter\expandafter | ||
| 5888 | \expandafter\xdef | ||
| 5889 | \expandafter\expandafter | ||
| 5890 | \csname\the\macname xxx\endcsname | ||
| 5891 | \paramlist{\egroup\noexpand\scanmacro{\temp}}% | ||
| 5892 | \fi | ||
| 5893 | \else | ||
| 5894 | \ifcase\paramno | ||
| 5895 | % 0 | ||
| 5896 | \expandafter\xdef\csname\the\macname\endcsname{% | ||
| 5897 | \noexpand\norecurse{\the\macname}% | ||
| 5898 | \noexpand\scanmacro{\temp}\egroup}% | ||
| 5899 | \or % 1 | ||
| 5900 | \expandafter\xdef\csname\the\macname\endcsname{% | ||
| 5901 | \bgroup\noexpand\macroargctxt | ||
| 5902 | \noexpand\braceorline | ||
| 5903 | \expandafter\noexpand\csname\the\macname xxx\endcsname}% | ||
| 5904 | \expandafter\xdef\csname\the\macname xxx\endcsname##1{% | ||
| 5905 | \egroup | ||
| 5906 | \noexpand\norecurse{\the\macname}% | ||
| 5907 | \noexpand\scanmacro{\temp}\egroup}% | ||
| 5908 | \else % many | ||
| 5909 | \expandafter\xdef\csname\the\macname\endcsname{% | ||
| 5910 | \bgroup\noexpand\macroargctxt | ||
| 5911 | \expandafter\noexpand\csname\the\macname xx\endcsname}% | ||
| 5912 | \expandafter\xdef\csname\the\macname xx\endcsname##1{% | ||
| 5913 | \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% | ||
| 5914 | \expandafter\expandafter | ||
| 5915 | \expandafter\xdef | ||
| 5916 | \expandafter\expandafter | ||
| 5917 | \csname\the\macname xxx\endcsname | ||
| 5918 | \paramlist{% | ||
| 5919 | \egroup | ||
| 5920 | \noexpand\norecurse{\the\macname}% | ||
| 5921 | \noexpand\scanmacro{\temp}\egroup}% | ||
| 5922 | \fi | ||
| 5923 | \fi} | ||
| 5924 | |||
| 5925 | \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} | ||
| 5926 | |||
| 5927 | % \braceorline decides whether the next nonwhitespace character is a | ||
| 5928 | % {. If so it reads up to the closing }, if not, it reads the whole | ||
| 5929 | % line. Whatever was read is then fed to the next control sequence | ||
| 5930 | % as an argument (by \parsebrace or \parsearg) | ||
| 5931 | \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx} | ||
| 5932 | \def\braceorlinexxx{% | ||
| 5933 | \ifx\nchar\bgroup\else | ||
| 5934 | \expandafter\parsearg | ||
| 5935 | \fi \next} | ||
| 5936 | |||
| 5937 | |||
| 5938 | % @alias. | ||
| 5939 | % We need some trickery to remove the optional spaces around the equal | ||
| 5940 | % sign. Just make them active and then expand them all to nothing. | ||
| 5941 | \def\alias{\parseargusing\obeyspaces\aliasxxx} | ||
| 5942 | \def\aliasxxx #1{\aliasyyy#1\relax} | ||
| 5943 | \def\aliasyyy #1=#2\relax{% | ||
| 5944 | {% | ||
| 5945 | \expandafter\let\obeyedspace=\empty | ||
| 5946 | \addtomacrolist{#1}% | ||
| 5947 | \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% | ||
| 5948 | }% | ||
| 5949 | \next | ||
| 5950 | } | ||
| 5951 | |||
| 5952 | |||
| 5953 | \message{cross references,} | ||
| 5954 | |||
| 5955 | \newwrite\auxfile | ||
| 5956 | |||
| 5957 | \newif\ifhavexrefs % True if xref values are known. | ||
| 5958 | \newif\ifwarnedxrefs % True if we warned once that they aren't known. | ||
| 5959 | |||
| 5960 | % @inforef is relatively simple. | ||
| 5961 | \def\inforef #1{\inforefzzz #1,,,,**} | ||
| 5962 | \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, | ||
| 5963 | node \samp{\ignorespaces#1{}}} | ||
| 5964 | |||
| 5965 | % @node's only job in TeX is to define \lastnode, which is used in | ||
| 5966 | % cross-references. The @node line might or might not have commas, and | ||
| 5967 | % might or might not have spaces before the first comma, like: | ||
| 5968 | % @node foo , bar , ... | ||
| 5969 | % We don't want such trailing spaces in the node name. | ||
| 5970 | % | ||
| 5971 | \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse} | ||
| 5972 | % | ||
| 5973 | % also remove a trailing comma, in case of something like this: | ||
| 5974 | % @node Help-Cross, , , Cross-refs | ||
| 5975 | \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse} | ||
| 5976 | \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}} | ||
| 5977 | |||
| 5978 | \let\nwnode=\node | ||
| 5979 | \let\lastnode=\empty | ||
| 5980 | |||
| 5981 | % Write a cross-reference definition for the current node. #1 is the | ||
| 5982 | % type (Ynumbered, Yappendix, Ynothing). | ||
| 5983 | % | ||
| 5984 | \def\donoderef#1{% | ||
| 5985 | \ifx\lastnode\empty\else | ||
| 5986 | \setref{\lastnode}{#1}% | ||
| 5987 | \global\let\lastnode=\empty | ||
| 5988 | \fi | ||
| 5989 | } | ||
| 5990 | |||
| 5991 | % @anchor{NAME} -- define xref target at arbitrary point. | ||
| 5992 | % | ||
| 5993 | \newcount\savesfregister | ||
| 5994 | % | ||
| 5995 | \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} | ||
| 5996 | \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} | ||
| 5997 | \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} | ||
| 5998 | |||
| 5999 | % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an | ||
| 6000 | % anchor), which consists of three parts: | ||
| 6001 | % 1) NAME-title - the current sectioning name taken from \thissection, | ||
| 6002 | % or the anchor name. | ||
| 6003 | % 2) NAME-snt - section number and type, passed as the SNT arg, or | ||
| 6004 | % empty for anchors. | ||
| 6005 | % 3) NAME-pg - the page number. | ||
| 6006 | % | ||
| 6007 | % This is called from \donoderef, \anchor, and \dofloat. In the case of | ||
| 6008 | % floats, there is an additional part, which is not written here: | ||
| 6009 | % 4) NAME-lof - the text as it should appear in a @listoffloats. | ||
| 6010 | % | ||
| 6011 | \def\setref#1#2{% | ||
| 6012 | \pdfmkdest{#1}% | ||
| 6013 | \iflinks | ||
| 6014 | {% | ||
| 6015 | \atdummies % preserve commands, but don't expand them | ||
| 6016 | \edef\writexrdef##1##2{% | ||
| 6017 | \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef | ||
| 6018 | ##1}{##2}}% these are parameters of \writexrdef | ||
| 6019 | }% | ||
| 6020 | \toks0 = \expandafter{\thissection}% | ||
| 6021 | \immediate \writexrdef{title}{\the\toks0 }% | ||
| 6022 | \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. | ||
| 6023 | \writexrdef{pg}{\folio}% will be written later, during \shipout | ||
| 6024 | }% | ||
| 6025 | \fi | ||
| 6026 | } | ||
| 6027 | |||
| 6028 | % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is | ||
| 6029 | % the node name, #2 the name of the Info cross-reference, #3 the printed | ||
| 6030 | % node name, #4 the name of the Info file, #5 the name of the printed | ||
| 6031 | % manual. All but the node name can be omitted. | ||
| 6032 | % | ||
| 6033 | \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} | ||
| 6034 | \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} | ||
| 6035 | \def\ref#1{\xrefX[#1,,,,,,,]} | ||
| 6036 | \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup | ||
| 6037 | \unsepspaces | ||
| 6038 | \def\printedmanual{\ignorespaces #5}% | ||
| 6039 | \def\printedrefname{\ignorespaces #3}% | ||
| 6040 | \setbox1=\hbox{\printedmanual\unskip}% | ||
| 6041 | \setbox0=\hbox{\printedrefname\unskip}% | ||
| 6042 | \ifdim \wd0 = 0pt | ||
| 6043 | % No printed node name was explicitly given. | ||
| 6044 | \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax | ||
| 6045 | % Use the node name inside the square brackets. | ||
| 6046 | \def\printedrefname{\ignorespaces #1}% | ||
| 6047 | \else | ||
| 6048 | % Use the actual chapter/section title appear inside | ||
| 6049 | % the square brackets. Use the real section title if we have it. | ||
| 6050 | \ifdim \wd1 > 0pt | ||
| 6051 | % It is in another manual, so we don't have it. | ||
| 6052 | \def\printedrefname{\ignorespaces #1}% | ||
| 6053 | \else | ||
| 6054 | \ifhavexrefs | ||
| 6055 | % We know the real title if we have the xref values. | ||
| 6056 | \def\printedrefname{\refx{#1-title}{}}% | ||
| 6057 | \else | ||
| 6058 | % Otherwise just copy the Info node name. | ||
| 6059 | \def\printedrefname{\ignorespaces #1}% | ||
| 6060 | \fi% | ||
| 6061 | \fi | ||
| 6062 | \fi | ||
| 6063 | \fi | ||
| 6064 | % | ||
| 6065 | % Make link in pdf output. | ||
| 6066 | \ifpdf | ||
| 6067 | \leavevmode | ||
| 6068 | \getfilename{#4}% | ||
| 6069 | {\turnoffactive | ||
| 6070 | % See comments at \activebackslashdouble. | ||
| 6071 | {\activebackslashdouble \xdef\pdfxrefdest{#1}% | ||
| 6072 | \backslashparens\pdfxrefdest}% | ||
| 6073 | % | ||
| 6074 | \ifnum\filenamelength>0 | ||
| 6075 | \startlink attr{/Border [0 0 0]}% | ||
| 6076 | goto file{\the\filename.pdf} name{\pdfxrefdest}% | ||
| 6077 | \else | ||
| 6078 | \startlink attr{/Border [0 0 0]}% | ||
| 6079 | goto name{\pdfmkpgn{\pdfxrefdest}}% | ||
| 6080 | \fi | ||
| 6081 | }% | ||
| 6082 | \linkcolor | ||
| 6083 | \fi | ||
| 6084 | % | ||
| 6085 | % Float references are printed completely differently: "Figure 1.2" | ||
| 6086 | % instead of "[somenode], p.3". We distinguish them by the | ||
| 6087 | % LABEL-title being set to a magic string. | ||
| 6088 | {% | ||
| 6089 | % Have to otherify everything special to allow the \csname to | ||
| 6090 | % include an _ in the xref name, etc. | ||
| 6091 | \indexnofonts | ||
| 6092 | \turnoffactive | ||
| 6093 | \expandafter\global\expandafter\let\expandafter\Xthisreftitle | ||
| 6094 | \csname XR#1-title\endcsname | ||
| 6095 | }% | ||
| 6096 | \iffloat\Xthisreftitle | ||
| 6097 | % If the user specified the print name (third arg) to the ref, | ||
| 6098 | % print it instead of our usual "Figure 1.2". | ||
| 6099 | \ifdim\wd0 = 0pt | ||
| 6100 | \refx{#1-snt}{}% | ||
| 6101 | \else | ||
| 6102 | \printedrefname | ||
| 6103 | \fi | ||
| 6104 | % | ||
| 6105 | % if the user also gave the printed manual name (fifth arg), append | ||
| 6106 | % "in MANUALNAME". | ||
| 6107 | \ifdim \wd1 > 0pt | ||
| 6108 | \space \putwordin{} \cite{\printedmanual}% | ||
| 6109 | \fi | ||
| 6110 | \else | ||
| 6111 | % node/anchor (non-float) references. | ||
| 6112 | % | ||
| 6113 | % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not | ||
| 6114 | % insert empty discretionaries after hyphens, which means that it will | ||
| 6115 | % not find a line break at a hyphen in a node names. Since some manuals | ||
| 6116 | % are best written with fairly long node names, containing hyphens, this | ||
| 6117 | % is a loss. Therefore, we give the text of the node name again, so it | ||
| 6118 | % is as if TeX is seeing it for the first time. | ||
| 6119 | \ifdim \wd1 > 0pt | ||
| 6120 | \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}% | ||
| 6121 | \else | ||
| 6122 | % _ (for example) has to be the character _ for the purposes of the | ||
| 6123 | % control sequence corresponding to the node, but it has to expand | ||
| 6124 | % into the usual \leavevmode...\vrule stuff for purposes of | ||
| 6125 | % printing. So we \turnoffactive for the \refx-snt, back on for the | ||
| 6126 | % printing, back off for the \refx-pg. | ||
| 6127 | {\turnoffactive | ||
| 6128 | % Only output a following space if the -snt ref is nonempty; for | ||
| 6129 | % @unnumbered and @anchor, it won't be. | ||
| 6130 | \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% | ||
| 6131 | \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi | ||
| 6132 | }% | ||
| 6133 | % output the `[mynode]' via a macro so it can be overridden. | ||
| 6134 | \xrefprintnodename\printedrefname | ||
| 6135 | % | ||
| 6136 | % But we always want a comma and a space: | ||
| 6137 | ,\space | ||
| 6138 | % | ||
| 6139 | % output the `page 3'. | ||
| 6140 | \turnoffactive \putwordpage\tie\refx{#1-pg}{}% | ||
| 6141 | \fi | ||
| 6142 | \fi | ||
| 6143 | \endlink | ||
| 6144 | \endgroup} | ||
| 6145 | |||
| 6146 | % This macro is called from \xrefX for the `[nodename]' part of xref | ||
| 6147 | % output. It's a separate macro only so it can be changed more easily, | ||
| 6148 | % since square brackets don't work well in some documents. Particularly | ||
| 6149 | % one that Bob is working on :). | ||
| 6150 | % | ||
| 6151 | \def\xrefprintnodename#1{[#1]} | ||
| 6152 | |||
| 6153 | % Things referred to by \setref. | ||
| 6154 | % | ||
| 6155 | \def\Ynothing{} | ||
| 6156 | \def\Yomitfromtoc{} | ||
| 6157 | \def\Ynumbered{% | ||
| 6158 | \ifnum\secno=0 | ||
| 6159 | \putwordChapter@tie \the\chapno | ||
| 6160 | \else \ifnum\subsecno=0 | ||
| 6161 | \putwordSection@tie \the\chapno.\the\secno | ||
| 6162 | \else \ifnum\subsubsecno=0 | ||
| 6163 | \putwordSection@tie \the\chapno.\the\secno.\the\subsecno | ||
| 6164 | \else | ||
| 6165 | \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno | ||
| 6166 | \fi\fi\fi | ||
| 6167 | } | ||
| 6168 | \def\Yappendix{% | ||
| 6169 | \ifnum\secno=0 | ||
| 6170 | \putwordAppendix@tie @char\the\appendixno{}% | ||
| 6171 | \else \ifnum\subsecno=0 | ||
| 6172 | \putwordSection@tie @char\the\appendixno.\the\secno | ||
| 6173 | \else \ifnum\subsubsecno=0 | ||
| 6174 | \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno | ||
| 6175 | \else | ||
| 6176 | \putwordSection@tie | ||
| 6177 | @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno | ||
| 6178 | \fi\fi\fi | ||
| 6179 | } | ||
| 6180 | |||
| 6181 | % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. | ||
| 6182 | % If its value is nonempty, SUFFIX is output afterward. | ||
| 6183 | % | ||
| 6184 | \def\refx#1#2{% | ||
| 6185 | {% | ||
| 6186 | \indexnofonts | ||
| 6187 | \otherbackslash | ||
| 6188 | \expandafter\global\expandafter\let\expandafter\thisrefX | ||
| 6189 | \csname XR#1\endcsname | ||
| 6190 | }% | ||
| 6191 | \ifx\thisrefX\relax | ||
| 6192 | % If not defined, say something at least. | ||
| 6193 | \angleleft un\-de\-fined\angleright | ||
| 6194 | \iflinks | ||
| 6195 | \ifhavexrefs | ||
| 6196 | \message{\linenumber Undefined cross reference `#1'.}% | ||
| 6197 | \else | ||
| 6198 | \ifwarnedxrefs\else | ||
| 6199 | \global\warnedxrefstrue | ||
| 6200 | \message{Cross reference values unknown; you must run TeX again.}% | ||
| 6201 | \fi | ||
| 6202 | \fi | ||
| 6203 | \fi | ||
| 6204 | \else | ||
| 6205 | % It's defined, so just use it. | ||
| 6206 | \thisrefX | ||
| 6207 | \fi | ||
| 6208 | #2% Output the suffix in any case. | ||
| 6209 | } | ||
| 6210 | |||
| 6211 | % This is the macro invoked by entries in the aux file. Usually it's | ||
| 6212 | % just a \def (we prepend XR to the control sequence name to avoid | ||
| 6213 | % collisions). But if this is a float type, we have more work to do. | ||
| 6214 | % | ||
| 6215 | \def\xrdef#1#2{% | ||
| 6216 | \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value. | ||
| 6217 | % | ||
| 6218 | % Was that xref control sequence that we just defined for a float? | ||
| 6219 | \expandafter\iffloat\csname XR#1\endcsname | ||
| 6220 | % it was a float, and we have the (safe) float type in \iffloattype. | ||
| 6221 | \expandafter\let\expandafter\floatlist | ||
| 6222 | \csname floatlist\iffloattype\endcsname | ||
| 6223 | % | ||
| 6224 | % Is this the first time we've seen this float type? | ||
| 6225 | \expandafter\ifx\floatlist\relax | ||
| 6226 | \toks0 = {\do}% yes, so just \do | ||
| 6227 | \else | ||
| 6228 | % had it before, so preserve previous elements in list. | ||
| 6229 | \toks0 = \expandafter{\floatlist\do}% | ||
| 6230 | \fi | ||
| 6231 | % | ||
| 6232 | % Remember this xref in the control sequence \floatlistFLOATTYPE, | ||
| 6233 | % for later use in \listoffloats. | ||
| 6234 | \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}% | ||
| 6235 | \fi | ||
| 6236 | } | ||
| 6237 | |||
| 6238 | % Read the last existing aux file, if any. No error if none exists. | ||
| 6239 | % | ||
| 6240 | \def\tryauxfile{% | ||
| 6241 | \openin 1 \jobname.aux | ||
| 6242 | \ifeof 1 \else | ||
| 6243 | \readdatafile{aux}% | ||
| 6244 | \global\havexrefstrue | ||
| 6245 | \fi | ||
| 6246 | \closein 1 | ||
| 6247 | } | ||
| 6248 | |||
| 6249 | \def\setupdatafile{% | ||
| 6250 | \catcode`\^^@=\other | ||
| 6251 | \catcode`\^^A=\other | ||
| 6252 | \catcode`\^^B=\other | ||
| 6253 | \catcode`\^^C=\other | ||
| 6254 | \catcode`\^^D=\other | ||
| 6255 | \catcode`\^^E=\other | ||
| 6256 | \catcode`\^^F=\other | ||
| 6257 | \catcode`\^^G=\other | ||
| 6258 | \catcode`\^^H=\other | ||
| 6259 | \catcode`\^^K=\other | ||
| 6260 | \catcode`\^^L=\other | ||
| 6261 | \catcode`\^^N=\other | ||
| 6262 | \catcode`\^^P=\other | ||
| 6263 | \catcode`\^^Q=\other | ||
| 6264 | \catcode`\^^R=\other | ||
| 6265 | \catcode`\^^S=\other | ||
| 6266 | \catcode`\^^T=\other | ||
| 6267 | \catcode`\^^U=\other | ||
| 6268 | \catcode`\^^V=\other | ||
| 6269 | \catcode`\^^W=\other | ||
| 6270 | \catcode`\^^X=\other | ||
| 6271 | \catcode`\^^Z=\other | ||
| 6272 | \catcode`\^^[=\other | ||
| 6273 | \catcode`\^^\=\other | ||
| 6274 | \catcode`\^^]=\other | ||
| 6275 | \catcode`\^^^=\other | ||
| 6276 | \catcode`\^^_=\other | ||
| 6277 | % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. | ||
| 6278 | % in xref tags, i.e., node names. But since ^^e4 notation isn't | ||
| 6279 | % supported in the main text, it doesn't seem desirable. Furthermore, | ||
| 6280 | % that is not enough: for node names that actually contain a ^ | ||
| 6281 | % character, we would end up writing a line like this: 'xrdef {'hat | ||
| 6282 | % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first | ||
| 6283 | % argument, and \hat is not an expandable control sequence. It could | ||
| 6284 | % all be worked out, but why? Either we support ^^ or we don't. | ||
| 6285 | % | ||
| 6286 | % The other change necessary for this was to define \auxhat: | ||
| 6287 | % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter | ||
| 6288 | % and then to call \auxhat in \setq. | ||
| 6289 | % | ||
| 6290 | \catcode`\^=\other | ||
| 6291 | % | ||
| 6292 | % Special characters. Should be turned off anyway, but... | ||
| 6293 | \catcode`\~=\other | ||
| 6294 | \catcode`\[=\other | ||
| 6295 | \catcode`\]=\other | ||
| 6296 | \catcode`\"=\other | ||
| 6297 | \catcode`\_=\other | ||
| 6298 | \catcode`\|=\other | ||
| 6299 | \catcode`\<=\other | ||
| 6300 | \catcode`\>=\other | ||
| 6301 | \catcode`\$=\other | ||
| 6302 | \catcode`\#=\other | ||
| 6303 | \catcode`\&=\other | ||
| 6304 | \catcode`\%=\other | ||
| 6305 | \catcode`+=\other % avoid \+ for paranoia even though we've turned it off | ||
| 6306 | % | ||
| 6307 | % This is to support \ in node names and titles, since the \ | ||
| 6308 | % characters end up in a \csname. It's easier than | ||
| 6309 | % leaving it active and making its active definition an actual \ | ||
| 6310 | % character. What I don't understand is why it works in the *value* | ||
| 6311 | % of the xrdef. Seems like it should be a catcode12 \, and that | ||
| 6312 | % should not typeset properly. But it works, so I'm moving on for | ||
| 6313 | % now. --karl, 15jan04. | ||
| 6314 | \catcode`\\=\other | ||
| 6315 | % | ||
| 6316 | % Make the characters 128-255 be printing characters. | ||
| 6317 | {% | ||
| 6318 | \count1=128 | ||
| 6319 | \def\loop{% | ||
| 6320 | \catcode\count1=\other | ||
| 6321 | \advance\count1 by 1 | ||
| 6322 | \ifnum \count1<256 \loop \fi | ||
| 6323 | }% | ||
| 6324 | }% | ||
| 6325 | % | ||
| 6326 | % @ is our escape character in .aux files, and we need braces. | ||
| 6327 | \catcode`\{=1 | ||
| 6328 | \catcode`\}=2 | ||
| 6329 | \catcode`\@=0 | ||
| 6330 | } | ||
| 6331 | |||
| 6332 | \def\readdatafile#1{% | ||
| 6333 | \begingroup | ||
| 6334 | \setupdatafile | ||
| 6335 | \input\jobname.#1 | ||
| 6336 | \endgroup} | ||
| 6337 | |||
| 6338 | \message{insertions,} | ||
| 6339 | % including footnotes. | ||
| 6340 | |||
| 6341 | \newcount \footnoteno | ||
| 6342 | |||
| 6343 | % The trailing space in the following definition for supereject is | ||
| 6344 | % vital for proper filling; pages come out unaligned when you do a | ||
| 6345 | % pagealignmacro call if that space before the closing brace is | ||
| 6346 | % removed. (Generally, numeric constants should always be followed by a | ||
| 6347 | % space to prevent strange expansion errors.) | ||
| 6348 | \def\supereject{\par\penalty -20000\footnoteno =0 } | ||
| 6349 | |||
| 6350 | % @footnotestyle is meaningful for info output only. | ||
| 6351 | \let\footnotestyle=\comment | ||
| 6352 | |||
| 6353 | {\catcode `\@=11 | ||
| 6354 | % | ||
| 6355 | % Auto-number footnotes. Otherwise like plain. | ||
| 6356 | \gdef\footnote{% | ||
| 6357 | \let\indent=\ptexindent | ||
| 6358 | \let\noindent=\ptexnoindent | ||
| 6359 | \global\advance\footnoteno by \@ne | ||
| 6360 | \edef\thisfootno{$^{\the\footnoteno}$}% | ||
| 6361 | % | ||
| 6362 | % In case the footnote comes at the end of a sentence, preserve the | ||
| 6363 | % extra spacing after we do the footnote number. | ||
| 6364 | \let\@sf\empty | ||
| 6365 | \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi | ||
| 6366 | % | ||
| 6367 | % Remove inadvertent blank space before typesetting the footnote number. | ||
| 6368 | \unskip | ||
| 6369 | \thisfootno\@sf | ||
| 6370 | \dofootnote | ||
| 6371 | }% | ||
| 6372 | |||
| 6373 | % Don't bother with the trickery in plain.tex to not require the | ||
| 6374 | % footnote text as a parameter. Our footnotes don't need to be so general. | ||
| 6375 | % | ||
| 6376 | % Oh yes, they do; otherwise, @ifset (and anything else that uses | ||
| 6377 | % \parseargline) fails inside footnotes because the tokens are fixed when | ||
| 6378 | % the footnote is read. --karl, 16nov96. | ||
| 6379 | % | ||
| 6380 | \gdef\dofootnote{% | ||
| 6381 | \insert\footins\bgroup | ||
| 6382 | % We want to typeset this text as a normal paragraph, even if the | ||
| 6383 | % footnote reference occurs in (for example) a display environment. | ||
| 6384 | % So reset some parameters. | ||
| 6385 | \hsize=\pagewidth | ||
| 6386 | \interlinepenalty\interfootnotelinepenalty | ||
| 6387 | \splittopskip\ht\strutbox % top baseline for broken footnotes | ||
| 6388 | \splitmaxdepth\dp\strutbox | ||
| 6389 | \floatingpenalty\@MM | ||
| 6390 | \leftskip\z@skip | ||
| 6391 | \rightskip\z@skip | ||
| 6392 | \spaceskip\z@skip | ||
| 6393 | \xspaceskip\z@skip | ||
| 6394 | \parindent\defaultparindent | ||
| 6395 | % | ||
| 6396 | \smallfonts \rm | ||
| 6397 | % | ||
| 6398 | % Because we use hanging indentation in footnotes, a @noindent appears | ||
| 6399 | % to exdent this text, so make it be a no-op. makeinfo does not use | ||
| 6400 | % hanging indentation so @noindent can still be needed within footnote | ||
| 6401 | % text after an @example or the like (not that this is good style). | ||
| 6402 | \let\noindent = \relax | ||
| 6403 | % | ||
| 6404 | % Hang the footnote text off the number. Use \everypar in case the | ||
| 6405 | % footnote extends for more than one paragraph. | ||
| 6406 | \everypar = {\hang}% | ||
| 6407 | \textindent{\thisfootno}% | ||
| 6408 | % | ||
| 6409 | % Don't crash into the line above the footnote text. Since this | ||
| 6410 | % expands into a box, it must come within the paragraph, lest it | ||
| 6411 | % provide a place where TeX can split the footnote. | ||
| 6412 | \footstrut | ||
| 6413 | \futurelet\next\fo@t | ||
| 6414 | } | ||
| 6415 | }%end \catcode `\@=11 | ||
| 6416 | |||
| 6417 | % In case a @footnote appears in a vbox, save the footnote text and create | ||
| 6418 | % the real \insert just after the vbox finished. Otherwise, the insertion | ||
| 6419 | % would be lost. | ||
| 6420 | % Similarily, if a @footnote appears inside an alignment, save the footnote | ||
| 6421 | % text to a box and make the \insert when a row of the table is finished. | ||
| 6422 | % And the same can be done for other insert classes. --kasal, 16nov03. | ||
| 6423 | |||
| 6424 | % Replace the \insert primitive by a cheating macro. | ||
| 6425 | % Deeper inside, just make sure that the saved insertions are not spilled | ||
| 6426 | % out prematurely. | ||
| 6427 | % | ||
| 6428 | \def\startsavinginserts{% | ||
| 6429 | \ifx \insert\ptexinsert | ||
| 6430 | \let\insert\saveinsert | ||
| 6431 | \else | ||
| 6432 | \let\checkinserts\relax | ||
| 6433 | \fi | ||
| 6434 | } | ||
| 6435 | |||
| 6436 | % This \insert replacement works for both \insert\footins{foo} and | ||
| 6437 | % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. | ||
| 6438 | % | ||
| 6439 | \def\saveinsert#1{% | ||
| 6440 | \edef\next{\noexpand\savetobox \makeSAVEname#1}% | ||
| 6441 | \afterassignment\next | ||
| 6442 | % swallow the left brace | ||
| 6443 | \let\temp = | ||
| 6444 | } | ||
| 6445 | \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} | ||
| 6446 | \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} | ||
| 6447 | |||
| 6448 | \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} | ||
| 6449 | |||
| 6450 | \def\placesaveins#1{% | ||
| 6451 | \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname | ||
| 6452 | {\box#1}% | ||
| 6453 | } | ||
| 6454 | |||
| 6455 | % eat @SAVE -- beware, all of them have catcode \other: | ||
| 6456 | { | ||
| 6457 | \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) | ||
| 6458 | \gdef\gobblesave @SAVE{} | ||
| 6459 | } | ||
| 6460 | |||
| 6461 | % initialization: | ||
| 6462 | \def\newsaveins #1{% | ||
| 6463 | \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% | ||
| 6464 | \next | ||
| 6465 | } | ||
| 6466 | \def\newsaveinsX #1{% | ||
| 6467 | \csname newbox\endcsname #1% | ||
| 6468 | \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts | ||
| 6469 | \checksaveins #1}% | ||
| 6470 | } | ||
| 6471 | |||
| 6472 | % initialize: | ||
| 6473 | \let\checkinserts\empty | ||
| 6474 | \newsaveins\footins | ||
| 6475 | \newsaveins\margin | ||
| 6476 | |||
| 6477 | |||
| 6478 | % @image. We use the macros from epsf.tex to support this. | ||
| 6479 | % If epsf.tex is not installed and @image is used, we complain. | ||
| 6480 | % | ||
| 6481 | % Check for and read epsf.tex up front. If we read it only at @image | ||
| 6482 | % time, we might be inside a group, and then its definitions would get | ||
| 6483 | % undone and the next image would fail. | ||
| 6484 | \openin 1 = epsf.tex | ||
| 6485 | \ifeof 1 \else | ||
| 6486 | % Do not bother showing banner with epsf.tex v2.7k (available in | ||
| 6487 | % doc/epsf.tex and on ctan). | ||
| 6488 | \def\epsfannounce{\toks0 = }% | ||
| 6489 | \input epsf.tex | ||
| 6490 | \fi | ||
| 6491 | \closein 1 | ||
| 6492 | % | ||
| 6493 | % We will only complain once about lack of epsf.tex. | ||
| 6494 | \newif\ifwarnednoepsf | ||
| 6495 | \newhelp\noepsfhelp{epsf.tex must be installed for images to | ||
| 6496 | work. It is also included in the Texinfo distribution, or you can get | ||
| 6497 | it from ftp://tug.org/tex/epsf.tex.} | ||
| 6498 | % | ||
| 6499 | \def\image#1{% | ||
| 6500 | \ifx\epsfbox\undefined | ||
| 6501 | \ifwarnednoepsf \else | ||
| 6502 | \errhelp = \noepsfhelp | ||
| 6503 | \errmessage{epsf.tex not found, images will be ignored}% | ||
| 6504 | \global\warnednoepsftrue | ||
| 6505 | \fi | ||
| 6506 | \else | ||
| 6507 | \imagexxx #1,,,,,\finish | ||
| 6508 | \fi | ||
| 6509 | } | ||
| 6510 | % | ||
| 6511 | % Arguments to @image: | ||
| 6512 | % #1 is (mandatory) image filename; we tack on .eps extension. | ||
| 6513 | % #2 is (optional) width, #3 is (optional) height. | ||
| 6514 | % #4 is (ignored optional) html alt text. | ||
| 6515 | % #5 is (ignored optional) extension. | ||
| 6516 | % #6 is just the usual extra ignored arg for parsing this stuff. | ||
| 6517 | \newif\ifimagevmode | ||
| 6518 | \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup | ||
| 6519 | \catcode`\^^M = 5 % in case we're inside an example | ||
| 6520 | \normalturnoffactive % allow _ et al. in names | ||
| 6521 | % If the image is by itself, center it. | ||
| 6522 | \ifvmode | ||
| 6523 | \imagevmodetrue | ||
| 6524 | \nobreak\bigskip | ||
| 6525 | % Usually we'll have text after the image which will insert | ||
| 6526 | % \parskip glue, so insert it here too to equalize the space | ||
| 6527 | % above and below. | ||
| 6528 | \nobreak\vskip\parskip | ||
| 6529 | \nobreak | ||
| 6530 | \line\bgroup | ||
| 6531 | \fi | ||
| 6532 | % | ||
| 6533 | % Output the image. | ||
| 6534 | \ifpdf | ||
| 6535 | \dopdfimage{#1}{#2}{#3}% | ||
| 6536 | \else | ||
| 6537 | % \epsfbox itself resets \epsf?size at each figure. | ||
| 6538 | \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi | ||
| 6539 | \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi | ||
| 6540 | \epsfbox{#1.eps}% | ||
| 6541 | \fi | ||
| 6542 | % | ||
| 6543 | \ifimagevmode \egroup \bigbreak \fi % space after the image | ||
| 6544 | \endgroup} | ||
| 6545 | |||
| 6546 | |||
| 6547 | % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables, | ||
| 6548 | % etc. We don't actually implement floating yet, we always include the | ||
| 6549 | % float "here". But it seemed the best name for the future. | ||
| 6550 | % | ||
| 6551 | \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish} | ||
| 6552 | |||
| 6553 | % There may be a space before second and/or third parameter; delete it. | ||
| 6554 | \def\eatcommaspace#1, {#1,} | ||
| 6555 | |||
| 6556 | % #1 is the optional FLOATTYPE, the text label for this float, typically | ||
| 6557 | % "Figure", "Table", "Example", etc. Can't contain commas. If omitted, | ||
| 6558 | % this float will not be numbered and cannot be referred to. | ||
| 6559 | % | ||
| 6560 | % #2 is the optional xref label. Also must be present for the float to | ||
| 6561 | % be referable. | ||
| 6562 | % | ||
| 6563 | % #3 is the optional positioning argument; for now, it is ignored. It | ||
| 6564 | % will somehow specify the positions allowed to float to (here, top, bottom). | ||
| 6565 | % | ||
| 6566 | % We keep a separate counter for each FLOATTYPE, which we reset at each | ||
| 6567 | % chapter-level command. | ||
| 6568 | \let\resetallfloatnos=\empty | ||
| 6569 | % | ||
| 6570 | \def\dofloat#1,#2,#3,#4\finish{% | ||
| 6571 | \let\thiscaption=\empty | ||
| 6572 | \let\thisshortcaption=\empty | ||
| 6573 | % | ||
| 6574 | % don't lose footnotes inside @float. | ||
| 6575 | % | ||
| 6576 | % BEWARE: when the floats start float, we have to issue warning whenever an | ||
| 6577 | % insert appears inside a float which could possibly float. --kasal, 26may04 | ||
| 6578 | % | ||
| 6579 | \startsavinginserts | ||
| 6580 | % | ||
| 6581 | % We can't be used inside a paragraph. | ||
| 6582 | \par | ||
| 6583 | % | ||
| 6584 | \vtop\bgroup | ||
| 6585 | \def\floattype{#1}% | ||
| 6586 | \def\floatlabel{#2}% | ||
| 6587 | \def\floatloc{#3}% we do nothing with this yet. | ||
| 6588 | % | ||
| 6589 | \ifx\floattype\empty | ||
| 6590 | \let\safefloattype=\empty | ||
| 6591 | \else | ||
| 6592 | {% | ||
| 6593 | % the floattype might have accents or other special characters, | ||
| 6594 | % but we need to use it in a control sequence name. | ||
| 6595 | \indexnofonts | ||
| 6596 | \turnoffactive | ||
| 6597 | \xdef\safefloattype{\floattype}% | ||
| 6598 | }% | ||
| 6599 | \fi | ||
| 6600 | % | ||
| 6601 | % If label is given but no type, we handle that as the empty type. | ||
| 6602 | \ifx\floatlabel\empty \else | ||
| 6603 | % We want each FLOATTYPE to be numbered separately (Figure 1, | ||
| 6604 | % Table 1, Figure 2, ...). (And if no label, no number.) | ||
| 6605 | % | ||
| 6606 | \expandafter\getfloatno\csname\safefloattype floatno\endcsname | ||
| 6607 | \global\advance\floatno by 1 | ||
| 6608 | % | ||
| 6609 | {% | ||
| 6610 | % This magic value for \thissection is output by \setref as the | ||
| 6611 | % XREFLABEL-title value. \xrefX uses it to distinguish float | ||
| 6612 | % labels (which have a completely different output format) from | ||
| 6613 | % node and anchor labels. And \xrdef uses it to construct the | ||
| 6614 | % lists of floats. | ||
| 6615 | % | ||
| 6616 | \edef\thissection{\floatmagic=\safefloattype}% | ||
| 6617 | \setref{\floatlabel}{Yfloat}% | ||
| 6618 | }% | ||
| 6619 | \fi | ||
| 6620 | % | ||
| 6621 | % start with \parskip glue, I guess. | ||
| 6622 | \vskip\parskip | ||
| 6623 | % | ||
| 6624 | % Don't suppress indentation if a float happens to start a section. | ||
| 6625 | \restorefirstparagraphindent | ||
| 6626 | } | ||
| 6627 | |||
| 6628 | % we have these possibilities: | ||
| 6629 | % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap | ||
| 6630 | % @float Foo,lbl & no caption: Foo 1.1 | ||
| 6631 | % @float Foo & @caption{Cap}: Foo: Cap | ||
| 6632 | % @float Foo & no caption: Foo | ||
| 6633 | % @float ,lbl & Caption{Cap}: 1.1: Cap | ||
| 6634 | % @float ,lbl & no caption: 1.1 | ||
| 6635 | % @float & @caption{Cap}: Cap | ||
| 6636 | % @float & no caption: | ||
| 6637 | % | ||
| 6638 | \def\Efloat{% | ||
| 6639 | \let\floatident = \empty | ||
| 6640 | % | ||
| 6641 | % In all cases, if we have a float type, it comes first. | ||
| 6642 | \ifx\floattype\empty \else \def\floatident{\floattype}\fi | ||
| 6643 | % | ||
| 6644 | % If we have an xref label, the number comes next. | ||
| 6645 | \ifx\floatlabel\empty \else | ||
| 6646 | \ifx\floattype\empty \else % if also had float type, need tie first. | ||
| 6647 | \appendtomacro\floatident{\tie}% | ||
| 6648 | \fi | ||
| 6649 | % the number. | ||
| 6650 | \appendtomacro\floatident{\chaplevelprefix\the\floatno}% | ||
| 6651 | \fi | ||
| 6652 | % | ||
| 6653 | % Start the printed caption with what we've constructed in | ||
| 6654 | % \floatident, but keep it separate; we need \floatident again. | ||
| 6655 | \let\captionline = \floatident | ||
| 6656 | % | ||
| 6657 | \ifx\thiscaption\empty \else | ||
| 6658 | \ifx\floatident\empty \else | ||
| 6659 | \appendtomacro\captionline{: }% had ident, so need a colon between | ||
| 6660 | \fi | ||
| 6661 | % | ||
| 6662 | % caption text. | ||
| 6663 | \appendtomacro\captionline{\scanexp\thiscaption}% | ||
| 6664 | \fi | ||
| 6665 | % | ||
| 6666 | % If we have anything to print, print it, with space before. | ||
| 6667 | % Eventually this needs to become an \insert. | ||
| 6668 | \ifx\captionline\empty \else | ||
| 6669 | \vskip.5\parskip | ||
| 6670 | \captionline | ||
| 6671 | % | ||
| 6672 | % Space below caption. | ||
| 6673 | \vskip\parskip | ||
| 6674 | \fi | ||
| 6675 | % | ||
| 6676 | % If have an xref label, write the list of floats info. Do this | ||
| 6677 | % after the caption, to avoid chance of it being a breakpoint. | ||
| 6678 | \ifx\floatlabel\empty \else | ||
| 6679 | % Write the text that goes in the lof to the aux file as | ||
| 6680 | % \floatlabel-lof. Besides \floatident, we include the short | ||
| 6681 | % caption if specified, else the full caption if specified, else nothing. | ||
| 6682 | {% | ||
| 6683 | \atdummies | ||
| 6684 | % | ||
| 6685 | % since we read the caption text in the macro world, where ^^M | ||
| 6686 | % is turned into a normal character, we have to scan it back, so | ||
| 6687 | % we don't write the literal three characters "^^M" into the aux file. | ||
| 6688 | \scanexp{% | ||
| 6689 | \xdef\noexpand\gtemp{% | ||
| 6690 | \ifx\thisshortcaption\empty | ||
| 6691 | \thiscaption | ||
| 6692 | \else | ||
| 6693 | \thisshortcaption | ||
| 6694 | \fi | ||
| 6695 | }% | ||
| 6696 | }% | ||
| 6697 | \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident | ||
| 6698 | \ifx\gtemp\empty \else : \gtemp \fi}}% | ||
| 6699 | }% | ||
| 6700 | \fi | ||
| 6701 | \egroup % end of \vtop | ||
| 6702 | % | ||
| 6703 | % place the captured inserts | ||
| 6704 | % | ||
| 6705 | % BEWARE: when the floats start floating, we have to issue warning | ||
| 6706 | % whenever an insert appears inside a float which could possibly | ||
| 6707 | % float. --kasal, 26may04 | ||
| 6708 | % | ||
| 6709 | \checkinserts | ||
| 6710 | } | ||
| 6711 | |||
| 6712 | % Append the tokens #2 to the definition of macro #1, not expanding either. | ||
| 6713 | % | ||
| 6714 | \def\appendtomacro#1#2{% | ||
| 6715 | \expandafter\def\expandafter#1\expandafter{#1#2}% | ||
| 6716 | } | ||
| 6717 | |||
| 6718 | % @caption, @shortcaption | ||
| 6719 | % | ||
| 6720 | \def\caption{\docaption\thiscaption} | ||
| 6721 | \def\shortcaption{\docaption\thisshortcaption} | ||
| 6722 | \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption} | ||
| 6723 | \def\defcaption#1#2{\egroup \def#1{#2}} | ||
| 6724 | |||
| 6725 | % The parameter is the control sequence identifying the counter we are | ||
| 6726 | % going to use. Create it if it doesn't exist and assign it to \floatno. | ||
| 6727 | \def\getfloatno#1{% | ||
| 6728 | \ifx#1\relax | ||
| 6729 | % Haven't seen this figure type before. | ||
| 6730 | \csname newcount\endcsname #1% | ||
| 6731 | % | ||
| 6732 | % Remember to reset this floatno at the next chap. | ||
| 6733 | \expandafter\gdef\expandafter\resetallfloatnos | ||
| 6734 | \expandafter{\resetallfloatnos #1=0 }% | ||
| 6735 | \fi | ||
| 6736 | \let\floatno#1% | ||
| 6737 | } | ||
| 6738 | |||
| 6739 | % \setref calls this to get the XREFLABEL-snt value. We want an @xref | ||
| 6740 | % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we | ||
| 6741 | % first read the @float command. | ||
| 6742 | % | ||
| 6743 | \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% | ||
| 6744 | |||
| 6745 | % Magic string used for the XREFLABEL-title value, so \xrefX can | ||
| 6746 | % distinguish floats from other xref types. | ||
| 6747 | \def\floatmagic{!!float!!} | ||
| 6748 | |||
| 6749 | % #1 is the control sequence we are passed; we expand into a conditional | ||
| 6750 | % which is true if #1 represents a float ref. That is, the magic | ||
| 6751 | % \thissection value which we \setref above. | ||
| 6752 | % | ||
| 6753 | \def\iffloat#1{\expandafter\doiffloat#1==\finish} | ||
| 6754 | % | ||
| 6755 | % #1 is (maybe) the \floatmagic string. If so, #2 will be the | ||
| 6756 | % (safe) float type for this float. We set \iffloattype to #2. | ||
| 6757 | % | ||
| 6758 | \def\doiffloat#1=#2=#3\finish{% | ||
| 6759 | \def\temp{#1}% | ||
| 6760 | \def\iffloattype{#2}% | ||
| 6761 | \ifx\temp\floatmagic | ||
| 6762 | } | ||
| 6763 | |||
| 6764 | % @listoffloats FLOATTYPE - print a list of floats like a table of contents. | ||
| 6765 | % | ||
| 6766 | \parseargdef\listoffloats{% | ||
| 6767 | \def\floattype{#1}% floattype | ||
| 6768 | {% | ||
| 6769 | % the floattype might have accents or other special characters, | ||
| 6770 | % but we need to use it in a control sequence name. | ||
| 6771 | \indexnofonts | ||
| 6772 | \turnoffactive | ||
| 6773 | \xdef\safefloattype{\floattype}% | ||
| 6774 | }% | ||
| 6775 | % | ||
| 6776 | % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. | ||
| 6777 | \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax | ||
| 6778 | \ifhavexrefs | ||
| 6779 | % if the user said @listoffloats foo but never @float foo. | ||
| 6780 | \message{\linenumber No `\safefloattype' floats to list.}% | ||
| 6781 | \fi | ||
| 6782 | \else | ||
| 6783 | \begingroup | ||
| 6784 | \leftskip=\tocindent % indent these entries like a toc | ||
| 6785 | \let\do=\listoffloatsdo | ||
| 6786 | \csname floatlist\safefloattype\endcsname | ||
| 6787 | \endgroup | ||
| 6788 | \fi | ||
| 6789 | } | ||
| 6790 | |||
| 6791 | % This is called on each entry in a list of floats. We're passed the | ||
| 6792 | % xref label, in the form LABEL-title, which is how we save it in the | ||
| 6793 | % aux file. We strip off the -title and look up \XRLABEL-lof, which | ||
| 6794 | % has the text we're supposed to typeset here. | ||
| 6795 | % | ||
| 6796 | % Figures without xref labels will not be included in the list (since | ||
| 6797 | % they won't appear in the aux file). | ||
| 6798 | % | ||
| 6799 | \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} | ||
| 6800 | \def\listoffloatsdoentry#1-title\finish{{% | ||
| 6801 | % Can't fully expand XR#1-lof because it can contain anything. Just | ||
| 6802 | % pass the control sequence. On the other hand, XR#1-pg is just the | ||
| 6803 | % page number, and we want to fully expand that so we can get a link | ||
| 6804 | % in pdf output. | ||
| 6805 | \toksA = \expandafter{\csname XR#1-lof\endcsname}% | ||
| 6806 | % | ||
| 6807 | % use the same \entry macro we use to generate the TOC and index. | ||
| 6808 | \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}% | ||
| 6809 | \writeentry | ||
| 6810 | }} | ||
| 6811 | |||
| 6812 | \message{localization,} | ||
| 6813 | % and i18n. | ||
| 6814 | |||
| 6815 | % @documentlanguage is usually given very early, just after | ||
| 6816 | % @setfilename. If done too late, it may not override everything | ||
| 6817 | % properly. Single argument is the language abbreviation. | ||
| 6818 | % It would be nice if we could set up a hyphenation file here. | ||
| 6819 | % | ||
| 6820 | \parseargdef\documentlanguage{% | ||
| 6821 | \tex % read txi-??.tex file in plain TeX. | ||
| 6822 | % Read the file if it exists. | ||
| 6823 | \openin 1 txi-#1.tex | ||
| 6824 | \ifeof 1 | ||
| 6825 | \errhelp = \nolanghelp | ||
| 6826 | \errmessage{Cannot read language file txi-#1.tex}% | ||
| 6827 | \else | ||
| 6828 | \input txi-#1.tex | ||
| 6829 | \fi | ||
| 6830 | \closein 1 | ||
| 6831 | \endgroup | ||
| 6832 | } | ||
| 6833 | \newhelp\nolanghelp{The given language definition file cannot be found or | ||
| 6834 | is empty. Maybe you need to install it? In the current directory | ||
| 6835 | should work if nowhere else does.} | ||
| 6836 | |||
| 6837 | |||
| 6838 | % @documentencoding should change something in TeX eventually, most | ||
| 6839 | % likely, but for now just recognize it. | ||
| 6840 | \let\documentencoding = \comment | ||
| 6841 | |||
| 6842 | |||
| 6843 | % Page size parameters. | ||
| 6844 | % | ||
| 6845 | \newdimen\defaultparindent \defaultparindent = 15pt | ||
| 6846 | |||
| 6847 | \chapheadingskip = 15pt plus 4pt minus 2pt | ||
| 6848 | \secheadingskip = 12pt plus 3pt minus 2pt | ||
| 6849 | \subsecheadingskip = 9pt plus 2pt minus 2pt | ||
| 6850 | |||
| 6851 | % Prevent underfull vbox error messages. | ||
| 6852 | \vbadness = 10000 | ||
| 6853 | |||
| 6854 | % Don't be so finicky about underfull hboxes, either. | ||
| 6855 | \hbadness = 2000 | ||
| 6856 | |||
| 6857 | % Following George Bush, just get rid of widows and orphans. | ||
| 6858 | \widowpenalty=10000 | ||
| 6859 | \clubpenalty=10000 | ||
| 6860 | |||
| 6861 | % Use TeX 3.0's \emergencystretch to help line breaking, but if we're | ||
| 6862 | % using an old version of TeX, don't do anything. We want the amount of | ||
| 6863 | % stretch added to depend on the line length, hence the dependence on | ||
| 6864 | % \hsize. We call this whenever the paper size is set. | ||
| 6865 | % | ||
| 6866 | \def\setemergencystretch{% | ||
| 6867 | \ifx\emergencystretch\thisisundefined | ||
| 6868 | % Allow us to assign to \emergencystretch anyway. | ||
| 6869 | \def\emergencystretch{\dimen0}% | ||
| 6870 | \else | ||
| 6871 | \emergencystretch = .15\hsize | ||
| 6872 | \fi | ||
| 6873 | } | ||
| 6874 | |||
| 6875 | % Parameters in order: 1) textheight; 2) textwidth; | ||
| 6876 | % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip; | ||
| 6877 | % 7) physical page height; 8) physical page width. | ||
| 6878 | % | ||
| 6879 | % We also call \setleading{\textleading}, so the caller should define | ||
| 6880 | % \textleading. The caller should also set \parskip. | ||
| 6881 | % | ||
| 6882 | \def\internalpagesizes#1#2#3#4#5#6#7#8{% | ||
| 6883 | \voffset = #3\relax | ||
| 6884 | \topskip = #6\relax | ||
| 6885 | \splittopskip = \topskip | ||
| 6886 | % | ||
| 6887 | \vsize = #1\relax | ||
| 6888 | \advance\vsize by \topskip | ||
| 6889 | \outervsize = \vsize | ||
| 6890 | \advance\outervsize by 2\topandbottommargin | ||
| 6891 | \pageheight = \vsize | ||
| 6892 | % | ||
| 6893 | \hsize = #2\relax | ||
| 6894 | \outerhsize = \hsize | ||
| 6895 | \advance\outerhsize by 0.5in | ||
| 6896 | \pagewidth = \hsize | ||
| 6897 | % | ||
| 6898 | \normaloffset = #4\relax | ||
| 6899 | \bindingoffset = #5\relax | ||
| 6900 | % | ||
| 6901 | \ifpdf | ||
| 6902 | \pdfpageheight #7\relax | ||
| 6903 | \pdfpagewidth #8\relax | ||
| 6904 | \fi | ||
| 6905 | % | ||
| 6906 | \setleading{\textleading} | ||
| 6907 | % | ||
| 6908 | \parindent = \defaultparindent | ||
| 6909 | \setemergencystretch | ||
| 6910 | } | ||
| 6911 | |||
| 6912 | % @letterpaper (the default). | ||
| 6913 | \def\letterpaper{{\globaldefs = 1 | ||
| 6914 | \parskip = 3pt plus 2pt minus 1pt | ||
| 6915 | \textleading = 13.2pt | ||
| 6916 | % | ||
| 6917 | % If page is nothing but text, make it come out even. | ||
| 6918 | \internalpagesizes{46\baselineskip}{6in}% | ||
| 6919 | {\voffset}{.25in}% | ||
| 6920 | {\bindingoffset}{36pt}% | ||
| 6921 | {11in}{8.5in}% | ||
| 6922 | }} | ||
| 6923 | |||
| 6924 | % Use @smallbook to reset parameters for 7x9.25 trim size. | ||
| 6925 | \def\smallbook{{\globaldefs = 1 | ||
| 6926 | \parskip = 2pt plus 1pt | ||
| 6927 | \textleading = 12pt | ||
| 6928 | % | ||
| 6929 | \internalpagesizes{7.5in}{5in}% | ||
| 6930 | {\voffset}{.25in}% | ||
| 6931 | {\bindingoffset}{16pt}% | ||
| 6932 | {9.25in}{7in}% | ||
| 6933 | % | ||
| 6934 | \lispnarrowing = 0.3in | ||
| 6935 | \tolerance = 700 | ||
| 6936 | \hfuzz = 1pt | ||
| 6937 | \contentsrightmargin = 0pt | ||
| 6938 | \defbodyindent = .5cm | ||
| 6939 | }} | ||
| 6940 | |||
| 6941 | % Use @smallerbook to reset parameters for 6x9 trim size. | ||
| 6942 | % (Just testing, parameters still in flux.) | ||
| 6943 | \def\smallerbook{{\globaldefs = 1 | ||
| 6944 | \parskip = 1.5pt plus 1pt | ||
| 6945 | \textleading = 12pt | ||
| 6946 | % | ||
| 6947 | \internalpagesizes{7.4in}{4.8in}% | ||
| 6948 | {-.2in}{-.4in}% | ||
| 6949 | {0pt}{14pt}% | ||
| 6950 | {9in}{6in}% | ||
| 6951 | % | ||
| 6952 | \lispnarrowing = 0.25in | ||
| 6953 | \tolerance = 700 | ||
| 6954 | \hfuzz = 1pt | ||
| 6955 | \contentsrightmargin = 0pt | ||
| 6956 | \defbodyindent = .4cm | ||
| 6957 | }} | ||
| 6958 | |||
| 6959 | % Use @afourpaper to print on European A4 paper. | ||
| 6960 | \def\afourpaper{{\globaldefs = 1 | ||
| 6961 | \parskip = 3pt plus 2pt minus 1pt | ||
| 6962 | \textleading = 13.2pt | ||
| 6963 | % | ||
| 6964 | % Double-side printing via postscript on Laserjet 4050 | ||
| 6965 | % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. | ||
| 6966 | % To change the settings for a different printer or situation, adjust | ||
| 6967 | % \normaloffset until the front-side and back-side texts align. Then | ||
| 6968 | % do the same for \bindingoffset. You can set these for testing in | ||
| 6969 | % your texinfo source file like this: | ||
| 6970 | % @tex | ||
| 6971 | % \global\normaloffset = -6mm | ||
| 6972 | % \global\bindingoffset = 10mm | ||
| 6973 | % @end tex | ||
| 6974 | \internalpagesizes{51\baselineskip}{160mm} | ||
| 6975 | {\voffset}{\hoffset}% | ||
| 6976 | {\bindingoffset}{44pt}% | ||
| 6977 | {297mm}{210mm}% | ||
| 6978 | % | ||
| 6979 | \tolerance = 700 | ||
| 6980 | \hfuzz = 1pt | ||
| 6981 | \contentsrightmargin = 0pt | ||
| 6982 | \defbodyindent = 5mm | ||
| 6983 | }} | ||
| 6984 | |||
| 6985 | % Use @afivepaper to print on European A5 paper. | ||
| 6986 | % From romildo@urano.iceb.ufop.br, 2 July 2000. | ||
| 6987 | % He also recommends making @example and @lisp be small. | ||
| 6988 | \def\afivepaper{{\globaldefs = 1 | ||
| 6989 | \parskip = 2pt plus 1pt minus 0.1pt | ||
| 6990 | \textleading = 12.5pt | ||
| 6991 | % | ||
| 6992 | \internalpagesizes{160mm}{120mm}% | ||
| 6993 | {\voffset}{\hoffset}% | ||
| 6994 | {\bindingoffset}{8pt}% | ||
| 6995 | {210mm}{148mm}% | ||
| 6996 | % | ||
| 6997 | \lispnarrowing = 0.2in | ||
| 6998 | \tolerance = 800 | ||
| 6999 | \hfuzz = 1.2pt | ||
| 7000 | \contentsrightmargin = 0pt | ||
| 7001 | \defbodyindent = 2mm | ||
| 7002 | \tableindent = 12mm | ||
| 7003 | }} | ||
| 7004 | |||
| 7005 | % A specific text layout, 24x15cm overall, intended for A4 paper. | ||
| 7006 | \def\afourlatex{{\globaldefs = 1 | ||
| 7007 | \afourpaper | ||
| 7008 | \internalpagesizes{237mm}{150mm}% | ||
| 7009 | {\voffset}{4.6mm}% | ||
| 7010 | {\bindingoffset}{7mm}% | ||
| 7011 | {297mm}{210mm}% | ||
| 7012 | % | ||
| 7013 | % Must explicitly reset to 0 because we call \afourpaper. | ||
| 7014 | \globaldefs = 0 | ||
| 7015 | }} | ||
| 7016 | |||
| 7017 | % Use @afourwide to print on A4 paper in landscape format. | ||
| 7018 | \def\afourwide{{\globaldefs = 1 | ||
| 7019 | \afourpaper | ||
| 7020 | \internalpagesizes{241mm}{165mm}% | ||
| 7021 | {\voffset}{-2.95mm}% | ||
| 7022 | {\bindingoffset}{7mm}% | ||
| 7023 | {297mm}{210mm}% | ||
| 7024 | \globaldefs = 0 | ||
| 7025 | }} | ||
| 7026 | |||
| 7027 | % @pagesizes TEXTHEIGHT[,TEXTWIDTH] | ||
| 7028 | % Perhaps we should allow setting the margins, \topskip, \parskip, | ||
| 7029 | % and/or leading, also. Or perhaps we should compute them somehow. | ||
| 7030 | % | ||
| 7031 | \parseargdef\pagesizes{\pagesizesyyy #1,,\finish} | ||
| 7032 | \def\pagesizesyyy#1,#2,#3\finish{{% | ||
| 7033 | \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi | ||
| 7034 | \globaldefs = 1 | ||
| 7035 | % | ||
| 7036 | \parskip = 3pt plus 2pt minus 1pt | ||
| 7037 | \setleading{\textleading}% | ||
| 7038 | % | ||
| 7039 | \dimen0 = #1 | ||
| 7040 | \advance\dimen0 by \voffset | ||
| 7041 | % | ||
| 7042 | \dimen2 = \hsize | ||
| 7043 | \advance\dimen2 by \normaloffset | ||
| 7044 | % | ||
| 7045 | \internalpagesizes{#1}{\hsize}% | ||
| 7046 | {\voffset}{\normaloffset}% | ||
| 7047 | {\bindingoffset}{44pt}% | ||
| 7048 | {\dimen0}{\dimen2}% | ||
| 7049 | }} | ||
| 7050 | |||
| 7051 | % Set default to letter. | ||
| 7052 | % | ||
| 7053 | \letterpaper | ||
| 7054 | |||
| 7055 | |||
| 7056 | \message{and turning on texinfo input format.} | ||
| 7057 | |||
| 7058 | % Define macros to output various characters with catcode for normal text. | ||
| 7059 | \catcode`\"=\other | ||
| 7060 | \catcode`\~=\other | ||
| 7061 | \catcode`\^=\other | ||
| 7062 | \catcode`\_=\other | ||
| 7063 | \catcode`\|=\other | ||
| 7064 | \catcode`\<=\other | ||
| 7065 | \catcode`\>=\other | ||
| 7066 | \catcode`\+=\other | ||
| 7067 | \catcode`\$=\other | ||
| 7068 | \def\normaldoublequote{"} | ||
| 7069 | \def\normaltilde{~} | ||
| 7070 | \def\normalcaret{^} | ||
| 7071 | \def\normalunderscore{_} | ||
| 7072 | \def\normalverticalbar{|} | ||
| 7073 | \def\normalless{<} | ||
| 7074 | \def\normalgreater{>} | ||
| 7075 | \def\normalplus{+} | ||
| 7076 | \def\normaldollar{$}%$ font-lock fix | ||
| 7077 | |||
| 7078 | % This macro is used to make a character print one way in \tt | ||
| 7079 | % (where it can probably be output as-is), and another way in other fonts, | ||
| 7080 | % where something hairier probably needs to be done. | ||
| 7081 | % | ||
| 7082 | % #1 is what to print if we are indeed using \tt; #2 is what to print | ||
| 7083 | % otherwise. Since all the Computer Modern typewriter fonts have zero | ||
| 7084 | % interword stretch (and shrink), and it is reasonable to expect all | ||
| 7085 | % typewriter fonts to have this, we can check that font parameter. | ||
| 7086 | % | ||
| 7087 | \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} | ||
| 7088 | |||
| 7089 | % Same as above, but check for italic font. Actually this also catches | ||
| 7090 | % non-italic slanted fonts since it is impossible to distinguish them from | ||
| 7091 | % italic fonts. But since this is only used by $ and it uses \sl anyway | ||
| 7092 | % this is not a problem. | ||
| 7093 | \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} | ||
| 7094 | |||
| 7095 | % Turn off all special characters except @ | ||
| 7096 | % (and those which the user can use as if they were ordinary). | ||
| 7097 | % Most of these we simply print from the \tt font, but for some, we can | ||
| 7098 | % use math or other variants that look better in normal text. | ||
| 7099 | |||
| 7100 | \catcode`\"=\active | ||
| 7101 | \def\activedoublequote{{\tt\char34}} | ||
| 7102 | \let"=\activedoublequote | ||
| 7103 | \catcode`\~=\active | ||
| 7104 | \def~{{\tt\char126}} | ||
| 7105 | \chardef\hat=`\^ | ||
| 7106 | \catcode`\^=\active | ||
| 7107 | \def^{{\tt \hat}} | ||
| 7108 | |||
| 7109 | \catcode`\_=\active | ||
| 7110 | \def_{\ifusingtt\normalunderscore\_} | ||
| 7111 | \let\realunder=_ | ||
| 7112 | % Subroutine for the previous macro. | ||
| 7113 | \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } | ||
| 7114 | |||
| 7115 | \catcode`\|=\active | ||
| 7116 | \def|{{\tt\char124}} | ||
| 7117 | \chardef \less=`\< | ||
| 7118 | \catcode`\<=\active | ||
| 7119 | \def<{{\tt \less}} | ||
| 7120 | \chardef \gtr=`\> | ||
| 7121 | \catcode`\>=\active | ||
| 7122 | \def>{{\tt \gtr}} | ||
| 7123 | \catcode`\+=\active | ||
| 7124 | \def+{{\tt \char 43}} | ||
| 7125 | \catcode`\$=\active | ||
| 7126 | \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix | ||
| 7127 | |||
| 7128 | % If a .fmt file is being used, characters that might appear in a file | ||
| 7129 | % name cannot be active until we have parsed the command line. | ||
| 7130 | % So turn them off again, and have \everyjob (or @setfilename) turn them on. | ||
| 7131 | % \otherifyactive is called near the end of this file. | ||
| 7132 | \def\otherifyactive{\catcode`+=\other \catcode`\_=\other} | ||
| 7133 | |||
| 7134 | % Used sometimes to turn off (effectively) the active characters even after | ||
| 7135 | % parsing them. | ||
| 7136 | \def\turnoffactive{% | ||
| 7137 | \normalturnoffactive | ||
| 7138 | \otherbackslash | ||
| 7139 | } | ||
| 7140 | |||
| 7141 | \catcode`\@=0 | ||
| 7142 | |||
| 7143 | % \backslashcurfont outputs one backslash character in current font, | ||
| 7144 | % as in \char`\\. | ||
| 7145 | \global\chardef\backslashcurfont=`\\ | ||
| 7146 | \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work | ||
| 7147 | |||
| 7148 | % \realbackslash is an actual character `\' with catcode other, and | ||
| 7149 | % \doublebackslash is two of them (for the pdf outlines). | ||
| 7150 | {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}} | ||
| 7151 | |||
| 7152 | % In texinfo, backslash is an active character; it prints the backslash | ||
| 7153 | % in fixed width font. | ||
| 7154 | \catcode`\\=\active | ||
| 7155 | @def@normalbackslash{{@tt@backslashcurfont}} | ||
| 7156 | % On startup, @fixbackslash assigns: | ||
| 7157 | % @let \ = @normalbackslash | ||
| 7158 | |||
| 7159 | % \rawbackslash defines an active \ to do \backslashcurfont. | ||
| 7160 | % \otherbackslash defines an active \ to be a literal `\' character with | ||
| 7161 | % catcode other. | ||
| 7162 | @gdef@rawbackslash{@let\=@backslashcurfont} | ||
| 7163 | @gdef@otherbackslash{@let\=@realbackslash} | ||
| 7164 | |||
| 7165 | % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of | ||
| 7166 | % the literal character `\'. | ||
| 7167 | % | ||
| 7168 | @def@normalturnoffactive{% | ||
| 7169 | @let\=@normalbackslash | ||
| 7170 | @let"=@normaldoublequote | ||
| 7171 | @let~=@normaltilde | ||
| 7172 | @let^=@normalcaret | ||
| 7173 | @let_=@normalunderscore | ||
| 7174 | @let|=@normalverticalbar | ||
| 7175 | @let<=@normalless | ||
| 7176 | @let>=@normalgreater | ||
| 7177 | @let+=@normalplus | ||
| 7178 | @let$=@normaldollar %$ font-lock fix | ||
| 7179 | @unsepspaces | ||
| 7180 | } | ||
| 7181 | |||
| 7182 | % Make _ and + \other characters, temporarily. | ||
| 7183 | % This is canceled by @fixbackslash. | ||
| 7184 | @otherifyactive | ||
| 7185 | |||
| 7186 | % If a .fmt file is being used, we don't want the `\input texinfo' to show up. | ||
| 7187 | % That is what \eatinput is for; after that, the `\' should revert to printing | ||
| 7188 | % a backslash. | ||
| 7189 | % | ||
| 7190 | @gdef@eatinput input texinfo{@fixbackslash} | ||
| 7191 | @global@let\ = @eatinput | ||
| 7192 | |||
| 7193 | % On the other hand, perhaps the file did not have a `\input texinfo'. Then | ||
| 7194 | % the first `\' in the file would cause an error. This macro tries to fix | ||
| 7195 | % that, assuming it is called before the first `\' could plausibly occur. | ||
| 7196 | % Also turn back on active characters that might appear in the input | ||
| 7197 | % file name, in case not using a pre-dumped format. | ||
| 7198 | % | ||
| 7199 | @gdef@fixbackslash{% | ||
| 7200 | @ifx\@eatinput @let\ = @normalbackslash @fi | ||
| 7201 | @catcode`+=@active | ||
| 7202 | @catcode`@_=@active | ||
| 7203 | } | ||
| 7204 | |||
| 7205 | % Say @foo, not \foo, in error messages. | ||
| 7206 | @escapechar = `@@ | ||
| 7207 | |||
| 7208 | % These look ok in all fonts, so just make them not special. | ||
| 7209 | @catcode`@& = @other | ||
| 7210 | @catcode`@# = @other | ||
| 7211 | @catcode`@% = @other | ||
| 7212 | |||
| 7213 | |||
| 7214 | @c Local variables: | ||
| 7215 | @c eval: (add-hook 'write-file-hooks 'time-stamp) | ||
| 7216 | @c page-delimiter: "^\\\\message" | ||
| 7217 | @c time-stamp-start: "def\\\\texinfoversion{" | ||
| 7218 | @c time-stamp-format: "%:y-%02m-%02d.%02H" | ||
| 7219 | @c time-stamp-end: "}" | ||
| 7220 | @c End: | ||
| 7221 | |||
| 7222 | @c vim:sw=2: | ||
| 7223 | |||
| 7224 | @ignore | ||
| 7225 | arch-tag: 53261dd3-7df7-4ec3-9d90-af7a955d3c87 | ||
| 7226 | @end ignore | ||