[15293] | 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 | % |
---|
[22253] | 6 | \def\texinfoversion{2004-04-07.08} |
---|
[15293] | 7 | % |
---|
[22253] | 8 | % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, |
---|
| 9 | % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software |
---|
| 10 | % Foundation, Inc. |
---|
[15293] | 11 | % |
---|
| 12 | % This texinfo.tex file is free software; you can redistribute it and/or |
---|
| 13 | % modify it under the terms of the GNU General Public License as |
---|
| 14 | % published by the Free Software Foundation; either version 2, or (at |
---|
| 15 | % your option) any later version. |
---|
| 16 | % |
---|
| 17 | % This texinfo.tex file is distributed in the hope that it will be |
---|
| 18 | % useful, but WITHOUT ANY WARRANTY; without even the implied warranty |
---|
| 19 | % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
---|
| 20 | % General Public License for more details. |
---|
| 21 | % |
---|
| 22 | % You should have received a copy of the GNU General Public License |
---|
| 23 | % along with this texinfo.tex file; see the file COPYING. If not, write |
---|
| 24 | % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
---|
| 25 | % Boston, MA 02111-1307, USA. |
---|
| 26 | % |
---|
[22253] | 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 | % |
---|
[15293] | 31 | % Please try the latest version of texinfo.tex before submitting bug |
---|
| 32 | % reports; you can get the latest version from: |
---|
[22253] | 33 | % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or |
---|
[15293] | 34 | % ftp://tug.org/tex/texinfo.tex |
---|
[22253] | 35 | % (and all CTAN mirrors, see http://www.ctan.org). |
---|
| 36 | % The texinfo.tex in any given distribution could well be out |
---|
[15293] | 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 |
---|
[18190] | 50 | % dvips foo.dvi -o # or whatever; this makes foo.ps. |
---|
| 51 | % The extra TeX runs get the cross-reference information correct. |
---|
[15293] | 52 | % Sometimes one run after texindex suffices, and sometimes you need more |
---|
| 53 | % than two; texi2dvi does it as many times as necessary. |
---|
| 54 | % |
---|
[22253] | 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. |
---|
[15293] | 60 | |
---|
[22253] | 61 | |
---|
[15293] | 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 | |
---|
[22253] | 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. |
---|
[15293] | 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=\! |
---|
[22253] | 87 | \let\ptexfootnote=\footnote |
---|
| 88 | \let\ptexgtr=> |
---|
| 89 | \let\ptexhat=^ |
---|
[15293] | 90 | \let\ptexi=\i |
---|
[22253] | 91 | \let\ptexindent=\indent |
---|
| 92 | \let\ptexnoindent=\noindent |
---|
| 93 | \let\ptexinsert=\insert |
---|
[15293] | 94 | \let\ptexlbrace=\{ |
---|
[22253] | 95 | \let\ptexless=< |
---|
| 96 | \let\ptexplus=+ |
---|
[15293] | 97 | \let\ptexrbrace=\} |
---|
[22253] | 98 | \let\ptexslash=\/ |
---|
[15293] | 99 | \let\ptexstar=\* |
---|
| 100 | \let\ptext=\t |
---|
| 101 | |
---|
| 102 | % If this character appears in an error message or help string, it |
---|
| 103 | % starts a new line in the output. |
---|
| 104 | \newlinechar = `^^J |
---|
| 105 | |
---|
[22253] | 106 | % Use TeX 3.0's \inputlineno to get the line number, for better error |
---|
| 107 | % messages, but if we're using an old version of TeX, don't do anything. |
---|
| 108 | % |
---|
| 109 | \ifx\inputlineno\thisisundefined |
---|
| 110 | \let\linenumber = \empty % Pre-3.0. |
---|
| 111 | \else |
---|
| 112 | \def\linenumber{l.\the\inputlineno:\space} |
---|
| 113 | \fi |
---|
| 114 | |
---|
[15293] | 115 | % Set up fixed words for English if not already set. |
---|
| 116 | \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi |
---|
| 117 | \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi |
---|
| 118 | \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi |
---|
| 119 | \ifx\putwordin\undefined \gdef\putwordin{in}\fi |
---|
| 120 | \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi |
---|
| 121 | \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi |
---|
| 122 | \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi |
---|
| 123 | \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi |
---|
| 124 | \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi |
---|
| 125 | \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi |
---|
| 126 | \ifx\putwordof\undefined \gdef\putwordof{of}\fi |
---|
| 127 | \ifx\putwordon\undefined \gdef\putwordon{on}\fi |
---|
| 128 | \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi |
---|
| 129 | \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi |
---|
| 130 | \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi |
---|
| 131 | \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi |
---|
| 132 | \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi |
---|
| 133 | \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi |
---|
| 134 | \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi |
---|
| 135 | % |
---|
| 136 | \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi |
---|
| 137 | \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi |
---|
| 138 | \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi |
---|
| 139 | \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi |
---|
| 140 | \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi |
---|
| 141 | \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi |
---|
| 142 | \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi |
---|
| 143 | \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi |
---|
| 144 | \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi |
---|
| 145 | \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi |
---|
| 146 | \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi |
---|
| 147 | \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi |
---|
| 148 | % |
---|
| 149 | \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi |
---|
| 150 | \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi |
---|
| 151 | \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi |
---|
| 152 | \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi |
---|
| 153 | \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi |
---|
| 154 | |
---|
[22253] | 155 | % In some macros, we cannot use the `\? notation---the left quote is |
---|
| 156 | % in some cases the escape char. |
---|
| 157 | \chardef\colonChar = `\: |
---|
| 158 | \chardef\commaChar = `\, |
---|
| 159 | \chardef\dotChar = `\. |
---|
| 160 | \chardef\exclamChar= `\! |
---|
| 161 | \chardef\questChar = `\? |
---|
| 162 | \chardef\semiChar = `\; |
---|
| 163 | \chardef\underChar = `\_ |
---|
| 164 | |
---|
| 165 | \chardef\spaceChar = `\ % |
---|
| 166 | \chardef\spacecat = 10 |
---|
| 167 | \def\spaceisspace{\catcode\spaceChar=\spacecat} |
---|
| 168 | |
---|
[15293] | 169 | % Ignore a token. |
---|
| 170 | % |
---|
| 171 | \def\gobble#1{} |
---|
| 172 | |
---|
[22253] | 173 | % The following is used inside several \edef's. |
---|
| 174 | \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} |
---|
[15293] | 175 | |
---|
[22253] | 176 | % Hyphenation fixes. |
---|
| 177 | \hyphenation{ |
---|
| 178 | Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script |
---|
| 179 | ap-pen-dix bit-map bit-maps |
---|
| 180 | data-base data-bases eshell fall-ing half-way long-est man-u-script |
---|
| 181 | man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm |
---|
| 182 | par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces |
---|
| 183 | spell-ing spell-ings |
---|
| 184 | stand-alone strong-est time-stamp time-stamps which-ever white-space |
---|
| 185 | wide-spread wrap-around |
---|
| 186 | } |
---|
| 187 | |
---|
[15293] | 188 | % Margin to add to right of even pages, to left of odd pages. |
---|
[22253] | 189 | \newdimen\bindingoffset |
---|
| 190 | \newdimen\normaloffset |
---|
[15293] | 191 | \newdimen\pagewidth \newdimen\pageheight |
---|
| 192 | |
---|
[22253] | 193 | % For a final copy, take out the rectangles |
---|
| 194 | % that mark overfull boxes (in case you have decided |
---|
| 195 | % that the text looks ok even though it passes the margin). |
---|
| 196 | % |
---|
| 197 | \def\finalout{\overfullrule=0pt} |
---|
| 198 | |
---|
| 199 | % @| inserts a changebar to the left of the current line. It should |
---|
| 200 | % surround any changed text. This approach does *not* work if the |
---|
| 201 | % change spans more than two lines of output. To handle that, we would |
---|
| 202 | % have adopt a much more difficult approach (putting marks into the main |
---|
| 203 | % vertical list for the beginning and end of each change). |
---|
| 204 | % |
---|
| 205 | \def\|{% |
---|
| 206 | % \vadjust can only be used in horizontal mode. |
---|
| 207 | \leavevmode |
---|
| 208 | % |
---|
| 209 | % Append this vertical mode material after the current line in the output. |
---|
| 210 | \vadjust{% |
---|
| 211 | % We want to insert a rule with the height and depth of the current |
---|
| 212 | % leading; that is exactly what \strutbox is supposed to record. |
---|
| 213 | \vskip-\baselineskip |
---|
| 214 | % |
---|
| 215 | % \vadjust-items are inserted at the left edge of the type. So |
---|
| 216 | % the \llap here moves out into the left-hand margin. |
---|
| 217 | \llap{% |
---|
| 218 | % |
---|
| 219 | % For a thicker or thinner bar, change the `1pt'. |
---|
| 220 | \vrule height\baselineskip width1pt |
---|
| 221 | % |
---|
| 222 | % This is the space between the bar and the text. |
---|
| 223 | \hskip 12pt |
---|
| 224 | }% |
---|
| 225 | }% |
---|
| 226 | } |
---|
| 227 | |
---|
[15293] | 228 | % Sometimes it is convenient to have everything in the transcript file |
---|
| 229 | % and nothing on the terminal. We don't just call \tracingall here, |
---|
[22253] | 230 | % since that produces some useless output on the terminal. We also make |
---|
| 231 | % some effort to order the tracing commands to reduce output in the log |
---|
| 232 | % file; cf. trace.sty in LaTeX. |
---|
[15293] | 233 | % |
---|
| 234 | \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% |
---|
[22253] | 235 | \def\loggingall{% |
---|
| 236 | \tracingstats2 |
---|
| 237 | \tracingpages1 |
---|
| 238 | \tracinglostchars2 % 2 gives us more in etex |
---|
| 239 | \tracingparagraphs1 |
---|
| 240 | \tracingoutput1 |
---|
| 241 | \tracingmacros2 |
---|
| 242 | \tracingrestores1 |
---|
| 243 | \showboxbreadth\maxdimen \showboxdepth\maxdimen |
---|
| 244 | \ifx\eTeXversion\undefined\else % etex gives us more logging |
---|
| 245 | \tracingscantokens1 |
---|
| 246 | \tracingifs1 |
---|
| 247 | \tracinggroups1 |
---|
| 248 | \tracingnesting2 |
---|
| 249 | \tracingassigns1 |
---|
| 250 | \fi |
---|
| 251 | \tracingcommands3 % 3 gives us more in etex |
---|
| 252 | \errorcontextlines16 |
---|
[15293] | 253 | }% |
---|
| 254 | |
---|
[18190] | 255 | % add check for \lastpenalty to plain's definitions. If the last thing |
---|
| 256 | % we did was a \nobreak, we don't want to insert more space. |
---|
[22253] | 257 | % |
---|
[18190] | 258 | \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount |
---|
| 259 | \removelastskip\penalty-50\smallskip\fi\fi} |
---|
| 260 | \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount |
---|
| 261 | \removelastskip\penalty-100\medskip\fi\fi} |
---|
| 262 | \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount |
---|
| 263 | \removelastskip\penalty-200\bigskip\fi\fi} |
---|
| 264 | |
---|
[15293] | 265 | % For @cropmarks command. |
---|
| 266 | % Do @cropmarks to get crop marks. |
---|
| 267 | % |
---|
| 268 | \newif\ifcropmarks |
---|
| 269 | \let\cropmarks = \cropmarkstrue |
---|
| 270 | % |
---|
| 271 | % Dimensions to add cropmarks at corners. |
---|
| 272 | % Added by P. A. MacKay, 12 Nov. 1986 |
---|
| 273 | % |
---|
| 274 | \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines |
---|
| 275 | \newdimen\cornerlong \cornerlong=1pc |
---|
| 276 | \newdimen\cornerthick \cornerthick=.3pt |
---|
| 277 | \newdimen\topandbottommargin \topandbottommargin=.75in |
---|
| 278 | |
---|
| 279 | % Main output routine. |
---|
| 280 | \chardef\PAGE = 255 |
---|
| 281 | \output = {\onepageout{\pagecontents\PAGE}} |
---|
| 282 | |
---|
| 283 | \newbox\headlinebox |
---|
| 284 | \newbox\footlinebox |
---|
| 285 | |
---|
| 286 | % \onepageout takes a vbox as an argument. Note that \pagecontents |
---|
| 287 | % does insertions, but you have to call it yourself. |
---|
| 288 | \def\onepageout#1{% |
---|
| 289 | \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi |
---|
| 290 | % |
---|
| 291 | \ifodd\pageno \advance\hoffset by \bindingoffset |
---|
| 292 | \else \advance\hoffset by -\bindingoffset\fi |
---|
| 293 | % |
---|
| 294 | % Do this outside of the \shipout so @code etc. will be expanded in |
---|
| 295 | % the headline as they should be, not taken literally (outputting ''code). |
---|
| 296 | \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% |
---|
| 297 | \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% |
---|
| 298 | % |
---|
| 299 | {% |
---|
| 300 | % Have to do this stuff outside the \shipout because we want it to |
---|
| 301 | % take effect in \write's, yet the group defined by the \vbox ends |
---|
| 302 | % before the \shipout runs. |
---|
| 303 | % |
---|
| 304 | \escapechar = `\\ % use backslash in output files. |
---|
| 305 | \indexdummies % don't expand commands in the output. |
---|
| 306 | \normalturnoffactive % \ in index entries must not stay \, e.g., if |
---|
| 307 | % the page break happens to be in the middle of an example. |
---|
| 308 | \shipout\vbox{% |
---|
[18190] | 309 | % Do this early so pdf references go to the beginning of the page. |
---|
[22253] | 310 | \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi |
---|
[18190] | 311 | % |
---|
[15293] | 312 | \ifcropmarks \vbox to \outervsize\bgroup |
---|
| 313 | \hsize = \outerhsize |
---|
| 314 | \vskip-\topandbottommargin |
---|
| 315 | \vtop to0pt{% |
---|
| 316 | \line{\ewtop\hfil\ewtop}% |
---|
| 317 | \nointerlineskip |
---|
| 318 | \line{% |
---|
| 319 | \vbox{\moveleft\cornerthick\nstop}% |
---|
| 320 | \hfill |
---|
| 321 | \vbox{\moveright\cornerthick\nstop}% |
---|
| 322 | }% |
---|
| 323 | \vss}% |
---|
| 324 | \vskip\topandbottommargin |
---|
| 325 | \line\bgroup |
---|
| 326 | \hfil % center the page within the outer (page) hsize. |
---|
| 327 | \ifodd\pageno\hskip\bindingoffset\fi |
---|
| 328 | \vbox\bgroup |
---|
| 329 | \fi |
---|
| 330 | % |
---|
| 331 | \unvbox\headlinebox |
---|
| 332 | \pagebody{#1}% |
---|
| 333 | \ifdim\ht\footlinebox > 0pt |
---|
| 334 | % Only leave this space if the footline is nonempty. |
---|
| 335 | % (We lessened \vsize for it in \oddfootingxxx.) |
---|
| 336 | % The \baselineskip=24pt in plain's \makefootline has no effect. |
---|
| 337 | \vskip 2\baselineskip |
---|
| 338 | \unvbox\footlinebox |
---|
| 339 | \fi |
---|
| 340 | % |
---|
| 341 | \ifcropmarks |
---|
| 342 | \egroup % end of \vbox\bgroup |
---|
| 343 | \hfil\egroup % end of (centering) \line\bgroup |
---|
| 344 | \vskip\topandbottommargin plus1fill minus1fill |
---|
| 345 | \boxmaxdepth = \cornerthick |
---|
| 346 | \vbox to0pt{\vss |
---|
| 347 | \line{% |
---|
| 348 | \vbox{\moveleft\cornerthick\nsbot}% |
---|
| 349 | \hfill |
---|
| 350 | \vbox{\moveright\cornerthick\nsbot}% |
---|
| 351 | }% |
---|
| 352 | \nointerlineskip |
---|
| 353 | \line{\ewbot\hfil\ewbot}% |
---|
| 354 | }% |
---|
| 355 | \egroup % \vbox from first cropmarks clause |
---|
| 356 | \fi |
---|
| 357 | }% end of \shipout\vbox |
---|
[22253] | 358 | }% end of group with \normalturnoffactive |
---|
[15293] | 359 | \advancepageno |
---|
| 360 | \ifnum\outputpenalty>-20000 \else\dosupereject\fi |
---|
| 361 | } |
---|
| 362 | |
---|
| 363 | \newinsert\margin \dimen\margin=\maxdimen |
---|
| 364 | |
---|
| 365 | \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} |
---|
| 366 | {\catcode`\@ =11 |
---|
| 367 | \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi |
---|
| 368 | % marginal hacks, juha@viisa.uucp (Juha Takala) |
---|
| 369 | \ifvoid\margin\else % marginal info is present |
---|
| 370 | \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi |
---|
| 371 | \dimen@=\dp#1 \unvbox#1 |
---|
| 372 | \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi |
---|
| 373 | \ifr@ggedbottom \kern-\dimen@ \vfil \fi} |
---|
| 374 | } |
---|
| 375 | |
---|
| 376 | % Here are the rules for the cropmarks. Note that they are |
---|
| 377 | % offset so that the space between them is truly \outerhsize or \outervsize |
---|
| 378 | % (P. A. MacKay, 12 November, 1986) |
---|
| 379 | % |
---|
| 380 | \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} |
---|
| 381 | \def\nstop{\vbox |
---|
| 382 | {\hrule height\cornerthick depth\cornerlong width\cornerthick}} |
---|
| 383 | \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} |
---|
| 384 | \def\nsbot{\vbox |
---|
| 385 | {\hrule height\cornerlong depth\cornerthick width\cornerthick}} |
---|
| 386 | |
---|
| 387 | % Parse an argument, then pass it to #1. The argument is the rest of |
---|
| 388 | % the input line (except we remove a trailing comment). #1 should be a |
---|
| 389 | % macro which expects an ordinary undelimited TeX argument. |
---|
| 390 | % |
---|
[22253] | 391 | \def\parsearg{\parseargusing{}} |
---|
| 392 | \def\parseargusing#1#2{% |
---|
| 393 | \def\next{#2}% |
---|
[15293] | 394 | \begingroup |
---|
| 395 | \obeylines |
---|
[22253] | 396 | \spaceisspace |
---|
| 397 | #1% |
---|
| 398 | \parseargline\empty% Insert the \empty token, see \finishparsearg below. |
---|
[15293] | 399 | } |
---|
| 400 | |
---|
| 401 | {\obeylines % |
---|
| 402 | \gdef\parseargline#1^^M{% |
---|
| 403 | \endgroup % End of the group started in \parsearg. |
---|
[22253] | 404 | \argremovecomment #1\comment\ArgTerm% |
---|
[15293] | 405 | }% |
---|
| 406 | } |
---|
| 407 | |
---|
[22253] | 408 | % First remove any @comment, then any @c comment. |
---|
| 409 | \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} |
---|
| 410 | \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} |
---|
[15293] | 411 | |
---|
[22253] | 412 | % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space. |
---|
| 413 | % |
---|
| 414 | % \argremovec might leave us with trailing space, e.g., |
---|
[15293] | 415 | % @end itemize @c foo |
---|
[22253] | 416 | % This space token undergoes the same procedure and is eventually removed |
---|
| 417 | % by \finishparsearg. |
---|
[15293] | 418 | % |
---|
[22253] | 419 | \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} |
---|
| 420 | \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} |
---|
| 421 | \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% |
---|
| 422 | \def\temp{#3}% |
---|
| 423 | \ifx\temp\empty |
---|
| 424 | % We cannot use \next here, as it holds the macro to run; |
---|
| 425 | % thus we reuse \temp. |
---|
| 426 | \let\temp\finishparsearg |
---|
| 427 | \else |
---|
| 428 | \let\temp\argcheckspaces |
---|
| 429 | \fi |
---|
| 430 | % Put the space token in: |
---|
| 431 | \temp#1 #3\ArgTerm |
---|
| 432 | } |
---|
| 433 | |
---|
| 434 | % If a _delimited_ argument is enclosed in braces, they get stripped; so |
---|
| 435 | % to get _exactly_ the rest of the line, we had to prevent such situation. |
---|
| 436 | % We prepended an \empty token at the very beginning and we expand it now, |
---|
| 437 | % just before passing the control to \next. |
---|
| 438 | % (Similarily, we have to think about #3 of \argcheckspacesY above: it is |
---|
| 439 | % either the null string, or it ends with \^^M---thus there is no danger |
---|
| 440 | % that a pair of braces would be stripped. |
---|
[15293] | 441 | % |
---|
[22253] | 442 | % But first, we have to remove the trailing space token. |
---|
| 443 | % |
---|
| 444 | \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}} |
---|
| 445 | |
---|
| 446 | % \parseargdef\foo{...} |
---|
| 447 | % is roughly equivalent to |
---|
| 448 | % \def\foo{\parsearg\Xfoo} |
---|
| 449 | % \def\Xfoo#1{...} |
---|
| 450 | % |
---|
| 451 | % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my |
---|
| 452 | % favourite TeX trick. --kasal, 16nov03 |
---|
| 453 | |
---|
| 454 | \def\parseargdef#1{% |
---|
| 455 | \expandafter \doparseargdef \csname\string#1\endcsname #1% |
---|
[15293] | 456 | } |
---|
[22253] | 457 | \def\doparseargdef#1#2{% |
---|
| 458 | \def#2{\parsearg#1}% |
---|
| 459 | \def#1##1% |
---|
| 460 | } |
---|
[15293] | 461 | |
---|
[22253] | 462 | % Several utility definitions with active space: |
---|
| 463 | { |
---|
[15293] | 464 | \obeyspaces |
---|
[22253] | 465 | \gdef\obeyedspace{ } |
---|
[15293] | 466 | |
---|
[22253] | 467 | % Make each space character in the input produce a normal interword |
---|
| 468 | % space in the output. Don't allow a line break at this space, as this |
---|
| 469 | % is used only in environments like @example, where each line of input |
---|
| 470 | % should produce a line of output anyway. |
---|
| 471 | % |
---|
| 472 | \gdef\sepspaces{\obeyspaces\let =\tie} |
---|
[15293] | 473 | |
---|
[22253] | 474 | % If an index command is used in an @example environment, any spaces |
---|
| 475 | % therein should become regular spaces in the raw index file, not the |
---|
| 476 | % expansion of \tie (\leavevmode \penalty \@M \ ). |
---|
| 477 | \gdef\unsepspaces{\let =\space} |
---|
| 478 | } |
---|
| 479 | |
---|
| 480 | |
---|
[15293] | 481 | \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} |
---|
| 482 | |
---|
[22253] | 483 | % Define the framework for environments in texinfo.tex. It's used like this: |
---|
| 484 | % |
---|
| 485 | % \envdef\foo{...} |
---|
| 486 | % \def\Efoo{...} |
---|
| 487 | % |
---|
| 488 | % It's the responsibility of \envdef to insert \begingroup before the |
---|
| 489 | % actual body; @end closes the group after calling \Efoo. \envdef also |
---|
| 490 | % defines \thisenv, so the current environment is known; @end checks |
---|
| 491 | % whether the environment name matches. The \checkenv macro can also be |
---|
| 492 | % used to check whether the current environment is the one expected. |
---|
| 493 | % |
---|
| 494 | % Non-false conditionals (@iftex, @ifset) don't fit into this, so they |
---|
| 495 | % are not treated as enviroments; they don't open a group. (The |
---|
| 496 | % implementation of @end takes care not to call \endgroup in this |
---|
| 497 | % special case.) |
---|
[15293] | 498 | |
---|
| 499 | |
---|
[22253] | 500 | % At runtime, environments start with this: |
---|
| 501 | \def\startenvironment#1{\begingroup\def\thisenv{#1}} |
---|
| 502 | % initialize |
---|
| 503 | \let\thisenv\empty |
---|
[15293] | 504 | |
---|
[22253] | 505 | % ... but they get defined via ``\envdef\foo{...}'': |
---|
| 506 | \long\def\envdef#1#2{\def#1{\startenvironment#1#2}} |
---|
| 507 | \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} |
---|
[15293] | 508 | |
---|
[22253] | 509 | % Check whether we're in the right environment: |
---|
| 510 | \def\checkenv#1{% |
---|
| 511 | \def\temp{#1}% |
---|
| 512 | \ifx\thisenv\temp |
---|
[15293] | 513 | \else |
---|
[22253] | 514 | \badenverr |
---|
[15293] | 515 | \fi |
---|
| 516 | } |
---|
| 517 | |
---|
[22253] | 518 | % Evironment mismatch, #1 expected: |
---|
| 519 | \def\badenverr{% |
---|
[15293] | 520 | \errhelp = \EMsimple |
---|
[22253] | 521 | \errmessage{This command can appear only \inenvironment\temp, |
---|
| 522 | not \inenvironment\thisenv}% |
---|
[15293] | 523 | } |
---|
[22253] | 524 | \def\inenvironment#1{% |
---|
| 525 | \ifx#1\empty |
---|
| 526 | out of any environment% |
---|
| 527 | \else |
---|
| 528 | in environment \expandafter\string#1% |
---|
| 529 | \fi |
---|
| 530 | } |
---|
[15293] | 531 | |
---|
[22253] | 532 | % @end foo executes the definition of \Efoo. |
---|
| 533 | % But first, it executes a specialized version of \checkenv |
---|
[15293] | 534 | % |
---|
[22253] | 535 | \parseargdef\end{% |
---|
| 536 | \if 1\csname iscond.#1\endcsname |
---|
| 537 | \else |
---|
| 538 | % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 |
---|
| 539 | \expandafter\checkenv\csname#1\endcsname |
---|
| 540 | \csname E#1\endcsname |
---|
| 541 | \endgroup |
---|
| 542 | \fi |
---|
[15293] | 543 | } |
---|
| 544 | |
---|
[22253] | 545 | \newhelp\EMsimple{Press RETURN to continue.} |
---|
[15293] | 546 | |
---|
| 547 | |
---|
| 548 | %% Simple single-character @ commands |
---|
| 549 | |
---|
| 550 | % @@ prints an @ |
---|
| 551 | % Kludge this until the fonts are right (grr). |
---|
| 552 | \def\@{{\tt\char64}} |
---|
| 553 | |
---|
| 554 | % This is turned off because it was never documented |
---|
| 555 | % and you can use @w{...} around a quote to suppress ligatures. |
---|
| 556 | %% Define @` and @' to be the same as ` and ' |
---|
| 557 | %% but suppressing ligatures. |
---|
| 558 | %\def\`{{`}} |
---|
| 559 | %\def\'{{'}} |
---|
| 560 | |
---|
| 561 | % Used to generate quoted braces. |
---|
| 562 | \def\mylbrace {{\tt\char123}} |
---|
| 563 | \def\myrbrace {{\tt\char125}} |
---|
| 564 | \let\{=\mylbrace |
---|
| 565 | \let\}=\myrbrace |
---|
| 566 | \begingroup |
---|
[22253] | 567 | % Definitions to produce \{ and \} commands for indices, |
---|
| 568 | % and @{ and @} for the aux file. |
---|
| 569 | \catcode`\{ = \other \catcode`\} = \other |
---|
[15293] | 570 | \catcode`\[ = 1 \catcode`\] = 2 |
---|
[22253] | 571 | \catcode`\! = 0 \catcode`\\ = \other |
---|
| 572 | !gdef!lbracecmd[\{]% |
---|
| 573 | !gdef!rbracecmd[\}]% |
---|
| 574 | !gdef!lbraceatcmd[@{]% |
---|
| 575 | !gdef!rbraceatcmd[@}]% |
---|
| 576 | !endgroup |
---|
[15293] | 577 | |
---|
[22253] | 578 | % @comma{} to avoid , parsing problems. |
---|
| 579 | \let\comma = , |
---|
| 580 | |
---|
[15293] | 581 | % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent |
---|
[22253] | 582 | % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. |
---|
[15293] | 583 | \let\, = \c |
---|
| 584 | \let\dotaccent = \. |
---|
| 585 | \def\ringaccent#1{{\accent23 #1}} |
---|
| 586 | \let\tieaccent = \t |
---|
| 587 | \let\ubaraccent = \b |
---|
| 588 | \let\udotaccent = \d |
---|
| 589 | |
---|
[22253] | 590 | % Other special characters: @questiondown @exclamdown @ordf @ordm |
---|
| 591 | % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. |
---|
[15293] | 592 | \def\questiondown{?`} |
---|
| 593 | \def\exclamdown{!`} |
---|
[22253] | 594 | \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} |
---|
| 595 | \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} |
---|
[15293] | 596 | |
---|
| 597 | % Dotless i and dotless j, used for accents. |
---|
| 598 | \def\imacro{i} |
---|
| 599 | \def\jmacro{j} |
---|
| 600 | \def\dotless#1{% |
---|
| 601 | \def\temp{#1}% |
---|
| 602 | \ifx\temp\imacro \ptexi |
---|
| 603 | \else\ifx\temp\jmacro \j |
---|
| 604 | \else \errmessage{@dotless can be used only with i or j}% |
---|
| 605 | \fi\fi |
---|
| 606 | } |
---|
| 607 | |
---|
[22253] | 608 | % The \TeX{} logo, as in plain, but resetting the spacing so that a |
---|
| 609 | % period following counts as ending a sentence. (Idea found in latex.) |
---|
| 610 | % |
---|
| 611 | \edef\TeX{\TeX \spacefactor=3000 } |
---|
| 612 | |
---|
| 613 | % @LaTeX{} logo. Not quite the same results as the definition in |
---|
| 614 | % latex.ltx, since we use a different font for the raised A; it's most |
---|
| 615 | % convenient for us to use an explicitly smaller font, rather than using |
---|
| 616 | % the \scriptstyle font (since we don't reset \scriptstyle and |
---|
| 617 | % \scriptscriptstyle). |
---|
| 618 | % |
---|
| 619 | \def\LaTeX{% |
---|
| 620 | L\kern-.36em |
---|
| 621 | {\setbox0=\hbox{T}% |
---|
| 622 | \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}% |
---|
| 623 | \kern-.15em |
---|
| 624 | \TeX |
---|
| 625 | } |
---|
| 626 | |
---|
[15293] | 627 | % Be sure we're in horizontal mode when doing a tie, since we make space |
---|
| 628 | % equivalent to this in @example-like environments. Otherwise, a space |
---|
| 629 | % at the beginning of a line will start with \penalty -- and |
---|
| 630 | % since \penalty is valid in vertical mode, we'd end up putting the |
---|
| 631 | % penalty on the vertical list instead of in the new paragraph. |
---|
| 632 | {\catcode`@ = 11 |
---|
| 633 | % Avoid using \@M directly, because that causes trouble |
---|
| 634 | % if the definition is written into an index file. |
---|
| 635 | \global\let\tiepenalty = \@M |
---|
| 636 | \gdef\tie{\leavevmode\penalty\tiepenalty\ } |
---|
| 637 | } |
---|
| 638 | |
---|
| 639 | % @: forces normal size whitespace following. |
---|
| 640 | \def\:{\spacefactor=1000 } |
---|
| 641 | |
---|
| 642 | % @* forces a line break. |
---|
| 643 | \def\*{\hfil\break\hbox{}\ignorespaces} |
---|
| 644 | |
---|
[22253] | 645 | % @/ allows a line break. |
---|
| 646 | \let\/=\allowbreak |
---|
| 647 | |
---|
[15293] | 648 | % @. is an end-of-sentence period. |
---|
| 649 | \def\.{.\spacefactor=3000 } |
---|
| 650 | |
---|
| 651 | % @! is an end-of-sentence bang. |
---|
| 652 | \def\!{!\spacefactor=3000 } |
---|
| 653 | |
---|
| 654 | % @? is an end-of-sentence query. |
---|
| 655 | \def\?{?\spacefactor=3000 } |
---|
| 656 | |
---|
| 657 | % @w prevents a word break. Without the \leavevmode, @w at the |
---|
| 658 | % beginning of a paragraph, when TeX is still in vertical mode, would |
---|
| 659 | % produce a whole line of output instead of starting the paragraph. |
---|
| 660 | \def\w#1{\leavevmode\hbox{#1}} |
---|
| 661 | |
---|
| 662 | % @group ... @end group forces ... to be all on one page, by enclosing |
---|
| 663 | % it in a TeX vbox. We use \vtop instead of \vbox to construct the box |
---|
| 664 | % to keep its height that of a normal line. According to the rules for |
---|
| 665 | % \topskip (p.114 of the TeXbook), the glue inserted is |
---|
| 666 | % max (\topskip - \ht (first item), 0). If that height is large, |
---|
| 667 | % therefore, no glue is inserted, and the space between the headline and |
---|
| 668 | % the text is small, which looks bad. |
---|
| 669 | % |
---|
[22253] | 670 | % Another complication is that the group might be very large. This can |
---|
| 671 | % cause the glue on the previous page to be unduly stretched, because it |
---|
| 672 | % does not have much material. In this case, it's better to add an |
---|
| 673 | % explicit \vfill so that the extra space is at the bottom. The |
---|
| 674 | % threshold for doing this is if the group is more than \vfilllimit |
---|
| 675 | % percent of a page (\vfilllimit can be changed inside of @tex). |
---|
| 676 | % |
---|
| 677 | \newbox\groupbox |
---|
| 678 | \def\vfilllimit{0.7} |
---|
| 679 | % |
---|
| 680 | \envdef\group{% |
---|
| 681 | \ifnum\catcode`\^^M=\active \else |
---|
[15293] | 682 | \errhelp = \groupinvalidhelp |
---|
| 683 | \errmessage{@group invalid in context where filling is enabled}% |
---|
| 684 | \fi |
---|
[22253] | 685 | \startsavinginserts |
---|
[15293] | 686 | % |
---|
[22253] | 687 | \setbox\groupbox = \vtop\bgroup |
---|
[15293] | 688 | % Do @comment since we are called inside an environment such as |
---|
| 689 | % @example, where each end-of-line in the input causes an |
---|
| 690 | % end-of-line in the output. We don't want the end-of-line after |
---|
| 691 | % the `@group' to put extra space in the output. Since @group |
---|
| 692 | % should appear on a line by itself (according to the Texinfo |
---|
| 693 | % manual), we don't worry about eating any user text. |
---|
| 694 | \comment |
---|
| 695 | } |
---|
| 696 | % |
---|
[22253] | 697 | % The \vtop produces a box with normal height and large depth; thus, TeX puts |
---|
| 698 | % \baselineskip glue before it, and (when the next line of text is done) |
---|
| 699 | % \lineskip glue after it. Thus, space below is not quite equal to space |
---|
| 700 | % above. But it's pretty close. |
---|
| 701 | \def\Egroup{% |
---|
| 702 | % To get correct interline space between the last line of the group |
---|
| 703 | % and the first line afterwards, we have to propagate \prevdepth. |
---|
| 704 | \endgraf % Not \par, as it may have been set to \lisppar. |
---|
| 705 | \global\dimen1 = \prevdepth |
---|
| 706 | \egroup % End the \vtop. |
---|
| 707 | % \dimen0 is the vertical size of the group's box. |
---|
| 708 | \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox |
---|
| 709 | % \dimen2 is how much space is left on the page (more or less). |
---|
| 710 | \dimen2 = \pageheight \advance\dimen2 by -\pagetotal |
---|
| 711 | % if the group doesn't fit on the current page, and it's a big big |
---|
| 712 | % group, force a page break. |
---|
| 713 | \ifdim \dimen0 > \dimen2 |
---|
| 714 | \ifdim \pagetotal < \vfilllimit\pageheight |
---|
| 715 | \page |
---|
| 716 | \fi |
---|
| 717 | \fi |
---|
| 718 | \box\groupbox |
---|
| 719 | \prevdepth = \dimen1 |
---|
| 720 | \checkinserts |
---|
| 721 | } |
---|
| 722 | % |
---|
[15293] | 723 | % TeX puts in an \escapechar (i.e., `@') at the beginning of the help |
---|
| 724 | % message, so this ends up printing `@group can only ...'. |
---|
| 725 | % |
---|
| 726 | \newhelp\groupinvalidhelp{% |
---|
| 727 | group can only be used in environments such as @example,^^J% |
---|
| 728 | where each line of input produces a line of output.} |
---|
| 729 | |
---|
| 730 | % @need space-in-mils |
---|
| 731 | % forces a page break if there is not space-in-mils remaining. |
---|
| 732 | |
---|
| 733 | \newdimen\mil \mil=0.001in |
---|
| 734 | |
---|
| 735 | % Old definition--didn't work. |
---|
[22253] | 736 | %\parseargdef\need{\par % |
---|
[15293] | 737 | %% This method tries to make TeX break the page naturally |
---|
| 738 | %% if the depth of the box does not fit. |
---|
| 739 | %{\baselineskip=0pt% |
---|
| 740 | %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak |
---|
| 741 | %\prevdepth=-1000pt |
---|
| 742 | %}} |
---|
| 743 | |
---|
[22253] | 744 | \parseargdef\need{% |
---|
[18190] | 745 | % Ensure vertical mode, so we don't make a big box in the middle of a |
---|
[15293] | 746 | % paragraph. |
---|
| 747 | \par |
---|
| 748 | % |
---|
[18190] | 749 | % If the @need value is less than one line space, it's useless. |
---|
| 750 | \dimen0 = #1\mil |
---|
| 751 | \dimen2 = \ht\strutbox |
---|
| 752 | \advance\dimen2 by \dp\strutbox |
---|
| 753 | \ifdim\dimen0 > \dimen2 |
---|
| 754 | % |
---|
| 755 | % Do a \strut just to make the height of this box be normal, so the |
---|
| 756 | % normal leading is inserted relative to the preceding line. |
---|
| 757 | % And a page break here is fine. |
---|
| 758 | \vtop to #1\mil{\strut\vfil}% |
---|
| 759 | % |
---|
| 760 | % TeX does not even consider page breaks if a penalty added to the |
---|
| 761 | % main vertical list is 10000 or more. But in order to see if the |
---|
| 762 | % empty box we just added fits on the page, we must make it consider |
---|
| 763 | % page breaks. On the other hand, we don't want to actually break the |
---|
| 764 | % page after the empty box. So we use a penalty of 9999. |
---|
| 765 | % |
---|
| 766 | % There is an extremely small chance that TeX will actually break the |
---|
| 767 | % page at this \penalty, if there are no other feasible breakpoints in |
---|
| 768 | % sight. (If the user is using lots of big @group commands, which |
---|
| 769 | % almost-but-not-quite fill up a page, TeX will have a hard time doing |
---|
| 770 | % good page breaking, for example.) However, I could not construct an |
---|
| 771 | % example where a page broke at this \penalty; if it happens in a real |
---|
| 772 | % document, then we can reconsider our strategy. |
---|
| 773 | \penalty9999 |
---|
| 774 | % |
---|
| 775 | % Back up by the size of the box, whether we did a page break or not. |
---|
| 776 | \kern -#1\mil |
---|
| 777 | % |
---|
| 778 | % Do not allow a page break right after this kern. |
---|
| 779 | \nobreak |
---|
| 780 | \fi |
---|
[15293] | 781 | } |
---|
| 782 | |
---|
[22253] | 783 | % @br forces paragraph break (and is undocumented). |
---|
[15293] | 784 | |
---|
| 785 | \let\br = \par |
---|
| 786 | |
---|
[22253] | 787 | % @page forces the start of a new page. |
---|
[15293] | 788 | % |
---|
| 789 | \def\page{\par\vfill\supereject} |
---|
| 790 | |
---|
| 791 | % @exdent text.... |
---|
| 792 | % outputs text on separate line in roman font, starting at standard page margin |
---|
| 793 | |
---|
| 794 | % This records the amount of indent in the innermost environment. |
---|
| 795 | % That's how much \exdent should take out. |
---|
| 796 | \newskip\exdentamount |
---|
| 797 | |
---|
| 798 | % This defn is used inside fill environments such as @defun. |
---|
[22253] | 799 | \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} |
---|
[15293] | 800 | |
---|
| 801 | % This defn is used inside nofill environments such as @example. |
---|
[22253] | 802 | \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount |
---|
| 803 | \leftline{\hskip\leftskip{\rm#1}}}} |
---|
[15293] | 804 | |
---|
[18190] | 805 | % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current |
---|
| 806 | % paragraph. For more general purposes, use the \margin insertion |
---|
| 807 | % class. WHICH is `l' or `r'. |
---|
| 808 | % |
---|
[15293] | 809 | \newskip\inmarginspacing \inmarginspacing=1cm |
---|
| 810 | \def\strutdepth{\dp\strutbox} |
---|
[18190] | 811 | % |
---|
| 812 | \def\doinmargin#1#2{\strut\vadjust{% |
---|
| 813 | \nobreak |
---|
| 814 | \kern-\strutdepth |
---|
| 815 | \vtop to \strutdepth{% |
---|
| 816 | \baselineskip=\strutdepth |
---|
| 817 | \vss |
---|
| 818 | % if you have multiple lines of stuff to put here, you'll need to |
---|
| 819 | % make the vbox yourself of the appropriate size. |
---|
| 820 | \ifx#1l% |
---|
| 821 | \llap{\ignorespaces #2\hskip\inmarginspacing}% |
---|
| 822 | \else |
---|
| 823 | \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% |
---|
| 824 | \fi |
---|
| 825 | \null |
---|
| 826 | }% |
---|
| 827 | }} |
---|
| 828 | \def\inleftmargin{\doinmargin l} |
---|
| 829 | \def\inrightmargin{\doinmargin r} |
---|
| 830 | % |
---|
| 831 | % @inmargin{TEXT [, RIGHT-TEXT]} |
---|
| 832 | % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; |
---|
| 833 | % else use TEXT for both). |
---|
[22253] | 834 | % |
---|
[18190] | 835 | \def\inmargin#1{\parseinmargin #1,,\finish} |
---|
| 836 | \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. |
---|
[22253] | 837 | \setbox0 = \hbox{\ignorespaces #2}% |
---|
[18190] | 838 | \ifdim\wd0 > 0pt |
---|
| 839 | \def\lefttext{#1}% have both texts |
---|
| 840 | \def\righttext{#2}% |
---|
| 841 | \else |
---|
| 842 | \def\lefttext{#1}% have only one text |
---|
| 843 | \def\righttext{#1}% |
---|
| 844 | \fi |
---|
| 845 | % |
---|
| 846 | \ifodd\pageno |
---|
| 847 | \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin |
---|
| 848 | \else |
---|
| 849 | \def\temp{\inleftmargin\lefttext}% |
---|
| 850 | \fi |
---|
| 851 | \temp |
---|
| 852 | } |
---|
[15293] | 853 | |
---|
| 854 | % @include file insert text of that file as input. |
---|
[22253] | 855 | % |
---|
| 856 | \def\include{\parseargusing\filenamecatcodes\includezzz} |
---|
| 857 | \def\includezzz#1{% |
---|
| 858 | \pushthisfilestack |
---|
[15293] | 859 | \def\thisfile{#1}% |
---|
[22253] | 860 | {% |
---|
| 861 | \makevalueexpandable |
---|
| 862 | \def\temp{\input #1 }% |
---|
| 863 | \expandafter |
---|
| 864 | }\temp |
---|
| 865 | \popthisfilestack |
---|
| 866 | } |
---|
| 867 | \def\filenamecatcodes{% |
---|
| 868 | \catcode`\\=\other |
---|
| 869 | \catcode`~=\other |
---|
| 870 | \catcode`^=\other |
---|
| 871 | \catcode`_=\other |
---|
| 872 | \catcode`|=\other |
---|
| 873 | \catcode`<=\other |
---|
| 874 | \catcode`>=\other |
---|
| 875 | \catcode`+=\other |
---|
| 876 | \catcode`-=\other |
---|
| 877 | } |
---|
[15293] | 878 | |
---|
[22253] | 879 | \def\pushthisfilestack{% |
---|
| 880 | \expandafter\pushthisfilestackX\popthisfilestack\StackTerm |
---|
| 881 | } |
---|
| 882 | \def\pushthisfilestackX{% |
---|
| 883 | \expandafter\pushthisfilestackY\thisfile\StackTerm |
---|
| 884 | } |
---|
| 885 | \def\pushthisfilestackY #1\StackTerm #2\StackTerm {% |
---|
| 886 | \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% |
---|
| 887 | } |
---|
| 888 | |
---|
| 889 | \def\popthisfilestack{\errthisfilestackempty} |
---|
| 890 | \def\errthisfilestackempty{\errmessage{Internal error: |
---|
| 891 | the stack of filenames is empty.}} |
---|
| 892 | |
---|
[15293] | 893 | \def\thisfile{} |
---|
| 894 | |
---|
[22253] | 895 | % @center line |
---|
| 896 | % outputs that line, centered. |
---|
| 897 | % |
---|
| 898 | \parseargdef\center{% |
---|
| 899 | \ifhmode |
---|
| 900 | \let\next\centerH |
---|
| 901 | \else |
---|
| 902 | \let\next\centerV |
---|
| 903 | \fi |
---|
| 904 | \next{\hfil \ignorespaces#1\unskip \hfil}% |
---|
| 905 | } |
---|
| 906 | \def\centerH#1{% |
---|
| 907 | {% |
---|
| 908 | \hfil\break |
---|
| 909 | \advance\hsize by -\leftskip |
---|
| 910 | \advance\hsize by -\rightskip |
---|
| 911 | \line{#1}% |
---|
| 912 | \break |
---|
| 913 | }% |
---|
| 914 | } |
---|
| 915 | \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}} |
---|
[15293] | 916 | |
---|
| 917 | % @sp n outputs n lines of vertical space |
---|
| 918 | |
---|
[22253] | 919 | \parseargdef\sp{\vskip #1\baselineskip} |
---|
[15293] | 920 | |
---|
| 921 | % @comment ...line which is ignored... |
---|
| 922 | % @c is the same as @comment |
---|
| 923 | % @ignore ... @end ignore is another way to write a comment |
---|
| 924 | |
---|
| 925 | \def\comment{\begingroup \catcode`\^^M=\other% |
---|
| 926 | \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% |
---|
| 927 | \commentxxx} |
---|
| 928 | {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} |
---|
| 929 | |
---|
| 930 | \let\c=\comment |
---|
| 931 | |
---|
| 932 | % @paragraphindent NCHARS |
---|
| 933 | % We'll use ems for NCHARS, close enough. |
---|
[22253] | 934 | % NCHARS can also be the word `asis' or `none'. |
---|
| 935 | % We cannot feasibly implement @paragraphindent asis, though. |
---|
| 936 | % |
---|
[15293] | 937 | \def\asisword{asis} % no translation, these are keywords |
---|
| 938 | \def\noneword{none} |
---|
| 939 | % |
---|
[22253] | 940 | \parseargdef\paragraphindent{% |
---|
[15293] | 941 | \def\temp{#1}% |
---|
| 942 | \ifx\temp\asisword |
---|
| 943 | \else |
---|
| 944 | \ifx\temp\noneword |
---|
| 945 | \defaultparindent = 0pt |
---|
| 946 | \else |
---|
| 947 | \defaultparindent = #1em |
---|
| 948 | \fi |
---|
| 949 | \fi |
---|
| 950 | \parindent = \defaultparindent |
---|
| 951 | } |
---|
| 952 | |
---|
| 953 | % @exampleindent NCHARS |
---|
| 954 | % We'll use ems for NCHARS like @paragraphindent. |
---|
| 955 | % It seems @exampleindent asis isn't necessary, but |
---|
| 956 | % I preserve it to make it similar to @paragraphindent. |
---|
[22253] | 957 | \parseargdef\exampleindent{% |
---|
[15293] | 958 | \def\temp{#1}% |
---|
| 959 | \ifx\temp\asisword |
---|
| 960 | \else |
---|
| 961 | \ifx\temp\noneword |
---|
| 962 | \lispnarrowing = 0pt |
---|
| 963 | \else |
---|
| 964 | \lispnarrowing = #1em |
---|
| 965 | \fi |
---|
| 966 | \fi |
---|
| 967 | } |
---|
| 968 | |
---|
[22253] | 969 | % @firstparagraphindent WORD |
---|
| 970 | % If WORD is `none', then suppress indentation of the first paragraph |
---|
| 971 | % after a section heading. If WORD is `insert', then do indent at such |
---|
| 972 | % paragraphs. |
---|
| 973 | % |
---|
| 974 | % The paragraph indentation is suppressed or not by calling |
---|
| 975 | % \suppressfirstparagraphindent, which the sectioning commands do. |
---|
| 976 | % We switch the definition of this back and forth according to WORD. |
---|
| 977 | % By default, we suppress indentation. |
---|
| 978 | % |
---|
| 979 | \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} |
---|
| 980 | \def\insertword{insert} |
---|
| 981 | % |
---|
| 982 | \parseargdef\firstparagraphindent{% |
---|
| 983 | \def\temp{#1}% |
---|
| 984 | \ifx\temp\noneword |
---|
| 985 | \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent |
---|
| 986 | \else\ifx\temp\insertword |
---|
| 987 | \let\suppressfirstparagraphindent = \relax |
---|
| 988 | \else |
---|
| 989 | \errhelp = \EMsimple |
---|
| 990 | \errmessage{Unknown @firstparagraphindent option `\temp'}% |
---|
| 991 | \fi\fi |
---|
| 992 | } |
---|
| 993 | |
---|
| 994 | % Here is how we actually suppress indentation. Redefine \everypar to |
---|
| 995 | % \kern backwards by \parindent, and then reset itself to empty. |
---|
| 996 | % |
---|
| 997 | % We also make \indent itself not actually do anything until the next |
---|
| 998 | % paragraph. |
---|
| 999 | % |
---|
| 1000 | \gdef\dosuppressfirstparagraphindent{% |
---|
| 1001 | \gdef\indent{% |
---|
| 1002 | \restorefirstparagraphindent |
---|
| 1003 | \indent |
---|
| 1004 | }% |
---|
| 1005 | \gdef\noindent{% |
---|
| 1006 | \restorefirstparagraphindent |
---|
| 1007 | \noindent |
---|
| 1008 | }% |
---|
| 1009 | \global\everypar = {% |
---|
| 1010 | \kern -\parindent |
---|
| 1011 | \restorefirstparagraphindent |
---|
| 1012 | }% |
---|
| 1013 | } |
---|
| 1014 | |
---|
| 1015 | \gdef\restorefirstparagraphindent{% |
---|
| 1016 | \global \let \indent = \ptexindent |
---|
| 1017 | \global \let \noindent = \ptexnoindent |
---|
| 1018 | \global \everypar = {}% |
---|
| 1019 | } |
---|
| 1020 | |
---|
| 1021 | |
---|
[15293] | 1022 | % @asis just yields its argument. Used with @table, for example. |
---|
| 1023 | % |
---|
| 1024 | \def\asis#1{#1} |
---|
| 1025 | |
---|
[18190] | 1026 | % @math outputs its argument in math mode. |
---|
[15293] | 1027 | % |
---|
[18190] | 1028 | % One complication: _ usually means subscripts, but it could also mean |
---|
| 1029 | % an actual _ character, as in @math{@var{some_variable} + 1}. So make |
---|
[22253] | 1030 | % _ active, and distinguish by seeing if the current family is \slfam, |
---|
| 1031 | % which is what @var uses. |
---|
| 1032 | { |
---|
| 1033 | \catcode\underChar = \active |
---|
| 1034 | \gdef\mathunderscore{% |
---|
| 1035 | \catcode\underChar=\active |
---|
| 1036 | \def_{\ifnum\fam=\slfam \_\else\sb\fi}% |
---|
| 1037 | } |
---|
| 1038 | } |
---|
[18190] | 1039 | % Another complication: we want \\ (and @\) to output a \ character. |
---|
| 1040 | % FYI, plain.tex uses \\ as a temporary control sequence (why?), but |
---|
| 1041 | % this is not advertised and we don't care. Texinfo does not |
---|
| 1042 | % otherwise define @\. |
---|
[22253] | 1043 | % |
---|
[18190] | 1044 | % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. |
---|
| 1045 | \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} |
---|
| 1046 | % |
---|
| 1047 | \def\math{% |
---|
| 1048 | \tex |
---|
[22253] | 1049 | \mathunderscore |
---|
[18190] | 1050 | \let\\ = \mathbackslash |
---|
[22253] | 1051 | \mathactive |
---|
| 1052 | $\finishmath |
---|
| 1053 | } |
---|
| 1054 | \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. |
---|
[15293] | 1055 | |
---|
[22253] | 1056 | % Some active characters (such as <) are spaced differently in math. |
---|
| 1057 | % We have to reset their definitions in case the @math was an argument |
---|
| 1058 | % to a command which sets the catcodes (such as @item or @section). |
---|
| 1059 | % |
---|
| 1060 | { |
---|
| 1061 | \catcode`^ = \active |
---|
| 1062 | \catcode`< = \active |
---|
| 1063 | \catcode`> = \active |
---|
| 1064 | \catcode`+ = \active |
---|
| 1065 | \gdef\mathactive{% |
---|
| 1066 | \let^ = \ptexhat |
---|
| 1067 | \let< = \ptexless |
---|
| 1068 | \let> = \ptexgtr |
---|
| 1069 | \let+ = \ptexplus |
---|
| 1070 | } |
---|
| 1071 | } |
---|
| 1072 | |
---|
[15293] | 1073 | % @bullet and @minus need the same treatment as @math, just above. |
---|
[22253] | 1074 | \def\bullet{$\ptexbullet$} |
---|
| 1075 | \def\minus{$-$} |
---|
[15293] | 1076 | |
---|
[22253] | 1077 | % @dots{} outputs an ellipsis using the current font. |
---|
| 1078 | % We do .5em per period so that it has the same spacing in a typewriter |
---|
| 1079 | % font as three actual period characters. |
---|
| 1080 | % |
---|
| 1081 | \def\dots{% |
---|
| 1082 | \leavevmode |
---|
| 1083 | \hbox to 1.5em{% |
---|
| 1084 | \hskip 0pt plus 0.25fil |
---|
| 1085 | .\hfil.\hfil.% |
---|
| 1086 | \hskip 0pt plus 0.5fil |
---|
| 1087 | }% |
---|
| 1088 | } |
---|
| 1089 | |
---|
| 1090 | % @enddots{} is an end-of-sentence ellipsis. |
---|
| 1091 | % |
---|
| 1092 | \def\enddots{% |
---|
| 1093 | \dots |
---|
| 1094 | \spacefactor=3000 |
---|
| 1095 | } |
---|
| 1096 | |
---|
| 1097 | % @comma{} is so commas can be inserted into text without messing up |
---|
| 1098 | % Texinfo's parsing. |
---|
| 1099 | % |
---|
| 1100 | \let\comma = , |
---|
| 1101 | |
---|
[15293] | 1102 | % @refill is a no-op. |
---|
| 1103 | \let\refill=\relax |
---|
| 1104 | |
---|
| 1105 | % If working on a large document in chapters, it is convenient to |
---|
| 1106 | % be able to disable indexing, cross-referencing, and contents, for test runs. |
---|
| 1107 | % This is done with @novalidate (before @setfilename). |
---|
| 1108 | % |
---|
| 1109 | \newif\iflinks \linkstrue % by default we want the aux files. |
---|
| 1110 | \let\novalidate = \linksfalse |
---|
| 1111 | |
---|
| 1112 | % @setfilename is done at the beginning of every texinfo file. |
---|
| 1113 | % So open here the files we need to have open while reading the input. |
---|
| 1114 | % This makes it possible to make a .fmt file for texinfo. |
---|
| 1115 | \def\setfilename{% |
---|
[22253] | 1116 | \fixbackslash % Turn off hack to swallow `\input texinfo'. |
---|
[15293] | 1117 | \iflinks |
---|
[22253] | 1118 | \tryauxfile |
---|
| 1119 | % Open the new aux file. TeX will close it automatically at exit. |
---|
| 1120 | \immediate\openout\auxfile=\jobname.aux |
---|
[15293] | 1121 | \fi % \openindices needs to do some work in any case. |
---|
| 1122 | \openindices |
---|
[22253] | 1123 | \let\setfilename=\comment % Ignore extra @setfilename cmds. |
---|
[15293] | 1124 | % |
---|
| 1125 | % If texinfo.cnf is present on the system, read it. |
---|
| 1126 | % Useful for site-wide @afourpaper, etc. |
---|
| 1127 | \openin 1 texinfo.cnf |
---|
[22253] | 1128 | \ifeof 1 \else \input texinfo.cnf \fi |
---|
| 1129 | \closein 1 |
---|
[15293] | 1130 | % |
---|
| 1131 | \comment % Ignore the actual filename. |
---|
| 1132 | } |
---|
| 1133 | |
---|
| 1134 | % Called from \setfilename. |
---|
| 1135 | % |
---|
| 1136 | \def\openindices{% |
---|
| 1137 | \newindex{cp}% |
---|
| 1138 | \newcodeindex{fn}% |
---|
| 1139 | \newcodeindex{vr}% |
---|
| 1140 | \newcodeindex{tp}% |
---|
| 1141 | \newcodeindex{ky}% |
---|
| 1142 | \newcodeindex{pg}% |
---|
| 1143 | } |
---|
| 1144 | |
---|
| 1145 | % @bye. |
---|
| 1146 | \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} |
---|
| 1147 | |
---|
| 1148 | |
---|
[18190] | 1149 | \message{pdf,} |
---|
| 1150 | % adobe `portable' document format |
---|
| 1151 | \newcount\tempnum |
---|
| 1152 | \newcount\lnkcount |
---|
| 1153 | \newtoks\filename |
---|
| 1154 | \newcount\filenamelength |
---|
| 1155 | \newcount\pgn |
---|
| 1156 | \newtoks\toksA |
---|
| 1157 | \newtoks\toksB |
---|
| 1158 | \newtoks\toksC |
---|
| 1159 | \newtoks\toksD |
---|
| 1160 | \newbox\boxA |
---|
| 1161 | \newcount\countA |
---|
| 1162 | \newif\ifpdf |
---|
| 1163 | \newif\ifpdfmakepagedest |
---|
| 1164 | |
---|
[22253] | 1165 | % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 |
---|
| 1166 | % can be set). So we test for \relax and 0 as well as \undefined, |
---|
| 1167 | % borrowed from ifpdf.sty. |
---|
[18190] | 1168 | \ifx\pdfoutput\undefined |
---|
| 1169 | \else |
---|
[22253] | 1170 | \ifx\pdfoutput\relax |
---|
| 1171 | \else |
---|
| 1172 | \ifcase\pdfoutput |
---|
| 1173 | \else |
---|
| 1174 | \pdftrue |
---|
| 1175 | \fi |
---|
| 1176 | \fi |
---|
| 1177 | \fi |
---|
| 1178 | % |
---|
| 1179 | \ifpdf |
---|
[18190] | 1180 | \input pdfcolor |
---|
[22253] | 1181 | \pdfcatalog{/PageMode /UseOutlines}% |
---|
[18190] | 1182 | \def\dopdfimage#1#2#3{% |
---|
| 1183 | \def\imagewidth{#2}% |
---|
| 1184 | \def\imageheight{#3}% |
---|
| 1185 | % without \immediate, pdftex seg faults when the same image is |
---|
| 1186 | % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) |
---|
| 1187 | \ifnum\pdftexversion < 14 |
---|
| 1188 | \immediate\pdfimage |
---|
| 1189 | \else |
---|
| 1190 | \immediate\pdfximage |
---|
| 1191 | \fi |
---|
| 1192 | \ifx\empty\imagewidth\else width \imagewidth \fi |
---|
| 1193 | \ifx\empty\imageheight\else height \imageheight \fi |
---|
| 1194 | \ifnum\pdftexversion<13 |
---|
[22253] | 1195 | #1.pdf% |
---|
[18190] | 1196 | \else |
---|
| 1197 | {#1.pdf}% |
---|
| 1198 | \fi |
---|
| 1199 | \ifnum\pdftexversion < 14 \else |
---|
| 1200 | \pdfrefximage \pdflastximage |
---|
| 1201 | \fi} |
---|
[22253] | 1202 | \def\pdfmkdest#1{{% |
---|
| 1203 | % We have to set dummies so commands such as @code in a section title |
---|
| 1204 | % aren't expanded. |
---|
| 1205 | \atdummies |
---|
| 1206 | \normalturnoffactive |
---|
| 1207 | \pdfdest name{#1} xyz% |
---|
| 1208 | }} |
---|
[18190] | 1209 | \def\pdfmkpgn#1{#1} |
---|
| 1210 | \let\linkcolor = \Blue % was Cyan, but that seems light? |
---|
| 1211 | \def\endlink{\Black\pdfendlink} |
---|
| 1212 | % Adding outlines to PDF; macros for calculating structure of outlines |
---|
| 1213 | % come from Petr Olsak |
---|
| 1214 | \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% |
---|
| 1215 | \else \csname#1\endcsname \fi} |
---|
| 1216 | \def\advancenumber#1{\tempnum=\expnumber{#1}\relax |
---|
[22253] | 1217 | \advance\tempnum by 1 |
---|
[18190] | 1218 | \expandafter\xdef\csname#1\endcsname{\the\tempnum}} |
---|
[22253] | 1219 | % |
---|
| 1220 | % #1 is the section text. #2 is the pdf expression for the number |
---|
| 1221 | % of subentries (or empty, for subsubsections). #3 is the node |
---|
| 1222 | % text, which might be empty if this toc entry had no |
---|
| 1223 | % corresponding node. #4 is the page number. |
---|
| 1224 | % |
---|
| 1225 | \def\dopdfoutline#1#2#3#4{% |
---|
| 1226 | % Generate a link to the node text if that exists; else, use the |
---|
| 1227 | % page number. We could generate a destination for the section |
---|
| 1228 | % text in the case where a section has no node, but it doesn't |
---|
| 1229 | % seem worthwhile, since most documents are normally structured. |
---|
| 1230 | \def\pdfoutlinedest{#3}% |
---|
| 1231 | \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi |
---|
| 1232 | % |
---|
| 1233 | \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}% |
---|
| 1234 | } |
---|
| 1235 | % |
---|
| 1236 | \def\pdfmakeoutlines{% |
---|
| 1237 | \begingroup |
---|
| 1238 | % Thanh's hack / proper braces in bookmarks |
---|
[18190] | 1239 | \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace |
---|
| 1240 | \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace |
---|
| 1241 | % |
---|
[22253] | 1242 | % Read toc silently, to get counts of subentries for \pdfoutline. |
---|
| 1243 | \def\numchapentry##1##2##3##4{% |
---|
| 1244 | \def\thischapnum{##2}% |
---|
| 1245 | \let\thissecnum\empty |
---|
| 1246 | \let\thissubsecnum\empty |
---|
| 1247 | }% |
---|
| 1248 | \def\numsecentry##1##2##3##4{% |
---|
| 1249 | \advancenumber{chap\thischapnum}% |
---|
| 1250 | \def\thissecnum{##2}% |
---|
| 1251 | \let\thissubsecnum\empty |
---|
| 1252 | }% |
---|
| 1253 | \def\numsubsecentry##1##2##3##4{% |
---|
| 1254 | \advancenumber{sec\thissecnum}% |
---|
| 1255 | \def\thissubsecnum{##2}% |
---|
| 1256 | }% |
---|
| 1257 | \def\numsubsubsecentry##1##2##3##4{% |
---|
| 1258 | \advancenumber{subsec\thissubsecnum}% |
---|
| 1259 | }% |
---|
| 1260 | \let\thischapnum\empty |
---|
| 1261 | \let\thissecnum\empty |
---|
| 1262 | \let\thissubsecnum\empty |
---|
| 1263 | % |
---|
| 1264 | % use \def rather than \let here because we redefine \chapentry et |
---|
| 1265 | % al. a second time, below. |
---|
| 1266 | \def\appentry{\numchapentry}% |
---|
| 1267 | \def\appsecentry{\numsecentry}% |
---|
| 1268 | \def\appsubsecentry{\numsubsecentry}% |
---|
| 1269 | \def\appsubsubsecentry{\numsubsubsecentry}% |
---|
| 1270 | \def\unnchapentry{\numchapentry}% |
---|
| 1271 | \def\unnsecentry{\numsecentry}% |
---|
| 1272 | \def\unnsubsecentry{\numsubsecentry}% |
---|
| 1273 | \def\unnsubsubsecentry{\numsubsubsecentry}% |
---|
[18190] | 1274 | \input \jobname.toc |
---|
[22253] | 1275 | % |
---|
| 1276 | % Read toc second time, this time actually producing the outlines. |
---|
| 1277 | % The `-' means take the \expnumber as the absolute number of |
---|
| 1278 | % subentries, which we calculated on our first read of the .toc above. |
---|
| 1279 | % |
---|
| 1280 | % We use the node names as the destinations. |
---|
| 1281 | \def\numchapentry##1##2##3##4{% |
---|
| 1282 | \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% |
---|
| 1283 | \def\numsecentry##1##2##3##4{% |
---|
| 1284 | \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% |
---|
| 1285 | \def\numsubsecentry##1##2##3##4{% |
---|
| 1286 | \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% |
---|
| 1287 | \def\numsubsubsecentry##1##2##3##4{% count is always zero |
---|
| 1288 | \dopdfoutline{##1}{}{##3}{##4}}% |
---|
| 1289 | % |
---|
| 1290 | % PDF outlines are displayed using system fonts, instead of |
---|
| 1291 | % document fonts. Therefore we cannot use special characters, |
---|
| 1292 | % since the encoding is unknown. For example, the eogonek from |
---|
| 1293 | % Latin 2 (0xea) gets translated to a | character. Info from |
---|
| 1294 | % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. |
---|
| 1295 | % |
---|
| 1296 | % xx to do this right, we have to translate 8-bit characters to |
---|
| 1297 | % their "best" equivalent, based on the @documentencoding. Right |
---|
| 1298 | % now, I guess we'll just let the pdf reader have its way. |
---|
| 1299 | \indexnofonts |
---|
| 1300 | \turnoffactive |
---|
[18190] | 1301 | \input \jobname.toc |
---|
[22253] | 1302 | \endgroup |
---|
| 1303 | } |
---|
| 1304 | % |
---|
[18190] | 1305 | \def\makelinks #1,{% |
---|
| 1306 | \def\params{#1}\def\E{END}% |
---|
| 1307 | \ifx\params\E |
---|
| 1308 | \let\nextmakelinks=\relax |
---|
| 1309 | \else |
---|
| 1310 | \let\nextmakelinks=\makelinks |
---|
| 1311 | \ifnum\lnkcount>0,\fi |
---|
| 1312 | \picknum{#1}% |
---|
[22253] | 1313 | \startlink attr{/Border [0 0 0]} |
---|
[18190] | 1314 | goto name{\pdfmkpgn{\the\pgn}}% |
---|
| 1315 | \linkcolor #1% |
---|
| 1316 | \advance\lnkcount by 1% |
---|
| 1317 | \endlink |
---|
| 1318 | \fi |
---|
| 1319 | \nextmakelinks |
---|
| 1320 | } |
---|
| 1321 | \def\picknum#1{\expandafter\pn#1} |
---|
| 1322 | \def\pn#1{% |
---|
| 1323 | \def\p{#1}% |
---|
| 1324 | \ifx\p\lbrace |
---|
| 1325 | \let\nextpn=\ppn |
---|
| 1326 | \else |
---|
| 1327 | \let\nextpn=\ppnn |
---|
| 1328 | \def\first{#1} |
---|
| 1329 | \fi |
---|
| 1330 | \nextpn |
---|
| 1331 | } |
---|
| 1332 | \def\ppn#1{\pgn=#1\gobble} |
---|
| 1333 | \def\ppnn{\pgn=\first} |
---|
| 1334 | \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,} |
---|
| 1335 | \def\skipspaces#1{\def\PP{#1}\def\D{|}% |
---|
| 1336 | \ifx\PP\D\let\nextsp\relax |
---|
| 1337 | \else\let\nextsp\skipspaces |
---|
| 1338 | \ifx\p\space\else\addtokens{\filename}{\PP}% |
---|
| 1339 | \advance\filenamelength by 1 |
---|
| 1340 | \fi |
---|
| 1341 | \fi |
---|
| 1342 | \nextsp} |
---|
| 1343 | \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} |
---|
| 1344 | \ifnum\pdftexversion < 14 |
---|
| 1345 | \let \startlink \pdfannotlink |
---|
| 1346 | \else |
---|
| 1347 | \let \startlink \pdfstartlink |
---|
| 1348 | \fi |
---|
| 1349 | \def\pdfurl#1{% |
---|
| 1350 | \begingroup |
---|
| 1351 | \normalturnoffactive\def\@{@}% |
---|
[22253] | 1352 | \makevalueexpandable |
---|
[18190] | 1353 | \leavevmode\Red |
---|
| 1354 | \startlink attr{/Border [0 0 0]}% |
---|
| 1355 | user{/Subtype /Link /A << /S /URI /URI (#1) >>}% |
---|
| 1356 | \endgroup} |
---|
| 1357 | \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} |
---|
| 1358 | \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} |
---|
| 1359 | \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} |
---|
| 1360 | \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} |
---|
| 1361 | \def\maketoks{% |
---|
[22253] | 1362 | \expandafter\poptoks\the\toksA|ENDTOKS|\relax |
---|
[18190] | 1363 | \ifx\first0\adn0 |
---|
| 1364 | \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 |
---|
| 1365 | \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 |
---|
[22253] | 1366 | \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 |
---|
[18190] | 1367 | \else |
---|
| 1368 | \ifnum0=\countA\else\makelink\fi |
---|
| 1369 | \ifx\first.\let\next=\done\else |
---|
| 1370 | \let\next=\maketoks |
---|
| 1371 | \addtokens{\toksB}{\the\toksD} |
---|
| 1372 | \ifx\first,\addtokens{\toksB}{\space}\fi |
---|
| 1373 | \fi |
---|
| 1374 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi |
---|
| 1375 | \next} |
---|
| 1376 | \def\makelink{\addtokens{\toksB}% |
---|
| 1377 | {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} |
---|
| 1378 | \def\pdflink#1{% |
---|
| 1379 | \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} |
---|
| 1380 | \linkcolor #1\endlink} |
---|
| 1381 | \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} |
---|
[22253] | 1382 | \else |
---|
| 1383 | \let\pdfmkdest = \gobble |
---|
| 1384 | \let\pdfurl = \gobble |
---|
| 1385 | \let\endlink = \relax |
---|
| 1386 | \let\linkcolor = \relax |
---|
| 1387 | \let\pdfmakeoutlines = \relax |
---|
| 1388 | \fi % \ifx\pdfoutput |
---|
[18190] | 1389 | |
---|
| 1390 | |
---|
[15293] | 1391 | \message{fonts,} |
---|
| 1392 | |
---|
[22253] | 1393 | % Change the current font style to #1, remembering it in \curfontstyle. |
---|
| 1394 | % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in |
---|
| 1395 | % italics, not bold italics. |
---|
| 1396 | % |
---|
| 1397 | \def\setfontstyle#1{% |
---|
| 1398 | \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. |
---|
| 1399 | \csname ten#1\endcsname % change the current font |
---|
| 1400 | } |
---|
| 1401 | |
---|
| 1402 | % Select #1 fonts with the current style. |
---|
| 1403 | % |
---|
| 1404 | \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} |
---|
| 1405 | |
---|
| 1406 | \def\rm{\fam=0 \setfontstyle{rm}} |
---|
| 1407 | \def\it{\fam=\itfam \setfontstyle{it}} |
---|
| 1408 | \def\sl{\fam=\slfam \setfontstyle{sl}} |
---|
| 1409 | \def\bf{\fam=\bffam \setfontstyle{bf}} |
---|
| 1410 | \def\tt{\fam=\ttfam \setfontstyle{tt}} |
---|
| 1411 | |
---|
[15293] | 1412 | % Texinfo sort of supports the sans serif font style, which plain TeX does not. |
---|
[22253] | 1413 | % So we set up a \sf. |
---|
[15293] | 1414 | \newfam\sffam |
---|
[22253] | 1415 | \def\sf{\fam=\sffam \setfontstyle{sf}} |
---|
[15293] | 1416 | \let\li = \sf % Sometimes we call it \li, not \sf. |
---|
| 1417 | |
---|
[22253] | 1418 | % We don't need math for this font style. |
---|
| 1419 | \def\ttsl{\setfontstyle{ttsl}} |
---|
[15293] | 1420 | |
---|
[18190] | 1421 | % Default leading. |
---|
| 1422 | \newdimen\textleading \textleading = 13.2pt |
---|
[15293] | 1423 | |
---|
[18190] | 1424 | % Set the baselineskip to #1, and the lineskip and strut size |
---|
| 1425 | % correspondingly. There is no deep meaning behind these magic numbers |
---|
| 1426 | % used as factors; they just match (closely enough) what Knuth defined. |
---|
| 1427 | % |
---|
| 1428 | \def\lineskipfactor{.08333} |
---|
| 1429 | \def\strutheightpercent{.70833} |
---|
| 1430 | \def\strutdepthpercent {.29167} |
---|
| 1431 | % |
---|
| 1432 | \def\setleading#1{% |
---|
| 1433 | \normalbaselineskip = #1\relax |
---|
| 1434 | \normallineskip = \lineskipfactor\normalbaselineskip |
---|
| 1435 | \normalbaselines |
---|
| 1436 | \setbox\strutbox =\hbox{% |
---|
| 1437 | \vrule width0pt height\strutheightpercent\baselineskip |
---|
| 1438 | depth \strutdepthpercent \baselineskip |
---|
| 1439 | }% |
---|
| 1440 | } |
---|
| 1441 | |
---|
[15293] | 1442 | % Set the font macro #1 to the font named #2, adding on the |
---|
| 1443 | % specified font prefix (normally `cm'). |
---|
| 1444 | % #3 is the font's design size, #4 is a scale factor |
---|
| 1445 | \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} |
---|
| 1446 | |
---|
| 1447 | % Use cm as the default font prefix. |
---|
| 1448 | % To specify the font prefix, you must define \fontprefix |
---|
| 1449 | % before you read in texinfo.tex. |
---|
| 1450 | \ifx\fontprefix\undefined |
---|
| 1451 | \def\fontprefix{cm} |
---|
| 1452 | \fi |
---|
| 1453 | % Support font families that don't use the same naming scheme as CM. |
---|
| 1454 | \def\rmshape{r} |
---|
| 1455 | \def\rmbshape{bx} %where the normal face is bold |
---|
| 1456 | \def\bfshape{b} |
---|
| 1457 | \def\bxshape{bx} |
---|
| 1458 | \def\ttshape{tt} |
---|
| 1459 | \def\ttbshape{tt} |
---|
| 1460 | \def\ttslshape{sltt} |
---|
| 1461 | \def\itshape{ti} |
---|
| 1462 | \def\itbshape{bxti} |
---|
| 1463 | \def\slshape{sl} |
---|
| 1464 | \def\slbshape{bxsl} |
---|
| 1465 | \def\sfshape{ss} |
---|
| 1466 | \def\sfbshape{ss} |
---|
| 1467 | \def\scshape{csc} |
---|
| 1468 | \def\scbshape{csc} |
---|
| 1469 | |
---|
[22253] | 1470 | % Text fonts (11.2pt, magstep1). |
---|
[18190] | 1471 | \newcount\mainmagstep |
---|
[15293] | 1472 | \ifx\bigger\relax |
---|
[18190] | 1473 | % not really supported. |
---|
[22253] | 1474 | \mainmagstep=\magstep1 |
---|
[18190] | 1475 | \setfont\textrm\rmshape{12}{1000} |
---|
| 1476 | \setfont\texttt\ttshape{12}{1000} |
---|
[15293] | 1477 | \else |
---|
[18190] | 1478 | \mainmagstep=\magstephalf |
---|
| 1479 | \setfont\textrm\rmshape{10}{\mainmagstep} |
---|
| 1480 | \setfont\texttt\ttshape{10}{\mainmagstep} |
---|
[15293] | 1481 | \fi |
---|
| 1482 | \setfont\textbf\bfshape{10}{\mainmagstep} |
---|
| 1483 | \setfont\textit\itshape{10}{\mainmagstep} |
---|
| 1484 | \setfont\textsl\slshape{10}{\mainmagstep} |
---|
| 1485 | \setfont\textsf\sfshape{10}{\mainmagstep} |
---|
| 1486 | \setfont\textsc\scshape{10}{\mainmagstep} |
---|
| 1487 | \setfont\textttsl\ttslshape{10}{\mainmagstep} |
---|
| 1488 | \font\texti=cmmi10 scaled \mainmagstep |
---|
| 1489 | \font\textsy=cmsy10 scaled \mainmagstep |
---|
| 1490 | |
---|
[22253] | 1491 | % A few fonts for @defun names and args. |
---|
| 1492 | \setfont\defbf\bfshape{10}{\magstep1} |
---|
[15293] | 1493 | \setfont\deftt\ttshape{10}{\magstep1} |
---|
[22253] | 1494 | \setfont\defttsl\ttslshape{10}{\magstep1} |
---|
| 1495 | \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} |
---|
[15293] | 1496 | |
---|
[18190] | 1497 | % Fonts for indices, footnotes, small examples (9pt). |
---|
| 1498 | \setfont\smallrm\rmshape{9}{1000} |
---|
| 1499 | \setfont\smalltt\ttshape{9}{1000} |
---|
| 1500 | \setfont\smallbf\bfshape{10}{900} |
---|
| 1501 | \setfont\smallit\itshape{9}{1000} |
---|
| 1502 | \setfont\smallsl\slshape{9}{1000} |
---|
| 1503 | \setfont\smallsf\sfshape{9}{1000} |
---|
| 1504 | \setfont\smallsc\scshape{10}{900} |
---|
| 1505 | \setfont\smallttsl\ttslshape{10}{900} |
---|
| 1506 | \font\smalli=cmmi9 |
---|
| 1507 | \font\smallsy=cmsy9 |
---|
[15293] | 1508 | |
---|
[18190] | 1509 | % Fonts for small examples (8pt). |
---|
| 1510 | \setfont\smallerrm\rmshape{8}{1000} |
---|
| 1511 | \setfont\smallertt\ttshape{8}{1000} |
---|
| 1512 | \setfont\smallerbf\bfshape{10}{800} |
---|
| 1513 | \setfont\smallerit\itshape{8}{1000} |
---|
| 1514 | \setfont\smallersl\slshape{8}{1000} |
---|
| 1515 | \setfont\smallersf\sfshape{8}{1000} |
---|
| 1516 | \setfont\smallersc\scshape{10}{800} |
---|
| 1517 | \setfont\smallerttsl\ttslshape{10}{800} |
---|
| 1518 | \font\smalleri=cmmi8 |
---|
| 1519 | \font\smallersy=cmsy8 |
---|
| 1520 | |
---|
[22253] | 1521 | % Fonts for title page (20.4pt): |
---|
[15293] | 1522 | \setfont\titlerm\rmbshape{12}{\magstep3} |
---|
| 1523 | \setfont\titleit\itbshape{10}{\magstep4} |
---|
| 1524 | \setfont\titlesl\slbshape{10}{\magstep4} |
---|
| 1525 | \setfont\titlett\ttbshape{12}{\magstep3} |
---|
| 1526 | \setfont\titlettsl\ttslshape{10}{\magstep4} |
---|
| 1527 | \setfont\titlesf\sfbshape{17}{\magstep1} |
---|
| 1528 | \let\titlebf=\titlerm |
---|
| 1529 | \setfont\titlesc\scbshape{10}{\magstep4} |
---|
| 1530 | \font\titlei=cmmi12 scaled \magstep3 |
---|
| 1531 | \font\titlesy=cmsy10 scaled \magstep4 |
---|
| 1532 | \def\authorrm{\secrm} |
---|
[22253] | 1533 | \def\authortt{\sectt} |
---|
[15293] | 1534 | |
---|
| 1535 | % Chapter (and unnumbered) fonts (17.28pt). |
---|
| 1536 | \setfont\chaprm\rmbshape{12}{\magstep2} |
---|
| 1537 | \setfont\chapit\itbshape{10}{\magstep3} |
---|
| 1538 | \setfont\chapsl\slbshape{10}{\magstep3} |
---|
| 1539 | \setfont\chaptt\ttbshape{12}{\magstep2} |
---|
| 1540 | \setfont\chapttsl\ttslshape{10}{\magstep3} |
---|
| 1541 | \setfont\chapsf\sfbshape{17}{1000} |
---|
| 1542 | \let\chapbf=\chaprm |
---|
| 1543 | \setfont\chapsc\scbshape{10}{\magstep3} |
---|
| 1544 | \font\chapi=cmmi12 scaled \magstep2 |
---|
| 1545 | \font\chapsy=cmsy10 scaled \magstep3 |
---|
| 1546 | |
---|
| 1547 | % Section fonts (14.4pt). |
---|
| 1548 | \setfont\secrm\rmbshape{12}{\magstep1} |
---|
| 1549 | \setfont\secit\itbshape{10}{\magstep2} |
---|
| 1550 | \setfont\secsl\slbshape{10}{\magstep2} |
---|
| 1551 | \setfont\sectt\ttbshape{12}{\magstep1} |
---|
| 1552 | \setfont\secttsl\ttslshape{10}{\magstep2} |
---|
| 1553 | \setfont\secsf\sfbshape{12}{\magstep1} |
---|
| 1554 | \let\secbf\secrm |
---|
| 1555 | \setfont\secsc\scbshape{10}{\magstep2} |
---|
| 1556 | \font\seci=cmmi12 scaled \magstep1 |
---|
| 1557 | \font\secsy=cmsy10 scaled \magstep2 |
---|
| 1558 | |
---|
| 1559 | % Subsection fonts (13.15pt). |
---|
| 1560 | \setfont\ssecrm\rmbshape{12}{\magstephalf} |
---|
| 1561 | \setfont\ssecit\itbshape{10}{1315} |
---|
| 1562 | \setfont\ssecsl\slbshape{10}{1315} |
---|
| 1563 | \setfont\ssectt\ttbshape{12}{\magstephalf} |
---|
| 1564 | \setfont\ssecttsl\ttslshape{10}{1315} |
---|
| 1565 | \setfont\ssecsf\sfbshape{12}{\magstephalf} |
---|
| 1566 | \let\ssecbf\ssecrm |
---|
[22253] | 1567 | \setfont\ssecsc\scbshape{10}{1315} |
---|
[15293] | 1568 | \font\sseci=cmmi12 scaled \magstephalf |
---|
| 1569 | \font\ssecsy=cmsy10 scaled 1315 |
---|
| 1570 | |
---|
[22253] | 1571 | % Reduced fonts for @acro in text (10pt). |
---|
| 1572 | \setfont\reducedrm\rmshape{10}{1000} |
---|
| 1573 | \setfont\reducedtt\ttshape{10}{1000} |
---|
| 1574 | \setfont\reducedbf\bfshape{10}{1000} |
---|
| 1575 | \setfont\reducedit\itshape{10}{1000} |
---|
| 1576 | \setfont\reducedsl\slshape{10}{1000} |
---|
| 1577 | \setfont\reducedsf\sfshape{10}{1000} |
---|
| 1578 | \setfont\reducedsc\scshape{10}{1000} |
---|
| 1579 | \setfont\reducedttsl\ttslshape{10}{1000} |
---|
| 1580 | \font\reducedi=cmmi10 |
---|
| 1581 | \font\reducedsy=cmsy10 |
---|
| 1582 | |
---|
[15293] | 1583 | % In order for the font changes to affect most math symbols and letters, |
---|
| 1584 | % we have to define the \textfont of the standard families. Since |
---|
[18190] | 1585 | % texinfo doesn't allow for producing subscripts and superscripts except |
---|
| 1586 | % in the main text, we don't bother to reset \scriptfont and |
---|
| 1587 | % \scriptscriptfont (which would also require loading a lot more fonts). |
---|
[15293] | 1588 | % |
---|
| 1589 | \def\resetmathfonts{% |
---|
[18190] | 1590 | \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy |
---|
| 1591 | \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf |
---|
| 1592 | \textfont\ttfam=\tentt \textfont\sffam=\tensf |
---|
[15293] | 1593 | } |
---|
| 1594 | |
---|
| 1595 | % The font-changing commands redefine the meanings of \tenSTYLE, instead |
---|
[22253] | 1596 | % of just \STYLE. We do this because \STYLE needs to also set the |
---|
| 1597 | % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire |
---|
| 1598 | % \tenSTYLE to set the current font. |
---|
| 1599 | % |
---|
| 1600 | % Each font-changing command also sets the names \lsize (one size lower) |
---|
| 1601 | % and \lllsize (three sizes lower). These relative commands are used in |
---|
| 1602 | % the LaTeX logo and acronyms. |
---|
| 1603 | % |
---|
| 1604 | % This all needs generalizing, badly. |
---|
| 1605 | % |
---|
[15293] | 1606 | \def\textfonts{% |
---|
| 1607 | \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl |
---|
| 1608 | \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc |
---|
[22253] | 1609 | \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy |
---|
| 1610 | \let\tenttsl=\textttsl |
---|
| 1611 | \def\lsize{reduced}\def\lllsize{smaller}% |
---|
[18190] | 1612 | \resetmathfonts \setleading{\textleading}} |
---|
[15293] | 1613 | \def\titlefonts{% |
---|
| 1614 | \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl |
---|
| 1615 | \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc |
---|
| 1616 | \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy |
---|
| 1617 | \let\tenttsl=\titlettsl |
---|
[22253] | 1618 | \def\lsize{chap}\def\lllsize{subsec}% |
---|
[15293] | 1619 | \resetmathfonts \setleading{25pt}} |
---|
| 1620 | \def\titlefont#1{{\titlefonts\rm #1}} |
---|
| 1621 | \def\chapfonts{% |
---|
| 1622 | \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl |
---|
| 1623 | \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc |
---|
| 1624 | \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl |
---|
[22253] | 1625 | \def\lsize{sec}\def\lllsize{text}% |
---|
[15293] | 1626 | \resetmathfonts \setleading{19pt}} |
---|
| 1627 | \def\secfonts{% |
---|
| 1628 | \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl |
---|
| 1629 | \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc |
---|
[22253] | 1630 | \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy |
---|
| 1631 | \let\tenttsl=\secttsl |
---|
| 1632 | \def\lsize{subsec}\def\lllsize{reduced}% |
---|
[15293] | 1633 | \resetmathfonts \setleading{16pt}} |
---|
| 1634 | \def\subsecfonts{% |
---|
| 1635 | \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl |
---|
| 1636 | \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc |
---|
[22253] | 1637 | \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy |
---|
| 1638 | \let\tenttsl=\ssecttsl |
---|
| 1639 | \def\lsize{text}\def\lllsize{small}% |
---|
[15293] | 1640 | \resetmathfonts \setleading{15pt}} |
---|
[22253] | 1641 | \let\subsubsecfonts = \subsecfonts |
---|
| 1642 | \def\reducedfonts{% |
---|
| 1643 | \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl |
---|
| 1644 | \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc |
---|
| 1645 | \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy |
---|
| 1646 | \let\tenttsl=\reducedttsl |
---|
| 1647 | \def\lsize{small}\def\lllsize{smaller}% |
---|
| 1648 | \resetmathfonts \setleading{10.5pt}} |
---|
[18190] | 1649 | \def\smallfonts{% |
---|
| 1650 | \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl |
---|
| 1651 | \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc |
---|
| 1652 | \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy |
---|
| 1653 | \let\tenttsl=\smallttsl |
---|
[22253] | 1654 | \def\lsize{smaller}\def\lllsize{smaller}% |
---|
[18190] | 1655 | \resetmathfonts \setleading{10.5pt}} |
---|
| 1656 | \def\smallerfonts{% |
---|
| 1657 | \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl |
---|
| 1658 | \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc |
---|
| 1659 | \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy |
---|
| 1660 | \let\tenttsl=\smallerttsl |
---|
[22253] | 1661 | \def\lsize{smaller}\def\lllsize{smaller}% |
---|
[18190] | 1662 | \resetmathfonts \setleading{9.5pt}} |
---|
[15293] | 1663 | |
---|
[22253] | 1664 | % Set the fonts to use with the @small... environments. |
---|
| 1665 | \let\smallexamplefonts = \smallfonts |
---|
| 1666 | |
---|
| 1667 | % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample |
---|
| 1668 | % can fit this many characters: |
---|
| 1669 | % 8.5x11=86 smallbook=72 a4=90 a5=69 |
---|
| 1670 | % If we use \scriptfonts (8pt), then we can fit this many characters: |
---|
| 1671 | % 8.5x11=90+ smallbook=80 a4=90+ a5=77 |
---|
| 1672 | % For me, subjectively, the few extra characters that fit aren't worth |
---|
| 1673 | % the additional smallness of 8pt. So I'm making the default 9pt. |
---|
| 1674 | % |
---|
| 1675 | % By the way, for comparison, here's what fits with @example (10pt): |
---|
| 1676 | % 8.5x11=71 smallbook=60 a4=75 a5=58 |
---|
| 1677 | % |
---|
| 1678 | % I wish the USA used A4 paper. |
---|
| 1679 | % --karl, 24jan03. |
---|
| 1680 | |
---|
| 1681 | |
---|
[15293] | 1682 | % Set up the default fonts, so we can use them for creating boxes. |
---|
| 1683 | % |
---|
[22253] | 1684 | \textfonts \rm |
---|
[15293] | 1685 | |
---|
| 1686 | % Define these so they can be easily changed for other fonts. |
---|
| 1687 | \def\angleleft{$\langle$} |
---|
| 1688 | \def\angleright{$\rangle$} |
---|
| 1689 | |
---|
| 1690 | % Count depth in font-changes, for error checks |
---|
| 1691 | \newcount\fontdepth \fontdepth=0 |
---|
| 1692 | |
---|
| 1693 | % Fonts for short table of contents. |
---|
| 1694 | \setfont\shortcontrm\rmshape{12}{1000} |
---|
[22253] | 1695 | \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12 |
---|
[15293] | 1696 | \setfont\shortcontsl\slshape{12}{1000} |
---|
[22253] | 1697 | \setfont\shortconttt\ttshape{12}{1000} |
---|
[15293] | 1698 | |
---|
| 1699 | %% Add scribe-like font environments, plus @l for inline lisp (usually sans |
---|
| 1700 | %% serif) and @ii for TeX italic |
---|
| 1701 | |
---|
| 1702 | % \smartitalic{ARG} outputs arg in italics, followed by an italic correction |
---|
| 1703 | % unless the following character is such as not to need one. |
---|
[22253] | 1704 | \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else |
---|
| 1705 | \ptexslash\fi\fi\fi} |
---|
| 1706 | \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} |
---|
| 1707 | \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} |
---|
[15293] | 1708 | |
---|
[22253] | 1709 | % like \smartslanted except unconditionally uses \ttsl. |
---|
| 1710 | % @var is set to this for defun arguments. |
---|
| 1711 | \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} |
---|
| 1712 | |
---|
| 1713 | % like \smartslanted except unconditionally use \sl. We never want |
---|
| 1714 | % ttsl for book titles, do we? |
---|
| 1715 | \def\cite#1{{\sl #1}\futurelet\next\smartitalicx} |
---|
| 1716 | |
---|
[15293] | 1717 | \let\i=\smartitalic |
---|
| 1718 | \let\var=\smartslanted |
---|
| 1719 | \let\dfn=\smartslanted |
---|
| 1720 | \let\emph=\smartitalic |
---|
| 1721 | |
---|
| 1722 | \def\b#1{{\bf #1}} |
---|
| 1723 | \let\strong=\b |
---|
| 1724 | |
---|
| 1725 | % We can't just use \exhyphenpenalty, because that only has effect at |
---|
| 1726 | % the end of a paragraph. Restore normal hyphenation at the end of the |
---|
| 1727 | % group within which \nohyphenation is presumably called. |
---|
| 1728 | % |
---|
| 1729 | \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} |
---|
| 1730 | \def\restorehyphenation{\hyphenchar\font = `- } |
---|
| 1731 | |
---|
[22253] | 1732 | % Set sfcode to normal for the chars that usually have another value. |
---|
| 1733 | % Can't use plain's \frenchspacing because it uses the `\x notation, and |
---|
| 1734 | % sometimes \x has an active definition that messes things up. |
---|
| 1735 | % |
---|
| 1736 | \catcode`@=11 |
---|
| 1737 | \def\frenchspacing{% |
---|
| 1738 | \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m |
---|
| 1739 | \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m |
---|
| 1740 | } |
---|
| 1741 | \catcode`@=\other |
---|
| 1742 | |
---|
[15293] | 1743 | \def\t#1{% |
---|
| 1744 | {\tt \rawbackslash \frenchspacing #1}% |
---|
| 1745 | \null |
---|
| 1746 | } |
---|
| 1747 | \def\samp#1{`\tclose{#1}'\null} |
---|
[18190] | 1748 | \setfont\keyrm\rmshape{8}{1000} |
---|
| 1749 | \font\keysy=cmsy9 |
---|
| 1750 | \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% |
---|
[15293] | 1751 | \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% |
---|
| 1752 | \vbox{\hrule\kern-0.4pt |
---|
| 1753 | \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% |
---|
| 1754 | \kern-0.4pt\hrule}% |
---|
| 1755 | \kern-.06em\raise0.4pt\hbox{\angleright}}}} |
---|
| 1756 | % The old definition, with no lozenge: |
---|
| 1757 | %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} |
---|
| 1758 | \def\ctrl #1{{\tt \rawbackslash \hat}#1} |
---|
| 1759 | |
---|
| 1760 | % @file, @option are the same as @samp. |
---|
| 1761 | \let\file=\samp |
---|
| 1762 | \let\option=\samp |
---|
| 1763 | |
---|
| 1764 | % @code is a modification of @t, |
---|
| 1765 | % which makes spaces the same size as normal in the surrounding text. |
---|
| 1766 | \def\tclose#1{% |
---|
| 1767 | {% |
---|
| 1768 | % Change normal interword space to be same as for the current font. |
---|
| 1769 | \spaceskip = \fontdimen2\font |
---|
| 1770 | % |
---|
| 1771 | % Switch to typewriter. |
---|
| 1772 | \tt |
---|
| 1773 | % |
---|
| 1774 | % But `\ ' produces the large typewriter interword space. |
---|
| 1775 | \def\ {{\spaceskip = 0pt{} }}% |
---|
| 1776 | % |
---|
| 1777 | % Turn off hyphenation. |
---|
| 1778 | \nohyphenation |
---|
| 1779 | % |
---|
| 1780 | \rawbackslash |
---|
| 1781 | \frenchspacing |
---|
| 1782 | #1% |
---|
| 1783 | }% |
---|
| 1784 | \null |
---|
| 1785 | } |
---|
| 1786 | |
---|
[22253] | 1787 | % We *must* turn on hyphenation at `-' and `_' in @code. |
---|
[15293] | 1788 | % Otherwise, it is too hard to avoid overfull hboxes |
---|
| 1789 | % in the Emacs manual, the Library manual, etc. |
---|
| 1790 | |
---|
| 1791 | % Unfortunately, TeX uses one parameter (\hyphenchar) to control |
---|
| 1792 | % both hyphenation at - and hyphenation within words. |
---|
| 1793 | % We must therefore turn them both off (\tclose does that) |
---|
| 1794 | % and arrange explicitly to hyphenate at a dash. |
---|
| 1795 | % -- rms. |
---|
| 1796 | { |
---|
| 1797 | \catcode`\-=\active |
---|
| 1798 | \catcode`\_=\active |
---|
| 1799 | % |
---|
| 1800 | \global\def\code{\begingroup |
---|
| 1801 | \catcode`\-=\active \let-\codedash |
---|
| 1802 | \catcode`\_=\active \let_\codeunder |
---|
| 1803 | \codex |
---|
| 1804 | } |
---|
| 1805 | } |
---|
| 1806 | |
---|
| 1807 | \def\realdash{-} |
---|
| 1808 | \def\codedash{-\discretionary{}{}{}} |
---|
[18190] | 1809 | \def\codeunder{% |
---|
| 1810 | % this is all so @math{@code{var_name}+1} can work. In math mode, _ |
---|
| 1811 | % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) |
---|
| 1812 | % will therefore expand the active definition of _, which is us |
---|
| 1813 | % (inside @code that is), therefore an endless loop. |
---|
| 1814 | \ifusingtt{\ifmmode |
---|
| 1815 | \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. |
---|
| 1816 | \else\normalunderscore \fi |
---|
| 1817 | \discretionary{}{}{}}% |
---|
| 1818 | {\_}% |
---|
| 1819 | } |
---|
[15293] | 1820 | \def\codex #1{\tclose{#1}\endgroup} |
---|
| 1821 | |
---|
| 1822 | % @kbd is like @code, except that if the argument is just one @key command, |
---|
| 1823 | % then @kbd has no effect. |
---|
| 1824 | |
---|
| 1825 | % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), |
---|
| 1826 | % `example' (@kbd uses ttsl only inside of @example and friends), |
---|
| 1827 | % or `code' (@kbd uses normal tty font always). |
---|
[22253] | 1828 | \parseargdef\kbdinputstyle{% |
---|
[15293] | 1829 | \def\arg{#1}% |
---|
| 1830 | \ifx\arg\worddistinct |
---|
| 1831 | \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% |
---|
| 1832 | \else\ifx\arg\wordexample |
---|
| 1833 | \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% |
---|
| 1834 | \else\ifx\arg\wordcode |
---|
| 1835 | \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% |
---|
[22253] | 1836 | \else |
---|
| 1837 | \errhelp = \EMsimple |
---|
| 1838 | \errmessage{Unknown @kbdinputstyle option `\arg'}% |
---|
[15293] | 1839 | \fi\fi\fi |
---|
| 1840 | } |
---|
| 1841 | \def\worddistinct{distinct} |
---|
| 1842 | \def\wordexample{example} |
---|
| 1843 | \def\wordcode{code} |
---|
| 1844 | |
---|
[22253] | 1845 | % Default is `distinct.' |
---|
| 1846 | \kbdinputstyle distinct |
---|
[15293] | 1847 | |
---|
| 1848 | \def\xkey{\key} |
---|
| 1849 | \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% |
---|
| 1850 | \ifx\one\xkey\ifx\threex\three \key{#2}% |
---|
| 1851 | \else{\tclose{\kbdfont\look}}\fi |
---|
| 1852 | \else{\tclose{\kbdfont\look}}\fi} |
---|
| 1853 | |
---|
[22253] | 1854 | % For @indicateurl, @env, @command quotes seem unnecessary, so use \code. |
---|
| 1855 | \let\indicateurl=\code |
---|
[15293] | 1856 | \let\env=\code |
---|
| 1857 | \let\command=\code |
---|
| 1858 | |
---|
| 1859 | % @uref (abbreviation for `urlref') takes an optional (comma-separated) |
---|
| 1860 | % second argument specifying the text to display and an optional third |
---|
| 1861 | % arg as text to display instead of (rather than in addition to) the url |
---|
| 1862 | % itself. First (mandatory) arg is the url. Perhaps eventually put in |
---|
| 1863 | % a hypertex \special here. |
---|
| 1864 | % |
---|
| 1865 | \def\uref#1{\douref #1,,,\finish} |
---|
[18190] | 1866 | \def\douref#1,#2,#3,#4\finish{\begingroup |
---|
| 1867 | \unsepspaces |
---|
| 1868 | \pdfurl{#1}% |
---|
[15293] | 1869 | \setbox0 = \hbox{\ignorespaces #3}% |
---|
| 1870 | \ifdim\wd0 > 0pt |
---|
| 1871 | \unhbox0 % third arg given, show only that |
---|
| 1872 | \else |
---|
| 1873 | \setbox0 = \hbox{\ignorespaces #2}% |
---|
| 1874 | \ifdim\wd0 > 0pt |
---|
[18190] | 1875 | \ifpdf |
---|
| 1876 | \unhbox0 % PDF: 2nd arg given, show only it |
---|
| 1877 | \else |
---|
| 1878 | \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url |
---|
| 1879 | \fi |
---|
[15293] | 1880 | \else |
---|
| 1881 | \code{#1}% only url given, so show it |
---|
| 1882 | \fi |
---|
| 1883 | \fi |
---|
[18190] | 1884 | \endlink |
---|
| 1885 | \endgroup} |
---|
[15293] | 1886 | |
---|
[22253] | 1887 | % @url synonym for @uref, since that's how everyone uses it. |
---|
| 1888 | % |
---|
| 1889 | \let\url=\uref |
---|
| 1890 | |
---|
[18190] | 1891 | % rms does not like angle brackets --karl, 17may97. |
---|
| 1892 | % So now @email is just like @uref, unless we are pdf. |
---|
[22253] | 1893 | % |
---|
[15293] | 1894 | %\def\email#1{\angleleft{\tt #1}\angleright} |
---|
[18190] | 1895 | \ifpdf |
---|
| 1896 | \def\email#1{\doemail#1,,\finish} |
---|
| 1897 | \def\doemail#1,#2,#3\finish{\begingroup |
---|
| 1898 | \unsepspaces |
---|
| 1899 | \pdfurl{mailto:#1}% |
---|
| 1900 | \setbox0 = \hbox{\ignorespaces #2}% |
---|
| 1901 | \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi |
---|
| 1902 | \endlink |
---|
| 1903 | \endgroup} |
---|
| 1904 | \else |
---|
| 1905 | \let\email=\uref |
---|
| 1906 | \fi |
---|
[15293] | 1907 | |
---|
| 1908 | % Check if we are currently using a typewriter font. Since all the |
---|
| 1909 | % Computer Modern typewriter fonts have zero interword stretch (and |
---|
| 1910 | % shrink), and it is reasonable to expect all typewriter fonts to have |
---|
| 1911 | % this property, we can check that font parameter. |
---|
| 1912 | % |
---|
| 1913 | \def\ifmonospace{\ifdim\fontdimen3\font=0pt } |
---|
| 1914 | |
---|
| 1915 | % Typeset a dimension, e.g., `in' or `pt'. The only reason for the |
---|
| 1916 | % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. |
---|
| 1917 | % |
---|
| 1918 | \def\dmn#1{\thinspace #1} |
---|
| 1919 | |
---|
| 1920 | \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} |
---|
| 1921 | |
---|
| 1922 | % @l was never documented to mean ``switch to the Lisp font'', |
---|
| 1923 | % and it is not used as such in any manual I can find. We need it for |
---|
| 1924 | % Polish suppressed-l. --karl, 22sep96. |
---|
| 1925 | %\def\l#1{{\li #1}\null} |
---|
| 1926 | |
---|
| 1927 | % Explicit font changes: @r, @sc, undocumented @ii. |
---|
| 1928 | \def\r#1{{\rm #1}} % roman font |
---|
| 1929 | \def\sc#1{{\smallcaps#1}} % smallcaps font |
---|
| 1930 | \def\ii#1{{\it #1}} % italic font |
---|
| 1931 | |
---|
[22253] | 1932 | \def\acronym#1{\doacronym #1,,\finish} |
---|
| 1933 | \def\doacronym#1,#2,#3\finish{% |
---|
| 1934 | {\selectfonts\lsize #1}% |
---|
| 1935 | \def\temp{#2}% |
---|
| 1936 | \ifx\temp\empty \else |
---|
| 1937 | \space ({\unsepspaces \ignorespaces \temp \unskip})% |
---|
| 1938 | \fi |
---|
| 1939 | } |
---|
[15293] | 1940 | |
---|
[22253] | 1941 | % @pounds{} is a sterling sign, which is in the CM italic font. |
---|
| 1942 | % |
---|
[15293] | 1943 | \def\pounds{{\it\$}} |
---|
| 1944 | |
---|
[22253] | 1945 | % @registeredsymbol - R in a circle. The font for the R should really |
---|
| 1946 | % be smaller yet, but lllsize is the best we can do for now. |
---|
| 1947 | % Adapted from the plain.tex definition of \copyright. |
---|
| 1948 | % |
---|
| 1949 | \def\registeredsymbol{% |
---|
| 1950 | $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% |
---|
| 1951 | \hfil\crcr\Orb}}% |
---|
| 1952 | }$% |
---|
| 1953 | } |
---|
[15293] | 1954 | |
---|
[22253] | 1955 | |
---|
[15293] | 1956 | \message{page headings,} |
---|
| 1957 | |
---|
| 1958 | \newskip\titlepagetopglue \titlepagetopglue = 1.5in |
---|
| 1959 | \newskip\titlepagebottomglue \titlepagebottomglue = 2pc |
---|
| 1960 | |
---|
| 1961 | % First the title page. Must do @settitle before @titlepage. |
---|
| 1962 | \newif\ifseenauthor |
---|
| 1963 | \newif\iffinishedtitlepage |
---|
| 1964 | |
---|
| 1965 | % Do an implicit @contents or @shortcontents after @end titlepage if the |
---|
| 1966 | % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. |
---|
| 1967 | % |
---|
| 1968 | \newif\ifsetcontentsaftertitlepage |
---|
| 1969 | \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue |
---|
| 1970 | \newif\ifsetshortcontentsaftertitlepage |
---|
| 1971 | \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue |
---|
| 1972 | |
---|
[22253] | 1973 | \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% |
---|
[15293] | 1974 | \endgroup\page\hbox{}\page} |
---|
| 1975 | |
---|
[22253] | 1976 | \envdef\titlepage{% |
---|
| 1977 | % Open one extra group, as we want to close it in the middle of \Etitlepage. |
---|
| 1978 | \begingroup |
---|
| 1979 | \parindent=0pt \textfonts |
---|
| 1980 | % Leave some space at the very top of the page. |
---|
| 1981 | \vglue\titlepagetopglue |
---|
| 1982 | % No rule at page bottom unless we print one at the top with @title. |
---|
| 1983 | \finishedtitlepagetrue |
---|
| 1984 | % |
---|
| 1985 | % Most title ``pages'' are actually two pages long, with space |
---|
| 1986 | % at the top of the second. We don't want the ragged left on the second. |
---|
| 1987 | \let\oldpage = \page |
---|
| 1988 | \def\page{% |
---|
[15293] | 1989 | \iffinishedtitlepage\else |
---|
[22253] | 1990 | \finishtitlepage |
---|
[15293] | 1991 | \fi |
---|
| 1992 | \let\page = \oldpage |
---|
[22253] | 1993 | \page |
---|
| 1994 | \null |
---|
| 1995 | }% |
---|
[15293] | 1996 | } |
---|
| 1997 | |
---|
| 1998 | \def\Etitlepage{% |
---|
[22253] | 1999 | \iffinishedtitlepage\else |
---|
| 2000 | \finishtitlepage |
---|
| 2001 | \fi |
---|
| 2002 | % It is important to do the page break before ending the group, |
---|
| 2003 | % because the headline and footline are only empty inside the group. |
---|
| 2004 | % If we use the new definition of \page, we always get a blank page |
---|
| 2005 | % after the title page, which we certainly don't want. |
---|
| 2006 | \oldpage |
---|
| 2007 | \endgroup |
---|
| 2008 | % |
---|
| 2009 | % Need this before the \...aftertitlepage checks so that if they are |
---|
| 2010 | % in effect the toc pages will come out with page numbers. |
---|
| 2011 | \HEADINGSon |
---|
| 2012 | % |
---|
| 2013 | % If they want short, they certainly want long too. |
---|
| 2014 | \ifsetshortcontentsaftertitlepage |
---|
| 2015 | \shortcontents |
---|
| 2016 | \contents |
---|
| 2017 | \global\let\shortcontents = \relax |
---|
| 2018 | \global\let\contents = \relax |
---|
| 2019 | \fi |
---|
| 2020 | % |
---|
| 2021 | \ifsetcontentsaftertitlepage |
---|
| 2022 | \contents |
---|
| 2023 | \global\let\contents = \relax |
---|
| 2024 | \global\let\shortcontents = \relax |
---|
| 2025 | \fi |
---|
[15293] | 2026 | } |
---|
| 2027 | |
---|
| 2028 | \def\finishtitlepage{% |
---|
[22253] | 2029 | \vskip4pt \hrule height 2pt width \hsize |
---|
| 2030 | \vskip\titlepagebottomglue |
---|
| 2031 | \finishedtitlepagetrue |
---|
[15293] | 2032 | } |
---|
| 2033 | |
---|
[22253] | 2034 | %%% Macros to be used within @titlepage: |
---|
| 2035 | |
---|
| 2036 | \let\subtitlerm=\tenrm |
---|
| 2037 | \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} |
---|
| 2038 | |
---|
| 2039 | \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines |
---|
| 2040 | \let\tt=\authortt} |
---|
| 2041 | |
---|
| 2042 | \parseargdef\title{% |
---|
| 2043 | \checkenv\titlepage |
---|
| 2044 | \leftline{\titlefonts\rm #1} |
---|
| 2045 | % print a rule at the page bottom also. |
---|
| 2046 | \finishedtitlepagefalse |
---|
| 2047 | \vskip4pt \hrule height 4pt width \hsize \vskip4pt |
---|
| 2048 | } |
---|
| 2049 | |
---|
| 2050 | \parseargdef\subtitle{% |
---|
| 2051 | \checkenv\titlepage |
---|
| 2052 | {\subtitlefont \rightline{#1}}% |
---|
| 2053 | } |
---|
| 2054 | |
---|
| 2055 | % @author should come last, but may come many times. |
---|
| 2056 | % It can also be used inside @quotation. |
---|
| 2057 | % |
---|
| 2058 | \parseargdef\author{% |
---|
| 2059 | \def\temp{\quotation}% |
---|
| 2060 | \ifx\thisenv\temp |
---|
| 2061 | \def\quotationauthor{#1}% printed in \Equotation. |
---|
| 2062 | \else |
---|
| 2063 | \checkenv\titlepage |
---|
| 2064 | \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi |
---|
| 2065 | {\authorfont \leftline{#1}}% |
---|
| 2066 | \fi |
---|
| 2067 | } |
---|
| 2068 | |
---|
| 2069 | |
---|
[15293] | 2070 | %%% Set up page headings and footings. |
---|
| 2071 | |
---|
| 2072 | \let\thispage=\folio |
---|
| 2073 | |
---|
| 2074 | \newtoks\evenheadline % headline on even pages |
---|
| 2075 | \newtoks\oddheadline % headline on odd pages |
---|
| 2076 | \newtoks\evenfootline % footline on even pages |
---|
| 2077 | \newtoks\oddfootline % footline on odd pages |
---|
| 2078 | |
---|
[22253] | 2079 | % Now make TeX use those variables |
---|
[15293] | 2080 | \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline |
---|
| 2081 | \else \the\evenheadline \fi}} |
---|
| 2082 | \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline |
---|
| 2083 | \else \the\evenfootline \fi}\HEADINGShook} |
---|
| 2084 | \let\HEADINGShook=\relax |
---|
| 2085 | |
---|
| 2086 | % Commands to set those variables. |
---|
| 2087 | % For example, this is what @headings on does |
---|
| 2088 | % @evenheading @thistitle|@thispage|@thischapter |
---|
| 2089 | % @oddheading @thischapter|@thispage|@thistitle |
---|
| 2090 | % @evenfooting @thisfile|| |
---|
| 2091 | % @oddfooting ||@thisfile |
---|
| 2092 | |
---|
[22253] | 2093 | |
---|
[15293] | 2094 | \def\evenheading{\parsearg\evenheadingxxx} |
---|
[22253] | 2095 | \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} |
---|
| 2096 | \def\evenheadingyyy #1\|#2\|#3\|#4\finish{% |
---|
[15293] | 2097 | \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
---|
| 2098 | |
---|
[22253] | 2099 | \def\oddheading{\parsearg\oddheadingxxx} |
---|
| 2100 | \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} |
---|
| 2101 | \def\oddheadingyyy #1\|#2\|#3\|#4\finish{% |
---|
[15293] | 2102 | \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
---|
| 2103 | |
---|
[22253] | 2104 | \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% |
---|
[15293] | 2105 | |
---|
[22253] | 2106 | \def\evenfooting{\parsearg\evenfootingxxx} |
---|
| 2107 | \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} |
---|
| 2108 | \def\evenfootingyyy #1\|#2\|#3\|#4\finish{% |
---|
[15293] | 2109 | \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
---|
| 2110 | |
---|
[22253] | 2111 | \def\oddfooting{\parsearg\oddfootingxxx} |
---|
| 2112 | \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} |
---|
| 2113 | \def\oddfootingyyy #1\|#2\|#3\|#4\finish{% |
---|
[15293] | 2114 | \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% |
---|
| 2115 | % |
---|
| 2116 | % Leave some space for the footline. Hopefully ok to assume |
---|
| 2117 | % @evenfooting will not be used by itself. |
---|
| 2118 | \global\advance\pageheight by -\baselineskip |
---|
| 2119 | \global\advance\vsize by -\baselineskip |
---|
| 2120 | } |
---|
| 2121 | |
---|
[22253] | 2122 | \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} |
---|
[15293] | 2123 | |
---|
[22253] | 2124 | |
---|
[15293] | 2125 | % @headings double turns headings on for double-sided printing. |
---|
| 2126 | % @headings single turns headings on for single-sided printing. |
---|
| 2127 | % @headings off turns them off. |
---|
| 2128 | % @headings on same as @headings double, retained for compatibility. |
---|
| 2129 | % @headings after turns on double-sided headings after this page. |
---|
| 2130 | % @headings doubleafter turns on double-sided headings after this page. |
---|
| 2131 | % @headings singleafter turns on single-sided headings after this page. |
---|
| 2132 | % By default, they are off at the start of a document, |
---|
| 2133 | % and turned `on' after @end titlepage. |
---|
| 2134 | |
---|
| 2135 | \def\headings #1 {\csname HEADINGS#1\endcsname} |
---|
| 2136 | |
---|
[22253] | 2137 | \def\HEADINGSoff{% |
---|
[15293] | 2138 | \global\evenheadline={\hfil} \global\evenfootline={\hfil} |
---|
| 2139 | \global\oddheadline={\hfil} \global\oddfootline={\hfil}} |
---|
| 2140 | \HEADINGSoff |
---|
| 2141 | % When we turn headings on, set the page number to 1. |
---|
| 2142 | % For double-sided printing, put current file name in lower left corner, |
---|
| 2143 | % chapter name on inside top of right hand pages, document |
---|
| 2144 | % title on inside top of left hand pages, and page numbers on outside top |
---|
| 2145 | % edge of all pages. |
---|
[22253] | 2146 | \def\HEADINGSdouble{% |
---|
[15293] | 2147 | \global\pageno=1 |
---|
| 2148 | \global\evenfootline={\hfil} |
---|
| 2149 | \global\oddfootline={\hfil} |
---|
| 2150 | \global\evenheadline={\line{\folio\hfil\thistitle}} |
---|
| 2151 | \global\oddheadline={\line{\thischapter\hfil\folio}} |
---|
| 2152 | \global\let\contentsalignmacro = \chapoddpage |
---|
| 2153 | } |
---|
| 2154 | \let\contentsalignmacro = \chappager |
---|
| 2155 | |
---|
| 2156 | % For single-sided printing, chapter title goes across top left of page, |
---|
| 2157 | % page number on top right. |
---|
[22253] | 2158 | \def\HEADINGSsingle{% |
---|
[15293] | 2159 | \global\pageno=1 |
---|
| 2160 | \global\evenfootline={\hfil} |
---|
| 2161 | \global\oddfootline={\hfil} |
---|
| 2162 | \global\evenheadline={\line{\thischapter\hfil\folio}} |
---|
| 2163 | \global\oddheadline={\line{\thischapter\hfil\folio}} |
---|
| 2164 | \global\let\contentsalignmacro = \chappager |
---|
| 2165 | } |
---|
| 2166 | \def\HEADINGSon{\HEADINGSdouble} |
---|
| 2167 | |
---|
| 2168 | \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} |
---|
| 2169 | \let\HEADINGSdoubleafter=\HEADINGSafter |
---|
| 2170 | \def\HEADINGSdoublex{% |
---|
| 2171 | \global\evenfootline={\hfil} |
---|
| 2172 | \global\oddfootline={\hfil} |
---|
| 2173 | \global\evenheadline={\line{\folio\hfil\thistitle}} |
---|
| 2174 | \global\oddheadline={\line{\thischapter\hfil\folio}} |
---|
| 2175 | \global\let\contentsalignmacro = \chapoddpage |
---|
| 2176 | } |
---|
| 2177 | |
---|
| 2178 | \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} |
---|
| 2179 | \def\HEADINGSsinglex{% |
---|
| 2180 | \global\evenfootline={\hfil} |
---|
| 2181 | \global\oddfootline={\hfil} |
---|
| 2182 | \global\evenheadline={\line{\thischapter\hfil\folio}} |
---|
| 2183 | \global\oddheadline={\line{\thischapter\hfil\folio}} |
---|
| 2184 | \global\let\contentsalignmacro = \chappager |
---|
| 2185 | } |
---|
| 2186 | |
---|
| 2187 | % Subroutines used in generating headings |
---|
[18190] | 2188 | % This produces Day Month Year style of output. |
---|
| 2189 | % Only define if not already defined, in case a txi-??.tex file has set |
---|
| 2190 | % up a different format (e.g., txi-cs.tex does this). |
---|
| 2191 | \ifx\today\undefined |
---|
[15293] | 2192 | \def\today{% |
---|
| 2193 | \number\day\space |
---|
| 2194 | \ifcase\month |
---|
| 2195 | \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr |
---|
| 2196 | \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug |
---|
| 2197 | \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec |
---|
| 2198 | \fi |
---|
| 2199 | \space\number\year} |
---|
[18190] | 2200 | \fi |
---|
[15293] | 2201 | |
---|
| 2202 | % @settitle line... specifies the title of the document, for headings. |
---|
| 2203 | % It generates no output of its own. |
---|
| 2204 | \def\thistitle{\putwordNoTitle} |
---|
[22253] | 2205 | \def\settitle{\parsearg{\gdef\thistitle}} |
---|
[15293] | 2206 | |
---|
| 2207 | |
---|
| 2208 | \message{tables,} |
---|
[22253] | 2209 | % Tables -- @table, @ftable, @vtable, @item(x). |
---|
[15293] | 2210 | |
---|
| 2211 | % default indentation of table text |
---|
| 2212 | \newdimen\tableindent \tableindent=.8in |
---|
| 2213 | % default indentation of @itemize and @enumerate text |
---|
| 2214 | \newdimen\itemindent \itemindent=.3in |
---|
| 2215 | % margin between end of table item and start of table text. |
---|
| 2216 | \newdimen\itemmargin \itemmargin=.1in |
---|
| 2217 | |
---|
| 2218 | % used internally for \itemindent minus \itemmargin |
---|
| 2219 | \newdimen\itemmax |
---|
| 2220 | |
---|
[22253] | 2221 | % Note @table, @ftable, and @vtable define @item, @itemx, etc., with |
---|
[15293] | 2222 | % these defs. |
---|
| 2223 | % They also define \itemindex |
---|
| 2224 | % to index the item name in whatever manner is desired (perhaps none). |
---|
| 2225 | |
---|
| 2226 | \newif\ifitemxneedsnegativevskip |
---|
| 2227 | |
---|
| 2228 | \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} |
---|
| 2229 | |
---|
| 2230 | \def\internalBitem{\smallbreak \parsearg\itemzzz} |
---|
| 2231 | \def\internalBitemx{\itemxpar \parsearg\itemzzz} |
---|
| 2232 | |
---|
| 2233 | \def\itemzzz #1{\begingroup % |
---|
| 2234 | \advance\hsize by -\rightskip |
---|
| 2235 | \advance\hsize by -\tableindent |
---|
[22253] | 2236 | \setbox0=\hbox{\itemindicate{#1}}% |
---|
[15293] | 2237 | \itemindex{#1}% |
---|
| 2238 | \nobreak % This prevents a break before @itemx. |
---|
| 2239 | % |
---|
| 2240 | % If the item text does not fit in the space we have, put it on a line |
---|
| 2241 | % by itself, and do not allow a page break either before or after that |
---|
| 2242 | % line. We do not start a paragraph here because then if the next |
---|
| 2243 | % command is, e.g., @kindex, the whatsit would get put into the |
---|
| 2244 | % horizontal list on a line by itself, resulting in extra blank space. |
---|
| 2245 | \ifdim \wd0>\itemmax |
---|
| 2246 | % |
---|
| 2247 | % Make this a paragraph so we get the \parskip glue and wrapping, |
---|
| 2248 | % but leave it ragged-right. |
---|
| 2249 | \begingroup |
---|
| 2250 | \advance\leftskip by-\tableindent |
---|
| 2251 | \advance\hsize by\tableindent |
---|
| 2252 | \advance\rightskip by0pt plus1fil |
---|
| 2253 | \leavevmode\unhbox0\par |
---|
| 2254 | \endgroup |
---|
| 2255 | % |
---|
| 2256 | % We're going to be starting a paragraph, but we don't want the |
---|
| 2257 | % \parskip glue -- logically it's part of the @item we just started. |
---|
| 2258 | \nobreak \vskip-\parskip |
---|
| 2259 | % |
---|
[22253] | 2260 | % Stop a page break at the \parskip glue coming up. (Unfortunately |
---|
[15293] | 2261 | % we can't prevent a possible page break at the following |
---|
[22253] | 2262 | % \baselineskip glue.) However, if what follows is an environment |
---|
| 2263 | % such as @example, there will be no \parskip glue; then |
---|
| 2264 | % the negative vskip we just would cause the example and the item to |
---|
| 2265 | % crash together. So we use this bizarre value of 10001 as a signal |
---|
| 2266 | % to \aboveenvbreak to insert \parskip glue after all. |
---|
| 2267 | % (Possibly there are other commands that could be followed by |
---|
| 2268 | % @example which need the same treatment, but not section titles; or |
---|
| 2269 | % maybe section titles are the only special case and they should be |
---|
| 2270 | % penalty 10001...) |
---|
| 2271 | \penalty 10001 |
---|
[15293] | 2272 | \endgroup |
---|
| 2273 | \itemxneedsnegativevskipfalse |
---|
| 2274 | \else |
---|
| 2275 | % The item text fits into the space. Start a paragraph, so that the |
---|
| 2276 | % following text (if any) will end up on the same line. |
---|
| 2277 | \noindent |
---|
| 2278 | % Do this with kerns and \unhbox so that if there is a footnote in |
---|
| 2279 | % the item text, it can migrate to the main vertical list and |
---|
| 2280 | % eventually be printed. |
---|
| 2281 | \nobreak\kern-\tableindent |
---|
| 2282 | \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 |
---|
| 2283 | \unhbox0 |
---|
| 2284 | \nobreak\kern\dimen0 |
---|
| 2285 | \endgroup |
---|
| 2286 | \itemxneedsnegativevskiptrue |
---|
| 2287 | \fi |
---|
| 2288 | } |
---|
| 2289 | |
---|
[22253] | 2290 | \def\item{\errmessage{@item while not in a list environment}} |
---|
| 2291 | \def\itemx{\errmessage{@itemx while not in a list environment}} |
---|
[15293] | 2292 | |
---|
| 2293 | % @table, @ftable, @vtable. |
---|
[22253] | 2294 | \envdef\table{% |
---|
| 2295 | \let\itemindex\gobble |
---|
| 2296 | \tablex |
---|
[15293] | 2297 | } |
---|
[22253] | 2298 | \envdef\ftable{% |
---|
| 2299 | \def\itemindex ##1{\doind {fn}{\code{##1}}}% |
---|
| 2300 | \tablex |
---|
| 2301 | } |
---|
| 2302 | \envdef\vtable{% |
---|
| 2303 | \def\itemindex ##1{\doind {vr}{\code{##1}}}% |
---|
| 2304 | \tablex |
---|
| 2305 | } |
---|
| 2306 | \def\tablex#1{% |
---|
| 2307 | \def\itemindicate{#1}% |
---|
| 2308 | \parsearg\tabley |
---|
| 2309 | } |
---|
| 2310 | \def\tabley#1{% |
---|
| 2311 | {% |
---|
| 2312 | \makevalueexpandable |
---|
| 2313 | \edef\temp{\noexpand\tablez #1\space\space\space}% |
---|
| 2314 | \expandafter |
---|
| 2315 | }\temp \endtablez |
---|
| 2316 | } |
---|
| 2317 | \def\tablez #1 #2 #3 #4\endtablez{% |
---|
| 2318 | \aboveenvbreak |
---|
| 2319 | \ifnum 0#1>0 \advance \leftskip by #1\mil \fi |
---|
| 2320 | \ifnum 0#2>0 \tableindent=#2\mil \fi |
---|
| 2321 | \ifnum 0#3>0 \advance \rightskip by #3\mil \fi |
---|
| 2322 | \itemmax=\tableindent |
---|
| 2323 | \advance \itemmax by -\itemmargin |
---|
| 2324 | \advance \leftskip by \tableindent |
---|
| 2325 | \exdentamount=\tableindent |
---|
| 2326 | \parindent = 0pt |
---|
| 2327 | \parskip = \smallskipamount |
---|
| 2328 | \ifdim \parskip=0pt \parskip=2pt \fi |
---|
| 2329 | \let\item = \internalBitem |
---|
| 2330 | \let\itemx = \internalBitemx |
---|
| 2331 | } |
---|
| 2332 | \def\Etable{\endgraf\afterenvbreak} |
---|
| 2333 | \let\Eftable\Etable |
---|
| 2334 | \let\Evtable\Etable |
---|
| 2335 | \let\Eitemize\Etable |
---|
| 2336 | \let\Eenumerate\Etable |
---|
[15293] | 2337 | |
---|
| 2338 | % This is the counter used by @enumerate, which is really @itemize |
---|
| 2339 | |
---|
| 2340 | \newcount \itemno |
---|
| 2341 | |
---|
[22253] | 2342 | \envdef\itemize{\parsearg\doitemize} |
---|
[15293] | 2343 | |
---|
[22253] | 2344 | \def\doitemize#1{% |
---|
| 2345 | \aboveenvbreak |
---|
| 2346 | \itemmax=\itemindent |
---|
| 2347 | \advance\itemmax by -\itemmargin |
---|
| 2348 | \advance\leftskip by \itemindent |
---|
| 2349 | \exdentamount=\itemindent |
---|
| 2350 | \parindent=0pt |
---|
| 2351 | \parskip=\smallskipamount |
---|
| 2352 | \ifdim\parskip=0pt \parskip=2pt \fi |
---|
| 2353 | \def\itemcontents{#1}% |
---|
| 2354 | % @itemize with no arg is equivalent to @itemize @bullet. |
---|
| 2355 | \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi |
---|
| 2356 | \let\item=\itemizeitem |
---|
[15293] | 2357 | } |
---|
| 2358 | |
---|
[22253] | 2359 | % Definition of @item while inside @itemize and @enumerate. |
---|
| 2360 | % |
---|
| 2361 | \def\itemizeitem{% |
---|
| 2362 | \advance\itemno by 1 % for enumerations |
---|
| 2363 | {\let\par=\endgraf \smallbreak}% reasonable place to break |
---|
| 2364 | {% |
---|
| 2365 | % If the document has an @itemize directly after a section title, a |
---|
| 2366 | % \nobreak will be last on the list, and \sectionheading will have |
---|
| 2367 | % done a \vskip-\parskip. In that case, we don't want to zero |
---|
| 2368 | % parskip, or the item text will crash with the heading. On the |
---|
| 2369 | % other hand, when there is normal text preceding the item (as there |
---|
| 2370 | % usually is), we do want to zero parskip, or there would be too much |
---|
| 2371 | % space. In that case, we won't have a \nobreak before. At least |
---|
| 2372 | % that's the theory. |
---|
| 2373 | \ifnum\lastpenalty<10000 \parskip=0in \fi |
---|
| 2374 | \noindent |
---|
| 2375 | \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% |
---|
| 2376 | \vadjust{\penalty 1200}}% not good to break after first line of item. |
---|
| 2377 | \flushcr |
---|
| 2378 | } |
---|
[15293] | 2379 | |
---|
| 2380 | % \splitoff TOKENS\endmark defines \first to be the first token in |
---|
| 2381 | % TOKENS, and \rest to be the remainder. |
---|
| 2382 | % |
---|
| 2383 | \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% |
---|
| 2384 | |
---|
| 2385 | % Allow an optional argument of an uppercase letter, lowercase letter, |
---|
| 2386 | % or number, to specify the first label in the enumerated list. No |
---|
| 2387 | % argument is the same as `1'. |
---|
| 2388 | % |
---|
[22253] | 2389 | \envparseargdef\enumerate{\enumeratey #1 \endenumeratey} |
---|
[15293] | 2390 | \def\enumeratey #1 #2\endenumeratey{% |
---|
| 2391 | % If we were given no argument, pretend we were given `1'. |
---|
| 2392 | \def\thearg{#1}% |
---|
| 2393 | \ifx\thearg\empty \def\thearg{1}\fi |
---|
| 2394 | % |
---|
| 2395 | % Detect if the argument is a single token. If so, it might be a |
---|
| 2396 | % letter. Otherwise, the only valid thing it can be is a number. |
---|
| 2397 | % (We will always have one token, because of the test we just made. |
---|
| 2398 | % This is a good thing, since \splitoff doesn't work given nothing at |
---|
| 2399 | % all -- the first parameter is undelimited.) |
---|
| 2400 | \expandafter\splitoff\thearg\endmark |
---|
| 2401 | \ifx\rest\empty |
---|
| 2402 | % Only one token in the argument. It could still be anything. |
---|
| 2403 | % A ``lowercase letter'' is one whose \lccode is nonzero. |
---|
| 2404 | % An ``uppercase letter'' is one whose \lccode is both nonzero, and |
---|
| 2405 | % not equal to itself. |
---|
| 2406 | % Otherwise, we assume it's a number. |
---|
| 2407 | % |
---|
| 2408 | % We need the \relax at the end of the \ifnum lines to stop TeX from |
---|
| 2409 | % continuing to look for a <number>. |
---|
| 2410 | % |
---|
| 2411 | \ifnum\lccode\expandafter`\thearg=0\relax |
---|
| 2412 | \numericenumerate % a number (we hope) |
---|
| 2413 | \else |
---|
| 2414 | % It's a letter. |
---|
| 2415 | \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax |
---|
| 2416 | \lowercaseenumerate % lowercase letter |
---|
| 2417 | \else |
---|
| 2418 | \uppercaseenumerate % uppercase letter |
---|
| 2419 | \fi |
---|
| 2420 | \fi |
---|
| 2421 | \else |
---|
| 2422 | % Multiple tokens in the argument. We hope it's a number. |
---|
| 2423 | \numericenumerate |
---|
| 2424 | \fi |
---|
| 2425 | } |
---|
| 2426 | |
---|
| 2427 | % An @enumerate whose labels are integers. The starting integer is |
---|
| 2428 | % given in \thearg. |
---|
| 2429 | % |
---|
| 2430 | \def\numericenumerate{% |
---|
| 2431 | \itemno = \thearg |
---|
| 2432 | \startenumeration{\the\itemno}% |
---|
| 2433 | } |
---|
| 2434 | |
---|
| 2435 | % The starting (lowercase) letter is in \thearg. |
---|
| 2436 | \def\lowercaseenumerate{% |
---|
| 2437 | \itemno = \expandafter`\thearg |
---|
| 2438 | \startenumeration{% |
---|
| 2439 | % Be sure we're not beyond the end of the alphabet. |
---|
| 2440 | \ifnum\itemno=0 |
---|
| 2441 | \errmessage{No more lowercase letters in @enumerate; get a bigger |
---|
| 2442 | alphabet}% |
---|
| 2443 | \fi |
---|
| 2444 | \char\lccode\itemno |
---|
| 2445 | }% |
---|
| 2446 | } |
---|
| 2447 | |
---|
| 2448 | % The starting (uppercase) letter is in \thearg. |
---|
| 2449 | \def\uppercaseenumerate{% |
---|
| 2450 | \itemno = \expandafter`\thearg |
---|
| 2451 | \startenumeration{% |
---|
| 2452 | % Be sure we're not beyond the end of the alphabet. |
---|
| 2453 | \ifnum\itemno=0 |
---|
| 2454 | \errmessage{No more uppercase letters in @enumerate; get a bigger |
---|
| 2455 | alphabet} |
---|
| 2456 | \fi |
---|
| 2457 | \char\uccode\itemno |
---|
| 2458 | }% |
---|
| 2459 | } |
---|
| 2460 | |
---|
[22253] | 2461 | % Call \doitemize, adding a period to the first argument and supplying the |
---|
[15293] | 2462 | % common last two arguments. Also subtract one from the initial value in |
---|
| 2463 | % \itemno, since @item increments \itemno. |
---|
| 2464 | % |
---|
| 2465 | \def\startenumeration#1{% |
---|
| 2466 | \advance\itemno by -1 |
---|
[22253] | 2467 | \doitemize{#1.}\flushcr |
---|
[15293] | 2468 | } |
---|
| 2469 | |
---|
| 2470 | % @alphaenumerate and @capsenumerate are abbreviations for giving an arg |
---|
| 2471 | % to @enumerate. |
---|
| 2472 | % |
---|
| 2473 | \def\alphaenumerate{\enumerate{a}} |
---|
| 2474 | \def\capsenumerate{\enumerate{A}} |
---|
| 2475 | \def\Ealphaenumerate{\Eenumerate} |
---|
| 2476 | \def\Ecapsenumerate{\Eenumerate} |
---|
| 2477 | |
---|
| 2478 | |
---|
| 2479 | % @multitable macros |
---|
| 2480 | % Amy Hendrickson, 8/18/94, 3/6/96 |
---|
| 2481 | % |
---|
| 2482 | % @multitable ... @end multitable will make as many columns as desired. |
---|
| 2483 | % Contents of each column will wrap at width given in preamble. Width |
---|
| 2484 | % can be specified either with sample text given in a template line, |
---|
| 2485 | % or in percent of \hsize, the current width of text on page. |
---|
| 2486 | |
---|
| 2487 | % Table can continue over pages but will only break between lines. |
---|
| 2488 | |
---|
| 2489 | % To make preamble: |
---|
| 2490 | % |
---|
| 2491 | % Either define widths of columns in terms of percent of \hsize: |
---|
| 2492 | % @multitable @columnfractions .25 .3 .45 |
---|
| 2493 | % @item ... |
---|
| 2494 | % |
---|
| 2495 | % Numbers following @columnfractions are the percent of the total |
---|
| 2496 | % current hsize to be used for each column. You may use as many |
---|
| 2497 | % columns as desired. |
---|
| 2498 | |
---|
| 2499 | |
---|
| 2500 | % Or use a template: |
---|
| 2501 | % @multitable {Column 1 template} {Column 2 template} {Column 3 template} |
---|
| 2502 | % @item ... |
---|
| 2503 | % using the widest term desired in each column. |
---|
| 2504 | |
---|
| 2505 | % Each new table line starts with @item, each subsequent new column |
---|
| 2506 | % starts with @tab. Empty columns may be produced by supplying @tab's |
---|
| 2507 | % with nothing between them for as many times as empty columns are needed, |
---|
| 2508 | % ie, @tab@tab@tab will produce two empty columns. |
---|
| 2509 | |
---|
[22253] | 2510 | % @item, @tab do not need to be on their own lines, but it will not hurt |
---|
| 2511 | % if they are. |
---|
[15293] | 2512 | |
---|
| 2513 | % Sample multitable: |
---|
| 2514 | |
---|
| 2515 | % @multitable {Column 1 template} {Column 2 template} {Column 3 template} |
---|
| 2516 | % @item first col stuff @tab second col stuff @tab third col |
---|
| 2517 | % @item |
---|
| 2518 | % first col stuff |
---|
| 2519 | % @tab |
---|
| 2520 | % second col stuff |
---|
| 2521 | % @tab |
---|
| 2522 | % third col |
---|
| 2523 | % @item first col stuff @tab second col stuff |
---|
| 2524 | % @tab Many paragraphs of text may be used in any column. |
---|
| 2525 | % |
---|
| 2526 | % They will wrap at the width determined by the template. |
---|
| 2527 | % @item@tab@tab This will be in third column. |
---|
| 2528 | % @end multitable |
---|
| 2529 | |
---|
| 2530 | % Default dimensions may be reset by user. |
---|
| 2531 | % @multitableparskip is vertical space between paragraphs in table. |
---|
| 2532 | % @multitableparindent is paragraph indent in table. |
---|
| 2533 | % @multitablecolmargin is horizontal space to be left between columns. |
---|
| 2534 | % @multitablelinespace is space to leave between table items, baseline |
---|
| 2535 | % to baseline. |
---|
| 2536 | % 0pt means it depends on current normal line spacing. |
---|
| 2537 | % |
---|
| 2538 | \newskip\multitableparskip |
---|
| 2539 | \newskip\multitableparindent |
---|
| 2540 | \newdimen\multitablecolspace |
---|
| 2541 | \newskip\multitablelinespace |
---|
| 2542 | \multitableparskip=0pt |
---|
| 2543 | \multitableparindent=6pt |
---|
| 2544 | \multitablecolspace=12pt |
---|
| 2545 | \multitablelinespace=0pt |
---|
| 2546 | |
---|
| 2547 | % Macros used to set up halign preamble: |
---|
| 2548 | % |
---|
| 2549 | \let\endsetuptable\relax |
---|
| 2550 | \def\xendsetuptable{\endsetuptable} |
---|
| 2551 | \let\columnfractions\relax |
---|
| 2552 | \def\xcolumnfractions{\columnfractions} |
---|
| 2553 | \newif\ifsetpercent |
---|
| 2554 | |
---|
[22253] | 2555 | % #1 is the @columnfraction, usually a decimal number like .5, but might |
---|
| 2556 | % be just 1. We just use it, whatever it is. |
---|
| 2557 | % |
---|
| 2558 | \def\pickupwholefraction#1 {% |
---|
[15293] | 2559 | \global\advance\colcount by 1 |
---|
[22253] | 2560 | \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% |
---|
[15293] | 2561 | \setuptable |
---|
| 2562 | } |
---|
| 2563 | |
---|
| 2564 | \newcount\colcount |
---|
| 2565 | \def\setuptable#1{% |
---|
| 2566 | \def\firstarg{#1}% |
---|
| 2567 | \ifx\firstarg\xendsetuptable |
---|
| 2568 | \let\go = \relax |
---|
| 2569 | \else |
---|
| 2570 | \ifx\firstarg\xcolumnfractions |
---|
| 2571 | \global\setpercenttrue |
---|
| 2572 | \else |
---|
| 2573 | \ifsetpercent |
---|
| 2574 | \let\go\pickupwholefraction |
---|
| 2575 | \else |
---|
| 2576 | \global\advance\colcount by 1 |
---|
[22253] | 2577 | \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a |
---|
| 2578 | % separator; typically that is always in the input, anyway. |
---|
[15293] | 2579 | \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% |
---|
| 2580 | \fi |
---|
| 2581 | \fi |
---|
| 2582 | \ifx\go\pickupwholefraction |
---|
| 2583 | % Put the argument back for the \pickupwholefraction call, so |
---|
| 2584 | % we'll always have a period there to be parsed. |
---|
| 2585 | \def\go{\pickupwholefraction#1}% |
---|
| 2586 | \else |
---|
| 2587 | \let\go = \setuptable |
---|
| 2588 | \fi% |
---|
| 2589 | \fi |
---|
| 2590 | \go |
---|
| 2591 | } |
---|
| 2592 | |
---|
[22253] | 2593 | % multitable-only commands. |
---|
| 2594 | % |
---|
| 2595 | % @headitem starts a heading row, which we typeset in bold. |
---|
| 2596 | % Assignments have to be global since we are inside the implicit group |
---|
| 2597 | % of an alignment entry. Note that \everycr resets \everytab. |
---|
| 2598 | \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}% |
---|
| 2599 | % |
---|
| 2600 | % A \tab used to include \hskip1sp. But then the space in a template |
---|
| 2601 | % line is not enough. That is bad. So let's go back to just `&' until |
---|
| 2602 | % we encounter the problem it was intended to solve again. |
---|
| 2603 | % --karl, nathan@acm.org, 20apr99. |
---|
| 2604 | \def\tab{\checkenv\multitable &\the\everytab}% |
---|
[15293] | 2605 | |
---|
| 2606 | % @multitable ... @end multitable definitions: |
---|
| 2607 | % |
---|
[22253] | 2608 | \newtoks\everytab % insert after every tab. |
---|
| 2609 | % |
---|
| 2610 | \envdef\multitable{% |
---|
[15293] | 2611 | \vskip\parskip |
---|
[22253] | 2612 | \startsavinginserts |
---|
| 2613 | % |
---|
| 2614 | % @item within a multitable starts a normal row. |
---|
[15293] | 2615 | \let\item\crcr |
---|
[22253] | 2616 | % |
---|
[15293] | 2617 | \tolerance=9500 |
---|
| 2618 | \hbadness=9500 |
---|
| 2619 | \setmultitablespacing |
---|
| 2620 | \parskip=\multitableparskip |
---|
| 2621 | \parindent=\multitableparindent |
---|
| 2622 | \overfullrule=0pt |
---|
| 2623 | \global\colcount=0 |
---|
| 2624 | % |
---|
[22253] | 2625 | \everycr = {% |
---|
| 2626 | \noalign{% |
---|
| 2627 | \global\everytab={}% |
---|
| 2628 | \global\colcount=0 % Reset the column counter. |
---|
| 2629 | % Check for saved footnotes, etc. |
---|
| 2630 | \checkinserts |
---|
| 2631 | % Keeps underfull box messages off when table breaks over pages. |
---|
| 2632 | %\filbreak |
---|
| 2633 | % Maybe so, but it also creates really weird page breaks when the |
---|
| 2634 | % table breaks over pages. Wouldn't \vfil be better? Wait until the |
---|
| 2635 | % problem manifests itself, so it can be fixed for real --karl. |
---|
| 2636 | }% |
---|
| 2637 | }% |
---|
| 2638 | % |
---|
| 2639 | \parsearg\domultitable |
---|
| 2640 | } |
---|
| 2641 | \def\domultitable#1{% |
---|
[15293] | 2642 | % To parse everything between @multitable and @item: |
---|
| 2643 | \setuptable#1 \endsetuptable |
---|
| 2644 | % |
---|
| 2645 | % This preamble sets up a generic column definition, which will |
---|
| 2646 | % be used as many times as user calls for columns. |
---|
| 2647 | % \vtop will set a single line and will also let text wrap and |
---|
| 2648 | % continue for many paragraphs if desired. |
---|
[22253] | 2649 | \halign\bgroup &% |
---|
| 2650 | \global\advance\colcount by 1 |
---|
| 2651 | \multistrut |
---|
| 2652 | \vtop{% |
---|
| 2653 | % Use the current \colcount to find the correct column width: |
---|
| 2654 | \hsize=\expandafter\csname col\the\colcount\endcsname |
---|
| 2655 | % |
---|
| 2656 | % In order to keep entries from bumping into each other |
---|
| 2657 | % we will add a \leftskip of \multitablecolspace to all columns after |
---|
| 2658 | % the first one. |
---|
| 2659 | % |
---|
| 2660 | % If a template has been used, we will add \multitablecolspace |
---|
| 2661 | % to the width of each template entry. |
---|
| 2662 | % |
---|
| 2663 | % If the user has set preamble in terms of percent of \hsize we will |
---|
| 2664 | % use that dimension as the width of the column, and the \leftskip |
---|
| 2665 | % will keep entries from bumping into each other. Table will start at |
---|
| 2666 | % left margin and final column will justify at right margin. |
---|
| 2667 | % |
---|
| 2668 | % Make sure we don't inherit \rightskip from the outer environment. |
---|
| 2669 | \rightskip=0pt |
---|
| 2670 | \ifnum\colcount=1 |
---|
| 2671 | % The first column will be indented with the surrounding text. |
---|
| 2672 | \advance\hsize by\leftskip |
---|
| 2673 | \else |
---|
| 2674 | \ifsetpercent \else |
---|
| 2675 | % If user has not set preamble in terms of percent of \hsize |
---|
| 2676 | % we will advance \hsize by \multitablecolspace. |
---|
| 2677 | \advance\hsize by \multitablecolspace |
---|
| 2678 | \fi |
---|
| 2679 | % In either case we will make \leftskip=\multitablecolspace: |
---|
| 2680 | \leftskip=\multitablecolspace |
---|
| 2681 | \fi |
---|
| 2682 | % Ignoring space at the beginning and end avoids an occasional spurious |
---|
| 2683 | % blank line, when TeX decides to break the line at the space before the |
---|
| 2684 | % box from the multistrut, so the strut ends up on a line by itself. |
---|
| 2685 | % For example: |
---|
| 2686 | % @multitable @columnfractions .11 .89 |
---|
| 2687 | % @item @code{#} |
---|
| 2688 | % @tab Legal holiday which is valid in major parts of the whole country. |
---|
| 2689 | % Is automatically provided with highlighting sequences respectively |
---|
| 2690 | % marking characters. |
---|
| 2691 | \noindent\ignorespaces##\unskip\multistrut |
---|
| 2692 | }\cr |
---|
[15293] | 2693 | } |
---|
[22253] | 2694 | \def\Emultitable{% |
---|
| 2695 | \crcr |
---|
| 2696 | \egroup % end the \halign |
---|
| 2697 | \global\setpercentfalse |
---|
| 2698 | } |
---|
[15293] | 2699 | |
---|
| 2700 | \def\setmultitablespacing{% test to see if user has set \multitablelinespace. |
---|
| 2701 | % If so, do nothing. If not, give it an appropriate dimension based on |
---|
| 2702 | % current baselineskip. |
---|
| 2703 | \ifdim\multitablelinespace=0pt |
---|
[18190] | 2704 | \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip |
---|
| 2705 | \global\advance\multitablelinespace by-\ht0 |
---|
[15293] | 2706 | %% strut to put in table in case some entry doesn't have descenders, |
---|
| 2707 | %% to keep lines equally spaced |
---|
| 2708 | \let\multistrut = \strut |
---|
[18190] | 2709 | \else |
---|
| 2710 | %% FIXME: what is \box0 supposed to be? |
---|
| 2711 | \gdef\multistrut{\vrule height\multitablelinespace depth\dp0 |
---|
| 2712 | width0pt\relax} \fi |
---|
[15293] | 2713 | %% Test to see if parskip is larger than space between lines of |
---|
| 2714 | %% table. If not, do nothing. |
---|
| 2715 | %% If so, set to same dimension as multitablelinespace. |
---|
| 2716 | \ifdim\multitableparskip>\multitablelinespace |
---|
| 2717 | \global\multitableparskip=\multitablelinespace |
---|
| 2718 | \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller |
---|
| 2719 | %% than skip between lines in the table. |
---|
| 2720 | \fi% |
---|
| 2721 | \ifdim\multitableparskip=0pt |
---|
| 2722 | \global\multitableparskip=\multitablelinespace |
---|
| 2723 | \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller |
---|
| 2724 | %% than skip between lines in the table. |
---|
| 2725 | \fi} |
---|
| 2726 | |
---|
| 2727 | |
---|
| 2728 | \message{conditionals,} |
---|
| 2729 | |
---|
[22253] | 2730 | % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, |
---|
| 2731 | % @ifnotxml always succeed. They currently do nothing; we don't |
---|
| 2732 | % attempt to check whether the conditionals are properly nested. But we |
---|
| 2733 | % have to remember that they are conditionals, so that @end doesn't |
---|
| 2734 | % attempt to close an environment group. |
---|
[15293] | 2735 | % |
---|
[22253] | 2736 | \def\makecond#1{% |
---|
| 2737 | \expandafter\let\csname #1\endcsname = \relax |
---|
| 2738 | \expandafter\let\csname iscond.#1\endcsname = 1 |
---|
[15293] | 2739 | } |
---|
[22253] | 2740 | \makecond{iftex} |
---|
| 2741 | \makecond{ifnotdocbook} |
---|
| 2742 | \makecond{ifnothtml} |
---|
| 2743 | \makecond{ifnotinfo} |
---|
| 2744 | \makecond{ifnotplaintext} |
---|
| 2745 | \makecond{ifnotxml} |
---|
[15293] | 2746 | |
---|
[22253] | 2747 | % Ignore @ignore, @ifhtml, @ifinfo, and the like. |
---|
[15293] | 2748 | % |
---|
[22253] | 2749 | \def\direntry{\doignore{direntry}} |
---|
| 2750 | \def\documentdescription{\doignore{documentdescription}} |
---|
| 2751 | \def\docbook{\doignore{docbook}} |
---|
| 2752 | \def\html{\doignore{html}} |
---|
| 2753 | \def\ifdocbook{\doignore{ifdocbook}} |
---|
[18190] | 2754 | \def\ifhtml{\doignore{ifhtml}} |
---|
[15293] | 2755 | \def\ifinfo{\doignore{ifinfo}} |
---|
[22253] | 2756 | \def\ifnottex{\doignore{ifnottex}} |
---|
[18190] | 2757 | \def\ifplaintext{\doignore{ifplaintext}} |
---|
[22253] | 2758 | \def\ifxml{\doignore{ifxml}} |
---|
| 2759 | \def\ignore{\doignore{ignore}} |
---|
[15293] | 2760 | \def\menu{\doignore{menu}} |
---|
[22253] | 2761 | \def\xml{\doignore{xml}} |
---|
[15293] | 2762 | |
---|
[22253] | 2763 | % Ignore text until a line `@end #1', keeping track of nested conditionals. |
---|
| 2764 | % |
---|
| 2765 | % A count to remember the depth of nesting. |
---|
| 2766 | \newcount\doignorecount |
---|
[15293] | 2767 | |
---|
| 2768 | \def\doignore#1{\begingroup |
---|
[22253] | 2769 | % Scan in ``verbatim'' mode: |
---|
| 2770 | \catcode`\@ = \other |
---|
| 2771 | \catcode`\{ = \other |
---|
| 2772 | \catcode`\} = \other |
---|
[15293] | 2773 | % |
---|
| 2774 | % Make sure that spaces turn into tokens that match what \doignoretext wants. |
---|
[22253] | 2775 | \spaceisspace |
---|
[15293] | 2776 | % |
---|
[22253] | 2777 | % Count number of #1's that we've seen. |
---|
| 2778 | \doignorecount = 0 |
---|
[15293] | 2779 | % |
---|
[22253] | 2780 | % Swallow text until we reach the matching `@end #1'. |
---|
| 2781 | \dodoignore {#1}% |
---|
| 2782 | } |
---|
| 2783 | |
---|
| 2784 | { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. |
---|
| 2785 | \obeylines % |
---|
[15293] | 2786 | % |
---|
[22253] | 2787 | \gdef\dodoignore#1{% |
---|
| 2788 | % #1 contains the string `ifinfo'. |
---|
| 2789 | % |
---|
| 2790 | % Define a command to find the next `@end #1', which must be on a line |
---|
| 2791 | % by itself. |
---|
| 2792 | \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}% |
---|
| 2793 | % And this command to find another #1 command, at the beginning of a |
---|
| 2794 | % line. (Otherwise, we would consider a line `@c @ifset', for |
---|
| 2795 | % example, to count as an @ifset for nesting.) |
---|
| 2796 | \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% |
---|
| 2797 | % |
---|
| 2798 | % And now expand that command. |
---|
| 2799 | \obeylines % |
---|
| 2800 | \doignoretext ^^M% |
---|
| 2801 | }% |
---|
| 2802 | } |
---|
| 2803 | |
---|
| 2804 | \def\doignoreyyy#1{% |
---|
| 2805 | \def\temp{#1}% |
---|
| 2806 | \ifx\temp\empty % Nothing found. |
---|
| 2807 | \let\next\doignoretextzzz |
---|
| 2808 | \else % Found a nested condition, ... |
---|
| 2809 | \advance\doignorecount by 1 |
---|
| 2810 | \let\next\doignoretextyyy % ..., look for another. |
---|
| 2811 | % If we're here, #1 ends with ^^M\ifinfo (for example). |
---|
[18190] | 2812 | \fi |
---|
[22253] | 2813 | \next #1% the token \_STOP_ is present just after this macro. |
---|
[15293] | 2814 | } |
---|
| 2815 | |
---|
[22253] | 2816 | % We have to swallow the remaining "\_STOP_". |
---|
| 2817 | % |
---|
| 2818 | \def\doignoretextzzz#1{% |
---|
| 2819 | \ifnum\doignorecount = 0 % We have just found the outermost @end. |
---|
| 2820 | \let\next\enddoignore |
---|
| 2821 | \else % Still inside a nested condition. |
---|
| 2822 | \advance\doignorecount by -1 |
---|
| 2823 | \let\next\doignoretext % Look for the next @end. |
---|
| 2824 | \fi |
---|
| 2825 | \next |
---|
[15293] | 2826 | } |
---|
| 2827 | |
---|
[22253] | 2828 | % Finish off ignored text. |
---|
| 2829 | \def\enddoignore{\endgroup\ignorespaces} |
---|
[15293] | 2830 | |
---|
| 2831 | |
---|
| 2832 | % @set VAR sets the variable VAR to an empty value. |
---|
| 2833 | % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. |
---|
| 2834 | % |
---|
| 2835 | % Since we want to separate VAR from REST-OF-LINE (which might be |
---|
| 2836 | % empty), we can't just use \parsearg; we have to insert a space of our |
---|
| 2837 | % own to delimit the rest of the line, and then take it out again if we |
---|
[22253] | 2838 | % didn't need it. |
---|
| 2839 | % We rely on the fact that \parsearg sets \catcode`\ =10. |
---|
[15293] | 2840 | % |
---|
[22253] | 2841 | \parseargdef\set{\setyyy#1 \endsetyyy} |
---|
[15293] | 2842 | \def\setyyy#1 #2\endsetyyy{% |
---|
[22253] | 2843 | {% |
---|
| 2844 | \makevalueexpandable |
---|
| 2845 | \def\temp{#2}% |
---|
| 2846 | \edef\next{\gdef\makecsname{SET#1}}% |
---|
| 2847 | \ifx\temp\empty |
---|
| 2848 | \next{}% |
---|
| 2849 | \else |
---|
| 2850 | \setzzz#2\endsetzzz |
---|
| 2851 | \fi |
---|
| 2852 | }% |
---|
[15293] | 2853 | } |
---|
[22253] | 2854 | % Remove the trailing space \setxxx inserted. |
---|
| 2855 | \def\setzzz#1 \endsetzzz{\next{#1}} |
---|
[15293] | 2856 | |
---|
| 2857 | % @clear VAR clears (i.e., unsets) the variable VAR. |
---|
| 2858 | % |
---|
[22253] | 2859 | \parseargdef\clear{% |
---|
| 2860 | {% |
---|
| 2861 | \makevalueexpandable |
---|
| 2862 | \global\expandafter\let\csname SET#1\endcsname=\relax |
---|
| 2863 | }% |
---|
| 2864 | } |
---|
[15293] | 2865 | |
---|
| 2866 | % @value{foo} gets the text saved in variable foo. |
---|
[22253] | 2867 | \def\value{\begingroup\makevalueexpandable\valuexxx} |
---|
| 2868 | \def\valuexxx#1{\expandablevalue{#1}\endgroup} |
---|
[15293] | 2869 | { |
---|
[22253] | 2870 | \catcode`\- = \active \catcode`\_ = \active |
---|
[15293] | 2871 | % |
---|
[22253] | 2872 | \gdef\makevalueexpandable{% |
---|
| 2873 | \let\value = \expandablevalue |
---|
| 2874 | % We don't want these characters active, ... |
---|
| 2875 | \catcode`\-=\other \catcode`\_=\other |
---|
| 2876 | % ..., but we might end up with active ones in the argument if |
---|
| 2877 | % we're called from @code, as @code{@value{foo-bar_}}, though. |
---|
| 2878 | % So \let them to their normal equivalents. |
---|
| 2879 | \let-\realdash \let_\normalunderscore |
---|
| 2880 | } |
---|
[15293] | 2881 | } |
---|
| 2882 | |
---|
| 2883 | % We have this subroutine so that we can handle at least some @value's |
---|
[22253] | 2884 | % properly in indexes (we call \makevalueexpandable in \indexdummies). |
---|
| 2885 | % The command has to be fully expandable (if the variable is set), since |
---|
| 2886 | % the result winds up in the index file. This means that if the |
---|
| 2887 | % variable's value contains other Texinfo commands, it's almost certain |
---|
| 2888 | % it will fail (although perhaps we could fix that with sufficient work |
---|
| 2889 | % to do a one-level expansion on the result, instead of complete). |
---|
[15293] | 2890 | % |
---|
| 2891 | \def\expandablevalue#1{% |
---|
| 2892 | \expandafter\ifx\csname SET#1\endcsname\relax |
---|
| 2893 | {[No value for ``#1'']}% |
---|
[22253] | 2894 | \message{Variable `#1', used in @value, is not set.}% |
---|
[15293] | 2895 | \else |
---|
| 2896 | \csname SET#1\endcsname |
---|
| 2897 | \fi |
---|
| 2898 | } |
---|
| 2899 | |
---|
| 2900 | % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined |
---|
| 2901 | % with @set. |
---|
| 2902 | % |
---|
[22253] | 2903 | % To get special treatment of `@end ifset,' call \makeond and the redefine. |
---|
| 2904 | % |
---|
| 2905 | \makecond{ifset} |
---|
| 2906 | \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} |
---|
| 2907 | \def\doifset#1#2{% |
---|
| 2908 | {% |
---|
| 2909 | \makevalueexpandable |
---|
| 2910 | \let\next=\empty |
---|
| 2911 | \expandafter\ifx\csname SET#2\endcsname\relax |
---|
| 2912 | #1% If not set, redefine \next. |
---|
| 2913 | \fi |
---|
| 2914 | \expandafter |
---|
| 2915 | }\next |
---|
[15293] | 2916 | } |
---|
[22253] | 2917 | \def\ifsetfail{\doignore{ifset}} |
---|
[15293] | 2918 | |
---|
| 2919 | % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been |
---|
| 2920 | % defined with @set, or has been undefined with @clear. |
---|
| 2921 | % |
---|
[22253] | 2922 | % The `\else' inside the `\doifset' parameter is a trick to reuse the |
---|
| 2923 | % above code: if the variable is not set, do nothing, if it is set, |
---|
| 2924 | % then redefine \next to \ifclearfail. |
---|
[15293] | 2925 | % |
---|
[22253] | 2926 | \makecond{ifclear} |
---|
| 2927 | \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} |
---|
| 2928 | \def\ifclearfail{\doignore{ifclear}} |
---|
[15293] | 2929 | |
---|
[22253] | 2930 | % @dircategory CATEGORY -- specify a category of the dir file |
---|
| 2931 | % which this file should belong to. Ignore this in TeX. |
---|
| 2932 | \let\dircategory=\comment |
---|
[15293] | 2933 | |
---|
| 2934 | % @defininfoenclose. |
---|
| 2935 | \let\definfoenclose=\comment |
---|
| 2936 | |
---|
| 2937 | |
---|
| 2938 | \message{indexing,} |
---|
| 2939 | % Index generation facilities |
---|
| 2940 | |
---|
| 2941 | % Define \newwrite to be identical to plain tex's \newwrite |
---|
| 2942 | % except not \outer, so it can be used within \newindex. |
---|
| 2943 | {\catcode`\@=11 |
---|
| 2944 | \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}} |
---|
| 2945 | |
---|
| 2946 | % \newindex {foo} defines an index named foo. |
---|
| 2947 | % It automatically defines \fooindex such that |
---|
| 2948 | % \fooindex ...rest of line... puts an entry in the index foo. |
---|
| 2949 | % It also defines \fooindfile to be the number of the output channel for |
---|
| 2950 | % the file that accumulates this index. The file's extension is foo. |
---|
| 2951 | % The name of an index should be no more than 2 characters long |
---|
| 2952 | % for the sake of vms. |
---|
| 2953 | % |
---|
| 2954 | \def\newindex#1{% |
---|
| 2955 | \iflinks |
---|
| 2956 | \expandafter\newwrite \csname#1indfile\endcsname |
---|
| 2957 | \openout \csname#1indfile\endcsname \jobname.#1 % Open the file |
---|
| 2958 | \fi |
---|
| 2959 | \expandafter\xdef\csname#1index\endcsname{% % Define @#1index |
---|
| 2960 | \noexpand\doindex{#1}} |
---|
| 2961 | } |
---|
| 2962 | |
---|
| 2963 | % @defindex foo == \newindex{foo} |
---|
[18190] | 2964 | % |
---|
[15293] | 2965 | \def\defindex{\parsearg\newindex} |
---|
| 2966 | |
---|
| 2967 | % Define @defcodeindex, like @defindex except put all entries in @code. |
---|
[18190] | 2968 | % |
---|
| 2969 | \def\defcodeindex{\parsearg\newcodeindex} |
---|
| 2970 | % |
---|
[15293] | 2971 | \def\newcodeindex#1{% |
---|
| 2972 | \iflinks |
---|
| 2973 | \expandafter\newwrite \csname#1indfile\endcsname |
---|
| 2974 | \openout \csname#1indfile\endcsname \jobname.#1 |
---|
| 2975 | \fi |
---|
| 2976 | \expandafter\xdef\csname#1index\endcsname{% |
---|
[18190] | 2977 | \noexpand\docodeindex{#1}}% |
---|
[15293] | 2978 | } |
---|
| 2979 | |
---|
| 2980 | |
---|
| 2981 | % @synindex foo bar makes index foo feed into index bar. |
---|
| 2982 | % Do this instead of @defindex foo if you don't want it as a separate index. |
---|
[22253] | 2983 | % |
---|
[15293] | 2984 | % @syncodeindex foo bar similar, but put all entries made for index foo |
---|
| 2985 | % inside @code. |
---|
[22253] | 2986 | % |
---|
[18190] | 2987 | \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} |
---|
| 2988 | \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} |
---|
| 2989 | |
---|
| 2990 | % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), |
---|
| 2991 | % #3 the target index (bar). |
---|
| 2992 | \def\dosynindex#1#2#3{% |
---|
| 2993 | % Only do \closeout if we haven't already done it, else we'll end up |
---|
| 2994 | % closing the target index. |
---|
| 2995 | \expandafter \ifx\csname donesynindex#2\endcsname \undefined |
---|
| 2996 | % The \closeout helps reduce unnecessary open files; the limit on the |
---|
| 2997 | % Acorn RISC OS is a mere 16 files. |
---|
| 2998 | \expandafter\closeout\csname#2indfile\endcsname |
---|
| 2999 | \expandafter\let\csname\donesynindex#2\endcsname = 1 |
---|
| 3000 | \fi |
---|
| 3001 | % redefine \fooindfile: |
---|
| 3002 | \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname |
---|
| 3003 | \expandafter\let\csname#2indfile\endcsname=\temp |
---|
| 3004 | % redefine \fooindex: |
---|
| 3005 | \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% |
---|
[15293] | 3006 | } |
---|
| 3007 | |
---|
| 3008 | % Define \doindex, the driver for all \fooindex macros. |
---|
| 3009 | % Argument #1 is generated by the calling \fooindex macro, |
---|
| 3010 | % and it is "foo", the name of the index. |
---|
| 3011 | |
---|
| 3012 | % \doindex just uses \parsearg; it calls \doind for the actual work. |
---|
| 3013 | % This is because \doind is more useful to call from other macros. |
---|
| 3014 | |
---|
| 3015 | % There is also \dosubind {index}{topic}{subtopic} |
---|
| 3016 | % which makes an entry in a two-level index such as the operation index. |
---|
| 3017 | |
---|
| 3018 | \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} |
---|
| 3019 | \def\singleindexer #1{\doind{\indexname}{#1}} |
---|
| 3020 | |
---|
| 3021 | % like the previous two, but they put @code around the argument. |
---|
| 3022 | \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} |
---|
| 3023 | \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} |
---|
| 3024 | |
---|
[22253] | 3025 | % Take care of Texinfo commands that can appear in an index entry. |
---|
| 3026 | % Since there are some commands we want to expand, and others we don't, |
---|
| 3027 | % we have to laboriously prevent expansion for those that we don't. |
---|
| 3028 | % |
---|
[15293] | 3029 | \def\indexdummies{% |
---|
[22253] | 3030 | \def\@{@}% change to @@ when we switch to @ as escape char in index files. |
---|
| 3031 | \def\ {\realbackslash\space }% |
---|
| 3032 | % Need these in case \tex is in effect and \{ is a \delimiter again. |
---|
| 3033 | % But can't use \lbracecmd and \rbracecmd because texindex assumes |
---|
| 3034 | % braces and backslashes are used only as delimiters. |
---|
| 3035 | \let\{ = \mylbrace |
---|
| 3036 | \let\} = \myrbrace |
---|
| 3037 | % |
---|
| 3038 | % \definedummyword defines \#1 as \realbackslash #1\space, thus |
---|
| 3039 | % effectively preventing its expansion. This is used only for control |
---|
| 3040 | % words, not control letters, because the \space would be incorrect |
---|
| 3041 | % for control characters, but is needed to separate the control word |
---|
| 3042 | % from whatever follows. |
---|
| 3043 | % |
---|
| 3044 | % For control letters, we have \definedummyletter, which omits the |
---|
| 3045 | % space. |
---|
| 3046 | % |
---|
| 3047 | % These can be used both for control words that take an argument and |
---|
| 3048 | % those that do not. If it is followed by {arg} in the input, then |
---|
| 3049 | % that will dutifully get written to the index (or wherever). |
---|
| 3050 | % |
---|
| 3051 | \def\definedummyword##1{% |
---|
| 3052 | \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}% |
---|
| 3053 | }% |
---|
| 3054 | \def\definedummyletter##1{% |
---|
| 3055 | \expandafter\def\csname ##1\endcsname{\realbackslash ##1}% |
---|
| 3056 | }% |
---|
| 3057 | % |
---|
| 3058 | % Do the redefinitions. |
---|
| 3059 | \commondummies |
---|
| 3060 | } |
---|
| 3061 | |
---|
| 3062 | % For the aux file, @ is the escape character. So we want to redefine |
---|
| 3063 | % everything using @ instead of \realbackslash. When everything uses |
---|
| 3064 | % @, this will be simpler. |
---|
[18190] | 3065 | % |
---|
[22253] | 3066 | \def\atdummies{% |
---|
| 3067 | \def\@{@@}% |
---|
| 3068 | \def\ {@ }% |
---|
| 3069 | \let\{ = \lbraceatcmd |
---|
| 3070 | \let\} = \rbraceatcmd |
---|
| 3071 | % |
---|
| 3072 | % (See comments in \indexdummies.) |
---|
| 3073 | \def\definedummyword##1{% |
---|
| 3074 | \expandafter\def\csname ##1\endcsname{@##1\space}% |
---|
| 3075 | }% |
---|
| 3076 | \def\definedummyletter##1{% |
---|
| 3077 | \expandafter\def\csname ##1\endcsname{@##1}% |
---|
| 3078 | }% |
---|
| 3079 | % |
---|
| 3080 | % Do the redefinitions. |
---|
| 3081 | \commondummies |
---|
| 3082 | } |
---|
| 3083 | |
---|
| 3084 | % Called from \indexdummies and \atdummies. \definedummyword and |
---|
| 3085 | % \definedummyletter must be defined first. |
---|
[18190] | 3086 | % |
---|
[22253] | 3087 | \def\commondummies{% |
---|
| 3088 | % |
---|
| 3089 | \normalturnoffactive |
---|
| 3090 | % |
---|
| 3091 | \commondummiesnofonts |
---|
| 3092 | % |
---|
| 3093 | \definedummyletter{_}% |
---|
| 3094 | % |
---|
| 3095 | % Non-English letters. |
---|
| 3096 | \definedummyword{AA}% |
---|
| 3097 | \definedummyword{AE}% |
---|
| 3098 | \definedummyword{L}% |
---|
| 3099 | \definedummyword{OE}% |
---|
| 3100 | \definedummyword{O}% |
---|
| 3101 | \definedummyword{aa}% |
---|
| 3102 | \definedummyword{ae}% |
---|
| 3103 | \definedummyword{l}% |
---|
| 3104 | \definedummyword{oe}% |
---|
| 3105 | \definedummyword{o}% |
---|
| 3106 | \definedummyword{ss}% |
---|
| 3107 | \definedummyword{exclamdown}% |
---|
| 3108 | \definedummyword{questiondown}% |
---|
| 3109 | \definedummyword{ordf}% |
---|
| 3110 | \definedummyword{ordm}% |
---|
| 3111 | % |
---|
| 3112 | % Although these internal commands shouldn't show up, sometimes they do. |
---|
| 3113 | \definedummyword{bf}% |
---|
| 3114 | \definedummyword{gtr}% |
---|
| 3115 | \definedummyword{hat}% |
---|
| 3116 | \definedummyword{less}% |
---|
| 3117 | \definedummyword{sf}% |
---|
| 3118 | \definedummyword{sl}% |
---|
| 3119 | \definedummyword{tclose}% |
---|
| 3120 | \definedummyword{tt}% |
---|
| 3121 | % |
---|
| 3122 | \definedummyword{LaTeX}% |
---|
| 3123 | \definedummyword{TeX}% |
---|
| 3124 | % |
---|
| 3125 | % Assorted special characters. |
---|
| 3126 | \definedummyword{bullet}% |
---|
| 3127 | \definedummyword{copyright}% |
---|
| 3128 | \definedummyword{registeredsymbol}% |
---|
| 3129 | \definedummyword{dots}% |
---|
| 3130 | \definedummyword{enddots}% |
---|
| 3131 | \definedummyword{equiv}% |
---|
| 3132 | \definedummyword{error}% |
---|
| 3133 | \definedummyword{expansion}% |
---|
| 3134 | \definedummyword{minus}% |
---|
| 3135 | \definedummyword{pounds}% |
---|
| 3136 | \definedummyword{point}% |
---|
| 3137 | \definedummyword{print}% |
---|
| 3138 | \definedummyword{result}% |
---|
| 3139 | % |
---|
| 3140 | % Handle some cases of @value -- where it does not contain any |
---|
| 3141 | % (non-fully-expandable) commands. |
---|
| 3142 | \makevalueexpandable |
---|
| 3143 | % |
---|
| 3144 | % Normal spaces, not active ones. |
---|
| 3145 | \unsepspaces |
---|
| 3146 | % |
---|
| 3147 | % No macro expansion. |
---|
| 3148 | \turnoffmacros |
---|
| 3149 | } |
---|
| 3150 | |
---|
| 3151 | % \commondummiesnofonts: common to \commondummies and \indexnofonts. |
---|
[18190] | 3152 | % |
---|
[22253] | 3153 | % Better have this without active chars. |
---|
| 3154 | { |
---|
| 3155 | \catcode`\~=\other |
---|
| 3156 | \gdef\commondummiesnofonts{% |
---|
| 3157 | % Control letters and accents. |
---|
| 3158 | \definedummyletter{!}% |
---|
| 3159 | \definedummyletter{"}% |
---|
| 3160 | \definedummyletter{'}% |
---|
| 3161 | \definedummyletter{*}% |
---|
| 3162 | \definedummyletter{,}% |
---|
| 3163 | \definedummyletter{.}% |
---|
| 3164 | \definedummyletter{/}% |
---|
| 3165 | \definedummyletter{:}% |
---|
| 3166 | \definedummyletter{=}% |
---|
| 3167 | \definedummyletter{?}% |
---|
| 3168 | \definedummyletter{^}% |
---|
| 3169 | \definedummyletter{`}% |
---|
| 3170 | \definedummyletter{~}% |
---|
| 3171 | \definedummyword{u}% |
---|
| 3172 | \definedummyword{v}% |
---|
| 3173 | \definedummyword{H}% |
---|
| 3174 | \definedummyword{dotaccent}% |
---|
| 3175 | \definedummyword{ringaccent}% |
---|
| 3176 | \definedummyword{tieaccent}% |
---|
| 3177 | \definedummyword{ubaraccent}% |
---|
| 3178 | \definedummyword{udotaccent}% |
---|
| 3179 | \definedummyword{dotless}% |
---|
| 3180 | % |
---|
| 3181 | % Texinfo font commands. |
---|
| 3182 | \definedummyword{b}% |
---|
| 3183 | \definedummyword{i}% |
---|
| 3184 | \definedummyword{r}% |
---|
| 3185 | \definedummyword{sc}% |
---|
| 3186 | \definedummyword{t}% |
---|
| 3187 | % |
---|
| 3188 | % Commands that take arguments. |
---|
| 3189 | \definedummyword{acronym}% |
---|
| 3190 | \definedummyword{cite}% |
---|
| 3191 | \definedummyword{code}% |
---|
| 3192 | \definedummyword{command}% |
---|
| 3193 | \definedummyword{dfn}% |
---|
| 3194 | \definedummyword{emph}% |
---|
| 3195 | \definedummyword{env}% |
---|
| 3196 | \definedummyword{file}% |
---|
| 3197 | \definedummyword{kbd}% |
---|
| 3198 | \definedummyword{key}% |
---|
| 3199 | \definedummyword{math}% |
---|
| 3200 | \definedummyword{option}% |
---|
| 3201 | \definedummyword{samp}% |
---|
| 3202 | \definedummyword{strong}% |
---|
| 3203 | \definedummyword{tie}% |
---|
| 3204 | \definedummyword{uref}% |
---|
| 3205 | \definedummyword{url}% |
---|
| 3206 | \definedummyword{var}% |
---|
| 3207 | \definedummyword{verb}% |
---|
| 3208 | \definedummyword{w}% |
---|
| 3209 | } |
---|
[15293] | 3210 | } |
---|
| 3211 | |
---|
[22253] | 3212 | % \indexnofonts is used when outputting the strings to sort the index |
---|
| 3213 | % by, and when constructing control sequence names. It eliminates all |
---|
| 3214 | % control sequences and just writes whatever the best ASCII sort string |
---|
| 3215 | % would be for a given command (usually its argument). |
---|
| 3216 | % |
---|
[15293] | 3217 | \def\indexnofonts{% |
---|
[22253] | 3218 | \def\definedummyword##1{% |
---|
| 3219 | \expandafter\let\csname ##1\endcsname\asis |
---|
| 3220 | }% |
---|
| 3221 | % We can just ignore the accent commands and other control letters. |
---|
| 3222 | \def\definedummyletter##1{% |
---|
| 3223 | \expandafter\def\csname ##1\endcsname{}% |
---|
| 3224 | }% |
---|
| 3225 | % |
---|
| 3226 | \commondummiesnofonts |
---|
| 3227 | % |
---|
| 3228 | % Don't no-op \tt, since it isn't a user-level command |
---|
| 3229 | % and is used in the definitions of the active chars like <, >, |, etc. |
---|
| 3230 | % Likewise with the other plain tex font commands. |
---|
| 3231 | %\let\tt=\asis |
---|
| 3232 | % |
---|
| 3233 | \def\ { }% |
---|
| 3234 | \def\@{@}% |
---|
| 3235 | % how to handle braces? |
---|
| 3236 | \def\_{\normalunderscore}% |
---|
| 3237 | % |
---|
| 3238 | % Non-English letters. |
---|
| 3239 | \def\AA{AA}% |
---|
| 3240 | \def\AE{AE}% |
---|
| 3241 | \def\L{L}% |
---|
| 3242 | \def\OE{OE}% |
---|
| 3243 | \def\O{O}% |
---|
| 3244 | \def\aa{aa}% |
---|
| 3245 | \def\ae{ae}% |
---|
| 3246 | \def\l{l}% |
---|
| 3247 | \def\oe{oe}% |
---|
| 3248 | \def\o{o}% |
---|
| 3249 | \def\ss{ss}% |
---|
| 3250 | \def\exclamdown{!}% |
---|
| 3251 | \def\questiondown{?}% |
---|
| 3252 | \def\ordf{a}% |
---|
| 3253 | \def\ordm{o}% |
---|
| 3254 | % |
---|
| 3255 | \def\LaTeX{LaTeX}% |
---|
| 3256 | \def\TeX{TeX}% |
---|
| 3257 | % |
---|
| 3258 | % Assorted special characters. |
---|
| 3259 | % (The following {} will end up in the sort string, but that's ok.) |
---|
| 3260 | \def\bullet{bullet}% |
---|
| 3261 | \def\copyright{copyright}% |
---|
| 3262 | \def\registeredsymbol{R}% |
---|
| 3263 | \def\dots{...}% |
---|
| 3264 | \def\enddots{...}% |
---|
| 3265 | \def\equiv{==}% |
---|
| 3266 | \def\error{error}% |
---|
| 3267 | \def\expansion{==>}% |
---|
| 3268 | \def\minus{-}% |
---|
| 3269 | \def\pounds{pounds}% |
---|
| 3270 | \def\point{.}% |
---|
| 3271 | \def\print{-|}% |
---|
| 3272 | \def\result{=>}% |
---|
[15293] | 3273 | } |
---|
| 3274 | |
---|
| 3275 | \let\indexbackslash=0 %overridden during \printindex. |
---|
| 3276 | \let\SETmarginindex=\relax % put index entries in margin (undocumented)? |
---|
| 3277 | |
---|
| 3278 | % Most index entries go through here, but \dosubind is the general case. |
---|
[22253] | 3279 | % #1 is the index name, #2 is the entry text. |
---|
| 3280 | \def\doind#1#2{\dosubind{#1}{#2}{}} |
---|
[15293] | 3281 | |
---|
| 3282 | % Workhorse for all \fooindexes. |
---|
| 3283 | % #1 is name of index, #2 is stuff to put there, #3 is subentry -- |
---|
[22253] | 3284 | % empty if called from \doind, as we usually are (the main exception |
---|
| 3285 | % is with most defuns, which call us directly). |
---|
[15293] | 3286 | % |
---|
| 3287 | \def\dosubind#1#2#3{% |
---|
[22253] | 3288 | \iflinks |
---|
| 3289 | {% |
---|
| 3290 | % Store the main index entry text (including the third arg). |
---|
| 3291 | \toks0 = {#2}% |
---|
| 3292 | % If third arg is present, precede it with a space. |
---|
| 3293 | \def\thirdarg{#3}% |
---|
| 3294 | \ifx\thirdarg\empty \else |
---|
| 3295 | \toks0 = \expandafter{\the\toks0 \space #3}% |
---|
| 3296 | \fi |
---|
| 3297 | % |
---|
| 3298 | \edef\writeto{\csname#1indfile\endcsname}% |
---|
| 3299 | % |
---|
| 3300 | \ifvmode |
---|
| 3301 | \dosubindsanitize |
---|
| 3302 | \else |
---|
| 3303 | \dosubindwrite |
---|
| 3304 | \fi |
---|
| 3305 | }% |
---|
| 3306 | \fi |
---|
| 3307 | } |
---|
| 3308 | |
---|
| 3309 | % Write the entry in \toks0 to the index file: |
---|
| 3310 | % |
---|
| 3311 | \def\dosubindwrite{% |
---|
[15293] | 3312 | % Put the index entry in the margin if desired. |
---|
| 3313 | \ifx\SETmarginindex\relax\else |
---|
[22253] | 3314 | \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% |
---|
[15293] | 3315 | \fi |
---|
[22253] | 3316 | % |
---|
| 3317 | % Remember, we are within a group. |
---|
| 3318 | \indexdummies % Must do this here, since \bf, etc expand at this stage |
---|
| 3319 | \escapechar=`\\ |
---|
| 3320 | \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now |
---|
| 3321 | % so it will be output as is; and it will print as backslash. |
---|
| 3322 | % |
---|
| 3323 | % Process the index entry with all font commands turned off, to |
---|
| 3324 | % get the string to sort by. |
---|
| 3325 | {\indexnofonts |
---|
| 3326 | \edef\temp{\the\toks0}% need full expansion |
---|
| 3327 | \xdef\indexsorttmp{\temp}% |
---|
[15293] | 3328 | }% |
---|
[22253] | 3329 | % |
---|
| 3330 | % Set up the complete index entry, with both the sort key and |
---|
| 3331 | % the original text, including any font commands. We write |
---|
| 3332 | % three arguments to \entry to the .?? file (four in the |
---|
| 3333 | % subentry case), texindex reduces to two when writing the .??s |
---|
| 3334 | % sorted result. |
---|
| 3335 | \edef\temp{% |
---|
| 3336 | \write\writeto{% |
---|
| 3337 | \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% |
---|
| 3338 | }% |
---|
| 3339 | \temp |
---|
[15293] | 3340 | } |
---|
| 3341 | |
---|
[22253] | 3342 | % Take care of unwanted page breaks: |
---|
| 3343 | % |
---|
| 3344 | % If a skip is the last thing on the list now, preserve it |
---|
| 3345 | % by backing up by \lastskip, doing the \write, then inserting |
---|
| 3346 | % the skip again. Otherwise, the whatsit generated by the |
---|
| 3347 | % \write will make \lastskip zero. The result is that sequences |
---|
| 3348 | % like this: |
---|
| 3349 | % @end defun |
---|
| 3350 | % @tindex whatever |
---|
| 3351 | % @defun ... |
---|
| 3352 | % will have extra space inserted, because the \medbreak in the |
---|
| 3353 | % start of the @defun won't see the skip inserted by the @end of |
---|
| 3354 | % the previous defun. |
---|
| 3355 | % |
---|
| 3356 | % But don't do any of this if we're not in vertical mode. We |
---|
| 3357 | % don't want to do a \vskip and prematurely end a paragraph. |
---|
| 3358 | % |
---|
| 3359 | % Avoid page breaks due to these extra skips, too. |
---|
| 3360 | % |
---|
| 3361 | % But wait, there is a catch there: |
---|
| 3362 | % We'll have to check whether \lastskip is zero skip. \ifdim is not |
---|
| 3363 | % sufficient for this purpose, as it ignores stretch and shrink parts |
---|
| 3364 | % of the skip. The only way seems to be to check the textual |
---|
| 3365 | % representation of the skip. |
---|
| 3366 | % |
---|
| 3367 | % The following is almost like \def\zeroskipmacro{0.0pt} except that |
---|
| 3368 | % the ``p'' and ``t'' characters have catcode \other, not 11 (letter). |
---|
| 3369 | % |
---|
| 3370 | \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} |
---|
| 3371 | % |
---|
| 3372 | % ..., ready, GO: |
---|
| 3373 | % |
---|
| 3374 | \def\dosubindsanitize{% |
---|
| 3375 | % \lastskip and \lastpenalty cannot both be nonzero simultaneously. |
---|
| 3376 | \skip0 = \lastskip |
---|
| 3377 | \edef\lastskipmacro{\the\lastskip}% |
---|
| 3378 | \count255 = \lastpenalty |
---|
| 3379 | % |
---|
| 3380 | % If \lastskip is nonzero, that means the last item was a |
---|
| 3381 | % skip. And since a skip is discardable, that means this |
---|
| 3382 | % -\skip0 glue we're inserting is preceded by a |
---|
| 3383 | % non-discardable item, therefore it is not a potential |
---|
| 3384 | % breakpoint, therefore no \nobreak needed. |
---|
| 3385 | \ifx\lastskipmacro\zeroskipmacro |
---|
| 3386 | \else |
---|
| 3387 | \vskip-\skip0 |
---|
| 3388 | \fi |
---|
| 3389 | % |
---|
| 3390 | \dosubindwrite |
---|
| 3391 | % |
---|
| 3392 | \ifx\lastskipmacro\zeroskipmacro |
---|
| 3393 | % if \lastskip was zero, perhaps the last item was a |
---|
| 3394 | % penalty, and perhaps it was >=10000, e.g., a \nobreak. |
---|
| 3395 | % In that case, we want to re-insert the penalty; since we |
---|
| 3396 | % just inserted a non-discardable item, any following glue |
---|
| 3397 | % (such as a \parskip) would be a breakpoint. For example: |
---|
| 3398 | % @deffn deffn-whatever |
---|
| 3399 | % @vindex index-whatever |
---|
| 3400 | % Description. |
---|
| 3401 | % would allow a break between the index-whatever whatsit |
---|
| 3402 | % and the "Description." paragraph. |
---|
| 3403 | \ifnum\count255>9999 \nobreak \fi |
---|
| 3404 | \else |
---|
| 3405 | % On the other hand, if we had a nonzero \lastskip, |
---|
| 3406 | % this make-up glue would be preceded by a non-discardable item |
---|
| 3407 | % (the whatsit from the \write), so we must insert a \nobreak. |
---|
| 3408 | \nobreak\vskip\skip0 |
---|
| 3409 | \fi |
---|
| 3410 | } |
---|
| 3411 | |
---|
[15293] | 3412 | % The index entry written in the file actually looks like |
---|
| 3413 | % \entry {sortstring}{page}{topic} |
---|
| 3414 | % or |
---|
| 3415 | % \entry {sortstring}{page}{topic}{subtopic} |
---|
| 3416 | % The texindex program reads in these files and writes files |
---|
| 3417 | % containing these kinds of lines: |
---|
| 3418 | % \initial {c} |
---|
| 3419 | % before the first topic whose initial is c |
---|
| 3420 | % \entry {topic}{pagelist} |
---|
| 3421 | % for a topic that is used without subtopics |
---|
| 3422 | % \primary {topic} |
---|
| 3423 | % for the beginning of a topic that is used with subtopics |
---|
| 3424 | % \secondary {subtopic}{pagelist} |
---|
| 3425 | % for each subtopic. |
---|
| 3426 | |
---|
| 3427 | % Define the user-accessible indexing commands |
---|
| 3428 | % @findex, @vindex, @kindex, @cindex. |
---|
| 3429 | |
---|
| 3430 | \def\findex {\fnindex} |
---|
| 3431 | \def\kindex {\kyindex} |
---|
| 3432 | \def\cindex {\cpindex} |
---|
| 3433 | \def\vindex {\vrindex} |
---|
| 3434 | \def\tindex {\tpindex} |
---|
| 3435 | \def\pindex {\pgindex} |
---|
| 3436 | |
---|
| 3437 | \def\cindexsub {\begingroup\obeylines\cindexsub} |
---|
| 3438 | {\obeylines % |
---|
| 3439 | \gdef\cindexsub "#1" #2^^M{\endgroup % |
---|
| 3440 | \dosubind{cp}{#2}{#1}}} |
---|
| 3441 | |
---|
| 3442 | % Define the macros used in formatting output of the sorted index material. |
---|
| 3443 | |
---|
| 3444 | % @printindex causes a particular index (the ??s file) to get printed. |
---|
| 3445 | % It does not print any chapter heading (usually an @unnumbered). |
---|
| 3446 | % |
---|
[22253] | 3447 | \parseargdef\printindex{\begingroup |
---|
[15293] | 3448 | \dobreak \chapheadingskip{10000}% |
---|
| 3449 | % |
---|
[18190] | 3450 | \smallfonts \rm |
---|
[15293] | 3451 | \tolerance = 9500 |
---|
[22253] | 3452 | \everypar = {}% don't want the \kern\-parindent from indentation suppression. |
---|
[15293] | 3453 | % |
---|
| 3454 | % See if the index file exists and is nonempty. |
---|
| 3455 | % Change catcode of @ here so that if the index file contains |
---|
| 3456 | % \initial {@} |
---|
| 3457 | % as its first line, TeX doesn't complain about mismatched braces |
---|
| 3458 | % (because it thinks @} is a control sequence). |
---|
| 3459 | \catcode`\@ = 11 |
---|
| 3460 | \openin 1 \jobname.#1s |
---|
| 3461 | \ifeof 1 |
---|
| 3462 | % \enddoublecolumns gets confused if there is no text in the index, |
---|
| 3463 | % and it loses the chapter title and the aux file entries for the |
---|
| 3464 | % index. The easiest way to prevent this problem is to make sure |
---|
| 3465 | % there is some text. |
---|
| 3466 | \putwordIndexNonexistent |
---|
| 3467 | \else |
---|
| 3468 | % |
---|
| 3469 | % If the index file exists but is empty, then \openin leaves \ifeof |
---|
| 3470 | % false. We have to make TeX try to read something from the file, so |
---|
| 3471 | % it can discover if there is anything in it. |
---|
| 3472 | \read 1 to \temp |
---|
| 3473 | \ifeof 1 |
---|
| 3474 | \putwordIndexIsEmpty |
---|
| 3475 | \else |
---|
| 3476 | % Index files are almost Texinfo source, but we use \ as the escape |
---|
| 3477 | % character. It would be better to use @, but that's too big a change |
---|
| 3478 | % to make right now. |
---|
[22253] | 3479 | \def\indexbackslash{\backslashcurfont}% |
---|
[15293] | 3480 | \catcode`\\ = 0 |
---|
| 3481 | \escapechar = `\\ |
---|
| 3482 | \begindoublecolumns |
---|
| 3483 | \input \jobname.#1s |
---|
| 3484 | \enddoublecolumns |
---|
| 3485 | \fi |
---|
| 3486 | \fi |
---|
| 3487 | \closein 1 |
---|
| 3488 | \endgroup} |
---|
| 3489 | |
---|
| 3490 | % These macros are used by the sorted index file itself. |
---|
| 3491 | % Change them to control the appearance of the index. |
---|
| 3492 | |
---|
| 3493 | \def\initial#1{{% |
---|
| 3494 | % Some minor font changes for the special characters. |
---|
| 3495 | \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt |
---|
| 3496 | % |
---|
| 3497 | % Remove any glue we may have, we'll be inserting our own. |
---|
| 3498 | \removelastskip |
---|
| 3499 | % |
---|
| 3500 | % We like breaks before the index initials, so insert a bonus. |
---|
| 3501 | \penalty -300 |
---|
| 3502 | % |
---|
| 3503 | % Typeset the initial. Making this add up to a whole number of |
---|
| 3504 | % baselineskips increases the chance of the dots lining up from column |
---|
| 3505 | % to column. It still won't often be perfect, because of the stretch |
---|
| 3506 | % we need before each entry, but it's better. |
---|
| 3507 | % |
---|
| 3508 | % No shrink because it confuses \balancecolumns. |
---|
| 3509 | \vskip 1.67\baselineskip plus .5\baselineskip |
---|
| 3510 | \leftline{\secbf #1}% |
---|
| 3511 | \vskip .33\baselineskip plus .1\baselineskip |
---|
| 3512 | % |
---|
| 3513 | % Do our best not to break after the initial. |
---|
| 3514 | \nobreak |
---|
| 3515 | }} |
---|
| 3516 | |
---|
[22253] | 3517 | % \entry typesets a paragraph consisting of the text (#1), dot leaders, and |
---|
| 3518 | % then page number (#2) flushed to the right margin. It is used for index |
---|
| 3519 | % and table of contents entries. The paragraph is indented by \leftskip. |
---|
[15293] | 3520 | % |
---|
[22253] | 3521 | % A straightforward implementation would start like this: |
---|
| 3522 | % \def\entry#1#2{... |
---|
| 3523 | % But this frozes the catcodes in the argument, and can cause problems to |
---|
| 3524 | % @code, which sets - active. This problem was fixed by a kludge--- |
---|
| 3525 | % ``-'' was active throughout whole index, but this isn't really right. |
---|
| 3526 | % |
---|
| 3527 | % The right solution is to prevent \entry from swallowing the whole text. |
---|
| 3528 | % --kasal, 21nov03 |
---|
| 3529 | \def\entry{% |
---|
| 3530 | \begingroup |
---|
[15293] | 3531 | % |
---|
[22253] | 3532 | % Start a new paragraph if necessary, so our assignments below can't |
---|
| 3533 | % affect previous text. |
---|
| 3534 | \par |
---|
[15293] | 3535 | % |
---|
[22253] | 3536 | % Do not fill out the last line with white space. |
---|
| 3537 | \parfillskip = 0in |
---|
| 3538 | % |
---|
| 3539 | % No extra space above this paragraph. |
---|
| 3540 | \parskip = 0in |
---|
| 3541 | % |
---|
| 3542 | % Do not prefer a separate line ending with a hyphen to fewer lines. |
---|
| 3543 | \finalhyphendemerits = 0 |
---|
| 3544 | % |
---|
| 3545 | % \hangindent is only relevant when the entry text and page number |
---|
| 3546 | % don't both fit on one line. In that case, bob suggests starting the |
---|
| 3547 | % dots pretty far over on the line. Unfortunately, a large |
---|
| 3548 | % indentation looks wrong when the entry text itself is broken across |
---|
| 3549 | % lines. So we use a small indentation and put up with long leaders. |
---|
| 3550 | % |
---|
| 3551 | % \hangafter is reset to 1 (which is the value we want) at the start |
---|
| 3552 | % of each paragraph, so we need not do anything with that. |
---|
| 3553 | \hangindent = 2em |
---|
| 3554 | % |
---|
| 3555 | % When the entry text needs to be broken, just fill out the first line |
---|
| 3556 | % with blank space. |
---|
| 3557 | \rightskip = 0pt plus1fil |
---|
| 3558 | % |
---|
| 3559 | % A bit of stretch before each entry for the benefit of balancing |
---|
| 3560 | % columns. |
---|
| 3561 | \vskip 0pt plus1pt |
---|
| 3562 | % |
---|
| 3563 | % Swallow the left brace of the text (first parameter): |
---|
| 3564 | \afterassignment\doentry |
---|
| 3565 | \let\temp = |
---|
| 3566 | } |
---|
| 3567 | \def\doentry{% |
---|
| 3568 | \bgroup % Instead of the swallowed brace. |
---|
| 3569 | \noindent |
---|
| 3570 | \aftergroup\finishentry |
---|
| 3571 | % And now comes the text of the entry. |
---|
| 3572 | } |
---|
| 3573 | \def\finishentry#1{% |
---|
| 3574 | % #1 is the page number. |
---|
| 3575 | % |
---|
| 3576 | % The following is kludged to not output a line of dots in the index if |
---|
| 3577 | % there are no page numbers. The next person who breaks this will be |
---|
| 3578 | % cursed by a Unix daemon. |
---|
| 3579 | \def\tempa{{\rm }}% |
---|
| 3580 | \def\tempb{#1}% |
---|
| 3581 | \edef\tempc{\tempa}% |
---|
| 3582 | \edef\tempd{\tempb}% |
---|
| 3583 | \ifx\tempc\tempd |
---|
| 3584 | \ % |
---|
[18190] | 3585 | \else |
---|
[22253] | 3586 | % |
---|
| 3587 | % If we must, put the page number on a line of its own, and fill out |
---|
| 3588 | % this line with blank space. (The \hfil is overwhelmed with the |
---|
| 3589 | % fill leaders glue in \indexdotfill if the page number does fit.) |
---|
| 3590 | \hfil\penalty50 |
---|
| 3591 | \null\nobreak\indexdotfill % Have leaders before the page number. |
---|
| 3592 | % |
---|
| 3593 | % The `\ ' here is removed by the implicit \unskip that TeX does as |
---|
| 3594 | % part of (the primitive) \par. Without it, a spurious underfull |
---|
| 3595 | % \hbox ensues. |
---|
| 3596 | \ifpdf |
---|
| 3597 | \pdfgettoks#1.% |
---|
| 3598 | \ \the\toksA |
---|
| 3599 | \else |
---|
| 3600 | \ #1% |
---|
| 3601 | \fi |
---|
[18190] | 3602 | \fi |
---|
[22253] | 3603 | \par |
---|
| 3604 | \endgroup |
---|
| 3605 | } |
---|
[15293] | 3606 | |
---|
| 3607 | % Like \dotfill except takes at least 1 em. |
---|
| 3608 | \def\indexdotfill{\cleaders |
---|
| 3609 | \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill} |
---|
| 3610 | |
---|
| 3611 | \def\primary #1{\line{#1\hfil}} |
---|
| 3612 | |
---|
| 3613 | \newskip\secondaryindent \secondaryindent=0.5cm |
---|
[18190] | 3614 | \def\secondary#1#2{{% |
---|
| 3615 | \parfillskip=0in |
---|
| 3616 | \parskip=0in |
---|
| 3617 | \hangindent=1in |
---|
| 3618 | \hangafter=1 |
---|
| 3619 | \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill |
---|
| 3620 | \ifpdf |
---|
| 3621 | \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. |
---|
| 3622 | \else |
---|
| 3623 | #2 |
---|
| 3624 | \fi |
---|
| 3625 | \par |
---|
[15293] | 3626 | }} |
---|
| 3627 | |
---|
| 3628 | % Define two-column mode, which we use to typeset indexes. |
---|
| 3629 | % Adapted from the TeXbook, page 416, which is to say, |
---|
| 3630 | % the manmac.tex format used to print the TeXbook itself. |
---|
| 3631 | \catcode`\@=11 |
---|
| 3632 | |
---|
| 3633 | \newbox\partialpage |
---|
| 3634 | \newdimen\doublecolumnhsize |
---|
| 3635 | |
---|
| 3636 | \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns |
---|
| 3637 | % Grab any single-column material above us. |
---|
| 3638 | \output = {% |
---|
| 3639 | % |
---|
| 3640 | % Here is a possibility not foreseen in manmac: if we accumulate a |
---|
| 3641 | % whole lot of material, we might end up calling this \output |
---|
| 3642 | % routine twice in a row (see the doublecol-lose test, which is |
---|
| 3643 | % essentially a couple of indexes with @setchapternewpage off). In |
---|
| 3644 | % that case we just ship out what is in \partialpage with the normal |
---|
| 3645 | % output routine. Generally, \partialpage will be empty when this |
---|
| 3646 | % runs and this will be a no-op. See the indexspread.tex test case. |
---|
| 3647 | \ifvoid\partialpage \else |
---|
| 3648 | \onepageout{\pagecontents\partialpage}% |
---|
| 3649 | \fi |
---|
| 3650 | % |
---|
| 3651 | \global\setbox\partialpage = \vbox{% |
---|
| 3652 | % Unvbox the main output page. |
---|
| 3653 | \unvbox\PAGE |
---|
| 3654 | \kern-\topskip \kern\baselineskip |
---|
| 3655 | }% |
---|
| 3656 | }% |
---|
| 3657 | \eject % run that output routine to set \partialpage |
---|
| 3658 | % |
---|
| 3659 | % Use the double-column output routine for subsequent pages. |
---|
| 3660 | \output = {\doublecolumnout}% |
---|
| 3661 | % |
---|
| 3662 | % Change the page size parameters. We could do this once outside this |
---|
| 3663 | % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 |
---|
| 3664 | % format, but then we repeat the same computation. Repeating a couple |
---|
| 3665 | % of assignments once per index is clearly meaningless for the |
---|
| 3666 | % execution time, so we may as well do it in one place. |
---|
| 3667 | % |
---|
| 3668 | % First we halve the line length, less a little for the gutter between |
---|
| 3669 | % the columns. We compute the gutter based on the line length, so it |
---|
| 3670 | % changes automatically with the paper format. The magic constant |
---|
| 3671 | % below is chosen so that the gutter has the same value (well, +-<1pt) |
---|
| 3672 | % as it did when we hard-coded it. |
---|
| 3673 | % |
---|
| 3674 | % We put the result in a separate register, \doublecolumhsize, so we |
---|
| 3675 | % can restore it in \pagesofar, after \hsize itself has (potentially) |
---|
| 3676 | % been clobbered. |
---|
| 3677 | % |
---|
| 3678 | \doublecolumnhsize = \hsize |
---|
| 3679 | \advance\doublecolumnhsize by -.04154\hsize |
---|
| 3680 | \divide\doublecolumnhsize by 2 |
---|
| 3681 | \hsize = \doublecolumnhsize |
---|
| 3682 | % |
---|
| 3683 | % Double the \vsize as well. (We don't need a separate register here, |
---|
| 3684 | % since nobody clobbers \vsize.) |
---|
| 3685 | \vsize = 2\vsize |
---|
| 3686 | } |
---|
| 3687 | |
---|
| 3688 | % The double-column output routine for all double-column pages except |
---|
| 3689 | % the last. |
---|
| 3690 | % |
---|
| 3691 | \def\doublecolumnout{% |
---|
| 3692 | \splittopskip=\topskip \splitmaxdepth=\maxdepth |
---|
| 3693 | % Get the available space for the double columns -- the normal |
---|
| 3694 | % (undoubled) page height minus any material left over from the |
---|
| 3695 | % previous page. |
---|
| 3696 | \dimen@ = \vsize |
---|
| 3697 | \divide\dimen@ by 2 |
---|
[18190] | 3698 | \advance\dimen@ by -\ht\partialpage |
---|
[15293] | 3699 | % |
---|
| 3700 | % box0 will be the left-hand column, box2 the right. |
---|
| 3701 | \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ |
---|
| 3702 | \onepageout\pagesofar |
---|
| 3703 | \unvbox255 |
---|
| 3704 | \penalty\outputpenalty |
---|
| 3705 | } |
---|
[18190] | 3706 | % |
---|
| 3707 | % Re-output the contents of the output page -- any previous material, |
---|
| 3708 | % followed by the two boxes we just split, in box0 and box2. |
---|
[15293] | 3709 | \def\pagesofar{% |
---|
| 3710 | \unvbox\partialpage |
---|
| 3711 | % |
---|
| 3712 | \hsize = \doublecolumnhsize |
---|
| 3713 | \wd0=\hsize \wd2=\hsize |
---|
| 3714 | \hbox to\pagewidth{\box0\hfil\box2}% |
---|
| 3715 | } |
---|
[22253] | 3716 | % |
---|
[18190] | 3717 | % All done with double columns. |
---|
[15293] | 3718 | \def\enddoublecolumns{% |
---|
| 3719 | \output = {% |
---|
| 3720 | % Split the last of the double-column material. Leave it on the |
---|
| 3721 | % current page, no automatic page break. |
---|
| 3722 | \balancecolumns |
---|
| 3723 | % |
---|
| 3724 | % If we end up splitting too much material for the current page, |
---|
| 3725 | % though, there will be another page break right after this \output |
---|
| 3726 | % invocation ends. Having called \balancecolumns once, we do not |
---|
| 3727 | % want to call it again. Therefore, reset \output to its normal |
---|
| 3728 | % definition right away. (We hope \balancecolumns will never be |
---|
| 3729 | % called on to balance too much material, but if it is, this makes |
---|
| 3730 | % the output somewhat more palatable.) |
---|
| 3731 | \global\output = {\onepageout{\pagecontents\PAGE}}% |
---|
| 3732 | }% |
---|
| 3733 | \eject |
---|
| 3734 | \endgroup % started in \begindoublecolumns |
---|
| 3735 | % |
---|
| 3736 | % \pagegoal was set to the doubled \vsize above, since we restarted |
---|
| 3737 | % the current page. We're now back to normal single-column |
---|
| 3738 | % typesetting, so reset \pagegoal to the normal \vsize (after the |
---|
| 3739 | % \endgroup where \vsize got restored). |
---|
| 3740 | \pagegoal = \vsize |
---|
| 3741 | } |
---|
[18190] | 3742 | % |
---|
| 3743 | % Called at the end of the double column material. |
---|
[15293] | 3744 | \def\balancecolumns{% |
---|
| 3745 | \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. |
---|
| 3746 | \dimen@ = \ht0 |
---|
| 3747 | \advance\dimen@ by \topskip |
---|
| 3748 | \advance\dimen@ by-\baselineskip |
---|
| 3749 | \divide\dimen@ by 2 % target to split to |
---|
| 3750 | %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% |
---|
| 3751 | \splittopskip = \topskip |
---|
| 3752 | % Loop until we get a decent breakpoint. |
---|
| 3753 | {% |
---|
| 3754 | \vbadness = 10000 |
---|
| 3755 | \loop |
---|
| 3756 | \global\setbox3 = \copy0 |
---|
| 3757 | \global\setbox1 = \vsplit3 to \dimen@ |
---|
| 3758 | \ifdim\ht3>\dimen@ |
---|
| 3759 | \global\advance\dimen@ by 1pt |
---|
| 3760 | \repeat |
---|
| 3761 | }% |
---|
| 3762 | %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% |
---|
| 3763 | \setbox0=\vbox to\dimen@{\unvbox1}% |
---|
| 3764 | \setbox2=\vbox to\dimen@{\unvbox3}% |
---|
| 3765 | % |
---|
| 3766 | \pagesofar |
---|
| 3767 | } |
---|
| 3768 | \catcode`\@ = \other |
---|
| 3769 | |
---|
| 3770 | |
---|
| 3771 | \message{sectioning,} |
---|
[18190] | 3772 | % Chapters, sections, etc. |
---|
[15293] | 3773 | |
---|
[22253] | 3774 | % \unnumberedno is an oxymoron, of course. But we count the unnumbered |
---|
| 3775 | % sections so that we can refer to them unambiguously in the pdf |
---|
| 3776 | % outlines by their "section number". We avoid collisions with chapter |
---|
| 3777 | % numbers by starting them at 10000. (If a document ever has 10000 |
---|
| 3778 | % chapters, we're in trouble anyway, I'm sure.) |
---|
| 3779 | \newcount\unnumberedno \unnumberedno = 10000 |
---|
[15293] | 3780 | \newcount\chapno |
---|
| 3781 | \newcount\secno \secno=0 |
---|
| 3782 | \newcount\subsecno \subsecno=0 |
---|
| 3783 | \newcount\subsubsecno \subsubsecno=0 |
---|
| 3784 | |
---|
| 3785 | % This counter is funny since it counts through charcodes of letters A, B, ... |
---|
| 3786 | \newcount\appendixno \appendixno = `\@ |
---|
[22253] | 3787 | % |
---|
[18190] | 3788 | % \def\appendixletter{\char\the\appendixno} |
---|
[22253] | 3789 | % We do the following ugly conditional instead of the above simple |
---|
| 3790 | % construct for the sake of pdftex, which needs the actual |
---|
[18190] | 3791 | % letter in the expansion, not just typeset. |
---|
[22253] | 3792 | % |
---|
[18190] | 3793 | \def\appendixletter{% |
---|
| 3794 | \ifnum\appendixno=`A A% |
---|
| 3795 | \else\ifnum\appendixno=`B B% |
---|
| 3796 | \else\ifnum\appendixno=`C C% |
---|
| 3797 | \else\ifnum\appendixno=`D D% |
---|
| 3798 | \else\ifnum\appendixno=`E E% |
---|
| 3799 | \else\ifnum\appendixno=`F F% |
---|
| 3800 | \else\ifnum\appendixno=`G G% |
---|
| 3801 | \else\ifnum\appendixno=`H H% |
---|
| 3802 | \else\ifnum\appendixno=`I I% |
---|
| 3803 | \else\ifnum\appendixno=`J J% |
---|
| 3804 | \else\ifnum\appendixno=`K K% |
---|
| 3805 | \else\ifnum\appendixno=`L L% |
---|
| 3806 | \else\ifnum\appendixno=`M M% |
---|
| 3807 | \else\ifnum\appendixno=`N N% |
---|
| 3808 | \else\ifnum\appendixno=`O O% |
---|
| 3809 | \else\ifnum\appendixno=`P P% |
---|
| 3810 | \else\ifnum\appendixno=`Q Q% |
---|
| 3811 | \else\ifnum\appendixno=`R R% |
---|
| 3812 | \else\ifnum\appendixno=`S S% |
---|
| 3813 | \else\ifnum\appendixno=`T T% |
---|
| 3814 | \else\ifnum\appendixno=`U U% |
---|
| 3815 | \else\ifnum\appendixno=`V V% |
---|
| 3816 | \else\ifnum\appendixno=`W W% |
---|
| 3817 | \else\ifnum\appendixno=`X X% |
---|
| 3818 | \else\ifnum\appendixno=`Y Y% |
---|
| 3819 | \else\ifnum\appendixno=`Z Z% |
---|
| 3820 | % The \the is necessary, despite appearances, because \appendixletter is |
---|
| 3821 | % expanded while writing the .toc file. \char\appendixno is not |
---|
| 3822 | % expandable, thus it is written literally, thus all appendixes come out |
---|
| 3823 | % with the same letter (or @) in the toc without it. |
---|
| 3824 | \else\char\the\appendixno |
---|
| 3825 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi |
---|
| 3826 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} |
---|
[15293] | 3827 | |
---|
| 3828 | % Each @chapter defines this as the name of the chapter. |
---|
| 3829 | % page headings and footings can use it. @section does likewise. |
---|
[22253] | 3830 | % However, they are not reliable, because we don't use marks. |
---|
[15293] | 3831 | \def\thischapter{} |
---|
| 3832 | \def\thissection{} |
---|
| 3833 | |
---|
| 3834 | \newcount\absseclevel % used to calculate proper heading level |
---|
[22253] | 3835 | \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count |
---|
[15293] | 3836 | |
---|
| 3837 | % @raisesections: treat @section as chapter, @subsection as section, etc. |
---|
| 3838 | \def\raisesections{\global\advance\secbase by -1} |
---|
| 3839 | \let\up=\raisesections % original BFox name |
---|
| 3840 | |
---|
| 3841 | % @lowersections: treat @chapter as section, @section as subsection, etc. |
---|
| 3842 | \def\lowersections{\global\advance\secbase by 1} |
---|
| 3843 | \let\down=\lowersections % original BFox name |
---|
| 3844 | |
---|
[22253] | 3845 | % we only have subsub. |
---|
| 3846 | \chardef\maxseclevel = 3 |
---|
| 3847 | % |
---|
| 3848 | % A numbered section within an unnumbered changes to unnumbered too. |
---|
| 3849 | % To achive this, remember the "biggest" unnum. sec. we are currently in: |
---|
| 3850 | \chardef\unmlevel = \maxseclevel |
---|
| 3851 | % |
---|
| 3852 | % Trace whether the current chapter is an appendix or not: |
---|
| 3853 | % \chapheadtype is "N" or "A", unnumbered chapters are ignored. |
---|
| 3854 | \def\chapheadtype{N} |
---|
| 3855 | |
---|
| 3856 | % Choose a heading macro |
---|
| 3857 | % #1 is heading type |
---|
| 3858 | % #2 is heading level |
---|
| 3859 | % #3 is text for heading |
---|
| 3860 | \def\genhead#1#2#3{% |
---|
| 3861 | % Compute the abs. sec. level: |
---|
| 3862 | \absseclevel=#2 |
---|
| 3863 | \advance\absseclevel by \secbase |
---|
| 3864 | % Make sure \absseclevel doesn't fall outside the range: |
---|
| 3865 | \ifnum \absseclevel < 0 |
---|
| 3866 | \absseclevel = 0 |
---|
[15293] | 3867 | \else |
---|
[22253] | 3868 | \ifnum \absseclevel > 3 |
---|
| 3869 | \absseclevel = 3 |
---|
| 3870 | \fi |
---|
[15293] | 3871 | \fi |
---|
[22253] | 3872 | % The heading type: |
---|
| 3873 | \def\headtype{#1}% |
---|
| 3874 | \if \headtype U% |
---|
| 3875 | \ifnum \absseclevel < \unmlevel |
---|
| 3876 | \chardef\unmlevel = \absseclevel |
---|
| 3877 | \fi |
---|
[15293] | 3878 | \else |
---|
[22253] | 3879 | % Check for appendix sections: |
---|
| 3880 | \ifnum \absseclevel = 0 |
---|
| 3881 | \edef\chapheadtype{\headtype}% |
---|
| 3882 | \else |
---|
| 3883 | \if \headtype A\if \chapheadtype N% |
---|
| 3884 | \errmessage{@appendix... within a non-appendix chapter}% |
---|
| 3885 | \fi\fi |
---|
| 3886 | \fi |
---|
| 3887 | % Check for numbered within unnumbered: |
---|
| 3888 | \ifnum \absseclevel > \unmlevel |
---|
| 3889 | \def\headtype{U}% |
---|
| 3890 | \else |
---|
| 3891 | \chardef\unmlevel = 3 |
---|
| 3892 | \fi |
---|
[15293] | 3893 | \fi |
---|
[22253] | 3894 | % Now print the heading: |
---|
| 3895 | \if \headtype U% |
---|
| 3896 | \ifcase\absseclevel |
---|
| 3897 | \unnumberedzzz{#3}% |
---|
| 3898 | \or \unnumberedseczzz{#3}% |
---|
| 3899 | \or \unnumberedsubseczzz{#3}% |
---|
| 3900 | \or \unnumberedsubsubseczzz{#3}% |
---|
| 3901 | \fi |
---|
[15293] | 3902 | \else |
---|
[22253] | 3903 | \if \headtype A% |
---|
| 3904 | \ifcase\absseclevel |
---|
| 3905 | \appendixzzz{#3}% |
---|
| 3906 | \or \appendixsectionzzz{#3}% |
---|
| 3907 | \or \appendixsubseczzz{#3}% |
---|
| 3908 | \or \appendixsubsubseczzz{#3}% |
---|
| 3909 | \fi |
---|
| 3910 | \else |
---|
| 3911 | \ifcase\absseclevel |
---|
| 3912 | \chapterzzz{#3}% |
---|
| 3913 | \or \seczzz{#3}% |
---|
| 3914 | \or \numberedsubseczzz{#3}% |
---|
| 3915 | \or \numberedsubsubseczzz{#3}% |
---|
| 3916 | \fi |
---|
| 3917 | \fi |
---|
[15293] | 3918 | \fi |
---|
[22253] | 3919 | \suppressfirstparagraphindent |
---|
[15293] | 3920 | } |
---|
| 3921 | |
---|
[22253] | 3922 | % an interface: |
---|
| 3923 | \def\numhead{\genhead N} |
---|
| 3924 | \def\apphead{\genhead A} |
---|
| 3925 | \def\unnmhead{\genhead U} |
---|
| 3926 | |
---|
| 3927 | % @chapter, @appendix, @unnumbered. Increment top-level counter, reset |
---|
| 3928 | % all lower-level sectioning counters to zero. |
---|
| 3929 | % |
---|
| 3930 | % Also set \chaplevelprefix, which we prepend to @float sequence numbers |
---|
| 3931 | % (e.g., figures), q.v. By default (before any chapter), that is empty. |
---|
| 3932 | \let\chaplevelprefix = \empty |
---|
| 3933 | % |
---|
| 3934 | \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz |
---|
| 3935 | \def\chapterzzz#1{% |
---|
| 3936 | % section resetting is \global in case the chapter is in a group, such |
---|
| 3937 | % as an @include file. |
---|
| 3938 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 |
---|
| 3939 | \global\advance\chapno by 1 |
---|
| 3940 | % |
---|
| 3941 | % Used for \float. |
---|
| 3942 | \gdef\chaplevelprefix{\the\chapno.}% |
---|
| 3943 | \resetallfloatnos |
---|
| 3944 | % |
---|
| 3945 | \message{\putwordChapter\space \the\chapno}% |
---|
| 3946 | % |
---|
| 3947 | % Write the actual heading. |
---|
| 3948 | \chapmacro{#1}{Ynumbered}{\the\chapno}% |
---|
| 3949 | % |
---|
| 3950 | % So @section and the like are numbered underneath this chapter. |
---|
| 3951 | \global\let\section = \numberedsec |
---|
| 3952 | \global\let\subsection = \numberedsubsec |
---|
| 3953 | \global\let\subsubsection = \numberedsubsubsec |
---|
[15293] | 3954 | } |
---|
| 3955 | |
---|
[22253] | 3956 | \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz |
---|
| 3957 | \def\appendixzzz#1{% |
---|
| 3958 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 |
---|
| 3959 | \global\advance\appendixno by 1 |
---|
| 3960 | \gdef\chaplevelprefix{\appendixletter.}% |
---|
| 3961 | \resetallfloatnos |
---|
| 3962 | % |
---|
| 3963 | \def\appendixnum{\putwordAppendix\space \appendixletter}% |
---|
| 3964 | \message{\appendixnum}% |
---|
| 3965 | % |
---|
| 3966 | \chapmacro{#1}{Yappendix}{\appendixletter}% |
---|
| 3967 | % |
---|
| 3968 | \global\let\section = \appendixsec |
---|
| 3969 | \global\let\subsection = \appendixsubsec |
---|
| 3970 | \global\let\subsubsection = \appendixsubsubsec |
---|
[15293] | 3971 | } |
---|
| 3972 | |
---|
[22253] | 3973 | \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz |
---|
| 3974 | \def\unnumberedzzz#1{% |
---|
| 3975 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 |
---|
| 3976 | \global\advance\unnumberedno by 1 |
---|
| 3977 | % |
---|
| 3978 | % Since an unnumbered has no number, no prefix for figures. |
---|
| 3979 | \global\let\chaplevelprefix = \empty |
---|
| 3980 | \resetallfloatnos |
---|
| 3981 | % |
---|
| 3982 | % This used to be simply \message{#1}, but TeX fully expands the |
---|
| 3983 | % argument to \message. Therefore, if #1 contained @-commands, TeX |
---|
| 3984 | % expanded them. For example, in `@unnumbered The @cite{Book}', TeX |
---|
| 3985 | % expanded @cite (which turns out to cause errors because \cite is meant |
---|
| 3986 | % to be executed, not expanded). |
---|
| 3987 | % |
---|
| 3988 | % Anyway, we don't want the fully-expanded definition of @cite to appear |
---|
| 3989 | % as a result of the \message, we just want `@cite' itself. We use |
---|
| 3990 | % \the<toks register> to achieve this: TeX expands \the<toks> only once, |
---|
| 3991 | % simply yielding the contents of <toks register>. (We also do this for |
---|
| 3992 | % the toc entries.) |
---|
| 3993 | \toks0 = {#1}% |
---|
| 3994 | \message{(\the\toks0)}% |
---|
| 3995 | % |
---|
| 3996 | \chapmacro{#1}{Ynothing}{\the\unnumberedno}% |
---|
| 3997 | % |
---|
| 3998 | \global\let\section = \unnumberedsec |
---|
| 3999 | \global\let\subsection = \unnumberedsubsec |
---|
| 4000 | \global\let\subsubsection = \unnumberedsubsubsec |
---|
| 4001 | } |
---|
| 4002 | |
---|
[15293] | 4003 | % @centerchap is like @unnumbered, but the heading is centered. |
---|
[22253] | 4004 | \outer\parseargdef\centerchap{% |
---|
| 4005 | % Well, we could do the following in a group, but that would break |
---|
| 4006 | % an assumption that \chapmacro is called at the outermost level. |
---|
| 4007 | % Thus we are safer this way: --kasal, 24feb04 |
---|
| 4008 | \let\centerparametersmaybe = \centerparameters |
---|
| 4009 | \unnmhead0{#1}% |
---|
| 4010 | \let\centerparametersmaybe = \relax |
---|
| 4011 | } |
---|
[15293] | 4012 | |
---|
| 4013 | % @top is like @unnumbered. |
---|
[22253] | 4014 | \let\top\unnumbered |
---|
[15293] | 4015 | |
---|
| 4016 | % Sections. |
---|
[22253] | 4017 | \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz |
---|
| 4018 | \def\seczzz#1{% |
---|
| 4019 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 |
---|
| 4020 | \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% |
---|
[15293] | 4021 | } |
---|
| 4022 | |
---|
[22253] | 4023 | \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz |
---|
| 4024 | \def\appendixsectionzzz#1{% |
---|
| 4025 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 |
---|
| 4026 | \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% |
---|
[15293] | 4027 | } |
---|
[22253] | 4028 | \let\appendixsec\appendixsection |
---|
[15293] | 4029 | |
---|
[22253] | 4030 | \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz |
---|
| 4031 | \def\unnumberedseczzz#1{% |
---|
| 4032 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 |
---|
| 4033 | \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% |
---|
[15293] | 4034 | } |
---|
| 4035 | |
---|
| 4036 | % Subsections. |
---|
[22253] | 4037 | \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz |
---|
| 4038 | \def\numberedsubseczzz#1{% |
---|
| 4039 | \global\subsubsecno=0 \global\advance\subsecno by 1 |
---|
| 4040 | \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% |
---|
[15293] | 4041 | } |
---|
| 4042 | |
---|
[22253] | 4043 | \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz |
---|
| 4044 | \def\appendixsubseczzz#1{% |
---|
| 4045 | \global\subsubsecno=0 \global\advance\subsecno by 1 |
---|
| 4046 | \sectionheading{#1}{subsec}{Yappendix}% |
---|
| 4047 | {\appendixletter.\the\secno.\the\subsecno}% |
---|
[15293] | 4048 | } |
---|
| 4049 | |
---|
[22253] | 4050 | \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz |
---|
| 4051 | \def\unnumberedsubseczzz#1{% |
---|
| 4052 | \global\subsubsecno=0 \global\advance\subsecno by 1 |
---|
| 4053 | \sectionheading{#1}{subsec}{Ynothing}% |
---|
| 4054 | {\the\unnumberedno.\the\secno.\the\subsecno}% |
---|
[15293] | 4055 | } |
---|
| 4056 | |
---|
| 4057 | % Subsubsections. |
---|
[22253] | 4058 | \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz |
---|
| 4059 | \def\numberedsubsubseczzz#1{% |
---|
| 4060 | \global\advance\subsubsecno by 1 |
---|
| 4061 | \sectionheading{#1}{subsubsec}{Ynumbered}% |
---|
| 4062 | {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% |
---|
[15293] | 4063 | } |
---|
| 4064 | |
---|
[22253] | 4065 | \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz |
---|
| 4066 | \def\appendixsubsubseczzz#1{% |
---|
| 4067 | \global\advance\subsubsecno by 1 |
---|
| 4068 | \sectionheading{#1}{subsubsec}{Yappendix}% |
---|
| 4069 | {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% |
---|
[15293] | 4070 | } |
---|
| 4071 | |
---|
[22253] | 4072 | \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz |
---|
| 4073 | \def\unnumberedsubsubseczzz#1{% |
---|
| 4074 | \global\advance\subsubsecno by 1 |
---|
| 4075 | \sectionheading{#1}{subsubsec}{Ynothing}% |
---|
| 4076 | {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% |
---|
[15293] | 4077 | } |
---|
| 4078 | |
---|
| 4079 | % These macros control what the section commands do, according |
---|
| 4080 | % to what kind of chapter we are in (ordinary, appendix, or unnumbered). |
---|
| 4081 | % Define them by default for a numbered chapter. |
---|
[22253] | 4082 | \let\section = \numberedsec |
---|
| 4083 | \let\subsection = \numberedsubsec |
---|
| 4084 | \let\subsubsection = \numberedsubsubsec |
---|
[15293] | 4085 | |
---|
| 4086 | % Define @majorheading, @heading and @subheading |
---|
| 4087 | |
---|
| 4088 | % NOTE on use of \vbox for chapter headings, section headings, and such: |
---|
| 4089 | % 1) We use \vbox rather than the earlier \line to permit |
---|
| 4090 | % overlong headings to fold. |
---|
| 4091 | % 2) \hyphenpenalty is set to 10000 because hyphenation in a |
---|
| 4092 | % heading is obnoxious; this forbids it. |
---|
| 4093 | % 3) Likewise, headings look best if no \parindent is used, and |
---|
| 4094 | % if justification is not attempted. Hence \raggedright. |
---|
| 4095 | |
---|
| 4096 | |
---|
[22253] | 4097 | \def\majorheading{% |
---|
| 4098 | {\advance\chapheadingskip by 10pt \chapbreak }% |
---|
| 4099 | \parsearg\chapheadingzzz |
---|
| 4100 | } |
---|
[15293] | 4101 | |
---|
[22253] | 4102 | \def\chapheading{\chapbreak \parsearg\chapheadingzzz} |
---|
| 4103 | \def\chapheadingzzz#1{% |
---|
| 4104 | {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 |
---|
| 4105 | \parindent=0pt\raggedright |
---|
| 4106 | \rm #1\hfill}}% |
---|
| 4107 | \bigskip \par\penalty 200\relax |
---|
| 4108 | \suppressfirstparagraphindent |
---|
| 4109 | } |
---|
[15293] | 4110 | |
---|
| 4111 | % @heading, @subheading, @subsubheading. |
---|
[22253] | 4112 | \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} |
---|
| 4113 | \suppressfirstparagraphindent} |
---|
| 4114 | \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} |
---|
| 4115 | \suppressfirstparagraphindent} |
---|
| 4116 | \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} |
---|
| 4117 | \suppressfirstparagraphindent} |
---|
[15293] | 4118 | |
---|
| 4119 | % These macros generate a chapter, section, etc. heading only |
---|
| 4120 | % (including whitespace, linebreaking, etc. around it), |
---|
| 4121 | % given all the information in convenient, parsed form. |
---|
| 4122 | |
---|
| 4123 | %%% Args are the skip and penalty (usually negative) |
---|
| 4124 | \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} |
---|
| 4125 | |
---|
| 4126 | %%% Define plain chapter starts, and page on/off switching for it |
---|
| 4127 | % Parameter controlling skip before chapter headings (if needed) |
---|
| 4128 | |
---|
| 4129 | \newskip\chapheadingskip |
---|
| 4130 | |
---|
| 4131 | \def\chapbreak{\dobreak \chapheadingskip {-4000}} |
---|
| 4132 | \def\chappager{\par\vfill\supereject} |
---|
| 4133 | \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} |
---|
| 4134 | |
---|
| 4135 | \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} |
---|
| 4136 | |
---|
| 4137 | \def\CHAPPAGoff{% |
---|
| 4138 | \global\let\contentsalignmacro = \chappager |
---|
| 4139 | \global\let\pchapsepmacro=\chapbreak |
---|
| 4140 | \global\let\pagealignmacro=\chappager} |
---|
| 4141 | |
---|
| 4142 | \def\CHAPPAGon{% |
---|
| 4143 | \global\let\contentsalignmacro = \chappager |
---|
| 4144 | \global\let\pchapsepmacro=\chappager |
---|
| 4145 | \global\let\pagealignmacro=\chappager |
---|
| 4146 | \global\def\HEADINGSon{\HEADINGSsingle}} |
---|
| 4147 | |
---|
[22253] | 4148 | \def\CHAPPAGodd{% |
---|
[15293] | 4149 | \global\let\contentsalignmacro = \chapoddpage |
---|
| 4150 | \global\let\pchapsepmacro=\chapoddpage |
---|
| 4151 | \global\let\pagealignmacro=\chapoddpage |
---|
| 4152 | \global\def\HEADINGSon{\HEADINGSdouble}} |
---|
| 4153 | |
---|
| 4154 | \CHAPPAGon |
---|
| 4155 | |
---|
[22253] | 4156 | % Chapter opening. |
---|
| 4157 | % |
---|
| 4158 | % #1 is the text, #2 is the section type (Ynumbered, Ynothing, |
---|
| 4159 | % Yappendix, Yomitfromtoc), #3 the chapter number. |
---|
| 4160 | % |
---|
| 4161 | % To test against our argument. |
---|
| 4162 | \def\Ynothingkeyword{Ynothing} |
---|
| 4163 | \def\Yomitfromtockeyword{Yomitfromtoc} |
---|
| 4164 | \def\Yappendixkeyword{Yappendix} |
---|
| 4165 | % |
---|
| 4166 | \def\chapmacro#1#2#3{% |
---|
[15293] | 4167 | \pchapsepmacro |
---|
| 4168 | {% |
---|
| 4169 | \chapfonts \rm |
---|
[22253] | 4170 | % |
---|
| 4171 | % Have to define \thissection before calling \donoderef, because the |
---|
| 4172 | % xref code eventually uses it. On the other hand, it has to be called |
---|
| 4173 | % after \pchapsepmacro, or the headline will change too soon. |
---|
| 4174 | \gdef\thissection{#1}% |
---|
| 4175 | \gdef\thischaptername{#1}% |
---|
| 4176 | % |
---|
| 4177 | % Only insert the separating space if we have a chapter/appendix |
---|
| 4178 | % number, and don't print the unnumbered ``number''. |
---|
| 4179 | \def\temptype{#2}% |
---|
| 4180 | \ifx\temptype\Ynothingkeyword |
---|
| 4181 | \setbox0 = \hbox{}% |
---|
| 4182 | \def\toctype{unnchap}% |
---|
| 4183 | \def\thischapter{#1}% |
---|
| 4184 | \else\ifx\temptype\Yomitfromtockeyword |
---|
| 4185 | \setbox0 = \hbox{}% contents like unnumbered, but no toc entry |
---|
| 4186 | \def\toctype{omit}% |
---|
| 4187 | \xdef\thischapter{}% |
---|
| 4188 | \else\ifx\temptype\Yappendixkeyword |
---|
| 4189 | \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% |
---|
| 4190 | \def\toctype{app}% |
---|
| 4191 | % We don't substitute the actual chapter name into \thischapter |
---|
| 4192 | % because we don't want its macros evaluated now. And we don't |
---|
| 4193 | % use \thissection because that changes with each section. |
---|
| 4194 | % |
---|
| 4195 | \xdef\thischapter{\putwordAppendix{} \appendixletter: |
---|
| 4196 | \noexpand\thischaptername}% |
---|
| 4197 | \else |
---|
| 4198 | \setbox0 = \hbox{#3\enspace}% |
---|
| 4199 | \def\toctype{numchap}% |
---|
| 4200 | \xdef\thischapter{\putwordChapter{} \the\chapno: |
---|
| 4201 | \noexpand\thischaptername}% |
---|
| 4202 | \fi\fi\fi |
---|
| 4203 | % |
---|
| 4204 | % Write the toc entry for this chapter. Must come before the |
---|
| 4205 | % \donoderef, because we include the current node name in the toc |
---|
| 4206 | % entry, and \donoderef resets it to empty. |
---|
| 4207 | \writetocentry{\toctype}{#1}{#3}% |
---|
| 4208 | % |
---|
| 4209 | % For pdftex, we have to write out the node definition (aka, make |
---|
| 4210 | % the pdfdest) after any page break, but before the actual text has |
---|
| 4211 | % been typeset. If the destination for the pdf outline is after the |
---|
| 4212 | % text, then jumping from the outline may wind up with the text not |
---|
| 4213 | % being visible, for instance under high magnification. |
---|
| 4214 | \donoderef{#2}% |
---|
| 4215 | % |
---|
| 4216 | % Typeset the actual heading. |
---|
[15293] | 4217 | \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright |
---|
[22253] | 4218 | \hangindent=\wd0 \centerparametersmaybe |
---|
[15293] | 4219 | \unhbox0 #1\par}% |
---|
| 4220 | }% |
---|
| 4221 | \nobreak\bigskip % no page break after a chapter title |
---|
| 4222 | \nobreak |
---|
| 4223 | } |
---|
| 4224 | |
---|
| 4225 | % @centerchap -- centered and unnumbered. |
---|
| 4226 | \let\centerparametersmaybe = \relax |
---|
[22253] | 4227 | \def\centerparameters{% |
---|
| 4228 | \advance\rightskip by 3\rightskip |
---|
| 4229 | \leftskip = \rightskip |
---|
| 4230 | \parfillskip = 0pt |
---|
| 4231 | } |
---|
[15293] | 4232 | |
---|
| 4233 | |
---|
[22253] | 4234 | % I don't think this chapter style is supported any more, so I'm not |
---|
| 4235 | % updating it with the new noderef stuff. We'll see. --karl, 11aug03. |
---|
| 4236 | % |
---|
| 4237 | \def\setchapterstyle #1 {\csname CHAPF#1\endcsname} |
---|
| 4238 | % |
---|
[15293] | 4239 | \def\unnchfopen #1{% |
---|
| 4240 | \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 |
---|
| 4241 | \parindent=0pt\raggedright |
---|
| 4242 | \rm #1\hfill}}\bigskip \par\nobreak |
---|
| 4243 | } |
---|
| 4244 | \def\chfopen #1#2{\chapoddpage {\chapfonts |
---|
| 4245 | \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% |
---|
| 4246 | \par\penalty 5000 % |
---|
| 4247 | } |
---|
| 4248 | \def\centerchfopen #1{% |
---|
| 4249 | \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 |
---|
| 4250 | \parindent=0pt |
---|
| 4251 | \hfill {\rm #1}\hfill}}\bigskip \par\nobreak |
---|
| 4252 | } |
---|
[22253] | 4253 | \def\CHAPFopen{% |
---|
| 4254 | \global\let\chapmacro=\chfopen |
---|
| 4255 | \global\let\centerchapmacro=\centerchfopen} |
---|
[15293] | 4256 | |
---|
| 4257 | |
---|
[22253] | 4258 | % Section titles. These macros combine the section number parts and |
---|
| 4259 | % call the generic \sectionheading to do the printing. |
---|
| 4260 | % |
---|
[15293] | 4261 | \newskip\secheadingskip |
---|
[22253] | 4262 | \def\secheadingbreak{\dobreak \secheadingskip{-1000}} |
---|
[15293] | 4263 | |
---|
| 4264 | % Subsection titles. |
---|
[22253] | 4265 | \newskip\subsecheadingskip |
---|
| 4266 | \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} |
---|
[15293] | 4267 | |
---|
| 4268 | % Subsubsection titles. |
---|
[22253] | 4269 | \def\subsubsecheadingskip{\subsecheadingskip} |
---|
| 4270 | \def\subsubsecheadingbreak{\subsecheadingbreak} |
---|
[15293] | 4271 | |
---|
| 4272 | |
---|
[22253] | 4273 | % Print any size, any type, section title. |
---|
| 4274 | % |
---|
| 4275 | % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is |
---|
| 4276 | % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the |
---|
| 4277 | % section number. |
---|
| 4278 | % |
---|
| 4279 | \def\sectionheading#1#2#3#4{% |
---|
[15293] | 4280 | {% |
---|
| 4281 | % Switch to the right set of fonts. |
---|
[22253] | 4282 | \csname #2fonts\endcsname \rm |
---|
[15293] | 4283 | % |
---|
[22253] | 4284 | % Insert space above the heading. |
---|
| 4285 | \csname #2headingbreak\endcsname |
---|
[15293] | 4286 | % |
---|
[22253] | 4287 | % Only insert the space after the number if we have a section number. |
---|
| 4288 | \def\sectionlevel{#2}% |
---|
| 4289 | \def\temptype{#3}% |
---|
| 4290 | % |
---|
| 4291 | \ifx\temptype\Ynothingkeyword |
---|
| 4292 | \setbox0 = \hbox{}% |
---|
| 4293 | \def\toctype{unn}% |
---|
| 4294 | \gdef\thissection{#1}% |
---|
| 4295 | \else\ifx\temptype\Yomitfromtockeyword |
---|
| 4296 | % for @headings -- no section number, don't include in toc, |
---|
| 4297 | % and don't redefine \thissection. |
---|
| 4298 | \setbox0 = \hbox{}% |
---|
| 4299 | \def\toctype{omit}% |
---|
| 4300 | \let\sectionlevel=\empty |
---|
| 4301 | \else\ifx\temptype\Yappendixkeyword |
---|
| 4302 | \setbox0 = \hbox{#4\enspace}% |
---|
| 4303 | \def\toctype{app}% |
---|
| 4304 | \gdef\thissection{#1}% |
---|
| 4305 | \else |
---|
| 4306 | \setbox0 = \hbox{#4\enspace}% |
---|
| 4307 | \def\toctype{num}% |
---|
| 4308 | \gdef\thissection{#1}% |
---|
| 4309 | \fi\fi\fi |
---|
| 4310 | % |
---|
| 4311 | % Write the toc entry (before \donoderef). See comments in \chfplain. |
---|
| 4312 | \writetocentry{\toctype\sectionlevel}{#1}{#4}% |
---|
| 4313 | % |
---|
| 4314 | % Write the node reference (= pdf destination for pdftex). |
---|
| 4315 | % Again, see comments in \chfplain. |
---|
| 4316 | \donoderef{#3}% |
---|
| 4317 | % |
---|
| 4318 | % Output the actual section heading. |
---|
[15293] | 4319 | \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright |
---|
[22253] | 4320 | \hangindent=\wd0 % zero if no section number |
---|
| 4321 | \unhbox0 #1}% |
---|
[15293] | 4322 | }% |
---|
[22253] | 4323 | % Add extra space after the heading -- half of whatever came above it. |
---|
| 4324 | % Don't allow stretch, though. |
---|
| 4325 | \kern .5 \csname #2headingskip\endcsname |
---|
| 4326 | % |
---|
| 4327 | % Do not let the kern be a potential breakpoint, as it would be if it |
---|
| 4328 | % was followed by glue. |
---|
| 4329 | \nobreak |
---|
| 4330 | % |
---|
| 4331 | % We'll almost certainly start a paragraph next, so don't let that |
---|
| 4332 | % glue accumulate. (Not a breakpoint because it's preceded by a |
---|
| 4333 | % discardable item.) |
---|
| 4334 | \vskip-\parskip |
---|
| 4335 | % |
---|
| 4336 | % This \nobreak is purely so the last item on the list is a \penalty |
---|
| 4337 | % of 10000. This is so other code, for instance \parsebodycommon, can |
---|
| 4338 | % check for and avoid allowing breakpoints. Otherwise, it would |
---|
| 4339 | % insert a valid breakpoint between: |
---|
| 4340 | % @section sec-whatever |
---|
| 4341 | % @deffn def-whatever |
---|
| 4342 | \nobreak |
---|
[15293] | 4343 | } |
---|
| 4344 | |
---|
| 4345 | |
---|
| 4346 | \message{toc,} |
---|
[18190] | 4347 | % Table of contents. |
---|
[15293] | 4348 | \newwrite\tocfile |
---|
| 4349 | |
---|
| 4350 | % Write an entry to the toc file, opening it if necessary. |
---|
[22253] | 4351 | % Called from @chapter, etc. |
---|
| 4352 | % |
---|
| 4353 | % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} |
---|
| 4354 | % We append the current node name (if any) and page number as additional |
---|
| 4355 | % arguments for the \{chap,sec,...}entry macros which will eventually |
---|
| 4356 | % read this. The node name is used in the pdf outlines as the |
---|
| 4357 | % destination to jump to. |
---|
| 4358 | % |
---|
| 4359 | % We open the .toc file for writing here instead of at @setfilename (or |
---|
| 4360 | % any other fixed time) so that @contents can be anywhere in the document. |
---|
| 4361 | % But if #1 is `omit', then we don't do anything. This is used for the |
---|
| 4362 | % table of contents chapter openings themselves. |
---|
[15293] | 4363 | % |
---|
[22253] | 4364 | \newif\iftocfileopened |
---|
| 4365 | \def\omitkeyword{omit}% |
---|
[15293] | 4366 | % |
---|
[22253] | 4367 | \def\writetocentry#1#2#3{% |
---|
| 4368 | \edef\writetoctype{#1}% |
---|
| 4369 | \ifx\writetoctype\omitkeyword \else |
---|
| 4370 | \iftocfileopened\else |
---|
| 4371 | \immediate\openout\tocfile = \jobname.toc |
---|
| 4372 | \global\tocfileopenedtrue |
---|
| 4373 | \fi |
---|
| 4374 | % |
---|
| 4375 | \iflinks |
---|
| 4376 | \toks0 = {#2}% |
---|
| 4377 | \toks2 = \expandafter{\lastnode}% |
---|
| 4378 | \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}% |
---|
| 4379 | {\the\toks2}{\noexpand\folio}}}% |
---|
| 4380 | \temp |
---|
| 4381 | \fi |
---|
[15293] | 4382 | \fi |
---|
[18190] | 4383 | % |
---|
[22253] | 4384 | % Tell \shipout to create a pdf destination on each page, if we're |
---|
| 4385 | % writing pdf. These are used in the table of contents. We can't |
---|
| 4386 | % just write one on every page because the title pages are numbered |
---|
| 4387 | % 1 and 2 (the page numbers aren't printed), and so are the first |
---|
| 4388 | % two pages of the document. Thus, we'd have two destinations named |
---|
| 4389 | % `1', and two named `2'. |
---|
| 4390 | \ifpdf \global\pdfmakepagedesttrue \fi |
---|
[15293] | 4391 | } |
---|
| 4392 | |
---|
| 4393 | \newskip\contentsrightmargin \contentsrightmargin=1in |
---|
| 4394 | \newcount\savepageno |
---|
| 4395 | \newcount\lastnegativepageno \lastnegativepageno = -1 |
---|
| 4396 | |
---|
[22253] | 4397 | % Prepare to read what we've written to \tocfile. |
---|
[15293] | 4398 | % |
---|
| 4399 | \def\startcontents#1{% |
---|
[22253] | 4400 | % If @setchapternewpage on, and @headings double, the contents should |
---|
| 4401 | % start on an odd page, unlike chapters. Thus, we maintain |
---|
| 4402 | % \contentsalignmacro in parallel with \pagealignmacro. |
---|
| 4403 | % From: Torbjorn Granlund <tege@matematik.su.se> |
---|
| 4404 | \contentsalignmacro |
---|
| 4405 | \immediate\closeout\tocfile |
---|
| 4406 | % |
---|
| 4407 | % Don't need to put `Contents' or `Short Contents' in the headline. |
---|
| 4408 | % It is abundantly clear what they are. |
---|
| 4409 | \def\thischapter{}% |
---|
| 4410 | \chapmacro{#1}{Yomitfromtoc}{}% |
---|
| 4411 | % |
---|
| 4412 | \savepageno = \pageno |
---|
| 4413 | \begingroup % Set up to handle contents files properly. |
---|
| 4414 | \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11 |
---|
| 4415 | % We can't do this, because then an actual ^ in a section |
---|
| 4416 | % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97. |
---|
| 4417 | %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi |
---|
| 4418 | \raggedbottom % Worry more about breakpoints than the bottom. |
---|
| 4419 | \advance\hsize by -\contentsrightmargin % Don't use the full line length. |
---|
| 4420 | % |
---|
| 4421 | % Roman numerals for page numbers. |
---|
| 4422 | \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi |
---|
[15293] | 4423 | } |
---|
| 4424 | |
---|
| 4425 | |
---|
| 4426 | % Normal (long) toc. |
---|
| 4427 | \def\contents{% |
---|
[22253] | 4428 | \startcontents{\putwordTOC}% |
---|
| 4429 | \openin 1 \jobname.toc |
---|
| 4430 | \ifeof 1 \else |
---|
| 4431 | \input \jobname.toc |
---|
| 4432 | \fi |
---|
| 4433 | \vfill \eject |
---|
| 4434 | \contentsalignmacro % in case @setchapternewpage odd is in effect |
---|
| 4435 | \ifeof 1 \else |
---|
| 4436 | \pdfmakeoutlines |
---|
| 4437 | \fi |
---|
| 4438 | \closein 1 |
---|
| 4439 | \endgroup |
---|
| 4440 | \lastnegativepageno = \pageno |
---|
| 4441 | \global\pageno = \savepageno |
---|
[15293] | 4442 | } |
---|
| 4443 | |
---|
| 4444 | % And just the chapters. |
---|
| 4445 | \def\summarycontents{% |
---|
[22253] | 4446 | \startcontents{\putwordShortTOC}% |
---|
| 4447 | % |
---|
| 4448 | \let\numchapentry = \shortchapentry |
---|
| 4449 | \let\appentry = \shortchapentry |
---|
| 4450 | \let\unnchapentry = \shortunnchapentry |
---|
| 4451 | % We want a true roman here for the page numbers. |
---|
| 4452 | \secfonts |
---|
| 4453 | \let\rm=\shortcontrm \let\bf=\shortcontbf |
---|
| 4454 | \let\sl=\shortcontsl \let\tt=\shortconttt |
---|
| 4455 | \rm |
---|
| 4456 | \hyphenpenalty = 10000 |
---|
| 4457 | \advance\baselineskip by 1pt % Open it up a little. |
---|
| 4458 | \def\numsecentry##1##2##3##4{} |
---|
| 4459 | \let\appsecentry = \numsecentry |
---|
| 4460 | \let\unnsecentry = \numsecentry |
---|
| 4461 | \let\numsubsecentry = \numsecentry |
---|
| 4462 | \let\appsubsecentry = \numsecentry |
---|
| 4463 | \let\unnsubsecentry = \numsecentry |
---|
| 4464 | \let\numsubsubsecentry = \numsecentry |
---|
| 4465 | \let\appsubsubsecentry = \numsecentry |
---|
| 4466 | \let\unnsubsubsecentry = \numsecentry |
---|
| 4467 | \openin 1 \jobname.toc |
---|
| 4468 | \ifeof 1 \else |
---|
| 4469 | \input \jobname.toc |
---|
| 4470 | \fi |
---|
| 4471 | \closein 1 |
---|
| 4472 | \vfill \eject |
---|
| 4473 | \contentsalignmacro % in case @setchapternewpage odd is in effect |
---|
| 4474 | \endgroup |
---|
| 4475 | \lastnegativepageno = \pageno |
---|
| 4476 | \global\pageno = \savepageno |
---|
[15293] | 4477 | } |
---|
| 4478 | \let\shortcontents = \summarycontents |
---|
| 4479 | |
---|
[22253] | 4480 | % Typeset the label for a chapter or appendix for the short contents. |
---|
| 4481 | % The arg is, e.g., `A' for an appendix, or `3' for a chapter. |
---|
| 4482 | % |
---|
| 4483 | \def\shortchaplabel#1{% |
---|
| 4484 | % This space should be enough, since a single number is .5em, and the |
---|
| 4485 | % widest letter (M) is 1em, at least in the Computer Modern fonts. |
---|
| 4486 | % But use \hss just in case. |
---|
| 4487 | % (This space doesn't include the extra space that gets added after |
---|
| 4488 | % the label; that gets put in by \shortchapentry above.) |
---|
| 4489 | % |
---|
| 4490 | % We'd like to right-justify chapter numbers, but that looks strange |
---|
| 4491 | % with appendix letters. And right-justifying numbers and |
---|
| 4492 | % left-justifying letters looks strange when there is less than 10 |
---|
| 4493 | % chapters. Have to read the whole toc once to know how many chapters |
---|
| 4494 | % there are before deciding ... |
---|
| 4495 | \hbox to 1em{#1\hss}% |
---|
| 4496 | } |
---|
[18190] | 4497 | |
---|
[15293] | 4498 | % These macros generate individual entries in the table of contents. |
---|
| 4499 | % The first argument is the chapter or section name. |
---|
| 4500 | % The last argument is the page number. |
---|
| 4501 | % The arguments in between are the chapter number, section number, ... |
---|
| 4502 | |
---|
[18190] | 4503 | % Chapters, in the main contents. |
---|
[22253] | 4504 | \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} |
---|
[18190] | 4505 | % |
---|
| 4506 | % Chapters, in the short toc. |
---|
| 4507 | % See comments in \dochapentry re vbox and related settings. |
---|
[22253] | 4508 | \def\shortchapentry#1#2#3#4{% |
---|
| 4509 | \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% |
---|
[15293] | 4510 | } |
---|
| 4511 | |
---|
[18190] | 4512 | % Appendices, in the main contents. |
---|
[22253] | 4513 | % Need the word Appendix, and a fixed-size box. |
---|
| 4514 | % |
---|
| 4515 | \def\appendixbox#1{% |
---|
| 4516 | % We use M since it's probably the widest letter. |
---|
| 4517 | \setbox0 = \hbox{\putwordAppendix{} M}% |
---|
| 4518 | \hbox to \wd0{\putwordAppendix{} #1\hss}} |
---|
[18190] | 4519 | % |
---|
[22253] | 4520 | \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} |
---|
[18190] | 4521 | |
---|
| 4522 | % Unnumbered chapters. |
---|
[22253] | 4523 | \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} |
---|
| 4524 | \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} |
---|
[15293] | 4525 | |
---|
| 4526 | % Sections. |
---|
[22253] | 4527 | \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} |
---|
| 4528 | \let\appsecentry=\numsecentry |
---|
| 4529 | \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} |
---|
[15293] | 4530 | |
---|
| 4531 | % Subsections. |
---|
[22253] | 4532 | \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} |
---|
| 4533 | \let\appsubsecentry=\numsubsecentry |
---|
| 4534 | \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} |
---|
[15293] | 4535 | |
---|
| 4536 | % And subsubsections. |
---|
[22253] | 4537 | \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} |
---|
| 4538 | \let\appsubsubsecentry=\numsubsubsecentry |
---|
| 4539 | \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} |
---|
[15293] | 4540 | |
---|
| 4541 | % This parameter controls the indentation of the various levels. |
---|
[22253] | 4542 | % Same as \defaultparindent. |
---|
| 4543 | \newdimen\tocindent \tocindent = 15pt |
---|
[15293] | 4544 | |
---|
| 4545 | % Now for the actual typesetting. In all these, #1 is the text and #2 is the |
---|
| 4546 | % page number. |
---|
| 4547 | % |
---|
| 4548 | % If the toc has to be broken over pages, we want it to be at chapters |
---|
| 4549 | % if at all possible; hence the \penalty. |
---|
| 4550 | \def\dochapentry#1#2{% |
---|
| 4551 | \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip |
---|
| 4552 | \begingroup |
---|
| 4553 | \chapentryfonts |
---|
[18190] | 4554 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% |
---|
[15293] | 4555 | \endgroup |
---|
| 4556 | \nobreak\vskip .25\baselineskip plus.1\baselineskip |
---|
| 4557 | } |
---|
| 4558 | |
---|
| 4559 | \def\dosecentry#1#2{\begingroup |
---|
| 4560 | \secentryfonts \leftskip=\tocindent |
---|
[18190] | 4561 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% |
---|
[15293] | 4562 | \endgroup} |
---|
| 4563 | |
---|
| 4564 | \def\dosubsecentry#1#2{\begingroup |
---|
| 4565 | \subsecentryfonts \leftskip=2\tocindent |
---|
[18190] | 4566 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% |
---|
[15293] | 4567 | \endgroup} |
---|
| 4568 | |
---|
| 4569 | \def\dosubsubsecentry#1#2{\begingroup |
---|
| 4570 | \subsubsecentryfonts \leftskip=3\tocindent |
---|
[18190] | 4571 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% |
---|
[15293] | 4572 | \endgroup} |
---|
| 4573 | |
---|
[22253] | 4574 | % We use the same \entry macro as for the index entries. |
---|
| 4575 | \let\tocentry = \entry |
---|
[15293] | 4576 | |
---|
| 4577 | % Space between chapter (or whatever) number and the title. |
---|
| 4578 | \def\labelspace{\hskip1em \relax} |
---|
| 4579 | |
---|
| 4580 | \def\dopageno#1{{\rm #1}} |
---|
| 4581 | \def\doshortpageno#1{{\rm #1}} |
---|
| 4582 | |
---|
| 4583 | \def\chapentryfonts{\secfonts \rm} |
---|
| 4584 | \def\secentryfonts{\textfonts} |
---|
[22253] | 4585 | \def\subsecentryfonts{\textfonts} |
---|
| 4586 | \def\subsubsecentryfonts{\textfonts} |
---|
[15293] | 4587 | |
---|
| 4588 | |
---|
| 4589 | \message{environments,} |
---|
[18190] | 4590 | % @foo ... @end foo. |
---|
[15293] | 4591 | |
---|
[18190] | 4592 | % @point{}, @result{}, @expansion{}, @print{}, @equiv{}. |
---|
[22253] | 4593 | % |
---|
[15293] | 4594 | % Since these characters are used in examples, it should be an even number of |
---|
| 4595 | % \tt widths. Each \tt character is 1en, so two makes it 1em. |
---|
[18190] | 4596 | % |
---|
[15293] | 4597 | \def\point{$\star$} |
---|
| 4598 | \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} |
---|
| 4599 | \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} |
---|
| 4600 | \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} |
---|
| 4601 | \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} |
---|
| 4602 | |
---|
[18190] | 4603 | % The @error{} command. |
---|
[15293] | 4604 | % Adapted from the TeXbook's \boxit. |
---|
[22253] | 4605 | % |
---|
[18190] | 4606 | \newbox\errorbox |
---|
| 4607 | % |
---|
[15293] | 4608 | {\tentt \global\dimen0 = 3em}% Width of the box. |
---|
| 4609 | \dimen2 = .55pt % Thickness of rules |
---|
| 4610 | % The text. (`r' is open on the right, `e' somewhat less so on the left.) |
---|
| 4611 | \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} |
---|
[18190] | 4612 | % |
---|
[22253] | 4613 | \setbox\errorbox=\hbox to \dimen0{\hfil |
---|
[15293] | 4614 | \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. |
---|
| 4615 | \advance\hsize by -2\dimen2 % Rules. |
---|
[22253] | 4616 | \vbox{% |
---|
[15293] | 4617 | \hrule height\dimen2 |
---|
| 4618 | \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. |
---|
| 4619 | \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. |
---|
| 4620 | \kern3pt\vrule width\dimen2}% Space to right. |
---|
| 4621 | \hrule height\dimen2} |
---|
| 4622 | \hfil} |
---|
[18190] | 4623 | % |
---|
[15293] | 4624 | \def\error{\leavevmode\lower.7ex\copy\errorbox} |
---|
| 4625 | |
---|
| 4626 | % @tex ... @end tex escapes into raw Tex temporarily. |
---|
| 4627 | % One exception: @ is still an escape character, so that @end tex works. |
---|
| 4628 | % But \@ or @@ will get a plain tex @ character. |
---|
| 4629 | |
---|
[22253] | 4630 | \envdef\tex{% |
---|
[15293] | 4631 | \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 |
---|
| 4632 | \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 |
---|
[22253] | 4633 | \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie |
---|
[15293] | 4634 | \catcode `\%=14 |
---|
[22253] | 4635 | \catcode `\+=\other |
---|
| 4636 | \catcode `\"=\other |
---|
| 4637 | \catcode `\|=\other |
---|
| 4638 | \catcode `\<=\other |
---|
| 4639 | \catcode `\>=\other |
---|
[15293] | 4640 | \escapechar=`\\ |
---|
| 4641 | % |
---|
| 4642 | \let\b=\ptexb |
---|
| 4643 | \let\bullet=\ptexbullet |
---|
| 4644 | \let\c=\ptexc |
---|
| 4645 | \let\,=\ptexcomma |
---|
| 4646 | \let\.=\ptexdot |
---|
| 4647 | \let\dots=\ptexdots |
---|
| 4648 | \let\equiv=\ptexequiv |
---|
| 4649 | \let\!=\ptexexclam |
---|
| 4650 | \let\i=\ptexi |
---|
[22253] |
---|