annotate src/fftw-3.3.3/doc/texinfo.tex @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 37bf6b4a2645
children
rev   line source
Chris@10 1 % texinfo.tex -- TeX macros to handle Texinfo files.
Chris@10 2 %
Chris@10 3 % Load plain if necessary, i.e., if running under initex.
Chris@10 4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
Chris@10 5 %
Chris@10 6 \def\texinfoversion{2012-03-11.15}
Chris@10 7 %
Chris@10 8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
Chris@10 9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
Chris@10 10 % 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
Chris@10 11 %
Chris@10 12 % This texinfo.tex file is free software: you can redistribute it and/or
Chris@10 13 % modify it under the terms of the GNU General Public License as
Chris@10 14 % published by the Free Software Foundation, either version 3 of the
Chris@10 15 % License, or (at your option) any later version.
Chris@10 16 %
Chris@10 17 % This texinfo.tex file is distributed in the hope that it will be
Chris@10 18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
Chris@10 19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Chris@10 20 % General Public License for more details.
Chris@10 21 %
Chris@10 22 % You should have received a copy of the GNU General Public License
Chris@10 23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
Chris@10 24 %
Chris@10 25 % As a special exception, when this file is read by TeX when processing
Chris@10 26 % a Texinfo source document, you may use the result without
Chris@10 27 % restriction. (This has been our intent since Texinfo was invented.)
Chris@10 28 %
Chris@10 29 % Please try the latest version of texinfo.tex before submitting bug
Chris@10 30 % reports; you can get the latest version from:
Chris@10 31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
Chris@10 32 % ftp://tug.org/tex/texinfo.tex
Chris@10 33 % (and all CTAN mirrors, see http://www.ctan.org).
Chris@10 34 % The texinfo.tex in any given distribution could well be out
Chris@10 35 % of date, so if that's what you're using, please check.
Chris@10 36 %
Chris@10 37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
Chris@10 38 % complete document in each bug report with which we can reproduce the
Chris@10 39 % problem. Patches are, of course, greatly appreciated.
Chris@10 40 %
Chris@10 41 % To process a Texinfo manual with TeX, it's most reliable to use the
Chris@10 42 % texi2dvi shell script that comes with the distribution. For a simple
Chris@10 43 % manual foo.texi, however, you can get away with this:
Chris@10 44 % tex foo.texi
Chris@10 45 % texindex foo.??
Chris@10 46 % tex foo.texi
Chris@10 47 % tex foo.texi
Chris@10 48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
Chris@10 49 % The extra TeX runs get the cross-reference information correct.
Chris@10 50 % Sometimes one run after texindex suffices, and sometimes you need more
Chris@10 51 % than two; texi2dvi does it as many times as necessary.
Chris@10 52 %
Chris@10 53 % It is possible to adapt texinfo.tex for other languages, to some
Chris@10 54 % extent. You can get the existing language-specific files from the
Chris@10 55 % full Texinfo distribution.
Chris@10 56 %
Chris@10 57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
Chris@10 58
Chris@10 59
Chris@10 60 \message{Loading texinfo [version \texinfoversion]:}
Chris@10 61
Chris@10 62 % If in a .fmt file, print the version number
Chris@10 63 % and turn on active characters that we couldn't do earlier because
Chris@10 64 % they might have appeared in the input file name.
Chris@10 65 \everyjob{\message{[Texinfo version \texinfoversion]}%
Chris@10 66 \catcode`+=\active \catcode`\_=\active}
Chris@10 67
Chris@10 68 \chardef\other=12
Chris@10 69
Chris@10 70 % We never want plain's \outer definition of \+ in Texinfo.
Chris@10 71 % For @tex, we can use \tabalign.
Chris@10 72 \let\+ = \relax
Chris@10 73
Chris@10 74 % Save some plain tex macros whose names we will redefine.
Chris@10 75 \let\ptexb=\b
Chris@10 76 \let\ptexbullet=\bullet
Chris@10 77 \let\ptexc=\c
Chris@10 78 \let\ptexcomma=\,
Chris@10 79 \let\ptexdot=\.
Chris@10 80 \let\ptexdots=\dots
Chris@10 81 \let\ptexend=\end
Chris@10 82 \let\ptexequiv=\equiv
Chris@10 83 \let\ptexexclam=\!
Chris@10 84 \let\ptexfootnote=\footnote
Chris@10 85 \let\ptexgtr=>
Chris@10 86 \let\ptexhat=^
Chris@10 87 \let\ptexi=\i
Chris@10 88 \let\ptexindent=\indent
Chris@10 89 \let\ptexinsert=\insert
Chris@10 90 \let\ptexlbrace=\{
Chris@10 91 \let\ptexless=<
Chris@10 92 \let\ptexnewwrite\newwrite
Chris@10 93 \let\ptexnoindent=\noindent
Chris@10 94 \let\ptexplus=+
Chris@10 95 \let\ptexraggedright=\raggedright
Chris@10 96 \let\ptexrbrace=\}
Chris@10 97 \let\ptexslash=\/
Chris@10 98 \let\ptexstar=\*
Chris@10 99 \let\ptext=\t
Chris@10 100 \let\ptextop=\top
Chris@10 101 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
Chris@10 102
Chris@10 103 % If this character appears in an error message or help string, it
Chris@10 104 % starts a new line in the output.
Chris@10 105 \newlinechar = `^^J
Chris@10 106
Chris@10 107 % Use TeX 3.0's \inputlineno to get the line number, for better error
Chris@10 108 % messages, but if we're using an old version of TeX, don't do anything.
Chris@10 109 %
Chris@10 110 \ifx\inputlineno\thisisundefined
Chris@10 111 \let\linenumber = \empty % Pre-3.0.
Chris@10 112 \else
Chris@10 113 \def\linenumber{l.\the\inputlineno:\space}
Chris@10 114 \fi
Chris@10 115
Chris@10 116 % Set up fixed words for English if not already set.
Chris@10 117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
Chris@10 118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
Chris@10 119 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
Chris@10 120 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
Chris@10 121 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
Chris@10 122 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
Chris@10 123 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
Chris@10 124 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
Chris@10 125 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
Chris@10 126 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
Chris@10 127 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
Chris@10 128 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
Chris@10 129 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
Chris@10 130 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
Chris@10 131 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
Chris@10 132 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
Chris@10 133 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
Chris@10 134 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
Chris@10 135 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
Chris@10 136 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
Chris@10 137 %
Chris@10 138 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
Chris@10 139 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
Chris@10 140 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
Chris@10 141 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
Chris@10 142 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
Chris@10 143 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
Chris@10 144 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
Chris@10 145 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
Chris@10 146 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
Chris@10 147 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
Chris@10 148 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
Chris@10 149 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
Chris@10 150 %
Chris@10 151 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
Chris@10 152 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
Chris@10 153 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
Chris@10 154 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
Chris@10 155 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
Chris@10 156
Chris@10 157 % Since the category of space is not known, we have to be careful.
Chris@10 158 \chardef\spacecat = 10
Chris@10 159 \def\spaceisspace{\catcode`\ =\spacecat}
Chris@10 160
Chris@10 161 % sometimes characters are active, so we need control sequences.
Chris@10 162 \chardef\ampChar = `\&
Chris@10 163 \chardef\colonChar = `\:
Chris@10 164 \chardef\commaChar = `\,
Chris@10 165 \chardef\dashChar = `\-
Chris@10 166 \chardef\dotChar = `\.
Chris@10 167 \chardef\exclamChar= `\!
Chris@10 168 \chardef\hashChar = `\#
Chris@10 169 \chardef\lquoteChar= `\`
Chris@10 170 \chardef\questChar = `\?
Chris@10 171 \chardef\rquoteChar= `\'
Chris@10 172 \chardef\semiChar = `\;
Chris@10 173 \chardef\slashChar = `\/
Chris@10 174 \chardef\underChar = `\_
Chris@10 175
Chris@10 176 % Ignore a token.
Chris@10 177 %
Chris@10 178 \def\gobble#1{}
Chris@10 179
Chris@10 180 % The following is used inside several \edef's.
Chris@10 181 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
Chris@10 182
Chris@10 183 % Hyphenation fixes.
Chris@10 184 \hyphenation{
Chris@10 185 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
Chris@10 186 ap-pen-dix bit-map bit-maps
Chris@10 187 data-base data-bases eshell fall-ing half-way long-est man-u-script
Chris@10 188 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
Chris@10 189 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
Chris@10 190 spell-ing spell-ings
Chris@10 191 stand-alone strong-est time-stamp time-stamps which-ever white-space
Chris@10 192 wide-spread wrap-around
Chris@10 193 }
Chris@10 194
Chris@10 195 % Margin to add to right of even pages, to left of odd pages.
Chris@10 196 \newdimen\bindingoffset
Chris@10 197 \newdimen\normaloffset
Chris@10 198 \newdimen\pagewidth \newdimen\pageheight
Chris@10 199
Chris@10 200 % For a final copy, take out the rectangles
Chris@10 201 % that mark overfull boxes (in case you have decided
Chris@10 202 % that the text looks ok even though it passes the margin).
Chris@10 203 %
Chris@10 204 \def\finalout{\overfullrule=0pt }
Chris@10 205
Chris@10 206 % Sometimes it is convenient to have everything in the transcript file
Chris@10 207 % and nothing on the terminal. We don't just call \tracingall here,
Chris@10 208 % since that produces some useless output on the terminal. We also make
Chris@10 209 % some effort to order the tracing commands to reduce output in the log
Chris@10 210 % file; cf. trace.sty in LaTeX.
Chris@10 211 %
Chris@10 212 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
Chris@10 213 \def\loggingall{%
Chris@10 214 \tracingstats2
Chris@10 215 \tracingpages1
Chris@10 216 \tracinglostchars2 % 2 gives us more in etex
Chris@10 217 \tracingparagraphs1
Chris@10 218 \tracingoutput1
Chris@10 219 \tracingmacros2
Chris@10 220 \tracingrestores1
Chris@10 221 \showboxbreadth\maxdimen \showboxdepth\maxdimen
Chris@10 222 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
Chris@10 223 \tracingscantokens1
Chris@10 224 \tracingifs1
Chris@10 225 \tracinggroups1
Chris@10 226 \tracingnesting2
Chris@10 227 \tracingassigns1
Chris@10 228 \fi
Chris@10 229 \tracingcommands3 % 3 gives us more in etex
Chris@10 230 \errorcontextlines16
Chris@10 231 }%
Chris@10 232
Chris@10 233 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
Chris@10 234 % aren't perfect, it's not the end of the world, being an error message,
Chris@10 235 % after all.
Chris@10 236 %
Chris@10 237 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
Chris@10 238 \def\doerrormsg#1{\errmessage{#1}}
Chris@10 239
Chris@10 240 % add check for \lastpenalty to plain's definitions. If the last thing
Chris@10 241 % we did was a \nobreak, we don't want to insert more space.
Chris@10 242 %
Chris@10 243 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
Chris@10 244 \removelastskip\penalty-50\smallskip\fi\fi}
Chris@10 245 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
Chris@10 246 \removelastskip\penalty-100\medskip\fi\fi}
Chris@10 247 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
Chris@10 248 \removelastskip\penalty-200\bigskip\fi\fi}
Chris@10 249
Chris@10 250 % Do @cropmarks to get crop marks.
Chris@10 251 %
Chris@10 252 \newif\ifcropmarks
Chris@10 253 \let\cropmarks = \cropmarkstrue
Chris@10 254 %
Chris@10 255 % Dimensions to add cropmarks at corners.
Chris@10 256 % Added by P. A. MacKay, 12 Nov. 1986
Chris@10 257 %
Chris@10 258 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
Chris@10 259 \newdimen\cornerlong \cornerlong=1pc
Chris@10 260 \newdimen\cornerthick \cornerthick=.3pt
Chris@10 261 \newdimen\topandbottommargin \topandbottommargin=.75in
Chris@10 262
Chris@10 263 % Output a mark which sets \thischapter, \thissection and \thiscolor.
Chris@10 264 % We dump everything together because we only have one kind of mark.
Chris@10 265 % This works because we only use \botmark / \topmark, not \firstmark.
Chris@10 266 %
Chris@10 267 % A mark contains a subexpression of the \ifcase ... \fi construct.
Chris@10 268 % \get*marks macros below extract the needed part using \ifcase.
Chris@10 269 %
Chris@10 270 % Another complication is to let the user choose whether \thischapter
Chris@10 271 % (\thissection) refers to the chapter (section) in effect at the top
Chris@10 272 % of a page, or that at the bottom of a page. The solution is
Chris@10 273 % described on page 260 of The TeXbook. It involves outputting two
Chris@10 274 % marks for the sectioning macros, one before the section break, and
Chris@10 275 % one after. I won't pretend I can describe this better than DEK...
Chris@10 276 \def\domark{%
Chris@10 277 \toks0=\expandafter{\lastchapterdefs}%
Chris@10 278 \toks2=\expandafter{\lastsectiondefs}%
Chris@10 279 \toks4=\expandafter{\prevchapterdefs}%
Chris@10 280 \toks6=\expandafter{\prevsectiondefs}%
Chris@10 281 \toks8=\expandafter{\lastcolordefs}%
Chris@10 282 \mark{%
Chris@10 283 \the\toks0 \the\toks2
Chris@10 284 \noexpand\or \the\toks4 \the\toks6
Chris@10 285 \noexpand\else \the\toks8
Chris@10 286 }%
Chris@10 287 }
Chris@10 288 % \topmark doesn't work for the very first chapter (after the title
Chris@10 289 % page or the contents), so we use \firstmark there -- this gets us
Chris@10 290 % the mark with the chapter defs, unless the user sneaks in, e.g.,
Chris@10 291 % @setcolor (or @url, or @link, etc.) between @contents and the very
Chris@10 292 % first @chapter.
Chris@10 293 \def\gettopheadingmarks{%
Chris@10 294 \ifcase0\topmark\fi
Chris@10 295 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
Chris@10 296 }
Chris@10 297 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
Chris@10 298 \def\getcolormarks{\ifcase2\topmark\fi}
Chris@10 299
Chris@10 300 % Avoid "undefined control sequence" errors.
Chris@10 301 \def\lastchapterdefs{}
Chris@10 302 \def\lastsectiondefs{}
Chris@10 303 \def\prevchapterdefs{}
Chris@10 304 \def\prevsectiondefs{}
Chris@10 305 \def\lastcolordefs{}
Chris@10 306
Chris@10 307 % Main output routine.
Chris@10 308 \chardef\PAGE = 255
Chris@10 309 \output = {\onepageout{\pagecontents\PAGE}}
Chris@10 310
Chris@10 311 \newbox\headlinebox
Chris@10 312 \newbox\footlinebox
Chris@10 313
Chris@10 314 % \onepageout takes a vbox as an argument. Note that \pagecontents
Chris@10 315 % does insertions, but you have to call it yourself.
Chris@10 316 \def\onepageout#1{%
Chris@10 317 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
Chris@10 318 %
Chris@10 319 \ifodd\pageno \advance\hoffset by \bindingoffset
Chris@10 320 \else \advance\hoffset by -\bindingoffset\fi
Chris@10 321 %
Chris@10 322 % Do this outside of the \shipout so @code etc. will be expanded in
Chris@10 323 % the headline as they should be, not taken literally (outputting ''code).
Chris@10 324 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
Chris@10 325 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
Chris@10 326 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
Chris@10 327 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
Chris@10 328 %
Chris@10 329 {%
Chris@10 330 % Have to do this stuff outside the \shipout because we want it to
Chris@10 331 % take effect in \write's, yet the group defined by the \vbox ends
Chris@10 332 % before the \shipout runs.
Chris@10 333 %
Chris@10 334 \indexdummies % don't expand commands in the output.
Chris@10 335 \normalturnoffactive % \ in index entries must not stay \, e.g., if
Chris@10 336 % the page break happens to be in the middle of an example.
Chris@10 337 % We don't want .vr (or whatever) entries like this:
Chris@10 338 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
Chris@10 339 % "\acronym" won't work when it's read back in;
Chris@10 340 % it needs to be
Chris@10 341 % {\code {{\tt \backslashcurfont }acronym}
Chris@10 342 \shipout\vbox{%
Chris@10 343 % Do this early so pdf references go to the beginning of the page.
Chris@10 344 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
Chris@10 345 %
Chris@10 346 \ifcropmarks \vbox to \outervsize\bgroup
Chris@10 347 \hsize = \outerhsize
Chris@10 348 \vskip-\topandbottommargin
Chris@10 349 \vtop to0pt{%
Chris@10 350 \line{\ewtop\hfil\ewtop}%
Chris@10 351 \nointerlineskip
Chris@10 352 \line{%
Chris@10 353 \vbox{\moveleft\cornerthick\nstop}%
Chris@10 354 \hfill
Chris@10 355 \vbox{\moveright\cornerthick\nstop}%
Chris@10 356 }%
Chris@10 357 \vss}%
Chris@10 358 \vskip\topandbottommargin
Chris@10 359 \line\bgroup
Chris@10 360 \hfil % center the page within the outer (page) hsize.
Chris@10 361 \ifodd\pageno\hskip\bindingoffset\fi
Chris@10 362 \vbox\bgroup
Chris@10 363 \fi
Chris@10 364 %
Chris@10 365 \unvbox\headlinebox
Chris@10 366 \pagebody{#1}%
Chris@10 367 \ifdim\ht\footlinebox > 0pt
Chris@10 368 % Only leave this space if the footline is nonempty.
Chris@10 369 % (We lessened \vsize for it in \oddfootingyyy.)
Chris@10 370 % The \baselineskip=24pt in plain's \makefootline has no effect.
Chris@10 371 \vskip 24pt
Chris@10 372 \unvbox\footlinebox
Chris@10 373 \fi
Chris@10 374 %
Chris@10 375 \ifcropmarks
Chris@10 376 \egroup % end of \vbox\bgroup
Chris@10 377 \hfil\egroup % end of (centering) \line\bgroup
Chris@10 378 \vskip\topandbottommargin plus1fill minus1fill
Chris@10 379 \boxmaxdepth = \cornerthick
Chris@10 380 \vbox to0pt{\vss
Chris@10 381 \line{%
Chris@10 382 \vbox{\moveleft\cornerthick\nsbot}%
Chris@10 383 \hfill
Chris@10 384 \vbox{\moveright\cornerthick\nsbot}%
Chris@10 385 }%
Chris@10 386 \nointerlineskip
Chris@10 387 \line{\ewbot\hfil\ewbot}%
Chris@10 388 }%
Chris@10 389 \egroup % \vbox from first cropmarks clause
Chris@10 390 \fi
Chris@10 391 }% end of \shipout\vbox
Chris@10 392 }% end of group with \indexdummies
Chris@10 393 \advancepageno
Chris@10 394 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
Chris@10 395 }
Chris@10 396
Chris@10 397 \newinsert\margin \dimen\margin=\maxdimen
Chris@10 398
Chris@10 399 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
Chris@10 400 {\catcode`\@ =11
Chris@10 401 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
Chris@10 402 % marginal hacks, juha@viisa.uucp (Juha Takala)
Chris@10 403 \ifvoid\margin\else % marginal info is present
Chris@10 404 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
Chris@10 405 \dimen@=\dp#1\relax \unvbox#1\relax
Chris@10 406 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
Chris@10 407 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
Chris@10 408 }
Chris@10 409
Chris@10 410 % Here are the rules for the cropmarks. Note that they are
Chris@10 411 % offset so that the space between them is truly \outerhsize or \outervsize
Chris@10 412 % (P. A. MacKay, 12 November, 1986)
Chris@10 413 %
Chris@10 414 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
Chris@10 415 \def\nstop{\vbox
Chris@10 416 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
Chris@10 417 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
Chris@10 418 \def\nsbot{\vbox
Chris@10 419 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
Chris@10 420
Chris@10 421 % Parse an argument, then pass it to #1. The argument is the rest of
Chris@10 422 % the input line (except we remove a trailing comment). #1 should be a
Chris@10 423 % macro which expects an ordinary undelimited TeX argument.
Chris@10 424 %
Chris@10 425 \def\parsearg{\parseargusing{}}
Chris@10 426 \def\parseargusing#1#2{%
Chris@10 427 \def\argtorun{#2}%
Chris@10 428 \begingroup
Chris@10 429 \obeylines
Chris@10 430 \spaceisspace
Chris@10 431 #1%
Chris@10 432 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
Chris@10 433 }
Chris@10 434
Chris@10 435 {\obeylines %
Chris@10 436 \gdef\parseargline#1^^M{%
Chris@10 437 \endgroup % End of the group started in \parsearg.
Chris@10 438 \argremovecomment #1\comment\ArgTerm%
Chris@10 439 }%
Chris@10 440 }
Chris@10 441
Chris@10 442 % First remove any @comment, then any @c comment.
Chris@10 443 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
Chris@10 444 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
Chris@10 445
Chris@10 446 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
Chris@10 447 %
Chris@10 448 % \argremovec might leave us with trailing space, e.g.,
Chris@10 449 % @end itemize @c foo
Chris@10 450 % This space token undergoes the same procedure and is eventually removed
Chris@10 451 % by \finishparsearg.
Chris@10 452 %
Chris@10 453 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
Chris@10 454 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
Chris@10 455 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
Chris@10 456 \def\temp{#3}%
Chris@10 457 \ifx\temp\empty
Chris@10 458 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
Chris@10 459 \let\temp\finishparsearg
Chris@10 460 \else
Chris@10 461 \let\temp\argcheckspaces
Chris@10 462 \fi
Chris@10 463 % Put the space token in:
Chris@10 464 \temp#1 #3\ArgTerm
Chris@10 465 }
Chris@10 466
Chris@10 467 % If a _delimited_ argument is enclosed in braces, they get stripped; so
Chris@10 468 % to get _exactly_ the rest of the line, we had to prevent such situation.
Chris@10 469 % We prepended an \empty token at the very beginning and we expand it now,
Chris@10 470 % just before passing the control to \argtorun.
Chris@10 471 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
Chris@10 472 % either the null string, or it ends with \^^M---thus there is no danger
Chris@10 473 % that a pair of braces would be stripped.
Chris@10 474 %
Chris@10 475 % But first, we have to remove the trailing space token.
Chris@10 476 %
Chris@10 477 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
Chris@10 478
Chris@10 479 % \parseargdef\foo{...}
Chris@10 480 % is roughly equivalent to
Chris@10 481 % \def\foo{\parsearg\Xfoo}
Chris@10 482 % \def\Xfoo#1{...}
Chris@10 483 %
Chris@10 484 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
Chris@10 485 % favourite TeX trick. --kasal, 16nov03
Chris@10 486
Chris@10 487 \def\parseargdef#1{%
Chris@10 488 \expandafter \doparseargdef \csname\string#1\endcsname #1%
Chris@10 489 }
Chris@10 490 \def\doparseargdef#1#2{%
Chris@10 491 \def#2{\parsearg#1}%
Chris@10 492 \def#1##1%
Chris@10 493 }
Chris@10 494
Chris@10 495 % Several utility definitions with active space:
Chris@10 496 {
Chris@10 497 \obeyspaces
Chris@10 498 \gdef\obeyedspace{ }
Chris@10 499
Chris@10 500 % Make each space character in the input produce a normal interword
Chris@10 501 % space in the output. Don't allow a line break at this space, as this
Chris@10 502 % is used only in environments like @example, where each line of input
Chris@10 503 % should produce a line of output anyway.
Chris@10 504 %
Chris@10 505 \gdef\sepspaces{\obeyspaces\let =\tie}
Chris@10 506
Chris@10 507 % If an index command is used in an @example environment, any spaces
Chris@10 508 % therein should become regular spaces in the raw index file, not the
Chris@10 509 % expansion of \tie (\leavevmode \penalty \@M \ ).
Chris@10 510 \gdef\unsepspaces{\let =\space}
Chris@10 511 }
Chris@10 512
Chris@10 513
Chris@10 514 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
Chris@10 515
Chris@10 516 % Define the framework for environments in texinfo.tex. It's used like this:
Chris@10 517 %
Chris@10 518 % \envdef\foo{...}
Chris@10 519 % \def\Efoo{...}
Chris@10 520 %
Chris@10 521 % It's the responsibility of \envdef to insert \begingroup before the
Chris@10 522 % actual body; @end closes the group after calling \Efoo. \envdef also
Chris@10 523 % defines \thisenv, so the current environment is known; @end checks
Chris@10 524 % whether the environment name matches. The \checkenv macro can also be
Chris@10 525 % used to check whether the current environment is the one expected.
Chris@10 526 %
Chris@10 527 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
Chris@10 528 % are not treated as environments; they don't open a group. (The
Chris@10 529 % implementation of @end takes care not to call \endgroup in this
Chris@10 530 % special case.)
Chris@10 531
Chris@10 532
Chris@10 533 % At run-time, environments start with this:
Chris@10 534 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
Chris@10 535 % initialize
Chris@10 536 \let\thisenv\empty
Chris@10 537
Chris@10 538 % ... but they get defined via ``\envdef\foo{...}'':
Chris@10 539 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
Chris@10 540 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
Chris@10 541
Chris@10 542 % Check whether we're in the right environment:
Chris@10 543 \def\checkenv#1{%
Chris@10 544 \def\temp{#1}%
Chris@10 545 \ifx\thisenv\temp
Chris@10 546 \else
Chris@10 547 \badenverr
Chris@10 548 \fi
Chris@10 549 }
Chris@10 550
Chris@10 551 % Environment mismatch, #1 expected:
Chris@10 552 \def\badenverr{%
Chris@10 553 \errhelp = \EMsimple
Chris@10 554 \errmessage{This command can appear only \inenvironment\temp,
Chris@10 555 not \inenvironment\thisenv}%
Chris@10 556 }
Chris@10 557 \def\inenvironment#1{%
Chris@10 558 \ifx#1\empty
Chris@10 559 outside of any environment%
Chris@10 560 \else
Chris@10 561 in environment \expandafter\string#1%
Chris@10 562 \fi
Chris@10 563 }
Chris@10 564
Chris@10 565 % @end foo executes the definition of \Efoo.
Chris@10 566 % But first, it executes a specialized version of \checkenv
Chris@10 567 %
Chris@10 568 \parseargdef\end{%
Chris@10 569 \if 1\csname iscond.#1\endcsname
Chris@10 570 \else
Chris@10 571 % The general wording of \badenverr may not be ideal.
Chris@10 572 \expandafter\checkenv\csname#1\endcsname
Chris@10 573 \csname E#1\endcsname
Chris@10 574 \endgroup
Chris@10 575 \fi
Chris@10 576 }
Chris@10 577
Chris@10 578 \newhelp\EMsimple{Press RETURN to continue.}
Chris@10 579
Chris@10 580
Chris@10 581 % Be sure we're in horizontal mode when doing a tie, since we make space
Chris@10 582 % equivalent to this in @example-like environments. Otherwise, a space
Chris@10 583 % at the beginning of a line will start with \penalty -- and
Chris@10 584 % since \penalty is valid in vertical mode, we'd end up putting the
Chris@10 585 % penalty on the vertical list instead of in the new paragraph.
Chris@10 586 {\catcode`@ = 11
Chris@10 587 % Avoid using \@M directly, because that causes trouble
Chris@10 588 % if the definition is written into an index file.
Chris@10 589 \global\let\tiepenalty = \@M
Chris@10 590 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
Chris@10 591 }
Chris@10 592
Chris@10 593 % @: forces normal size whitespace following.
Chris@10 594 \def\:{\spacefactor=1000 }
Chris@10 595
Chris@10 596 % @* forces a line break.
Chris@10 597 \def\*{\hfil\break\hbox{}\ignorespaces}
Chris@10 598
Chris@10 599 % @/ allows a line break.
Chris@10 600 \let\/=\allowbreak
Chris@10 601
Chris@10 602 % @. is an end-of-sentence period.
Chris@10 603 \def\.{.\spacefactor=\endofsentencespacefactor\space}
Chris@10 604
Chris@10 605 % @! is an end-of-sentence bang.
Chris@10 606 \def\!{!\spacefactor=\endofsentencespacefactor\space}
Chris@10 607
Chris@10 608 % @? is an end-of-sentence query.
Chris@10 609 \def\?{?\spacefactor=\endofsentencespacefactor\space}
Chris@10 610
Chris@10 611 % @frenchspacing on|off says whether to put extra space after punctuation.
Chris@10 612 %
Chris@10 613 \def\onword{on}
Chris@10 614 \def\offword{off}
Chris@10 615 %
Chris@10 616 \parseargdef\frenchspacing{%
Chris@10 617 \def\temp{#1}%
Chris@10 618 \ifx\temp\onword \plainfrenchspacing
Chris@10 619 \else\ifx\temp\offword \plainnonfrenchspacing
Chris@10 620 \else
Chris@10 621 \errhelp = \EMsimple
Chris@10 622 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
Chris@10 623 \fi\fi
Chris@10 624 }
Chris@10 625
Chris@10 626 % @w prevents a word break. Without the \leavevmode, @w at the
Chris@10 627 % beginning of a paragraph, when TeX is still in vertical mode, would
Chris@10 628 % produce a whole line of output instead of starting the paragraph.
Chris@10 629 \def\w#1{\leavevmode\hbox{#1}}
Chris@10 630
Chris@10 631 % @group ... @end group forces ... to be all on one page, by enclosing
Chris@10 632 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
Chris@10 633 % to keep its height that of a normal line. According to the rules for
Chris@10 634 % \topskip (p.114 of the TeXbook), the glue inserted is
Chris@10 635 % max (\topskip - \ht (first item), 0). If that height is large,
Chris@10 636 % therefore, no glue is inserted, and the space between the headline and
Chris@10 637 % the text is small, which looks bad.
Chris@10 638 %
Chris@10 639 % Another complication is that the group might be very large. This can
Chris@10 640 % cause the glue on the previous page to be unduly stretched, because it
Chris@10 641 % does not have much material. In this case, it's better to add an
Chris@10 642 % explicit \vfill so that the extra space is at the bottom. The
Chris@10 643 % threshold for doing this is if the group is more than \vfilllimit
Chris@10 644 % percent of a page (\vfilllimit can be changed inside of @tex).
Chris@10 645 %
Chris@10 646 \newbox\groupbox
Chris@10 647 \def\vfilllimit{0.7}
Chris@10 648 %
Chris@10 649 \envdef\group{%
Chris@10 650 \ifnum\catcode`\^^M=\active \else
Chris@10 651 \errhelp = \groupinvalidhelp
Chris@10 652 \errmessage{@group invalid in context where filling is enabled}%
Chris@10 653 \fi
Chris@10 654 \startsavinginserts
Chris@10 655 %
Chris@10 656 \setbox\groupbox = \vtop\bgroup
Chris@10 657 % Do @comment since we are called inside an environment such as
Chris@10 658 % @example, where each end-of-line in the input causes an
Chris@10 659 % end-of-line in the output. We don't want the end-of-line after
Chris@10 660 % the `@group' to put extra space in the output. Since @group
Chris@10 661 % should appear on a line by itself (according to the Texinfo
Chris@10 662 % manual), we don't worry about eating any user text.
Chris@10 663 \comment
Chris@10 664 }
Chris@10 665 %
Chris@10 666 % The \vtop produces a box with normal height and large depth; thus, TeX puts
Chris@10 667 % \baselineskip glue before it, and (when the next line of text is done)
Chris@10 668 % \lineskip glue after it. Thus, space below is not quite equal to space
Chris@10 669 % above. But it's pretty close.
Chris@10 670 \def\Egroup{%
Chris@10 671 % To get correct interline space between the last line of the group
Chris@10 672 % and the first line afterwards, we have to propagate \prevdepth.
Chris@10 673 \endgraf % Not \par, as it may have been set to \lisppar.
Chris@10 674 \global\dimen1 = \prevdepth
Chris@10 675 \egroup % End the \vtop.
Chris@10 676 % \dimen0 is the vertical size of the group's box.
Chris@10 677 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
Chris@10 678 % \dimen2 is how much space is left on the page (more or less).
Chris@10 679 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
Chris@10 680 % if the group doesn't fit on the current page, and it's a big big
Chris@10 681 % group, force a page break.
Chris@10 682 \ifdim \dimen0 > \dimen2
Chris@10 683 \ifdim \pagetotal < \vfilllimit\pageheight
Chris@10 684 \page
Chris@10 685 \fi
Chris@10 686 \fi
Chris@10 687 \box\groupbox
Chris@10 688 \prevdepth = \dimen1
Chris@10 689 \checkinserts
Chris@10 690 }
Chris@10 691 %
Chris@10 692 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
Chris@10 693 % message, so this ends up printing `@group can only ...'.
Chris@10 694 %
Chris@10 695 \newhelp\groupinvalidhelp{%
Chris@10 696 group can only be used in environments such as @example,^^J%
Chris@10 697 where each line of input produces a line of output.}
Chris@10 698
Chris@10 699 % @need space-in-mils
Chris@10 700 % forces a page break if there is not space-in-mils remaining.
Chris@10 701
Chris@10 702 \newdimen\mil \mil=0.001in
Chris@10 703
Chris@10 704 \parseargdef\need{%
Chris@10 705 % Ensure vertical mode, so we don't make a big box in the middle of a
Chris@10 706 % paragraph.
Chris@10 707 \par
Chris@10 708 %
Chris@10 709 % If the @need value is less than one line space, it's useless.
Chris@10 710 \dimen0 = #1\mil
Chris@10 711 \dimen2 = \ht\strutbox
Chris@10 712 \advance\dimen2 by \dp\strutbox
Chris@10 713 \ifdim\dimen0 > \dimen2
Chris@10 714 %
Chris@10 715 % Do a \strut just to make the height of this box be normal, so the
Chris@10 716 % normal leading is inserted relative to the preceding line.
Chris@10 717 % And a page break here is fine.
Chris@10 718 \vtop to #1\mil{\strut\vfil}%
Chris@10 719 %
Chris@10 720 % TeX does not even consider page breaks if a penalty added to the
Chris@10 721 % main vertical list is 10000 or more. But in order to see if the
Chris@10 722 % empty box we just added fits on the page, we must make it consider
Chris@10 723 % page breaks. On the other hand, we don't want to actually break the
Chris@10 724 % page after the empty box. So we use a penalty of 9999.
Chris@10 725 %
Chris@10 726 % There is an extremely small chance that TeX will actually break the
Chris@10 727 % page at this \penalty, if there are no other feasible breakpoints in
Chris@10 728 % sight. (If the user is using lots of big @group commands, which
Chris@10 729 % almost-but-not-quite fill up a page, TeX will have a hard time doing
Chris@10 730 % good page breaking, for example.) However, I could not construct an
Chris@10 731 % example where a page broke at this \penalty; if it happens in a real
Chris@10 732 % document, then we can reconsider our strategy.
Chris@10 733 \penalty9999
Chris@10 734 %
Chris@10 735 % Back up by the size of the box, whether we did a page break or not.
Chris@10 736 \kern -#1\mil
Chris@10 737 %
Chris@10 738 % Do not allow a page break right after this kern.
Chris@10 739 \nobreak
Chris@10 740 \fi
Chris@10 741 }
Chris@10 742
Chris@10 743 % @br forces paragraph break (and is undocumented).
Chris@10 744
Chris@10 745 \let\br = \par
Chris@10 746
Chris@10 747 % @page forces the start of a new page.
Chris@10 748 %
Chris@10 749 \def\page{\par\vfill\supereject}
Chris@10 750
Chris@10 751 % @exdent text....
Chris@10 752 % outputs text on separate line in roman font, starting at standard page margin
Chris@10 753
Chris@10 754 % This records the amount of indent in the innermost environment.
Chris@10 755 % That's how much \exdent should take out.
Chris@10 756 \newskip\exdentamount
Chris@10 757
Chris@10 758 % This defn is used inside fill environments such as @defun.
Chris@10 759 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
Chris@10 760
Chris@10 761 % This defn is used inside nofill environments such as @example.
Chris@10 762 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
Chris@10 763 \leftline{\hskip\leftskip{\rm#1}}}}
Chris@10 764
Chris@10 765 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
Chris@10 766 % paragraph. For more general purposes, use the \margin insertion
Chris@10 767 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
Chris@10 768 %
Chris@10 769 \newskip\inmarginspacing \inmarginspacing=1cm
Chris@10 770 \def\strutdepth{\dp\strutbox}
Chris@10 771 %
Chris@10 772 \def\doinmargin#1#2{\strut\vadjust{%
Chris@10 773 \nobreak
Chris@10 774 \kern-\strutdepth
Chris@10 775 \vtop to \strutdepth{%
Chris@10 776 \baselineskip=\strutdepth
Chris@10 777 \vss
Chris@10 778 % if you have multiple lines of stuff to put here, you'll need to
Chris@10 779 % make the vbox yourself of the appropriate size.
Chris@10 780 \ifx#1l%
Chris@10 781 \llap{\ignorespaces #2\hskip\inmarginspacing}%
Chris@10 782 \else
Chris@10 783 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
Chris@10 784 \fi
Chris@10 785 \null
Chris@10 786 }%
Chris@10 787 }}
Chris@10 788 \def\inleftmargin{\doinmargin l}
Chris@10 789 \def\inrightmargin{\doinmargin r}
Chris@10 790 %
Chris@10 791 % @inmargin{TEXT [, RIGHT-TEXT]}
Chris@10 792 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
Chris@10 793 % else use TEXT for both).
Chris@10 794 %
Chris@10 795 \def\inmargin#1{\parseinmargin #1,,\finish}
Chris@10 796 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
Chris@10 797 \setbox0 = \hbox{\ignorespaces #2}%
Chris@10 798 \ifdim\wd0 > 0pt
Chris@10 799 \def\lefttext{#1}% have both texts
Chris@10 800 \def\righttext{#2}%
Chris@10 801 \else
Chris@10 802 \def\lefttext{#1}% have only one text
Chris@10 803 \def\righttext{#1}%
Chris@10 804 \fi
Chris@10 805 %
Chris@10 806 \ifodd\pageno
Chris@10 807 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
Chris@10 808 \else
Chris@10 809 \def\temp{\inleftmargin\lefttext}%
Chris@10 810 \fi
Chris@10 811 \temp
Chris@10 812 }
Chris@10 813
Chris@10 814 % @| inserts a changebar to the left of the current line. It should
Chris@10 815 % surround any changed text. This approach does *not* work if the
Chris@10 816 % change spans more than two lines of output. To handle that, we would
Chris@10 817 % have adopt a much more difficult approach (putting marks into the main
Chris@10 818 % vertical list for the beginning and end of each change). This command
Chris@10 819 % is not documented, not supported, and doesn't work.
Chris@10 820 %
Chris@10 821 \def\|{%
Chris@10 822 % \vadjust can only be used in horizontal mode.
Chris@10 823 \leavevmode
Chris@10 824 %
Chris@10 825 % Append this vertical mode material after the current line in the output.
Chris@10 826 \vadjust{%
Chris@10 827 % We want to insert a rule with the height and depth of the current
Chris@10 828 % leading; that is exactly what \strutbox is supposed to record.
Chris@10 829 \vskip-\baselineskip
Chris@10 830 %
Chris@10 831 % \vadjust-items are inserted at the left edge of the type. So
Chris@10 832 % the \llap here moves out into the left-hand margin.
Chris@10 833 \llap{%
Chris@10 834 %
Chris@10 835 % For a thicker or thinner bar, change the `1pt'.
Chris@10 836 \vrule height\baselineskip width1pt
Chris@10 837 %
Chris@10 838 % This is the space between the bar and the text.
Chris@10 839 \hskip 12pt
Chris@10 840 }%
Chris@10 841 }%
Chris@10 842 }
Chris@10 843
Chris@10 844 % @include FILE -- \input text of FILE.
Chris@10 845 %
Chris@10 846 \def\include{\parseargusing\filenamecatcodes\includezzz}
Chris@10 847 \def\includezzz#1{%
Chris@10 848 \pushthisfilestack
Chris@10 849 \def\thisfile{#1}%
Chris@10 850 {%
Chris@10 851 \makevalueexpandable % we want to expand any @value in FILE.
Chris@10 852 \turnoffactive % and allow special characters in the expansion
Chris@10 853 \indexnofonts % Allow `@@' and other weird things in file names.
Chris@10 854 \wlog{texinfo.tex: doing @include of #1^^J}%
Chris@10 855 \edef\temp{\noexpand\input #1 }%
Chris@10 856 %
Chris@10 857 % This trickery is to read FILE outside of a group, in case it makes
Chris@10 858 % definitions, etc.
Chris@10 859 \expandafter
Chris@10 860 }\temp
Chris@10 861 \popthisfilestack
Chris@10 862 }
Chris@10 863 \def\filenamecatcodes{%
Chris@10 864 \catcode`\\=\other
Chris@10 865 \catcode`~=\other
Chris@10 866 \catcode`^=\other
Chris@10 867 \catcode`_=\other
Chris@10 868 \catcode`|=\other
Chris@10 869 \catcode`<=\other
Chris@10 870 \catcode`>=\other
Chris@10 871 \catcode`+=\other
Chris@10 872 \catcode`-=\other
Chris@10 873 \catcode`\`=\other
Chris@10 874 \catcode`\'=\other
Chris@10 875 }
Chris@10 876
Chris@10 877 \def\pushthisfilestack{%
Chris@10 878 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
Chris@10 879 }
Chris@10 880 \def\pushthisfilestackX{%
Chris@10 881 \expandafter\pushthisfilestackY\thisfile\StackTerm
Chris@10 882 }
Chris@10 883 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
Chris@10 884 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
Chris@10 885 }
Chris@10 886
Chris@10 887 \def\popthisfilestack{\errthisfilestackempty}
Chris@10 888 \def\errthisfilestackempty{\errmessage{Internal error:
Chris@10 889 the stack of filenames is empty.}}
Chris@10 890 %
Chris@10 891 \def\thisfile{}
Chris@10 892
Chris@10 893 % @center line
Chris@10 894 % outputs that line, centered.
Chris@10 895 %
Chris@10 896 \parseargdef\center{%
Chris@10 897 \ifhmode
Chris@10 898 \let\centersub\centerH
Chris@10 899 \else
Chris@10 900 \let\centersub\centerV
Chris@10 901 \fi
Chris@10 902 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
Chris@10 903 \let\centersub\relax % don't let the definition persist, just in case
Chris@10 904 }
Chris@10 905 \def\centerH#1{{%
Chris@10 906 \hfil\break
Chris@10 907 \advance\hsize by -\leftskip
Chris@10 908 \advance\hsize by -\rightskip
Chris@10 909 \line{#1}%
Chris@10 910 \break
Chris@10 911 }}
Chris@10 912 %
Chris@10 913 \newcount\centerpenalty
Chris@10 914 \def\centerV#1{%
Chris@10 915 % The idea here is the same as in \startdefun, \cartouche, etc.: if
Chris@10 916 % @center is the first thing after a section heading, we need to wipe
Chris@10 917 % out the negative parskip inserted by \sectionheading, but still
Chris@10 918 % prevent a page break here.
Chris@10 919 \centerpenalty = \lastpenalty
Chris@10 920 \ifnum\centerpenalty>10000 \vskip\parskip \fi
Chris@10 921 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
Chris@10 922 \line{\kern\leftskip #1\kern\rightskip}%
Chris@10 923 }
Chris@10 924
Chris@10 925 % @sp n outputs n lines of vertical space
Chris@10 926 %
Chris@10 927 \parseargdef\sp{\vskip #1\baselineskip}
Chris@10 928
Chris@10 929 % @comment ...line which is ignored...
Chris@10 930 % @c is the same as @comment
Chris@10 931 % @ignore ... @end ignore is another way to write a comment
Chris@10 932 %
Chris@10 933 \def\comment{\begingroup \catcode`\^^M=\other%
Chris@10 934 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
Chris@10 935 \commentxxx}
Chris@10 936 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
Chris@10 937 %
Chris@10 938 \let\c=\comment
Chris@10 939
Chris@10 940 % @paragraphindent NCHARS
Chris@10 941 % We'll use ems for NCHARS, close enough.
Chris@10 942 % NCHARS can also be the word `asis' or `none'.
Chris@10 943 % We cannot feasibly implement @paragraphindent asis, though.
Chris@10 944 %
Chris@10 945 \def\asisword{asis} % no translation, these are keywords
Chris@10 946 \def\noneword{none}
Chris@10 947 %
Chris@10 948 \parseargdef\paragraphindent{%
Chris@10 949 \def\temp{#1}%
Chris@10 950 \ifx\temp\asisword
Chris@10 951 \else
Chris@10 952 \ifx\temp\noneword
Chris@10 953 \defaultparindent = 0pt
Chris@10 954 \else
Chris@10 955 \defaultparindent = #1em
Chris@10 956 \fi
Chris@10 957 \fi
Chris@10 958 \parindent = \defaultparindent
Chris@10 959 }
Chris@10 960
Chris@10 961 % @exampleindent NCHARS
Chris@10 962 % We'll use ems for NCHARS like @paragraphindent.
Chris@10 963 % It seems @exampleindent asis isn't necessary, but
Chris@10 964 % I preserve it to make it similar to @paragraphindent.
Chris@10 965 \parseargdef\exampleindent{%
Chris@10 966 \def\temp{#1}%
Chris@10 967 \ifx\temp\asisword
Chris@10 968 \else
Chris@10 969 \ifx\temp\noneword
Chris@10 970 \lispnarrowing = 0pt
Chris@10 971 \else
Chris@10 972 \lispnarrowing = #1em
Chris@10 973 \fi
Chris@10 974 \fi
Chris@10 975 }
Chris@10 976
Chris@10 977 % @firstparagraphindent WORD
Chris@10 978 % If WORD is `none', then suppress indentation of the first paragraph
Chris@10 979 % after a section heading. If WORD is `insert', then do indent at such
Chris@10 980 % paragraphs.
Chris@10 981 %
Chris@10 982 % The paragraph indentation is suppressed or not by calling
Chris@10 983 % \suppressfirstparagraphindent, which the sectioning commands do.
Chris@10 984 % We switch the definition of this back and forth according to WORD.
Chris@10 985 % By default, we suppress indentation.
Chris@10 986 %
Chris@10 987 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
Chris@10 988 \def\insertword{insert}
Chris@10 989 %
Chris@10 990 \parseargdef\firstparagraphindent{%
Chris@10 991 \def\temp{#1}%
Chris@10 992 \ifx\temp\noneword
Chris@10 993 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
Chris@10 994 \else\ifx\temp\insertword
Chris@10 995 \let\suppressfirstparagraphindent = \relax
Chris@10 996 \else
Chris@10 997 \errhelp = \EMsimple
Chris@10 998 \errmessage{Unknown @firstparagraphindent option `\temp'}%
Chris@10 999 \fi\fi
Chris@10 1000 }
Chris@10 1001
Chris@10 1002 % Here is how we actually suppress indentation. Redefine \everypar to
Chris@10 1003 % \kern backwards by \parindent, and then reset itself to empty.
Chris@10 1004 %
Chris@10 1005 % We also make \indent itself not actually do anything until the next
Chris@10 1006 % paragraph.
Chris@10 1007 %
Chris@10 1008 \gdef\dosuppressfirstparagraphindent{%
Chris@10 1009 \gdef\indent{%
Chris@10 1010 \restorefirstparagraphindent
Chris@10 1011 \indent
Chris@10 1012 }%
Chris@10 1013 \gdef\noindent{%
Chris@10 1014 \restorefirstparagraphindent
Chris@10 1015 \noindent
Chris@10 1016 }%
Chris@10 1017 \global\everypar = {%
Chris@10 1018 \kern -\parindent
Chris@10 1019 \restorefirstparagraphindent
Chris@10 1020 }%
Chris@10 1021 }
Chris@10 1022
Chris@10 1023 \gdef\restorefirstparagraphindent{%
Chris@10 1024 \global \let \indent = \ptexindent
Chris@10 1025 \global \let \noindent = \ptexnoindent
Chris@10 1026 \global \everypar = {}%
Chris@10 1027 }
Chris@10 1028
Chris@10 1029
Chris@10 1030 % @refill is a no-op.
Chris@10 1031 \let\refill=\relax
Chris@10 1032
Chris@10 1033 % If working on a large document in chapters, it is convenient to
Chris@10 1034 % be able to disable indexing, cross-referencing, and contents, for test runs.
Chris@10 1035 % This is done with @novalidate (before @setfilename).
Chris@10 1036 %
Chris@10 1037 \newif\iflinks \linkstrue % by default we want the aux files.
Chris@10 1038 \let\novalidate = \linksfalse
Chris@10 1039
Chris@10 1040 % @setfilename is done at the beginning of every texinfo file.
Chris@10 1041 % So open here the files we need to have open while reading the input.
Chris@10 1042 % This makes it possible to make a .fmt file for texinfo.
Chris@10 1043 \def\setfilename{%
Chris@10 1044 \fixbackslash % Turn off hack to swallow `\input texinfo'.
Chris@10 1045 \iflinks
Chris@10 1046 \tryauxfile
Chris@10 1047 % Open the new aux file. TeX will close it automatically at exit.
Chris@10 1048 \immediate\openout\auxfile=\jobname.aux
Chris@10 1049 \fi % \openindices needs to do some work in any case.
Chris@10 1050 \openindices
Chris@10 1051 \let\setfilename=\comment % Ignore extra @setfilename cmds.
Chris@10 1052 %
Chris@10 1053 % If texinfo.cnf is present on the system, read it.
Chris@10 1054 % Useful for site-wide @afourpaper, etc.
Chris@10 1055 \openin 1 texinfo.cnf
Chris@10 1056 \ifeof 1 \else \input texinfo.cnf \fi
Chris@10 1057 \closein 1
Chris@10 1058 %
Chris@10 1059 \comment % Ignore the actual filename.
Chris@10 1060 }
Chris@10 1061
Chris@10 1062 % Called from \setfilename.
Chris@10 1063 %
Chris@10 1064 \def\openindices{%
Chris@10 1065 \newindex{cp}%
Chris@10 1066 \newcodeindex{fn}%
Chris@10 1067 \newcodeindex{vr}%
Chris@10 1068 \newcodeindex{tp}%
Chris@10 1069 \newcodeindex{ky}%
Chris@10 1070 \newcodeindex{pg}%
Chris@10 1071 }
Chris@10 1072
Chris@10 1073 % @bye.
Chris@10 1074 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
Chris@10 1075
Chris@10 1076
Chris@10 1077 \message{pdf,}
Chris@10 1078 % adobe `portable' document format
Chris@10 1079 \newcount\tempnum
Chris@10 1080 \newcount\lnkcount
Chris@10 1081 \newtoks\filename
Chris@10 1082 \newcount\filenamelength
Chris@10 1083 \newcount\pgn
Chris@10 1084 \newtoks\toksA
Chris@10 1085 \newtoks\toksB
Chris@10 1086 \newtoks\toksC
Chris@10 1087 \newtoks\toksD
Chris@10 1088 \newbox\boxA
Chris@10 1089 \newcount\countA
Chris@10 1090 \newif\ifpdf
Chris@10 1091 \newif\ifpdfmakepagedest
Chris@10 1092
Chris@10 1093 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
Chris@10 1094 % can be set). So we test for \relax and 0 as well as being undefined.
Chris@10 1095 \ifx\pdfoutput\thisisundefined
Chris@10 1096 \else
Chris@10 1097 \ifx\pdfoutput\relax
Chris@10 1098 \else
Chris@10 1099 \ifcase\pdfoutput
Chris@10 1100 \else
Chris@10 1101 \pdftrue
Chris@10 1102 \fi
Chris@10 1103 \fi
Chris@10 1104 \fi
Chris@10 1105
Chris@10 1106 % PDF uses PostScript string constants for the names of xref targets,
Chris@10 1107 % for display in the outlines, and in other places. Thus, we have to
Chris@10 1108 % double any backslashes. Otherwise, a name like "\node" will be
Chris@10 1109 % interpreted as a newline (\n), followed by o, d, e. Not good.
Chris@10 1110 %
Chris@10 1111 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
Chris@10 1112 % related messages. The final outcome is that it is up to the TeX user
Chris@10 1113 % to double the backslashes and otherwise make the string valid, so
Chris@10 1114 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
Chris@10 1115 % do this reliably, so we use it.
Chris@10 1116
Chris@10 1117 % #1 is a control sequence in which to do the replacements,
Chris@10 1118 % which we \xdef.
Chris@10 1119 \def\txiescapepdf#1{%
Chris@10 1120 \ifx\pdfescapestring\relax
Chris@10 1121 % No primitive available; should we give a warning or log?
Chris@10 1122 % Many times it won't matter.
Chris@10 1123 \else
Chris@10 1124 % The expandable \pdfescapestring primitive escapes parentheses,
Chris@10 1125 % backslashes, and other special chars.
Chris@10 1126 \xdef#1{\pdfescapestring{#1}}%
Chris@10 1127 \fi
Chris@10 1128 }
Chris@10 1129
Chris@10 1130 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
Chris@10 1131 with PDF output, and none of those formats could be found. (.eps cannot
Chris@10 1132 be supported due to the design of the PDF format; use regular TeX (DVI
Chris@10 1133 output) for that.)}
Chris@10 1134
Chris@10 1135 \ifpdf
Chris@10 1136 %
Chris@10 1137 % Color manipulation macros based on pdfcolor.tex,
Chris@10 1138 % except using rgb instead of cmyk; the latter is said to render as a
Chris@10 1139 % very dark gray on-screen and a very dark halftone in print, instead
Chris@10 1140 % of actual black.
Chris@10 1141 \def\rgbDarkRed{0.50 0.09 0.12}
Chris@10 1142 \def\rgbBlack{0 0 0}
Chris@10 1143 %
Chris@10 1144 % k sets the color for filling (usual text, etc.);
Chris@10 1145 % K sets the color for stroking (thin rules, e.g., normal _'s).
Chris@10 1146 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
Chris@10 1147 %
Chris@10 1148 % Set color, and create a mark which defines \thiscolor accordingly,
Chris@10 1149 % so that \makeheadline knows which color to restore.
Chris@10 1150 \def\setcolor#1{%
Chris@10 1151 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
Chris@10 1152 \domark
Chris@10 1153 \pdfsetcolor{#1}%
Chris@10 1154 }
Chris@10 1155 %
Chris@10 1156 \def\maincolor{\rgbBlack}
Chris@10 1157 \pdfsetcolor{\maincolor}
Chris@10 1158 \edef\thiscolor{\maincolor}
Chris@10 1159 \def\lastcolordefs{}
Chris@10 1160 %
Chris@10 1161 \def\makefootline{%
Chris@10 1162 \baselineskip24pt
Chris@10 1163 \line{\pdfsetcolor{\maincolor}\the\footline}%
Chris@10 1164 }
Chris@10 1165 %
Chris@10 1166 \def\makeheadline{%
Chris@10 1167 \vbox to 0pt{%
Chris@10 1168 \vskip-22.5pt
Chris@10 1169 \line{%
Chris@10 1170 \vbox to8.5pt{}%
Chris@10 1171 % Extract \thiscolor definition from the marks.
Chris@10 1172 \getcolormarks
Chris@10 1173 % Typeset the headline with \maincolor, then restore the color.
Chris@10 1174 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
Chris@10 1175 }%
Chris@10 1176 \vss
Chris@10 1177 }%
Chris@10 1178 \nointerlineskip
Chris@10 1179 }
Chris@10 1180 %
Chris@10 1181 %
Chris@10 1182 \pdfcatalog{/PageMode /UseOutlines}
Chris@10 1183 %
Chris@10 1184 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
Chris@10 1185 \def\dopdfimage#1#2#3{%
Chris@10 1186 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
Chris@10 1187 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
Chris@10 1188 %
Chris@10 1189 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
Chris@10 1190 % others). Let's try in that order, PDF first since if
Chris@10 1191 % someone has a scalable image, presumably better to use that than a
Chris@10 1192 % bitmap.
Chris@10 1193 \let\pdfimgext=\empty
Chris@10 1194 \begingroup
Chris@10 1195 \openin 1 #1.pdf \ifeof 1
Chris@10 1196 \openin 1 #1.PDF \ifeof 1
Chris@10 1197 \openin 1 #1.png \ifeof 1
Chris@10 1198 \openin 1 #1.jpg \ifeof 1
Chris@10 1199 \openin 1 #1.jpeg \ifeof 1
Chris@10 1200 \openin 1 #1.JPG \ifeof 1
Chris@10 1201 \errhelp = \nopdfimagehelp
Chris@10 1202 \errmessage{Could not find image file #1 for pdf}%
Chris@10 1203 \else \gdef\pdfimgext{JPG}%
Chris@10 1204 \fi
Chris@10 1205 \else \gdef\pdfimgext{jpeg}%
Chris@10 1206 \fi
Chris@10 1207 \else \gdef\pdfimgext{jpg}%
Chris@10 1208 \fi
Chris@10 1209 \else \gdef\pdfimgext{png}%
Chris@10 1210 \fi
Chris@10 1211 \else \gdef\pdfimgext{PDF}%
Chris@10 1212 \fi
Chris@10 1213 \else \gdef\pdfimgext{pdf}%
Chris@10 1214 \fi
Chris@10 1215 \closein 1
Chris@10 1216 \endgroup
Chris@10 1217 %
Chris@10 1218 % without \immediate, ancient pdftex seg faults when the same image is
Chris@10 1219 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
Chris@10 1220 \ifnum\pdftexversion < 14
Chris@10 1221 \immediate\pdfimage
Chris@10 1222 \else
Chris@10 1223 \immediate\pdfximage
Chris@10 1224 \fi
Chris@10 1225 \ifdim \wd0 >0pt width \pdfimagewidth \fi
Chris@10 1226 \ifdim \wd2 >0pt height \pdfimageheight \fi
Chris@10 1227 \ifnum\pdftexversion<13
Chris@10 1228 #1.\pdfimgext
Chris@10 1229 \else
Chris@10 1230 {#1.\pdfimgext}%
Chris@10 1231 \fi
Chris@10 1232 \ifnum\pdftexversion < 14 \else
Chris@10 1233 \pdfrefximage \pdflastximage
Chris@10 1234 \fi}
Chris@10 1235 %
Chris@10 1236 \def\pdfmkdest#1{{%
Chris@10 1237 % We have to set dummies so commands such as @code, and characters
Chris@10 1238 % such as \, aren't expanded when present in a section title.
Chris@10 1239 \indexnofonts
Chris@10 1240 \turnoffactive
Chris@10 1241 \makevalueexpandable
Chris@10 1242 \def\pdfdestname{#1}%
Chris@10 1243 \txiescapepdf\pdfdestname
Chris@10 1244 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
Chris@10 1245 }}
Chris@10 1246 %
Chris@10 1247 % used to mark target names; must be expandable.
Chris@10 1248 \def\pdfmkpgn#1{#1}
Chris@10 1249 %
Chris@10 1250 % by default, use a color that is dark enough to print on paper as
Chris@10 1251 % nearly black, but still distinguishable for online viewing.
Chris@10 1252 \def\urlcolor{\rgbDarkRed}
Chris@10 1253 \def\linkcolor{\rgbDarkRed}
Chris@10 1254 \def\endlink{\setcolor{\maincolor}\pdfendlink}
Chris@10 1255 %
Chris@10 1256 % Adding outlines to PDF; macros for calculating structure of outlines
Chris@10 1257 % come from Petr Olsak
Chris@10 1258 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
Chris@10 1259 \else \csname#1\endcsname \fi}
Chris@10 1260 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
Chris@10 1261 \advance\tempnum by 1
Chris@10 1262 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
Chris@10 1263 %
Chris@10 1264 % #1 is the section text, which is what will be displayed in the
Chris@10 1265 % outline by the pdf viewer. #2 is the pdf expression for the number
Chris@10 1266 % of subentries (or empty, for subsubsections). #3 is the node text,
Chris@10 1267 % which might be empty if this toc entry had no corresponding node.
Chris@10 1268 % #4 is the page number
Chris@10 1269 %
Chris@10 1270 \def\dopdfoutline#1#2#3#4{%
Chris@10 1271 % Generate a link to the node text if that exists; else, use the
Chris@10 1272 % page number. We could generate a destination for the section
Chris@10 1273 % text in the case where a section has no node, but it doesn't
Chris@10 1274 % seem worth the trouble, since most documents are normally structured.
Chris@10 1275 \edef\pdfoutlinedest{#3}%
Chris@10 1276 \ifx\pdfoutlinedest\empty
Chris@10 1277 \def\pdfoutlinedest{#4}%
Chris@10 1278 \else
Chris@10 1279 \txiescapepdf\pdfoutlinedest
Chris@10 1280 \fi
Chris@10 1281 %
Chris@10 1282 % Also escape PDF chars in the display string.
Chris@10 1283 \edef\pdfoutlinetext{#1}%
Chris@10 1284 \txiescapepdf\pdfoutlinetext
Chris@10 1285 %
Chris@10 1286 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
Chris@10 1287 }
Chris@10 1288 %
Chris@10 1289 \def\pdfmakeoutlines{%
Chris@10 1290 \begingroup
Chris@10 1291 % Read toc silently, to get counts of subentries for \pdfoutline.
Chris@10 1292 \def\partentry##1##2##3##4{}% ignore parts in the outlines
Chris@10 1293 \def\numchapentry##1##2##3##4{%
Chris@10 1294 \def\thischapnum{##2}%
Chris@10 1295 \def\thissecnum{0}%
Chris@10 1296 \def\thissubsecnum{0}%
Chris@10 1297 }%
Chris@10 1298 \def\numsecentry##1##2##3##4{%
Chris@10 1299 \advancenumber{chap\thischapnum}%
Chris@10 1300 \def\thissecnum{##2}%
Chris@10 1301 \def\thissubsecnum{0}%
Chris@10 1302 }%
Chris@10 1303 \def\numsubsecentry##1##2##3##4{%
Chris@10 1304 \advancenumber{sec\thissecnum}%
Chris@10 1305 \def\thissubsecnum{##2}%
Chris@10 1306 }%
Chris@10 1307 \def\numsubsubsecentry##1##2##3##4{%
Chris@10 1308 \advancenumber{subsec\thissubsecnum}%
Chris@10 1309 }%
Chris@10 1310 \def\thischapnum{0}%
Chris@10 1311 \def\thissecnum{0}%
Chris@10 1312 \def\thissubsecnum{0}%
Chris@10 1313 %
Chris@10 1314 % use \def rather than \let here because we redefine \chapentry et
Chris@10 1315 % al. a second time, below.
Chris@10 1316 \def\appentry{\numchapentry}%
Chris@10 1317 \def\appsecentry{\numsecentry}%
Chris@10 1318 \def\appsubsecentry{\numsubsecentry}%
Chris@10 1319 \def\appsubsubsecentry{\numsubsubsecentry}%
Chris@10 1320 \def\unnchapentry{\numchapentry}%
Chris@10 1321 \def\unnsecentry{\numsecentry}%
Chris@10 1322 \def\unnsubsecentry{\numsubsecentry}%
Chris@10 1323 \def\unnsubsubsecentry{\numsubsubsecentry}%
Chris@10 1324 \readdatafile{toc}%
Chris@10 1325 %
Chris@10 1326 % Read toc second time, this time actually producing the outlines.
Chris@10 1327 % The `-' means take the \expnumber as the absolute number of
Chris@10 1328 % subentries, which we calculated on our first read of the .toc above.
Chris@10 1329 %
Chris@10 1330 % We use the node names as the destinations.
Chris@10 1331 \def\numchapentry##1##2##3##4{%
Chris@10 1332 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
Chris@10 1333 \def\numsecentry##1##2##3##4{%
Chris@10 1334 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
Chris@10 1335 \def\numsubsecentry##1##2##3##4{%
Chris@10 1336 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
Chris@10 1337 \def\numsubsubsecentry##1##2##3##4{% count is always zero
Chris@10 1338 \dopdfoutline{##1}{}{##3}{##4}}%
Chris@10 1339 %
Chris@10 1340 % PDF outlines are displayed using system fonts, instead of
Chris@10 1341 % document fonts. Therefore we cannot use special characters,
Chris@10 1342 % since the encoding is unknown. For example, the eogonek from
Chris@10 1343 % Latin 2 (0xea) gets translated to a | character. Info from
Chris@10 1344 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
Chris@10 1345 %
Chris@10 1346 % TODO this right, we have to translate 8-bit characters to
Chris@10 1347 % their "best" equivalent, based on the @documentencoding. Too
Chris@10 1348 % much work for too little return. Just use the ASCII equivalents
Chris@10 1349 % we use for the index sort strings.
Chris@10 1350 %
Chris@10 1351 \indexnofonts
Chris@10 1352 \setupdatafile
Chris@10 1353 % We can have normal brace characters in the PDF outlines, unlike
Chris@10 1354 % Texinfo index files. So set that up.
Chris@10 1355 \def\{{\lbracecharliteral}%
Chris@10 1356 \def\}{\rbracecharliteral}%
Chris@10 1357 \catcode`\\=\active \otherbackslash
Chris@10 1358 \input \tocreadfilename
Chris@10 1359 \endgroup
Chris@10 1360 }
Chris@10 1361 {\catcode`[=1 \catcode`]=2
Chris@10 1362 \catcode`{=\other \catcode`}=\other
Chris@10 1363 \gdef\lbracecharliteral[{]%
Chris@10 1364 \gdef\rbracecharliteral[}]%
Chris@10 1365 ]
Chris@10 1366 %
Chris@10 1367 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
Chris@10 1368 \ifx\PP\D\let\nextsp\relax
Chris@10 1369 \else\let\nextsp\skipspaces
Chris@10 1370 \ifx\p\space\else\addtokens{\filename}{\PP}%
Chris@10 1371 \advance\filenamelength by 1
Chris@10 1372 \fi
Chris@10 1373 \fi
Chris@10 1374 \nextsp}
Chris@10 1375 \def\getfilename#1{%
Chris@10 1376 \filenamelength=0
Chris@10 1377 % If we don't expand the argument now, \skipspaces will get
Chris@10 1378 % snagged on things like "@value{foo}".
Chris@10 1379 \edef\temp{#1}%
Chris@10 1380 \expandafter\skipspaces\temp|\relax
Chris@10 1381 }
Chris@10 1382 \ifnum\pdftexversion < 14
Chris@10 1383 \let \startlink \pdfannotlink
Chris@10 1384 \else
Chris@10 1385 \let \startlink \pdfstartlink
Chris@10 1386 \fi
Chris@10 1387 % make a live url in pdf output.
Chris@10 1388 \def\pdfurl#1{%
Chris@10 1389 \begingroup
Chris@10 1390 % it seems we really need yet another set of dummies; have not
Chris@10 1391 % tried to figure out what each command should do in the context
Chris@10 1392 % of @url. for now, just make @/ a no-op, that's the only one
Chris@10 1393 % people have actually reported a problem with.
Chris@10 1394 %
Chris@10 1395 \normalturnoffactive
Chris@10 1396 \def\@{@}%
Chris@10 1397 \let\/=\empty
Chris@10 1398 \makevalueexpandable
Chris@10 1399 % do we want to go so far as to use \indexnofonts instead of just
Chris@10 1400 % special-casing \var here?
Chris@10 1401 \def\var##1{##1}%
Chris@10 1402 %
Chris@10 1403 \leavevmode\setcolor{\urlcolor}%
Chris@10 1404 \startlink attr{/Border [0 0 0]}%
Chris@10 1405 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
Chris@10 1406 \endgroup}
Chris@10 1407 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
Chris@10 1408 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
Chris@10 1409 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
Chris@10 1410 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
Chris@10 1411 \def\maketoks{%
Chris@10 1412 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
Chris@10 1413 \ifx\first0\adn0
Chris@10 1414 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
Chris@10 1415 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
Chris@10 1416 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
Chris@10 1417 \else
Chris@10 1418 \ifnum0=\countA\else\makelink\fi
Chris@10 1419 \ifx\first.\let\next=\done\else
Chris@10 1420 \let\next=\maketoks
Chris@10 1421 \addtokens{\toksB}{\the\toksD}
Chris@10 1422 \ifx\first,\addtokens{\toksB}{\space}\fi
Chris@10 1423 \fi
Chris@10 1424 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
Chris@10 1425 \next}
Chris@10 1426 \def\makelink{\addtokens{\toksB}%
Chris@10 1427 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
Chris@10 1428 \def\pdflink#1{%
Chris@10 1429 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
Chris@10 1430 \setcolor{\linkcolor}#1\endlink}
Chris@10 1431 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
Chris@10 1432 \else
Chris@10 1433 % non-pdf mode
Chris@10 1434 \let\pdfmkdest = \gobble
Chris@10 1435 \let\pdfurl = \gobble
Chris@10 1436 \let\endlink = \relax
Chris@10 1437 \let\setcolor = \gobble
Chris@10 1438 \let\pdfsetcolor = \gobble
Chris@10 1439 \let\pdfmakeoutlines = \relax
Chris@10 1440 \fi % \ifx\pdfoutput
Chris@10 1441
Chris@10 1442
Chris@10 1443 \message{fonts,}
Chris@10 1444
Chris@10 1445 % Change the current font style to #1, remembering it in \curfontstyle.
Chris@10 1446 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
Chris@10 1447 % italics, not bold italics.
Chris@10 1448 %
Chris@10 1449 \def\setfontstyle#1{%
Chris@10 1450 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
Chris@10 1451 \csname ten#1\endcsname % change the current font
Chris@10 1452 }
Chris@10 1453
Chris@10 1454 % Select #1 fonts with the current style.
Chris@10 1455 %
Chris@10 1456 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
Chris@10 1457
Chris@10 1458 \def\rm{\fam=0 \setfontstyle{rm}}
Chris@10 1459 \def\it{\fam=\itfam \setfontstyle{it}}
Chris@10 1460 \def\sl{\fam=\slfam \setfontstyle{sl}}
Chris@10 1461 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
Chris@10 1462 \def\tt{\fam=\ttfam \setfontstyle{tt}}
Chris@10 1463
Chris@10 1464 % Unfortunately, we have to override this for titles and the like, since
Chris@10 1465 % in those cases "rm" is bold. Sigh.
Chris@10 1466 \def\rmisbold{\rm\def\curfontstyle{bf}}
Chris@10 1467
Chris@10 1468 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
Chris@10 1469 % So we set up a \sf.
Chris@10 1470 \newfam\sffam
Chris@10 1471 \def\sf{\fam=\sffam \setfontstyle{sf}}
Chris@10 1472 \let\li = \sf % Sometimes we call it \li, not \sf.
Chris@10 1473
Chris@10 1474 % We don't need math for this font style.
Chris@10 1475 \def\ttsl{\setfontstyle{ttsl}}
Chris@10 1476
Chris@10 1477
Chris@10 1478 % Default leading.
Chris@10 1479 \newdimen\textleading \textleading = 13.2pt
Chris@10 1480
Chris@10 1481 % Set the baselineskip to #1, and the lineskip and strut size
Chris@10 1482 % correspondingly. There is no deep meaning behind these magic numbers
Chris@10 1483 % used as factors; they just match (closely enough) what Knuth defined.
Chris@10 1484 %
Chris@10 1485 \def\lineskipfactor{.08333}
Chris@10 1486 \def\strutheightpercent{.70833}
Chris@10 1487 \def\strutdepthpercent {.29167}
Chris@10 1488 %
Chris@10 1489 % can get a sort of poor man's double spacing by redefining this.
Chris@10 1490 \def\baselinefactor{1}
Chris@10 1491 %
Chris@10 1492 \def\setleading#1{%
Chris@10 1493 \dimen0 = #1\relax
Chris@10 1494 \normalbaselineskip = \baselinefactor\dimen0
Chris@10 1495 \normallineskip = \lineskipfactor\normalbaselineskip
Chris@10 1496 \normalbaselines
Chris@10 1497 \setbox\strutbox =\hbox{%
Chris@10 1498 \vrule width0pt height\strutheightpercent\baselineskip
Chris@10 1499 depth \strutdepthpercent \baselineskip
Chris@10 1500 }%
Chris@10 1501 }
Chris@10 1502
Chris@10 1503 % PDF CMaps. See also LaTeX's t1.cmap.
Chris@10 1504 %
Chris@10 1505 % do nothing with this by default.
Chris@10 1506 \expandafter\let\csname cmapOT1\endcsname\gobble
Chris@10 1507 \expandafter\let\csname cmapOT1IT\endcsname\gobble
Chris@10 1508 \expandafter\let\csname cmapOT1TT\endcsname\gobble
Chris@10 1509
Chris@10 1510 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
Chris@10 1511 % (\pdffontattr was introduced many years ago, but people still run
Chris@10 1512 % older pdftex's; it's easy to conditionalize, so we do.)
Chris@10 1513 \ifpdf \ifx\pdffontattr\thisisundefined \else
Chris@10 1514 \begingroup
Chris@10 1515 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
Chris@10 1516 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
Chris@10 1517 %%DocumentNeededResources: ProcSet (CIDInit)
Chris@10 1518 %%IncludeResource: ProcSet (CIDInit)
Chris@10 1519 %%BeginResource: CMap (TeX-OT1-0)
Chris@10 1520 %%Title: (TeX-OT1-0 TeX OT1 0)
Chris@10 1521 %%Version: 1.000
Chris@10 1522 %%EndComments
Chris@10 1523 /CIDInit /ProcSet findresource begin
Chris@10 1524 12 dict begin
Chris@10 1525 begincmap
Chris@10 1526 /CIDSystemInfo
Chris@10 1527 << /Registry (TeX)
Chris@10 1528 /Ordering (OT1)
Chris@10 1529 /Supplement 0
Chris@10 1530 >> def
Chris@10 1531 /CMapName /TeX-OT1-0 def
Chris@10 1532 /CMapType 2 def
Chris@10 1533 1 begincodespacerange
Chris@10 1534 <00> <7F>
Chris@10 1535 endcodespacerange
Chris@10 1536 8 beginbfrange
Chris@10 1537 <00> <01> <0393>
Chris@10 1538 <09> <0A> <03A8>
Chris@10 1539 <23> <26> <0023>
Chris@10 1540 <28> <3B> <0028>
Chris@10 1541 <3F> <5B> <003F>
Chris@10 1542 <5D> <5E> <005D>
Chris@10 1543 <61> <7A> <0061>
Chris@10 1544 <7B> <7C> <2013>
Chris@10 1545 endbfrange
Chris@10 1546 40 beginbfchar
Chris@10 1547 <02> <0398>
Chris@10 1548 <03> <039B>
Chris@10 1549 <04> <039E>
Chris@10 1550 <05> <03A0>
Chris@10 1551 <06> <03A3>
Chris@10 1552 <07> <03D2>
Chris@10 1553 <08> <03A6>
Chris@10 1554 <0B> <00660066>
Chris@10 1555 <0C> <00660069>
Chris@10 1556 <0D> <0066006C>
Chris@10 1557 <0E> <006600660069>
Chris@10 1558 <0F> <00660066006C>
Chris@10 1559 <10> <0131>
Chris@10 1560 <11> <0237>
Chris@10 1561 <12> <0060>
Chris@10 1562 <13> <00B4>
Chris@10 1563 <14> <02C7>
Chris@10 1564 <15> <02D8>
Chris@10 1565 <16> <00AF>
Chris@10 1566 <17> <02DA>
Chris@10 1567 <18> <00B8>
Chris@10 1568 <19> <00DF>
Chris@10 1569 <1A> <00E6>
Chris@10 1570 <1B> <0153>
Chris@10 1571 <1C> <00F8>
Chris@10 1572 <1D> <00C6>
Chris@10 1573 <1E> <0152>
Chris@10 1574 <1F> <00D8>
Chris@10 1575 <21> <0021>
Chris@10 1576 <22> <201D>
Chris@10 1577 <27> <2019>
Chris@10 1578 <3C> <00A1>
Chris@10 1579 <3D> <003D>
Chris@10 1580 <3E> <00BF>
Chris@10 1581 <5C> <201C>
Chris@10 1582 <5F> <02D9>
Chris@10 1583 <60> <2018>
Chris@10 1584 <7D> <02DD>
Chris@10 1585 <7E> <007E>
Chris@10 1586 <7F> <00A8>
Chris@10 1587 endbfchar
Chris@10 1588 endcmap
Chris@10 1589 CMapName currentdict /CMap defineresource pop
Chris@10 1590 end
Chris@10 1591 end
Chris@10 1592 %%EndResource
Chris@10 1593 %%EOF
Chris@10 1594 }\endgroup
Chris@10 1595 \expandafter\edef\csname cmapOT1\endcsname#1{%
Chris@10 1596 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
Chris@10 1597 }%
Chris@10 1598 %
Chris@10 1599 % \cmapOT1IT
Chris@10 1600 \begingroup
Chris@10 1601 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
Chris@10 1602 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
Chris@10 1603 %%DocumentNeededResources: ProcSet (CIDInit)
Chris@10 1604 %%IncludeResource: ProcSet (CIDInit)
Chris@10 1605 %%BeginResource: CMap (TeX-OT1IT-0)
Chris@10 1606 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
Chris@10 1607 %%Version: 1.000
Chris@10 1608 %%EndComments
Chris@10 1609 /CIDInit /ProcSet findresource begin
Chris@10 1610 12 dict begin
Chris@10 1611 begincmap
Chris@10 1612 /CIDSystemInfo
Chris@10 1613 << /Registry (TeX)
Chris@10 1614 /Ordering (OT1IT)
Chris@10 1615 /Supplement 0
Chris@10 1616 >> def
Chris@10 1617 /CMapName /TeX-OT1IT-0 def
Chris@10 1618 /CMapType 2 def
Chris@10 1619 1 begincodespacerange
Chris@10 1620 <00> <7F>
Chris@10 1621 endcodespacerange
Chris@10 1622 8 beginbfrange
Chris@10 1623 <00> <01> <0393>
Chris@10 1624 <09> <0A> <03A8>
Chris@10 1625 <25> <26> <0025>
Chris@10 1626 <28> <3B> <0028>
Chris@10 1627 <3F> <5B> <003F>
Chris@10 1628 <5D> <5E> <005D>
Chris@10 1629 <61> <7A> <0061>
Chris@10 1630 <7B> <7C> <2013>
Chris@10 1631 endbfrange
Chris@10 1632 42 beginbfchar
Chris@10 1633 <02> <0398>
Chris@10 1634 <03> <039B>
Chris@10 1635 <04> <039E>
Chris@10 1636 <05> <03A0>
Chris@10 1637 <06> <03A3>
Chris@10 1638 <07> <03D2>
Chris@10 1639 <08> <03A6>
Chris@10 1640 <0B> <00660066>
Chris@10 1641 <0C> <00660069>
Chris@10 1642 <0D> <0066006C>
Chris@10 1643 <0E> <006600660069>
Chris@10 1644 <0F> <00660066006C>
Chris@10 1645 <10> <0131>
Chris@10 1646 <11> <0237>
Chris@10 1647 <12> <0060>
Chris@10 1648 <13> <00B4>
Chris@10 1649 <14> <02C7>
Chris@10 1650 <15> <02D8>
Chris@10 1651 <16> <00AF>
Chris@10 1652 <17> <02DA>
Chris@10 1653 <18> <00B8>
Chris@10 1654 <19> <00DF>
Chris@10 1655 <1A> <00E6>
Chris@10 1656 <1B> <0153>
Chris@10 1657 <1C> <00F8>
Chris@10 1658 <1D> <00C6>
Chris@10 1659 <1E> <0152>
Chris@10 1660 <1F> <00D8>
Chris@10 1661 <21> <0021>
Chris@10 1662 <22> <201D>
Chris@10 1663 <23> <0023>
Chris@10 1664 <24> <00A3>
Chris@10 1665 <27> <2019>
Chris@10 1666 <3C> <00A1>
Chris@10 1667 <3D> <003D>
Chris@10 1668 <3E> <00BF>
Chris@10 1669 <5C> <201C>
Chris@10 1670 <5F> <02D9>
Chris@10 1671 <60> <2018>
Chris@10 1672 <7D> <02DD>
Chris@10 1673 <7E> <007E>
Chris@10 1674 <7F> <00A8>
Chris@10 1675 endbfchar
Chris@10 1676 endcmap
Chris@10 1677 CMapName currentdict /CMap defineresource pop
Chris@10 1678 end
Chris@10 1679 end
Chris@10 1680 %%EndResource
Chris@10 1681 %%EOF
Chris@10 1682 }\endgroup
Chris@10 1683 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
Chris@10 1684 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
Chris@10 1685 }%
Chris@10 1686 %
Chris@10 1687 % \cmapOT1TT
Chris@10 1688 \begingroup
Chris@10 1689 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
Chris@10 1690 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
Chris@10 1691 %%DocumentNeededResources: ProcSet (CIDInit)
Chris@10 1692 %%IncludeResource: ProcSet (CIDInit)
Chris@10 1693 %%BeginResource: CMap (TeX-OT1TT-0)
Chris@10 1694 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
Chris@10 1695 %%Version: 1.000
Chris@10 1696 %%EndComments
Chris@10 1697 /CIDInit /ProcSet findresource begin
Chris@10 1698 12 dict begin
Chris@10 1699 begincmap
Chris@10 1700 /CIDSystemInfo
Chris@10 1701 << /Registry (TeX)
Chris@10 1702 /Ordering (OT1TT)
Chris@10 1703 /Supplement 0
Chris@10 1704 >> def
Chris@10 1705 /CMapName /TeX-OT1TT-0 def
Chris@10 1706 /CMapType 2 def
Chris@10 1707 1 begincodespacerange
Chris@10 1708 <00> <7F>
Chris@10 1709 endcodespacerange
Chris@10 1710 5 beginbfrange
Chris@10 1711 <00> <01> <0393>
Chris@10 1712 <09> <0A> <03A8>
Chris@10 1713 <21> <26> <0021>
Chris@10 1714 <28> <5F> <0028>
Chris@10 1715 <61> <7E> <0061>
Chris@10 1716 endbfrange
Chris@10 1717 32 beginbfchar
Chris@10 1718 <02> <0398>
Chris@10 1719 <03> <039B>
Chris@10 1720 <04> <039E>
Chris@10 1721 <05> <03A0>
Chris@10 1722 <06> <03A3>
Chris@10 1723 <07> <03D2>
Chris@10 1724 <08> <03A6>
Chris@10 1725 <0B> <2191>
Chris@10 1726 <0C> <2193>
Chris@10 1727 <0D> <0027>
Chris@10 1728 <0E> <00A1>
Chris@10 1729 <0F> <00BF>
Chris@10 1730 <10> <0131>
Chris@10 1731 <11> <0237>
Chris@10 1732 <12> <0060>
Chris@10 1733 <13> <00B4>
Chris@10 1734 <14> <02C7>
Chris@10 1735 <15> <02D8>
Chris@10 1736 <16> <00AF>
Chris@10 1737 <17> <02DA>
Chris@10 1738 <18> <00B8>
Chris@10 1739 <19> <00DF>
Chris@10 1740 <1A> <00E6>
Chris@10 1741 <1B> <0153>
Chris@10 1742 <1C> <00F8>
Chris@10 1743 <1D> <00C6>
Chris@10 1744 <1E> <0152>
Chris@10 1745 <1F> <00D8>
Chris@10 1746 <20> <2423>
Chris@10 1747 <27> <2019>
Chris@10 1748 <60> <2018>
Chris@10 1749 <7F> <00A8>
Chris@10 1750 endbfchar
Chris@10 1751 endcmap
Chris@10 1752 CMapName currentdict /CMap defineresource pop
Chris@10 1753 end
Chris@10 1754 end
Chris@10 1755 %%EndResource
Chris@10 1756 %%EOF
Chris@10 1757 }\endgroup
Chris@10 1758 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
Chris@10 1759 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
Chris@10 1760 }%
Chris@10 1761 \fi\fi
Chris@10 1762
Chris@10 1763
Chris@10 1764 % Set the font macro #1 to the font named #2, adding on the
Chris@10 1765 % specified font prefix (normally `cm').
Chris@10 1766 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
Chris@10 1767 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
Chris@10 1768 % empty to omit).
Chris@10 1769 \def\setfont#1#2#3#4#5{%
Chris@10 1770 \font#1=\fontprefix#2#3 scaled #4
Chris@10 1771 \csname cmap#5\endcsname#1%
Chris@10 1772 }
Chris@10 1773 % This is what gets called when #5 of \setfont is empty.
Chris@10 1774 \let\cmap\gobble
Chris@10 1775 % emacs-page end of cmaps
Chris@10 1776
Chris@10 1777 % Use cm as the default font prefix.
Chris@10 1778 % To specify the font prefix, you must define \fontprefix
Chris@10 1779 % before you read in texinfo.tex.
Chris@10 1780 \ifx\fontprefix\thisisundefined
Chris@10 1781 \def\fontprefix{cm}
Chris@10 1782 \fi
Chris@10 1783 % Support font families that don't use the same naming scheme as CM.
Chris@10 1784 \def\rmshape{r}
Chris@10 1785 \def\rmbshape{bx} %where the normal face is bold
Chris@10 1786 \def\bfshape{b}
Chris@10 1787 \def\bxshape{bx}
Chris@10 1788 \def\ttshape{tt}
Chris@10 1789 \def\ttbshape{tt}
Chris@10 1790 \def\ttslshape{sltt}
Chris@10 1791 \def\itshape{ti}
Chris@10 1792 \def\itbshape{bxti}
Chris@10 1793 \def\slshape{sl}
Chris@10 1794 \def\slbshape{bxsl}
Chris@10 1795 \def\sfshape{ss}
Chris@10 1796 \def\sfbshape{ss}
Chris@10 1797 \def\scshape{csc}
Chris@10 1798 \def\scbshape{csc}
Chris@10 1799
Chris@10 1800 % Definitions for a main text size of 11pt. This is the default in
Chris@10 1801 % Texinfo.
Chris@10 1802 %
Chris@10 1803 \def\definetextfontsizexi{%
Chris@10 1804 % Text fonts (11.2pt, magstep1).
Chris@10 1805 \def\textnominalsize{11pt}
Chris@10 1806 \edef\mainmagstep{\magstephalf}
Chris@10 1807 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
Chris@10 1808 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
Chris@10 1809 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
Chris@10 1810 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
Chris@10 1811 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
Chris@10 1812 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
Chris@10 1813 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
Chris@10 1814 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
Chris@10 1815 \font\texti=cmmi10 scaled \mainmagstep
Chris@10 1816 \font\textsy=cmsy10 scaled \mainmagstep
Chris@10 1817 \def\textecsize{1095}
Chris@10 1818
Chris@10 1819 % A few fonts for @defun names and args.
Chris@10 1820 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
Chris@10 1821 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
Chris@10 1822 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
Chris@10 1823 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
Chris@10 1824
Chris@10 1825 % Fonts for indices, footnotes, small examples (9pt).
Chris@10 1826 \def\smallnominalsize{9pt}
Chris@10 1827 \setfont\smallrm\rmshape{9}{1000}{OT1}
Chris@10 1828 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
Chris@10 1829 \setfont\smallbf\bfshape{10}{900}{OT1}
Chris@10 1830 \setfont\smallit\itshape{9}{1000}{OT1IT}
Chris@10 1831 \setfont\smallsl\slshape{9}{1000}{OT1}
Chris@10 1832 \setfont\smallsf\sfshape{9}{1000}{OT1}
Chris@10 1833 \setfont\smallsc\scshape{10}{900}{OT1}
Chris@10 1834 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
Chris@10 1835 \font\smalli=cmmi9
Chris@10 1836 \font\smallsy=cmsy9
Chris@10 1837 \def\smallecsize{0900}
Chris@10 1838
Chris@10 1839 % Fonts for small examples (8pt).
Chris@10 1840 \def\smallernominalsize{8pt}
Chris@10 1841 \setfont\smallerrm\rmshape{8}{1000}{OT1}
Chris@10 1842 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
Chris@10 1843 \setfont\smallerbf\bfshape{10}{800}{OT1}
Chris@10 1844 \setfont\smallerit\itshape{8}{1000}{OT1IT}
Chris@10 1845 \setfont\smallersl\slshape{8}{1000}{OT1}
Chris@10 1846 \setfont\smallersf\sfshape{8}{1000}{OT1}
Chris@10 1847 \setfont\smallersc\scshape{10}{800}{OT1}
Chris@10 1848 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
Chris@10 1849 \font\smalleri=cmmi8
Chris@10 1850 \font\smallersy=cmsy8
Chris@10 1851 \def\smallerecsize{0800}
Chris@10 1852
Chris@10 1853 % Fonts for title page (20.4pt):
Chris@10 1854 \def\titlenominalsize{20pt}
Chris@10 1855 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
Chris@10 1856 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
Chris@10 1857 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
Chris@10 1858 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
Chris@10 1859 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
Chris@10 1860 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
Chris@10 1861 \let\titlebf=\titlerm
Chris@10 1862 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
Chris@10 1863 \font\titlei=cmmi12 scaled \magstep3
Chris@10 1864 \font\titlesy=cmsy10 scaled \magstep4
Chris@10 1865 \def\titleecsize{2074}
Chris@10 1866
Chris@10 1867 % Chapter (and unnumbered) fonts (17.28pt).
Chris@10 1868 \def\chapnominalsize{17pt}
Chris@10 1869 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
Chris@10 1870 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
Chris@10 1871 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
Chris@10 1872 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
Chris@10 1873 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
Chris@10 1874 \setfont\chapsf\sfbshape{17}{1000}{OT1}
Chris@10 1875 \let\chapbf=\chaprm
Chris@10 1876 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
Chris@10 1877 \font\chapi=cmmi12 scaled \magstep2
Chris@10 1878 \font\chapsy=cmsy10 scaled \magstep3
Chris@10 1879 \def\chapecsize{1728}
Chris@10 1880
Chris@10 1881 % Section fonts (14.4pt).
Chris@10 1882 \def\secnominalsize{14pt}
Chris@10 1883 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
Chris@10 1884 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
Chris@10 1885 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
Chris@10 1886 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
Chris@10 1887 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
Chris@10 1888 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
Chris@10 1889 \let\secbf\secrm
Chris@10 1890 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
Chris@10 1891 \font\seci=cmmi12 scaled \magstep1
Chris@10 1892 \font\secsy=cmsy10 scaled \magstep2
Chris@10 1893 \def\sececsize{1440}
Chris@10 1894
Chris@10 1895 % Subsection fonts (13.15pt).
Chris@10 1896 \def\ssecnominalsize{13pt}
Chris@10 1897 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
Chris@10 1898 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
Chris@10 1899 \setfont\ssecsl\slbshape{10}{1315}{OT1}
Chris@10 1900 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
Chris@10 1901 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
Chris@10 1902 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
Chris@10 1903 \let\ssecbf\ssecrm
Chris@10 1904 \setfont\ssecsc\scbshape{10}{1315}{OT1}
Chris@10 1905 \font\sseci=cmmi12 scaled \magstephalf
Chris@10 1906 \font\ssecsy=cmsy10 scaled 1315
Chris@10 1907 \def\ssececsize{1200}
Chris@10 1908
Chris@10 1909 % Reduced fonts for @acro in text (10pt).
Chris@10 1910 \def\reducednominalsize{10pt}
Chris@10 1911 \setfont\reducedrm\rmshape{10}{1000}{OT1}
Chris@10 1912 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
Chris@10 1913 \setfont\reducedbf\bfshape{10}{1000}{OT1}
Chris@10 1914 \setfont\reducedit\itshape{10}{1000}{OT1IT}
Chris@10 1915 \setfont\reducedsl\slshape{10}{1000}{OT1}
Chris@10 1916 \setfont\reducedsf\sfshape{10}{1000}{OT1}
Chris@10 1917 \setfont\reducedsc\scshape{10}{1000}{OT1}
Chris@10 1918 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
Chris@10 1919 \font\reducedi=cmmi10
Chris@10 1920 \font\reducedsy=cmsy10
Chris@10 1921 \def\reducedecsize{1000}
Chris@10 1922
Chris@10 1923 \textleading = 13.2pt % line spacing for 11pt CM
Chris@10 1924 \textfonts % reset the current fonts
Chris@10 1925 \rm
Chris@10 1926 } % end of 11pt text font size definitions
Chris@10 1927
Chris@10 1928
Chris@10 1929 % Definitions to make the main text be 10pt Computer Modern, with
Chris@10 1930 % section, chapter, etc., sizes following suit. This is for the GNU
Chris@10 1931 % Press printing of the Emacs 22 manual. Maybe other manuals in the
Chris@10 1932 % future. Used with @smallbook, which sets the leading to 12pt.
Chris@10 1933 %
Chris@10 1934 \def\definetextfontsizex{%
Chris@10 1935 % Text fonts (10pt).
Chris@10 1936 \def\textnominalsize{10pt}
Chris@10 1937 \edef\mainmagstep{1000}
Chris@10 1938 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
Chris@10 1939 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
Chris@10 1940 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
Chris@10 1941 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
Chris@10 1942 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
Chris@10 1943 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
Chris@10 1944 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
Chris@10 1945 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
Chris@10 1946 \font\texti=cmmi10 scaled \mainmagstep
Chris@10 1947 \font\textsy=cmsy10 scaled \mainmagstep
Chris@10 1948 \def\textecsize{1000}
Chris@10 1949
Chris@10 1950 % A few fonts for @defun names and args.
Chris@10 1951 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
Chris@10 1952 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
Chris@10 1953 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
Chris@10 1954 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
Chris@10 1955
Chris@10 1956 % Fonts for indices, footnotes, small examples (9pt).
Chris@10 1957 \def\smallnominalsize{9pt}
Chris@10 1958 \setfont\smallrm\rmshape{9}{1000}{OT1}
Chris@10 1959 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
Chris@10 1960 \setfont\smallbf\bfshape{10}{900}{OT1}
Chris@10 1961 \setfont\smallit\itshape{9}{1000}{OT1IT}
Chris@10 1962 \setfont\smallsl\slshape{9}{1000}{OT1}
Chris@10 1963 \setfont\smallsf\sfshape{9}{1000}{OT1}
Chris@10 1964 \setfont\smallsc\scshape{10}{900}{OT1}
Chris@10 1965 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
Chris@10 1966 \font\smalli=cmmi9
Chris@10 1967 \font\smallsy=cmsy9
Chris@10 1968 \def\smallecsize{0900}
Chris@10 1969
Chris@10 1970 % Fonts for small examples (8pt).
Chris@10 1971 \def\smallernominalsize{8pt}
Chris@10 1972 \setfont\smallerrm\rmshape{8}{1000}{OT1}
Chris@10 1973 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
Chris@10 1974 \setfont\smallerbf\bfshape{10}{800}{OT1}
Chris@10 1975 \setfont\smallerit\itshape{8}{1000}{OT1IT}
Chris@10 1976 \setfont\smallersl\slshape{8}{1000}{OT1}
Chris@10 1977 \setfont\smallersf\sfshape{8}{1000}{OT1}
Chris@10 1978 \setfont\smallersc\scshape{10}{800}{OT1}
Chris@10 1979 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
Chris@10 1980 \font\smalleri=cmmi8
Chris@10 1981 \font\smallersy=cmsy8
Chris@10 1982 \def\smallerecsize{0800}
Chris@10 1983
Chris@10 1984 % Fonts for title page (20.4pt):
Chris@10 1985 \def\titlenominalsize{20pt}
Chris@10 1986 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
Chris@10 1987 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
Chris@10 1988 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
Chris@10 1989 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
Chris@10 1990 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
Chris@10 1991 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
Chris@10 1992 \let\titlebf=\titlerm
Chris@10 1993 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
Chris@10 1994 \font\titlei=cmmi12 scaled \magstep3
Chris@10 1995 \font\titlesy=cmsy10 scaled \magstep4
Chris@10 1996 \def\titleecsize{2074}
Chris@10 1997
Chris@10 1998 % Chapter fonts (14.4pt).
Chris@10 1999 \def\chapnominalsize{14pt}
Chris@10 2000 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
Chris@10 2001 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
Chris@10 2002 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
Chris@10 2003 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
Chris@10 2004 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
Chris@10 2005 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
Chris@10 2006 \let\chapbf\chaprm
Chris@10 2007 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
Chris@10 2008 \font\chapi=cmmi12 scaled \magstep1
Chris@10 2009 \font\chapsy=cmsy10 scaled \magstep2
Chris@10 2010 \def\chapecsize{1440}
Chris@10 2011
Chris@10 2012 % Section fonts (12pt).
Chris@10 2013 \def\secnominalsize{12pt}
Chris@10 2014 \setfont\secrm\rmbshape{12}{1000}{OT1}
Chris@10 2015 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
Chris@10 2016 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
Chris@10 2017 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
Chris@10 2018 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
Chris@10 2019 \setfont\secsf\sfbshape{12}{1000}{OT1}
Chris@10 2020 \let\secbf\secrm
Chris@10 2021 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
Chris@10 2022 \font\seci=cmmi12
Chris@10 2023 \font\secsy=cmsy10 scaled \magstep1
Chris@10 2024 \def\sececsize{1200}
Chris@10 2025
Chris@10 2026 % Subsection fonts (10pt).
Chris@10 2027 \def\ssecnominalsize{10pt}
Chris@10 2028 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
Chris@10 2029 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
Chris@10 2030 \setfont\ssecsl\slbshape{10}{1000}{OT1}
Chris@10 2031 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
Chris@10 2032 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
Chris@10 2033 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
Chris@10 2034 \let\ssecbf\ssecrm
Chris@10 2035 \setfont\ssecsc\scbshape{10}{1000}{OT1}
Chris@10 2036 \font\sseci=cmmi10
Chris@10 2037 \font\ssecsy=cmsy10
Chris@10 2038 \def\ssececsize{1000}
Chris@10 2039
Chris@10 2040 % Reduced fonts for @acro in text (9pt).
Chris@10 2041 \def\reducednominalsize{9pt}
Chris@10 2042 \setfont\reducedrm\rmshape{9}{1000}{OT1}
Chris@10 2043 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
Chris@10 2044 \setfont\reducedbf\bfshape{10}{900}{OT1}
Chris@10 2045 \setfont\reducedit\itshape{9}{1000}{OT1IT}
Chris@10 2046 \setfont\reducedsl\slshape{9}{1000}{OT1}
Chris@10 2047 \setfont\reducedsf\sfshape{9}{1000}{OT1}
Chris@10 2048 \setfont\reducedsc\scshape{10}{900}{OT1}
Chris@10 2049 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
Chris@10 2050 \font\reducedi=cmmi9
Chris@10 2051 \font\reducedsy=cmsy9
Chris@10 2052 \def\reducedecsize{0900}
Chris@10 2053
Chris@10 2054 \divide\parskip by 2 % reduce space between paragraphs
Chris@10 2055 \textleading = 12pt % line spacing for 10pt CM
Chris@10 2056 \textfonts % reset the current fonts
Chris@10 2057 \rm
Chris@10 2058 } % end of 10pt text font size definitions
Chris@10 2059
Chris@10 2060
Chris@10 2061 % We provide the user-level command
Chris@10 2062 % @fonttextsize 10
Chris@10 2063 % (or 11) to redefine the text font size. pt is assumed.
Chris@10 2064 %
Chris@10 2065 \def\xiword{11}
Chris@10 2066 \def\xword{10}
Chris@10 2067 \def\xwordpt{10pt}
Chris@10 2068 %
Chris@10 2069 \parseargdef\fonttextsize{%
Chris@10 2070 \def\textsizearg{#1}%
Chris@10 2071 %\wlog{doing @fonttextsize \textsizearg}%
Chris@10 2072 %
Chris@10 2073 % Set \globaldefs so that documents can use this inside @tex, since
Chris@10 2074 % makeinfo 4.8 does not support it, but we need it nonetheless.
Chris@10 2075 %
Chris@10 2076 \begingroup \globaldefs=1
Chris@10 2077 \ifx\textsizearg\xword \definetextfontsizex
Chris@10 2078 \else \ifx\textsizearg\xiword \definetextfontsizexi
Chris@10 2079 \else
Chris@10 2080 \errhelp=\EMsimple
Chris@10 2081 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
Chris@10 2082 \fi\fi
Chris@10 2083 \endgroup
Chris@10 2084 }
Chris@10 2085
Chris@10 2086
Chris@10 2087 % In order for the font changes to affect most math symbols and letters,
Chris@10 2088 % we have to define the \textfont of the standard families. Since
Chris@10 2089 % texinfo doesn't allow for producing subscripts and superscripts except
Chris@10 2090 % in the main text, we don't bother to reset \scriptfont and
Chris@10 2091 % \scriptscriptfont (which would also require loading a lot more fonts).
Chris@10 2092 %
Chris@10 2093 \def\resetmathfonts{%
Chris@10 2094 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
Chris@10 2095 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
Chris@10 2096 \textfont\ttfam=\tentt \textfont\sffam=\tensf
Chris@10 2097 }
Chris@10 2098
Chris@10 2099 % The font-changing commands redefine the meanings of \tenSTYLE, instead
Chris@10 2100 % of just \STYLE. We do this because \STYLE needs to also set the
Chris@10 2101 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
Chris@10 2102 % \tenSTYLE to set the current font.
Chris@10 2103 %
Chris@10 2104 % Each font-changing command also sets the names \lsize (one size lower)
Chris@10 2105 % and \lllsize (three sizes lower). These relative commands are used in
Chris@10 2106 % the LaTeX logo and acronyms.
Chris@10 2107 %
Chris@10 2108 % This all needs generalizing, badly.
Chris@10 2109 %
Chris@10 2110 \def\textfonts{%
Chris@10 2111 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
Chris@10 2112 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
Chris@10 2113 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
Chris@10 2114 \let\tenttsl=\textttsl
Chris@10 2115 \def\curfontsize{text}%
Chris@10 2116 \def\lsize{reduced}\def\lllsize{smaller}%
Chris@10 2117 \resetmathfonts \setleading{\textleading}}
Chris@10 2118 \def\titlefonts{%
Chris@10 2119 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
Chris@10 2120 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
Chris@10 2121 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
Chris@10 2122 \let\tenttsl=\titlettsl
Chris@10 2123 \def\curfontsize{title}%
Chris@10 2124 \def\lsize{chap}\def\lllsize{subsec}%
Chris@10 2125 \resetmathfonts \setleading{27pt}}
Chris@10 2126 \def\titlefont#1{{\titlefonts\rmisbold #1}}
Chris@10 2127 \def\chapfonts{%
Chris@10 2128 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
Chris@10 2129 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
Chris@10 2130 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
Chris@10 2131 \let\tenttsl=\chapttsl
Chris@10 2132 \def\curfontsize{chap}%
Chris@10 2133 \def\lsize{sec}\def\lllsize{text}%
Chris@10 2134 \resetmathfonts \setleading{19pt}}
Chris@10 2135 \def\secfonts{%
Chris@10 2136 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
Chris@10 2137 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
Chris@10 2138 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
Chris@10 2139 \let\tenttsl=\secttsl
Chris@10 2140 \def\curfontsize{sec}%
Chris@10 2141 \def\lsize{subsec}\def\lllsize{reduced}%
Chris@10 2142 \resetmathfonts \setleading{16pt}}
Chris@10 2143 \def\subsecfonts{%
Chris@10 2144 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
Chris@10 2145 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
Chris@10 2146 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
Chris@10 2147 \let\tenttsl=\ssecttsl
Chris@10 2148 \def\curfontsize{ssec}%
Chris@10 2149 \def\lsize{text}\def\lllsize{small}%
Chris@10 2150 \resetmathfonts \setleading{15pt}}
Chris@10 2151 \let\subsubsecfonts = \subsecfonts
Chris@10 2152 \def\reducedfonts{%
Chris@10 2153 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
Chris@10 2154 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
Chris@10 2155 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
Chris@10 2156 \let\tenttsl=\reducedttsl
Chris@10 2157 \def\curfontsize{reduced}%
Chris@10 2158 \def\lsize{small}\def\lllsize{smaller}%
Chris@10 2159 \resetmathfonts \setleading{10.5pt}}
Chris@10 2160 \def\smallfonts{%
Chris@10 2161 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
Chris@10 2162 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
Chris@10 2163 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
Chris@10 2164 \let\tenttsl=\smallttsl
Chris@10 2165 \def\curfontsize{small}%
Chris@10 2166 \def\lsize{smaller}\def\lllsize{smaller}%
Chris@10 2167 \resetmathfonts \setleading{10.5pt}}
Chris@10 2168 \def\smallerfonts{%
Chris@10 2169 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
Chris@10 2170 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
Chris@10 2171 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
Chris@10 2172 \let\tenttsl=\smallerttsl
Chris@10 2173 \def\curfontsize{smaller}%
Chris@10 2174 \def\lsize{smaller}\def\lllsize{smaller}%
Chris@10 2175 \resetmathfonts \setleading{9.5pt}}
Chris@10 2176
Chris@10 2177 % Fonts for short table of contents.
Chris@10 2178 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
Chris@10 2179 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
Chris@10 2180 \setfont\shortcontsl\slshape{12}{1000}{OT1}
Chris@10 2181 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
Chris@10 2182
Chris@10 2183 % Define these just so they can be easily changed for other fonts.
Chris@10 2184 \def\angleleft{$\langle$}
Chris@10 2185 \def\angleright{$\rangle$}
Chris@10 2186
Chris@10 2187 % Set the fonts to use with the @small... environments.
Chris@10 2188 \let\smallexamplefonts = \smallfonts
Chris@10 2189
Chris@10 2190 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
Chris@10 2191 % can fit this many characters:
Chris@10 2192 % 8.5x11=86 smallbook=72 a4=90 a5=69
Chris@10 2193 % If we use \scriptfonts (8pt), then we can fit this many characters:
Chris@10 2194 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
Chris@10 2195 % For me, subjectively, the few extra characters that fit aren't worth
Chris@10 2196 % the additional smallness of 8pt. So I'm making the default 9pt.
Chris@10 2197 %
Chris@10 2198 % By the way, for comparison, here's what fits with @example (10pt):
Chris@10 2199 % 8.5x11=71 smallbook=60 a4=75 a5=58
Chris@10 2200 % --karl, 24jan03.
Chris@10 2201
Chris@10 2202 % Set up the default fonts, so we can use them for creating boxes.
Chris@10 2203 %
Chris@10 2204 \definetextfontsizexi
Chris@10 2205
Chris@10 2206
Chris@10 2207 \message{markup,}
Chris@10 2208
Chris@10 2209 % Check if we are currently using a typewriter font. Since all the
Chris@10 2210 % Computer Modern typewriter fonts have zero interword stretch (and
Chris@10 2211 % shrink), and it is reasonable to expect all typewriter fonts to have
Chris@10 2212 % this property, we can check that font parameter.
Chris@10 2213 %
Chris@10 2214 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
Chris@10 2215
Chris@10 2216 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
Chris@10 2217 % define and register \INITMACRO to be called on markup style changes.
Chris@10 2218 % \INITMACRO can check \currentmarkupstyle for the innermost
Chris@10 2219 % style and the set of \ifmarkupSTYLE switches for all styles
Chris@10 2220 % currently in effect.
Chris@10 2221 \newif\ifmarkupvar
Chris@10 2222 \newif\ifmarkupsamp
Chris@10 2223 \newif\ifmarkupkey
Chris@10 2224 %\newif\ifmarkupfile % @file == @samp.
Chris@10 2225 %\newif\ifmarkupoption % @option == @samp.
Chris@10 2226 \newif\ifmarkupcode
Chris@10 2227 \newif\ifmarkupkbd
Chris@10 2228 %\newif\ifmarkupenv % @env == @code.
Chris@10 2229 %\newif\ifmarkupcommand % @command == @code.
Chris@10 2230 \newif\ifmarkuptex % @tex (and part of @math, for now).
Chris@10 2231 \newif\ifmarkupexample
Chris@10 2232 \newif\ifmarkupverb
Chris@10 2233 \newif\ifmarkupverbatim
Chris@10 2234
Chris@10 2235 \let\currentmarkupstyle\empty
Chris@10 2236
Chris@10 2237 \def\setupmarkupstyle#1{%
Chris@10 2238 \csname markup#1true\endcsname
Chris@10 2239 \def\currentmarkupstyle{#1}%
Chris@10 2240 \markupstylesetup
Chris@10 2241 }
Chris@10 2242
Chris@10 2243 \let\markupstylesetup\empty
Chris@10 2244
Chris@10 2245 \def\defmarkupstylesetup#1{%
Chris@10 2246 \expandafter\def\expandafter\markupstylesetup
Chris@10 2247 \expandafter{\markupstylesetup #1}%
Chris@10 2248 \def#1%
Chris@10 2249 }
Chris@10 2250
Chris@10 2251 % Markup style setup for left and right quotes.
Chris@10 2252 \defmarkupstylesetup\markupsetuplq{%
Chris@10 2253 \expandafter\let\expandafter \temp
Chris@10 2254 \csname markupsetuplq\currentmarkupstyle\endcsname
Chris@10 2255 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
Chris@10 2256 }
Chris@10 2257
Chris@10 2258 \defmarkupstylesetup\markupsetuprq{%
Chris@10 2259 \expandafter\let\expandafter \temp
Chris@10 2260 \csname markupsetuprq\currentmarkupstyle\endcsname
Chris@10 2261 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
Chris@10 2262 }
Chris@10 2263
Chris@10 2264 {
Chris@10 2265 \catcode`\'=\active
Chris@10 2266 \catcode`\`=\active
Chris@10 2267
Chris@10 2268 \gdef\markupsetuplqdefault{\let`\lq}
Chris@10 2269 \gdef\markupsetuprqdefault{\let'\rq}
Chris@10 2270
Chris@10 2271 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
Chris@10 2272 \gdef\markupsetcodequoteright{\let'\codequoteright}
Chris@10 2273
Chris@10 2274 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
Chris@10 2275 }
Chris@10 2276
Chris@10 2277 \let\markupsetuplqcode \markupsetcodequoteleft
Chris@10 2278 \let\markupsetuprqcode \markupsetcodequoteright
Chris@10 2279 %
Chris@10 2280 \let\markupsetuplqexample \markupsetcodequoteleft
Chris@10 2281 \let\markupsetuprqexample \markupsetcodequoteright
Chris@10 2282 %
Chris@10 2283 \let\markupsetuplqsamp \markupsetcodequoteleft
Chris@10 2284 \let\markupsetuprqsamp \markupsetcodequoteright
Chris@10 2285 %
Chris@10 2286 \let\markupsetuplqverb \markupsetcodequoteleft
Chris@10 2287 \let\markupsetuprqverb \markupsetcodequoteright
Chris@10 2288 %
Chris@10 2289 \let\markupsetuplqverbatim \markupsetcodequoteleft
Chris@10 2290 \let\markupsetuprqverbatim \markupsetcodequoteright
Chris@10 2291
Chris@10 2292 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
Chris@10 2293
Chris@10 2294 % Allow an option to not use regular directed right quote/apostrophe
Chris@10 2295 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
Chris@10 2296 % The undirected quote is ugly, so don't make it the default, but it
Chris@10 2297 % works for pasting with more pdf viewers (at least evince), the
Chris@10 2298 % lilypond developers report. xpdf does work with the regular 0x27.
Chris@10 2299 %
Chris@10 2300 \def\codequoteright{%
Chris@10 2301 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
Chris@10 2302 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
Chris@10 2303 '%
Chris@10 2304 \else \char'15 \fi
Chris@10 2305 \else \char'15 \fi
Chris@10 2306 }
Chris@10 2307 %
Chris@10 2308 % and a similar option for the left quote char vs. a grave accent.
Chris@10 2309 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
Chris@10 2310 % the code environments to do likewise.
Chris@10 2311 %
Chris@10 2312 \def\codequoteleft{%
Chris@10 2313 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
Chris@10 2314 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
Chris@10 2315 % [Knuth] pp. 380,381,391
Chris@10 2316 % \relax disables Spanish ligatures ?` and !` of \tt font.
Chris@10 2317 \relax`%
Chris@10 2318 \else \char'22 \fi
Chris@10 2319 \else \char'22 \fi
Chris@10 2320 }
Chris@10 2321
Chris@10 2322 % Commands to set the quote options.
Chris@10 2323 %
Chris@10 2324 \parseargdef\codequoteundirected{%
Chris@10 2325 \def\temp{#1}%
Chris@10 2326 \ifx\temp\onword
Chris@10 2327 \expandafter\let\csname SETtxicodequoteundirected\endcsname
Chris@10 2328 = t%
Chris@10 2329 \else\ifx\temp\offword
Chris@10 2330 \expandafter\let\csname SETtxicodequoteundirected\endcsname
Chris@10 2331 = \relax
Chris@10 2332 \else
Chris@10 2333 \errhelp = \EMsimple
Chris@10 2334 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
Chris@10 2335 \fi\fi
Chris@10 2336 }
Chris@10 2337 %
Chris@10 2338 \parseargdef\codequotebacktick{%
Chris@10 2339 \def\temp{#1}%
Chris@10 2340 \ifx\temp\onword
Chris@10 2341 \expandafter\let\csname SETtxicodequotebacktick\endcsname
Chris@10 2342 = t%
Chris@10 2343 \else\ifx\temp\offword
Chris@10 2344 \expandafter\let\csname SETtxicodequotebacktick\endcsname
Chris@10 2345 = \relax
Chris@10 2346 \else
Chris@10 2347 \errhelp = \EMsimple
Chris@10 2348 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
Chris@10 2349 \fi\fi
Chris@10 2350 }
Chris@10 2351
Chris@10 2352 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
Chris@10 2353 \def\noligaturesquoteleft{\relax\lq}
Chris@10 2354
Chris@10 2355 % Count depth in font-changes, for error checks
Chris@10 2356 \newcount\fontdepth \fontdepth=0
Chris@10 2357
Chris@10 2358 % Font commands.
Chris@10 2359
Chris@10 2360 % #1 is the font command (\sl or \it), #2 is the text to slant.
Chris@10 2361 % If we are in a monospaced environment, however, 1) always use \ttsl,
Chris@10 2362 % and 2) do not add an italic correction.
Chris@10 2363 \def\dosmartslant#1#2{%
Chris@10 2364 \ifusingtt
Chris@10 2365 {{\ttsl #2}\let\next=\relax}%
Chris@10 2366 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
Chris@10 2367 \next
Chris@10 2368 }
Chris@10 2369 \def\smartslanted{\dosmartslant\sl}
Chris@10 2370 \def\smartitalic{\dosmartslant\it}
Chris@10 2371
Chris@10 2372 % Output an italic correction unless \next (presumed to be the following
Chris@10 2373 % character) is such as not to need one.
Chris@10 2374 \def\smartitaliccorrection{%
Chris@10 2375 \ifx\next,%
Chris@10 2376 \else\ifx\next-%
Chris@10 2377 \else\ifx\next.%
Chris@10 2378 \else\ptexslash
Chris@10 2379 \fi\fi\fi
Chris@10 2380 \aftersmartic
Chris@10 2381 }
Chris@10 2382
Chris@10 2383 % like \smartslanted except unconditionally uses \ttsl, and no ic.
Chris@10 2384 % @var is set to this for defun arguments.
Chris@10 2385 \def\ttslanted#1{{\ttsl #1}}
Chris@10 2386
Chris@10 2387 % @cite is like \smartslanted except unconditionally use \sl. We never want
Chris@10 2388 % ttsl for book titles, do we?
Chris@10 2389 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
Chris@10 2390
Chris@10 2391 \def\aftersmartic{}
Chris@10 2392 \def\var#1{%
Chris@10 2393 \let\saveaftersmartic = \aftersmartic
Chris@10 2394 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
Chris@10 2395 \smartslanted{#1}%
Chris@10 2396 }
Chris@10 2397
Chris@10 2398 \let\i=\smartitalic
Chris@10 2399 \let\slanted=\smartslanted
Chris@10 2400 \let\dfn=\smartslanted
Chris@10 2401 \let\emph=\smartitalic
Chris@10 2402
Chris@10 2403 % Explicit font changes: @r, @sc, undocumented @ii.
Chris@10 2404 \def\r#1{{\rm #1}} % roman font
Chris@10 2405 \def\sc#1{{\smallcaps#1}} % smallcaps font
Chris@10 2406 \def\ii#1{{\it #1}} % italic font
Chris@10 2407
Chris@10 2408 % @b, explicit bold. Also @strong.
Chris@10 2409 \def\b#1{{\bf #1}}
Chris@10 2410 \let\strong=\b
Chris@10 2411
Chris@10 2412 % @sansserif, explicit sans.
Chris@10 2413 \def\sansserif#1{{\sf #1}}
Chris@10 2414
Chris@10 2415 % We can't just use \exhyphenpenalty, because that only has effect at
Chris@10 2416 % the end of a paragraph. Restore normal hyphenation at the end of the
Chris@10 2417 % group within which \nohyphenation is presumably called.
Chris@10 2418 %
Chris@10 2419 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
Chris@10 2420 \def\restorehyphenation{\hyphenchar\font = `- }
Chris@10 2421
Chris@10 2422 % Set sfcode to normal for the chars that usually have another value.
Chris@10 2423 % Can't use plain's \frenchspacing because it uses the `\x notation, and
Chris@10 2424 % sometimes \x has an active definition that messes things up.
Chris@10 2425 %
Chris@10 2426 \catcode`@=11
Chris@10 2427 \def\plainfrenchspacing{%
Chris@10 2428 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
Chris@10 2429 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
Chris@10 2430 \def\endofsentencespacefactor{1000}% for @. and friends
Chris@10 2431 }
Chris@10 2432 \def\plainnonfrenchspacing{%
Chris@10 2433 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
Chris@10 2434 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
Chris@10 2435 \def\endofsentencespacefactor{3000}% for @. and friends
Chris@10 2436 }
Chris@10 2437 \catcode`@=\other
Chris@10 2438 \def\endofsentencespacefactor{3000}% default
Chris@10 2439
Chris@10 2440 % @t, explicit typewriter.
Chris@10 2441 \def\t#1{%
Chris@10 2442 {\tt \rawbackslash \plainfrenchspacing #1}%
Chris@10 2443 \null
Chris@10 2444 }
Chris@10 2445
Chris@10 2446 % @samp.
Chris@10 2447 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
Chris@10 2448
Chris@10 2449 % definition of @key that produces a lozenge. Doesn't adjust to text size.
Chris@10 2450 %\setfont\keyrm\rmshape{8}{1000}{OT1}
Chris@10 2451 %\font\keysy=cmsy9
Chris@10 2452 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
Chris@10 2453 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
Chris@10 2454 % \vbox{\hrule\kern-0.4pt
Chris@10 2455 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
Chris@10 2456 % \kern-0.4pt\hrule}%
Chris@10 2457 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
Chris@10 2458
Chris@10 2459 % definition of @key with no lozenge. If the current font is already
Chris@10 2460 % monospace, don't change it; that way, we respect @kbdinputstyle. But
Chris@10 2461 % if it isn't monospace, then use \tt.
Chris@10 2462 %
Chris@10 2463 \def\key#1{{\setupmarkupstyle{key}%
Chris@10 2464 \nohyphenation
Chris@10 2465 \ifmonospace\else\tt\fi
Chris@10 2466 #1}\null}
Chris@10 2467
Chris@10 2468 % ctrl is no longer a Texinfo command.
Chris@10 2469 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
Chris@10 2470
Chris@10 2471 % @file, @option are the same as @samp.
Chris@10 2472 \let\file=\samp
Chris@10 2473 \let\option=\samp
Chris@10 2474
Chris@10 2475 % @code is a modification of @t,
Chris@10 2476 % which makes spaces the same size as normal in the surrounding text.
Chris@10 2477 \def\tclose#1{%
Chris@10 2478 {%
Chris@10 2479 % Change normal interword space to be same as for the current font.
Chris@10 2480 \spaceskip = \fontdimen2\font
Chris@10 2481 %
Chris@10 2482 % Switch to typewriter.
Chris@10 2483 \tt
Chris@10 2484 %
Chris@10 2485 % But `\ ' produces the large typewriter interword space.
Chris@10 2486 \def\ {{\spaceskip = 0pt{} }}%
Chris@10 2487 %
Chris@10 2488 % Turn off hyphenation.
Chris@10 2489 \nohyphenation
Chris@10 2490 %
Chris@10 2491 \rawbackslash
Chris@10 2492 \plainfrenchspacing
Chris@10 2493 #1%
Chris@10 2494 }%
Chris@10 2495 \null % reset spacefactor to 1000
Chris@10 2496 }
Chris@10 2497
Chris@10 2498 % We *must* turn on hyphenation at `-' and `_' in @code.
Chris@10 2499 % Otherwise, it is too hard to avoid overfull hboxes
Chris@10 2500 % in the Emacs manual, the Library manual, etc.
Chris@10 2501
Chris@10 2502 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
Chris@10 2503 % both hyphenation at - and hyphenation within words.
Chris@10 2504 % We must therefore turn them both off (\tclose does that)
Chris@10 2505 % and arrange explicitly to hyphenate at a dash.
Chris@10 2506 % -- rms.
Chris@10 2507 {
Chris@10 2508 \catcode`\-=\active \catcode`\_=\active
Chris@10 2509 \catcode`\'=\active \catcode`\`=\active
Chris@10 2510 \global\let'=\rq \global\let`=\lq % default definitions
Chris@10 2511 %
Chris@10 2512 \global\def\code{\begingroup
Chris@10 2513 \setupmarkupstyle{code}%
Chris@10 2514 % The following should really be moved into \setupmarkupstyle handlers.
Chris@10 2515 \catcode\dashChar=\active \catcode\underChar=\active
Chris@10 2516 \ifallowcodebreaks
Chris@10 2517 \let-\codedash
Chris@10 2518 \let_\codeunder
Chris@10 2519 \else
Chris@10 2520 \let-\realdash
Chris@10 2521 \let_\realunder
Chris@10 2522 \fi
Chris@10 2523 \codex
Chris@10 2524 }
Chris@10 2525 }
Chris@10 2526
Chris@10 2527 \def\codex #1{\tclose{#1}\endgroup}
Chris@10 2528
Chris@10 2529 \def\realdash{-}
Chris@10 2530 \def\codedash{-\discretionary{}{}{}}
Chris@10 2531 \def\codeunder{%
Chris@10 2532 % this is all so @math{@code{var_name}+1} can work. In math mode, _
Chris@10 2533 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
Chris@10 2534 % will therefore expand the active definition of _, which is us
Chris@10 2535 % (inside @code that is), therefore an endless loop.
Chris@10 2536 \ifusingtt{\ifmmode
Chris@10 2537 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
Chris@10 2538 \else\normalunderscore \fi
Chris@10 2539 \discretionary{}{}{}}%
Chris@10 2540 {\_}%
Chris@10 2541 }
Chris@10 2542
Chris@10 2543 % An additional complication: the above will allow breaks after, e.g.,
Chris@10 2544 % each of the four underscores in __typeof__. This is undesirable in
Chris@10 2545 % some manuals, especially if they don't have long identifiers in
Chris@10 2546 % general. @allowcodebreaks provides a way to control this.
Chris@10 2547 %
Chris@10 2548 \newif\ifallowcodebreaks \allowcodebreakstrue
Chris@10 2549
Chris@10 2550 \def\keywordtrue{true}
Chris@10 2551 \def\keywordfalse{false}
Chris@10 2552
Chris@10 2553 \parseargdef\allowcodebreaks{%
Chris@10 2554 \def\txiarg{#1}%
Chris@10 2555 \ifx\txiarg\keywordtrue
Chris@10 2556 \allowcodebreakstrue
Chris@10 2557 \else\ifx\txiarg\keywordfalse
Chris@10 2558 \allowcodebreaksfalse
Chris@10 2559 \else
Chris@10 2560 \errhelp = \EMsimple
Chris@10 2561 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
Chris@10 2562 \fi\fi
Chris@10 2563 }
Chris@10 2564
Chris@10 2565 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
Chris@10 2566 % second argument specifying the text to display and an optional third
Chris@10 2567 % arg as text to display instead of (rather than in addition to) the url
Chris@10 2568 % itself. First (mandatory) arg is the url.
Chris@10 2569 % (This \urefnobreak definition isn't used now, leaving it for a while
Chris@10 2570 % for comparison.)
Chris@10 2571 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
Chris@10 2572 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
Chris@10 2573 \unsepspaces
Chris@10 2574 \pdfurl{#1}%
Chris@10 2575 \setbox0 = \hbox{\ignorespaces #3}%
Chris@10 2576 \ifdim\wd0 > 0pt
Chris@10 2577 \unhbox0 % third arg given, show only that
Chris@10 2578 \else
Chris@10 2579 \setbox0 = \hbox{\ignorespaces #2}%
Chris@10 2580 \ifdim\wd0 > 0pt
Chris@10 2581 \ifpdf
Chris@10 2582 \unhbox0 % PDF: 2nd arg given, show only it
Chris@10 2583 \else
Chris@10 2584 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
Chris@10 2585 \fi
Chris@10 2586 \else
Chris@10 2587 \code{#1}% only url given, so show it
Chris@10 2588 \fi
Chris@10 2589 \fi
Chris@10 2590 \endlink
Chris@10 2591 \endgroup}
Chris@10 2592
Chris@10 2593 % This \urefbreak definition is the active one.
Chris@10 2594 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
Chris@10 2595 \let\uref=\urefbreak
Chris@10 2596 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
Chris@10 2597 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
Chris@10 2598 \unsepspaces
Chris@10 2599 \pdfurl{#1}%
Chris@10 2600 \setbox0 = \hbox{\ignorespaces #3}%
Chris@10 2601 \ifdim\wd0 > 0pt
Chris@10 2602 \unhbox0 % third arg given, show only that
Chris@10 2603 \else
Chris@10 2604 \setbox0 = \hbox{\ignorespaces #2}%
Chris@10 2605 \ifdim\wd0 > 0pt
Chris@10 2606 \ifpdf
Chris@10 2607 \unhbox0 % PDF: 2nd arg given, show only it
Chris@10 2608 \else
Chris@10 2609 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
Chris@10 2610 \fi
Chris@10 2611 \else
Chris@10 2612 \urefcode{#1}% only url given, so show it
Chris@10 2613 \fi
Chris@10 2614 \fi
Chris@10 2615 \endlink
Chris@10 2616 \endgroup}
Chris@10 2617
Chris@10 2618 % Allow line breaks around only a few characters (only).
Chris@10 2619 \def\urefcatcodes{%
Chris@10 2620 \catcode\ampChar=\active \catcode\dotChar=\active
Chris@10 2621 \catcode\hashChar=\active \catcode\questChar=\active
Chris@10 2622 \catcode\slashChar=\active
Chris@10 2623 }
Chris@10 2624 {
Chris@10 2625 \urefcatcodes
Chris@10 2626 %
Chris@10 2627 \global\def\urefcode{\begingroup
Chris@10 2628 \setupmarkupstyle{code}%
Chris@10 2629 \urefcatcodes
Chris@10 2630 \let&\urefcodeamp
Chris@10 2631 \let.\urefcodedot
Chris@10 2632 \let#\urefcodehash
Chris@10 2633 \let?\urefcodequest
Chris@10 2634 \let/\urefcodeslash
Chris@10 2635 \codex
Chris@10 2636 }
Chris@10 2637 %
Chris@10 2638 % By default, they are just regular characters.
Chris@10 2639 \global\def&{\normalamp}
Chris@10 2640 \global\def.{\normaldot}
Chris@10 2641 \global\def#{\normalhash}
Chris@10 2642 \global\def?{\normalquest}
Chris@10 2643 \global\def/{\normalslash}
Chris@10 2644 }
Chris@10 2645
Chris@10 2646 % we put a little stretch before and after the breakable chars, to help
Chris@10 2647 % line breaking of long url's. The unequal skips make look better in
Chris@10 2648 % cmtt at least, especially for dots.
Chris@10 2649 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
Chris@10 2650 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
Chris@10 2651 %
Chris@10 2652 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
Chris@10 2653 \def\urefcodedot{\urefprestretch .\urefpoststretch}
Chris@10 2654 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
Chris@10 2655 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
Chris@10 2656 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
Chris@10 2657 {
Chris@10 2658 \catcode`\/=\active
Chris@10 2659 \global\def\urefcodeslashfinish{%
Chris@10 2660 \urefprestretch \slashChar
Chris@10 2661 % Allow line break only after the final / in a sequence of
Chris@10 2662 % slashes, to avoid line break between the slashes in http://.
Chris@10 2663 \ifx\next/\else \urefpoststretch \fi
Chris@10 2664 }
Chris@10 2665 }
Chris@10 2666
Chris@10 2667 % One more complication: by default we'll break after the special
Chris@10 2668 % characters, but some people like to break before the special chars, so
Chris@10 2669 % allow that. Also allow no breaking at all, for manual control.
Chris@10 2670 %
Chris@10 2671 \parseargdef\urefbreakstyle{%
Chris@10 2672 \def\txiarg{#1}%
Chris@10 2673 \ifx\txiarg\wordnone
Chris@10 2674 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
Chris@10 2675 \else\ifx\txiarg\wordbefore
Chris@10 2676 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
Chris@10 2677 \else\ifx\txiarg\wordafter
Chris@10 2678 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
Chris@10 2679 \else
Chris@10 2680 \errhelp = \EMsimple
Chris@10 2681 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
Chris@10 2682 \fi\fi\fi
Chris@10 2683 }
Chris@10 2684 \def\wordafter{after}
Chris@10 2685 \def\wordbefore{before}
Chris@10 2686 \def\wordnone{none}
Chris@10 2687
Chris@10 2688 \urefbreakstyle after
Chris@10 2689
Chris@10 2690 % @url synonym for @uref, since that's how everyone uses it.
Chris@10 2691 %
Chris@10 2692 \let\url=\uref
Chris@10 2693
Chris@10 2694 % rms does not like angle brackets --karl, 17may97.
Chris@10 2695 % So now @email is just like @uref, unless we are pdf.
Chris@10 2696 %
Chris@10 2697 %\def\email#1{\angleleft{\tt #1}\angleright}
Chris@10 2698 \ifpdf
Chris@10 2699 \def\email#1{\doemail#1,,\finish}
Chris@10 2700 \def\doemail#1,#2,#3\finish{\begingroup
Chris@10 2701 \unsepspaces
Chris@10 2702 \pdfurl{mailto:#1}%
Chris@10 2703 \setbox0 = \hbox{\ignorespaces #2}%
Chris@10 2704 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
Chris@10 2705 \endlink
Chris@10 2706 \endgroup}
Chris@10 2707 \else
Chris@10 2708 \let\email=\uref
Chris@10 2709 \fi
Chris@10 2710
Chris@10 2711 % @kbd is like @code, except that if the argument is just one @key command,
Chris@10 2712 % then @kbd has no effect.
Chris@10 2713 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
Chris@10 2714
Chris@10 2715 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
Chris@10 2716 % `example' (@kbd uses ttsl only inside of @example and friends),
Chris@10 2717 % or `code' (@kbd uses normal tty font always).
Chris@10 2718 \parseargdef\kbdinputstyle{%
Chris@10 2719 \def\txiarg{#1}%
Chris@10 2720 \ifx\txiarg\worddistinct
Chris@10 2721 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
Chris@10 2722 \else\ifx\txiarg\wordexample
Chris@10 2723 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
Chris@10 2724 \else\ifx\txiarg\wordcode
Chris@10 2725 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
Chris@10 2726 \else
Chris@10 2727 \errhelp = \EMsimple
Chris@10 2728 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
Chris@10 2729 \fi\fi\fi
Chris@10 2730 }
Chris@10 2731 \def\worddistinct{distinct}
Chris@10 2732 \def\wordexample{example}
Chris@10 2733 \def\wordcode{code}
Chris@10 2734
Chris@10 2735 % Default is `distinct'.
Chris@10 2736 \kbdinputstyle distinct
Chris@10 2737
Chris@10 2738 \def\xkey{\key}
Chris@10 2739 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
Chris@10 2740 \ifx\one\xkey\ifx\threex\three \key{#2}%
Chris@10 2741 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
Chris@10 2742 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
Chris@10 2743
Chris@10 2744 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
Chris@10 2745 \let\indicateurl=\code
Chris@10 2746 \let\env=\code
Chris@10 2747 \let\command=\code
Chris@10 2748
Chris@10 2749 % @clicksequence{File @click{} Open ...}
Chris@10 2750 \def\clicksequence#1{\begingroup #1\endgroup}
Chris@10 2751
Chris@10 2752 % @clickstyle @arrow (by default)
Chris@10 2753 \parseargdef\clickstyle{\def\click{#1}}
Chris@10 2754 \def\click{\arrow}
Chris@10 2755
Chris@10 2756 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
Chris@10 2757 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
Chris@10 2758 %
Chris@10 2759 \def\dmn#1{\thinspace #1}
Chris@10 2760
Chris@10 2761 % @l was never documented to mean ``switch to the Lisp font'',
Chris@10 2762 % and it is not used as such in any manual I can find. We need it for
Chris@10 2763 % Polish suppressed-l. --karl, 22sep96.
Chris@10 2764 %\def\l#1{{\li #1}\null}
Chris@10 2765
Chris@10 2766 % @acronym for "FBI", "NATO", and the like.
Chris@10 2767 % We print this one point size smaller, since it's intended for
Chris@10 2768 % all-uppercase.
Chris@10 2769 %
Chris@10 2770 \def\acronym#1{\doacronym #1,,\finish}
Chris@10 2771 \def\doacronym#1,#2,#3\finish{%
Chris@10 2772 {\selectfonts\lsize #1}%
Chris@10 2773 \def\temp{#2}%
Chris@10 2774 \ifx\temp\empty \else
Chris@10 2775 \space ({\unsepspaces \ignorespaces \temp \unskip})%
Chris@10 2776 \fi
Chris@10 2777 \null % reset \spacefactor=1000
Chris@10 2778 }
Chris@10 2779
Chris@10 2780 % @abbr for "Comput. J." and the like.
Chris@10 2781 % No font change, but don't do end-of-sentence spacing.
Chris@10 2782 %
Chris@10 2783 \def\abbr#1{\doabbr #1,,\finish}
Chris@10 2784 \def\doabbr#1,#2,#3\finish{%
Chris@10 2785 {\plainfrenchspacing #1}%
Chris@10 2786 \def\temp{#2}%
Chris@10 2787 \ifx\temp\empty \else
Chris@10 2788 \space ({\unsepspaces \ignorespaces \temp \unskip})%
Chris@10 2789 \fi
Chris@10 2790 \null % reset \spacefactor=1000
Chris@10 2791 }
Chris@10 2792
Chris@10 2793 % @asis just yields its argument. Used with @table, for example.
Chris@10 2794 %
Chris@10 2795 \def\asis#1{#1}
Chris@10 2796
Chris@10 2797 % @math outputs its argument in math mode.
Chris@10 2798 %
Chris@10 2799 % One complication: _ usually means subscripts, but it could also mean
Chris@10 2800 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
Chris@10 2801 % _ active, and distinguish by seeing if the current family is \slfam,
Chris@10 2802 % which is what @var uses.
Chris@10 2803 {
Chris@10 2804 \catcode`\_ = \active
Chris@10 2805 \gdef\mathunderscore{%
Chris@10 2806 \catcode`\_=\active
Chris@10 2807 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
Chris@10 2808 }
Chris@10 2809 }
Chris@10 2810 % Another complication: we want \\ (and @\) to output a math (or tt) \.
Chris@10 2811 % FYI, plain.tex uses \\ as a temporary control sequence (for no
Chris@10 2812 % particular reason), but this is not advertised and we don't care.
Chris@10 2813 %
Chris@10 2814 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
Chris@10 2815 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
Chris@10 2816 %
Chris@10 2817 \def\math{%
Chris@10 2818 \tex
Chris@10 2819 \mathunderscore
Chris@10 2820 \let\\ = \mathbackslash
Chris@10 2821 \mathactive
Chris@10 2822 % make the texinfo accent commands work in math mode
Chris@10 2823 \let\"=\ddot
Chris@10 2824 \let\'=\acute
Chris@10 2825 \let\==\bar
Chris@10 2826 \let\^=\hat
Chris@10 2827 \let\`=\grave
Chris@10 2828 \let\u=\breve
Chris@10 2829 \let\v=\check
Chris@10 2830 \let\~=\tilde
Chris@10 2831 \let\dotaccent=\dot
Chris@10 2832 $\finishmath
Chris@10 2833 }
Chris@10 2834 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
Chris@10 2835
Chris@10 2836 % Some active characters (such as <) are spaced differently in math.
Chris@10 2837 % We have to reset their definitions in case the @math was an argument
Chris@10 2838 % to a command which sets the catcodes (such as @item or @section).
Chris@10 2839 %
Chris@10 2840 {
Chris@10 2841 \catcode`^ = \active
Chris@10 2842 \catcode`< = \active
Chris@10 2843 \catcode`> = \active
Chris@10 2844 \catcode`+ = \active
Chris@10 2845 \catcode`' = \active
Chris@10 2846 \gdef\mathactive{%
Chris@10 2847 \let^ = \ptexhat
Chris@10 2848 \let< = \ptexless
Chris@10 2849 \let> = \ptexgtr
Chris@10 2850 \let+ = \ptexplus
Chris@10 2851 \let' = \ptexquoteright
Chris@10 2852 }
Chris@10 2853 }
Chris@10 2854
Chris@10 2855 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
Chris@10 2856 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
Chris@10 2857 % except specified as a normal braced arg, so no newlines to worry about.
Chris@10 2858 %
Chris@10 2859 \def\outfmtnametex{tex}
Chris@10 2860 %
Chris@10 2861 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
Chris@10 2862 \long\def\doinlinefmt#1,#2,\finish{%
Chris@10 2863 \def\inlinefmtname{#1}%
Chris@10 2864 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
Chris@10 2865 }
Chris@10 2866 % For raw, must switch into @tex before parsing the argument, to avoid
Chris@10 2867 % setting catcodes prematurely. Doing it this way means that, for
Chris@10 2868 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
Chris@10 2869 % ignored. But this isn't important because if people want a literal
Chris@10 2870 % *right* brace they would have to use a command anyway, so they may as
Chris@10 2871 % well use a command to get a left brace too. We could re-use the
Chris@10 2872 % delimiter character idea from \verb, but it seems like overkill.
Chris@10 2873 %
Chris@10 2874 \long\def\inlineraw{\tex \doinlineraw}
Chris@10 2875 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
Chris@10 2876 \def\doinlinerawtwo#1,#2,\finish{%
Chris@10 2877 \def\inlinerawname{#1}%
Chris@10 2878 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
Chris@10 2879 \endgroup % close group opened by \tex.
Chris@10 2880 }
Chris@10 2881
Chris@10 2882
Chris@10 2883 \message{glyphs,}
Chris@10 2884 % and logos.
Chris@10 2885
Chris@10 2886 % @@ prints an @, as does @atchar{}.
Chris@10 2887 \def\@{\char64 }
Chris@10 2888 \let\atchar=\@
Chris@10 2889
Chris@10 2890 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
Chris@10 2891 % Unless we're in typewriter, use \ecfont because the CM text fonts do
Chris@10 2892 % not have braces, and we don't want to switch into math.
Chris@10 2893 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
Chris@10 2894 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
Chris@10 2895 \let\{=\mylbrace \let\lbracechar=\{
Chris@10 2896 \let\}=\myrbrace \let\rbracechar=\}
Chris@10 2897 \begingroup
Chris@10 2898 % Definitions to produce \{ and \} commands for indices,
Chris@10 2899 % and @{ and @} for the aux/toc files.
Chris@10 2900 \catcode`\{ = \other \catcode`\} = \other
Chris@10 2901 \catcode`\[ = 1 \catcode`\] = 2
Chris@10 2902 \catcode`\! = 0 \catcode`\\ = \other
Chris@10 2903 !gdef!lbracecmd[\{]%
Chris@10 2904 !gdef!rbracecmd[\}]%
Chris@10 2905 !gdef!lbraceatcmd[@{]%
Chris@10 2906 !gdef!rbraceatcmd[@}]%
Chris@10 2907 !endgroup
Chris@10 2908
Chris@10 2909 % @comma{} to avoid , parsing problems.
Chris@10 2910 \let\comma = ,
Chris@10 2911
Chris@10 2912 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
Chris@10 2913 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
Chris@10 2914 \let\, = \ptexc
Chris@10 2915 \let\dotaccent = \ptexdot
Chris@10 2916 \def\ringaccent#1{{\accent23 #1}}
Chris@10 2917 \let\tieaccent = \ptext
Chris@10 2918 \let\ubaraccent = \ptexb
Chris@10 2919 \let\udotaccent = \d
Chris@10 2920
Chris@10 2921 % Other special characters: @questiondown @exclamdown @ordf @ordm
Chris@10 2922 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
Chris@10 2923 \def\questiondown{?`}
Chris@10 2924 \def\exclamdown{!`}
Chris@10 2925 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
Chris@10 2926 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
Chris@10 2927
Chris@10 2928 % Dotless i and dotless j, used for accents.
Chris@10 2929 \def\imacro{i}
Chris@10 2930 \def\jmacro{j}
Chris@10 2931 \def\dotless#1{%
Chris@10 2932 \def\temp{#1}%
Chris@10 2933 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
Chris@10 2934 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
Chris@10 2935 \else \errmessage{@dotless can be used only with i or j}%
Chris@10 2936 \fi\fi
Chris@10 2937 }
Chris@10 2938
Chris@10 2939 % The \TeX{} logo, as in plain, but resetting the spacing so that a
Chris@10 2940 % period following counts as ending a sentence. (Idea found in latex.)
Chris@10 2941 %
Chris@10 2942 \edef\TeX{\TeX \spacefactor=1000 }
Chris@10 2943
Chris@10 2944 % @LaTeX{} logo. Not quite the same results as the definition in
Chris@10 2945 % latex.ltx, since we use a different font for the raised A; it's most
Chris@10 2946 % convenient for us to use an explicitly smaller font, rather than using
Chris@10 2947 % the \scriptstyle font (since we don't reset \scriptstyle and
Chris@10 2948 % \scriptscriptstyle).
Chris@10 2949 %
Chris@10 2950 \def\LaTeX{%
Chris@10 2951 L\kern-.36em
Chris@10 2952 {\setbox0=\hbox{T}%
Chris@10 2953 \vbox to \ht0{\hbox{%
Chris@10 2954 \ifx\textnominalsize\xwordpt
Chris@10 2955 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
Chris@10 2956 % Revert to plain's \scriptsize, which is 7pt.
Chris@10 2957 \count255=\the\fam $\fam\count255 \scriptstyle A$%
Chris@10 2958 \else
Chris@10 2959 % For 11pt, we can use our lllsize.
Chris@10 2960 \selectfonts\lllsize A%
Chris@10 2961 \fi
Chris@10 2962 }%
Chris@10 2963 \vss
Chris@10 2964 }}%
Chris@10 2965 \kern-.15em
Chris@10 2966 \TeX
Chris@10 2967 }
Chris@10 2968
Chris@10 2969 % Some math mode symbols.
Chris@10 2970 \def\bullet{$\ptexbullet$}
Chris@10 2971 \def\geq{\ifmmode \ge\else $\ge$\fi}
Chris@10 2972 \def\leq{\ifmmode \le\else $\le$\fi}
Chris@10 2973 \def\minus{\ifmmode -\else $-$\fi}
Chris@10 2974
Chris@10 2975 % @dots{} outputs an ellipsis using the current font.
Chris@10 2976 % We do .5em per period so that it has the same spacing in the cm
Chris@10 2977 % typewriter fonts as three actual period characters; on the other hand,
Chris@10 2978 % in other typewriter fonts three periods are wider than 1.5em. So do
Chris@10 2979 % whichever is larger.
Chris@10 2980 %
Chris@10 2981 \def\dots{%
Chris@10 2982 \leavevmode
Chris@10 2983 \setbox0=\hbox{...}% get width of three periods
Chris@10 2984 \ifdim\wd0 > 1.5em
Chris@10 2985 \dimen0 = \wd0
Chris@10 2986 \else
Chris@10 2987 \dimen0 = 1.5em
Chris@10 2988 \fi
Chris@10 2989 \hbox to \dimen0{%
Chris@10 2990 \hskip 0pt plus.25fil
Chris@10 2991 .\hskip 0pt plus1fil
Chris@10 2992 .\hskip 0pt plus1fil
Chris@10 2993 .\hskip 0pt plus.5fil
Chris@10 2994 }%
Chris@10 2995 }
Chris@10 2996
Chris@10 2997 % @enddots{} is an end-of-sentence ellipsis.
Chris@10 2998 %
Chris@10 2999 \def\enddots{%
Chris@10 3000 \dots
Chris@10 3001 \spacefactor=\endofsentencespacefactor
Chris@10 3002 }
Chris@10 3003
Chris@10 3004 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
Chris@10 3005 %
Chris@10 3006 % Since these characters are used in examples, they should be an even number of
Chris@10 3007 % \tt widths. Each \tt character is 1en, so two makes it 1em.
Chris@10 3008 %
Chris@10 3009 \def\point{$\star$}
Chris@10 3010 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
Chris@10 3011 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
Chris@10 3012 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
Chris@10 3013 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
Chris@10 3014 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
Chris@10 3015
Chris@10 3016 % The @error{} command.
Chris@10 3017 % Adapted from the TeXbook's \boxit.
Chris@10 3018 %
Chris@10 3019 \newbox\errorbox
Chris@10 3020 %
Chris@10 3021 {\tentt \global\dimen0 = 3em}% Width of the box.
Chris@10 3022 \dimen2 = .55pt % Thickness of rules
Chris@10 3023 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
Chris@10 3024 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
Chris@10 3025 %
Chris@10 3026 \setbox\errorbox=\hbox to \dimen0{\hfil
Chris@10 3027 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
Chris@10 3028 \advance\hsize by -2\dimen2 % Rules.
Chris@10 3029 \vbox{%
Chris@10 3030 \hrule height\dimen2
Chris@10 3031 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
Chris@10 3032 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
Chris@10 3033 \kern3pt\vrule width\dimen2}% Space to right.
Chris@10 3034 \hrule height\dimen2}
Chris@10 3035 \hfil}
Chris@10 3036 %
Chris@10 3037 \def\error{\leavevmode\lower.7ex\copy\errorbox}
Chris@10 3038
Chris@10 3039 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
Chris@10 3040 %
Chris@10 3041 \def\pounds{{\it\$}}
Chris@10 3042
Chris@10 3043 % @euro{} comes from a separate font, depending on the current style.
Chris@10 3044 % We use the free feym* fonts from the eurosym package by Henrik
Chris@10 3045 % Theiling, which support regular, slanted, bold and bold slanted (and
Chris@10 3046 % "outlined" (blackboard board, sort of) versions, which we don't need).
Chris@10 3047 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
Chris@10 3048 %
Chris@10 3049 % Although only regular is the truly official Euro symbol, we ignore
Chris@10 3050 % that. The Euro is designed to be slightly taller than the regular
Chris@10 3051 % font height.
Chris@10 3052 %
Chris@10 3053 % feymr - regular
Chris@10 3054 % feymo - slanted
Chris@10 3055 % feybr - bold
Chris@10 3056 % feybo - bold slanted
Chris@10 3057 %
Chris@10 3058 % There is no good (free) typewriter version, to my knowledge.
Chris@10 3059 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
Chris@10 3060 % Hmm.
Chris@10 3061 %
Chris@10 3062 % Also doesn't work in math. Do we need to do math with euro symbols?
Chris@10 3063 % Hope not.
Chris@10 3064 %
Chris@10 3065 %
Chris@10 3066 \def\euro{{\eurofont e}}
Chris@10 3067 \def\eurofont{%
Chris@10 3068 % We set the font at each command, rather than predefining it in
Chris@10 3069 % \textfonts and the other font-switching commands, so that
Chris@10 3070 % installations which never need the symbol don't have to have the
Chris@10 3071 % font installed.
Chris@10 3072 %
Chris@10 3073 % There is only one designed size (nominal 10pt), so we always scale
Chris@10 3074 % that to the current nominal size.
Chris@10 3075 %
Chris@10 3076 % By the way, simply using "at 1em" works for cmr10 and the like, but
Chris@10 3077 % does not work for cmbx10 and other extended/shrunken fonts.
Chris@10 3078 %
Chris@10 3079 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
Chris@10 3080 %
Chris@10 3081 \ifx\curfontstyle\bfstylename
Chris@10 3082 % bold:
Chris@10 3083 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
Chris@10 3084 \else
Chris@10 3085 % regular:
Chris@10 3086 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
Chris@10 3087 \fi
Chris@10 3088 \thiseurofont
Chris@10 3089 }
Chris@10 3090
Chris@10 3091 % Glyphs from the EC fonts. We don't use \let for the aliases, because
Chris@10 3092 % sometimes we redefine the original macro, and the alias should reflect
Chris@10 3093 % the redefinition.
Chris@10 3094 %
Chris@10 3095 % Use LaTeX names for the Icelandic letters.
Chris@10 3096 \def\DH{{\ecfont \char"D0}} % Eth
Chris@10 3097 \def\dh{{\ecfont \char"F0}} % eth
Chris@10 3098 \def\TH{{\ecfont \char"DE}} % Thorn
Chris@10 3099 \def\th{{\ecfont \char"FE}} % thorn
Chris@10 3100 %
Chris@10 3101 \def\guillemetleft{{\ecfont \char"13}}
Chris@10 3102 \def\guillemotleft{\guillemetleft}
Chris@10 3103 \def\guillemetright{{\ecfont \char"14}}
Chris@10 3104 \def\guillemotright{\guillemetright}
Chris@10 3105 \def\guilsinglleft{{\ecfont \char"0E}}
Chris@10 3106 \def\guilsinglright{{\ecfont \char"0F}}
Chris@10 3107 \def\quotedblbase{{\ecfont \char"12}}
Chris@10 3108 \def\quotesinglbase{{\ecfont \char"0D}}
Chris@10 3109 %
Chris@10 3110 % This positioning is not perfect (see the ogonek LaTeX package), but
Chris@10 3111 % we have the precomposed glyphs for the most common cases. We put the
Chris@10 3112 % tests to use those glyphs in the single \ogonek macro so we have fewer
Chris@10 3113 % dummy definitions to worry about for index entries, etc.
Chris@10 3114 %
Chris@10 3115 % ogonek is also used with other letters in Lithuanian (IOU), but using
Chris@10 3116 % the precomposed glyphs for those is not so easy since they aren't in
Chris@10 3117 % the same EC font.
Chris@10 3118 \def\ogonek#1{{%
Chris@10 3119 \def\temp{#1}%
Chris@10 3120 \ifx\temp\macrocharA\Aogonek
Chris@10 3121 \else\ifx\temp\macrochara\aogonek
Chris@10 3122 \else\ifx\temp\macrocharE\Eogonek
Chris@10 3123 \else\ifx\temp\macrochare\eogonek
Chris@10 3124 \else
Chris@10 3125 \ecfont \setbox0=\hbox{#1}%
Chris@10 3126 \ifdim\ht0=1ex\accent"0C #1%
Chris@10 3127 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
Chris@10 3128 \fi
Chris@10 3129 \fi\fi\fi\fi
Chris@10 3130 }%
Chris@10 3131 }
Chris@10 3132 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
Chris@10 3133 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
Chris@10 3134 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
Chris@10 3135 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
Chris@10 3136 %
Chris@10 3137 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
Chris@10 3138 \def\ecfont{%
Chris@10 3139 % We can't distinguish serif/sans and italic/slanted, but this
Chris@10 3140 % is used for crude hacks anyway (like adding French and German
Chris@10 3141 % quotes to documents typeset with CM, where we lose kerning), so
Chris@10 3142 % hopefully nobody will notice/care.
Chris@10 3143 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
Chris@10 3144 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
Chris@10 3145 \ifx\curfontstyle\bfstylename
Chris@10 3146 % bold:
Chris@10 3147 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
Chris@10 3148 \else
Chris@10 3149 % regular:
Chris@10 3150 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
Chris@10 3151 \fi
Chris@10 3152 \thisecfont
Chris@10 3153 }
Chris@10 3154
Chris@10 3155 % @registeredsymbol - R in a circle. The font for the R should really
Chris@10 3156 % be smaller yet, but lllsize is the best we can do for now.
Chris@10 3157 % Adapted from the plain.tex definition of \copyright.
Chris@10 3158 %
Chris@10 3159 \def\registeredsymbol{%
Chris@10 3160 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
Chris@10 3161 \hfil\crcr\Orb}}%
Chris@10 3162 }$%
Chris@10 3163 }
Chris@10 3164
Chris@10 3165 % @textdegree - the normal degrees sign.
Chris@10 3166 %
Chris@10 3167 \def\textdegree{$^\circ$}
Chris@10 3168
Chris@10 3169 % Laurent Siebenmann reports \Orb undefined with:
Chris@10 3170 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
Chris@10 3171 % so we'll define it if necessary.
Chris@10 3172 %
Chris@10 3173 \ifx\Orb\thisisundefined
Chris@10 3174 \def\Orb{\mathhexbox20D}
Chris@10 3175 \fi
Chris@10 3176
Chris@10 3177 % Quotes.
Chris@10 3178 \chardef\quotedblleft="5C
Chris@10 3179 \chardef\quotedblright=`\"
Chris@10 3180 \chardef\quoteleft=`\`
Chris@10 3181 \chardef\quoteright=`\'
Chris@10 3182
Chris@10 3183
Chris@10 3184 \message{page headings,}
Chris@10 3185
Chris@10 3186 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
Chris@10 3187 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
Chris@10 3188
Chris@10 3189 % First the title page. Must do @settitle before @titlepage.
Chris@10 3190 \newif\ifseenauthor
Chris@10 3191 \newif\iffinishedtitlepage
Chris@10 3192
Chris@10 3193 % Do an implicit @contents or @shortcontents after @end titlepage if the
Chris@10 3194 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
Chris@10 3195 %
Chris@10 3196 \newif\ifsetcontentsaftertitlepage
Chris@10 3197 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
Chris@10 3198 \newif\ifsetshortcontentsaftertitlepage
Chris@10 3199 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
Chris@10 3200
Chris@10 3201 \parseargdef\shorttitlepage{%
Chris@10 3202 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
Chris@10 3203 \endgroup\page\hbox{}\page}
Chris@10 3204
Chris@10 3205 \envdef\titlepage{%
Chris@10 3206 % Open one extra group, as we want to close it in the middle of \Etitlepage.
Chris@10 3207 \begingroup
Chris@10 3208 \parindent=0pt \textfonts
Chris@10 3209 % Leave some space at the very top of the page.
Chris@10 3210 \vglue\titlepagetopglue
Chris@10 3211 % No rule at page bottom unless we print one at the top with @title.
Chris@10 3212 \finishedtitlepagetrue
Chris@10 3213 %
Chris@10 3214 % Most title ``pages'' are actually two pages long, with space
Chris@10 3215 % at the top of the second. We don't want the ragged left on the second.
Chris@10 3216 \let\oldpage = \page
Chris@10 3217 \def\page{%
Chris@10 3218 \iffinishedtitlepage\else
Chris@10 3219 \finishtitlepage
Chris@10 3220 \fi
Chris@10 3221 \let\page = \oldpage
Chris@10 3222 \page
Chris@10 3223 \null
Chris@10 3224 }%
Chris@10 3225 }
Chris@10 3226
Chris@10 3227 \def\Etitlepage{%
Chris@10 3228 \iffinishedtitlepage\else
Chris@10 3229 \finishtitlepage
Chris@10 3230 \fi
Chris@10 3231 % It is important to do the page break before ending the group,
Chris@10 3232 % because the headline and footline are only empty inside the group.
Chris@10 3233 % If we use the new definition of \page, we always get a blank page
Chris@10 3234 % after the title page, which we certainly don't want.
Chris@10 3235 \oldpage
Chris@10 3236 \endgroup
Chris@10 3237 %
Chris@10 3238 % Need this before the \...aftertitlepage checks so that if they are
Chris@10 3239 % in effect the toc pages will come out with page numbers.
Chris@10 3240 \HEADINGSon
Chris@10 3241 %
Chris@10 3242 % If they want short, they certainly want long too.
Chris@10 3243 \ifsetshortcontentsaftertitlepage
Chris@10 3244 \shortcontents
Chris@10 3245 \contents
Chris@10 3246 \global\let\shortcontents = \relax
Chris@10 3247 \global\let\contents = \relax
Chris@10 3248 \fi
Chris@10 3249 %
Chris@10 3250 \ifsetcontentsaftertitlepage
Chris@10 3251 \contents
Chris@10 3252 \global\let\contents = \relax
Chris@10 3253 \global\let\shortcontents = \relax
Chris@10 3254 \fi
Chris@10 3255 }
Chris@10 3256
Chris@10 3257 \def\finishtitlepage{%
Chris@10 3258 \vskip4pt \hrule height 2pt width \hsize
Chris@10 3259 \vskip\titlepagebottomglue
Chris@10 3260 \finishedtitlepagetrue
Chris@10 3261 }
Chris@10 3262
Chris@10 3263 % Macros to be used within @titlepage:
Chris@10 3264
Chris@10 3265 \let\subtitlerm=\tenrm
Chris@10 3266 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
Chris@10 3267
Chris@10 3268 \parseargdef\title{%
Chris@10 3269 \checkenv\titlepage
Chris@10 3270 \leftline{\titlefonts\rmisbold #1}
Chris@10 3271 % print a rule at the page bottom also.
Chris@10 3272 \finishedtitlepagefalse
Chris@10 3273 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
Chris@10 3274 }
Chris@10 3275
Chris@10 3276 \parseargdef\subtitle{%
Chris@10 3277 \checkenv\titlepage
Chris@10 3278 {\subtitlefont \rightline{#1}}%
Chris@10 3279 }
Chris@10 3280
Chris@10 3281 % @author should come last, but may come many times.
Chris@10 3282 % It can also be used inside @quotation.
Chris@10 3283 %
Chris@10 3284 \parseargdef\author{%
Chris@10 3285 \def\temp{\quotation}%
Chris@10 3286 \ifx\thisenv\temp
Chris@10 3287 \def\quotationauthor{#1}% printed in \Equotation.
Chris@10 3288 \else
Chris@10 3289 \checkenv\titlepage
Chris@10 3290 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
Chris@10 3291 {\secfonts\rmisbold \leftline{#1}}%
Chris@10 3292 \fi
Chris@10 3293 }
Chris@10 3294
Chris@10 3295
Chris@10 3296 % Set up page headings and footings.
Chris@10 3297
Chris@10 3298 \let\thispage=\folio
Chris@10 3299
Chris@10 3300 \newtoks\evenheadline % headline on even pages
Chris@10 3301 \newtoks\oddheadline % headline on odd pages
Chris@10 3302 \newtoks\evenfootline % footline on even pages
Chris@10 3303 \newtoks\oddfootline % footline on odd pages
Chris@10 3304
Chris@10 3305 % Now make TeX use those variables
Chris@10 3306 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
Chris@10 3307 \else \the\evenheadline \fi}}
Chris@10 3308 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
Chris@10 3309 \else \the\evenfootline \fi}\HEADINGShook}
Chris@10 3310 \let\HEADINGShook=\relax
Chris@10 3311
Chris@10 3312 % Commands to set those variables.
Chris@10 3313 % For example, this is what @headings on does
Chris@10 3314 % @evenheading @thistitle|@thispage|@thischapter
Chris@10 3315 % @oddheading @thischapter|@thispage|@thistitle
Chris@10 3316 % @evenfooting @thisfile||
Chris@10 3317 % @oddfooting ||@thisfile
Chris@10 3318
Chris@10 3319
Chris@10 3320 \def\evenheading{\parsearg\evenheadingxxx}
Chris@10 3321 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
Chris@10 3322 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
Chris@10 3323 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
Chris@10 3324
Chris@10 3325 \def\oddheading{\parsearg\oddheadingxxx}
Chris@10 3326 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
Chris@10 3327 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
Chris@10 3328 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
Chris@10 3329
Chris@10 3330 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
Chris@10 3331
Chris@10 3332 \def\evenfooting{\parsearg\evenfootingxxx}
Chris@10 3333 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
Chris@10 3334 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
Chris@10 3335 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
Chris@10 3336
Chris@10 3337 \def\oddfooting{\parsearg\oddfootingxxx}
Chris@10 3338 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
Chris@10 3339 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
Chris@10 3340 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
Chris@10 3341 %
Chris@10 3342 % Leave some space for the footline. Hopefully ok to assume
Chris@10 3343 % @evenfooting will not be used by itself.
Chris@10 3344 \global\advance\pageheight by -12pt
Chris@10 3345 \global\advance\vsize by -12pt
Chris@10 3346 }
Chris@10 3347
Chris@10 3348 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
Chris@10 3349
Chris@10 3350 % @evenheadingmarks top \thischapter <- chapter at the top of a page
Chris@10 3351 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
Chris@10 3352 %
Chris@10 3353 % The same set of arguments for:
Chris@10 3354 %
Chris@10 3355 % @oddheadingmarks
Chris@10 3356 % @evenfootingmarks
Chris@10 3357 % @oddfootingmarks
Chris@10 3358 % @everyheadingmarks
Chris@10 3359 % @everyfootingmarks
Chris@10 3360
Chris@10 3361 \def\evenheadingmarks{\headingmarks{even}{heading}}
Chris@10 3362 \def\oddheadingmarks{\headingmarks{odd}{heading}}
Chris@10 3363 \def\evenfootingmarks{\headingmarks{even}{footing}}
Chris@10 3364 \def\oddfootingmarks{\headingmarks{odd}{footing}}
Chris@10 3365 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
Chris@10 3366 \headingmarks{odd}{heading}{#1} }
Chris@10 3367 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
Chris@10 3368 \headingmarks{odd}{footing}{#1} }
Chris@10 3369 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
Chris@10 3370 \def\headingmarks#1#2#3 {%
Chris@10 3371 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
Chris@10 3372 \global\expandafter\let\csname get#1#2marks\endcsname \temp
Chris@10 3373 }
Chris@10 3374
Chris@10 3375 \everyheadingmarks bottom
Chris@10 3376 \everyfootingmarks bottom
Chris@10 3377
Chris@10 3378 % @headings double turns headings on for double-sided printing.
Chris@10 3379 % @headings single turns headings on for single-sided printing.
Chris@10 3380 % @headings off turns them off.
Chris@10 3381 % @headings on same as @headings double, retained for compatibility.
Chris@10 3382 % @headings after turns on double-sided headings after this page.
Chris@10 3383 % @headings doubleafter turns on double-sided headings after this page.
Chris@10 3384 % @headings singleafter turns on single-sided headings after this page.
Chris@10 3385 % By default, they are off at the start of a document,
Chris@10 3386 % and turned `on' after @end titlepage.
Chris@10 3387
Chris@10 3388 \def\headings #1 {\csname HEADINGS#1\endcsname}
Chris@10 3389
Chris@10 3390 \def\headingsoff{% non-global headings elimination
Chris@10 3391 \evenheadline={\hfil}\evenfootline={\hfil}%
Chris@10 3392 \oddheadline={\hfil}\oddfootline={\hfil}%
Chris@10 3393 }
Chris@10 3394
Chris@10 3395 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
Chris@10 3396 \HEADINGSoff % it's the default
Chris@10 3397
Chris@10 3398 % When we turn headings on, set the page number to 1.
Chris@10 3399 % For double-sided printing, put current file name in lower left corner,
Chris@10 3400 % chapter name on inside top of right hand pages, document
Chris@10 3401 % title on inside top of left hand pages, and page numbers on outside top
Chris@10 3402 % edge of all pages.
Chris@10 3403 \def\HEADINGSdouble{%
Chris@10 3404 \global\pageno=1
Chris@10 3405 \global\evenfootline={\hfil}
Chris@10 3406 \global\oddfootline={\hfil}
Chris@10 3407 \global\evenheadline={\line{\folio\hfil\thistitle}}
Chris@10 3408 \global\oddheadline={\line{\thischapter\hfil\folio}}
Chris@10 3409 \global\let\contentsalignmacro = \chapoddpage
Chris@10 3410 }
Chris@10 3411 \let\contentsalignmacro = \chappager
Chris@10 3412
Chris@10 3413 % For single-sided printing, chapter title goes across top left of page,
Chris@10 3414 % page number on top right.
Chris@10 3415 \def\HEADINGSsingle{%
Chris@10 3416 \global\pageno=1
Chris@10 3417 \global\evenfootline={\hfil}
Chris@10 3418 \global\oddfootline={\hfil}
Chris@10 3419 \global\evenheadline={\line{\thischapter\hfil\folio}}
Chris@10 3420 \global\oddheadline={\line{\thischapter\hfil\folio}}
Chris@10 3421 \global\let\contentsalignmacro = \chappager
Chris@10 3422 }
Chris@10 3423 \def\HEADINGSon{\HEADINGSdouble}
Chris@10 3424
Chris@10 3425 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
Chris@10 3426 \let\HEADINGSdoubleafter=\HEADINGSafter
Chris@10 3427 \def\HEADINGSdoublex{%
Chris@10 3428 \global\evenfootline={\hfil}
Chris@10 3429 \global\oddfootline={\hfil}
Chris@10 3430 \global\evenheadline={\line{\folio\hfil\thistitle}}
Chris@10 3431 \global\oddheadline={\line{\thischapter\hfil\folio}}
Chris@10 3432 \global\let\contentsalignmacro = \chapoddpage
Chris@10 3433 }
Chris@10 3434
Chris@10 3435 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
Chris@10 3436 \def\HEADINGSsinglex{%
Chris@10 3437 \global\evenfootline={\hfil}
Chris@10 3438 \global\oddfootline={\hfil}
Chris@10 3439 \global\evenheadline={\line{\thischapter\hfil\folio}}
Chris@10 3440 \global\oddheadline={\line{\thischapter\hfil\folio}}
Chris@10 3441 \global\let\contentsalignmacro = \chappager
Chris@10 3442 }
Chris@10 3443
Chris@10 3444 % Subroutines used in generating headings
Chris@10 3445 % This produces Day Month Year style of output.
Chris@10 3446 % Only define if not already defined, in case a txi-??.tex file has set
Chris@10 3447 % up a different format (e.g., txi-cs.tex does this).
Chris@10 3448 \ifx\today\thisisundefined
Chris@10 3449 \def\today{%
Chris@10 3450 \number\day\space
Chris@10 3451 \ifcase\month
Chris@10 3452 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
Chris@10 3453 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
Chris@10 3454 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
Chris@10 3455 \fi
Chris@10 3456 \space\number\year}
Chris@10 3457 \fi
Chris@10 3458
Chris@10 3459 % @settitle line... specifies the title of the document, for headings.
Chris@10 3460 % It generates no output of its own.
Chris@10 3461 \def\thistitle{\putwordNoTitle}
Chris@10 3462 \def\settitle{\parsearg{\gdef\thistitle}}
Chris@10 3463
Chris@10 3464
Chris@10 3465 \message{tables,}
Chris@10 3466 % Tables -- @table, @ftable, @vtable, @item(x).
Chris@10 3467
Chris@10 3468 % default indentation of table text
Chris@10 3469 \newdimen\tableindent \tableindent=.8in
Chris@10 3470 % default indentation of @itemize and @enumerate text
Chris@10 3471 \newdimen\itemindent \itemindent=.3in
Chris@10 3472 % margin between end of table item and start of table text.
Chris@10 3473 \newdimen\itemmargin \itemmargin=.1in
Chris@10 3474
Chris@10 3475 % used internally for \itemindent minus \itemmargin
Chris@10 3476 \newdimen\itemmax
Chris@10 3477
Chris@10 3478 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
Chris@10 3479 % these defs.
Chris@10 3480 % They also define \itemindex
Chris@10 3481 % to index the item name in whatever manner is desired (perhaps none).
Chris@10 3482
Chris@10 3483 \newif\ifitemxneedsnegativevskip
Chris@10 3484
Chris@10 3485 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
Chris@10 3486
Chris@10 3487 \def\internalBitem{\smallbreak \parsearg\itemzzz}
Chris@10 3488 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
Chris@10 3489
Chris@10 3490 \def\itemzzz #1{\begingroup %
Chris@10 3491 \advance\hsize by -\rightskip
Chris@10 3492 \advance\hsize by -\tableindent
Chris@10 3493 \setbox0=\hbox{\itemindicate{#1}}%
Chris@10 3494 \itemindex{#1}%
Chris@10 3495 \nobreak % This prevents a break before @itemx.
Chris@10 3496 %
Chris@10 3497 % If the item text does not fit in the space we have, put it on a line
Chris@10 3498 % by itself, and do not allow a page break either before or after that
Chris@10 3499 % line. We do not start a paragraph here because then if the next
Chris@10 3500 % command is, e.g., @kindex, the whatsit would get put into the
Chris@10 3501 % horizontal list on a line by itself, resulting in extra blank space.
Chris@10 3502 \ifdim \wd0>\itemmax
Chris@10 3503 %
Chris@10 3504 % Make this a paragraph so we get the \parskip glue and wrapping,
Chris@10 3505 % but leave it ragged-right.
Chris@10 3506 \begingroup
Chris@10 3507 \advance\leftskip by-\tableindent
Chris@10 3508 \advance\hsize by\tableindent
Chris@10 3509 \advance\rightskip by0pt plus1fil\relax
Chris@10 3510 \leavevmode\unhbox0\par
Chris@10 3511 \endgroup
Chris@10 3512 %
Chris@10 3513 % We're going to be starting a paragraph, but we don't want the
Chris@10 3514 % \parskip glue -- logically it's part of the @item we just started.
Chris@10 3515 \nobreak \vskip-\parskip
Chris@10 3516 %
Chris@10 3517 % Stop a page break at the \parskip glue coming up. However, if
Chris@10 3518 % what follows is an environment such as @example, there will be no
Chris@10 3519 % \parskip glue; then the negative vskip we just inserted would
Chris@10 3520 % cause the example and the item to crash together. So we use this
Chris@10 3521 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
Chris@10 3522 % \parskip glue after all. Section titles are handled this way also.
Chris@10 3523 %
Chris@10 3524 \penalty 10001
Chris@10 3525 \endgroup
Chris@10 3526 \itemxneedsnegativevskipfalse
Chris@10 3527 \else
Chris@10 3528 % The item text fits into the space. Start a paragraph, so that the
Chris@10 3529 % following text (if any) will end up on the same line.
Chris@10 3530 \noindent
Chris@10 3531 % Do this with kerns and \unhbox so that if there is a footnote in
Chris@10 3532 % the item text, it can migrate to the main vertical list and
Chris@10 3533 % eventually be printed.
Chris@10 3534 \nobreak\kern-\tableindent
Chris@10 3535 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
Chris@10 3536 \unhbox0
Chris@10 3537 \nobreak\kern\dimen0
Chris@10 3538 \endgroup
Chris@10 3539 \itemxneedsnegativevskiptrue
Chris@10 3540 \fi
Chris@10 3541 }
Chris@10 3542
Chris@10 3543 \def\item{\errmessage{@item while not in a list environment}}
Chris@10 3544 \def\itemx{\errmessage{@itemx while not in a list environment}}
Chris@10 3545
Chris@10 3546 % @table, @ftable, @vtable.
Chris@10 3547 \envdef\table{%
Chris@10 3548 \let\itemindex\gobble
Chris@10 3549 \tablecheck{table}%
Chris@10 3550 }
Chris@10 3551 \envdef\ftable{%
Chris@10 3552 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
Chris@10 3553 \tablecheck{ftable}%
Chris@10 3554 }
Chris@10 3555 \envdef\vtable{%
Chris@10 3556 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
Chris@10 3557 \tablecheck{vtable}%
Chris@10 3558 }
Chris@10 3559 \def\tablecheck#1{%
Chris@10 3560 \ifnum \the\catcode`\^^M=\active
Chris@10 3561 \endgroup
Chris@10 3562 \errmessage{This command won't work in this context; perhaps the problem is
Chris@10 3563 that we are \inenvironment\thisenv}%
Chris@10 3564 \def\next{\doignore{#1}}%
Chris@10 3565 \else
Chris@10 3566 \let\next\tablex
Chris@10 3567 \fi
Chris@10 3568 \next
Chris@10 3569 }
Chris@10 3570 \def\tablex#1{%
Chris@10 3571 \def\itemindicate{#1}%
Chris@10 3572 \parsearg\tabley
Chris@10 3573 }
Chris@10 3574 \def\tabley#1{%
Chris@10 3575 {%
Chris@10 3576 \makevalueexpandable
Chris@10 3577 \edef\temp{\noexpand\tablez #1\space\space\space}%
Chris@10 3578 \expandafter
Chris@10 3579 }\temp \endtablez
Chris@10 3580 }
Chris@10 3581 \def\tablez #1 #2 #3 #4\endtablez{%
Chris@10 3582 \aboveenvbreak
Chris@10 3583 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
Chris@10 3584 \ifnum 0#2>0 \tableindent=#2\mil \fi
Chris@10 3585 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
Chris@10 3586 \itemmax=\tableindent
Chris@10 3587 \advance \itemmax by -\itemmargin
Chris@10 3588 \advance \leftskip by \tableindent
Chris@10 3589 \exdentamount=\tableindent
Chris@10 3590 \parindent = 0pt
Chris@10 3591 \parskip = \smallskipamount
Chris@10 3592 \ifdim \parskip=0pt \parskip=2pt \fi
Chris@10 3593 \let\item = \internalBitem
Chris@10 3594 \let\itemx = \internalBitemx
Chris@10 3595 }
Chris@10 3596 \def\Etable{\endgraf\afterenvbreak}
Chris@10 3597 \let\Eftable\Etable
Chris@10 3598 \let\Evtable\Etable
Chris@10 3599 \let\Eitemize\Etable
Chris@10 3600 \let\Eenumerate\Etable
Chris@10 3601
Chris@10 3602 % This is the counter used by @enumerate, which is really @itemize
Chris@10 3603
Chris@10 3604 \newcount \itemno
Chris@10 3605
Chris@10 3606 \envdef\itemize{\parsearg\doitemize}
Chris@10 3607
Chris@10 3608 \def\doitemize#1{%
Chris@10 3609 \aboveenvbreak
Chris@10 3610 \itemmax=\itemindent
Chris@10 3611 \advance\itemmax by -\itemmargin
Chris@10 3612 \advance\leftskip by \itemindent
Chris@10 3613 \exdentamount=\itemindent
Chris@10 3614 \parindent=0pt
Chris@10 3615 \parskip=\smallskipamount
Chris@10 3616 \ifdim\parskip=0pt \parskip=2pt \fi
Chris@10 3617 %
Chris@10 3618 % Try typesetting the item mark that if the document erroneously says
Chris@10 3619 % something like @itemize @samp (intending @table), there's an error
Chris@10 3620 % right away at the @itemize. It's not the best error message in the
Chris@10 3621 % world, but it's better than leaving it to the @item. This means if
Chris@10 3622 % the user wants an empty mark, they have to say @w{} not just @w.
Chris@10 3623 \def\itemcontents{#1}%
Chris@10 3624 \setbox0 = \hbox{\itemcontents}%
Chris@10 3625 %
Chris@10 3626 % @itemize with no arg is equivalent to @itemize @bullet.
Chris@10 3627 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
Chris@10 3628 %
Chris@10 3629 \let\item=\itemizeitem
Chris@10 3630 }
Chris@10 3631
Chris@10 3632 % Definition of @item while inside @itemize and @enumerate.
Chris@10 3633 %
Chris@10 3634 \def\itemizeitem{%
Chris@10 3635 \advance\itemno by 1 % for enumerations
Chris@10 3636 {\let\par=\endgraf \smallbreak}% reasonable place to break
Chris@10 3637 {%
Chris@10 3638 % If the document has an @itemize directly after a section title, a
Chris@10 3639 % \nobreak will be last on the list, and \sectionheading will have
Chris@10 3640 % done a \vskip-\parskip. In that case, we don't want to zero
Chris@10 3641 % parskip, or the item text will crash with the heading. On the
Chris@10 3642 % other hand, when there is normal text preceding the item (as there
Chris@10 3643 % usually is), we do want to zero parskip, or there would be too much
Chris@10 3644 % space. In that case, we won't have a \nobreak before. At least
Chris@10 3645 % that's the theory.
Chris@10 3646 \ifnum\lastpenalty<10000 \parskip=0in \fi
Chris@10 3647 \noindent
Chris@10 3648 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
Chris@10 3649 %
Chris@10 3650 \vadjust{\penalty 1200}}% not good to break after first line of item.
Chris@10 3651 \flushcr
Chris@10 3652 }
Chris@10 3653
Chris@10 3654 % \splitoff TOKENS\endmark defines \first to be the first token in
Chris@10 3655 % TOKENS, and \rest to be the remainder.
Chris@10 3656 %
Chris@10 3657 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
Chris@10 3658
Chris@10 3659 % Allow an optional argument of an uppercase letter, lowercase letter,
Chris@10 3660 % or number, to specify the first label in the enumerated list. No
Chris@10 3661 % argument is the same as `1'.
Chris@10 3662 %
Chris@10 3663 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
Chris@10 3664 \def\enumeratey #1 #2\endenumeratey{%
Chris@10 3665 % If we were given no argument, pretend we were given `1'.
Chris@10 3666 \def\thearg{#1}%
Chris@10 3667 \ifx\thearg\empty \def\thearg{1}\fi
Chris@10 3668 %
Chris@10 3669 % Detect if the argument is a single token. If so, it might be a
Chris@10 3670 % letter. Otherwise, the only valid thing it can be is a number.
Chris@10 3671 % (We will always have one token, because of the test we just made.
Chris@10 3672 % This is a good thing, since \splitoff doesn't work given nothing at
Chris@10 3673 % all -- the first parameter is undelimited.)
Chris@10 3674 \expandafter\splitoff\thearg\endmark
Chris@10 3675 \ifx\rest\empty
Chris@10 3676 % Only one token in the argument. It could still be anything.
Chris@10 3677 % A ``lowercase letter'' is one whose \lccode is nonzero.
Chris@10 3678 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
Chris@10 3679 % not equal to itself.
Chris@10 3680 % Otherwise, we assume it's a number.
Chris@10 3681 %
Chris@10 3682 % We need the \relax at the end of the \ifnum lines to stop TeX from
Chris@10 3683 % continuing to look for a <number>.
Chris@10 3684 %
Chris@10 3685 \ifnum\lccode\expandafter`\thearg=0\relax
Chris@10 3686 \numericenumerate % a number (we hope)
Chris@10 3687 \else
Chris@10 3688 % It's a letter.
Chris@10 3689 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
Chris@10 3690 \lowercaseenumerate % lowercase letter
Chris@10 3691 \else
Chris@10 3692 \uppercaseenumerate % uppercase letter
Chris@10 3693 \fi
Chris@10 3694 \fi
Chris@10 3695 \else
Chris@10 3696 % Multiple tokens in the argument. We hope it's a number.
Chris@10 3697 \numericenumerate
Chris@10 3698 \fi
Chris@10 3699 }
Chris@10 3700
Chris@10 3701 % An @enumerate whose labels are integers. The starting integer is
Chris@10 3702 % given in \thearg.
Chris@10 3703 %
Chris@10 3704 \def\numericenumerate{%
Chris@10 3705 \itemno = \thearg
Chris@10 3706 \startenumeration{\the\itemno}%
Chris@10 3707 }
Chris@10 3708
Chris@10 3709 % The starting (lowercase) letter is in \thearg.
Chris@10 3710 \def\lowercaseenumerate{%
Chris@10 3711 \itemno = \expandafter`\thearg
Chris@10 3712 \startenumeration{%
Chris@10 3713 % Be sure we're not beyond the end of the alphabet.
Chris@10 3714 \ifnum\itemno=0
Chris@10 3715 \errmessage{No more lowercase letters in @enumerate; get a bigger
Chris@10 3716 alphabet}%
Chris@10 3717 \fi
Chris@10 3718 \char\lccode\itemno
Chris@10 3719 }%
Chris@10 3720 }
Chris@10 3721
Chris@10 3722 % The starting (uppercase) letter is in \thearg.
Chris@10 3723 \def\uppercaseenumerate{%
Chris@10 3724 \itemno = \expandafter`\thearg
Chris@10 3725 \startenumeration{%
Chris@10 3726 % Be sure we're not beyond the end of the alphabet.
Chris@10 3727 \ifnum\itemno=0
Chris@10 3728 \errmessage{No more uppercase letters in @enumerate; get a bigger
Chris@10 3729 alphabet}
Chris@10 3730 \fi
Chris@10 3731 \char\uccode\itemno
Chris@10 3732 }%
Chris@10 3733 }
Chris@10 3734
Chris@10 3735 % Call \doitemize, adding a period to the first argument and supplying the
Chris@10 3736 % common last two arguments. Also subtract one from the initial value in
Chris@10 3737 % \itemno, since @item increments \itemno.
Chris@10 3738 %
Chris@10 3739 \def\startenumeration#1{%
Chris@10 3740 \advance\itemno by -1
Chris@10 3741 \doitemize{#1.}\flushcr
Chris@10 3742 }
Chris@10 3743
Chris@10 3744 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
Chris@10 3745 % to @enumerate.
Chris@10 3746 %
Chris@10 3747 \def\alphaenumerate{\enumerate{a}}
Chris@10 3748 \def\capsenumerate{\enumerate{A}}
Chris@10 3749 \def\Ealphaenumerate{\Eenumerate}
Chris@10 3750 \def\Ecapsenumerate{\Eenumerate}
Chris@10 3751
Chris@10 3752
Chris@10 3753 % @multitable macros
Chris@10 3754 % Amy Hendrickson, 8/18/94, 3/6/96
Chris@10 3755 %
Chris@10 3756 % @multitable ... @end multitable will make as many columns as desired.
Chris@10 3757 % Contents of each column will wrap at width given in preamble. Width
Chris@10 3758 % can be specified either with sample text given in a template line,
Chris@10 3759 % or in percent of \hsize, the current width of text on page.
Chris@10 3760
Chris@10 3761 % Table can continue over pages but will only break between lines.
Chris@10 3762
Chris@10 3763 % To make preamble:
Chris@10 3764 %
Chris@10 3765 % Either define widths of columns in terms of percent of \hsize:
Chris@10 3766 % @multitable @columnfractions .25 .3 .45
Chris@10 3767 % @item ...
Chris@10 3768 %
Chris@10 3769 % Numbers following @columnfractions are the percent of the total
Chris@10 3770 % current hsize to be used for each column. You may use as many
Chris@10 3771 % columns as desired.
Chris@10 3772
Chris@10 3773
Chris@10 3774 % Or use a template:
Chris@10 3775 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
Chris@10 3776 % @item ...
Chris@10 3777 % using the widest term desired in each column.
Chris@10 3778
Chris@10 3779 % Each new table line starts with @item, each subsequent new column
Chris@10 3780 % starts with @tab. Empty columns may be produced by supplying @tab's
Chris@10 3781 % with nothing between them for as many times as empty columns are needed,
Chris@10 3782 % ie, @tab@tab@tab will produce two empty columns.
Chris@10 3783
Chris@10 3784 % @item, @tab do not need to be on their own lines, but it will not hurt
Chris@10 3785 % if they are.
Chris@10 3786
Chris@10 3787 % Sample multitable:
Chris@10 3788
Chris@10 3789 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
Chris@10 3790 % @item first col stuff @tab second col stuff @tab third col
Chris@10 3791 % @item
Chris@10 3792 % first col stuff
Chris@10 3793 % @tab
Chris@10 3794 % second col stuff
Chris@10 3795 % @tab
Chris@10 3796 % third col
Chris@10 3797 % @item first col stuff @tab second col stuff
Chris@10 3798 % @tab Many paragraphs of text may be used in any column.
Chris@10 3799 %
Chris@10 3800 % They will wrap at the width determined by the template.
Chris@10 3801 % @item@tab@tab This will be in third column.
Chris@10 3802 % @end multitable
Chris@10 3803
Chris@10 3804 % Default dimensions may be reset by user.
Chris@10 3805 % @multitableparskip is vertical space between paragraphs in table.
Chris@10 3806 % @multitableparindent is paragraph indent in table.
Chris@10 3807 % @multitablecolmargin is horizontal space to be left between columns.
Chris@10 3808 % @multitablelinespace is space to leave between table items, baseline
Chris@10 3809 % to baseline.
Chris@10 3810 % 0pt means it depends on current normal line spacing.
Chris@10 3811 %
Chris@10 3812 \newskip\multitableparskip
Chris@10 3813 \newskip\multitableparindent
Chris@10 3814 \newdimen\multitablecolspace
Chris@10 3815 \newskip\multitablelinespace
Chris@10 3816 \multitableparskip=0pt
Chris@10 3817 \multitableparindent=6pt
Chris@10 3818 \multitablecolspace=12pt
Chris@10 3819 \multitablelinespace=0pt
Chris@10 3820
Chris@10 3821 % Macros used to set up halign preamble:
Chris@10 3822 %
Chris@10 3823 \let\endsetuptable\relax
Chris@10 3824 \def\xendsetuptable{\endsetuptable}
Chris@10 3825 \let\columnfractions\relax
Chris@10 3826 \def\xcolumnfractions{\columnfractions}
Chris@10 3827 \newif\ifsetpercent
Chris@10 3828
Chris@10 3829 % #1 is the @columnfraction, usually a decimal number like .5, but might
Chris@10 3830 % be just 1. We just use it, whatever it is.
Chris@10 3831 %
Chris@10 3832 \def\pickupwholefraction#1 {%
Chris@10 3833 \global\advance\colcount by 1
Chris@10 3834 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
Chris@10 3835 \setuptable
Chris@10 3836 }
Chris@10 3837
Chris@10 3838 \newcount\colcount
Chris@10 3839 \def\setuptable#1{%
Chris@10 3840 \def\firstarg{#1}%
Chris@10 3841 \ifx\firstarg\xendsetuptable
Chris@10 3842 \let\go = \relax
Chris@10 3843 \else
Chris@10 3844 \ifx\firstarg\xcolumnfractions
Chris@10 3845 \global\setpercenttrue
Chris@10 3846 \else
Chris@10 3847 \ifsetpercent
Chris@10 3848 \let\go\pickupwholefraction
Chris@10 3849 \else
Chris@10 3850 \global\advance\colcount by 1
Chris@10 3851 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
Chris@10 3852 % separator; typically that is always in the input, anyway.
Chris@10 3853 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
Chris@10 3854 \fi
Chris@10 3855 \fi
Chris@10 3856 \ifx\go\pickupwholefraction
Chris@10 3857 % Put the argument back for the \pickupwholefraction call, so
Chris@10 3858 % we'll always have a period there to be parsed.
Chris@10 3859 \def\go{\pickupwholefraction#1}%
Chris@10 3860 \else
Chris@10 3861 \let\go = \setuptable
Chris@10 3862 \fi%
Chris@10 3863 \fi
Chris@10 3864 \go
Chris@10 3865 }
Chris@10 3866
Chris@10 3867 % multitable-only commands.
Chris@10 3868 %
Chris@10 3869 % @headitem starts a heading row, which we typeset in bold.
Chris@10 3870 % Assignments have to be global since we are inside the implicit group
Chris@10 3871 % of an alignment entry. \everycr resets \everytab so we don't have to
Chris@10 3872 % undo it ourselves.
Chris@10 3873 \def\headitemfont{\b}% for people to use in the template row; not changeable
Chris@10 3874 \def\headitem{%
Chris@10 3875 \checkenv\multitable
Chris@10 3876 \crcr
Chris@10 3877 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
Chris@10 3878 \the\everytab % for the first item
Chris@10 3879 }%
Chris@10 3880 %
Chris@10 3881 % A \tab used to include \hskip1sp. But then the space in a template
Chris@10 3882 % line is not enough. That is bad. So let's go back to just `&' until
Chris@10 3883 % we again encounter the problem the 1sp was intended to solve.
Chris@10 3884 % --karl, nathan@acm.org, 20apr99.
Chris@10 3885 \def\tab{\checkenv\multitable &\the\everytab}%
Chris@10 3886
Chris@10 3887 % @multitable ... @end multitable definitions:
Chris@10 3888 %
Chris@10 3889 \newtoks\everytab % insert after every tab.
Chris@10 3890 %
Chris@10 3891 \envdef\multitable{%
Chris@10 3892 \vskip\parskip
Chris@10 3893 \startsavinginserts
Chris@10 3894 %
Chris@10 3895 % @item within a multitable starts a normal row.
Chris@10 3896 % We use \def instead of \let so that if one of the multitable entries
Chris@10 3897 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
Chris@10 3898 % \endtemplate) expanding \doitemize.
Chris@10 3899 \def\item{\crcr}%
Chris@10 3900 %
Chris@10 3901 \tolerance=9500
Chris@10 3902 \hbadness=9500
Chris@10 3903 \setmultitablespacing
Chris@10 3904 \parskip=\multitableparskip
Chris@10 3905 \parindent=\multitableparindent
Chris@10 3906 \overfullrule=0pt
Chris@10 3907 \global\colcount=0
Chris@10 3908 %
Chris@10 3909 \everycr = {%
Chris@10 3910 \noalign{%
Chris@10 3911 \global\everytab={}%
Chris@10 3912 \global\colcount=0 % Reset the column counter.
Chris@10 3913 % Check for saved footnotes, etc.
Chris@10 3914 \checkinserts
Chris@10 3915 % Keeps underfull box messages off when table breaks over pages.
Chris@10 3916 %\filbreak
Chris@10 3917 % Maybe so, but it also creates really weird page breaks when the
Chris@10 3918 % table breaks over pages. Wouldn't \vfil be better? Wait until the
Chris@10 3919 % problem manifests itself, so it can be fixed for real --karl.
Chris@10 3920 }%
Chris@10 3921 }%
Chris@10 3922 %
Chris@10 3923 \parsearg\domultitable
Chris@10 3924 }
Chris@10 3925 \def\domultitable#1{%
Chris@10 3926 % To parse everything between @multitable and @item:
Chris@10 3927 \setuptable#1 \endsetuptable
Chris@10 3928 %
Chris@10 3929 % This preamble sets up a generic column definition, which will
Chris@10 3930 % be used as many times as user calls for columns.
Chris@10 3931 % \vtop will set a single line and will also let text wrap and
Chris@10 3932 % continue for many paragraphs if desired.
Chris@10 3933 \halign\bgroup &%
Chris@10 3934 \global\advance\colcount by 1
Chris@10 3935 \multistrut
Chris@10 3936 \vtop{%
Chris@10 3937 % Use the current \colcount to find the correct column width:
Chris@10 3938 \hsize=\expandafter\csname col\the\colcount\endcsname
Chris@10 3939 %
Chris@10 3940 % In order to keep entries from bumping into each other
Chris@10 3941 % we will add a \leftskip of \multitablecolspace to all columns after
Chris@10 3942 % the first one.
Chris@10 3943 %
Chris@10 3944 % If a template has been used, we will add \multitablecolspace
Chris@10 3945 % to the width of each template entry.
Chris@10 3946 %
Chris@10 3947 % If the user has set preamble in terms of percent of \hsize we will
Chris@10 3948 % use that dimension as the width of the column, and the \leftskip
Chris@10 3949 % will keep entries from bumping into each other. Table will start at
Chris@10 3950 % left margin and final column will justify at right margin.
Chris@10 3951 %
Chris@10 3952 % Make sure we don't inherit \rightskip from the outer environment.
Chris@10 3953 \rightskip=0pt
Chris@10 3954 \ifnum\colcount=1
Chris@10 3955 % The first column will be indented with the surrounding text.
Chris@10 3956 \advance\hsize by\leftskip
Chris@10 3957 \else
Chris@10 3958 \ifsetpercent \else
Chris@10 3959 % If user has not set preamble in terms of percent of \hsize
Chris@10 3960 % we will advance \hsize by \multitablecolspace.
Chris@10 3961 \advance\hsize by \multitablecolspace
Chris@10 3962 \fi
Chris@10 3963 % In either case we will make \leftskip=\multitablecolspace:
Chris@10 3964 \leftskip=\multitablecolspace
Chris@10 3965 \fi
Chris@10 3966 % Ignoring space at the beginning and end avoids an occasional spurious
Chris@10 3967 % blank line, when TeX decides to break the line at the space before the
Chris@10 3968 % box from the multistrut, so the strut ends up on a line by itself.
Chris@10 3969 % For example:
Chris@10 3970 % @multitable @columnfractions .11 .89
Chris@10 3971 % @item @code{#}
Chris@10 3972 % @tab Legal holiday which is valid in major parts of the whole country.
Chris@10 3973 % Is automatically provided with highlighting sequences respectively
Chris@10 3974 % marking characters.
Chris@10 3975 \noindent\ignorespaces##\unskip\multistrut
Chris@10 3976 }\cr
Chris@10 3977 }
Chris@10 3978 \def\Emultitable{%
Chris@10 3979 \crcr
Chris@10 3980 \egroup % end the \halign
Chris@10 3981 \global\setpercentfalse
Chris@10 3982 }
Chris@10 3983
Chris@10 3984 \def\setmultitablespacing{%
Chris@10 3985 \def\multistrut{\strut}% just use the standard line spacing
Chris@10 3986 %
Chris@10 3987 % Compute \multitablelinespace (if not defined by user) for use in
Chris@10 3988 % \multitableparskip calculation. We used define \multistrut based on
Chris@10 3989 % this, but (ironically) that caused the spacing to be off.
Chris@10 3990 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
Chris@10 3991 \ifdim\multitablelinespace=0pt
Chris@10 3992 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
Chris@10 3993 \global\advance\multitablelinespace by-\ht0
Chris@10 3994 \fi
Chris@10 3995 % Test to see if parskip is larger than space between lines of
Chris@10 3996 % table. If not, do nothing.
Chris@10 3997 % If so, set to same dimension as multitablelinespace.
Chris@10 3998 \ifdim\multitableparskip>\multitablelinespace
Chris@10 3999 \global\multitableparskip=\multitablelinespace
Chris@10 4000 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
Chris@10 4001 % than skip between lines in the table.
Chris@10 4002 \fi%
Chris@10 4003 \ifdim\multitableparskip=0pt
Chris@10 4004 \global\multitableparskip=\multitablelinespace
Chris@10 4005 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
Chris@10 4006 % than skip between lines in the table.
Chris@10 4007 \fi}
Chris@10 4008
Chris@10 4009
Chris@10 4010 \message{conditionals,}
Chris@10 4011
Chris@10 4012 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
Chris@10 4013 % @ifnotxml always succeed. They currently do nothing; we don't
Chris@10 4014 % attempt to check whether the conditionals are properly nested. But we
Chris@10 4015 % have to remember that they are conditionals, so that @end doesn't
Chris@10 4016 % attempt to close an environment group.
Chris@10 4017 %
Chris@10 4018 \def\makecond#1{%
Chris@10 4019 \expandafter\let\csname #1\endcsname = \relax
Chris@10 4020 \expandafter\let\csname iscond.#1\endcsname = 1
Chris@10 4021 }
Chris@10 4022 \makecond{iftex}
Chris@10 4023 \makecond{ifnotdocbook}
Chris@10 4024 \makecond{ifnothtml}
Chris@10 4025 \makecond{ifnotinfo}
Chris@10 4026 \makecond{ifnotplaintext}
Chris@10 4027 \makecond{ifnotxml}
Chris@10 4028
Chris@10 4029 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
Chris@10 4030 %
Chris@10 4031 \def\direntry{\doignore{direntry}}
Chris@10 4032 \def\documentdescription{\doignore{documentdescription}}
Chris@10 4033 \def\docbook{\doignore{docbook}}
Chris@10 4034 \def\html{\doignore{html}}
Chris@10 4035 \def\ifdocbook{\doignore{ifdocbook}}
Chris@10 4036 \def\ifhtml{\doignore{ifhtml}}
Chris@10 4037 \def\ifinfo{\doignore{ifinfo}}
Chris@10 4038 \def\ifnottex{\doignore{ifnottex}}
Chris@10 4039 \def\ifplaintext{\doignore{ifplaintext}}
Chris@10 4040 \def\ifxml{\doignore{ifxml}}
Chris@10 4041 \def\ignore{\doignore{ignore}}
Chris@10 4042 \def\menu{\doignore{menu}}
Chris@10 4043 \def\xml{\doignore{xml}}
Chris@10 4044
Chris@10 4045 % Ignore text until a line `@end #1', keeping track of nested conditionals.
Chris@10 4046 %
Chris@10 4047 % A count to remember the depth of nesting.
Chris@10 4048 \newcount\doignorecount
Chris@10 4049
Chris@10 4050 \def\doignore#1{\begingroup
Chris@10 4051 % Scan in ``verbatim'' mode:
Chris@10 4052 \obeylines
Chris@10 4053 \catcode`\@ = \other
Chris@10 4054 \catcode`\{ = \other
Chris@10 4055 \catcode`\} = \other
Chris@10 4056 %
Chris@10 4057 % Make sure that spaces turn into tokens that match what \doignoretext wants.
Chris@10 4058 \spaceisspace
Chris@10 4059 %
Chris@10 4060 % Count number of #1's that we've seen.
Chris@10 4061 \doignorecount = 0
Chris@10 4062 %
Chris@10 4063 % Swallow text until we reach the matching `@end #1'.
Chris@10 4064 \dodoignore{#1}%
Chris@10 4065 }
Chris@10 4066
Chris@10 4067 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
Chris@10 4068 \obeylines %
Chris@10 4069 %
Chris@10 4070 \gdef\dodoignore#1{%
Chris@10 4071 % #1 contains the command name as a string, e.g., `ifinfo'.
Chris@10 4072 %
Chris@10 4073 % Define a command to find the next `@end #1'.
Chris@10 4074 \long\def\doignoretext##1^^M@end #1{%
Chris@10 4075 \doignoretextyyy##1^^M@#1\_STOP_}%
Chris@10 4076 %
Chris@10 4077 % And this command to find another #1 command, at the beginning of a
Chris@10 4078 % line. (Otherwise, we would consider a line `@c @ifset', for
Chris@10 4079 % example, to count as an @ifset for nesting.)
Chris@10 4080 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
Chris@10 4081 %
Chris@10 4082 % And now expand that command.
Chris@10 4083 \doignoretext ^^M%
Chris@10 4084 }%
Chris@10 4085 }
Chris@10 4086
Chris@10 4087 \def\doignoreyyy#1{%
Chris@10 4088 \def\temp{#1}%
Chris@10 4089 \ifx\temp\empty % Nothing found.
Chris@10 4090 \let\next\doignoretextzzz
Chris@10 4091 \else % Found a nested condition, ...
Chris@10 4092 \advance\doignorecount by 1
Chris@10 4093 \let\next\doignoretextyyy % ..., look for another.
Chris@10 4094 % If we're here, #1 ends with ^^M\ifinfo (for example).
Chris@10 4095 \fi
Chris@10 4096 \next #1% the token \_STOP_ is present just after this macro.
Chris@10 4097 }
Chris@10 4098
Chris@10 4099 % We have to swallow the remaining "\_STOP_".
Chris@10 4100 %
Chris@10 4101 \def\doignoretextzzz#1{%
Chris@10 4102 \ifnum\doignorecount = 0 % We have just found the outermost @end.
Chris@10 4103 \let\next\enddoignore
Chris@10 4104 \else % Still inside a nested condition.
Chris@10 4105 \advance\doignorecount by -1
Chris@10 4106 \let\next\doignoretext % Look for the next @end.
Chris@10 4107 \fi
Chris@10 4108 \next
Chris@10 4109 }
Chris@10 4110
Chris@10 4111 % Finish off ignored text.
Chris@10 4112 { \obeylines%
Chris@10 4113 % Ignore anything after the last `@end #1'; this matters in verbatim
Chris@10 4114 % environments, where otherwise the newline after an ignored conditional
Chris@10 4115 % would result in a blank line in the output.
Chris@10 4116 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
Chris@10 4117 }
Chris@10 4118
Chris@10 4119
Chris@10 4120 % @set VAR sets the variable VAR to an empty value.
Chris@10 4121 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
Chris@10 4122 %
Chris@10 4123 % Since we want to separate VAR from REST-OF-LINE (which might be
Chris@10 4124 % empty), we can't just use \parsearg; we have to insert a space of our
Chris@10 4125 % own to delimit the rest of the line, and then take it out again if we
Chris@10 4126 % didn't need it.
Chris@10 4127 % We rely on the fact that \parsearg sets \catcode`\ =10.
Chris@10 4128 %
Chris@10 4129 \parseargdef\set{\setyyy#1 \endsetyyy}
Chris@10 4130 \def\setyyy#1 #2\endsetyyy{%
Chris@10 4131 {%
Chris@10 4132 \makevalueexpandable
Chris@10 4133 \def\temp{#2}%
Chris@10 4134 \edef\next{\gdef\makecsname{SET#1}}%
Chris@10 4135 \ifx\temp\empty
Chris@10 4136 \next{}%
Chris@10 4137 \else
Chris@10 4138 \setzzz#2\endsetzzz
Chris@10 4139 \fi
Chris@10 4140 }%
Chris@10 4141 }
Chris@10 4142 % Remove the trailing space \setxxx inserted.
Chris@10 4143 \def\setzzz#1 \endsetzzz{\next{#1}}
Chris@10 4144
Chris@10 4145 % @clear VAR clears (i.e., unsets) the variable VAR.
Chris@10 4146 %
Chris@10 4147 \parseargdef\clear{%
Chris@10 4148 {%
Chris@10 4149 \makevalueexpandable
Chris@10 4150 \global\expandafter\let\csname SET#1\endcsname=\relax
Chris@10 4151 }%
Chris@10 4152 }
Chris@10 4153
Chris@10 4154 % @value{foo} gets the text saved in variable foo.
Chris@10 4155 \def\value{\begingroup\makevalueexpandable\valuexxx}
Chris@10 4156 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
Chris@10 4157 {
Chris@10 4158 \catcode`\- = \active \catcode`\_ = \active
Chris@10 4159 %
Chris@10 4160 \gdef\makevalueexpandable{%
Chris@10 4161 \let\value = \expandablevalue
Chris@10 4162 % We don't want these characters active, ...
Chris@10 4163 \catcode`\-=\other \catcode`\_=\other
Chris@10 4164 % ..., but we might end up with active ones in the argument if
Chris@10 4165 % we're called from @code, as @code{@value{foo-bar_}}, though.
Chris@10 4166 % So \let them to their normal equivalents.
Chris@10 4167 \let-\realdash \let_\normalunderscore
Chris@10 4168 }
Chris@10 4169 }
Chris@10 4170
Chris@10 4171 % We have this subroutine so that we can handle at least some @value's
Chris@10 4172 % properly in indexes (we call \makevalueexpandable in \indexdummies).
Chris@10 4173 % The command has to be fully expandable (if the variable is set), since
Chris@10 4174 % the result winds up in the index file. This means that if the
Chris@10 4175 % variable's value contains other Texinfo commands, it's almost certain
Chris@10 4176 % it will fail (although perhaps we could fix that with sufficient work
Chris@10 4177 % to do a one-level expansion on the result, instead of complete).
Chris@10 4178 %
Chris@10 4179 \def\expandablevalue#1{%
Chris@10 4180 \expandafter\ifx\csname SET#1\endcsname\relax
Chris@10 4181 {[No value for ``#1'']}%
Chris@10 4182 \message{Variable `#1', used in @value, is not set.}%
Chris@10 4183 \else
Chris@10 4184 \csname SET#1\endcsname
Chris@10 4185 \fi
Chris@10 4186 }
Chris@10 4187
Chris@10 4188 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
Chris@10 4189 % with @set.
Chris@10 4190 %
Chris@10 4191 % To get special treatment of `@end ifset,' call \makeond and the redefine.
Chris@10 4192 %
Chris@10 4193 \makecond{ifset}
Chris@10 4194 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
Chris@10 4195 \def\doifset#1#2{%
Chris@10 4196 {%
Chris@10 4197 \makevalueexpandable
Chris@10 4198 \let\next=\empty
Chris@10 4199 \expandafter\ifx\csname SET#2\endcsname\relax
Chris@10 4200 #1% If not set, redefine \next.
Chris@10 4201 \fi
Chris@10 4202 \expandafter
Chris@10 4203 }\next
Chris@10 4204 }
Chris@10 4205 \def\ifsetfail{\doignore{ifset}}
Chris@10 4206
Chris@10 4207 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
Chris@10 4208 % defined with @set, or has been undefined with @clear.
Chris@10 4209 %
Chris@10 4210 % The `\else' inside the `\doifset' parameter is a trick to reuse the
Chris@10 4211 % above code: if the variable is not set, do nothing, if it is set,
Chris@10 4212 % then redefine \next to \ifclearfail.
Chris@10 4213 %
Chris@10 4214 \makecond{ifclear}
Chris@10 4215 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
Chris@10 4216 \def\ifclearfail{\doignore{ifclear}}
Chris@10 4217
Chris@10 4218 % @dircategory CATEGORY -- specify a category of the dir file
Chris@10 4219 % which this file should belong to. Ignore this in TeX.
Chris@10 4220 \let\dircategory=\comment
Chris@10 4221
Chris@10 4222 % @defininfoenclose.
Chris@10 4223 \let\definfoenclose=\comment
Chris@10 4224
Chris@10 4225
Chris@10 4226 \message{indexing,}
Chris@10 4227 % Index generation facilities
Chris@10 4228
Chris@10 4229 % Define \newwrite to be identical to plain tex's \newwrite
Chris@10 4230 % except not \outer, so it can be used within macros and \if's.
Chris@10 4231 \edef\newwrite{\makecsname{ptexnewwrite}}
Chris@10 4232
Chris@10 4233 % \newindex {foo} defines an index named foo.
Chris@10 4234 % It automatically defines \fooindex such that
Chris@10 4235 % \fooindex ...rest of line... puts an entry in the index foo.
Chris@10 4236 % It also defines \fooindfile to be the number of the output channel for
Chris@10 4237 % the file that accumulates this index. The file's extension is foo.
Chris@10 4238 % The name of an index should be no more than 2 characters long
Chris@10 4239 % for the sake of vms.
Chris@10 4240 %
Chris@10 4241 \def\newindex#1{%
Chris@10 4242 \iflinks
Chris@10 4243 \expandafter\newwrite \csname#1indfile\endcsname
Chris@10 4244 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
Chris@10 4245 \fi
Chris@10 4246 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
Chris@10 4247 \noexpand\doindex{#1}}
Chris@10 4248 }
Chris@10 4249
Chris@10 4250 % @defindex foo == \newindex{foo}
Chris@10 4251 %
Chris@10 4252 \def\defindex{\parsearg\newindex}
Chris@10 4253
Chris@10 4254 % Define @defcodeindex, like @defindex except put all entries in @code.
Chris@10 4255 %
Chris@10 4256 \def\defcodeindex{\parsearg\newcodeindex}
Chris@10 4257 %
Chris@10 4258 \def\newcodeindex#1{%
Chris@10 4259 \iflinks
Chris@10 4260 \expandafter\newwrite \csname#1indfile\endcsname
Chris@10 4261 \openout \csname#1indfile\endcsname \jobname.#1
Chris@10 4262 \fi
Chris@10 4263 \expandafter\xdef\csname#1index\endcsname{%
Chris@10 4264 \noexpand\docodeindex{#1}}%
Chris@10 4265 }
Chris@10 4266
Chris@10 4267
Chris@10 4268 % @synindex foo bar makes index foo feed into index bar.
Chris@10 4269 % Do this instead of @defindex foo if you don't want it as a separate index.
Chris@10 4270 %
Chris@10 4271 % @syncodeindex foo bar similar, but put all entries made for index foo
Chris@10 4272 % inside @code.
Chris@10 4273 %
Chris@10 4274 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
Chris@10 4275 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
Chris@10 4276
Chris@10 4277 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
Chris@10 4278 % #3 the target index (bar).
Chris@10 4279 \def\dosynindex#1#2#3{%
Chris@10 4280 % Only do \closeout if we haven't already done it, else we'll end up
Chris@10 4281 % closing the target index.
Chris@10 4282 \expandafter \ifx\csname donesynindex#2\endcsname \relax
Chris@10 4283 % The \closeout helps reduce unnecessary open files; the limit on the
Chris@10 4284 % Acorn RISC OS is a mere 16 files.
Chris@10 4285 \expandafter\closeout\csname#2indfile\endcsname
Chris@10 4286 \expandafter\let\csname donesynindex#2\endcsname = 1
Chris@10 4287 \fi
Chris@10 4288 % redefine \fooindfile:
Chris@10 4289 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
Chris@10 4290 \expandafter\let\csname#2indfile\endcsname=\temp
Chris@10 4291 % redefine \fooindex:
Chris@10 4292 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
Chris@10 4293 }
Chris@10 4294
Chris@10 4295 % Define \doindex, the driver for all \fooindex macros.
Chris@10 4296 % Argument #1 is generated by the calling \fooindex macro,
Chris@10 4297 % and it is "foo", the name of the index.
Chris@10 4298
Chris@10 4299 % \doindex just uses \parsearg; it calls \doind for the actual work.
Chris@10 4300 % This is because \doind is more useful to call from other macros.
Chris@10 4301
Chris@10 4302 % There is also \dosubind {index}{topic}{subtopic}
Chris@10 4303 % which makes an entry in a two-level index such as the operation index.
Chris@10 4304
Chris@10 4305 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
Chris@10 4306 \def\singleindexer #1{\doind{\indexname}{#1}}
Chris@10 4307
Chris@10 4308 % like the previous two, but they put @code around the argument.
Chris@10 4309 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
Chris@10 4310 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
Chris@10 4311
Chris@10 4312 % Take care of Texinfo commands that can appear in an index entry.
Chris@10 4313 % Since there are some commands we want to expand, and others we don't,
Chris@10 4314 % we have to laboriously prevent expansion for those that we don't.
Chris@10 4315 %
Chris@10 4316 \def\indexdummies{%
Chris@10 4317 \escapechar = `\\ % use backslash in output files.
Chris@10 4318 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
Chris@10 4319 \def\ {\realbackslash\space }%
Chris@10 4320 %
Chris@10 4321 % Need these unexpandable (because we define \tt as a dummy)
Chris@10 4322 % definitions when @{ or @} appear in index entry text. Also, more
Chris@10 4323 % complicated, when \tex is in effect and \{ is a \delimiter again.
Chris@10 4324 % We can't use \lbracecmd and \rbracecmd because texindex assumes
Chris@10 4325 % braces and backslashes are used only as delimiters. Perhaps we
Chris@10 4326 % should define @lbrace and @rbrace commands a la @comma.
Chris@10 4327 \def\{{{\tt\char123}}%
Chris@10 4328 \def\}{{\tt\char125}}%
Chris@10 4329 %
Chris@10 4330 % I don't entirely understand this, but when an index entry is
Chris@10 4331 % generated from a macro call, the \endinput which \scanmacro inserts
Chris@10 4332 % causes processing to be prematurely terminated. This is,
Chris@10 4333 % apparently, because \indexsorttmp is fully expanded, and \endinput
Chris@10 4334 % is an expandable command. The redefinition below makes \endinput
Chris@10 4335 % disappear altogether for that purpose -- although logging shows that
Chris@10 4336 % processing continues to some further point. On the other hand, it
Chris@10 4337 % seems \endinput does not hurt in the printed index arg, since that
Chris@10 4338 % is still getting written without apparent harm.
Chris@10 4339 %
Chris@10 4340 % Sample source (mac-idx3.tex, reported by Graham Percival to
Chris@10 4341 % help-texinfo, 22may06):
Chris@10 4342 % @macro funindex {WORD}
Chris@10 4343 % @findex xyz
Chris@10 4344 % @end macro
Chris@10 4345 % ...
Chris@10 4346 % @funindex commtest
Chris@10 4347 %
Chris@10 4348 % The above is not enough to reproduce the bug, but it gives the flavor.
Chris@10 4349 %
Chris@10 4350 % Sample whatsit resulting:
Chris@10 4351 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
Chris@10 4352 %
Chris@10 4353 % So:
Chris@10 4354 \let\endinput = \empty
Chris@10 4355 %
Chris@10 4356 % Do the redefinitions.
Chris@10 4357 \commondummies
Chris@10 4358 }
Chris@10 4359
Chris@10 4360 % For the aux and toc files, @ is the escape character. So we want to
Chris@10 4361 % redefine everything using @ as the escape character (instead of
Chris@10 4362 % \realbackslash, still used for index files). When everything uses @,
Chris@10 4363 % this will be simpler.
Chris@10 4364 %
Chris@10 4365 \def\atdummies{%
Chris@10 4366 \def\@{@@}%
Chris@10 4367 \def\ {@ }%
Chris@10 4368 \let\{ = \lbraceatcmd
Chris@10 4369 \let\} = \rbraceatcmd
Chris@10 4370 %
Chris@10 4371 % Do the redefinitions.
Chris@10 4372 \commondummies
Chris@10 4373 \otherbackslash
Chris@10 4374 }
Chris@10 4375
Chris@10 4376 % Called from \indexdummies and \atdummies.
Chris@10 4377 %
Chris@10 4378 \def\commondummies{%
Chris@10 4379 %
Chris@10 4380 % \definedummyword defines \#1 as \string\#1\space, thus effectively
Chris@10 4381 % preventing its expansion. This is used only for control words,
Chris@10 4382 % not control letters, because the \space would be incorrect for
Chris@10 4383 % control characters, but is needed to separate the control word
Chris@10 4384 % from whatever follows.
Chris@10 4385 %
Chris@10 4386 % For control letters, we have \definedummyletter, which omits the
Chris@10 4387 % space.
Chris@10 4388 %
Chris@10 4389 % These can be used both for control words that take an argument and
Chris@10 4390 % those that do not. If it is followed by {arg} in the input, then
Chris@10 4391 % that will dutifully get written to the index (or wherever).
Chris@10 4392 %
Chris@10 4393 \def\definedummyword ##1{\def##1{\string##1\space}}%
Chris@10 4394 \def\definedummyletter##1{\def##1{\string##1}}%
Chris@10 4395 \let\definedummyaccent\definedummyletter
Chris@10 4396 %
Chris@10 4397 \commondummiesnofonts
Chris@10 4398 %
Chris@10 4399 \definedummyletter\_%
Chris@10 4400 \definedummyletter\-%
Chris@10 4401 %
Chris@10 4402 % Non-English letters.
Chris@10 4403 \definedummyword\AA
Chris@10 4404 \definedummyword\AE
Chris@10 4405 \definedummyword\DH
Chris@10 4406 \definedummyword\L
Chris@10 4407 \definedummyword\O
Chris@10 4408 \definedummyword\OE
Chris@10 4409 \definedummyword\TH
Chris@10 4410 \definedummyword\aa
Chris@10 4411 \definedummyword\ae
Chris@10 4412 \definedummyword\dh
Chris@10 4413 \definedummyword\exclamdown
Chris@10 4414 \definedummyword\l
Chris@10 4415 \definedummyword\o
Chris@10 4416 \definedummyword\oe
Chris@10 4417 \definedummyword\ordf
Chris@10 4418 \definedummyword\ordm
Chris@10 4419 \definedummyword\questiondown
Chris@10 4420 \definedummyword\ss
Chris@10 4421 \definedummyword\th
Chris@10 4422 %
Chris@10 4423 % Although these internal commands shouldn't show up, sometimes they do.
Chris@10 4424 \definedummyword\bf
Chris@10 4425 \definedummyword\gtr
Chris@10 4426 \definedummyword\hat
Chris@10 4427 \definedummyword\less
Chris@10 4428 \definedummyword\sf
Chris@10 4429 \definedummyword\sl
Chris@10 4430 \definedummyword\tclose
Chris@10 4431 \definedummyword\tt
Chris@10 4432 %
Chris@10 4433 \definedummyword\LaTeX
Chris@10 4434 \definedummyword\TeX
Chris@10 4435 %
Chris@10 4436 % Assorted special characters.
Chris@10 4437 \definedummyword\arrow
Chris@10 4438 \definedummyword\bullet
Chris@10 4439 \definedummyword\comma
Chris@10 4440 \definedummyword\copyright
Chris@10 4441 \definedummyword\registeredsymbol
Chris@10 4442 \definedummyword\dots
Chris@10 4443 \definedummyword\enddots
Chris@10 4444 \definedummyword\entrybreak
Chris@10 4445 \definedummyword\equiv
Chris@10 4446 \definedummyword\error
Chris@10 4447 \definedummyword\euro
Chris@10 4448 \definedummyword\expansion
Chris@10 4449 \definedummyword\geq
Chris@10 4450 \definedummyword\guillemetleft
Chris@10 4451 \definedummyword\guillemetright
Chris@10 4452 \definedummyword\guilsinglleft
Chris@10 4453 \definedummyword\guilsinglright
Chris@10 4454 \definedummyword\leq
Chris@10 4455 \definedummyword\minus
Chris@10 4456 \definedummyword\ogonek
Chris@10 4457 \definedummyword\pounds
Chris@10 4458 \definedummyword\point
Chris@10 4459 \definedummyword\print
Chris@10 4460 \definedummyword\quotedblbase
Chris@10 4461 \definedummyword\quotedblleft
Chris@10 4462 \definedummyword\quotedblright
Chris@10 4463 \definedummyword\quoteleft
Chris@10 4464 \definedummyword\quoteright
Chris@10 4465 \definedummyword\quotesinglbase
Chris@10 4466 \definedummyword\result
Chris@10 4467 \definedummyword\textdegree
Chris@10 4468 %
Chris@10 4469 % We want to disable all macros so that they are not expanded by \write.
Chris@10 4470 \macrolist
Chris@10 4471 %
Chris@10 4472 \normalturnoffactive
Chris@10 4473 %
Chris@10 4474 % Handle some cases of @value -- where it does not contain any
Chris@10 4475 % (non-fully-expandable) commands.
Chris@10 4476 \makevalueexpandable
Chris@10 4477 }
Chris@10 4478
Chris@10 4479 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
Chris@10 4480 %
Chris@10 4481 \def\commondummiesnofonts{%
Chris@10 4482 % Control letters and accents.
Chris@10 4483 \definedummyletter\!%
Chris@10 4484 \definedummyaccent\"%
Chris@10 4485 \definedummyaccent\'%
Chris@10 4486 \definedummyletter\*%
Chris@10 4487 \definedummyaccent\,%
Chris@10 4488 \definedummyletter\.%
Chris@10 4489 \definedummyletter\/%
Chris@10 4490 \definedummyletter\:%
Chris@10 4491 \definedummyaccent\=%
Chris@10 4492 \definedummyletter\?%
Chris@10 4493 \definedummyaccent\^%
Chris@10 4494 \definedummyaccent\`%
Chris@10 4495 \definedummyaccent\~%
Chris@10 4496 \definedummyword\u
Chris@10 4497 \definedummyword\v
Chris@10 4498 \definedummyword\H
Chris@10 4499 \definedummyword\dotaccent
Chris@10 4500 \definedummyword\ogonek
Chris@10 4501 \definedummyword\ringaccent
Chris@10 4502 \definedummyword\tieaccent
Chris@10 4503 \definedummyword\ubaraccent
Chris@10 4504 \definedummyword\udotaccent
Chris@10 4505 \definedummyword\dotless
Chris@10 4506 %
Chris@10 4507 % Texinfo font commands.
Chris@10 4508 \definedummyword\b
Chris@10 4509 \definedummyword\i
Chris@10 4510 \definedummyword\r
Chris@10 4511 \definedummyword\sansserif
Chris@10 4512 \definedummyword\sc
Chris@10 4513 \definedummyword\slanted
Chris@10 4514 \definedummyword\t
Chris@10 4515 %
Chris@10 4516 % Commands that take arguments.
Chris@10 4517 \definedummyword\acronym
Chris@10 4518 \definedummyword\anchor
Chris@10 4519 \definedummyword\cite
Chris@10 4520 \definedummyword\code
Chris@10 4521 \definedummyword\command
Chris@10 4522 \definedummyword\dfn
Chris@10 4523 \definedummyword\dmn
Chris@10 4524 \definedummyword\email
Chris@10 4525 \definedummyword\emph
Chris@10 4526 \definedummyword\env
Chris@10 4527 \definedummyword\file
Chris@10 4528 \definedummyword\indicateurl
Chris@10 4529 \definedummyword\kbd
Chris@10 4530 \definedummyword\key
Chris@10 4531 \definedummyword\math
Chris@10 4532 \definedummyword\option
Chris@10 4533 \definedummyword\pxref
Chris@10 4534 \definedummyword\ref
Chris@10 4535 \definedummyword\samp
Chris@10 4536 \definedummyword\strong
Chris@10 4537 \definedummyword\tie
Chris@10 4538 \definedummyword\uref
Chris@10 4539 \definedummyword\url
Chris@10 4540 \definedummyword\var
Chris@10 4541 \definedummyword\verb
Chris@10 4542 \definedummyword\w
Chris@10 4543 \definedummyword\xref
Chris@10 4544 }
Chris@10 4545
Chris@10 4546 % \indexnofonts is used when outputting the strings to sort the index
Chris@10 4547 % by, and when constructing control sequence names. It eliminates all
Chris@10 4548 % control sequences and just writes whatever the best ASCII sort string
Chris@10 4549 % would be for a given command (usually its argument).
Chris@10 4550 %
Chris@10 4551 \def\indexnofonts{%
Chris@10 4552 % Accent commands should become @asis.
Chris@10 4553 \def\definedummyaccent##1{\let##1\asis}%
Chris@10 4554 % We can just ignore other control letters.
Chris@10 4555 \def\definedummyletter##1{\let##1\empty}%
Chris@10 4556 % All control words become @asis by default; overrides below.
Chris@10 4557 \let\definedummyword\definedummyaccent
Chris@10 4558 %
Chris@10 4559 \commondummiesnofonts
Chris@10 4560 %
Chris@10 4561 % Don't no-op \tt, since it isn't a user-level command
Chris@10 4562 % and is used in the definitions of the active chars like <, >, |, etc.
Chris@10 4563 % Likewise with the other plain tex font commands.
Chris@10 4564 %\let\tt=\asis
Chris@10 4565 %
Chris@10 4566 \def\ { }%
Chris@10 4567 \def\@{@}%
Chris@10 4568 \def\_{\normalunderscore}%
Chris@10 4569 \def\-{}% @- shouldn't affect sorting
Chris@10 4570 %
Chris@10 4571 % Unfortunately, texindex is not prepared to handle braces in the
Chris@10 4572 % content at all. So for index sorting, we map @{ and @} to strings
Chris@10 4573 % starting with |, since that ASCII character is between ASCII { and }.
Chris@10 4574 \def\{{|a}%
Chris@10 4575 \def\}{|b}%
Chris@10 4576 %
Chris@10 4577 % Non-English letters.
Chris@10 4578 \def\AA{AA}%
Chris@10 4579 \def\AE{AE}%
Chris@10 4580 \def\DH{DZZ}%
Chris@10 4581 \def\L{L}%
Chris@10 4582 \def\OE{OE}%
Chris@10 4583 \def\O{O}%
Chris@10 4584 \def\TH{ZZZ}%
Chris@10 4585 \def\aa{aa}%
Chris@10 4586 \def\ae{ae}%
Chris@10 4587 \def\dh{dzz}%
Chris@10 4588 \def\exclamdown{!}%
Chris@10 4589 \def\l{l}%
Chris@10 4590 \def\oe{oe}%
Chris@10 4591 \def\ordf{a}%
Chris@10 4592 \def\ordm{o}%
Chris@10 4593 \def\o{o}%
Chris@10 4594 \def\questiondown{?}%
Chris@10 4595 \def\ss{ss}%
Chris@10 4596 \def\th{zzz}%
Chris@10 4597 %
Chris@10 4598 \def\LaTeX{LaTeX}%
Chris@10 4599 \def\TeX{TeX}%
Chris@10 4600 %
Chris@10 4601 % Assorted special characters.
Chris@10 4602 % (The following {} will end up in the sort string, but that's ok.)
Chris@10 4603 \def\arrow{->}%
Chris@10 4604 \def\bullet{bullet}%
Chris@10 4605 \def\comma{,}%
Chris@10 4606 \def\copyright{copyright}%
Chris@10 4607 \def\dots{...}%
Chris@10 4608 \def\enddots{...}%
Chris@10 4609 \def\equiv{==}%
Chris@10 4610 \def\error{error}%
Chris@10 4611 \def\euro{euro}%
Chris@10 4612 \def\expansion{==>}%
Chris@10 4613 \def\geq{>=}%
Chris@10 4614 \def\guillemetleft{<<}%
Chris@10 4615 \def\guillemetright{>>}%
Chris@10 4616 \def\guilsinglleft{<}%
Chris@10 4617 \def\guilsinglright{>}%
Chris@10 4618 \def\leq{<=}%
Chris@10 4619 \def\minus{-}%
Chris@10 4620 \def\point{.}%
Chris@10 4621 \def\pounds{pounds}%
Chris@10 4622 \def\print{-|}%
Chris@10 4623 \def\quotedblbase{"}%
Chris@10 4624 \def\quotedblleft{"}%
Chris@10 4625 \def\quotedblright{"}%
Chris@10 4626 \def\quoteleft{`}%
Chris@10 4627 \def\quoteright{'}%
Chris@10 4628 \def\quotesinglbase{,}%
Chris@10 4629 \def\registeredsymbol{R}%
Chris@10 4630 \def\result{=>}%
Chris@10 4631 \def\textdegree{o}%
Chris@10 4632 %
Chris@10 4633 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
Chris@10 4634 \else \indexlquoteignore \fi
Chris@10 4635 %
Chris@10 4636 % We need to get rid of all macros, leaving only the arguments (if present).
Chris@10 4637 % Of course this is not nearly correct, but it is the best we can do for now.
Chris@10 4638 % makeinfo does not expand macros in the argument to @deffn, which ends up
Chris@10 4639 % writing an index entry, and texindex isn't prepared for an index sort entry
Chris@10 4640 % that starts with \.
Chris@10 4641 %
Chris@10 4642 % Since macro invocations are followed by braces, we can just redefine them
Chris@10 4643 % to take a single TeX argument. The case of a macro invocation that
Chris@10 4644 % goes to end-of-line is not handled.
Chris@10 4645 %
Chris@10 4646 \macrolist
Chris@10 4647 }
Chris@10 4648
Chris@10 4649 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
Chris@10 4650 % ignore left quotes in the sort term.
Chris@10 4651 {\catcode`\`=\active
Chris@10 4652 \gdef\indexlquoteignore{\let`=\empty}}
Chris@10 4653
Chris@10 4654 \let\indexbackslash=0 %overridden during \printindex.
Chris@10 4655 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
Chris@10 4656
Chris@10 4657 % Most index entries go through here, but \dosubind is the general case.
Chris@10 4658 % #1 is the index name, #2 is the entry text.
Chris@10 4659 \def\doind#1#2{\dosubind{#1}{#2}{}}
Chris@10 4660
Chris@10 4661 % Workhorse for all \fooindexes.
Chris@10 4662 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
Chris@10 4663 % empty if called from \doind, as we usually are (the main exception
Chris@10 4664 % is with most defuns, which call us directly).
Chris@10 4665 %
Chris@10 4666 \def\dosubind#1#2#3{%
Chris@10 4667 \iflinks
Chris@10 4668 {%
Chris@10 4669 % Store the main index entry text (including the third arg).
Chris@10 4670 \toks0 = {#2}%
Chris@10 4671 % If third arg is present, precede it with a space.
Chris@10 4672 \def\thirdarg{#3}%
Chris@10 4673 \ifx\thirdarg\empty \else
Chris@10 4674 \toks0 = \expandafter{\the\toks0 \space #3}%
Chris@10 4675 \fi
Chris@10 4676 %
Chris@10 4677 \edef\writeto{\csname#1indfile\endcsname}%
Chris@10 4678 %
Chris@10 4679 \safewhatsit\dosubindwrite
Chris@10 4680 }%
Chris@10 4681 \fi
Chris@10 4682 }
Chris@10 4683
Chris@10 4684 % Write the entry in \toks0 to the index file:
Chris@10 4685 %
Chris@10 4686 \def\dosubindwrite{%
Chris@10 4687 % Put the index entry in the margin if desired.
Chris@10 4688 \ifx\SETmarginindex\relax\else
Chris@10 4689 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
Chris@10 4690 \fi
Chris@10 4691 %
Chris@10 4692 % Remember, we are within a group.
Chris@10 4693 \indexdummies % Must do this here, since \bf, etc expand at this stage
Chris@10 4694 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
Chris@10 4695 % so it will be output as is; and it will print as backslash.
Chris@10 4696 %
Chris@10 4697 % Process the index entry with all font commands turned off, to
Chris@10 4698 % get the string to sort by.
Chris@10 4699 {\indexnofonts
Chris@10 4700 \edef\temp{\the\toks0}% need full expansion
Chris@10 4701 \xdef\indexsorttmp{\temp}%
Chris@10 4702 }%
Chris@10 4703 %
Chris@10 4704 % Set up the complete index entry, with both the sort key and
Chris@10 4705 % the original text, including any font commands. We write
Chris@10 4706 % three arguments to \entry to the .?? file (four in the
Chris@10 4707 % subentry case), texindex reduces to two when writing the .??s
Chris@10 4708 % sorted result.
Chris@10 4709 \edef\temp{%
Chris@10 4710 \write\writeto{%
Chris@10 4711 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
Chris@10 4712 }%
Chris@10 4713 \temp
Chris@10 4714 }
Chris@10 4715
Chris@10 4716 % Take care of unwanted page breaks/skips around a whatsit:
Chris@10 4717 %
Chris@10 4718 % If a skip is the last thing on the list now, preserve it
Chris@10 4719 % by backing up by \lastskip, doing the \write, then inserting
Chris@10 4720 % the skip again. Otherwise, the whatsit generated by the
Chris@10 4721 % \write or \pdfdest will make \lastskip zero. The result is that
Chris@10 4722 % sequences like this:
Chris@10 4723 % @end defun
Chris@10 4724 % @tindex whatever
Chris@10 4725 % @defun ...
Chris@10 4726 % will have extra space inserted, because the \medbreak in the
Chris@10 4727 % start of the @defun won't see the skip inserted by the @end of
Chris@10 4728 % the previous defun.
Chris@10 4729 %
Chris@10 4730 % But don't do any of this if we're not in vertical mode. We
Chris@10 4731 % don't want to do a \vskip and prematurely end a paragraph.
Chris@10 4732 %
Chris@10 4733 % Avoid page breaks due to these extra skips, too.
Chris@10 4734 %
Chris@10 4735 % But wait, there is a catch there:
Chris@10 4736 % We'll have to check whether \lastskip is zero skip. \ifdim is not
Chris@10 4737 % sufficient for this purpose, as it ignores stretch and shrink parts
Chris@10 4738 % of the skip. The only way seems to be to check the textual
Chris@10 4739 % representation of the skip.
Chris@10 4740 %
Chris@10 4741 % The following is almost like \def\zeroskipmacro{0.0pt} except that
Chris@10 4742 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
Chris@10 4743 %
Chris@10 4744 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
Chris@10 4745 %
Chris@10 4746 \newskip\whatsitskip
Chris@10 4747 \newcount\whatsitpenalty
Chris@10 4748 %
Chris@10 4749 % ..., ready, GO:
Chris@10 4750 %
Chris@10 4751 \def\safewhatsit#1{\ifhmode
Chris@10 4752 #1%
Chris@10 4753 \else
Chris@10 4754 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
Chris@10 4755 \whatsitskip = \lastskip
Chris@10 4756 \edef\lastskipmacro{\the\lastskip}%
Chris@10 4757 \whatsitpenalty = \lastpenalty
Chris@10 4758 %
Chris@10 4759 % If \lastskip is nonzero, that means the last item was a
Chris@10 4760 % skip. And since a skip is discardable, that means this
Chris@10 4761 % -\whatsitskip glue we're inserting is preceded by a
Chris@10 4762 % non-discardable item, therefore it is not a potential
Chris@10 4763 % breakpoint, therefore no \nobreak needed.
Chris@10 4764 \ifx\lastskipmacro\zeroskipmacro
Chris@10 4765 \else
Chris@10 4766 \vskip-\whatsitskip
Chris@10 4767 \fi
Chris@10 4768 %
Chris@10 4769 #1%
Chris@10 4770 %
Chris@10 4771 \ifx\lastskipmacro\zeroskipmacro
Chris@10 4772 % If \lastskip was zero, perhaps the last item was a penalty, and
Chris@10 4773 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
Chris@10 4774 % to re-insert the same penalty (values >10000 are used for various
Chris@10 4775 % signals); since we just inserted a non-discardable item, any
Chris@10 4776 % following glue (such as a \parskip) would be a breakpoint. For example:
Chris@10 4777 % @deffn deffn-whatever
Chris@10 4778 % @vindex index-whatever
Chris@10 4779 % Description.
Chris@10 4780 % would allow a break between the index-whatever whatsit
Chris@10 4781 % and the "Description." paragraph.
Chris@10 4782 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
Chris@10 4783 \else
Chris@10 4784 % On the other hand, if we had a nonzero \lastskip,
Chris@10 4785 % this make-up glue would be preceded by a non-discardable item
Chris@10 4786 % (the whatsit from the \write), so we must insert a \nobreak.
Chris@10 4787 \nobreak\vskip\whatsitskip
Chris@10 4788 \fi
Chris@10 4789 \fi}
Chris@10 4790
Chris@10 4791 % The index entry written in the file actually looks like
Chris@10 4792 % \entry {sortstring}{page}{topic}
Chris@10 4793 % or
Chris@10 4794 % \entry {sortstring}{page}{topic}{subtopic}
Chris@10 4795 % The texindex program reads in these files and writes files
Chris@10 4796 % containing these kinds of lines:
Chris@10 4797 % \initial {c}
Chris@10 4798 % before the first topic whose initial is c
Chris@10 4799 % \entry {topic}{pagelist}
Chris@10 4800 % for a topic that is used without subtopics
Chris@10 4801 % \primary {topic}
Chris@10 4802 % for the beginning of a topic that is used with subtopics
Chris@10 4803 % \secondary {subtopic}{pagelist}
Chris@10 4804 % for each subtopic.
Chris@10 4805
Chris@10 4806 % Define the user-accessible indexing commands
Chris@10 4807 % @findex, @vindex, @kindex, @cindex.
Chris@10 4808
Chris@10 4809 \def\findex {\fnindex}
Chris@10 4810 \def\kindex {\kyindex}
Chris@10 4811 \def\cindex {\cpindex}
Chris@10 4812 \def\vindex {\vrindex}
Chris@10 4813 \def\tindex {\tpindex}
Chris@10 4814 \def\pindex {\pgindex}
Chris@10 4815
Chris@10 4816 \def\cindexsub {\begingroup\obeylines\cindexsub}
Chris@10 4817 {\obeylines %
Chris@10 4818 \gdef\cindexsub "#1" #2^^M{\endgroup %
Chris@10 4819 \dosubind{cp}{#2}{#1}}}
Chris@10 4820
Chris@10 4821 % Define the macros used in formatting output of the sorted index material.
Chris@10 4822
Chris@10 4823 % @printindex causes a particular index (the ??s file) to get printed.
Chris@10 4824 % It does not print any chapter heading (usually an @unnumbered).
Chris@10 4825 %
Chris@10 4826 \parseargdef\printindex{\begingroup
Chris@10 4827 \dobreak \chapheadingskip{10000}%
Chris@10 4828 %
Chris@10 4829 \smallfonts \rm
Chris@10 4830 \tolerance = 9500
Chris@10 4831 \plainfrenchspacing
Chris@10 4832 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
Chris@10 4833 %
Chris@10 4834 % See if the index file exists and is nonempty.
Chris@10 4835 % Change catcode of @ here so that if the index file contains
Chris@10 4836 % \initial {@}
Chris@10 4837 % as its first line, TeX doesn't complain about mismatched braces
Chris@10 4838 % (because it thinks @} is a control sequence).
Chris@10 4839 \catcode`\@ = 11
Chris@10 4840 \openin 1 \jobname.#1s
Chris@10 4841 \ifeof 1
Chris@10 4842 % \enddoublecolumns gets confused if there is no text in the index,
Chris@10 4843 % and it loses the chapter title and the aux file entries for the
Chris@10 4844 % index. The easiest way to prevent this problem is to make sure
Chris@10 4845 % there is some text.
Chris@10 4846 \putwordIndexNonexistent
Chris@10 4847 \else
Chris@10 4848 %
Chris@10 4849 % If the index file exists but is empty, then \openin leaves \ifeof
Chris@10 4850 % false. We have to make TeX try to read something from the file, so
Chris@10 4851 % it can discover if there is anything in it.
Chris@10 4852 \read 1 to \temp
Chris@10 4853 \ifeof 1
Chris@10 4854 \putwordIndexIsEmpty
Chris@10 4855 \else
Chris@10 4856 % Index files are almost Texinfo source, but we use \ as the escape
Chris@10 4857 % character. It would be better to use @, but that's too big a change
Chris@10 4858 % to make right now.
Chris@10 4859 \def\indexbackslash{\backslashcurfont}%
Chris@10 4860 \catcode`\\ = 0
Chris@10 4861 \escapechar = `\\
Chris@10 4862 \begindoublecolumns
Chris@10 4863 \input \jobname.#1s
Chris@10 4864 \enddoublecolumns
Chris@10 4865 \fi
Chris@10 4866 \fi
Chris@10 4867 \closein 1
Chris@10 4868 \endgroup}
Chris@10 4869
Chris@10 4870 % These macros are used by the sorted index file itself.
Chris@10 4871 % Change them to control the appearance of the index.
Chris@10 4872
Chris@10 4873 \def\initial#1{{%
Chris@10 4874 % Some minor font changes for the special characters.
Chris@10 4875 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
Chris@10 4876 %
Chris@10 4877 % Remove any glue we may have, we'll be inserting our own.
Chris@10 4878 \removelastskip
Chris@10 4879 %
Chris@10 4880 % We like breaks before the index initials, so insert a bonus.
Chris@10 4881 \nobreak
Chris@10 4882 \vskip 0pt plus 3\baselineskip
Chris@10 4883 \penalty 0
Chris@10 4884 \vskip 0pt plus -3\baselineskip
Chris@10 4885 %
Chris@10 4886 % Typeset the initial. Making this add up to a whole number of
Chris@10 4887 % baselineskips increases the chance of the dots lining up from column
Chris@10 4888 % to column. It still won't often be perfect, because of the stretch
Chris@10 4889 % we need before each entry, but it's better.
Chris@10 4890 %
Chris@10 4891 % No shrink because it confuses \balancecolumns.
Chris@10 4892 \vskip 1.67\baselineskip plus .5\baselineskip
Chris@10 4893 \leftline{\secbf #1}%
Chris@10 4894 % Do our best not to break after the initial.
Chris@10 4895 \nobreak
Chris@10 4896 \vskip .33\baselineskip plus .1\baselineskip
Chris@10 4897 }}
Chris@10 4898
Chris@10 4899 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
Chris@10 4900 % then page number (#2) flushed to the right margin. It is used for index
Chris@10 4901 % and table of contents entries. The paragraph is indented by \leftskip.
Chris@10 4902 %
Chris@10 4903 % A straightforward implementation would start like this:
Chris@10 4904 % \def\entry#1#2{...
Chris@10 4905 % But this freezes the catcodes in the argument, and can cause problems to
Chris@10 4906 % @code, which sets - active. This problem was fixed by a kludge---
Chris@10 4907 % ``-'' was active throughout whole index, but this isn't really right.
Chris@10 4908 % The right solution is to prevent \entry from swallowing the whole text.
Chris@10 4909 % --kasal, 21nov03
Chris@10 4910 \def\entry{%
Chris@10 4911 \begingroup
Chris@10 4912 %
Chris@10 4913 % Start a new paragraph if necessary, so our assignments below can't
Chris@10 4914 % affect previous text.
Chris@10 4915 \par
Chris@10 4916 %
Chris@10 4917 % Do not fill out the last line with white space.
Chris@10 4918 \parfillskip = 0in
Chris@10 4919 %
Chris@10 4920 % No extra space above this paragraph.
Chris@10 4921 \parskip = 0in
Chris@10 4922 %
Chris@10 4923 % Do not prefer a separate line ending with a hyphen to fewer lines.
Chris@10 4924 \finalhyphendemerits = 0
Chris@10 4925 %
Chris@10 4926 % \hangindent is only relevant when the entry text and page number
Chris@10 4927 % don't both fit on one line. In that case, bob suggests starting the
Chris@10 4928 % dots pretty far over on the line. Unfortunately, a large
Chris@10 4929 % indentation looks wrong when the entry text itself is broken across
Chris@10 4930 % lines. So we use a small indentation and put up with long leaders.
Chris@10 4931 %
Chris@10 4932 % \hangafter is reset to 1 (which is the value we want) at the start
Chris@10 4933 % of each paragraph, so we need not do anything with that.
Chris@10 4934 \hangindent = 2em
Chris@10 4935 %
Chris@10 4936 % When the entry text needs to be broken, just fill out the first line
Chris@10 4937 % with blank space.
Chris@10 4938 \rightskip = 0pt plus1fil
Chris@10 4939 %
Chris@10 4940 % A bit of stretch before each entry for the benefit of balancing
Chris@10 4941 % columns.
Chris@10 4942 \vskip 0pt plus1pt
Chris@10 4943 %
Chris@10 4944 % When reading the text of entry, convert explicit line breaks
Chris@10 4945 % from @* into spaces. The user might give these in long section
Chris@10 4946 % titles, for instance.
Chris@10 4947 \def\*{\unskip\space\ignorespaces}%
Chris@10 4948 \def\entrybreak{\hfil\break}%
Chris@10 4949 %
Chris@10 4950 % Swallow the left brace of the text (first parameter):
Chris@10 4951 \afterassignment\doentry
Chris@10 4952 \let\temp =
Chris@10 4953 }
Chris@10 4954 \def\entrybreak{\unskip\space\ignorespaces}%
Chris@10 4955 \def\doentry{%
Chris@10 4956 \bgroup % Instead of the swallowed brace.
Chris@10 4957 \noindent
Chris@10 4958 \aftergroup\finishentry
Chris@10 4959 % And now comes the text of the entry.
Chris@10 4960 }
Chris@10 4961 \def\finishentry#1{%
Chris@10 4962 % #1 is the page number.
Chris@10 4963 %
Chris@10 4964 % The following is kludged to not output a line of dots in the index if
Chris@10 4965 % there are no page numbers. The next person who breaks this will be
Chris@10 4966 % cursed by a Unix daemon.
Chris@10 4967 \setbox\boxA = \hbox{#1}%
Chris@10 4968 \ifdim\wd\boxA = 0pt
Chris@10 4969 \ %
Chris@10 4970 \else
Chris@10 4971 %
Chris@10 4972 % If we must, put the page number on a line of its own, and fill out
Chris@10 4973 % this line with blank space. (The \hfil is overwhelmed with the
Chris@10 4974 % fill leaders glue in \indexdotfill if the page number does fit.)
Chris@10 4975 \hfil\penalty50
Chris@10 4976 \null\nobreak\indexdotfill % Have leaders before the page number.
Chris@10 4977 %
Chris@10 4978 % The `\ ' here is removed by the implicit \unskip that TeX does as
Chris@10 4979 % part of (the primitive) \par. Without it, a spurious underfull
Chris@10 4980 % \hbox ensues.
Chris@10 4981 \ifpdf
Chris@10 4982 \pdfgettoks#1.%
Chris@10 4983 \ \the\toksA
Chris@10 4984 \else
Chris@10 4985 \ #1%
Chris@10 4986 \fi
Chris@10 4987 \fi
Chris@10 4988 \par
Chris@10 4989 \endgroup
Chris@10 4990 }
Chris@10 4991
Chris@10 4992 % Like plain.tex's \dotfill, except uses up at least 1 em.
Chris@10 4993 \def\indexdotfill{\cleaders
Chris@10 4994 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
Chris@10 4995
Chris@10 4996 \def\primary #1{\line{#1\hfil}}
Chris@10 4997
Chris@10 4998 \newskip\secondaryindent \secondaryindent=0.5cm
Chris@10 4999 \def\secondary#1#2{{%
Chris@10 5000 \parfillskip=0in
Chris@10 5001 \parskip=0in
Chris@10 5002 \hangindent=1in
Chris@10 5003 \hangafter=1
Chris@10 5004 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
Chris@10 5005 \ifpdf
Chris@10 5006 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
Chris@10 5007 \else
Chris@10 5008 #2
Chris@10 5009 \fi
Chris@10 5010 \par
Chris@10 5011 }}
Chris@10 5012
Chris@10 5013 % Define two-column mode, which we use to typeset indexes.
Chris@10 5014 % Adapted from the TeXbook, page 416, which is to say,
Chris@10 5015 % the manmac.tex format used to print the TeXbook itself.
Chris@10 5016 \catcode`\@=11
Chris@10 5017
Chris@10 5018 \newbox\partialpage
Chris@10 5019 \newdimen\doublecolumnhsize
Chris@10 5020
Chris@10 5021 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
Chris@10 5022 % Grab any single-column material above us.
Chris@10 5023 \output = {%
Chris@10 5024 %
Chris@10 5025 % Here is a possibility not foreseen in manmac: if we accumulate a
Chris@10 5026 % whole lot of material, we might end up calling this \output
Chris@10 5027 % routine twice in a row (see the doublecol-lose test, which is
Chris@10 5028 % essentially a couple of indexes with @setchapternewpage off). In
Chris@10 5029 % that case we just ship out what is in \partialpage with the normal
Chris@10 5030 % output routine. Generally, \partialpage will be empty when this
Chris@10 5031 % runs and this will be a no-op. See the indexspread.tex test case.
Chris@10 5032 \ifvoid\partialpage \else
Chris@10 5033 \onepageout{\pagecontents\partialpage}%
Chris@10 5034 \fi
Chris@10 5035 %
Chris@10 5036 \global\setbox\partialpage = \vbox{%
Chris@10 5037 % Unvbox the main output page.
Chris@10 5038 \unvbox\PAGE
Chris@10 5039 \kern-\topskip \kern\baselineskip
Chris@10 5040 }%
Chris@10 5041 }%
Chris@10 5042 \eject % run that output routine to set \partialpage
Chris@10 5043 %
Chris@10 5044 % Use the double-column output routine for subsequent pages.
Chris@10 5045 \output = {\doublecolumnout}%
Chris@10 5046 %
Chris@10 5047 % Change the page size parameters. We could do this once outside this
Chris@10 5048 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
Chris@10 5049 % format, but then we repeat the same computation. Repeating a couple
Chris@10 5050 % of assignments once per index is clearly meaningless for the
Chris@10 5051 % execution time, so we may as well do it in one place.
Chris@10 5052 %
Chris@10 5053 % First we halve the line length, less a little for the gutter between
Chris@10 5054 % the columns. We compute the gutter based on the line length, so it
Chris@10 5055 % changes automatically with the paper format. The magic constant
Chris@10 5056 % below is chosen so that the gutter has the same value (well, +-<1pt)
Chris@10 5057 % as it did when we hard-coded it.
Chris@10 5058 %
Chris@10 5059 % We put the result in a separate register, \doublecolumhsize, so we
Chris@10 5060 % can restore it in \pagesofar, after \hsize itself has (potentially)
Chris@10 5061 % been clobbered.
Chris@10 5062 %
Chris@10 5063 \doublecolumnhsize = \hsize
Chris@10 5064 \advance\doublecolumnhsize by -.04154\hsize
Chris@10 5065 \divide\doublecolumnhsize by 2
Chris@10 5066 \hsize = \doublecolumnhsize
Chris@10 5067 %
Chris@10 5068 % Double the \vsize as well. (We don't need a separate register here,
Chris@10 5069 % since nobody clobbers \vsize.)
Chris@10 5070 \vsize = 2\vsize
Chris@10 5071 }
Chris@10 5072
Chris@10 5073 % The double-column output routine for all double-column pages except
Chris@10 5074 % the last.
Chris@10 5075 %
Chris@10 5076 \def\doublecolumnout{%
Chris@10 5077 \splittopskip=\topskip \splitmaxdepth=\maxdepth
Chris@10 5078 % Get the available space for the double columns -- the normal
Chris@10 5079 % (undoubled) page height minus any material left over from the
Chris@10 5080 % previous page.
Chris@10 5081 \dimen@ = \vsize
Chris@10 5082 \divide\dimen@ by 2
Chris@10 5083 \advance\dimen@ by -\ht\partialpage
Chris@10 5084 %
Chris@10 5085 % box0 will be the left-hand column, box2 the right.
Chris@10 5086 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
Chris@10 5087 \onepageout\pagesofar
Chris@10 5088 \unvbox255
Chris@10 5089 \penalty\outputpenalty
Chris@10 5090 }
Chris@10 5091 %
Chris@10 5092 % Re-output the contents of the output page -- any previous material,
Chris@10 5093 % followed by the two boxes we just split, in box0 and box2.
Chris@10 5094 \def\pagesofar{%
Chris@10 5095 \unvbox\partialpage
Chris@10 5096 %
Chris@10 5097 \hsize = \doublecolumnhsize
Chris@10 5098 \wd0=\hsize \wd2=\hsize
Chris@10 5099 \hbox to\pagewidth{\box0\hfil\box2}%
Chris@10 5100 }
Chris@10 5101 %
Chris@10 5102 % All done with double columns.
Chris@10 5103 \def\enddoublecolumns{%
Chris@10 5104 % The following penalty ensures that the page builder is exercised
Chris@10 5105 % _before_ we change the output routine. This is necessary in the
Chris@10 5106 % following situation:
Chris@10 5107 %
Chris@10 5108 % The last section of the index consists only of a single entry.
Chris@10 5109 % Before this section, \pagetotal is less than \pagegoal, so no
Chris@10 5110 % break occurs before the last section starts. However, the last
Chris@10 5111 % section, consisting of \initial and the single \entry, does not
Chris@10 5112 % fit on the page and has to be broken off. Without the following
Chris@10 5113 % penalty the page builder will not be exercised until \eject
Chris@10 5114 % below, and by that time we'll already have changed the output
Chris@10 5115 % routine to the \balancecolumns version, so the next-to-last
Chris@10 5116 % double-column page will be processed with \balancecolumns, which
Chris@10 5117 % is wrong: The two columns will go to the main vertical list, with
Chris@10 5118 % the broken-off section in the recent contributions. As soon as
Chris@10 5119 % the output routine finishes, TeX starts reconsidering the page
Chris@10 5120 % break. The two columns and the broken-off section both fit on the
Chris@10 5121 % page, because the two columns now take up only half of the page
Chris@10 5122 % goal. When TeX sees \eject from below which follows the final
Chris@10 5123 % section, it invokes the new output routine that we've set after
Chris@10 5124 % \balancecolumns below; \onepageout will try to fit the two columns
Chris@10 5125 % and the final section into the vbox of \pageheight (see
Chris@10 5126 % \pagebody), causing an overfull box.
Chris@10 5127 %
Chris@10 5128 % Note that glue won't work here, because glue does not exercise the
Chris@10 5129 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
Chris@10 5130 \penalty0
Chris@10 5131 %
Chris@10 5132 \output = {%
Chris@10 5133 % Split the last of the double-column material. Leave it on the
Chris@10 5134 % current page, no automatic page break.
Chris@10 5135 \balancecolumns
Chris@10 5136 %
Chris@10 5137 % If we end up splitting too much material for the current page,
Chris@10 5138 % though, there will be another page break right after this \output
Chris@10 5139 % invocation ends. Having called \balancecolumns once, we do not
Chris@10 5140 % want to call it again. Therefore, reset \output to its normal
Chris@10 5141 % definition right away. (We hope \balancecolumns will never be
Chris@10 5142 % called on to balance too much material, but if it is, this makes
Chris@10 5143 % the output somewhat more palatable.)
Chris@10 5144 \global\output = {\onepageout{\pagecontents\PAGE}}%
Chris@10 5145 }%
Chris@10 5146 \eject
Chris@10 5147 \endgroup % started in \begindoublecolumns
Chris@10 5148 %
Chris@10 5149 % \pagegoal was set to the doubled \vsize above, since we restarted
Chris@10 5150 % the current page. We're now back to normal single-column
Chris@10 5151 % typesetting, so reset \pagegoal to the normal \vsize (after the
Chris@10 5152 % \endgroup where \vsize got restored).
Chris@10 5153 \pagegoal = \vsize
Chris@10 5154 }
Chris@10 5155 %
Chris@10 5156 % Called at the end of the double column material.
Chris@10 5157 \def\balancecolumns{%
Chris@10 5158 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
Chris@10 5159 \dimen@ = \ht0
Chris@10 5160 \advance\dimen@ by \topskip
Chris@10 5161 \advance\dimen@ by-\baselineskip
Chris@10 5162 \divide\dimen@ by 2 % target to split to
Chris@10 5163 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
Chris@10 5164 \splittopskip = \topskip
Chris@10 5165 % Loop until we get a decent breakpoint.
Chris@10 5166 {%
Chris@10 5167 \vbadness = 10000
Chris@10 5168 \loop
Chris@10 5169 \global\setbox3 = \copy0
Chris@10 5170 \global\setbox1 = \vsplit3 to \dimen@
Chris@10 5171 \ifdim\ht3>\dimen@
Chris@10 5172 \global\advance\dimen@ by 1pt
Chris@10 5173 \repeat
Chris@10 5174 }%
Chris@10 5175 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
Chris@10 5176 \setbox0=\vbox to\dimen@{\unvbox1}%
Chris@10 5177 \setbox2=\vbox to\dimen@{\unvbox3}%
Chris@10 5178 %
Chris@10 5179 \pagesofar
Chris@10 5180 }
Chris@10 5181 \catcode`\@ = \other
Chris@10 5182
Chris@10 5183
Chris@10 5184 \message{sectioning,}
Chris@10 5185 % Chapters, sections, etc.
Chris@10 5186
Chris@10 5187 % Let's start with @part.
Chris@10 5188 \outer\parseargdef\part{\partzzz{#1}}
Chris@10 5189 \def\partzzz#1{%
Chris@10 5190 \chapoddpage
Chris@10 5191 \null
Chris@10 5192 \vskip.3\vsize % move it down on the page a bit
Chris@10 5193 \begingroup
Chris@10 5194 \noindent \titlefonts\rmisbold #1\par % the text
Chris@10 5195 \let\lastnode=\empty % no node to associate with
Chris@10 5196 \writetocentry{part}{#1}{}% but put it in the toc
Chris@10 5197 \headingsoff % no headline or footline on the part page
Chris@10 5198 \chapoddpage
Chris@10 5199 \endgroup
Chris@10 5200 }
Chris@10 5201
Chris@10 5202 % \unnumberedno is an oxymoron. But we count the unnumbered
Chris@10 5203 % sections so that we can refer to them unambiguously in the pdf
Chris@10 5204 % outlines by their "section number". We avoid collisions with chapter
Chris@10 5205 % numbers by starting them at 10000. (If a document ever has 10000
Chris@10 5206 % chapters, we're in trouble anyway, I'm sure.)
Chris@10 5207 \newcount\unnumberedno \unnumberedno = 10000
Chris@10 5208 \newcount\chapno
Chris@10 5209 \newcount\secno \secno=0
Chris@10 5210 \newcount\subsecno \subsecno=0
Chris@10 5211 \newcount\subsubsecno \subsubsecno=0
Chris@10 5212
Chris@10 5213 % This counter is funny since it counts through charcodes of letters A, B, ...
Chris@10 5214 \newcount\appendixno \appendixno = `\@
Chris@10 5215 %
Chris@10 5216 % \def\appendixletter{\char\the\appendixno}
Chris@10 5217 % We do the following ugly conditional instead of the above simple
Chris@10 5218 % construct for the sake of pdftex, which needs the actual
Chris@10 5219 % letter in the expansion, not just typeset.
Chris@10 5220 %
Chris@10 5221 \def\appendixletter{%
Chris@10 5222 \ifnum\appendixno=`A A%
Chris@10 5223 \else\ifnum\appendixno=`B B%
Chris@10 5224 \else\ifnum\appendixno=`C C%
Chris@10 5225 \else\ifnum\appendixno=`D D%
Chris@10 5226 \else\ifnum\appendixno=`E E%
Chris@10 5227 \else\ifnum\appendixno=`F F%
Chris@10 5228 \else\ifnum\appendixno=`G G%
Chris@10 5229 \else\ifnum\appendixno=`H H%
Chris@10 5230 \else\ifnum\appendixno=`I I%
Chris@10 5231 \else\ifnum\appendixno=`J J%
Chris@10 5232 \else\ifnum\appendixno=`K K%
Chris@10 5233 \else\ifnum\appendixno=`L L%
Chris@10 5234 \else\ifnum\appendixno=`M M%
Chris@10 5235 \else\ifnum\appendixno=`N N%
Chris@10 5236 \else\ifnum\appendixno=`O O%
Chris@10 5237 \else\ifnum\appendixno=`P P%
Chris@10 5238 \else\ifnum\appendixno=`Q Q%
Chris@10 5239 \else\ifnum\appendixno=`R R%
Chris@10 5240 \else\ifnum\appendixno=`S S%
Chris@10 5241 \else\ifnum\appendixno=`T T%
Chris@10 5242 \else\ifnum\appendixno=`U U%
Chris@10 5243 \else\ifnum\appendixno=`V V%
Chris@10 5244 \else\ifnum\appendixno=`W W%
Chris@10 5245 \else\ifnum\appendixno=`X X%
Chris@10 5246 \else\ifnum\appendixno=`Y Y%
Chris@10 5247 \else\ifnum\appendixno=`Z Z%
Chris@10 5248 % The \the is necessary, despite appearances, because \appendixletter is
Chris@10 5249 % expanded while writing the .toc file. \char\appendixno is not
Chris@10 5250 % expandable, thus it is written literally, thus all appendixes come out
Chris@10 5251 % with the same letter (or @) in the toc without it.
Chris@10 5252 \else\char\the\appendixno
Chris@10 5253 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
Chris@10 5254 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
Chris@10 5255
Chris@10 5256 % Each @chapter defines these (using marks) as the number+name, number
Chris@10 5257 % and name of the chapter. Page headings and footings can use
Chris@10 5258 % these. @section does likewise.
Chris@10 5259 \def\thischapter{}
Chris@10 5260 \def\thischapternum{}
Chris@10 5261 \def\thischaptername{}
Chris@10 5262 \def\thissection{}
Chris@10 5263 \def\thissectionnum{}
Chris@10 5264 \def\thissectionname{}
Chris@10 5265
Chris@10 5266 \newcount\absseclevel % used to calculate proper heading level
Chris@10 5267 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
Chris@10 5268
Chris@10 5269 % @raisesections: treat @section as chapter, @subsection as section, etc.
Chris@10 5270 \def\raisesections{\global\advance\secbase by -1}
Chris@10 5271 \let\up=\raisesections % original BFox name
Chris@10 5272
Chris@10 5273 % @lowersections: treat @chapter as section, @section as subsection, etc.
Chris@10 5274 \def\lowersections{\global\advance\secbase by 1}
Chris@10 5275 \let\down=\lowersections % original BFox name
Chris@10 5276
Chris@10 5277 % we only have subsub.
Chris@10 5278 \chardef\maxseclevel = 3
Chris@10 5279 %
Chris@10 5280 % A numbered section within an unnumbered changes to unnumbered too.
Chris@10 5281 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
Chris@10 5282 \chardef\unnlevel = \maxseclevel
Chris@10 5283 %
Chris@10 5284 % Trace whether the current chapter is an appendix or not:
Chris@10 5285 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
Chris@10 5286 \def\chapheadtype{N}
Chris@10 5287
Chris@10 5288 % Choose a heading macro
Chris@10 5289 % #1 is heading type
Chris@10 5290 % #2 is heading level
Chris@10 5291 % #3 is text for heading
Chris@10 5292 \def\genhead#1#2#3{%
Chris@10 5293 % Compute the abs. sec. level:
Chris@10 5294 \absseclevel=#2
Chris@10 5295 \advance\absseclevel by \secbase
Chris@10 5296 % Make sure \absseclevel doesn't fall outside the range:
Chris@10 5297 \ifnum \absseclevel < 0
Chris@10 5298 \absseclevel = 0
Chris@10 5299 \else
Chris@10 5300 \ifnum \absseclevel > 3
Chris@10 5301 \absseclevel = 3
Chris@10 5302 \fi
Chris@10 5303 \fi
Chris@10 5304 % The heading type:
Chris@10 5305 \def\headtype{#1}%
Chris@10 5306 \if \headtype U%
Chris@10 5307 \ifnum \absseclevel < \unnlevel
Chris@10 5308 \chardef\unnlevel = \absseclevel
Chris@10 5309 \fi
Chris@10 5310 \else
Chris@10 5311 % Check for appendix sections:
Chris@10 5312 \ifnum \absseclevel = 0
Chris@10 5313 \edef\chapheadtype{\headtype}%
Chris@10 5314 \else
Chris@10 5315 \if \headtype A\if \chapheadtype N%
Chris@10 5316 \errmessage{@appendix... within a non-appendix chapter}%
Chris@10 5317 \fi\fi
Chris@10 5318 \fi
Chris@10 5319 % Check for numbered within unnumbered:
Chris@10 5320 \ifnum \absseclevel > \unnlevel
Chris@10 5321 \def\headtype{U}%
Chris@10 5322 \else
Chris@10 5323 \chardef\unnlevel = 3
Chris@10 5324 \fi
Chris@10 5325 \fi
Chris@10 5326 % Now print the heading:
Chris@10 5327 \if \headtype U%
Chris@10 5328 \ifcase\absseclevel
Chris@10 5329 \unnumberedzzz{#3}%
Chris@10 5330 \or \unnumberedseczzz{#3}%
Chris@10 5331 \or \unnumberedsubseczzz{#3}%
Chris@10 5332 \or \unnumberedsubsubseczzz{#3}%
Chris@10 5333 \fi
Chris@10 5334 \else
Chris@10 5335 \if \headtype A%
Chris@10 5336 \ifcase\absseclevel
Chris@10 5337 \appendixzzz{#3}%
Chris@10 5338 \or \appendixsectionzzz{#3}%
Chris@10 5339 \or \appendixsubseczzz{#3}%
Chris@10 5340 \or \appendixsubsubseczzz{#3}%
Chris@10 5341 \fi
Chris@10 5342 \else
Chris@10 5343 \ifcase\absseclevel
Chris@10 5344 \chapterzzz{#3}%
Chris@10 5345 \or \seczzz{#3}%
Chris@10 5346 \or \numberedsubseczzz{#3}%
Chris@10 5347 \or \numberedsubsubseczzz{#3}%
Chris@10 5348 \fi
Chris@10 5349 \fi
Chris@10 5350 \fi
Chris@10 5351 \suppressfirstparagraphindent
Chris@10 5352 }
Chris@10 5353
Chris@10 5354 % an interface:
Chris@10 5355 \def\numhead{\genhead N}
Chris@10 5356 \def\apphead{\genhead A}
Chris@10 5357 \def\unnmhead{\genhead U}
Chris@10 5358
Chris@10 5359 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
Chris@10 5360 % all lower-level sectioning counters to zero.
Chris@10 5361 %
Chris@10 5362 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
Chris@10 5363 % (e.g., figures), q.v. By default (before any chapter), that is empty.
Chris@10 5364 \let\chaplevelprefix = \empty
Chris@10 5365 %
Chris@10 5366 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
Chris@10 5367 \def\chapterzzz#1{%
Chris@10 5368 % section resetting is \global in case the chapter is in a group, such
Chris@10 5369 % as an @include file.
Chris@10 5370 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
Chris@10 5371 \global\advance\chapno by 1
Chris@10 5372 %
Chris@10 5373 % Used for \float.
Chris@10 5374 \gdef\chaplevelprefix{\the\chapno.}%
Chris@10 5375 \resetallfloatnos
Chris@10 5376 %
Chris@10 5377 % \putwordChapter can contain complex things in translations.
Chris@10 5378 \toks0=\expandafter{\putwordChapter}%
Chris@10 5379 \message{\the\toks0 \space \the\chapno}%
Chris@10 5380 %
Chris@10 5381 % Write the actual heading.
Chris@10 5382 \chapmacro{#1}{Ynumbered}{\the\chapno}%
Chris@10 5383 %
Chris@10 5384 % So @section and the like are numbered underneath this chapter.
Chris@10 5385 \global\let\section = \numberedsec
Chris@10 5386 \global\let\subsection = \numberedsubsec
Chris@10 5387 \global\let\subsubsection = \numberedsubsubsec
Chris@10 5388 }
Chris@10 5389
Chris@10 5390 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
Chris@10 5391 %
Chris@10 5392 \def\appendixzzz#1{%
Chris@10 5393 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
Chris@10 5394 \global\advance\appendixno by 1
Chris@10 5395 \gdef\chaplevelprefix{\appendixletter.}%
Chris@10 5396 \resetallfloatnos
Chris@10 5397 %
Chris@10 5398 % \putwordAppendix can contain complex things in translations.
Chris@10 5399 \toks0=\expandafter{\putwordAppendix}%
Chris@10 5400 \message{\the\toks0 \space \appendixletter}%
Chris@10 5401 %
Chris@10 5402 \chapmacro{#1}{Yappendix}{\appendixletter}%
Chris@10 5403 %
Chris@10 5404 \global\let\section = \appendixsec
Chris@10 5405 \global\let\subsection = \appendixsubsec
Chris@10 5406 \global\let\subsubsection = \appendixsubsubsec
Chris@10 5407 }
Chris@10 5408
Chris@10 5409 % normally unnmhead0 calls unnumberedzzz:
Chris@10 5410 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
Chris@10 5411 \def\unnumberedzzz#1{%
Chris@10 5412 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
Chris@10 5413 \global\advance\unnumberedno by 1
Chris@10 5414 %
Chris@10 5415 % Since an unnumbered has no number, no prefix for figures.
Chris@10 5416 \global\let\chaplevelprefix = \empty
Chris@10 5417 \resetallfloatnos
Chris@10 5418 %
Chris@10 5419 % This used to be simply \message{#1}, but TeX fully expands the
Chris@10 5420 % argument to \message. Therefore, if #1 contained @-commands, TeX
Chris@10 5421 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
Chris@10 5422 % expanded @cite (which turns out to cause errors because \cite is meant
Chris@10 5423 % to be executed, not expanded).
Chris@10 5424 %
Chris@10 5425 % Anyway, we don't want the fully-expanded definition of @cite to appear
Chris@10 5426 % as a result of the \message, we just want `@cite' itself. We use
Chris@10 5427 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
Chris@10 5428 % simply yielding the contents of <toks register>. (We also do this for
Chris@10 5429 % the toc entries.)
Chris@10 5430 \toks0 = {#1}%
Chris@10 5431 \message{(\the\toks0)}%
Chris@10 5432 %
Chris@10 5433 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
Chris@10 5434 %
Chris@10 5435 \global\let\section = \unnumberedsec
Chris@10 5436 \global\let\subsection = \unnumberedsubsec
Chris@10 5437 \global\let\subsubsection = \unnumberedsubsubsec
Chris@10 5438 }
Chris@10 5439
Chris@10 5440 % @centerchap is like @unnumbered, but the heading is centered.
Chris@10 5441 \outer\parseargdef\centerchap{%
Chris@10 5442 % Well, we could do the following in a group, but that would break
Chris@10 5443 % an assumption that \chapmacro is called at the outermost level.
Chris@10 5444 % Thus we are safer this way: --kasal, 24feb04
Chris@10 5445 \let\centerparametersmaybe = \centerparameters
Chris@10 5446 \unnmhead0{#1}%
Chris@10 5447 \let\centerparametersmaybe = \relax
Chris@10 5448 }
Chris@10 5449
Chris@10 5450 % @top is like @unnumbered.
Chris@10 5451 \let\top\unnumbered
Chris@10 5452
Chris@10 5453 % Sections.
Chris@10 5454 %
Chris@10 5455 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
Chris@10 5456 \def\seczzz#1{%
Chris@10 5457 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
Chris@10 5458 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
Chris@10 5459 }
Chris@10 5460
Chris@10 5461 % normally calls appendixsectionzzz:
Chris@10 5462 \outer\parseargdef\appendixsection{\apphead1{#1}}
Chris@10 5463 \def\appendixsectionzzz#1{%
Chris@10 5464 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
Chris@10 5465 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
Chris@10 5466 }
Chris@10 5467 \let\appendixsec\appendixsection
Chris@10 5468
Chris@10 5469 % normally calls unnumberedseczzz:
Chris@10 5470 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
Chris@10 5471 \def\unnumberedseczzz#1{%
Chris@10 5472 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
Chris@10 5473 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
Chris@10 5474 }
Chris@10 5475
Chris@10 5476 % Subsections.
Chris@10 5477 %
Chris@10 5478 % normally calls numberedsubseczzz:
Chris@10 5479 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
Chris@10 5480 \def\numberedsubseczzz#1{%
Chris@10 5481 \global\subsubsecno=0 \global\advance\subsecno by 1
Chris@10 5482 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
Chris@10 5483 }
Chris@10 5484
Chris@10 5485 % normally calls appendixsubseczzz:
Chris@10 5486 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
Chris@10 5487 \def\appendixsubseczzz#1{%
Chris@10 5488 \global\subsubsecno=0 \global\advance\subsecno by 1
Chris@10 5489 \sectionheading{#1}{subsec}{Yappendix}%
Chris@10 5490 {\appendixletter.\the\secno.\the\subsecno}%
Chris@10 5491 }
Chris@10 5492
Chris@10 5493 % normally calls unnumberedsubseczzz:
Chris@10 5494 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
Chris@10 5495 \def\unnumberedsubseczzz#1{%
Chris@10 5496 \global\subsubsecno=0 \global\advance\subsecno by 1
Chris@10 5497 \sectionheading{#1}{subsec}{Ynothing}%
Chris@10 5498 {\the\unnumberedno.\the\secno.\the\subsecno}%
Chris@10 5499 }
Chris@10 5500
Chris@10 5501 % Subsubsections.
Chris@10 5502 %
Chris@10 5503 % normally numberedsubsubseczzz:
Chris@10 5504 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
Chris@10 5505 \def\numberedsubsubseczzz#1{%
Chris@10 5506 \global\advance\subsubsecno by 1
Chris@10 5507 \sectionheading{#1}{subsubsec}{Ynumbered}%
Chris@10 5508 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
Chris@10 5509 }
Chris@10 5510
Chris@10 5511 % normally appendixsubsubseczzz:
Chris@10 5512 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
Chris@10 5513 \def\appendixsubsubseczzz#1{%
Chris@10 5514 \global\advance\subsubsecno by 1
Chris@10 5515 \sectionheading{#1}{subsubsec}{Yappendix}%
Chris@10 5516 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
Chris@10 5517 }
Chris@10 5518
Chris@10 5519 % normally unnumberedsubsubseczzz:
Chris@10 5520 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
Chris@10 5521 \def\unnumberedsubsubseczzz#1{%
Chris@10 5522 \global\advance\subsubsecno by 1
Chris@10 5523 \sectionheading{#1}{subsubsec}{Ynothing}%
Chris@10 5524 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
Chris@10 5525 }
Chris@10 5526
Chris@10 5527 % These macros control what the section commands do, according
Chris@10 5528 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
Chris@10 5529 % Define them by default for a numbered chapter.
Chris@10 5530 \let\section = \numberedsec
Chris@10 5531 \let\subsection = \numberedsubsec
Chris@10 5532 \let\subsubsection = \numberedsubsubsec
Chris@10 5533
Chris@10 5534 % Define @majorheading, @heading and @subheading
Chris@10 5535
Chris@10 5536 % NOTE on use of \vbox for chapter headings, section headings, and such:
Chris@10 5537 % 1) We use \vbox rather than the earlier \line to permit
Chris@10 5538 % overlong headings to fold.
Chris@10 5539 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
Chris@10 5540 % heading is obnoxious; this forbids it.
Chris@10 5541 % 3) Likewise, headings look best if no \parindent is used, and
Chris@10 5542 % if justification is not attempted. Hence \raggedright.
Chris@10 5543
Chris@10 5544 \def\majorheading{%
Chris@10 5545 {\advance\chapheadingskip by 10pt \chapbreak }%
Chris@10 5546 \parsearg\chapheadingzzz
Chris@10 5547 }
Chris@10 5548
Chris@10 5549 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
Chris@10 5550 \def\chapheadingzzz#1{%
Chris@10 5551 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
Chris@10 5552 \parindent=0pt\ptexraggedright
Chris@10 5553 \rmisbold #1\hfill}}%
Chris@10 5554 \bigskip \par\penalty 200\relax
Chris@10 5555 \suppressfirstparagraphindent
Chris@10 5556 }
Chris@10 5557
Chris@10 5558 % @heading, @subheading, @subsubheading.
Chris@10 5559 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
Chris@10 5560 \suppressfirstparagraphindent}
Chris@10 5561 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
Chris@10 5562 \suppressfirstparagraphindent}
Chris@10 5563 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
Chris@10 5564 \suppressfirstparagraphindent}
Chris@10 5565
Chris@10 5566 % These macros generate a chapter, section, etc. heading only
Chris@10 5567 % (including whitespace, linebreaking, etc. around it),
Chris@10 5568 % given all the information in convenient, parsed form.
Chris@10 5569
Chris@10 5570 % Args are the skip and penalty (usually negative)
Chris@10 5571 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
Chris@10 5572
Chris@10 5573 % Parameter controlling skip before chapter headings (if needed)
Chris@10 5574 \newskip\chapheadingskip
Chris@10 5575
Chris@10 5576 % Define plain chapter starts, and page on/off switching for it.
Chris@10 5577 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
Chris@10 5578 \def\chappager{\par\vfill\supereject}
Chris@10 5579 % Because \domark is called before \chapoddpage, the filler page will
Chris@10 5580 % get the headings for the next chapter, which is wrong. But we don't
Chris@10 5581 % care -- we just disable all headings on the filler page.
Chris@10 5582 \def\chapoddpage{%
Chris@10 5583 \chappager
Chris@10 5584 \ifodd\pageno \else
Chris@10 5585 \begingroup
Chris@10 5586 \headingsoff
Chris@10 5587 \null
Chris@10 5588 \chappager
Chris@10 5589 \endgroup
Chris@10 5590 \fi
Chris@10 5591 }
Chris@10 5592
Chris@10 5593 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
Chris@10 5594
Chris@10 5595 \def\CHAPPAGoff{%
Chris@10 5596 \global\let\contentsalignmacro = \chappager
Chris@10 5597 \global\let\pchapsepmacro=\chapbreak
Chris@10 5598 \global\let\pagealignmacro=\chappager}
Chris@10 5599
Chris@10 5600 \def\CHAPPAGon{%
Chris@10 5601 \global\let\contentsalignmacro = \chappager
Chris@10 5602 \global\let\pchapsepmacro=\chappager
Chris@10 5603 \global\let\pagealignmacro=\chappager
Chris@10 5604 \global\def\HEADINGSon{\HEADINGSsingle}}
Chris@10 5605
Chris@10 5606 \def\CHAPPAGodd{%
Chris@10 5607 \global\let\contentsalignmacro = \chapoddpage
Chris@10 5608 \global\let\pchapsepmacro=\chapoddpage
Chris@10 5609 \global\let\pagealignmacro=\chapoddpage
Chris@10 5610 \global\def\HEADINGSon{\HEADINGSdouble}}
Chris@10 5611
Chris@10 5612 \CHAPPAGon
Chris@10 5613
Chris@10 5614 % Chapter opening.
Chris@10 5615 %
Chris@10 5616 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
Chris@10 5617 % Yappendix, Yomitfromtoc), #3 the chapter number.
Chris@10 5618 %
Chris@10 5619 % To test against our argument.
Chris@10 5620 \def\Ynothingkeyword{Ynothing}
Chris@10 5621 \def\Yomitfromtockeyword{Yomitfromtoc}
Chris@10 5622 \def\Yappendixkeyword{Yappendix}
Chris@10 5623 %
Chris@10 5624 \def\chapmacro#1#2#3{%
Chris@10 5625 % Insert the first mark before the heading break (see notes for \domark).
Chris@10 5626 \let\prevchapterdefs=\lastchapterdefs
Chris@10 5627 \let\prevsectiondefs=\lastsectiondefs
Chris@10 5628 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
Chris@10 5629 \gdef\thissection{}}%
Chris@10 5630 %
Chris@10 5631 \def\temptype{#2}%
Chris@10 5632 \ifx\temptype\Ynothingkeyword
Chris@10 5633 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
Chris@10 5634 \gdef\thischapter{\thischaptername}}%
Chris@10 5635 \else\ifx\temptype\Yomitfromtockeyword
Chris@10 5636 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
Chris@10 5637 \gdef\thischapter{}}%
Chris@10 5638 \else\ifx\temptype\Yappendixkeyword
Chris@10 5639 \toks0={#1}%
Chris@10 5640 \xdef\lastchapterdefs{%
Chris@10 5641 \gdef\noexpand\thischaptername{\the\toks0}%
Chris@10 5642 \gdef\noexpand\thischapternum{\appendixletter}%
Chris@10 5643 % \noexpand\putwordAppendix avoids expanding indigestible
Chris@10 5644 % commands in some of the translations.
Chris@10 5645 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
Chris@10 5646 \noexpand\thischapternum:
Chris@10 5647 \noexpand\thischaptername}%
Chris@10 5648 }%
Chris@10 5649 \else
Chris@10 5650 \toks0={#1}%
Chris@10 5651 \xdef\lastchapterdefs{%
Chris@10 5652 \gdef\noexpand\thischaptername{\the\toks0}%
Chris@10 5653 \gdef\noexpand\thischapternum{\the\chapno}%
Chris@10 5654 % \noexpand\putwordChapter avoids expanding indigestible
Chris@10 5655 % commands in some of the translations.
Chris@10 5656 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
Chris@10 5657 \noexpand\thischapternum:
Chris@10 5658 \noexpand\thischaptername}%
Chris@10 5659 }%
Chris@10 5660 \fi\fi\fi
Chris@10 5661 %
Chris@10 5662 % Output the mark. Pass it through \safewhatsit, to take care of
Chris@10 5663 % the preceding space.
Chris@10 5664 \safewhatsit\domark
Chris@10 5665 %
Chris@10 5666 % Insert the chapter heading break.
Chris@10 5667 \pchapsepmacro
Chris@10 5668 %
Chris@10 5669 % Now the second mark, after the heading break. No break points
Chris@10 5670 % between here and the heading.
Chris@10 5671 \let\prevchapterdefs=\lastchapterdefs
Chris@10 5672 \let\prevsectiondefs=\lastsectiondefs
Chris@10 5673 \domark
Chris@10 5674 %
Chris@10 5675 {%
Chris@10 5676 \chapfonts \rmisbold
Chris@10 5677 %
Chris@10 5678 % Have to define \lastsection before calling \donoderef, because the
Chris@10 5679 % xref code eventually uses it. On the other hand, it has to be called
Chris@10 5680 % after \pchapsepmacro, or the headline will change too soon.
Chris@10 5681 \gdef\lastsection{#1}%
Chris@10 5682 %
Chris@10 5683 % Only insert the separating space if we have a chapter/appendix
Chris@10 5684 % number, and don't print the unnumbered ``number''.
Chris@10 5685 \ifx\temptype\Ynothingkeyword
Chris@10 5686 \setbox0 = \hbox{}%
Chris@10 5687 \def\toctype{unnchap}%
Chris@10 5688 \else\ifx\temptype\Yomitfromtockeyword
Chris@10 5689 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
Chris@10 5690 \def\toctype{omit}%
Chris@10 5691 \else\ifx\temptype\Yappendixkeyword
Chris@10 5692 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
Chris@10 5693 \def\toctype{app}%
Chris@10 5694 \else
Chris@10 5695 \setbox0 = \hbox{#3\enspace}%
Chris@10 5696 \def\toctype{numchap}%
Chris@10 5697 \fi\fi\fi
Chris@10 5698 %
Chris@10 5699 % Write the toc entry for this chapter. Must come before the
Chris@10 5700 % \donoderef, because we include the current node name in the toc
Chris@10 5701 % entry, and \donoderef resets it to empty.
Chris@10 5702 \writetocentry{\toctype}{#1}{#3}%
Chris@10 5703 %
Chris@10 5704 % For pdftex, we have to write out the node definition (aka, make
Chris@10 5705 % the pdfdest) after any page break, but before the actual text has
Chris@10 5706 % been typeset. If the destination for the pdf outline is after the
Chris@10 5707 % text, then jumping from the outline may wind up with the text not
Chris@10 5708 % being visible, for instance under high magnification.
Chris@10 5709 \donoderef{#2}%
Chris@10 5710 %
Chris@10 5711 % Typeset the actual heading.
Chris@10 5712 \nobreak % Avoid page breaks at the interline glue.
Chris@10 5713 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
Chris@10 5714 \hangindent=\wd0 \centerparametersmaybe
Chris@10 5715 \unhbox0 #1\par}%
Chris@10 5716 }%
Chris@10 5717 \nobreak\bigskip % no page break after a chapter title
Chris@10 5718 \nobreak
Chris@10 5719 }
Chris@10 5720
Chris@10 5721 % @centerchap -- centered and unnumbered.
Chris@10 5722 \let\centerparametersmaybe = \relax
Chris@10 5723 \def\centerparameters{%
Chris@10 5724 \advance\rightskip by 3\rightskip
Chris@10 5725 \leftskip = \rightskip
Chris@10 5726 \parfillskip = 0pt
Chris@10 5727 }
Chris@10 5728
Chris@10 5729
Chris@10 5730 % I don't think this chapter style is supported any more, so I'm not
Chris@10 5731 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
Chris@10 5732 %
Chris@10 5733 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
Chris@10 5734 %
Chris@10 5735 \def\unnchfopen #1{%
Chris@10 5736 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
Chris@10 5737 \parindent=0pt\ptexraggedright
Chris@10 5738 \rmisbold #1\hfill}}\bigskip \par\nobreak
Chris@10 5739 }
Chris@10 5740 \def\chfopen #1#2{\chapoddpage {\chapfonts
Chris@10 5741 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
Chris@10 5742 \par\penalty 5000 %
Chris@10 5743 }
Chris@10 5744 \def\centerchfopen #1{%
Chris@10 5745 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
Chris@10 5746 \parindent=0pt
Chris@10 5747 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
Chris@10 5748 }
Chris@10 5749 \def\CHAPFopen{%
Chris@10 5750 \global\let\chapmacro=\chfopen
Chris@10 5751 \global\let\centerchapmacro=\centerchfopen}
Chris@10 5752
Chris@10 5753
Chris@10 5754 % Section titles. These macros combine the section number parts and
Chris@10 5755 % call the generic \sectionheading to do the printing.
Chris@10 5756 %
Chris@10 5757 \newskip\secheadingskip
Chris@10 5758 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
Chris@10 5759
Chris@10 5760 % Subsection titles.
Chris@10 5761 \newskip\subsecheadingskip
Chris@10 5762 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
Chris@10 5763
Chris@10 5764 % Subsubsection titles.
Chris@10 5765 \def\subsubsecheadingskip{\subsecheadingskip}
Chris@10 5766 \def\subsubsecheadingbreak{\subsecheadingbreak}
Chris@10 5767
Chris@10 5768
Chris@10 5769 % Print any size, any type, section title.
Chris@10 5770 %
Chris@10 5771 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
Chris@10 5772 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
Chris@10 5773 % section number.
Chris@10 5774 %
Chris@10 5775 \def\seckeyword{sec}
Chris@10 5776 %
Chris@10 5777 \def\sectionheading#1#2#3#4{%
Chris@10 5778 {%
Chris@10 5779 \checkenv{}% should not be in an environment.
Chris@10 5780 %
Chris@10 5781 % Switch to the right set of fonts.
Chris@10 5782 \csname #2fonts\endcsname \rmisbold
Chris@10 5783 %
Chris@10 5784 \def\sectionlevel{#2}%
Chris@10 5785 \def\temptype{#3}%
Chris@10 5786 %
Chris@10 5787 % Insert first mark before the heading break (see notes for \domark).
Chris@10 5788 \let\prevsectiondefs=\lastsectiondefs
Chris@10 5789 \ifx\temptype\Ynothingkeyword
Chris@10 5790 \ifx\sectionlevel\seckeyword
Chris@10 5791 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
Chris@10 5792 \gdef\thissection{\thissectionname}}%
Chris@10 5793 \fi
Chris@10 5794 \else\ifx\temptype\Yomitfromtockeyword
Chris@10 5795 % Don't redefine \thissection.
Chris@10 5796 \else\ifx\temptype\Yappendixkeyword
Chris@10 5797 \ifx\sectionlevel\seckeyword
Chris@10 5798 \toks0={#1}%
Chris@10 5799 \xdef\lastsectiondefs{%
Chris@10 5800 \gdef\noexpand\thissectionname{\the\toks0}%
Chris@10 5801 \gdef\noexpand\thissectionnum{#4}%
Chris@10 5802 % \noexpand\putwordSection avoids expanding indigestible
Chris@10 5803 % commands in some of the translations.
Chris@10 5804 \gdef\noexpand\thissection{\noexpand\putwordSection{}
Chris@10 5805 \noexpand\thissectionnum:
Chris@10 5806 \noexpand\thissectionname}%
Chris@10 5807 }%
Chris@10 5808 \fi
Chris@10 5809 \else
Chris@10 5810 \ifx\sectionlevel\seckeyword
Chris@10 5811 \toks0={#1}%
Chris@10 5812 \xdef\lastsectiondefs{%
Chris@10 5813 \gdef\noexpand\thissectionname{\the\toks0}%
Chris@10 5814 \gdef\noexpand\thissectionnum{#4}%
Chris@10 5815 % \noexpand\putwordSection avoids expanding indigestible
Chris@10 5816 % commands in some of the translations.
Chris@10 5817 \gdef\noexpand\thissection{\noexpand\putwordSection{}
Chris@10 5818 \noexpand\thissectionnum:
Chris@10 5819 \noexpand\thissectionname}%
Chris@10 5820 }%
Chris@10 5821 \fi
Chris@10 5822 \fi\fi\fi
Chris@10 5823 %
Chris@10 5824 % Go into vertical mode. Usually we'll already be there, but we
Chris@10 5825 % don't want the following whatsit to end up in a preceding paragraph
Chris@10 5826 % if the document didn't happen to have a blank line.
Chris@10 5827 \par
Chris@10 5828 %
Chris@10 5829 % Output the mark. Pass it through \safewhatsit, to take care of
Chris@10 5830 % the preceding space.
Chris@10 5831 \safewhatsit\domark
Chris@10 5832 %
Chris@10 5833 % Insert space above the heading.
Chris@10 5834 \csname #2headingbreak\endcsname
Chris@10 5835 %
Chris@10 5836 % Now the second mark, after the heading break. No break points
Chris@10 5837 % between here and the heading.
Chris@10 5838 \let\prevsectiondefs=\lastsectiondefs
Chris@10 5839 \domark
Chris@10 5840 %
Chris@10 5841 % Only insert the space after the number if we have a section number.
Chris@10 5842 \ifx\temptype\Ynothingkeyword
Chris@10 5843 \setbox0 = \hbox{}%
Chris@10 5844 \def\toctype{unn}%
Chris@10 5845 \gdef\lastsection{#1}%
Chris@10 5846 \else\ifx\temptype\Yomitfromtockeyword
Chris@10 5847 % for @headings -- no section number, don't include in toc,
Chris@10 5848 % and don't redefine \lastsection.
Chris@10 5849 \setbox0 = \hbox{}%
Chris@10 5850 \def\toctype{omit}%
Chris@10 5851 \let\sectionlevel=\empty
Chris@10 5852 \else\ifx\temptype\Yappendixkeyword
Chris@10 5853 \setbox0 = \hbox{#4\enspace}%
Chris@10 5854 \def\toctype{app}%
Chris@10 5855 \gdef\lastsection{#1}%
Chris@10 5856 \else
Chris@10 5857 \setbox0 = \hbox{#4\enspace}%
Chris@10 5858 \def\toctype{num}%
Chris@10 5859 \gdef\lastsection{#1}%
Chris@10 5860 \fi\fi\fi
Chris@10 5861 %
Chris@10 5862 % Write the toc entry (before \donoderef). See comments in \chapmacro.
Chris@10 5863 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
Chris@10 5864 %
Chris@10 5865 % Write the node reference (= pdf destination for pdftex).
Chris@10 5866 % Again, see comments in \chapmacro.
Chris@10 5867 \donoderef{#3}%
Chris@10 5868 %
Chris@10 5869 % Interline glue will be inserted when the vbox is completed.
Chris@10 5870 % That glue will be a valid breakpoint for the page, since it'll be
Chris@10 5871 % preceded by a whatsit (usually from the \donoderef, or from the
Chris@10 5872 % \writetocentry if there was no node). We don't want to allow that
Chris@10 5873 % break, since then the whatsits could end up on page n while the
Chris@10 5874 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
Chris@10 5875 \nobreak
Chris@10 5876 %
Chris@10 5877 % Output the actual section heading.
Chris@10 5878 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
Chris@10 5879 \hangindent=\wd0 % zero if no section number
Chris@10 5880 \unhbox0 #1}%
Chris@10 5881 }%
Chris@10 5882 % Add extra space after the heading -- half of whatever came above it.
Chris@10 5883 % Don't allow stretch, though.
Chris@10 5884 \kern .5 \csname #2headingskip\endcsname
Chris@10 5885 %
Chris@10 5886 % Do not let the kern be a potential breakpoint, as it would be if it
Chris@10 5887 % was followed by glue.
Chris@10 5888 \nobreak
Chris@10 5889 %
Chris@10 5890 % We'll almost certainly start a paragraph next, so don't let that
Chris@10 5891 % glue accumulate. (Not a breakpoint because it's preceded by a
Chris@10 5892 % discardable item.) However, when a paragraph is not started next
Chris@10 5893 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
Chris@10 5894 % or the negative glue will cause weirdly wrong output, typically
Chris@10 5895 % obscuring the section heading with something else.
Chris@10 5896 \vskip-\parskip
Chris@10 5897 %
Chris@10 5898 % This is so the last item on the main vertical list is a known
Chris@10 5899 % \penalty > 10000, so \startdefun, etc., can recognize the situation
Chris@10 5900 % and do the needful.
Chris@10 5901 \penalty 10001
Chris@10 5902 }
Chris@10 5903
Chris@10 5904
Chris@10 5905 \message{toc,}
Chris@10 5906 % Table of contents.
Chris@10 5907 \newwrite\tocfile
Chris@10 5908
Chris@10 5909 % Write an entry to the toc file, opening it if necessary.
Chris@10 5910 % Called from @chapter, etc.
Chris@10 5911 %
Chris@10 5912 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
Chris@10 5913 % We append the current node name (if any) and page number as additional
Chris@10 5914 % arguments for the \{chap,sec,...}entry macros which will eventually
Chris@10 5915 % read this. The node name is used in the pdf outlines as the
Chris@10 5916 % destination to jump to.
Chris@10 5917 %
Chris@10 5918 % We open the .toc file for writing here instead of at @setfilename (or
Chris@10 5919 % any other fixed time) so that @contents can be anywhere in the document.
Chris@10 5920 % But if #1 is `omit', then we don't do anything. This is used for the
Chris@10 5921 % table of contents chapter openings themselves.
Chris@10 5922 %
Chris@10 5923 \newif\iftocfileopened
Chris@10 5924 \def\omitkeyword{omit}%
Chris@10 5925 %
Chris@10 5926 \def\writetocentry#1#2#3{%
Chris@10 5927 \edef\writetoctype{#1}%
Chris@10 5928 \ifx\writetoctype\omitkeyword \else
Chris@10 5929 \iftocfileopened\else
Chris@10 5930 \immediate\openout\tocfile = \jobname.toc
Chris@10 5931 \global\tocfileopenedtrue
Chris@10 5932 \fi
Chris@10 5933 %
Chris@10 5934 \iflinks
Chris@10 5935 {\atdummies
Chris@10 5936 \edef\temp{%
Chris@10 5937 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
Chris@10 5938 \temp
Chris@10 5939 }%
Chris@10 5940 \fi
Chris@10 5941 \fi
Chris@10 5942 %
Chris@10 5943 % Tell \shipout to create a pdf destination on each page, if we're
Chris@10 5944 % writing pdf. These are used in the table of contents. We can't
Chris@10 5945 % just write one on every page because the title pages are numbered
Chris@10 5946 % 1 and 2 (the page numbers aren't printed), and so are the first
Chris@10 5947 % two pages of the document. Thus, we'd have two destinations named
Chris@10 5948 % `1', and two named `2'.
Chris@10 5949 \ifpdf \global\pdfmakepagedesttrue \fi
Chris@10 5950 }
Chris@10 5951
Chris@10 5952
Chris@10 5953 % These characters do not print properly in the Computer Modern roman
Chris@10 5954 % fonts, so we must take special care. This is more or less redundant
Chris@10 5955 % with the Texinfo input format setup at the end of this file.
Chris@10 5956 %
Chris@10 5957 \def\activecatcodes{%
Chris@10 5958 \catcode`\"=\active
Chris@10 5959 \catcode`\$=\active
Chris@10 5960 \catcode`\<=\active
Chris@10 5961 \catcode`\>=\active
Chris@10 5962 \catcode`\\=\active
Chris@10 5963 \catcode`\^=\active
Chris@10 5964 \catcode`\_=\active
Chris@10 5965 \catcode`\|=\active
Chris@10 5966 \catcode`\~=\active
Chris@10 5967 }
Chris@10 5968
Chris@10 5969
Chris@10 5970 % Read the toc file, which is essentially Texinfo input.
Chris@10 5971 \def\readtocfile{%
Chris@10 5972 \setupdatafile
Chris@10 5973 \activecatcodes
Chris@10 5974 \input \tocreadfilename
Chris@10 5975 }
Chris@10 5976
Chris@10 5977 \newskip\contentsrightmargin \contentsrightmargin=1in
Chris@10 5978 \newcount\savepageno
Chris@10 5979 \newcount\lastnegativepageno \lastnegativepageno = -1
Chris@10 5980
Chris@10 5981 % Prepare to read what we've written to \tocfile.
Chris@10 5982 %
Chris@10 5983 \def\startcontents#1{%
Chris@10 5984 % If @setchapternewpage on, and @headings double, the contents should
Chris@10 5985 % start on an odd page, unlike chapters. Thus, we maintain
Chris@10 5986 % \contentsalignmacro in parallel with \pagealignmacro.
Chris@10 5987 % From: Torbjorn Granlund <tege@matematik.su.se>
Chris@10 5988 \contentsalignmacro
Chris@10 5989 \immediate\closeout\tocfile
Chris@10 5990 %
Chris@10 5991 % Don't need to put `Contents' or `Short Contents' in the headline.
Chris@10 5992 % It is abundantly clear what they are.
Chris@10 5993 \chapmacro{#1}{Yomitfromtoc}{}%
Chris@10 5994 %
Chris@10 5995 \savepageno = \pageno
Chris@10 5996 \begingroup % Set up to handle contents files properly.
Chris@10 5997 \raggedbottom % Worry more about breakpoints than the bottom.
Chris@10 5998 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
Chris@10 5999 %
Chris@10 6000 % Roman numerals for page numbers.
Chris@10 6001 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
Chris@10 6002 }
Chris@10 6003
Chris@10 6004 % redefined for the two-volume lispref. We always output on
Chris@10 6005 % \jobname.toc even if this is redefined.
Chris@10 6006 %
Chris@10 6007 \def\tocreadfilename{\jobname.toc}
Chris@10 6008
Chris@10 6009 % Normal (long) toc.
Chris@10 6010 %
Chris@10 6011 \def\contents{%
Chris@10 6012 \startcontents{\putwordTOC}%
Chris@10 6013 \openin 1 \tocreadfilename\space
Chris@10 6014 \ifeof 1 \else
Chris@10 6015 \readtocfile
Chris@10 6016 \fi
Chris@10 6017 \vfill \eject
Chris@10 6018 \contentsalignmacro % in case @setchapternewpage odd is in effect
Chris@10 6019 \ifeof 1 \else
Chris@10 6020 \pdfmakeoutlines
Chris@10 6021 \fi
Chris@10 6022 \closein 1
Chris@10 6023 \endgroup
Chris@10 6024 \lastnegativepageno = \pageno
Chris@10 6025 \global\pageno = \savepageno
Chris@10 6026 }
Chris@10 6027
Chris@10 6028 % And just the chapters.
Chris@10 6029 \def\summarycontents{%
Chris@10 6030 \startcontents{\putwordShortTOC}%
Chris@10 6031 %
Chris@10 6032 \let\partentry = \shortpartentry
Chris@10 6033 \let\numchapentry = \shortchapentry
Chris@10 6034 \let\appentry = \shortchapentry
Chris@10 6035 \let\unnchapentry = \shortunnchapentry
Chris@10 6036 % We want a true roman here for the page numbers.
Chris@10 6037 \secfonts
Chris@10 6038 \let\rm=\shortcontrm \let\bf=\shortcontbf
Chris@10 6039 \let\sl=\shortcontsl \let\tt=\shortconttt
Chris@10 6040 \rm
Chris@10 6041 \hyphenpenalty = 10000
Chris@10 6042 \advance\baselineskip by 1pt % Open it up a little.
Chris@10 6043 \def\numsecentry##1##2##3##4{}
Chris@10 6044 \let\appsecentry = \numsecentry
Chris@10 6045 \let\unnsecentry = \numsecentry
Chris@10 6046 \let\numsubsecentry = \numsecentry
Chris@10 6047 \let\appsubsecentry = \numsecentry
Chris@10 6048 \let\unnsubsecentry = \numsecentry
Chris@10 6049 \let\numsubsubsecentry = \numsecentry
Chris@10 6050 \let\appsubsubsecentry = \numsecentry
Chris@10 6051 \let\unnsubsubsecentry = \numsecentry
Chris@10 6052 \openin 1 \tocreadfilename\space
Chris@10 6053 \ifeof 1 \else
Chris@10 6054 \readtocfile
Chris@10 6055 \fi
Chris@10 6056 \closein 1
Chris@10 6057 \vfill \eject
Chris@10 6058 \contentsalignmacro % in case @setchapternewpage odd is in effect
Chris@10 6059 \endgroup
Chris@10 6060 \lastnegativepageno = \pageno
Chris@10 6061 \global\pageno = \savepageno
Chris@10 6062 }
Chris@10 6063 \let\shortcontents = \summarycontents
Chris@10 6064
Chris@10 6065 % Typeset the label for a chapter or appendix for the short contents.
Chris@10 6066 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
Chris@10 6067 %
Chris@10 6068 \def\shortchaplabel#1{%
Chris@10 6069 % This space should be enough, since a single number is .5em, and the
Chris@10 6070 % widest letter (M) is 1em, at least in the Computer Modern fonts.
Chris@10 6071 % But use \hss just in case.
Chris@10 6072 % (This space doesn't include the extra space that gets added after
Chris@10 6073 % the label; that gets put in by \shortchapentry above.)
Chris@10 6074 %
Chris@10 6075 % We'd like to right-justify chapter numbers, but that looks strange
Chris@10 6076 % with appendix letters. And right-justifying numbers and
Chris@10 6077 % left-justifying letters looks strange when there is less than 10
Chris@10 6078 % chapters. Have to read the whole toc once to know how many chapters
Chris@10 6079 % there are before deciding ...
Chris@10 6080 \hbox to 1em{#1\hss}%
Chris@10 6081 }
Chris@10 6082
Chris@10 6083 % These macros generate individual entries in the table of contents.
Chris@10 6084 % The first argument is the chapter or section name.
Chris@10 6085 % The last argument is the page number.
Chris@10 6086 % The arguments in between are the chapter number, section number, ...
Chris@10 6087
Chris@10 6088 % Parts, in the main contents. Replace the part number, which doesn't
Chris@10 6089 % exist, with an empty box. Let's hope all the numbers have the same width.
Chris@10 6090 % Also ignore the page number, which is conventionally not printed.
Chris@10 6091 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
Chris@10 6092 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
Chris@10 6093 %
Chris@10 6094 % Parts, in the short toc.
Chris@10 6095 \def\shortpartentry#1#2#3#4{%
Chris@10 6096 \penalty-300
Chris@10 6097 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
Chris@10 6098 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
Chris@10 6099 }
Chris@10 6100
Chris@10 6101 % Chapters, in the main contents.
Chris@10 6102 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
Chris@10 6103 %
Chris@10 6104 % Chapters, in the short toc.
Chris@10 6105 % See comments in \dochapentry re vbox and related settings.
Chris@10 6106 \def\shortchapentry#1#2#3#4{%
Chris@10 6107 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
Chris@10 6108 }
Chris@10 6109
Chris@10 6110 % Appendices, in the main contents.
Chris@10 6111 % Need the word Appendix, and a fixed-size box.
Chris@10 6112 %
Chris@10 6113 \def\appendixbox#1{%
Chris@10 6114 % We use M since it's probably the widest letter.
Chris@10 6115 \setbox0 = \hbox{\putwordAppendix{} M}%
Chris@10 6116 \hbox to \wd0{\putwordAppendix{} #1\hss}}
Chris@10 6117 %
Chris@10 6118 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
Chris@10 6119
Chris@10 6120 % Unnumbered chapters.
Chris@10 6121 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
Chris@10 6122 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
Chris@10 6123
Chris@10 6124 % Sections.
Chris@10 6125 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
Chris@10 6126 \let\appsecentry=\numsecentry
Chris@10 6127 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
Chris@10 6128
Chris@10 6129 % Subsections.
Chris@10 6130 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
Chris@10 6131 \let\appsubsecentry=\numsubsecentry
Chris@10 6132 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
Chris@10 6133
Chris@10 6134 % And subsubsections.
Chris@10 6135 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
Chris@10 6136 \let\appsubsubsecentry=\numsubsubsecentry
Chris@10 6137 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
Chris@10 6138
Chris@10 6139 % This parameter controls the indentation of the various levels.
Chris@10 6140 % Same as \defaultparindent.
Chris@10 6141 \newdimen\tocindent \tocindent = 15pt
Chris@10 6142
Chris@10 6143 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
Chris@10 6144 % page number.
Chris@10 6145 %
Chris@10 6146 % If the toc has to be broken over pages, we want it to be at chapters
Chris@10 6147 % if at all possible; hence the \penalty.
Chris@10 6148 \def\dochapentry#1#2{%
Chris@10 6149 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
Chris@10 6150 \begingroup
Chris@10 6151 \chapentryfonts
Chris@10 6152 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
Chris@10 6153 \endgroup
Chris@10 6154 \nobreak\vskip .25\baselineskip plus.1\baselineskip
Chris@10 6155 }
Chris@10 6156
Chris@10 6157 \def\dosecentry#1#2{\begingroup
Chris@10 6158 \secentryfonts \leftskip=\tocindent
Chris@10 6159 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
Chris@10 6160 \endgroup}
Chris@10 6161
Chris@10 6162 \def\dosubsecentry#1#2{\begingroup
Chris@10 6163 \subsecentryfonts \leftskip=2\tocindent
Chris@10 6164 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
Chris@10 6165 \endgroup}
Chris@10 6166
Chris@10 6167 \def\dosubsubsecentry#1#2{\begingroup
Chris@10 6168 \subsubsecentryfonts \leftskip=3\tocindent
Chris@10 6169 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
Chris@10 6170 \endgroup}
Chris@10 6171
Chris@10 6172 % We use the same \entry macro as for the index entries.
Chris@10 6173 \let\tocentry = \entry
Chris@10 6174
Chris@10 6175 % Space between chapter (or whatever) number and the title.
Chris@10 6176 \def\labelspace{\hskip1em \relax}
Chris@10 6177
Chris@10 6178 \def\dopageno#1{{\rm #1}}
Chris@10 6179 \def\doshortpageno#1{{\rm #1}}
Chris@10 6180
Chris@10 6181 \def\chapentryfonts{\secfonts \rm}
Chris@10 6182 \def\secentryfonts{\textfonts}
Chris@10 6183 \def\subsecentryfonts{\textfonts}
Chris@10 6184 \def\subsubsecentryfonts{\textfonts}
Chris@10 6185
Chris@10 6186
Chris@10 6187 \message{environments,}
Chris@10 6188 % @foo ... @end foo.
Chris@10 6189
Chris@10 6190 % @tex ... @end tex escapes into raw TeX temporarily.
Chris@10 6191 % One exception: @ is still an escape character, so that @end tex works.
Chris@10 6192 % But \@ or @@ will get a plain @ character.
Chris@10 6193
Chris@10 6194 \envdef\tex{%
Chris@10 6195 \setupmarkupstyle{tex}%
Chris@10 6196 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
Chris@10 6197 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
Chris@10 6198 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
Chris@10 6199 \catcode `\%=14
Chris@10 6200 \catcode `\+=\other
Chris@10 6201 \catcode `\"=\other
Chris@10 6202 \catcode `\|=\other
Chris@10 6203 \catcode `\<=\other
Chris@10 6204 \catcode `\>=\other
Chris@10 6205 \catcode`\`=\other
Chris@10 6206 \catcode`\'=\other
Chris@10 6207 \escapechar=`\\
Chris@10 6208 %
Chris@10 6209 % ' is active in math mode (mathcode"8000). So reset it, and all our
Chris@10 6210 % other math active characters (just in case), to plain's definitions.
Chris@10 6211 \mathactive
Chris@10 6212 %
Chris@10 6213 \let\b=\ptexb
Chris@10 6214 \let\bullet=\ptexbullet
Chris@10 6215 \let\c=\ptexc
Chris@10 6216 \let\,=\ptexcomma
Chris@10 6217 \let\.=\ptexdot
Chris@10 6218 \let\dots=\ptexdots
Chris@10 6219 \let\equiv=\ptexequiv
Chris@10 6220 \let\!=\ptexexclam
Chris@10 6221 \let\i=\ptexi
Chris@10 6222 \let\indent=\ptexindent
Chris@10 6223 \let\noindent=\ptexnoindent
Chris@10 6224 \let\{=\ptexlbrace
Chris@10 6225 \let\+=\tabalign
Chris@10 6226 \let\}=\ptexrbrace
Chris@10 6227 \let\/=\ptexslash
Chris@10 6228 \let\*=\ptexstar
Chris@10 6229 \let\t=\ptext
Chris@10 6230 \expandafter \let\csname top\endcsname=\ptextop % outer
Chris@10 6231 \let\frenchspacing=\plainfrenchspacing
Chris@10 6232 %
Chris@10 6233 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
Chris@10 6234 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
Chris@10 6235 \def\@{@}%
Chris@10 6236 }
Chris@10 6237 % There is no need to define \Etex.
Chris@10 6238
Chris@10 6239 % Define @lisp ... @end lisp.
Chris@10 6240 % @lisp environment forms a group so it can rebind things,
Chris@10 6241 % including the definition of @end lisp (which normally is erroneous).
Chris@10 6242
Chris@10 6243 % Amount to narrow the margins by for @lisp.
Chris@10 6244 \newskip\lispnarrowing \lispnarrowing=0.4in
Chris@10 6245
Chris@10 6246 % This is the definition that ^^M gets inside @lisp, @example, and other
Chris@10 6247 % such environments. \null is better than a space, since it doesn't
Chris@10 6248 % have any width.
Chris@10 6249 \def\lisppar{\null\endgraf}
Chris@10 6250
Chris@10 6251 % This space is always present above and below environments.
Chris@10 6252 \newskip\envskipamount \envskipamount = 0pt
Chris@10 6253
Chris@10 6254 % Make spacing and below environment symmetrical. We use \parskip here
Chris@10 6255 % to help in doing that, since in @example-like environments \parskip
Chris@10 6256 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
Chris@10 6257 % start of the next paragraph will insert \parskip.
Chris@10 6258 %
Chris@10 6259 \def\aboveenvbreak{{%
Chris@10 6260 % =10000 instead of <10000 because of a special case in \itemzzz and
Chris@10 6261 % \sectionheading, q.v.
Chris@10 6262 \ifnum \lastpenalty=10000 \else
Chris@10 6263 \advance\envskipamount by \parskip
Chris@10 6264 \endgraf
Chris@10 6265 \ifdim\lastskip<\envskipamount
Chris@10 6266 \removelastskip
Chris@10 6267 % it's not a good place to break if the last penalty was \nobreak
Chris@10 6268 % or better ...
Chris@10 6269 \ifnum\lastpenalty<10000 \penalty-50 \fi
Chris@10 6270 \vskip\envskipamount
Chris@10 6271 \fi
Chris@10 6272 \fi
Chris@10 6273 }}
Chris@10 6274
Chris@10 6275 \let\afterenvbreak = \aboveenvbreak
Chris@10 6276
Chris@10 6277 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
Chris@10 6278 % also clear it, so that its embedded environments do the narrowing again.
Chris@10 6279 \let\nonarrowing=\relax
Chris@10 6280
Chris@10 6281 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
Chris@10 6282 % environment contents.
Chris@10 6283 \font\circle=lcircle10
Chris@10 6284 \newdimen\circthick
Chris@10 6285 \newdimen\cartouter\newdimen\cartinner
Chris@10 6286 \newskip\normbskip\newskip\normpskip\newskip\normlskip
Chris@10 6287 \circthick=\fontdimen8\circle
Chris@10 6288 %
Chris@10 6289 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
Chris@10 6290 \def\ctr{{\hskip 6pt\circle\char'010}}
Chris@10 6291 \def\cbl{{\circle\char'012\hskip -6pt}}
Chris@10 6292 \def\cbr{{\hskip 6pt\circle\char'011}}
Chris@10 6293 \def\carttop{\hbox to \cartouter{\hskip\lskip
Chris@10 6294 \ctl\leaders\hrule height\circthick\hfil\ctr
Chris@10 6295 \hskip\rskip}}
Chris@10 6296 \def\cartbot{\hbox to \cartouter{\hskip\lskip
Chris@10 6297 \cbl\leaders\hrule height\circthick\hfil\cbr
Chris@10 6298 \hskip\rskip}}
Chris@10 6299 %
Chris@10 6300 \newskip\lskip\newskip\rskip
Chris@10 6301
Chris@10 6302 \envdef\cartouche{%
Chris@10 6303 \ifhmode\par\fi % can't be in the midst of a paragraph.
Chris@10 6304 \startsavinginserts
Chris@10 6305 \lskip=\leftskip \rskip=\rightskip
Chris@10 6306 \leftskip=0pt\rightskip=0pt % we want these *outside*.
Chris@10 6307 \cartinner=\hsize \advance\cartinner by-\lskip
Chris@10 6308 \advance\cartinner by-\rskip
Chris@10 6309 \cartouter=\hsize
Chris@10 6310 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
Chris@10 6311 % side, and for 6pt waste from
Chris@10 6312 % each corner char, and rule thickness
Chris@10 6313 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
Chris@10 6314 % Flag to tell @lisp, etc., not to narrow margin.
Chris@10 6315 \let\nonarrowing = t%
Chris@10 6316 %
Chris@10 6317 % If this cartouche directly follows a sectioning command, we need the
Chris@10 6318 % \parskip glue (backspaced over by default) or the cartouche can
Chris@10 6319 % collide with the section heading.
Chris@10 6320 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
Chris@10 6321 %
Chris@10 6322 \vbox\bgroup
Chris@10 6323 \baselineskip=0pt\parskip=0pt\lineskip=0pt
Chris@10 6324 \carttop
Chris@10 6325 \hbox\bgroup
Chris@10 6326 \hskip\lskip
Chris@10 6327 \vrule\kern3pt
Chris@10 6328 \vbox\bgroup
Chris@10 6329 \kern3pt
Chris@10 6330 \hsize=\cartinner
Chris@10 6331 \baselineskip=\normbskip
Chris@10 6332 \lineskip=\normlskip
Chris@10 6333 \parskip=\normpskip
Chris@10 6334 \vskip -\parskip
Chris@10 6335 \comment % For explanation, see the end of def\group.
Chris@10 6336 }
Chris@10 6337 \def\Ecartouche{%
Chris@10 6338 \ifhmode\par\fi
Chris@10 6339 \kern3pt
Chris@10 6340 \egroup
Chris@10 6341 \kern3pt\vrule
Chris@10 6342 \hskip\rskip
Chris@10 6343 \egroup
Chris@10 6344 \cartbot
Chris@10 6345 \egroup
Chris@10 6346 \checkinserts
Chris@10 6347 }
Chris@10 6348
Chris@10 6349
Chris@10 6350 % This macro is called at the beginning of all the @example variants,
Chris@10 6351 % inside a group.
Chris@10 6352 \newdimen\nonfillparindent
Chris@10 6353 \def\nonfillstart{%
Chris@10 6354 \aboveenvbreak
Chris@10 6355 \hfuzz = 12pt % Don't be fussy
Chris@10 6356 \sepspaces % Make spaces be word-separators rather than space tokens.
Chris@10 6357 \let\par = \lisppar % don't ignore blank lines
Chris@10 6358 \obeylines % each line of input is a line of output
Chris@10 6359 \parskip = 0pt
Chris@10 6360 % Turn off paragraph indentation but redefine \indent to emulate
Chris@10 6361 % the normal \indent.
Chris@10 6362 \nonfillparindent=\parindent
Chris@10 6363 \parindent = 0pt
Chris@10 6364 \let\indent\nonfillindent
Chris@10 6365 %
Chris@10 6366 \emergencystretch = 0pt % don't try to avoid overfull boxes
Chris@10 6367 \ifx\nonarrowing\relax
Chris@10 6368 \advance \leftskip by \lispnarrowing
Chris@10 6369 \exdentamount=\lispnarrowing
Chris@10 6370 \else
Chris@10 6371 \let\nonarrowing = \relax
Chris@10 6372 \fi
Chris@10 6373 \let\exdent=\nofillexdent
Chris@10 6374 }
Chris@10 6375
Chris@10 6376 \begingroup
Chris@10 6377 \obeyspaces
Chris@10 6378 % We want to swallow spaces (but not other tokens) after the fake
Chris@10 6379 % @indent in our nonfill-environments, where spaces are normally
Chris@10 6380 % active and set to @tie, resulting in them not being ignored after
Chris@10 6381 % @indent.
Chris@10 6382 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
Chris@10 6383 \gdef\nonfillindentcheck{%
Chris@10 6384 \ifx\temp %
Chris@10 6385 \expandafter\nonfillindentgobble%
Chris@10 6386 \else%
Chris@10 6387 \leavevmode\nonfillindentbox%
Chris@10 6388 \fi%
Chris@10 6389 }%
Chris@10 6390 \endgroup
Chris@10 6391 \def\nonfillindentgobble#1{\nonfillindent}
Chris@10 6392 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
Chris@10 6393
Chris@10 6394 % If you want all examples etc. small: @set dispenvsize small.
Chris@10 6395 % If you want even small examples the full size: @set dispenvsize nosmall.
Chris@10 6396 % This affects the following displayed environments:
Chris@10 6397 % @example, @display, @format, @lisp
Chris@10 6398 %
Chris@10 6399 \def\smallword{small}
Chris@10 6400 \def\nosmallword{nosmall}
Chris@10 6401 \let\SETdispenvsize\relax
Chris@10 6402 \def\setnormaldispenv{%
Chris@10 6403 \ifx\SETdispenvsize\smallword
Chris@10 6404 % end paragraph for sake of leading, in case document has no blank
Chris@10 6405 % line. This is redundant with what happens in \aboveenvbreak, but
Chris@10 6406 % we need to do it before changing the fonts, and it's inconvenient
Chris@10 6407 % to change the fonts afterward.
Chris@10 6408 \ifnum \lastpenalty=10000 \else \endgraf \fi
Chris@10 6409 \smallexamplefonts \rm
Chris@10 6410 \fi
Chris@10 6411 }
Chris@10 6412 \def\setsmalldispenv{%
Chris@10 6413 \ifx\SETdispenvsize\nosmallword
Chris@10 6414 \else
Chris@10 6415 \ifnum \lastpenalty=10000 \else \endgraf \fi
Chris@10 6416 \smallexamplefonts \rm
Chris@10 6417 \fi
Chris@10 6418 }
Chris@10 6419
Chris@10 6420 % We often define two environments, @foo and @smallfoo.
Chris@10 6421 % Let's do it in one command. #1 is the env name, #2 the definition.
Chris@10 6422 \def\makedispenvdef#1#2{%
Chris@10 6423 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
Chris@10 6424 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
Chris@10 6425 \expandafter\let\csname E#1\endcsname \afterenvbreak
Chris@10 6426 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
Chris@10 6427 }
Chris@10 6428
Chris@10 6429 % Define two environment synonyms (#1 and #2) for an environment.
Chris@10 6430 \def\maketwodispenvdef#1#2#3{%
Chris@10 6431 \makedispenvdef{#1}{#3}%
Chris@10 6432 \makedispenvdef{#2}{#3}%
Chris@10 6433 }
Chris@10 6434 %
Chris@10 6435 % @lisp: indented, narrowed, typewriter font;
Chris@10 6436 % @example: same as @lisp.
Chris@10 6437 %
Chris@10 6438 % @smallexample and @smalllisp: use smaller fonts.
Chris@10 6439 % Originally contributed by Pavel@xerox.
Chris@10 6440 %
Chris@10 6441 \maketwodispenvdef{lisp}{example}{%
Chris@10 6442 \nonfillstart
Chris@10 6443 \tt\setupmarkupstyle{example}%
Chris@10 6444 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
Chris@10 6445 \gobble % eat return
Chris@10 6446 }
Chris@10 6447 % @display/@smalldisplay: same as @lisp except keep current font.
Chris@10 6448 %
Chris@10 6449 \makedispenvdef{display}{%
Chris@10 6450 \nonfillstart
Chris@10 6451 \gobble
Chris@10 6452 }
Chris@10 6453
Chris@10 6454 % @format/@smallformat: same as @display except don't narrow margins.
Chris@10 6455 %
Chris@10 6456 \makedispenvdef{format}{%
Chris@10 6457 \let\nonarrowing = t%
Chris@10 6458 \nonfillstart
Chris@10 6459 \gobble
Chris@10 6460 }
Chris@10 6461
Chris@10 6462 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
Chris@10 6463 \envdef\flushleft{%
Chris@10 6464 \let\nonarrowing = t%
Chris@10 6465 \nonfillstart
Chris@10 6466 \gobble
Chris@10 6467 }
Chris@10 6468 \let\Eflushleft = \afterenvbreak
Chris@10 6469
Chris@10 6470 % @flushright.
Chris@10 6471 %
Chris@10 6472 \envdef\flushright{%
Chris@10 6473 \let\nonarrowing = t%
Chris@10 6474 \nonfillstart
Chris@10 6475 \advance\leftskip by 0pt plus 1fill\relax
Chris@10 6476 \gobble
Chris@10 6477 }
Chris@10 6478 \let\Eflushright = \afterenvbreak
Chris@10 6479
Chris@10 6480
Chris@10 6481 % @raggedright does more-or-less normal line breaking but no right
Chris@10 6482 % justification. From plain.tex.
Chris@10 6483 \envdef\raggedright{%
Chris@10 6484 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
Chris@10 6485 }
Chris@10 6486 \let\Eraggedright\par
Chris@10 6487
Chris@10 6488 \envdef\raggedleft{%
Chris@10 6489 \parindent=0pt \leftskip0pt plus2em
Chris@10 6490 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
Chris@10 6491 \hbadness=10000 % Last line will usually be underfull, so turn off
Chris@10 6492 % badness reporting.
Chris@10 6493 }
Chris@10 6494 \let\Eraggedleft\par
Chris@10 6495
Chris@10 6496 \envdef\raggedcenter{%
Chris@10 6497 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
Chris@10 6498 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
Chris@10 6499 \hbadness=10000 % Last line will usually be underfull, so turn off
Chris@10 6500 % badness reporting.
Chris@10 6501 }
Chris@10 6502 \let\Eraggedcenter\par
Chris@10 6503
Chris@10 6504
Chris@10 6505 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
Chris@10 6506 % and narrows the margins. We keep \parskip nonzero in general, since
Chris@10 6507 % we're doing normal filling. So, when using \aboveenvbreak and
Chris@10 6508 % \afterenvbreak, temporarily make \parskip 0.
Chris@10 6509 %
Chris@10 6510 \makedispenvdef{quotation}{\quotationstart}
Chris@10 6511 %
Chris@10 6512 \def\quotationstart{%
Chris@10 6513 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
Chris@10 6514 \parindent=0pt
Chris@10 6515 %
Chris@10 6516 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
Chris@10 6517 \ifx\nonarrowing\relax
Chris@10 6518 \advance\leftskip by \lispnarrowing
Chris@10 6519 \advance\rightskip by \lispnarrowing
Chris@10 6520 \exdentamount = \lispnarrowing
Chris@10 6521 \else
Chris@10 6522 \let\nonarrowing = \relax
Chris@10 6523 \fi
Chris@10 6524 \parsearg\quotationlabel
Chris@10 6525 }
Chris@10 6526
Chris@10 6527 % We have retained a nonzero parskip for the environment, since we're
Chris@10 6528 % doing normal filling.
Chris@10 6529 %
Chris@10 6530 \def\Equotation{%
Chris@10 6531 \par
Chris@10 6532 \ifx\quotationauthor\thisisundefined\else
Chris@10 6533 % indent a bit.
Chris@10 6534 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
Chris@10 6535 \fi
Chris@10 6536 {\parskip=0pt \afterenvbreak}%
Chris@10 6537 }
Chris@10 6538 \def\Esmallquotation{\Equotation}
Chris@10 6539
Chris@10 6540 % If we're given an argument, typeset it in bold with a colon after.
Chris@10 6541 \def\quotationlabel#1{%
Chris@10 6542 \def\temp{#1}%
Chris@10 6543 \ifx\temp\empty \else
Chris@10 6544 {\bf #1: }%
Chris@10 6545 \fi
Chris@10 6546 }
Chris@10 6547
Chris@10 6548
Chris@10 6549 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
Chris@10 6550 % If we want to allow any <char> as delimiter,
Chris@10 6551 % we need the curly braces so that makeinfo sees the @verb command, eg:
Chris@10 6552 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
Chris@10 6553 %
Chris@10 6554 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
Chris@10 6555 %
Chris@10 6556 % [Knuth] p.344; only we need to do the other characters Texinfo sets
Chris@10 6557 % active too. Otherwise, they get lost as the first character on a
Chris@10 6558 % verbatim line.
Chris@10 6559 \def\dospecials{%
Chris@10 6560 \do\ \do\\\do\{\do\}\do\$\do\&%
Chris@10 6561 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
Chris@10 6562 \do\<\do\>\do\|\do\@\do+\do\"%
Chris@10 6563 % Don't do the quotes -- if we do, @set txicodequoteundirected and
Chris@10 6564 % @set txicodequotebacktick will not have effect on @verb and
Chris@10 6565 % @verbatim, and ?` and !` ligatures won't get disabled.
Chris@10 6566 %\do\`\do\'%
Chris@10 6567 }
Chris@10 6568 %
Chris@10 6569 % [Knuth] p. 380
Chris@10 6570 \def\uncatcodespecials{%
Chris@10 6571 \def\do##1{\catcode`##1=\other}\dospecials}
Chris@10 6572 %
Chris@10 6573 % Setup for the @verb command.
Chris@10 6574 %
Chris@10 6575 % Eight spaces for a tab
Chris@10 6576 \begingroup
Chris@10 6577 \catcode`\^^I=\active
Chris@10 6578 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
Chris@10 6579 \endgroup
Chris@10 6580 %
Chris@10 6581 \def\setupverb{%
Chris@10 6582 \tt % easiest (and conventionally used) font for verbatim
Chris@10 6583 \def\par{\leavevmode\endgraf}%
Chris@10 6584 \setupmarkupstyle{verb}%
Chris@10 6585 \tabeightspaces
Chris@10 6586 % Respect line breaks,
Chris@10 6587 % print special symbols as themselves, and
Chris@10 6588 % make each space count
Chris@10 6589 % must do in this order:
Chris@10 6590 \obeylines \uncatcodespecials \sepspaces
Chris@10 6591 }
Chris@10 6592
Chris@10 6593 % Setup for the @verbatim environment
Chris@10 6594 %
Chris@10 6595 % Real tab expansion.
Chris@10 6596 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
Chris@10 6597 %
Chris@10 6598 % We typeset each line of the verbatim in an \hbox, so we can handle
Chris@10 6599 % tabs. The \global is in case the verbatim line starts with an accent,
Chris@10 6600 % or some other command that starts with a begin-group. Otherwise, the
Chris@10 6601 % entire \verbbox would disappear at the corresponding end-group, before
Chris@10 6602 % it is typeset. Meanwhile, we can't have nested verbatim commands
Chris@10 6603 % (can we?), so the \global won't be overwriting itself.
Chris@10 6604 \newbox\verbbox
Chris@10 6605 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
Chris@10 6606 %
Chris@10 6607 \begingroup
Chris@10 6608 \catcode`\^^I=\active
Chris@10 6609 \gdef\tabexpand{%
Chris@10 6610 \catcode`\^^I=\active
Chris@10 6611 \def^^I{\leavevmode\egroup
Chris@10 6612 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
Chris@10 6613 \divide\dimen\verbbox by\tabw
Chris@10 6614 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
Chris@10 6615 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
Chris@10 6616 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
Chris@10 6617 }%
Chris@10 6618 }
Chris@10 6619 \endgroup
Chris@10 6620
Chris@10 6621 % start the verbatim environment.
Chris@10 6622 \def\setupverbatim{%
Chris@10 6623 \let\nonarrowing = t%
Chris@10 6624 \nonfillstart
Chris@10 6625 \tt % easiest (and conventionally used) font for verbatim
Chris@10 6626 % The \leavevmode here is for blank lines. Otherwise, we would
Chris@10 6627 % never \starttabox and the \egroup would end verbatim mode.
Chris@10 6628 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
Chris@10 6629 \tabexpand
Chris@10 6630 \setupmarkupstyle{verbatim}%
Chris@10 6631 % Respect line breaks,
Chris@10 6632 % print special symbols as themselves, and
Chris@10 6633 % make each space count.
Chris@10 6634 % Must do in this order:
Chris@10 6635 \obeylines \uncatcodespecials \sepspaces
Chris@10 6636 \everypar{\starttabbox}%
Chris@10 6637 }
Chris@10 6638
Chris@10 6639 % Do the @verb magic: verbatim text is quoted by unique
Chris@10 6640 % delimiter characters. Before first delimiter expect a
Chris@10 6641 % right brace, after last delimiter expect closing brace:
Chris@10 6642 %
Chris@10 6643 % \def\doverb'{'<char>#1<char>'}'{#1}
Chris@10 6644 %
Chris@10 6645 % [Knuth] p. 382; only eat outer {}
Chris@10 6646 \begingroup
Chris@10 6647 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
Chris@10 6648 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
Chris@10 6649 \endgroup
Chris@10 6650 %
Chris@10 6651 \def\verb{\begingroup\setupverb\doverb}
Chris@10 6652 %
Chris@10 6653 %
Chris@10 6654 % Do the @verbatim magic: define the macro \doverbatim so that
Chris@10 6655 % the (first) argument ends when '@end verbatim' is reached, ie:
Chris@10 6656 %
Chris@10 6657 % \def\doverbatim#1@end verbatim{#1}
Chris@10 6658 %
Chris@10 6659 % For Texinfo it's a lot easier than for LaTeX,
Chris@10 6660 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
Chris@10 6661 % we need not redefine '\', '{' and '}'.
Chris@10 6662 %
Chris@10 6663 % Inspired by LaTeX's verbatim command set [latex.ltx]
Chris@10 6664 %
Chris@10 6665 \begingroup
Chris@10 6666 \catcode`\ =\active
Chris@10 6667 \obeylines %
Chris@10 6668 % ignore everything up to the first ^^M, that's the newline at the end
Chris@10 6669 % of the @verbatim input line itself. Otherwise we get an extra blank
Chris@10 6670 % line in the output.
Chris@10 6671 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
Chris@10 6672 % We really want {...\end verbatim} in the body of the macro, but
Chris@10 6673 % without the active space; thus we have to use \xdef and \gobble.
Chris@10 6674 \endgroup
Chris@10 6675 %
Chris@10 6676 \envdef\verbatim{%
Chris@10 6677 \setupverbatim\doverbatim
Chris@10 6678 }
Chris@10 6679 \let\Everbatim = \afterenvbreak
Chris@10 6680
Chris@10 6681
Chris@10 6682 % @verbatiminclude FILE - insert text of file in verbatim environment.
Chris@10 6683 %
Chris@10 6684 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
Chris@10 6685 %
Chris@10 6686 \def\doverbatiminclude#1{%
Chris@10 6687 {%
Chris@10 6688 \makevalueexpandable
Chris@10 6689 \setupverbatim
Chris@10 6690 \indexnofonts % Allow `@@' and other weird things in file names.
Chris@10 6691 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
Chris@10 6692 \input #1
Chris@10 6693 \afterenvbreak
Chris@10 6694 }%
Chris@10 6695 }
Chris@10 6696
Chris@10 6697 % @copying ... @end copying.
Chris@10 6698 % Save the text away for @insertcopying later.
Chris@10 6699 %
Chris@10 6700 % We save the uninterpreted tokens, rather than creating a box.
Chris@10 6701 % Saving the text in a box would be much easier, but then all the
Chris@10 6702 % typesetting commands (@smallbook, font changes, etc.) have to be done
Chris@10 6703 % beforehand -- and a) we want @copying to be done first in the source
Chris@10 6704 % file; b) letting users define the frontmatter in as flexible order as
Chris@10 6705 % possible is very desirable.
Chris@10 6706 %
Chris@10 6707 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
Chris@10 6708 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
Chris@10 6709 %
Chris@10 6710 \def\insertcopying{%
Chris@10 6711 \begingroup
Chris@10 6712 \parindent = 0pt % paragraph indentation looks wrong on title page
Chris@10 6713 \scanexp\copyingtext
Chris@10 6714 \endgroup
Chris@10 6715 }
Chris@10 6716
Chris@10 6717
Chris@10 6718 \message{defuns,}
Chris@10 6719 % @defun etc.
Chris@10 6720
Chris@10 6721 \newskip\defbodyindent \defbodyindent=.4in
Chris@10 6722 \newskip\defargsindent \defargsindent=50pt
Chris@10 6723 \newskip\deflastargmargin \deflastargmargin=18pt
Chris@10 6724 \newcount\defunpenalty
Chris@10 6725
Chris@10 6726 % Start the processing of @deffn:
Chris@10 6727 \def\startdefun{%
Chris@10 6728 \ifnum\lastpenalty<10000
Chris@10 6729 \medbreak
Chris@10 6730 \defunpenalty=10003 % Will keep this @deffn together with the
Chris@10 6731 % following @def command, see below.
Chris@10 6732 \else
Chris@10 6733 % If there are two @def commands in a row, we'll have a \nobreak,
Chris@10 6734 % which is there to keep the function description together with its
Chris@10 6735 % header. But if there's nothing but headers, we need to allow a
Chris@10 6736 % break somewhere. Check specifically for penalty 10002, inserted
Chris@10 6737 % by \printdefunline, instead of 10000, since the sectioning
Chris@10 6738 % commands also insert a nobreak penalty, and we don't want to allow
Chris@10 6739 % a break between a section heading and a defun.
Chris@10 6740 %
Chris@10 6741 % As a further refinement, we avoid "club" headers by signalling
Chris@10 6742 % with penalty of 10003 after the very first @deffn in the
Chris@10 6743 % sequence (see above), and penalty of 10002 after any following
Chris@10 6744 % @def command.
Chris@10 6745 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
Chris@10 6746 %
Chris@10 6747 % Similarly, after a section heading, do not allow a break.
Chris@10 6748 % But do insert the glue.
Chris@10 6749 \medskip % preceded by discardable penalty, so not a breakpoint
Chris@10 6750 \fi
Chris@10 6751 %
Chris@10 6752 \parindent=0in
Chris@10 6753 \advance\leftskip by \defbodyindent
Chris@10 6754 \exdentamount=\defbodyindent
Chris@10 6755 }
Chris@10 6756
Chris@10 6757 \def\dodefunx#1{%
Chris@10 6758 % First, check whether we are in the right environment:
Chris@10 6759 \checkenv#1%
Chris@10 6760 %
Chris@10 6761 % As above, allow line break if we have multiple x headers in a row.
Chris@10 6762 % It's not a great place, though.
Chris@10 6763 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
Chris@10 6764 %
Chris@10 6765 % And now, it's time to reuse the body of the original defun:
Chris@10 6766 \expandafter\gobbledefun#1%
Chris@10 6767 }
Chris@10 6768 \def\gobbledefun#1\startdefun{}
Chris@10 6769
Chris@10 6770 % \printdefunline \deffnheader{text}
Chris@10 6771 %
Chris@10 6772 \def\printdefunline#1#2{%
Chris@10 6773 \begingroup
Chris@10 6774 % call \deffnheader:
Chris@10 6775 #1#2 \endheader
Chris@10 6776 % common ending:
Chris@10 6777 \interlinepenalty = 10000
Chris@10 6778 \advance\rightskip by 0pt plus 1fil\relax
Chris@10 6779 \endgraf
Chris@10 6780 \nobreak\vskip -\parskip
Chris@10 6781 \penalty\defunpenalty % signal to \startdefun and \dodefunx
Chris@10 6782 % Some of the @defun-type tags do not enable magic parentheses,
Chris@10 6783 % rendering the following check redundant. But we don't optimize.
Chris@10 6784 \checkparencounts
Chris@10 6785 \endgroup
Chris@10 6786 }
Chris@10 6787
Chris@10 6788 \def\Edefun{\endgraf\medbreak}
Chris@10 6789
Chris@10 6790 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
Chris@10 6791 % the only thing remaining is to define \deffnheader.
Chris@10 6792 %
Chris@10 6793 \def\makedefun#1{%
Chris@10 6794 \expandafter\let\csname E#1\endcsname = \Edefun
Chris@10 6795 \edef\temp{\noexpand\domakedefun
Chris@10 6796 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
Chris@10 6797 \temp
Chris@10 6798 }
Chris@10 6799
Chris@10 6800 % \domakedefun \deffn \deffnx \deffnheader
Chris@10 6801 %
Chris@10 6802 % Define \deffn and \deffnx, without parameters.
Chris@10 6803 % \deffnheader has to be defined explicitly.
Chris@10 6804 %
Chris@10 6805 \def\domakedefun#1#2#3{%
Chris@10 6806 \envdef#1{%
Chris@10 6807 \startdefun
Chris@10 6808 \doingtypefnfalse % distinguish typed functions from all else
Chris@10 6809 \parseargusing\activeparens{\printdefunline#3}%
Chris@10 6810 }%
Chris@10 6811 \def#2{\dodefunx#1}%
Chris@10 6812 \def#3%
Chris@10 6813 }
Chris@10 6814
Chris@10 6815 \newif\ifdoingtypefn % doing typed function?
Chris@10 6816 \newif\ifrettypeownline % typeset return type on its own line?
Chris@10 6817
Chris@10 6818 % @deftypefnnewline on|off says whether the return type of typed functions
Chris@10 6819 % are printed on their own line. This affects @deftypefn, @deftypefun,
Chris@10 6820 % @deftypeop, and @deftypemethod.
Chris@10 6821 %
Chris@10 6822 \parseargdef\deftypefnnewline{%
Chris@10 6823 \def\temp{#1}%
Chris@10 6824 \ifx\temp\onword
Chris@10 6825 \expandafter\let\csname SETtxideftypefnnl\endcsname
Chris@10 6826 = \empty
Chris@10 6827 \else\ifx\temp\offword
Chris@10 6828 \expandafter\let\csname SETtxideftypefnnl\endcsname
Chris@10 6829 = \relax
Chris@10 6830 \else
Chris@10 6831 \errhelp = \EMsimple
Chris@10 6832 \errmessage{Unknown @txideftypefnnl value `\temp',
Chris@10 6833 must be on|off}%
Chris@10 6834 \fi\fi
Chris@10 6835 }
Chris@10 6836
Chris@10 6837 % Untyped functions:
Chris@10 6838
Chris@10 6839 % @deffn category name args
Chris@10 6840 \makedefun{deffn}{\deffngeneral{}}
Chris@10 6841
Chris@10 6842 % @deffn category class name args
Chris@10 6843 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
Chris@10 6844
Chris@10 6845 % \defopon {category on}class name args
Chris@10 6846 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
Chris@10 6847
Chris@10 6848 % \deffngeneral {subind}category name args
Chris@10 6849 %
Chris@10 6850 \def\deffngeneral#1#2 #3 #4\endheader{%
Chris@10 6851 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
Chris@10 6852 \dosubind{fn}{\code{#3}}{#1}%
Chris@10 6853 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
Chris@10 6854 }
Chris@10 6855
Chris@10 6856 % Typed functions:
Chris@10 6857
Chris@10 6858 % @deftypefn category type name args
Chris@10 6859 \makedefun{deftypefn}{\deftypefngeneral{}}
Chris@10 6860
Chris@10 6861 % @deftypeop category class type name args
Chris@10 6862 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
Chris@10 6863
Chris@10 6864 % \deftypeopon {category on}class type name args
Chris@10 6865 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
Chris@10 6866
Chris@10 6867 % \deftypefngeneral {subind}category type name args
Chris@10 6868 %
Chris@10 6869 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
Chris@10 6870 \dosubind{fn}{\code{#4}}{#1}%
Chris@10 6871 \doingtypefntrue
Chris@10 6872 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
Chris@10 6873 }
Chris@10 6874
Chris@10 6875 % Typed variables:
Chris@10 6876
Chris@10 6877 % @deftypevr category type var args
Chris@10 6878 \makedefun{deftypevr}{\deftypecvgeneral{}}
Chris@10 6879
Chris@10 6880 % @deftypecv category class type var args
Chris@10 6881 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
Chris@10 6882
Chris@10 6883 % \deftypecvof {category of}class type var args
Chris@10 6884 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
Chris@10 6885
Chris@10 6886 % \deftypecvgeneral {subind}category type var args
Chris@10 6887 %
Chris@10 6888 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
Chris@10 6889 \dosubind{vr}{\code{#4}}{#1}%
Chris@10 6890 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
Chris@10 6891 }
Chris@10 6892
Chris@10 6893 % Untyped variables:
Chris@10 6894
Chris@10 6895 % @defvr category var args
Chris@10 6896 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
Chris@10 6897
Chris@10 6898 % @defcv category class var args
Chris@10 6899 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
Chris@10 6900
Chris@10 6901 % \defcvof {category of}class var args
Chris@10 6902 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
Chris@10 6903
Chris@10 6904 % Types:
Chris@10 6905
Chris@10 6906 % @deftp category name args
Chris@10 6907 \makedefun{deftp}#1 #2 #3\endheader{%
Chris@10 6908 \doind{tp}{\code{#2}}%
Chris@10 6909 \defname{#1}{}{#2}\defunargs{#3\unskip}%
Chris@10 6910 }
Chris@10 6911
Chris@10 6912 % Remaining @defun-like shortcuts:
Chris@10 6913 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
Chris@10 6914 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
Chris@10 6915 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
Chris@10 6916 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
Chris@10 6917 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
Chris@10 6918 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
Chris@10 6919 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
Chris@10 6920 \makedefun{defmethod}{\defopon\putwordMethodon}
Chris@10 6921 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
Chris@10 6922 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
Chris@10 6923 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
Chris@10 6924
Chris@10 6925 % \defname, which formats the name of the @def (not the args).
Chris@10 6926 % #1 is the category, such as "Function".
Chris@10 6927 % #2 is the return type, if any.
Chris@10 6928 % #3 is the function name.
Chris@10 6929 %
Chris@10 6930 % We are followed by (but not passed) the arguments, if any.
Chris@10 6931 %
Chris@10 6932 \def\defname#1#2#3{%
Chris@10 6933 \par
Chris@10 6934 % Get the values of \leftskip and \rightskip as they were outside the @def...
Chris@10 6935 \advance\leftskip by -\defbodyindent
Chris@10 6936 %
Chris@10 6937 % Determine if we are typesetting the return type of a typed function
Chris@10 6938 % on a line by itself.
Chris@10 6939 \rettypeownlinefalse
Chris@10 6940 \ifdoingtypefn % doing a typed function specifically?
Chris@10 6941 % then check user option for putting return type on its own line:
Chris@10 6942 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
Chris@10 6943 \rettypeownlinetrue
Chris@10 6944 \fi
Chris@10 6945 \fi
Chris@10 6946 %
Chris@10 6947 % How we'll format the category name. Putting it in brackets helps
Chris@10 6948 % distinguish it from the body text that may end up on the next line
Chris@10 6949 % just below it.
Chris@10 6950 \def\temp{#1}%
Chris@10 6951 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
Chris@10 6952 %
Chris@10 6953 % Figure out line sizes for the paragraph shape. We'll always have at
Chris@10 6954 % least two.
Chris@10 6955 \tempnum = 2
Chris@10 6956 %
Chris@10 6957 % The first line needs space for \box0; but if \rightskip is nonzero,
Chris@10 6958 % we need only space for the part of \box0 which exceeds it:
Chris@10 6959 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
Chris@10 6960 %
Chris@10 6961 % If doing a return type on its own line, we'll have another line.
Chris@10 6962 \ifrettypeownline
Chris@10 6963 \advance\tempnum by 1
Chris@10 6964 \def\maybeshapeline{0in \hsize}%
Chris@10 6965 \else
Chris@10 6966 \def\maybeshapeline{}%
Chris@10 6967 \fi
Chris@10 6968 %
Chris@10 6969 % The continuations:
Chris@10 6970 \dimen2=\hsize \advance\dimen2 by -\defargsindent
Chris@10 6971 %
Chris@10 6972 % The final paragraph shape:
Chris@10 6973 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
Chris@10 6974 %
Chris@10 6975 % Put the category name at the right margin.
Chris@10 6976 \noindent
Chris@10 6977 \hbox to 0pt{%
Chris@10 6978 \hfil\box0 \kern-\hsize
Chris@10 6979 % \hsize has to be shortened this way:
Chris@10 6980 \kern\leftskip
Chris@10 6981 % Intentionally do not respect \rightskip, since we need the space.
Chris@10 6982 }%
Chris@10 6983 %
Chris@10 6984 % Allow all lines to be underfull without complaint:
Chris@10 6985 \tolerance=10000 \hbadness=10000
Chris@10 6986 \exdentamount=\defbodyindent
Chris@10 6987 {%
Chris@10 6988 % defun fonts. We use typewriter by default (used to be bold) because:
Chris@10 6989 % . we're printing identifiers, they should be in tt in principle.
Chris@10 6990 % . in languages with many accents, such as Czech or French, it's
Chris@10 6991 % common to leave accents off identifiers. The result looks ok in
Chris@10 6992 % tt, but exceedingly strange in rm.
Chris@10 6993 % . we don't want -- and --- to be treated as ligatures.
Chris@10 6994 % . this still does not fix the ?` and !` ligatures, but so far no
Chris@10 6995 % one has made identifiers using them :).
Chris@10 6996 \df \tt
Chris@10 6997 \def\temp{#2}% text of the return type
Chris@10 6998 \ifx\temp\empty\else
Chris@10 6999 \tclose{\temp}% typeset the return type
Chris@10 7000 \ifrettypeownline
Chris@10 7001 % put return type on its own line; prohibit line break following:
Chris@10 7002 \hfil\vadjust{\nobreak}\break
Chris@10 7003 \else
Chris@10 7004 \space % type on same line, so just followed by a space
Chris@10 7005 \fi
Chris@10 7006 \fi % no return type
Chris@10 7007 #3% output function name
Chris@10 7008 }%
Chris@10 7009 {\rm\enskip}% hskip 0.5 em of \tenrm
Chris@10 7010 %
Chris@10 7011 \boldbrax
Chris@10 7012 % arguments will be output next, if any.
Chris@10 7013 }
Chris@10 7014
Chris@10 7015 % Print arguments in slanted roman (not ttsl), inconsistently with using
Chris@10 7016 % tt for the name. This is because literal text is sometimes needed in
Chris@10 7017 % the argument list (groff manual), and ttsl and tt are not very
Chris@10 7018 % distinguishable. Prevent hyphenation at `-' chars.
Chris@10 7019 %
Chris@10 7020 \def\defunargs#1{%
Chris@10 7021 % use sl by default (not ttsl),
Chris@10 7022 % tt for the names.
Chris@10 7023 \df \sl \hyphenchar\font=0
Chris@10 7024 %
Chris@10 7025 % On the other hand, if an argument has two dashes (for instance), we
Chris@10 7026 % want a way to get ttsl. Let's try @var for that.
Chris@10 7027 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
Chris@10 7028 #1%
Chris@10 7029 \sl\hyphenchar\font=45
Chris@10 7030 }
Chris@10 7031
Chris@10 7032 % We want ()&[] to print specially on the defun line.
Chris@10 7033 %
Chris@10 7034 \def\activeparens{%
Chris@10 7035 \catcode`\(=\active \catcode`\)=\active
Chris@10 7036 \catcode`\[=\active \catcode`\]=\active
Chris@10 7037 \catcode`\&=\active
Chris@10 7038 }
Chris@10 7039
Chris@10 7040 % Make control sequences which act like normal parenthesis chars.
Chris@10 7041 \let\lparen = ( \let\rparen = )
Chris@10 7042
Chris@10 7043 % Be sure that we always have a definition for `(', etc. For example,
Chris@10 7044 % if the fn name has parens in it, \boldbrax will not be in effect yet,
Chris@10 7045 % so TeX would otherwise complain about undefined control sequence.
Chris@10 7046 {
Chris@10 7047 \activeparens
Chris@10 7048 \global\let(=\lparen \global\let)=\rparen
Chris@10 7049 \global\let[=\lbrack \global\let]=\rbrack
Chris@10 7050 \global\let& = \&
Chris@10 7051
Chris@10 7052 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
Chris@10 7053 \gdef\magicamp{\let&=\amprm}
Chris@10 7054 }
Chris@10 7055
Chris@10 7056 \newcount\parencount
Chris@10 7057
Chris@10 7058 % If we encounter &foo, then turn on ()-hacking afterwards
Chris@10 7059 \newif\ifampseen
Chris@10 7060 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
Chris@10 7061
Chris@10 7062 \def\parenfont{%
Chris@10 7063 \ifampseen
Chris@10 7064 % At the first level, print parens in roman,
Chris@10 7065 % otherwise use the default font.
Chris@10 7066 \ifnum \parencount=1 \rm \fi
Chris@10 7067 \else
Chris@10 7068 % The \sf parens (in \boldbrax) actually are a little bolder than
Chris@10 7069 % the contained text. This is especially needed for [ and ] .
Chris@10 7070 \sf
Chris@10 7071 \fi
Chris@10 7072 }
Chris@10 7073 \def\infirstlevel#1{%
Chris@10 7074 \ifampseen
Chris@10 7075 \ifnum\parencount=1
Chris@10 7076 #1%
Chris@10 7077 \fi
Chris@10 7078 \fi
Chris@10 7079 }
Chris@10 7080 \def\bfafterword#1 {#1 \bf}
Chris@10 7081
Chris@10 7082 \def\opnr{%
Chris@10 7083 \global\advance\parencount by 1
Chris@10 7084 {\parenfont(}%
Chris@10 7085 \infirstlevel \bfafterword
Chris@10 7086 }
Chris@10 7087 \def\clnr{%
Chris@10 7088 {\parenfont)}%
Chris@10 7089 \infirstlevel \sl
Chris@10 7090 \global\advance\parencount by -1
Chris@10 7091 }
Chris@10 7092
Chris@10 7093 \newcount\brackcount
Chris@10 7094 \def\lbrb{%
Chris@10 7095 \global\advance\brackcount by 1
Chris@10 7096 {\bf[}%
Chris@10 7097 }
Chris@10 7098 \def\rbrb{%
Chris@10 7099 {\bf]}%
Chris@10 7100 \global\advance\brackcount by -1
Chris@10 7101 }
Chris@10 7102
Chris@10 7103 \def\checkparencounts{%
Chris@10 7104 \ifnum\parencount=0 \else \badparencount \fi
Chris@10 7105 \ifnum\brackcount=0 \else \badbrackcount \fi
Chris@10 7106 }
Chris@10 7107 % these should not use \errmessage; the glibc manual, at least, actually
Chris@10 7108 % has such constructs (when documenting function pointers).
Chris@10 7109 \def\badparencount{%
Chris@10 7110 \message{Warning: unbalanced parentheses in @def...}%
Chris@10 7111 \global\parencount=0
Chris@10 7112 }
Chris@10 7113 \def\badbrackcount{%
Chris@10 7114 \message{Warning: unbalanced square brackets in @def...}%
Chris@10 7115 \global\brackcount=0
Chris@10 7116 }
Chris@10 7117
Chris@10 7118
Chris@10 7119 \message{macros,}
Chris@10 7120 % @macro.
Chris@10 7121
Chris@10 7122 % To do this right we need a feature of e-TeX, \scantokens,
Chris@10 7123 % which we arrange to emulate with a temporary file in ordinary TeX.
Chris@10 7124 \ifx\eTeXversion\thisisundefined
Chris@10 7125 \newwrite\macscribble
Chris@10 7126 \def\scantokens#1{%
Chris@10 7127 \toks0={#1}%
Chris@10 7128 \immediate\openout\macscribble=\jobname.tmp
Chris@10 7129 \immediate\write\macscribble{\the\toks0}%
Chris@10 7130 \immediate\closeout\macscribble
Chris@10 7131 \input \jobname.tmp
Chris@10 7132 }
Chris@10 7133 \fi
Chris@10 7134
Chris@10 7135 \def\scanmacro#1{\begingroup
Chris@10 7136 \newlinechar`\^^M
Chris@10 7137 \let\xeatspaces\eatspaces
Chris@10 7138 %
Chris@10 7139 % Undo catcode changes of \startcontents and \doprintindex
Chris@10 7140 % When called from @insertcopying or (short)caption, we need active
Chris@10 7141 % backslash to get it printed correctly. Previously, we had
Chris@10 7142 % \catcode`\\=\other instead. We'll see whether a problem appears
Chris@10 7143 % with macro expansion. --kasal, 19aug04
Chris@10 7144 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
Chris@10 7145 %
Chris@10 7146 % ... and for \example:
Chris@10 7147 \spaceisspace
Chris@10 7148 %
Chris@10 7149 % The \empty here causes a following catcode 5 newline to be eaten as
Chris@10 7150 % part of reading whitespace after a control sequence. It does not
Chris@10 7151 % eat a catcode 13 newline. There's no good way to handle the two
Chris@10 7152 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
Chris@10 7153 % would then have different behavior). See the Macro Details node in
Chris@10 7154 % the manual for the workaround we recommend for macros and
Chris@10 7155 % line-oriented commands.
Chris@10 7156 %
Chris@10 7157 \scantokens{#1\empty}%
Chris@10 7158 \endgroup}
Chris@10 7159
Chris@10 7160 \def\scanexp#1{%
Chris@10 7161 \edef\temp{\noexpand\scanmacro{#1}}%
Chris@10 7162 \temp
Chris@10 7163 }
Chris@10 7164
Chris@10 7165 \newcount\paramno % Count of parameters
Chris@10 7166 \newtoks\macname % Macro name
Chris@10 7167 \newif\ifrecursive % Is it recursive?
Chris@10 7168
Chris@10 7169 % List of all defined macros in the form
Chris@10 7170 % \definedummyword\macro1\definedummyword\macro2...
Chris@10 7171 % Currently is also contains all @aliases; the list can be split
Chris@10 7172 % if there is a need.
Chris@10 7173 \def\macrolist{}
Chris@10 7174
Chris@10 7175 % Add the macro to \macrolist
Chris@10 7176 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
Chris@10 7177 \def\addtomacrolistxxx#1{%
Chris@10 7178 \toks0 = \expandafter{\macrolist\definedummyword#1}%
Chris@10 7179 \xdef\macrolist{\the\toks0}%
Chris@10 7180 }
Chris@10 7181
Chris@10 7182 % Utility routines.
Chris@10 7183 % This does \let #1 = #2, with \csnames; that is,
Chris@10 7184 % \let \csname#1\endcsname = \csname#2\endcsname
Chris@10 7185 % (except of course we have to play expansion games).
Chris@10 7186 %
Chris@10 7187 \def\cslet#1#2{%
Chris@10 7188 \expandafter\let
Chris@10 7189 \csname#1\expandafter\endcsname
Chris@10 7190 \csname#2\endcsname
Chris@10 7191 }
Chris@10 7192
Chris@10 7193 % Trim leading and trailing spaces off a string.
Chris@10 7194 % Concepts from aro-bend problem 15 (see CTAN).
Chris@10 7195 {\catcode`\@=11
Chris@10 7196 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
Chris@10 7197 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
Chris@10 7198 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
Chris@10 7199 \def\unbrace#1{#1}
Chris@10 7200 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
Chris@10 7201 }
Chris@10 7202
Chris@10 7203 % Trim a single trailing ^^M off a string.
Chris@10 7204 {\catcode`\^^M=\other \catcode`\Q=3%
Chris@10 7205 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
Chris@10 7206 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
Chris@10 7207 \gdef\eatcrb#1Q#2Q{#1}%
Chris@10 7208 }
Chris@10 7209
Chris@10 7210 % Macro bodies are absorbed as an argument in a context where
Chris@10 7211 % all characters are catcode 10, 11 or 12, except \ which is active
Chris@10 7212 % (as in normal texinfo). It is necessary to change the definition of \
Chris@10 7213 % to recognize macro arguments; this is the job of \mbodybackslash.
Chris@10 7214 %
Chris@10 7215 % Non-ASCII encodings make 8-bit characters active, so un-activate
Chris@10 7216 % them to avoid their expansion. Must do this non-globally, to
Chris@10 7217 % confine the change to the current group.
Chris@10 7218 %
Chris@10 7219 % It's necessary to have hard CRs when the macro is executed. This is
Chris@10 7220 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
Chris@10 7221 % body, and then making it the \newlinechar in \scanmacro.
Chris@10 7222 %
Chris@10 7223 \def\scanctxt{% used as subroutine
Chris@10 7224 \catcode`\"=\other
Chris@10 7225 \catcode`\+=\other
Chris@10 7226 \catcode`\<=\other
Chris@10 7227 \catcode`\>=\other
Chris@10 7228 \catcode`\@=\other
Chris@10 7229 \catcode`\^=\other
Chris@10 7230 \catcode`\_=\other
Chris@10 7231 \catcode`\|=\other
Chris@10 7232 \catcode`\~=\other
Chris@10 7233 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
Chris@10 7234 }
Chris@10 7235
Chris@10 7236 \def\scanargctxt{% used for copying and captions, not macros.
Chris@10 7237 \scanctxt
Chris@10 7238 \catcode`\\=\other
Chris@10 7239 \catcode`\^^M=\other
Chris@10 7240 }
Chris@10 7241
Chris@10 7242 \def\macrobodyctxt{% used for @macro definitions
Chris@10 7243 \scanctxt
Chris@10 7244 \catcode`\{=\other
Chris@10 7245 \catcode`\}=\other
Chris@10 7246 \catcode`\^^M=\other
Chris@10 7247 \usembodybackslash
Chris@10 7248 }
Chris@10 7249
Chris@10 7250 \def\macroargctxt{% used when scanning invocations
Chris@10 7251 \scanctxt
Chris@10 7252 \catcode`\\=0
Chris@10 7253 }
Chris@10 7254 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
Chris@10 7255 % for the single characters \ { }. Thus, we end up with the "commands"
Chris@10 7256 % that would be written @\ @{ @} in a Texinfo document.
Chris@10 7257 %
Chris@10 7258 % We already have @{ and @}. For @\, we define it here, and only for
Chris@10 7259 % this purpose, to produce a typewriter backslash (so, the @\ that we
Chris@10 7260 % define for @math can't be used with @macro calls):
Chris@10 7261 %
Chris@10 7262 \def\\{\normalbackslash}%
Chris@10 7263 %
Chris@10 7264 % We would like to do this for \, too, since that is what makeinfo does.
Chris@10 7265 % But it is not possible, because Texinfo already has a command @, for a
Chris@10 7266 % cedilla accent. Documents must use @comma{} instead.
Chris@10 7267 %
Chris@10 7268 % \anythingelse will almost certainly be an error of some kind.
Chris@10 7269
Chris@10 7270
Chris@10 7271 % \mbodybackslash is the definition of \ in @macro bodies.
Chris@10 7272 % It maps \foo\ => \csname macarg.foo\endcsname => #N
Chris@10 7273 % where N is the macro parameter number.
Chris@10 7274 % We define \csname macarg.\endcsname to be \realbackslash, so
Chris@10 7275 % \\ in macro replacement text gets you a backslash.
Chris@10 7276 %
Chris@10 7277 {\catcode`@=0 @catcode`@\=@active
Chris@10 7278 @gdef@usembodybackslash{@let\=@mbodybackslash}
Chris@10 7279 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
Chris@10 7280 }
Chris@10 7281 \expandafter\def\csname macarg.\endcsname{\realbackslash}
Chris@10 7282
Chris@10 7283 \def\margbackslash#1{\char`\#1 }
Chris@10 7284
Chris@10 7285 \def\macro{\recursivefalse\parsearg\macroxxx}
Chris@10 7286 \def\rmacro{\recursivetrue\parsearg\macroxxx}
Chris@10 7287
Chris@10 7288 \def\macroxxx#1{%
Chris@10 7289 \getargs{#1}% now \macname is the macname and \argl the arglist
Chris@10 7290 \ifx\argl\empty % no arguments
Chris@10 7291 \paramno=0\relax
Chris@10 7292 \else
Chris@10 7293 \expandafter\parsemargdef \argl;%
Chris@10 7294 \if\paramno>256\relax
Chris@10 7295 \ifx\eTeXversion\thisisundefined
Chris@10 7296 \errhelp = \EMsimple
Chris@10 7297 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
Chris@10 7298 \fi
Chris@10 7299 \fi
Chris@10 7300 \fi
Chris@10 7301 \if1\csname ismacro.\the\macname\endcsname
Chris@10 7302 \message{Warning: redefining \the\macname}%
Chris@10 7303 \else
Chris@10 7304 \expandafter\ifx\csname \the\macname\endcsname \relax
Chris@10 7305 \else \errmessage{Macro name \the\macname\space already defined}\fi
Chris@10 7306 \global\cslet{macsave.\the\macname}{\the\macname}%
Chris@10 7307 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
Chris@10 7308 \addtomacrolist{\the\macname}%
Chris@10 7309 \fi
Chris@10 7310 \begingroup \macrobodyctxt
Chris@10 7311 \ifrecursive \expandafter\parsermacbody
Chris@10 7312 \else \expandafter\parsemacbody
Chris@10 7313 \fi}
Chris@10 7314
Chris@10 7315 \parseargdef\unmacro{%
Chris@10 7316 \if1\csname ismacro.#1\endcsname
Chris@10 7317 \global\cslet{#1}{macsave.#1}%
Chris@10 7318 \global\expandafter\let \csname ismacro.#1\endcsname=0%
Chris@10 7319 % Remove the macro name from \macrolist:
Chris@10 7320 \begingroup
Chris@10 7321 \expandafter\let\csname#1\endcsname \relax
Chris@10 7322 \let\definedummyword\unmacrodo
Chris@10 7323 \xdef\macrolist{\macrolist}%
Chris@10 7324 \endgroup
Chris@10 7325 \else
Chris@10 7326 \errmessage{Macro #1 not defined}%
Chris@10 7327 \fi
Chris@10 7328 }
Chris@10 7329
Chris@10 7330 % Called by \do from \dounmacro on each macro. The idea is to omit any
Chris@10 7331 % macro definitions that have been changed to \relax.
Chris@10 7332 %
Chris@10 7333 \def\unmacrodo#1{%
Chris@10 7334 \ifx #1\relax
Chris@10 7335 % remove this
Chris@10 7336 \else
Chris@10 7337 \noexpand\definedummyword \noexpand#1%
Chris@10 7338 \fi
Chris@10 7339 }
Chris@10 7340
Chris@10 7341 % This makes use of the obscure feature that if the last token of a
Chris@10 7342 % <parameter list> is #, then the preceding argument is delimited by
Chris@10 7343 % an opening brace, and that opening brace is not consumed.
Chris@10 7344 \def\getargs#1{\getargsxxx#1{}}
Chris@10 7345 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
Chris@10 7346 \def\getmacname#1 #2\relax{\macname={#1}}
Chris@10 7347 \def\getmacargs#1{\def\argl{#1}}
Chris@10 7348
Chris@10 7349 % For macro processing make @ a letter so that we can make Texinfo private macro names.
Chris@10 7350 \edef\texiatcatcode{\the\catcode`\@}
Chris@10 7351 \catcode `@=11\relax
Chris@10 7352
Chris@10 7353 % Parse the optional {params} list. Set up \paramno and \paramlist
Chris@10 7354 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
Chris@10 7355 % in the params list to some hook where the argument si to be expanded. If
Chris@10 7356 % there are less than 10 arguments that hook is to be replaced by ##N where N
Chris@10 7357 % is the position in that list, that is to say the macro arguments are to be
Chris@10 7358 % defined `a la TeX in the macro body.
Chris@10 7359 %
Chris@10 7360 % That gets used by \mbodybackslash (above).
Chris@10 7361 %
Chris@10 7362 % We need to get `macro parameter char #' into several definitions.
Chris@10 7363 % The technique used is stolen from LaTeX: let \hash be something
Chris@10 7364 % unexpandable, insert that wherever you need a #, and then redefine
Chris@10 7365 % it to # just before using the token list produced.
Chris@10 7366 %
Chris@10 7367 % The same technique is used to protect \eatspaces till just before
Chris@10 7368 % the macro is used.
Chris@10 7369 %
Chris@10 7370 % If there are 10 or more arguments, a different technique is used, where the
Chris@10 7371 % hook remains in the body, and when macro is to be expanded the body is
Chris@10 7372 % processed again to replace the arguments.
Chris@10 7373 %
Chris@10 7374 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
Chris@10 7375 % argument N value and then \edef the body (nothing else will expand because of
Chris@10 7376 % the catcode regime underwhich the body was input).
Chris@10 7377 %
Chris@10 7378 % If you compile with TeX (not eTeX), and you have macros with 10 or more
Chris@10 7379 % arguments, you need that no macro has more than 256 arguments, otherwise an
Chris@10 7380 % error is produced.
Chris@10 7381 \def\parsemargdef#1;{%
Chris@10 7382 \paramno=0\def\paramlist{}%
Chris@10 7383 \let\hash\relax
Chris@10 7384 \let\xeatspaces\relax
Chris@10 7385 \parsemargdefxxx#1,;,%
Chris@10 7386 % In case that there are 10 or more arguments we parse again the arguments
Chris@10 7387 % list to set new definitions for the \macarg.BLAH macros corresponding to
Chris@10 7388 % each BLAH argument. It was anyhow needed to parse already once this list
Chris@10 7389 % in order to count the arguments, and as macros with at most 9 arguments
Chris@10 7390 % are by far more frequent than macro with 10 or more arguments, defining
Chris@10 7391 % twice the \macarg.BLAH macros does not cost too much processing power.
Chris@10 7392 \ifnum\paramno<10\relax\else
Chris@10 7393 \paramno0\relax
Chris@10 7394 \parsemmanyargdef@@#1,;,% 10 or more arguments
Chris@10 7395 \fi
Chris@10 7396 }
Chris@10 7397 \def\parsemargdefxxx#1,{%
Chris@10 7398 \if#1;\let\next=\relax
Chris@10 7399 \else \let\next=\parsemargdefxxx
Chris@10 7400 \advance\paramno by 1
Chris@10 7401 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
Chris@10 7402 {\xeatspaces{\hash\the\paramno}}%
Chris@10 7403 \edef\paramlist{\paramlist\hash\the\paramno,}%
Chris@10 7404 \fi\next}
Chris@10 7405
Chris@10 7406 \def\parsemmanyargdef@@#1,{%
Chris@10 7407 \if#1;\let\next=\relax
Chris@10 7408 \else
Chris@10 7409 \let\next=\parsemmanyargdef@@
Chris@10 7410 \edef\tempb{\eatspaces{#1}}%
Chris@10 7411 \expandafter\def\expandafter\tempa
Chris@10 7412 \expandafter{\csname macarg.\tempb\endcsname}%
Chris@10 7413 % Note that we need some extra \noexpand\noexpand, this is because we
Chris@10 7414 % don't want \the to be expanded in the \parsermacbody as it uses an
Chris@10 7415 % \xdef .
Chris@10 7416 \expandafter\edef\tempa
Chris@10 7417 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
Chris@10 7418 \advance\paramno by 1\relax
Chris@10 7419 \fi\next}
Chris@10 7420
Chris@10 7421 % These two commands read recursive and nonrecursive macro bodies.
Chris@10 7422 % (They're different since rec and nonrec macros end differently.)
Chris@10 7423 %
Chris@10 7424
Chris@10 7425 \catcode `\@\texiatcatcode
Chris@10 7426 \long\def\parsemacbody#1@end macro%
Chris@10 7427 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
Chris@10 7428 \long\def\parsermacbody#1@end rmacro%
Chris@10 7429 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
Chris@10 7430 \catcode `\@=11\relax
Chris@10 7431
Chris@10 7432 \let\endargs@\relax
Chris@10 7433 \let\nil@\relax
Chris@10 7434 \def\nilm@{\nil@}%
Chris@10 7435 \long\def\nillm@{\nil@}%
Chris@10 7436
Chris@10 7437 % This macro is expanded during the Texinfo macro expansion, not during its
Chris@10 7438 % definition. It gets all the arguments values and assigns them to macros
Chris@10 7439 % macarg.ARGNAME
Chris@10 7440 %
Chris@10 7441 % #1 is the macro name
Chris@10 7442 % #2 is the list of argument names
Chris@10 7443 % #3 is the list of argument values
Chris@10 7444 \def\getargvals@#1#2#3{%
Chris@10 7445 \def\macargdeflist@{}%
Chris@10 7446 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
Chris@10 7447 \def\paramlist{#2,\nil@}%
Chris@10 7448 \def\macroname{#1}%
Chris@10 7449 \begingroup
Chris@10 7450 \macroargctxt
Chris@10 7451 \def\argvaluelist{#3,\nil@}%
Chris@10 7452 \def\@tempa{#3}%
Chris@10 7453 \ifx\@tempa\empty
Chris@10 7454 \setemptyargvalues@
Chris@10 7455 \else
Chris@10 7456 \getargvals@@
Chris@10 7457 \fi
Chris@10 7458 }
Chris@10 7459
Chris@10 7460 %
Chris@10 7461 \def\getargvals@@{%
Chris@10 7462 \ifx\paramlist\nilm@
Chris@10 7463 % Some sanity check needed here that \argvaluelist is also empty.
Chris@10 7464 \ifx\argvaluelist\nillm@
Chris@10 7465 \else
Chris@10 7466 \errhelp = \EMsimple
Chris@10 7467 \errmessage{Too many arguments in macro `\macroname'!}%
Chris@10 7468 \fi
Chris@10 7469 \let\next\macargexpandinbody@
Chris@10 7470 \else
Chris@10 7471 \ifx\argvaluelist\nillm@
Chris@10 7472 % No more arguments values passed to macro. Set remaining named-arg
Chris@10 7473 % macros to empty.
Chris@10 7474 \let\next\setemptyargvalues@
Chris@10 7475 \else
Chris@10 7476 % pop current arg name into \@tempb
Chris@10 7477 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
Chris@10 7478 \expandafter\@tempa\expandafter{\paramlist}%
Chris@10 7479 % pop current argument value into \@tempc
Chris@10 7480 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
Chris@10 7481 \expandafter\@tempa\expandafter{\argvaluelist}%
Chris@10 7482 % Here \@tempb is the current arg name and \@tempc is the current arg value.
Chris@10 7483 % First place the new argument macro definition into \@tempd
Chris@10 7484 \expandafter\macname\expandafter{\@tempc}%
Chris@10 7485 \expandafter\let\csname macarg.\@tempb\endcsname\relax
Chris@10 7486 \expandafter\def\expandafter\@tempe\expandafter{%
Chris@10 7487 \csname macarg.\@tempb\endcsname}%
Chris@10 7488 \edef\@tempd{\long\def\@tempe{\the\macname}}%
Chris@10 7489 \push@\@tempd\macargdeflist@
Chris@10 7490 \let\next\getargvals@@
Chris@10 7491 \fi
Chris@10 7492 \fi
Chris@10 7493 \next
Chris@10 7494 }
Chris@10 7495
Chris@10 7496 \def\push@#1#2{%
Chris@10 7497 \expandafter\expandafter\expandafter\def
Chris@10 7498 \expandafter\expandafter\expandafter#2%
Chris@10 7499 \expandafter\expandafter\expandafter{%
Chris@10 7500 \expandafter#1#2}%
Chris@10 7501 }
Chris@10 7502
Chris@10 7503 % Replace arguments by their values in the macro body, and place the result
Chris@10 7504 % in macro \@tempa
Chris@10 7505 \def\macvalstoargs@{%
Chris@10 7506 % To do this we use the property that token registers that are \the'ed
Chris@10 7507 % within an \edef expand only once. So we are going to place all argument
Chris@10 7508 % values into respective token registers.
Chris@10 7509 %
Chris@10 7510 % First we save the token context, and initialize argument numbering.
Chris@10 7511 \begingroup
Chris@10 7512 \paramno0\relax
Chris@10 7513 % Then, for each argument number #N, we place the corresponding argument
Chris@10 7514 % value into a new token list register \toks#N
Chris@10 7515 \expandafter\putargsintokens@\saveparamlist@,;,%
Chris@10 7516 % Then, we expand the body so that argument are replaced by their
Chris@10 7517 % values. The trick for values not to be expanded themselves is that they
Chris@10 7518 % are within tokens and that tokens expand only once in an \edef .
Chris@10 7519 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
Chris@10 7520 % Now we restore the token stack pointer to free the token list registers
Chris@10 7521 % which we have used, but we make sure that expanded body is saved after
Chris@10 7522 % group.
Chris@10 7523 \expandafter
Chris@10 7524 \endgroup
Chris@10 7525 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
Chris@10 7526 }
Chris@10 7527
Chris@10 7528 \def\macargexpandinbody@{%
Chris@10 7529 %% Define the named-macro outside of this group and then close this group.
Chris@10 7530 \expandafter
Chris@10 7531 \endgroup
Chris@10 7532 \macargdeflist@
Chris@10 7533 % First the replace in body the macro arguments by their values, the result
Chris@10 7534 % is in \@tempa .
Chris@10 7535 \macvalstoargs@
Chris@10 7536 % Then we point at the \norecurse or \gobble (for recursive) macro value
Chris@10 7537 % with \@tempb .
Chris@10 7538 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
Chris@10 7539 % Depending on whether it is recursive or not, we need some tailing
Chris@10 7540 % \egroup .
Chris@10 7541 \ifx\@tempb\gobble
Chris@10 7542 \let\@tempc\relax
Chris@10 7543 \else
Chris@10 7544 \let\@tempc\egroup
Chris@10 7545 \fi
Chris@10 7546 % And now we do the real job:
Chris@10 7547 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
Chris@10 7548 \@tempd
Chris@10 7549 }
Chris@10 7550
Chris@10 7551 \def\putargsintokens@#1,{%
Chris@10 7552 \if#1;\let\next\relax
Chris@10 7553 \else
Chris@10 7554 \let\next\putargsintokens@
Chris@10 7555 % First we allocate the new token list register, and give it a temporary
Chris@10 7556 % alias \@tempb .
Chris@10 7557 \toksdef\@tempb\the\paramno
Chris@10 7558 % Then we place the argument value into that token list register.
Chris@10 7559 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
Chris@10 7560 \expandafter\@tempb\expandafter{\@tempa}%
Chris@10 7561 \advance\paramno by 1\relax
Chris@10 7562 \fi
Chris@10 7563 \next
Chris@10 7564 }
Chris@10 7565
Chris@10 7566 % Save the token stack pointer into macro #1
Chris@10 7567 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
Chris@10 7568 % Restore the token stack pointer from number in macro #1
Chris@10 7569 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
Chris@10 7570 % newtoks that can be used non \outer .
Chris@10 7571 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
Chris@10 7572
Chris@10 7573 % Tailing missing arguments are set to empty
Chris@10 7574 \def\setemptyargvalues@{%
Chris@10 7575 \ifx\paramlist\nilm@
Chris@10 7576 \let\next\macargexpandinbody@
Chris@10 7577 \else
Chris@10 7578 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
Chris@10 7579 \let\next\setemptyargvalues@
Chris@10 7580 \fi
Chris@10 7581 \next
Chris@10 7582 }
Chris@10 7583
Chris@10 7584 \def\setemptyargvaluesparser@#1,#2\endargs@{%
Chris@10 7585 \expandafter\def\expandafter\@tempa\expandafter{%
Chris@10 7586 \expandafter\def\csname macarg.#1\endcsname{}}%
Chris@10 7587 \push@\@tempa\macargdeflist@
Chris@10 7588 \def\paramlist{#2}%
Chris@10 7589 }
Chris@10 7590
Chris@10 7591 % #1 is the element target macro
Chris@10 7592 % #2 is the list macro
Chris@10 7593 % #3,#4\endargs@ is the list value
Chris@10 7594 \def\pop@#1#2#3,#4\endargs@{%
Chris@10 7595 \def#1{#3}%
Chris@10 7596 \def#2{#4}%
Chris@10 7597 }
Chris@10 7598 \long\def\longpop@#1#2#3,#4\endargs@{%
Chris@10 7599 \long\def#1{#3}%
Chris@10 7600 \long\def#2{#4}%
Chris@10 7601 }
Chris@10 7602
Chris@10 7603 % This defines a Texinfo @macro. There are eight cases: recursive and
Chris@10 7604 % nonrecursive macros of zero, one, up to nine, and many arguments.
Chris@10 7605 % Much magic with \expandafter here.
Chris@10 7606 % \xdef is used so that macro definitions will survive the file
Chris@10 7607 % they're defined in; @include reads the file inside a group.
Chris@10 7608 %
Chris@10 7609 \def\defmacro{%
Chris@10 7610 \let\hash=##% convert placeholders to macro parameter chars
Chris@10 7611 \ifrecursive
Chris@10 7612 \ifcase\paramno
Chris@10 7613 % 0
Chris@10 7614 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7615 \noexpand\scanmacro{\temp}}%
Chris@10 7616 \or % 1
Chris@10 7617 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7618 \bgroup\noexpand\macroargctxt
Chris@10 7619 \noexpand\braceorline
Chris@10 7620 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
Chris@10 7621 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
Chris@10 7622 \egroup\noexpand\scanmacro{\temp}}%
Chris@10 7623 \else
Chris@10 7624 \ifnum\paramno<10\relax % at most 9
Chris@10 7625 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7626 \bgroup\noexpand\macroargctxt
Chris@10 7627 \noexpand\csname\the\macname xx\endcsname}%
Chris@10 7628 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
Chris@10 7629 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
Chris@10 7630 \expandafter\expandafter
Chris@10 7631 \expandafter\xdef
Chris@10 7632 \expandafter\expandafter
Chris@10 7633 \csname\the\macname xxx\endcsname
Chris@10 7634 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
Chris@10 7635 \else % 10 or more
Chris@10 7636 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7637 \noexpand\getargvals@{\the\macname}{\argl}%
Chris@10 7638 }%
Chris@10 7639 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
Chris@10 7640 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
Chris@10 7641 \fi
Chris@10 7642 \fi
Chris@10 7643 \else
Chris@10 7644 \ifcase\paramno
Chris@10 7645 % 0
Chris@10 7646 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7647 \noexpand\norecurse{\the\macname}%
Chris@10 7648 \noexpand\scanmacro{\temp}\egroup}%
Chris@10 7649 \or % 1
Chris@10 7650 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7651 \bgroup\noexpand\macroargctxt
Chris@10 7652 \noexpand\braceorline
Chris@10 7653 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
Chris@10 7654 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
Chris@10 7655 \egroup
Chris@10 7656 \noexpand\norecurse{\the\macname}%
Chris@10 7657 \noexpand\scanmacro{\temp}\egroup}%
Chris@10 7658 \else % at most 9
Chris@10 7659 \ifnum\paramno<10\relax
Chris@10 7660 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7661 \bgroup\noexpand\macroargctxt
Chris@10 7662 \expandafter\noexpand\csname\the\macname xx\endcsname}%
Chris@10 7663 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
Chris@10 7664 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
Chris@10 7665 \expandafter\expandafter
Chris@10 7666 \expandafter\xdef
Chris@10 7667 \expandafter\expandafter
Chris@10 7668 \csname\the\macname xxx\endcsname
Chris@10 7669 \paramlist{%
Chris@10 7670 \egroup
Chris@10 7671 \noexpand\norecurse{\the\macname}%
Chris@10 7672 \noexpand\scanmacro{\temp}\egroup}%
Chris@10 7673 \else % 10 or more:
Chris@10 7674 \expandafter\xdef\csname\the\macname\endcsname{%
Chris@10 7675 \noexpand\getargvals@{\the\macname}{\argl}%
Chris@10 7676 }%
Chris@10 7677 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
Chris@10 7678 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
Chris@10 7679 \fi
Chris@10 7680 \fi
Chris@10 7681 \fi}
Chris@10 7682
Chris@10 7683 \catcode `\@\texiatcatcode\relax
Chris@10 7684
Chris@10 7685 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
Chris@10 7686
Chris@10 7687 % \braceorline decides whether the next nonwhitespace character is a
Chris@10 7688 % {. If so it reads up to the closing }, if not, it reads the whole
Chris@10 7689 % line. Whatever was read is then fed to the next control sequence
Chris@10 7690 % as an argument (by \parsebrace or \parsearg).
Chris@10 7691 %
Chris@10 7692 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
Chris@10 7693 \def\braceorlinexxx{%
Chris@10 7694 \ifx\nchar\bgroup\else
Chris@10 7695 \expandafter\parsearg
Chris@10 7696 \fi \macnamexxx}
Chris@10 7697
Chris@10 7698
Chris@10 7699 % @alias.
Chris@10 7700 % We need some trickery to remove the optional spaces around the equal
Chris@10 7701 % sign. Make them active and then expand them all to nothing.
Chris@10 7702 %
Chris@10 7703 \def\alias{\parseargusing\obeyspaces\aliasxxx}
Chris@10 7704 \def\aliasxxx #1{\aliasyyy#1\relax}
Chris@10 7705 \def\aliasyyy #1=#2\relax{%
Chris@10 7706 {%
Chris@10 7707 \expandafter\let\obeyedspace=\empty
Chris@10 7708 \addtomacrolist{#1}%
Chris@10 7709 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
Chris@10 7710 }%
Chris@10 7711 \next
Chris@10 7712 }
Chris@10 7713
Chris@10 7714
Chris@10 7715 \message{cross references,}
Chris@10 7716
Chris@10 7717 \newwrite\auxfile
Chris@10 7718 \newif\ifhavexrefs % True if xref values are known.
Chris@10 7719 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
Chris@10 7720
Chris@10 7721 % @inforef is relatively simple.
Chris@10 7722 \def\inforef #1{\inforefzzz #1,,,,**}
Chris@10 7723 \def\inforefzzz #1,#2,#3,#4**{%
Chris@10 7724 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
Chris@10 7725 node \samp{\ignorespaces#1{}}}
Chris@10 7726
Chris@10 7727 % @node's only job in TeX is to define \lastnode, which is used in
Chris@10 7728 % cross-references. The @node line might or might not have commas, and
Chris@10 7729 % might or might not have spaces before the first comma, like:
Chris@10 7730 % @node foo , bar , ...
Chris@10 7731 % We don't want such trailing spaces in the node name.
Chris@10 7732 %
Chris@10 7733 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
Chris@10 7734 %
Chris@10 7735 % also remove a trailing comma, in case of something like this:
Chris@10 7736 % @node Help-Cross, , , Cross-refs
Chris@10 7737 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
Chris@10 7738 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
Chris@10 7739
Chris@10 7740 \let\nwnode=\node
Chris@10 7741 \let\lastnode=\empty
Chris@10 7742
Chris@10 7743 % Write a cross-reference definition for the current node. #1 is the
Chris@10 7744 % type (Ynumbered, Yappendix, Ynothing).
Chris@10 7745 %
Chris@10 7746 \def\donoderef#1{%
Chris@10 7747 \ifx\lastnode\empty\else
Chris@10 7748 \setref{\lastnode}{#1}%
Chris@10 7749 \global\let\lastnode=\empty
Chris@10 7750 \fi
Chris@10 7751 }
Chris@10 7752
Chris@10 7753 % @anchor{NAME} -- define xref target at arbitrary point.
Chris@10 7754 %
Chris@10 7755 \newcount\savesfregister
Chris@10 7756 %
Chris@10 7757 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
Chris@10 7758 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
Chris@10 7759 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
Chris@10 7760
Chris@10 7761 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
Chris@10 7762 % anchor), which consists of three parts:
Chris@10 7763 % 1) NAME-title - the current sectioning name taken from \lastsection,
Chris@10 7764 % or the anchor name.
Chris@10 7765 % 2) NAME-snt - section number and type, passed as the SNT arg, or
Chris@10 7766 % empty for anchors.
Chris@10 7767 % 3) NAME-pg - the page number.
Chris@10 7768 %
Chris@10 7769 % This is called from \donoderef, \anchor, and \dofloat. In the case of
Chris@10 7770 % floats, there is an additional part, which is not written here:
Chris@10 7771 % 4) NAME-lof - the text as it should appear in a @listoffloats.
Chris@10 7772 %
Chris@10 7773 \def\setref#1#2{%
Chris@10 7774 \pdfmkdest{#1}%
Chris@10 7775 \iflinks
Chris@10 7776 {%
Chris@10 7777 \atdummies % preserve commands, but don't expand them
Chris@10 7778 \edef\writexrdef##1##2{%
Chris@10 7779 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
Chris@10 7780 ##1}{##2}}% these are parameters of \writexrdef
Chris@10 7781 }%
Chris@10 7782 \toks0 = \expandafter{\lastsection}%
Chris@10 7783 \immediate \writexrdef{title}{\the\toks0 }%
Chris@10 7784 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
Chris@10 7785 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
Chris@10 7786 }%
Chris@10 7787 \fi
Chris@10 7788 }
Chris@10 7789
Chris@10 7790 % @xrefautosectiontitle on|off says whether @section(ing) names are used
Chris@10 7791 % automatically in xrefs, if the third arg is not explicitly specified.
Chris@10 7792 % This was provided as a "secret" @set xref-automatic-section-title
Chris@10 7793 % variable, now it's official.
Chris@10 7794 %
Chris@10 7795 \parseargdef\xrefautomaticsectiontitle{%
Chris@10 7796 \def\temp{#1}%
Chris@10 7797 \ifx\temp\onword
Chris@10 7798 \expandafter\let\csname SETxref-automatic-section-title\endcsname
Chris@10 7799 = \empty
Chris@10 7800 \else\ifx\temp\offword
Chris@10 7801 \expandafter\let\csname SETxref-automatic-section-title\endcsname
Chris@10 7802 = \relax
Chris@10 7803 \else
Chris@10 7804 \errhelp = \EMsimple
Chris@10 7805 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
Chris@10 7806 must be on|off}%
Chris@10 7807 \fi\fi
Chris@10 7808 }
Chris@10 7809
Chris@10 7810
Chris@10 7811 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
Chris@10 7812 % the node name, #2 the name of the Info cross-reference, #3 the printed
Chris@10 7813 % node name, #4 the name of the Info file, #5 the name of the printed
Chris@10 7814 % manual. All but the node name can be omitted.
Chris@10 7815 %
Chris@10 7816 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
Chris@10 7817 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
Chris@10 7818 \def\ref#1{\xrefX[#1,,,,,,,]}
Chris@10 7819 %
Chris@10 7820 \newbox\topbox
Chris@10 7821 \newbox\printedrefnamebox
Chris@10 7822 \newbox\printedmanualbox
Chris@10 7823 %
Chris@10 7824 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
Chris@10 7825 \unsepspaces
Chris@10 7826 %
Chris@10 7827 \def\printedrefname{\ignorespaces #3}%
Chris@10 7828 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
Chris@10 7829 %
Chris@10 7830 \def\printedmanual{\ignorespaces #5}%
Chris@10 7831 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
Chris@10 7832 %
Chris@10 7833 % If the printed reference name (arg #3) was not explicitly given in
Chris@10 7834 % the @xref, figure out what we want to use.
Chris@10 7835 \ifdim \wd\printedrefnamebox = 0pt
Chris@10 7836 % No printed node name was explicitly given.
Chris@10 7837 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
Chris@10 7838 % Not auto section-title: use node name inside the square brackets.
Chris@10 7839 \def\printedrefname{\ignorespaces #1}%
Chris@10 7840 \else
Chris@10 7841 % Auto section-title: use chapter/section title inside
Chris@10 7842 % the square brackets if we have it.
Chris@10 7843 \ifdim \wd\printedmanualbox > 0pt
Chris@10 7844 % It is in another manual, so we don't have it; use node name.
Chris@10 7845 \def\printedrefname{\ignorespaces #1}%
Chris@10 7846 \else
Chris@10 7847 \ifhavexrefs
Chris@10 7848 % We (should) know the real title if we have the xref values.
Chris@10 7849 \def\printedrefname{\refx{#1-title}{}}%
Chris@10 7850 \else
Chris@10 7851 % Otherwise just copy the Info node name.
Chris@10 7852 \def\printedrefname{\ignorespaces #1}%
Chris@10 7853 \fi%
Chris@10 7854 \fi
Chris@10 7855 \fi
Chris@10 7856 \fi
Chris@10 7857 %
Chris@10 7858 % Make link in pdf output.
Chris@10 7859 \ifpdf
Chris@10 7860 {\indexnofonts
Chris@10 7861 \turnoffactive
Chris@10 7862 \makevalueexpandable
Chris@10 7863 % This expands tokens, so do it after making catcode changes, so _
Chris@10 7864 % etc. don't get their TeX definitions.
Chris@10 7865 \getfilename{#4}%
Chris@10 7866 %
Chris@10 7867 \edef\pdfxrefdest{#1}%
Chris@10 7868 \txiescapepdf\pdfxrefdest
Chris@10 7869 %
Chris@10 7870 \leavevmode
Chris@10 7871 \startlink attr{/Border [0 0 0]}%
Chris@10 7872 \ifnum\filenamelength>0
Chris@10 7873 goto file{\the\filename.pdf} name{\pdfxrefdest}%
Chris@10 7874 \else
Chris@10 7875 goto name{\pdfmkpgn{\pdfxrefdest}}%
Chris@10 7876 \fi
Chris@10 7877 }%
Chris@10 7878 \setcolor{\linkcolor}%
Chris@10 7879 \fi
Chris@10 7880 %
Chris@10 7881 % Float references are printed completely differently: "Figure 1.2"
Chris@10 7882 % instead of "[somenode], p.3". We distinguish them by the
Chris@10 7883 % LABEL-title being set to a magic string.
Chris@10 7884 {%
Chris@10 7885 % Have to otherify everything special to allow the \csname to
Chris@10 7886 % include an _ in the xref name, etc.
Chris@10 7887 \indexnofonts
Chris@10 7888 \turnoffactive
Chris@10 7889 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
Chris@10 7890 \csname XR#1-title\endcsname
Chris@10 7891 }%
Chris@10 7892 \iffloat\Xthisreftitle
Chris@10 7893 % If the user specified the print name (third arg) to the ref,
Chris@10 7894 % print it instead of our usual "Figure 1.2".
Chris@10 7895 \ifdim\wd\printedrefnamebox = 0pt
Chris@10 7896 \refx{#1-snt}{}%
Chris@10 7897 \else
Chris@10 7898 \printedrefname
Chris@10 7899 \fi
Chris@10 7900 %
Chris@10 7901 % if the user also gave the printed manual name (fifth arg), append
Chris@10 7902 % "in MANUALNAME".
Chris@10 7903 \ifdim \wd\printedmanualbox > 0pt
Chris@10 7904 \space \putwordin{} \cite{\printedmanual}%
Chris@10 7905 \fi
Chris@10 7906 \else
Chris@10 7907 % node/anchor (non-float) references.
Chris@10 7908 %
Chris@10 7909 % If we use \unhbox to print the node names, TeX does not insert
Chris@10 7910 % empty discretionaries after hyphens, which means that it will not
Chris@10 7911 % find a line break at a hyphen in a node names. Since some manuals
Chris@10 7912 % are best written with fairly long node names, containing hyphens,
Chris@10 7913 % this is a loss. Therefore, we give the text of the node name
Chris@10 7914 % again, so it is as if TeX is seeing it for the first time.
Chris@10 7915 %
Chris@10 7916 % Cross-manual reference. Only include the "Section ``foo'' in" if
Chris@10 7917 % the foo is neither missing or Top. Thus, @xref{,,,foo,The Foo Manual}
Chris@10 7918 % outputs simply "see The Foo Manual".
Chris@10 7919 \ifdim \wd\printedmanualbox > 0pt
Chris@10 7920 % What is the 7sp about? The idea is that we also want to omit
Chris@10 7921 % the Section part if we would be printing "Top", since they are
Chris@10 7922 % clearly trying to refer to the whole manual. But, this being
Chris@10 7923 % TeX, we can't easily compare strings while ignoring the possible
Chris@10 7924 % spaces before and after in the input. By adding the arbitrary
Chris@10 7925 % 7sp, we make it much less likely that a real node name would
Chris@10 7926 % happen to have the same width as "Top" (e.g., in a monospaced font).
Chris@10 7927 % I hope it will never happen in practice.
Chris@10 7928 %
Chris@10 7929 % For the same basic reason, we retypeset the "Top" at every
Chris@10 7930 % reference, since the current font is indeterminate.
Chris@10 7931 %
Chris@10 7932 \setbox\topbox = \hbox{Top\kern7sp}%
Chris@10 7933 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
Chris@10 7934 \ifdim \wd2 > 7sp
Chris@10 7935 \ifdim \wd2 = \wd\topbox \else
Chris@10 7936 \putwordSection{} ``\printedrefname'' \putwordin{}\space
Chris@10 7937 \fi
Chris@10 7938 \fi
Chris@10 7939 \cite{\printedmanual}%
Chris@10 7940 \else
Chris@10 7941 % Reference in this manual.
Chris@10 7942 %
Chris@10 7943 % _ (for example) has to be the character _ for the purposes of the
Chris@10 7944 % control sequence corresponding to the node, but it has to expand
Chris@10 7945 % into the usual \leavevmode...\vrule stuff for purposes of
Chris@10 7946 % printing. So we \turnoffactive for the \refx-snt, back on for the
Chris@10 7947 % printing, back off for the \refx-pg.
Chris@10 7948 {\turnoffactive
Chris@10 7949 % Only output a following space if the -snt ref is nonempty; for
Chris@10 7950 % @unnumbered and @anchor, it won't be.
Chris@10 7951 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
Chris@10 7952 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
Chris@10 7953 }%
Chris@10 7954 % output the `[mynode]' via the macro below so it can be overridden.
Chris@10 7955 \xrefprintnodename\printedrefname
Chris@10 7956 %
Chris@10 7957 % But we always want a comma and a space:
Chris@10 7958 ,\space
Chris@10 7959 %
Chris@10 7960 % output the `page 3'.
Chris@10 7961 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
Chris@10 7962 \fi
Chris@10 7963 \fi
Chris@10 7964 \endlink
Chris@10 7965 \endgroup}
Chris@10 7966
Chris@10 7967 % This macro is called from \xrefX for the `[nodename]' part of xref
Chris@10 7968 % output. It's a separate macro only so it can be changed more easily,
Chris@10 7969 % since square brackets don't work well in some documents. Particularly
Chris@10 7970 % one that Bob is working on :).
Chris@10 7971 %
Chris@10 7972 \def\xrefprintnodename#1{[#1]}
Chris@10 7973
Chris@10 7974 % Things referred to by \setref.
Chris@10 7975 %
Chris@10 7976 \def\Ynothing{}
Chris@10 7977 \def\Yomitfromtoc{}
Chris@10 7978 \def\Ynumbered{%
Chris@10 7979 \ifnum\secno=0
Chris@10 7980 \putwordChapter@tie \the\chapno
Chris@10 7981 \else \ifnum\subsecno=0
Chris@10 7982 \putwordSection@tie \the\chapno.\the\secno
Chris@10 7983 \else \ifnum\subsubsecno=0
Chris@10 7984 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
Chris@10 7985 \else
Chris@10 7986 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
Chris@10 7987 \fi\fi\fi
Chris@10 7988 }
Chris@10 7989 \def\Yappendix{%
Chris@10 7990 \ifnum\secno=0
Chris@10 7991 \putwordAppendix@tie @char\the\appendixno{}%
Chris@10 7992 \else \ifnum\subsecno=0
Chris@10 7993 \putwordSection@tie @char\the\appendixno.\the\secno
Chris@10 7994 \else \ifnum\subsubsecno=0
Chris@10 7995 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
Chris@10 7996 \else
Chris@10 7997 \putwordSection@tie
Chris@10 7998 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
Chris@10 7999 \fi\fi\fi
Chris@10 8000 }
Chris@10 8001
Chris@10 8002 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
Chris@10 8003 % If its value is nonempty, SUFFIX is output afterward.
Chris@10 8004 %
Chris@10 8005 \def\refx#1#2{%
Chris@10 8006 {%
Chris@10 8007 \indexnofonts
Chris@10 8008 \otherbackslash
Chris@10 8009 \expandafter\global\expandafter\let\expandafter\thisrefX
Chris@10 8010 \csname XR#1\endcsname
Chris@10 8011 }%
Chris@10 8012 \ifx\thisrefX\relax
Chris@10 8013 % If not defined, say something at least.
Chris@10 8014 \angleleft un\-de\-fined\angleright
Chris@10 8015 \iflinks
Chris@10 8016 \ifhavexrefs
Chris@10 8017 {\toks0 = {#1}% avoid expansion of possibly-complex value
Chris@10 8018 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
Chris@10 8019 \else
Chris@10 8020 \ifwarnedxrefs\else
Chris@10 8021 \global\warnedxrefstrue
Chris@10 8022 \message{Cross reference values unknown; you must run TeX again.}%
Chris@10 8023 \fi
Chris@10 8024 \fi
Chris@10 8025 \fi
Chris@10 8026 \else
Chris@10 8027 % It's defined, so just use it.
Chris@10 8028 \thisrefX
Chris@10 8029 \fi
Chris@10 8030 #2% Output the suffix in any case.
Chris@10 8031 }
Chris@10 8032
Chris@10 8033 % This is the macro invoked by entries in the aux file. Usually it's
Chris@10 8034 % just a \def (we prepend XR to the control sequence name to avoid
Chris@10 8035 % collisions). But if this is a float type, we have more work to do.
Chris@10 8036 %
Chris@10 8037 \def\xrdef#1#2{%
Chris@10 8038 {% The node name might contain 8-bit characters, which in our current
Chris@10 8039 % implementation are changed to commands like @'e. Don't let these
Chris@10 8040 % mess up the control sequence name.
Chris@10 8041 \indexnofonts
Chris@10 8042 \turnoffactive
Chris@10 8043 \xdef\safexrefname{#1}%
Chris@10 8044 }%
Chris@10 8045 %
Chris@10 8046 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
Chris@10 8047 %
Chris@10 8048 % Was that xref control sequence that we just defined for a float?
Chris@10 8049 \expandafter\iffloat\csname XR\safexrefname\endcsname
Chris@10 8050 % it was a float, and we have the (safe) float type in \iffloattype.
Chris@10 8051 \expandafter\let\expandafter\floatlist
Chris@10 8052 \csname floatlist\iffloattype\endcsname
Chris@10 8053 %
Chris@10 8054 % Is this the first time we've seen this float type?
Chris@10 8055 \expandafter\ifx\floatlist\relax
Chris@10 8056 \toks0 = {\do}% yes, so just \do
Chris@10 8057 \else
Chris@10 8058 % had it before, so preserve previous elements in list.
Chris@10 8059 \toks0 = \expandafter{\floatlist\do}%
Chris@10 8060 \fi
Chris@10 8061 %
Chris@10 8062 % Remember this xref in the control sequence \floatlistFLOATTYPE,
Chris@10 8063 % for later use in \listoffloats.
Chris@10 8064 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
Chris@10 8065 {\safexrefname}}%
Chris@10 8066 \fi
Chris@10 8067 }
Chris@10 8068
Chris@10 8069 % Read the last existing aux file, if any. No error if none exists.
Chris@10 8070 %
Chris@10 8071 \def\tryauxfile{%
Chris@10 8072 \openin 1 \jobname.aux
Chris@10 8073 \ifeof 1 \else
Chris@10 8074 \readdatafile{aux}%
Chris@10 8075 \global\havexrefstrue
Chris@10 8076 \fi
Chris@10 8077 \closein 1
Chris@10 8078 }
Chris@10 8079
Chris@10 8080 \def\setupdatafile{%
Chris@10 8081 \catcode`\^^@=\other
Chris@10 8082 \catcode`\^^A=\other
Chris@10 8083 \catcode`\^^B=\other
Chris@10 8084 \catcode`\^^C=\other
Chris@10 8085 \catcode`\^^D=\other
Chris@10 8086 \catcode`\^^E=\other
Chris@10 8087 \catcode`\^^F=\other
Chris@10 8088 \catcode`\^^G=\other
Chris@10 8089 \catcode`\^^H=\other
Chris@10 8090 \catcode`\^^K=\other
Chris@10 8091 \catcode`\^^L=\other
Chris@10 8092 \catcode`\^^N=\other
Chris@10 8093 \catcode`\^^P=\other
Chris@10 8094 \catcode`\^^Q=\other
Chris@10 8095 \catcode`\^^R=\other
Chris@10 8096 \catcode`\^^S=\other
Chris@10 8097 \catcode`\^^T=\other
Chris@10 8098 \catcode`\^^U=\other
Chris@10 8099 \catcode`\^^V=\other
Chris@10 8100 \catcode`\^^W=\other
Chris@10 8101 \catcode`\^^X=\other
Chris@10 8102 \catcode`\^^Z=\other
Chris@10 8103 \catcode`\^^[=\other
Chris@10 8104 \catcode`\^^\=\other
Chris@10 8105 \catcode`\^^]=\other
Chris@10 8106 \catcode`\^^^=\other
Chris@10 8107 \catcode`\^^_=\other
Chris@10 8108 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
Chris@10 8109 % in xref tags, i.e., node names. But since ^^e4 notation isn't
Chris@10 8110 % supported in the main text, it doesn't seem desirable. Furthermore,
Chris@10 8111 % that is not enough: for node names that actually contain a ^
Chris@10 8112 % character, we would end up writing a line like this: 'xrdef {'hat
Chris@10 8113 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
Chris@10 8114 % argument, and \hat is not an expandable control sequence. It could
Chris@10 8115 % all be worked out, but why? Either we support ^^ or we don't.
Chris@10 8116 %
Chris@10 8117 % The other change necessary for this was to define \auxhat:
Chris@10 8118 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
Chris@10 8119 % and then to call \auxhat in \setq.
Chris@10 8120 %
Chris@10 8121 \catcode`\^=\other
Chris@10 8122 %
Chris@10 8123 % Special characters. Should be turned off anyway, but...
Chris@10 8124 \catcode`\~=\other
Chris@10 8125 \catcode`\[=\other
Chris@10 8126 \catcode`\]=\other
Chris@10 8127 \catcode`\"=\other
Chris@10 8128 \catcode`\_=\other
Chris@10 8129 \catcode`\|=\other
Chris@10 8130 \catcode`\<=\other
Chris@10 8131 \catcode`\>=\other
Chris@10 8132 \catcode`\$=\other
Chris@10 8133 \catcode`\#=\other
Chris@10 8134 \catcode`\&=\other
Chris@10 8135 \catcode`\%=\other
Chris@10 8136 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
Chris@10 8137 %
Chris@10 8138 % This is to support \ in node names and titles, since the \
Chris@10 8139 % characters end up in a \csname. It's easier than
Chris@10 8140 % leaving it active and making its active definition an actual \
Chris@10 8141 % character. What I don't understand is why it works in the *value*
Chris@10 8142 % of the xrdef. Seems like it should be a catcode12 \, and that
Chris@10 8143 % should not typeset properly. But it works, so I'm moving on for
Chris@10 8144 % now. --karl, 15jan04.
Chris@10 8145 \catcode`\\=\other
Chris@10 8146 %
Chris@10 8147 % Make the characters 128-255 be printing characters.
Chris@10 8148 {%
Chris@10 8149 \count1=128
Chris@10 8150 \def\loop{%
Chris@10 8151 \catcode\count1=\other
Chris@10 8152 \advance\count1 by 1
Chris@10 8153 \ifnum \count1<256 \loop \fi
Chris@10 8154 }%
Chris@10 8155 }%
Chris@10 8156 %
Chris@10 8157 % @ is our escape character in .aux files, and we need braces.
Chris@10 8158 \catcode`\{=1
Chris@10 8159 \catcode`\}=2
Chris@10 8160 \catcode`\@=0
Chris@10 8161 }
Chris@10 8162
Chris@10 8163 \def\readdatafile#1{%
Chris@10 8164 \begingroup
Chris@10 8165 \setupdatafile
Chris@10 8166 \input\jobname.#1
Chris@10 8167 \endgroup}
Chris@10 8168
Chris@10 8169
Chris@10 8170 \message{insertions,}
Chris@10 8171 % including footnotes.
Chris@10 8172
Chris@10 8173 \newcount \footnoteno
Chris@10 8174
Chris@10 8175 % The trailing space in the following definition for supereject is
Chris@10 8176 % vital for proper filling; pages come out unaligned when you do a
Chris@10 8177 % pagealignmacro call if that space before the closing brace is
Chris@10 8178 % removed. (Generally, numeric constants should always be followed by a
Chris@10 8179 % space to prevent strange expansion errors.)
Chris@10 8180 \def\supereject{\par\penalty -20000\footnoteno =0 }
Chris@10 8181
Chris@10 8182 % @footnotestyle is meaningful for Info output only.
Chris@10 8183 \let\footnotestyle=\comment
Chris@10 8184
Chris@10 8185 {\catcode `\@=11
Chris@10 8186 %
Chris@10 8187 % Auto-number footnotes. Otherwise like plain.
Chris@10 8188 \gdef\footnote{%
Chris@10 8189 \let\indent=\ptexindent
Chris@10 8190 \let\noindent=\ptexnoindent
Chris@10 8191 \global\advance\footnoteno by \@ne
Chris@10 8192 \edef\thisfootno{$^{\the\footnoteno}$}%
Chris@10 8193 %
Chris@10 8194 % In case the footnote comes at the end of a sentence, preserve the
Chris@10 8195 % extra spacing after we do the footnote number.
Chris@10 8196 \let\@sf\empty
Chris@10 8197 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
Chris@10 8198 %
Chris@10 8199 % Remove inadvertent blank space before typesetting the footnote number.
Chris@10 8200 \unskip
Chris@10 8201 \thisfootno\@sf
Chris@10 8202 \dofootnote
Chris@10 8203 }%
Chris@10 8204
Chris@10 8205 % Don't bother with the trickery in plain.tex to not require the
Chris@10 8206 % footnote text as a parameter. Our footnotes don't need to be so general.
Chris@10 8207 %
Chris@10 8208 % Oh yes, they do; otherwise, @ifset (and anything else that uses
Chris@10 8209 % \parseargline) fails inside footnotes because the tokens are fixed when
Chris@10 8210 % the footnote is read. --karl, 16nov96.
Chris@10 8211 %
Chris@10 8212 \gdef\dofootnote{%
Chris@10 8213 \insert\footins\bgroup
Chris@10 8214 % We want to typeset this text as a normal paragraph, even if the
Chris@10 8215 % footnote reference occurs in (for example) a display environment.
Chris@10 8216 % So reset some parameters.
Chris@10 8217 \hsize=\pagewidth
Chris@10 8218 \interlinepenalty\interfootnotelinepenalty
Chris@10 8219 \splittopskip\ht\strutbox % top baseline for broken footnotes
Chris@10 8220 \splitmaxdepth\dp\strutbox
Chris@10 8221 \floatingpenalty\@MM
Chris@10 8222 \leftskip\z@skip
Chris@10 8223 \rightskip\z@skip
Chris@10 8224 \spaceskip\z@skip
Chris@10 8225 \xspaceskip\z@skip
Chris@10 8226 \parindent\defaultparindent
Chris@10 8227 %
Chris@10 8228 \smallfonts \rm
Chris@10 8229 %
Chris@10 8230 % Because we use hanging indentation in footnotes, a @noindent appears
Chris@10 8231 % to exdent this text, so make it be a no-op. makeinfo does not use
Chris@10 8232 % hanging indentation so @noindent can still be needed within footnote
Chris@10 8233 % text after an @example or the like (not that this is good style).
Chris@10 8234 \let\noindent = \relax
Chris@10 8235 %
Chris@10 8236 % Hang the footnote text off the number. Use \everypar in case the
Chris@10 8237 % footnote extends for more than one paragraph.
Chris@10 8238 \everypar = {\hang}%
Chris@10 8239 \textindent{\thisfootno}%
Chris@10 8240 %
Chris@10 8241 % Don't crash into the line above the footnote text. Since this
Chris@10 8242 % expands into a box, it must come within the paragraph, lest it
Chris@10 8243 % provide a place where TeX can split the footnote.
Chris@10 8244 \footstrut
Chris@10 8245 %
Chris@10 8246 % Invoke rest of plain TeX footnote routine.
Chris@10 8247 \futurelet\next\fo@t
Chris@10 8248 }
Chris@10 8249 }%end \catcode `\@=11
Chris@10 8250
Chris@10 8251 % In case a @footnote appears in a vbox, save the footnote text and create
Chris@10 8252 % the real \insert just after the vbox finished. Otherwise, the insertion
Chris@10 8253 % would be lost.
Chris@10 8254 % Similarly, if a @footnote appears inside an alignment, save the footnote
Chris@10 8255 % text to a box and make the \insert when a row of the table is finished.
Chris@10 8256 % And the same can be done for other insert classes. --kasal, 16nov03.
Chris@10 8257
Chris@10 8258 % Replace the \insert primitive by a cheating macro.
Chris@10 8259 % Deeper inside, just make sure that the saved insertions are not spilled
Chris@10 8260 % out prematurely.
Chris@10 8261 %
Chris@10 8262 \def\startsavinginserts{%
Chris@10 8263 \ifx \insert\ptexinsert
Chris@10 8264 \let\insert\saveinsert
Chris@10 8265 \else
Chris@10 8266 \let\checkinserts\relax
Chris@10 8267 \fi
Chris@10 8268 }
Chris@10 8269
Chris@10 8270 % This \insert replacement works for both \insert\footins{foo} and
Chris@10 8271 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
Chris@10 8272 %
Chris@10 8273 \def\saveinsert#1{%
Chris@10 8274 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
Chris@10 8275 \afterassignment\next
Chris@10 8276 % swallow the left brace
Chris@10 8277 \let\temp =
Chris@10 8278 }
Chris@10 8279 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
Chris@10 8280 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
Chris@10 8281
Chris@10 8282 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
Chris@10 8283
Chris@10 8284 \def\placesaveins#1{%
Chris@10 8285 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
Chris@10 8286 {\box#1}%
Chris@10 8287 }
Chris@10 8288
Chris@10 8289 % eat @SAVE -- beware, all of them have catcode \other:
Chris@10 8290 {
Chris@10 8291 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
Chris@10 8292 \gdef\gobblesave @SAVE{}
Chris@10 8293 }
Chris@10 8294
Chris@10 8295 % initialization:
Chris@10 8296 \def\newsaveins #1{%
Chris@10 8297 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
Chris@10 8298 \next
Chris@10 8299 }
Chris@10 8300 \def\newsaveinsX #1{%
Chris@10 8301 \csname newbox\endcsname #1%
Chris@10 8302 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
Chris@10 8303 \checksaveins #1}%
Chris@10 8304 }
Chris@10 8305
Chris@10 8306 % initialize:
Chris@10 8307 \let\checkinserts\empty
Chris@10 8308 \newsaveins\footins
Chris@10 8309 \newsaveins\margin
Chris@10 8310
Chris@10 8311
Chris@10 8312 % @image. We use the macros from epsf.tex to support this.
Chris@10 8313 % If epsf.tex is not installed and @image is used, we complain.
Chris@10 8314 %
Chris@10 8315 % Check for and read epsf.tex up front. If we read it only at @image
Chris@10 8316 % time, we might be inside a group, and then its definitions would get
Chris@10 8317 % undone and the next image would fail.
Chris@10 8318 \openin 1 = epsf.tex
Chris@10 8319 \ifeof 1 \else
Chris@10 8320 % Do not bother showing banner with epsf.tex v2.7k (available in
Chris@10 8321 % doc/epsf.tex and on ctan).
Chris@10 8322 \def\epsfannounce{\toks0 = }%
Chris@10 8323 \input epsf.tex
Chris@10 8324 \fi
Chris@10 8325 \closein 1
Chris@10 8326 %
Chris@10 8327 % We will only complain once about lack of epsf.tex.
Chris@10 8328 \newif\ifwarnednoepsf
Chris@10 8329 \newhelp\noepsfhelp{epsf.tex must be installed for images to
Chris@10 8330 work. It is also included in the Texinfo distribution, or you can get
Chris@10 8331 it from ftp://tug.org/tex/epsf.tex.}
Chris@10 8332 %
Chris@10 8333 \def\image#1{%
Chris@10 8334 \ifx\epsfbox\thisisundefined
Chris@10 8335 \ifwarnednoepsf \else
Chris@10 8336 \errhelp = \noepsfhelp
Chris@10 8337 \errmessage{epsf.tex not found, images will be ignored}%
Chris@10 8338 \global\warnednoepsftrue
Chris@10 8339 \fi
Chris@10 8340 \else
Chris@10 8341 \imagexxx #1,,,,,\finish
Chris@10 8342 \fi
Chris@10 8343 }
Chris@10 8344 %
Chris@10 8345 % Arguments to @image:
Chris@10 8346 % #1 is (mandatory) image filename; we tack on .eps extension.
Chris@10 8347 % #2 is (optional) width, #3 is (optional) height.
Chris@10 8348 % #4 is (ignored optional) html alt text.
Chris@10 8349 % #5 is (ignored optional) extension.
Chris@10 8350 % #6 is just the usual extra ignored arg for parsing stuff.
Chris@10 8351 \newif\ifimagevmode
Chris@10 8352 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
Chris@10 8353 \catcode`\^^M = 5 % in case we're inside an example
Chris@10 8354 \normalturnoffactive % allow _ et al. in names
Chris@10 8355 % If the image is by itself, center it.
Chris@10 8356 \ifvmode
Chris@10 8357 \imagevmodetrue
Chris@10 8358 \else \ifx\centersub\centerV
Chris@10 8359 % for @center @image, we need a vbox so we can have our vertical space
Chris@10 8360 \imagevmodetrue
Chris@10 8361 \vbox\bgroup % vbox has better behavior than vtop herev
Chris@10 8362 \fi\fi
Chris@10 8363 %
Chris@10 8364 \ifimagevmode
Chris@10 8365 \nobreak\medskip
Chris@10 8366 % Usually we'll have text after the image which will insert
Chris@10 8367 % \parskip glue, so insert it here too to equalize the space
Chris@10 8368 % above and below.
Chris@10 8369 \nobreak\vskip\parskip
Chris@10 8370 \nobreak
Chris@10 8371 \fi
Chris@10 8372 %
Chris@10 8373 % Leave vertical mode so that indentation from an enclosing
Chris@10 8374 % environment such as @quotation is respected.
Chris@10 8375 % However, if we're at the top level, we don't want the
Chris@10 8376 % normal paragraph indentation.
Chris@10 8377 % On the other hand, if we are in the case of @center @image, we don't
Chris@10 8378 % want to start a paragraph, which will create a hsize-width box and
Chris@10 8379 % eradicate the centering.
Chris@10 8380 \ifx\centersub\centerV\else \noindent \fi
Chris@10 8381 %
Chris@10 8382 % Output the image.
Chris@10 8383 \ifpdf
Chris@10 8384 \dopdfimage{#1}{#2}{#3}%
Chris@10 8385 \else
Chris@10 8386 % \epsfbox itself resets \epsf?size at each figure.
Chris@10 8387 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
Chris@10 8388 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
Chris@10 8389 \epsfbox{#1.eps}%
Chris@10 8390 \fi
Chris@10 8391 %
Chris@10 8392 \ifimagevmode
Chris@10 8393 \medskip % space after a standalone image
Chris@10 8394 \fi
Chris@10 8395 \ifx\centersub\centerV \egroup \fi
Chris@10 8396 \endgroup}
Chris@10 8397
Chris@10 8398
Chris@10 8399 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
Chris@10 8400 % etc. We don't actually implement floating yet, we always include the
Chris@10 8401 % float "here". But it seemed the best name for the future.
Chris@10 8402 %
Chris@10 8403 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
Chris@10 8404
Chris@10 8405 % There may be a space before second and/or third parameter; delete it.
Chris@10 8406 \def\eatcommaspace#1, {#1,}
Chris@10 8407
Chris@10 8408 % #1 is the optional FLOATTYPE, the text label for this float, typically
Chris@10 8409 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
Chris@10 8410 % this float will not be numbered and cannot be referred to.
Chris@10 8411 %
Chris@10 8412 % #2 is the optional xref label. Also must be present for the float to
Chris@10 8413 % be referable.
Chris@10 8414 %
Chris@10 8415 % #3 is the optional positioning argument; for now, it is ignored. It
Chris@10 8416 % will somehow specify the positions allowed to float to (here, top, bottom).
Chris@10 8417 %
Chris@10 8418 % We keep a separate counter for each FLOATTYPE, which we reset at each
Chris@10 8419 % chapter-level command.
Chris@10 8420 \let\resetallfloatnos=\empty
Chris@10 8421 %
Chris@10 8422 \def\dofloat#1,#2,#3,#4\finish{%
Chris@10 8423 \let\thiscaption=\empty
Chris@10 8424 \let\thisshortcaption=\empty
Chris@10 8425 %
Chris@10 8426 % don't lose footnotes inside @float.
Chris@10 8427 %
Chris@10 8428 % BEWARE: when the floats start float, we have to issue warning whenever an
Chris@10 8429 % insert appears inside a float which could possibly float. --kasal, 26may04
Chris@10 8430 %
Chris@10 8431 \startsavinginserts
Chris@10 8432 %
Chris@10 8433 % We can't be used inside a paragraph.
Chris@10 8434 \par
Chris@10 8435 %
Chris@10 8436 \vtop\bgroup
Chris@10 8437 \def\floattype{#1}%
Chris@10 8438 \def\floatlabel{#2}%
Chris@10 8439 \def\floatloc{#3}% we do nothing with this yet.
Chris@10 8440 %
Chris@10 8441 \ifx\floattype\empty
Chris@10 8442 \let\safefloattype=\empty
Chris@10 8443 \else
Chris@10 8444 {%
Chris@10 8445 % the floattype might have accents or other special characters,
Chris@10 8446 % but we need to use it in a control sequence name.
Chris@10 8447 \indexnofonts
Chris@10 8448 \turnoffactive
Chris@10 8449 \xdef\safefloattype{\floattype}%
Chris@10 8450 }%
Chris@10 8451 \fi
Chris@10 8452 %
Chris@10 8453 % If label is given but no type, we handle that as the empty type.
Chris@10 8454 \ifx\floatlabel\empty \else
Chris@10 8455 % We want each FLOATTYPE to be numbered separately (Figure 1,
Chris@10 8456 % Table 1, Figure 2, ...). (And if no label, no number.)
Chris@10 8457 %
Chris@10 8458 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
Chris@10 8459 \global\advance\floatno by 1
Chris@10 8460 %
Chris@10 8461 {%
Chris@10 8462 % This magic value for \lastsection is output by \setref as the
Chris@10 8463 % XREFLABEL-title value. \xrefX uses it to distinguish float
Chris@10 8464 % labels (which have a completely different output format) from
Chris@10 8465 % node and anchor labels. And \xrdef uses it to construct the
Chris@10 8466 % lists of floats.
Chris@10 8467 %
Chris@10 8468 \edef\lastsection{\floatmagic=\safefloattype}%
Chris@10 8469 \setref{\floatlabel}{Yfloat}%
Chris@10 8470 }%
Chris@10 8471 \fi
Chris@10 8472 %
Chris@10 8473 % start with \parskip glue, I guess.
Chris@10 8474 \vskip\parskip
Chris@10 8475 %
Chris@10 8476 % Don't suppress indentation if a float happens to start a section.
Chris@10 8477 \restorefirstparagraphindent
Chris@10 8478 }
Chris@10 8479
Chris@10 8480 % we have these possibilities:
Chris@10 8481 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
Chris@10 8482 % @float Foo,lbl & no caption: Foo 1.1
Chris@10 8483 % @float Foo & @caption{Cap}: Foo: Cap
Chris@10 8484 % @float Foo & no caption: Foo
Chris@10 8485 % @float ,lbl & Caption{Cap}: 1.1: Cap
Chris@10 8486 % @float ,lbl & no caption: 1.1
Chris@10 8487 % @float & @caption{Cap}: Cap
Chris@10 8488 % @float & no caption:
Chris@10 8489 %
Chris@10 8490 \def\Efloat{%
Chris@10 8491 \let\floatident = \empty
Chris@10 8492 %
Chris@10 8493 % In all cases, if we have a float type, it comes first.
Chris@10 8494 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
Chris@10 8495 %
Chris@10 8496 % If we have an xref label, the number comes next.
Chris@10 8497 \ifx\floatlabel\empty \else
Chris@10 8498 \ifx\floattype\empty \else % if also had float type, need tie first.
Chris@10 8499 \appendtomacro\floatident{\tie}%
Chris@10 8500 \fi
Chris@10 8501 % the number.
Chris@10 8502 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
Chris@10 8503 \fi
Chris@10 8504 %
Chris@10 8505 % Start the printed caption with what we've constructed in
Chris@10 8506 % \floatident, but keep it separate; we need \floatident again.
Chris@10 8507 \let\captionline = \floatident
Chris@10 8508 %
Chris@10 8509 \ifx\thiscaption\empty \else
Chris@10 8510 \ifx\floatident\empty \else
Chris@10 8511 \appendtomacro\captionline{: }% had ident, so need a colon between
Chris@10 8512 \fi
Chris@10 8513 %
Chris@10 8514 % caption text.
Chris@10 8515 \appendtomacro\captionline{\scanexp\thiscaption}%
Chris@10 8516 \fi
Chris@10 8517 %
Chris@10 8518 % If we have anything to print, print it, with space before.
Chris@10 8519 % Eventually this needs to become an \insert.
Chris@10 8520 \ifx\captionline\empty \else
Chris@10 8521 \vskip.5\parskip
Chris@10 8522 \captionline
Chris@10 8523 %
Chris@10 8524 % Space below caption.
Chris@10 8525 \vskip\parskip
Chris@10 8526 \fi
Chris@10 8527 %
Chris@10 8528 % If have an xref label, write the list of floats info. Do this
Chris@10 8529 % after the caption, to avoid chance of it being a breakpoint.
Chris@10 8530 \ifx\floatlabel\empty \else
Chris@10 8531 % Write the text that goes in the lof to the aux file as
Chris@10 8532 % \floatlabel-lof. Besides \floatident, we include the short
Chris@10 8533 % caption if specified, else the full caption if specified, else nothing.
Chris@10 8534 {%
Chris@10 8535 \atdummies
Chris@10 8536 %
Chris@10 8537 % since we read the caption text in the macro world, where ^^M
Chris@10 8538 % is turned into a normal character, we have to scan it back, so
Chris@10 8539 % we don't write the literal three characters "^^M" into the aux file.
Chris@10 8540 \scanexp{%
Chris@10 8541 \xdef\noexpand\gtemp{%
Chris@10 8542 \ifx\thisshortcaption\empty
Chris@10 8543 \thiscaption
Chris@10 8544 \else
Chris@10 8545 \thisshortcaption
Chris@10 8546 \fi
Chris@10 8547 }%
Chris@10 8548 }%
Chris@10 8549 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
Chris@10 8550 \ifx\gtemp\empty \else : \gtemp \fi}}%
Chris@10 8551 }%
Chris@10 8552 \fi
Chris@10 8553 \egroup % end of \vtop
Chris@10 8554 %
Chris@10 8555 % place the captured inserts
Chris@10 8556 %
Chris@10 8557 % BEWARE: when the floats start floating, we have to issue warning
Chris@10 8558 % whenever an insert appears inside a float which could possibly
Chris@10 8559 % float. --kasal, 26may04
Chris@10 8560 %
Chris@10 8561 \checkinserts
Chris@10 8562 }
Chris@10 8563
Chris@10 8564 % Append the tokens #2 to the definition of macro #1, not expanding either.
Chris@10 8565 %
Chris@10 8566 \def\appendtomacro#1#2{%
Chris@10 8567 \expandafter\def\expandafter#1\expandafter{#1#2}%
Chris@10 8568 }
Chris@10 8569
Chris@10 8570 % @caption, @shortcaption
Chris@10 8571 %
Chris@10 8572 \def\caption{\docaption\thiscaption}
Chris@10 8573 \def\shortcaption{\docaption\thisshortcaption}
Chris@10 8574 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
Chris@10 8575 \def\defcaption#1#2{\egroup \def#1{#2}}
Chris@10 8576
Chris@10 8577 % The parameter is the control sequence identifying the counter we are
Chris@10 8578 % going to use. Create it if it doesn't exist and assign it to \floatno.
Chris@10 8579 \def\getfloatno#1{%
Chris@10 8580 \ifx#1\relax
Chris@10 8581 % Haven't seen this figure type before.
Chris@10 8582 \csname newcount\endcsname #1%
Chris@10 8583 %
Chris@10 8584 % Remember to reset this floatno at the next chap.
Chris@10 8585 \expandafter\gdef\expandafter\resetallfloatnos
Chris@10 8586 \expandafter{\resetallfloatnos #1=0 }%
Chris@10 8587 \fi
Chris@10 8588 \let\floatno#1%
Chris@10 8589 }
Chris@10 8590
Chris@10 8591 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
Chris@10 8592 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
Chris@10 8593 % first read the @float command.
Chris@10 8594 %
Chris@10 8595 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
Chris@10 8596
Chris@10 8597 % Magic string used for the XREFLABEL-title value, so \xrefX can
Chris@10 8598 % distinguish floats from other xref types.
Chris@10 8599 \def\floatmagic{!!float!!}
Chris@10 8600
Chris@10 8601 % #1 is the control sequence we are passed; we expand into a conditional
Chris@10 8602 % which is true if #1 represents a float ref. That is, the magic
Chris@10 8603 % \lastsection value which we \setref above.
Chris@10 8604 %
Chris@10 8605 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
Chris@10 8606 %
Chris@10 8607 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
Chris@10 8608 % (safe) float type for this float. We set \iffloattype to #2.
Chris@10 8609 %
Chris@10 8610 \def\doiffloat#1=#2=#3\finish{%
Chris@10 8611 \def\temp{#1}%
Chris@10 8612 \def\iffloattype{#2}%
Chris@10 8613 \ifx\temp\floatmagic
Chris@10 8614 }
Chris@10 8615
Chris@10 8616 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
Chris@10 8617 %
Chris@10 8618 \parseargdef\listoffloats{%
Chris@10 8619 \def\floattype{#1}% floattype
Chris@10 8620 {%
Chris@10 8621 % the floattype might have accents or other special characters,
Chris@10 8622 % but we need to use it in a control sequence name.
Chris@10 8623 \indexnofonts
Chris@10 8624 \turnoffactive
Chris@10 8625 \xdef\safefloattype{\floattype}%
Chris@10 8626 }%
Chris@10 8627 %
Chris@10 8628 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
Chris@10 8629 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
Chris@10 8630 \ifhavexrefs
Chris@10 8631 % if the user said @listoffloats foo but never @float foo.
Chris@10 8632 \message{\linenumber No `\safefloattype' floats to list.}%
Chris@10 8633 \fi
Chris@10 8634 \else
Chris@10 8635 \begingroup
Chris@10 8636 \leftskip=\tocindent % indent these entries like a toc
Chris@10 8637 \let\do=\listoffloatsdo
Chris@10 8638 \csname floatlist\safefloattype\endcsname
Chris@10 8639 \endgroup
Chris@10 8640 \fi
Chris@10 8641 }
Chris@10 8642
Chris@10 8643 % This is called on each entry in a list of floats. We're passed the
Chris@10 8644 % xref label, in the form LABEL-title, which is how we save it in the
Chris@10 8645 % aux file. We strip off the -title and look up \XRLABEL-lof, which
Chris@10 8646 % has the text we're supposed to typeset here.
Chris@10 8647 %
Chris@10 8648 % Figures without xref labels will not be included in the list (since
Chris@10 8649 % they won't appear in the aux file).
Chris@10 8650 %
Chris@10 8651 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
Chris@10 8652 \def\listoffloatsdoentry#1-title\finish{{%
Chris@10 8653 % Can't fully expand XR#1-lof because it can contain anything. Just
Chris@10 8654 % pass the control sequence. On the other hand, XR#1-pg is just the
Chris@10 8655 % page number, and we want to fully expand that so we can get a link
Chris@10 8656 % in pdf output.
Chris@10 8657 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
Chris@10 8658 %
Chris@10 8659 % use the same \entry macro we use to generate the TOC and index.
Chris@10 8660 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
Chris@10 8661 \writeentry
Chris@10 8662 }}
Chris@10 8663
Chris@10 8664
Chris@10 8665 \message{localization,}
Chris@10 8666
Chris@10 8667 % For single-language documents, @documentlanguage is usually given very
Chris@10 8668 % early, just after @documentencoding. Single argument is the language
Chris@10 8669 % (de) or locale (de_DE) abbreviation.
Chris@10 8670 %
Chris@10 8671 {
Chris@10 8672 \catcode`\_ = \active
Chris@10 8673 \globaldefs=1
Chris@10 8674 \parseargdef\documentlanguage{\begingroup
Chris@10 8675 \let_=\normalunderscore % normal _ character for filenames
Chris@10 8676 \tex % read txi-??.tex file in plain TeX.
Chris@10 8677 % Read the file by the name they passed if it exists.
Chris@10 8678 \openin 1 txi-#1.tex
Chris@10 8679 \ifeof 1
Chris@10 8680 \documentlanguagetrywithoutunderscore{#1_\finish}%
Chris@10 8681 \else
Chris@10 8682 \globaldefs = 1 % everything in the txi-LL files needs to persist
Chris@10 8683 \input txi-#1.tex
Chris@10 8684 \fi
Chris@10 8685 \closein 1
Chris@10 8686 \endgroup % end raw TeX
Chris@10 8687 \endgroup}
Chris@10 8688 %
Chris@10 8689 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
Chris@10 8690 % try txi-de.tex.
Chris@10 8691 %
Chris@10 8692 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
Chris@10 8693 \openin 1 txi-#1.tex
Chris@10 8694 \ifeof 1
Chris@10 8695 \errhelp = \nolanghelp
Chris@10 8696 \errmessage{Cannot read language file txi-#1.tex}%
Chris@10 8697 \else
Chris@10 8698 \globaldefs = 1 % everything in the txi-LL files needs to persist
Chris@10 8699 \input txi-#1.tex
Chris@10 8700 \fi
Chris@10 8701 \closein 1
Chris@10 8702 }
Chris@10 8703 }% end of special _ catcode
Chris@10 8704 %
Chris@10 8705 \newhelp\nolanghelp{The given language definition file cannot be found or
Chris@10 8706 is empty. Maybe you need to install it? Putting it in the current
Chris@10 8707 directory should work if nowhere else does.}
Chris@10 8708
Chris@10 8709 % This macro is called from txi-??.tex files; the first argument is the
Chris@10 8710 % \language name to set (without the "\lang@" prefix), the second and
Chris@10 8711 % third args are \{left,right}hyphenmin.
Chris@10 8712 %
Chris@10 8713 % The language names to pass are determined when the format is built.
Chris@10 8714 % See the etex.log file created at that time, e.g.,
Chris@10 8715 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
Chris@10 8716 %
Chris@10 8717 % With TeX Live 2008, etex now includes hyphenation patterns for all
Chris@10 8718 % available languages. This means we can support hyphenation in
Chris@10 8719 % Texinfo, at least to some extent. (This still doesn't solve the
Chris@10 8720 % accented characters problem.)
Chris@10 8721 %
Chris@10 8722 \catcode`@=11
Chris@10 8723 \def\txisetlanguage#1#2#3{%
Chris@10 8724 % do not set the language if the name is undefined in the current TeX.
Chris@10 8725 \expandafter\ifx\csname lang@#1\endcsname \relax
Chris@10 8726 \message{no patterns for #1}%
Chris@10 8727 \else
Chris@10 8728 \global\language = \csname lang@#1\endcsname
Chris@10 8729 \fi
Chris@10 8730 % but there is no harm in adjusting the hyphenmin values regardless.
Chris@10 8731 \global\lefthyphenmin = #2\relax
Chris@10 8732 \global\righthyphenmin = #3\relax
Chris@10 8733 }
Chris@10 8734
Chris@10 8735 % Helpers for encodings.
Chris@10 8736 % Set the catcode of characters 128 through 255 to the specified number.
Chris@10 8737 %
Chris@10 8738 \def\setnonasciicharscatcode#1{%
Chris@10 8739 \count255=128
Chris@10 8740 \loop\ifnum\count255<256
Chris@10 8741 \global\catcode\count255=#1\relax
Chris@10 8742 \advance\count255 by 1
Chris@10 8743 \repeat
Chris@10 8744 }
Chris@10 8745
Chris@10 8746 \def\setnonasciicharscatcodenonglobal#1{%
Chris@10 8747 \count255=128
Chris@10 8748 \loop\ifnum\count255<256
Chris@10 8749 \catcode\count255=#1\relax
Chris@10 8750 \advance\count255 by 1
Chris@10 8751 \repeat
Chris@10 8752 }
Chris@10 8753
Chris@10 8754 % @documentencoding sets the definition of non-ASCII characters
Chris@10 8755 % according to the specified encoding.
Chris@10 8756 %
Chris@10 8757 \parseargdef\documentencoding{%
Chris@10 8758 % Encoding being declared for the document.
Chris@10 8759 \def\declaredencoding{\csname #1.enc\endcsname}%
Chris@10 8760 %
Chris@10 8761 % Supported encodings: names converted to tokens in order to be able
Chris@10 8762 % to compare them with \ifx.
Chris@10 8763 \def\ascii{\csname US-ASCII.enc\endcsname}%
Chris@10 8764 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
Chris@10 8765 \def\latone{\csname ISO-8859-1.enc\endcsname}%
Chris@10 8766 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
Chris@10 8767 \def\utfeight{\csname UTF-8.enc\endcsname}%
Chris@10 8768 %
Chris@10 8769 \ifx \declaredencoding \ascii
Chris@10 8770 \asciichardefs
Chris@10 8771 %
Chris@10 8772 \else \ifx \declaredencoding \lattwo
Chris@10 8773 \setnonasciicharscatcode\active
Chris@10 8774 \lattwochardefs
Chris@10 8775 %
Chris@10 8776 \else \ifx \declaredencoding \latone
Chris@10 8777 \setnonasciicharscatcode\active
Chris@10 8778 \latonechardefs
Chris@10 8779 %
Chris@10 8780 \else \ifx \declaredencoding \latnine
Chris@10 8781 \setnonasciicharscatcode\active
Chris@10 8782 \latninechardefs
Chris@10 8783 %
Chris@10 8784 \else \ifx \declaredencoding \utfeight
Chris@10 8785 \setnonasciicharscatcode\active
Chris@10 8786 \utfeightchardefs
Chris@10 8787 %
Chris@10 8788 \else
Chris@10 8789 \message{Unknown document encoding #1, ignoring.}%
Chris@10 8790 %
Chris@10 8791 \fi % utfeight
Chris@10 8792 \fi % latnine
Chris@10 8793 \fi % latone
Chris@10 8794 \fi % lattwo
Chris@10 8795 \fi % ascii
Chris@10 8796 }
Chris@10 8797
Chris@10 8798 % A message to be logged when using a character that isn't available
Chris@10 8799 % the default font encoding (OT1).
Chris@10 8800 %
Chris@10 8801 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
Chris@10 8802
Chris@10 8803 % Take account of \c (plain) vs. \, (Texinfo) difference.
Chris@10 8804 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
Chris@10 8805
Chris@10 8806 % First, make active non-ASCII characters in order for them to be
Chris@10 8807 % correctly categorized when TeX reads the replacement text of
Chris@10 8808 % macros containing the character definitions.
Chris@10 8809 \setnonasciicharscatcode\active
Chris@10 8810 %
Chris@10 8811 % Latin1 (ISO-8859-1) character definitions.
Chris@10 8812 \def\latonechardefs{%
Chris@10 8813 \gdef^^a0{\tie}
Chris@10 8814 \gdef^^a1{\exclamdown}
Chris@10 8815 \gdef^^a2{\missingcharmsg{CENT SIGN}}
Chris@10 8816 \gdef^^a3{{\pounds}}
Chris@10 8817 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
Chris@10 8818 \gdef^^a5{\missingcharmsg{YEN SIGN}}
Chris@10 8819 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
Chris@10 8820 \gdef^^a7{\S}
Chris@10 8821 \gdef^^a8{\"{}}
Chris@10 8822 \gdef^^a9{\copyright}
Chris@10 8823 \gdef^^aa{\ordf}
Chris@10 8824 \gdef^^ab{\guillemetleft}
Chris@10 8825 \gdef^^ac{$\lnot$}
Chris@10 8826 \gdef^^ad{\-}
Chris@10 8827 \gdef^^ae{\registeredsymbol}
Chris@10 8828 \gdef^^af{\={}}
Chris@10 8829 %
Chris@10 8830 \gdef^^b0{\textdegree}
Chris@10 8831 \gdef^^b1{$\pm$}
Chris@10 8832 \gdef^^b2{$^2$}
Chris@10 8833 \gdef^^b3{$^3$}
Chris@10 8834 \gdef^^b4{\'{}}
Chris@10 8835 \gdef^^b5{$\mu$}
Chris@10 8836 \gdef^^b6{\P}
Chris@10 8837 %
Chris@10 8838 \gdef^^b7{$^.$}
Chris@10 8839 \gdef^^b8{\cedilla\ }
Chris@10 8840 \gdef^^b9{$^1$}
Chris@10 8841 \gdef^^ba{\ordm}
Chris@10 8842 %
Chris@10 8843 \gdef^^bb{\guillemetright}
Chris@10 8844 \gdef^^bc{$1\over4$}
Chris@10 8845 \gdef^^bd{$1\over2$}
Chris@10 8846 \gdef^^be{$3\over4$}
Chris@10 8847 \gdef^^bf{\questiondown}
Chris@10 8848 %
Chris@10 8849 \gdef^^c0{\`A}
Chris@10 8850 \gdef^^c1{\'A}
Chris@10 8851 \gdef^^c2{\^A}
Chris@10 8852 \gdef^^c3{\~A}
Chris@10 8853 \gdef^^c4{\"A}
Chris@10 8854 \gdef^^c5{\ringaccent A}
Chris@10 8855 \gdef^^c6{\AE}
Chris@10 8856 \gdef^^c7{\cedilla C}
Chris@10 8857 \gdef^^c8{\`E}
Chris@10 8858 \gdef^^c9{\'E}
Chris@10 8859 \gdef^^ca{\^E}
Chris@10 8860 \gdef^^cb{\"E}
Chris@10 8861 \gdef^^cc{\`I}
Chris@10 8862 \gdef^^cd{\'I}
Chris@10 8863 \gdef^^ce{\^I}
Chris@10 8864 \gdef^^cf{\"I}
Chris@10 8865 %
Chris@10 8866 \gdef^^d0{\DH}
Chris@10 8867 \gdef^^d1{\~N}
Chris@10 8868 \gdef^^d2{\`O}
Chris@10 8869 \gdef^^d3{\'O}
Chris@10 8870 \gdef^^d4{\^O}
Chris@10 8871 \gdef^^d5{\~O}
Chris@10 8872 \gdef^^d6{\"O}
Chris@10 8873 \gdef^^d7{$\times$}
Chris@10 8874 \gdef^^d8{\O}
Chris@10 8875 \gdef^^d9{\`U}
Chris@10 8876 \gdef^^da{\'U}
Chris@10 8877 \gdef^^db{\^U}
Chris@10 8878 \gdef^^dc{\"U}
Chris@10 8879 \gdef^^dd{\'Y}
Chris@10 8880 \gdef^^de{\TH}
Chris@10 8881 \gdef^^df{\ss}
Chris@10 8882 %
Chris@10 8883 \gdef^^e0{\`a}
Chris@10 8884 \gdef^^e1{\'a}
Chris@10 8885 \gdef^^e2{\^a}
Chris@10 8886 \gdef^^e3{\~a}
Chris@10 8887 \gdef^^e4{\"a}
Chris@10 8888 \gdef^^e5{\ringaccent a}
Chris@10 8889 \gdef^^e6{\ae}
Chris@10 8890 \gdef^^e7{\cedilla c}
Chris@10 8891 \gdef^^e8{\`e}
Chris@10 8892 \gdef^^e9{\'e}
Chris@10 8893 \gdef^^ea{\^e}
Chris@10 8894 \gdef^^eb{\"e}
Chris@10 8895 \gdef^^ec{\`{\dotless i}}
Chris@10 8896 \gdef^^ed{\'{\dotless i}}
Chris@10 8897 \gdef^^ee{\^{\dotless i}}
Chris@10 8898 \gdef^^ef{\"{\dotless i}}
Chris@10 8899 %
Chris@10 8900 \gdef^^f0{\dh}
Chris@10 8901 \gdef^^f1{\~n}
Chris@10 8902 \gdef^^f2{\`o}
Chris@10 8903 \gdef^^f3{\'o}
Chris@10 8904 \gdef^^f4{\^o}
Chris@10 8905 \gdef^^f5{\~o}
Chris@10 8906 \gdef^^f6{\"o}
Chris@10 8907 \gdef^^f7{$\div$}
Chris@10 8908 \gdef^^f8{\o}
Chris@10 8909 \gdef^^f9{\`u}
Chris@10 8910 \gdef^^fa{\'u}
Chris@10 8911 \gdef^^fb{\^u}
Chris@10 8912 \gdef^^fc{\"u}
Chris@10 8913 \gdef^^fd{\'y}
Chris@10 8914 \gdef^^fe{\th}
Chris@10 8915 \gdef^^ff{\"y}
Chris@10 8916 }
Chris@10 8917
Chris@10 8918 % Latin9 (ISO-8859-15) encoding character definitions.
Chris@10 8919 \def\latninechardefs{%
Chris@10 8920 % Encoding is almost identical to Latin1.
Chris@10 8921 \latonechardefs
Chris@10 8922 %
Chris@10 8923 \gdef^^a4{\euro}
Chris@10 8924 \gdef^^a6{\v S}
Chris@10 8925 \gdef^^a8{\v s}
Chris@10 8926 \gdef^^b4{\v Z}
Chris@10 8927 \gdef^^b8{\v z}
Chris@10 8928 \gdef^^bc{\OE}
Chris@10 8929 \gdef^^bd{\oe}
Chris@10 8930 \gdef^^be{\"Y}
Chris@10 8931 }
Chris@10 8932
Chris@10 8933 % Latin2 (ISO-8859-2) character definitions.
Chris@10 8934 \def\lattwochardefs{%
Chris@10 8935 \gdef^^a0{\tie}
Chris@10 8936 \gdef^^a1{\ogonek{A}}
Chris@10 8937 \gdef^^a2{\u{}}
Chris@10 8938 \gdef^^a3{\L}
Chris@10 8939 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
Chris@10 8940 \gdef^^a5{\v L}
Chris@10 8941 \gdef^^a6{\'S}
Chris@10 8942 \gdef^^a7{\S}
Chris@10 8943 \gdef^^a8{\"{}}
Chris@10 8944 \gdef^^a9{\v S}
Chris@10 8945 \gdef^^aa{\cedilla S}
Chris@10 8946 \gdef^^ab{\v T}
Chris@10 8947 \gdef^^ac{\'Z}
Chris@10 8948 \gdef^^ad{\-}
Chris@10 8949 \gdef^^ae{\v Z}
Chris@10 8950 \gdef^^af{\dotaccent Z}
Chris@10 8951 %
Chris@10 8952 \gdef^^b0{\textdegree}
Chris@10 8953 \gdef^^b1{\ogonek{a}}
Chris@10 8954 \gdef^^b2{\ogonek{ }}
Chris@10 8955 \gdef^^b3{\l}
Chris@10 8956 \gdef^^b4{\'{}}
Chris@10 8957 \gdef^^b5{\v l}
Chris@10 8958 \gdef^^b6{\'s}
Chris@10 8959 \gdef^^b7{\v{}}
Chris@10 8960 \gdef^^b8{\cedilla\ }
Chris@10 8961 \gdef^^b9{\v s}
Chris@10 8962 \gdef^^ba{\cedilla s}
Chris@10 8963 \gdef^^bb{\v t}
Chris@10 8964 \gdef^^bc{\'z}
Chris@10 8965 \gdef^^bd{\H{}}
Chris@10 8966 \gdef^^be{\v z}
Chris@10 8967 \gdef^^bf{\dotaccent z}
Chris@10 8968 %
Chris@10 8969 \gdef^^c0{\'R}
Chris@10 8970 \gdef^^c1{\'A}
Chris@10 8971 \gdef^^c2{\^A}
Chris@10 8972 \gdef^^c3{\u A}
Chris@10 8973 \gdef^^c4{\"A}
Chris@10 8974 \gdef^^c5{\'L}
Chris@10 8975 \gdef^^c6{\'C}
Chris@10 8976 \gdef^^c7{\cedilla C}
Chris@10 8977 \gdef^^c8{\v C}
Chris@10 8978 \gdef^^c9{\'E}
Chris@10 8979 \gdef^^ca{\ogonek{E}}
Chris@10 8980 \gdef^^cb{\"E}
Chris@10 8981 \gdef^^cc{\v E}
Chris@10 8982 \gdef^^cd{\'I}
Chris@10 8983 \gdef^^ce{\^I}
Chris@10 8984 \gdef^^cf{\v D}
Chris@10 8985 %
Chris@10 8986 \gdef^^d0{\DH}
Chris@10 8987 \gdef^^d1{\'N}
Chris@10 8988 \gdef^^d2{\v N}
Chris@10 8989 \gdef^^d3{\'O}
Chris@10 8990 \gdef^^d4{\^O}
Chris@10 8991 \gdef^^d5{\H O}
Chris@10 8992 \gdef^^d6{\"O}
Chris@10 8993 \gdef^^d7{$\times$}
Chris@10 8994 \gdef^^d8{\v R}
Chris@10 8995 \gdef^^d9{\ringaccent U}
Chris@10 8996 \gdef^^da{\'U}
Chris@10 8997 \gdef^^db{\H U}
Chris@10 8998 \gdef^^dc{\"U}
Chris@10 8999 \gdef^^dd{\'Y}
Chris@10 9000 \gdef^^de{\cedilla T}
Chris@10 9001 \gdef^^df{\ss}
Chris@10 9002 %
Chris@10 9003 \gdef^^e0{\'r}
Chris@10 9004 \gdef^^e1{\'a}
Chris@10 9005 \gdef^^e2{\^a}
Chris@10 9006 \gdef^^e3{\u a}
Chris@10 9007 \gdef^^e4{\"a}
Chris@10 9008 \gdef^^e5{\'l}
Chris@10 9009 \gdef^^e6{\'c}
Chris@10 9010 \gdef^^e7{\cedilla c}
Chris@10 9011 \gdef^^e8{\v c}
Chris@10 9012 \gdef^^e9{\'e}
Chris@10 9013 \gdef^^ea{\ogonek{e}}
Chris@10 9014 \gdef^^eb{\"e}
Chris@10 9015 \gdef^^ec{\v e}
Chris@10 9016 \gdef^^ed{\'{\dotless{i}}}
Chris@10 9017 \gdef^^ee{\^{\dotless{i}}}
Chris@10 9018 \gdef^^ef{\v d}
Chris@10 9019 %
Chris@10 9020 \gdef^^f0{\dh}
Chris@10 9021 \gdef^^f1{\'n}
Chris@10 9022 \gdef^^f2{\v n}
Chris@10 9023 \gdef^^f3{\'o}
Chris@10 9024 \gdef^^f4{\^o}
Chris@10 9025 \gdef^^f5{\H o}
Chris@10 9026 \gdef^^f6{\"o}
Chris@10 9027 \gdef^^f7{$\div$}
Chris@10 9028 \gdef^^f8{\v r}
Chris@10 9029 \gdef^^f9{\ringaccent u}
Chris@10 9030 \gdef^^fa{\'u}
Chris@10 9031 \gdef^^fb{\H u}
Chris@10 9032 \gdef^^fc{\"u}
Chris@10 9033 \gdef^^fd{\'y}
Chris@10 9034 \gdef^^fe{\cedilla t}
Chris@10 9035 \gdef^^ff{\dotaccent{}}
Chris@10 9036 }
Chris@10 9037
Chris@10 9038 % UTF-8 character definitions.
Chris@10 9039 %
Chris@10 9040 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
Chris@10 9041 % changes for Texinfo conventions. It is included here under the GPL by
Chris@10 9042 % permission from Frank Mittelbach and the LaTeX team.
Chris@10 9043 %
Chris@10 9044 \newcount\countUTFx
Chris@10 9045 \newcount\countUTFy
Chris@10 9046 \newcount\countUTFz
Chris@10 9047
Chris@10 9048 \gdef\UTFviiiTwoOctets#1#2{\expandafter
Chris@10 9049 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
Chris@10 9050 %
Chris@10 9051 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
Chris@10 9052 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
Chris@10 9053 %
Chris@10 9054 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
Chris@10 9055 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
Chris@10 9056
Chris@10 9057 \gdef\UTFviiiDefined#1{%
Chris@10 9058 \ifx #1\relax
Chris@10 9059 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
Chris@10 9060 \else
Chris@10 9061 \expandafter #1%
Chris@10 9062 \fi
Chris@10 9063 }
Chris@10 9064
Chris@10 9065 \begingroup
Chris@10 9066 \catcode`\~13
Chris@10 9067 \catcode`\"12
Chris@10 9068
Chris@10 9069 \def\UTFviiiLoop{%
Chris@10 9070 \global\catcode\countUTFx\active
Chris@10 9071 \uccode`\~\countUTFx
Chris@10 9072 \uppercase\expandafter{\UTFviiiTmp}%
Chris@10 9073 \advance\countUTFx by 1
Chris@10 9074 \ifnum\countUTFx < \countUTFy
Chris@10 9075 \expandafter\UTFviiiLoop
Chris@10 9076 \fi}
Chris@10 9077
Chris@10 9078 \countUTFx = "C2
Chris@10 9079 \countUTFy = "E0
Chris@10 9080 \def\UTFviiiTmp{%
Chris@10 9081 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
Chris@10 9082 \UTFviiiLoop
Chris@10 9083
Chris@10 9084 \countUTFx = "E0
Chris@10 9085 \countUTFy = "F0
Chris@10 9086 \def\UTFviiiTmp{%
Chris@10 9087 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
Chris@10 9088 \UTFviiiLoop
Chris@10 9089
Chris@10 9090 \countUTFx = "F0
Chris@10 9091 \countUTFy = "F4
Chris@10 9092 \def\UTFviiiTmp{%
Chris@10 9093 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
Chris@10 9094 \UTFviiiLoop
Chris@10 9095 \endgroup
Chris@10 9096
Chris@10 9097 \begingroup
Chris@10 9098 \catcode`\"=12
Chris@10 9099 \catcode`\<=12
Chris@10 9100 \catcode`\.=12
Chris@10 9101 \catcode`\,=12
Chris@10 9102 \catcode`\;=12
Chris@10 9103 \catcode`\!=12
Chris@10 9104 \catcode`\~=13
Chris@10 9105
Chris@10 9106 \gdef\DeclareUnicodeCharacter#1#2{%
Chris@10 9107 \countUTFz = "#1\relax
Chris@10 9108 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
Chris@10 9109 \begingroup
Chris@10 9110 \parseXMLCharref
Chris@10 9111 \def\UTFviiiTwoOctets##1##2{%
Chris@10 9112 \csname u8:##1\string ##2\endcsname}%
Chris@10 9113 \def\UTFviiiThreeOctets##1##2##3{%
Chris@10 9114 \csname u8:##1\string ##2\string ##3\endcsname}%
Chris@10 9115 \def\UTFviiiFourOctets##1##2##3##4{%
Chris@10 9116 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
Chris@10 9117 \expandafter\expandafter\expandafter\expandafter
Chris@10 9118 \expandafter\expandafter\expandafter
Chris@10 9119 \gdef\UTFviiiTmp{#2}%
Chris@10 9120 \endgroup}
Chris@10 9121
Chris@10 9122 \gdef\parseXMLCharref{%
Chris@10 9123 \ifnum\countUTFz < "A0\relax
Chris@10 9124 \errhelp = \EMsimple
Chris@10 9125 \errmessage{Cannot define Unicode char value < 00A0}%
Chris@10 9126 \else\ifnum\countUTFz < "800\relax
Chris@10 9127 \parseUTFviiiA,%
Chris@10 9128 \parseUTFviiiB C\UTFviiiTwoOctets.,%
Chris@10 9129 \else\ifnum\countUTFz < "10000\relax
Chris@10 9130 \parseUTFviiiA;%
Chris@10 9131 \parseUTFviiiA,%
Chris@10 9132 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
Chris@10 9133 \else
Chris@10 9134 \parseUTFviiiA;%
Chris@10 9135 \parseUTFviiiA,%
Chris@10 9136 \parseUTFviiiA!%
Chris@10 9137 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
Chris@10 9138 \fi\fi\fi
Chris@10 9139 }
Chris@10 9140
Chris@10 9141 \gdef\parseUTFviiiA#1{%
Chris@10 9142 \countUTFx = \countUTFz
Chris@10 9143 \divide\countUTFz by 64
Chris@10 9144 \countUTFy = \countUTFz
Chris@10 9145 \multiply\countUTFz by 64
Chris@10 9146 \advance\countUTFx by -\countUTFz
Chris@10 9147 \advance\countUTFx by 128
Chris@10 9148 \uccode `#1\countUTFx
Chris@10 9149 \countUTFz = \countUTFy}
Chris@10 9150
Chris@10 9151 \gdef\parseUTFviiiB#1#2#3#4{%
Chris@10 9152 \advance\countUTFz by "#10\relax
Chris@10 9153 \uccode `#3\countUTFz
Chris@10 9154 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
Chris@10 9155 \endgroup
Chris@10 9156
Chris@10 9157 \def\utfeightchardefs{%
Chris@10 9158 \DeclareUnicodeCharacter{00A0}{\tie}
Chris@10 9159 \DeclareUnicodeCharacter{00A1}{\exclamdown}
Chris@10 9160 \DeclareUnicodeCharacter{00A3}{\pounds}
Chris@10 9161 \DeclareUnicodeCharacter{00A8}{\"{ }}
Chris@10 9162 \DeclareUnicodeCharacter{00A9}{\copyright}
Chris@10 9163 \DeclareUnicodeCharacter{00AA}{\ordf}
Chris@10 9164 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
Chris@10 9165 \DeclareUnicodeCharacter{00AD}{\-}
Chris@10 9166 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
Chris@10 9167 \DeclareUnicodeCharacter{00AF}{\={ }}
Chris@10 9168
Chris@10 9169 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
Chris@10 9170 \DeclareUnicodeCharacter{00B4}{\'{ }}
Chris@10 9171 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
Chris@10 9172 \DeclareUnicodeCharacter{00BA}{\ordm}
Chris@10 9173 \DeclareUnicodeCharacter{00BB}{\guillemetright}
Chris@10 9174 \DeclareUnicodeCharacter{00BF}{\questiondown}
Chris@10 9175
Chris@10 9176 \DeclareUnicodeCharacter{00C0}{\`A}
Chris@10 9177 \DeclareUnicodeCharacter{00C1}{\'A}
Chris@10 9178 \DeclareUnicodeCharacter{00C2}{\^A}
Chris@10 9179 \DeclareUnicodeCharacter{00C3}{\~A}
Chris@10 9180 \DeclareUnicodeCharacter{00C4}{\"A}
Chris@10 9181 \DeclareUnicodeCharacter{00C5}{\AA}
Chris@10 9182 \DeclareUnicodeCharacter{00C6}{\AE}
Chris@10 9183 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
Chris@10 9184 \DeclareUnicodeCharacter{00C8}{\`E}
Chris@10 9185 \DeclareUnicodeCharacter{00C9}{\'E}
Chris@10 9186 \DeclareUnicodeCharacter{00CA}{\^E}
Chris@10 9187 \DeclareUnicodeCharacter{00CB}{\"E}
Chris@10 9188 \DeclareUnicodeCharacter{00CC}{\`I}
Chris@10 9189 \DeclareUnicodeCharacter{00CD}{\'I}
Chris@10 9190 \DeclareUnicodeCharacter{00CE}{\^I}
Chris@10 9191 \DeclareUnicodeCharacter{00CF}{\"I}
Chris@10 9192
Chris@10 9193 \DeclareUnicodeCharacter{00D0}{\DH}
Chris@10 9194 \DeclareUnicodeCharacter{00D1}{\~N}
Chris@10 9195 \DeclareUnicodeCharacter{00D2}{\`O}
Chris@10 9196 \DeclareUnicodeCharacter{00D3}{\'O}
Chris@10 9197 \DeclareUnicodeCharacter{00D4}{\^O}
Chris@10 9198 \DeclareUnicodeCharacter{00D5}{\~O}
Chris@10 9199 \DeclareUnicodeCharacter{00D6}{\"O}
Chris@10 9200 \DeclareUnicodeCharacter{00D8}{\O}
Chris@10 9201 \DeclareUnicodeCharacter{00D9}{\`U}
Chris@10 9202 \DeclareUnicodeCharacter{00DA}{\'U}
Chris@10 9203 \DeclareUnicodeCharacter{00DB}{\^U}
Chris@10 9204 \DeclareUnicodeCharacter{00DC}{\"U}
Chris@10 9205 \DeclareUnicodeCharacter{00DD}{\'Y}
Chris@10 9206 \DeclareUnicodeCharacter{00DE}{\TH}
Chris@10 9207 \DeclareUnicodeCharacter{00DF}{\ss}
Chris@10 9208
Chris@10 9209 \DeclareUnicodeCharacter{00E0}{\`a}
Chris@10 9210 \DeclareUnicodeCharacter{00E1}{\'a}
Chris@10 9211 \DeclareUnicodeCharacter{00E2}{\^a}
Chris@10 9212 \DeclareUnicodeCharacter{00E3}{\~a}
Chris@10 9213 \DeclareUnicodeCharacter{00E4}{\"a}
Chris@10 9214 \DeclareUnicodeCharacter{00E5}{\aa}
Chris@10 9215 \DeclareUnicodeCharacter{00E6}{\ae}
Chris@10 9216 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
Chris@10 9217 \DeclareUnicodeCharacter{00E8}{\`e}
Chris@10 9218 \DeclareUnicodeCharacter{00E9}{\'e}
Chris@10 9219 \DeclareUnicodeCharacter{00EA}{\^e}
Chris@10 9220 \DeclareUnicodeCharacter{00EB}{\"e}
Chris@10 9221 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
Chris@10 9222 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
Chris@10 9223 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
Chris@10 9224 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
Chris@10 9225
Chris@10 9226 \DeclareUnicodeCharacter{00F0}{\dh}
Chris@10 9227 \DeclareUnicodeCharacter{00F1}{\~n}
Chris@10 9228 \DeclareUnicodeCharacter{00F2}{\`o}
Chris@10 9229 \DeclareUnicodeCharacter{00F3}{\'o}
Chris@10 9230 \DeclareUnicodeCharacter{00F4}{\^o}
Chris@10 9231 \DeclareUnicodeCharacter{00F5}{\~o}
Chris@10 9232 \DeclareUnicodeCharacter{00F6}{\"o}
Chris@10 9233 \DeclareUnicodeCharacter{00F8}{\o}
Chris@10 9234 \DeclareUnicodeCharacter{00F9}{\`u}
Chris@10 9235 \DeclareUnicodeCharacter{00FA}{\'u}
Chris@10 9236 \DeclareUnicodeCharacter{00FB}{\^u}
Chris@10 9237 \DeclareUnicodeCharacter{00FC}{\"u}
Chris@10 9238 \DeclareUnicodeCharacter{00FD}{\'y}
Chris@10 9239 \DeclareUnicodeCharacter{00FE}{\th}
Chris@10 9240 \DeclareUnicodeCharacter{00FF}{\"y}
Chris@10 9241
Chris@10 9242 \DeclareUnicodeCharacter{0100}{\=A}
Chris@10 9243 \DeclareUnicodeCharacter{0101}{\=a}
Chris@10 9244 \DeclareUnicodeCharacter{0102}{\u{A}}
Chris@10 9245 \DeclareUnicodeCharacter{0103}{\u{a}}
Chris@10 9246 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
Chris@10 9247 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
Chris@10 9248 \DeclareUnicodeCharacter{0106}{\'C}
Chris@10 9249 \DeclareUnicodeCharacter{0107}{\'c}
Chris@10 9250 \DeclareUnicodeCharacter{0108}{\^C}
Chris@10 9251 \DeclareUnicodeCharacter{0109}{\^c}
Chris@10 9252 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
Chris@10 9253 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
Chris@10 9254 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
Chris@10 9255 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
Chris@10 9256 \DeclareUnicodeCharacter{010C}{\v{C}}
Chris@10 9257 \DeclareUnicodeCharacter{010D}{\v{c}}
Chris@10 9258 \DeclareUnicodeCharacter{010E}{\v{D}}
Chris@10 9259
Chris@10 9260 \DeclareUnicodeCharacter{0112}{\=E}
Chris@10 9261 \DeclareUnicodeCharacter{0113}{\=e}
Chris@10 9262 \DeclareUnicodeCharacter{0114}{\u{E}}
Chris@10 9263 \DeclareUnicodeCharacter{0115}{\u{e}}
Chris@10 9264 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
Chris@10 9265 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
Chris@10 9266 \DeclareUnicodeCharacter{011A}{\v{E}}
Chris@10 9267 \DeclareUnicodeCharacter{011B}{\v{e}}
Chris@10 9268 \DeclareUnicodeCharacter{011C}{\^G}
Chris@10 9269 \DeclareUnicodeCharacter{011D}{\^g}
Chris@10 9270 \DeclareUnicodeCharacter{011E}{\u{G}}
Chris@10 9271 \DeclareUnicodeCharacter{011F}{\u{g}}
Chris@10 9272
Chris@10 9273 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
Chris@10 9274 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
Chris@10 9275 \DeclareUnicodeCharacter{0124}{\^H}
Chris@10 9276 \DeclareUnicodeCharacter{0125}{\^h}
Chris@10 9277 \DeclareUnicodeCharacter{0128}{\~I}
Chris@10 9278 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
Chris@10 9279 \DeclareUnicodeCharacter{012A}{\=I}
Chris@10 9280 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
Chris@10 9281 \DeclareUnicodeCharacter{012C}{\u{I}}
Chris@10 9282 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
Chris@10 9283
Chris@10 9284 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
Chris@10 9285 \DeclareUnicodeCharacter{0131}{\dotless{i}}
Chris@10 9286 \DeclareUnicodeCharacter{0132}{IJ}
Chris@10 9287 \DeclareUnicodeCharacter{0133}{ij}
Chris@10 9288 \DeclareUnicodeCharacter{0134}{\^J}
Chris@10 9289 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
Chris@10 9290 \DeclareUnicodeCharacter{0139}{\'L}
Chris@10 9291 \DeclareUnicodeCharacter{013A}{\'l}
Chris@10 9292
Chris@10 9293 \DeclareUnicodeCharacter{0141}{\L}
Chris@10 9294 \DeclareUnicodeCharacter{0142}{\l}
Chris@10 9295 \DeclareUnicodeCharacter{0143}{\'N}
Chris@10 9296 \DeclareUnicodeCharacter{0144}{\'n}
Chris@10 9297 \DeclareUnicodeCharacter{0147}{\v{N}}
Chris@10 9298 \DeclareUnicodeCharacter{0148}{\v{n}}
Chris@10 9299 \DeclareUnicodeCharacter{014C}{\=O}
Chris@10 9300 \DeclareUnicodeCharacter{014D}{\=o}
Chris@10 9301 \DeclareUnicodeCharacter{014E}{\u{O}}
Chris@10 9302 \DeclareUnicodeCharacter{014F}{\u{o}}
Chris@10 9303
Chris@10 9304 \DeclareUnicodeCharacter{0150}{\H{O}}
Chris@10 9305 \DeclareUnicodeCharacter{0151}{\H{o}}
Chris@10 9306 \DeclareUnicodeCharacter{0152}{\OE}
Chris@10 9307 \DeclareUnicodeCharacter{0153}{\oe}
Chris@10 9308 \DeclareUnicodeCharacter{0154}{\'R}
Chris@10 9309 \DeclareUnicodeCharacter{0155}{\'r}
Chris@10 9310 \DeclareUnicodeCharacter{0158}{\v{R}}
Chris@10 9311 \DeclareUnicodeCharacter{0159}{\v{r}}
Chris@10 9312 \DeclareUnicodeCharacter{015A}{\'S}
Chris@10 9313 \DeclareUnicodeCharacter{015B}{\'s}
Chris@10 9314 \DeclareUnicodeCharacter{015C}{\^S}
Chris@10 9315 \DeclareUnicodeCharacter{015D}{\^s}
Chris@10 9316 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
Chris@10 9317 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
Chris@10 9318
Chris@10 9319 \DeclareUnicodeCharacter{0160}{\v{S}}
Chris@10 9320 \DeclareUnicodeCharacter{0161}{\v{s}}
Chris@10 9321 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
Chris@10 9322 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
Chris@10 9323 \DeclareUnicodeCharacter{0164}{\v{T}}
Chris@10 9324
Chris@10 9325 \DeclareUnicodeCharacter{0168}{\~U}
Chris@10 9326 \DeclareUnicodeCharacter{0169}{\~u}
Chris@10 9327 \DeclareUnicodeCharacter{016A}{\=U}
Chris@10 9328 \DeclareUnicodeCharacter{016B}{\=u}
Chris@10 9329 \DeclareUnicodeCharacter{016C}{\u{U}}
Chris@10 9330 \DeclareUnicodeCharacter{016D}{\u{u}}
Chris@10 9331 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
Chris@10 9332 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
Chris@10 9333
Chris@10 9334 \DeclareUnicodeCharacter{0170}{\H{U}}
Chris@10 9335 \DeclareUnicodeCharacter{0171}{\H{u}}
Chris@10 9336 \DeclareUnicodeCharacter{0174}{\^W}
Chris@10 9337 \DeclareUnicodeCharacter{0175}{\^w}
Chris@10 9338 \DeclareUnicodeCharacter{0176}{\^Y}
Chris@10 9339 \DeclareUnicodeCharacter{0177}{\^y}
Chris@10 9340 \DeclareUnicodeCharacter{0178}{\"Y}
Chris@10 9341 \DeclareUnicodeCharacter{0179}{\'Z}
Chris@10 9342 \DeclareUnicodeCharacter{017A}{\'z}
Chris@10 9343 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
Chris@10 9344 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
Chris@10 9345 \DeclareUnicodeCharacter{017D}{\v{Z}}
Chris@10 9346 \DeclareUnicodeCharacter{017E}{\v{z}}
Chris@10 9347
Chris@10 9348 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
Chris@10 9349 \DeclareUnicodeCharacter{01C5}{D\v{z}}
Chris@10 9350 \DeclareUnicodeCharacter{01C6}{d\v{z}}
Chris@10 9351 \DeclareUnicodeCharacter{01C7}{LJ}
Chris@10 9352 \DeclareUnicodeCharacter{01C8}{Lj}
Chris@10 9353 \DeclareUnicodeCharacter{01C9}{lj}
Chris@10 9354 \DeclareUnicodeCharacter{01CA}{NJ}
Chris@10 9355 \DeclareUnicodeCharacter{01CB}{Nj}
Chris@10 9356 \DeclareUnicodeCharacter{01CC}{nj}
Chris@10 9357 \DeclareUnicodeCharacter{01CD}{\v{A}}
Chris@10 9358 \DeclareUnicodeCharacter{01CE}{\v{a}}
Chris@10 9359 \DeclareUnicodeCharacter{01CF}{\v{I}}
Chris@10 9360
Chris@10 9361 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
Chris@10 9362 \DeclareUnicodeCharacter{01D1}{\v{O}}
Chris@10 9363 \DeclareUnicodeCharacter{01D2}{\v{o}}
Chris@10 9364 \DeclareUnicodeCharacter{01D3}{\v{U}}
Chris@10 9365 \DeclareUnicodeCharacter{01D4}{\v{u}}
Chris@10 9366
Chris@10 9367 \DeclareUnicodeCharacter{01E2}{\={\AE}}
Chris@10 9368 \DeclareUnicodeCharacter{01E3}{\={\ae}}
Chris@10 9369 \DeclareUnicodeCharacter{01E6}{\v{G}}
Chris@10 9370 \DeclareUnicodeCharacter{01E7}{\v{g}}
Chris@10 9371 \DeclareUnicodeCharacter{01E8}{\v{K}}
Chris@10 9372 \DeclareUnicodeCharacter{01E9}{\v{k}}
Chris@10 9373
Chris@10 9374 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
Chris@10 9375 \DeclareUnicodeCharacter{01F1}{DZ}
Chris@10 9376 \DeclareUnicodeCharacter{01F2}{Dz}
Chris@10 9377 \DeclareUnicodeCharacter{01F3}{dz}
Chris@10 9378 \DeclareUnicodeCharacter{01F4}{\'G}
Chris@10 9379 \DeclareUnicodeCharacter{01F5}{\'g}
Chris@10 9380 \DeclareUnicodeCharacter{01F8}{\`N}
Chris@10 9381 \DeclareUnicodeCharacter{01F9}{\`n}
Chris@10 9382 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
Chris@10 9383 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
Chris@10 9384 \DeclareUnicodeCharacter{01FE}{\'{\O}}
Chris@10 9385 \DeclareUnicodeCharacter{01FF}{\'{\o}}
Chris@10 9386
Chris@10 9387 \DeclareUnicodeCharacter{021E}{\v{H}}
Chris@10 9388 \DeclareUnicodeCharacter{021F}{\v{h}}
Chris@10 9389
Chris@10 9390 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
Chris@10 9391 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
Chris@10 9392 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
Chris@10 9393 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
Chris@10 9394 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
Chris@10 9395 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
Chris@10 9396
Chris@10 9397 \DeclareUnicodeCharacter{0232}{\=Y}
Chris@10 9398 \DeclareUnicodeCharacter{0233}{\=y}
Chris@10 9399 \DeclareUnicodeCharacter{0237}{\dotless{j}}
Chris@10 9400
Chris@10 9401 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
Chris@10 9402
Chris@10 9403 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
Chris@10 9404 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
Chris@10 9405 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
Chris@10 9406 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
Chris@10 9407 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
Chris@10 9408 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
Chris@10 9409 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
Chris@10 9410 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
Chris@10 9411 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
Chris@10 9412 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
Chris@10 9413 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
Chris@10 9414 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
Chris@10 9415
Chris@10 9416 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
Chris@10 9417 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
Chris@10 9418
Chris@10 9419 \DeclareUnicodeCharacter{1E20}{\=G}
Chris@10 9420 \DeclareUnicodeCharacter{1E21}{\=g}
Chris@10 9421 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
Chris@10 9422 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
Chris@10 9423 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
Chris@10 9424 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
Chris@10 9425 \DeclareUnicodeCharacter{1E26}{\"H}
Chris@10 9426 \DeclareUnicodeCharacter{1E27}{\"h}
Chris@10 9427
Chris@10 9428 \DeclareUnicodeCharacter{1E30}{\'K}
Chris@10 9429 \DeclareUnicodeCharacter{1E31}{\'k}
Chris@10 9430 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
Chris@10 9431 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
Chris@10 9432 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
Chris@10 9433 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
Chris@10 9434 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
Chris@10 9435 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
Chris@10 9436 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
Chris@10 9437 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
Chris@10 9438 \DeclareUnicodeCharacter{1E3E}{\'M}
Chris@10 9439 \DeclareUnicodeCharacter{1E3F}{\'m}
Chris@10 9440
Chris@10 9441 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
Chris@10 9442 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
Chris@10 9443 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
Chris@10 9444 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
Chris@10 9445 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
Chris@10 9446 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
Chris@10 9447 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
Chris@10 9448 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
Chris@10 9449 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
Chris@10 9450 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
Chris@10 9451
Chris@10 9452 \DeclareUnicodeCharacter{1E54}{\'P}
Chris@10 9453 \DeclareUnicodeCharacter{1E55}{\'p}
Chris@10 9454 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
Chris@10 9455 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
Chris@10 9456 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
Chris@10 9457 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
Chris@10 9458 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
Chris@10 9459 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
Chris@10 9460 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
Chris@10 9461 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
Chris@10 9462
Chris@10 9463 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
Chris@10 9464 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
Chris@10 9465 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
Chris@10 9466 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
Chris@10 9467 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
Chris@10 9468 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
Chris@10 9469 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
Chris@10 9470 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
Chris@10 9471 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
Chris@10 9472 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
Chris@10 9473
Chris@10 9474 \DeclareUnicodeCharacter{1E7C}{\~V}
Chris@10 9475 \DeclareUnicodeCharacter{1E7D}{\~v}
Chris@10 9476 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
Chris@10 9477 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
Chris@10 9478
Chris@10 9479 \DeclareUnicodeCharacter{1E80}{\`W}
Chris@10 9480 \DeclareUnicodeCharacter{1E81}{\`w}
Chris@10 9481 \DeclareUnicodeCharacter{1E82}{\'W}
Chris@10 9482 \DeclareUnicodeCharacter{1E83}{\'w}
Chris@10 9483 \DeclareUnicodeCharacter{1E84}{\"W}
Chris@10 9484 \DeclareUnicodeCharacter{1E85}{\"w}
Chris@10 9485 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
Chris@10 9486 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
Chris@10 9487 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
Chris@10 9488 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
Chris@10 9489 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
Chris@10 9490 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
Chris@10 9491 \DeclareUnicodeCharacter{1E8C}{\"X}
Chris@10 9492 \DeclareUnicodeCharacter{1E8D}{\"x}
Chris@10 9493 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
Chris@10 9494 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
Chris@10 9495
Chris@10 9496 \DeclareUnicodeCharacter{1E90}{\^Z}
Chris@10 9497 \DeclareUnicodeCharacter{1E91}{\^z}
Chris@10 9498 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
Chris@10 9499 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
Chris@10 9500 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
Chris@10 9501 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
Chris@10 9502 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
Chris@10 9503 \DeclareUnicodeCharacter{1E97}{\"t}
Chris@10 9504 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
Chris@10 9505 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
Chris@10 9506
Chris@10 9507 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
Chris@10 9508 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
Chris@10 9509
Chris@10 9510 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
Chris@10 9511 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
Chris@10 9512 \DeclareUnicodeCharacter{1EBC}{\~E}
Chris@10 9513 \DeclareUnicodeCharacter{1EBD}{\~e}
Chris@10 9514
Chris@10 9515 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
Chris@10 9516 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
Chris@10 9517 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
Chris@10 9518 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
Chris@10 9519
Chris@10 9520 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
Chris@10 9521 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
Chris@10 9522
Chris@10 9523 \DeclareUnicodeCharacter{1EF2}{\`Y}
Chris@10 9524 \DeclareUnicodeCharacter{1EF3}{\`y}
Chris@10 9525 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
Chris@10 9526
Chris@10 9527 \DeclareUnicodeCharacter{1EF8}{\~Y}
Chris@10 9528 \DeclareUnicodeCharacter{1EF9}{\~y}
Chris@10 9529
Chris@10 9530 \DeclareUnicodeCharacter{2013}{--}
Chris@10 9531 \DeclareUnicodeCharacter{2014}{---}
Chris@10 9532 \DeclareUnicodeCharacter{2018}{\quoteleft}
Chris@10 9533 \DeclareUnicodeCharacter{2019}{\quoteright}
Chris@10 9534 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
Chris@10 9535 \DeclareUnicodeCharacter{201C}{\quotedblleft}
Chris@10 9536 \DeclareUnicodeCharacter{201D}{\quotedblright}
Chris@10 9537 \DeclareUnicodeCharacter{201E}{\quotedblbase}
Chris@10 9538 \DeclareUnicodeCharacter{2022}{\bullet}
Chris@10 9539 \DeclareUnicodeCharacter{2026}{\dots}
Chris@10 9540 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
Chris@10 9541 \DeclareUnicodeCharacter{203A}{\guilsinglright}
Chris@10 9542 \DeclareUnicodeCharacter{20AC}{\euro}
Chris@10 9543
Chris@10 9544 \DeclareUnicodeCharacter{2192}{\expansion}
Chris@10 9545 \DeclareUnicodeCharacter{21D2}{\result}
Chris@10 9546
Chris@10 9547 \DeclareUnicodeCharacter{2212}{\minus}
Chris@10 9548 \DeclareUnicodeCharacter{2217}{\point}
Chris@10 9549 \DeclareUnicodeCharacter{2261}{\equiv}
Chris@10 9550 }% end of \utfeightchardefs
Chris@10 9551
Chris@10 9552
Chris@10 9553 % US-ASCII character definitions.
Chris@10 9554 \def\asciichardefs{% nothing need be done
Chris@10 9555 \relax
Chris@10 9556 }
Chris@10 9557
Chris@10 9558 % Make non-ASCII characters printable again for compatibility with
Chris@10 9559 % existing Texinfo documents that may use them, even without declaring a
Chris@10 9560 % document encoding.
Chris@10 9561 %
Chris@10 9562 \setnonasciicharscatcode \other
Chris@10 9563
Chris@10 9564
Chris@10 9565 \message{formatting,}
Chris@10 9566
Chris@10 9567 \newdimen\defaultparindent \defaultparindent = 15pt
Chris@10 9568
Chris@10 9569 \chapheadingskip = 15pt plus 4pt minus 2pt
Chris@10 9570 \secheadingskip = 12pt plus 3pt minus 2pt
Chris@10 9571 \subsecheadingskip = 9pt plus 2pt minus 2pt
Chris@10 9572
Chris@10 9573 % Prevent underfull vbox error messages.
Chris@10 9574 \vbadness = 10000
Chris@10 9575
Chris@10 9576 % Don't be very finicky about underfull hboxes, either.
Chris@10 9577 \hbadness = 6666
Chris@10 9578
Chris@10 9579 % Following George Bush, get rid of widows and orphans.
Chris@10 9580 \widowpenalty=10000
Chris@10 9581 \clubpenalty=10000
Chris@10 9582
Chris@10 9583 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
Chris@10 9584 % using an old version of TeX, don't do anything. We want the amount of
Chris@10 9585 % stretch added to depend on the line length, hence the dependence on
Chris@10 9586 % \hsize. We call this whenever the paper size is set.
Chris@10 9587 %
Chris@10 9588 \def\setemergencystretch{%
Chris@10 9589 \ifx\emergencystretch\thisisundefined
Chris@10 9590 % Allow us to assign to \emergencystretch anyway.
Chris@10 9591 \def\emergencystretch{\dimen0}%
Chris@10 9592 \else
Chris@10 9593 \emergencystretch = .15\hsize
Chris@10 9594 \fi
Chris@10 9595 }
Chris@10 9596
Chris@10 9597 % Parameters in order: 1) textheight; 2) textwidth;
Chris@10 9598 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
Chris@10 9599 % 7) physical page height; 8) physical page width.
Chris@10 9600 %
Chris@10 9601 % We also call \setleading{\textleading}, so the caller should define
Chris@10 9602 % \textleading. The caller should also set \parskip.
Chris@10 9603 %
Chris@10 9604 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
Chris@10 9605 \voffset = #3\relax
Chris@10 9606 \topskip = #6\relax
Chris@10 9607 \splittopskip = \topskip
Chris@10 9608 %
Chris@10 9609 \vsize = #1\relax
Chris@10 9610 \advance\vsize by \topskip
Chris@10 9611 \outervsize = \vsize
Chris@10 9612 \advance\outervsize by 2\topandbottommargin
Chris@10 9613 \pageheight = \vsize
Chris@10 9614 %
Chris@10 9615 \hsize = #2\relax
Chris@10 9616 \outerhsize = \hsize
Chris@10 9617 \advance\outerhsize by 0.5in
Chris@10 9618 \pagewidth = \hsize
Chris@10 9619 %
Chris@10 9620 \normaloffset = #4\relax
Chris@10 9621 \bindingoffset = #5\relax
Chris@10 9622 %
Chris@10 9623 \ifpdf
Chris@10 9624 \pdfpageheight #7\relax
Chris@10 9625 \pdfpagewidth #8\relax
Chris@10 9626 % if we don't reset these, they will remain at "1 true in" of
Chris@10 9627 % whatever layout pdftex was dumped with.
Chris@10 9628 \pdfhorigin = 1 true in
Chris@10 9629 \pdfvorigin = 1 true in
Chris@10 9630 \fi
Chris@10 9631 %
Chris@10 9632 \setleading{\textleading}
Chris@10 9633 %
Chris@10 9634 \parindent = \defaultparindent
Chris@10 9635 \setemergencystretch
Chris@10 9636 }
Chris@10 9637
Chris@10 9638 % @letterpaper (the default).
Chris@10 9639 \def\letterpaper{{\globaldefs = 1
Chris@10 9640 \parskip = 3pt plus 2pt minus 1pt
Chris@10 9641 \textleading = 13.2pt
Chris@10 9642 %
Chris@10 9643 % If page is nothing but text, make it come out even.
Chris@10 9644 \internalpagesizes{607.2pt}{6in}% that's 46 lines
Chris@10 9645 {\voffset}{.25in}%
Chris@10 9646 {\bindingoffset}{36pt}%
Chris@10 9647 {11in}{8.5in}%
Chris@10 9648 }}
Chris@10 9649
Chris@10 9650 % Use @smallbook to reset parameters for 7x9.25 trim size.
Chris@10 9651 \def\smallbook{{\globaldefs = 1
Chris@10 9652 \parskip = 2pt plus 1pt
Chris@10 9653 \textleading = 12pt
Chris@10 9654 %
Chris@10 9655 \internalpagesizes{7.5in}{5in}%
Chris@10 9656 {-.2in}{0in}%
Chris@10 9657 {\bindingoffset}{16pt}%
Chris@10 9658 {9.25in}{7in}%
Chris@10 9659 %
Chris@10 9660 \lispnarrowing = 0.3in
Chris@10 9661 \tolerance = 700
Chris@10 9662 \hfuzz = 1pt
Chris@10 9663 \contentsrightmargin = 0pt
Chris@10 9664 \defbodyindent = .5cm
Chris@10 9665 }}
Chris@10 9666
Chris@10 9667 % Use @smallerbook to reset parameters for 6x9 trim size.
Chris@10 9668 % (Just testing, parameters still in flux.)
Chris@10 9669 \def\smallerbook{{\globaldefs = 1
Chris@10 9670 \parskip = 1.5pt plus 1pt
Chris@10 9671 \textleading = 12pt
Chris@10 9672 %
Chris@10 9673 \internalpagesizes{7.4in}{4.8in}%
Chris@10 9674 {-.2in}{-.4in}%
Chris@10 9675 {0pt}{14pt}%
Chris@10 9676 {9in}{6in}%
Chris@10 9677 %
Chris@10 9678 \lispnarrowing = 0.25in
Chris@10 9679 \tolerance = 700
Chris@10 9680 \hfuzz = 1pt
Chris@10 9681 \contentsrightmargin = 0pt
Chris@10 9682 \defbodyindent = .4cm
Chris@10 9683 }}
Chris@10 9684
Chris@10 9685 % Use @afourpaper to print on European A4 paper.
Chris@10 9686 \def\afourpaper{{\globaldefs = 1
Chris@10 9687 \parskip = 3pt plus 2pt minus 1pt
Chris@10 9688 \textleading = 13.2pt
Chris@10 9689 %
Chris@10 9690 % Double-side printing via postscript on Laserjet 4050
Chris@10 9691 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
Chris@10 9692 % To change the settings for a different printer or situation, adjust
Chris@10 9693 % \normaloffset until the front-side and back-side texts align. Then
Chris@10 9694 % do the same for \bindingoffset. You can set these for testing in
Chris@10 9695 % your texinfo source file like this:
Chris@10 9696 % @tex
Chris@10 9697 % \global\normaloffset = -6mm
Chris@10 9698 % \global\bindingoffset = 10mm
Chris@10 9699 % @end tex
Chris@10 9700 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
Chris@10 9701 {\voffset}{\hoffset}%
Chris@10 9702 {\bindingoffset}{44pt}%
Chris@10 9703 {297mm}{210mm}%
Chris@10 9704 %
Chris@10 9705 \tolerance = 700
Chris@10 9706 \hfuzz = 1pt
Chris@10 9707 \contentsrightmargin = 0pt
Chris@10 9708 \defbodyindent = 5mm
Chris@10 9709 }}
Chris@10 9710
Chris@10 9711 % Use @afivepaper to print on European A5 paper.
Chris@10 9712 % From romildo@urano.iceb.ufop.br, 2 July 2000.
Chris@10 9713 % He also recommends making @example and @lisp be small.
Chris@10 9714 \def\afivepaper{{\globaldefs = 1
Chris@10 9715 \parskip = 2pt plus 1pt minus 0.1pt
Chris@10 9716 \textleading = 12.5pt
Chris@10 9717 %
Chris@10 9718 \internalpagesizes{160mm}{120mm}%
Chris@10 9719 {\voffset}{\hoffset}%
Chris@10 9720 {\bindingoffset}{8pt}%
Chris@10 9721 {210mm}{148mm}%
Chris@10 9722 %
Chris@10 9723 \lispnarrowing = 0.2in
Chris@10 9724 \tolerance = 800
Chris@10 9725 \hfuzz = 1.2pt
Chris@10 9726 \contentsrightmargin = 0pt
Chris@10 9727 \defbodyindent = 2mm
Chris@10 9728 \tableindent = 12mm
Chris@10 9729 }}
Chris@10 9730
Chris@10 9731 % A specific text layout, 24x15cm overall, intended for A4 paper.
Chris@10 9732 \def\afourlatex{{\globaldefs = 1
Chris@10 9733 \afourpaper
Chris@10 9734 \internalpagesizes{237mm}{150mm}%
Chris@10 9735 {\voffset}{4.6mm}%
Chris@10 9736 {\bindingoffset}{7mm}%
Chris@10 9737 {297mm}{210mm}%
Chris@10 9738 %
Chris@10 9739 % Must explicitly reset to 0 because we call \afourpaper.
Chris@10 9740 \globaldefs = 0
Chris@10 9741 }}
Chris@10 9742
Chris@10 9743 % Use @afourwide to print on A4 paper in landscape format.
Chris@10 9744 \def\afourwide{{\globaldefs = 1
Chris@10 9745 \afourpaper
Chris@10 9746 \internalpagesizes{241mm}{165mm}%
Chris@10 9747 {\voffset}{-2.95mm}%
Chris@10 9748 {\bindingoffset}{7mm}%
Chris@10 9749 {297mm}{210mm}%
Chris@10 9750 \globaldefs = 0
Chris@10 9751 }}
Chris@10 9752
Chris@10 9753 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
Chris@10 9754 % Perhaps we should allow setting the margins, \topskip, \parskip,
Chris@10 9755 % and/or leading, also. Or perhaps we should compute them somehow.
Chris@10 9756 %
Chris@10 9757 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
Chris@10 9758 \def\pagesizesyyy#1,#2,#3\finish{{%
Chris@10 9759 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
Chris@10 9760 \globaldefs = 1
Chris@10 9761 %
Chris@10 9762 \parskip = 3pt plus 2pt minus 1pt
Chris@10 9763 \setleading{\textleading}%
Chris@10 9764 %
Chris@10 9765 \dimen0 = #1\relax
Chris@10 9766 \advance\dimen0 by \voffset
Chris@10 9767 %
Chris@10 9768 \dimen2 = \hsize
Chris@10 9769 \advance\dimen2 by \normaloffset
Chris@10 9770 %
Chris@10 9771 \internalpagesizes{#1}{\hsize}%
Chris@10 9772 {\voffset}{\normaloffset}%
Chris@10 9773 {\bindingoffset}{44pt}%
Chris@10 9774 {\dimen0}{\dimen2}%
Chris@10 9775 }}
Chris@10 9776
Chris@10 9777 % Set default to letter.
Chris@10 9778 %
Chris@10 9779 \letterpaper
Chris@10 9780
Chris@10 9781
Chris@10 9782 \message{and turning on texinfo input format.}
Chris@10 9783
Chris@10 9784 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
Chris@10 9785
Chris@10 9786 % DEL is a comment character, in case @c does not suffice.
Chris@10 9787 \catcode`\^^? = 14
Chris@10 9788
Chris@10 9789 % Define macros to output various characters with catcode for normal text.
Chris@10 9790 \catcode`\"=\other \def\normaldoublequote{"}
Chris@10 9791 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
Chris@10 9792 \catcode`\+=\other \def\normalplus{+}
Chris@10 9793 \catcode`\<=\other \def\normalless{<}
Chris@10 9794 \catcode`\>=\other \def\normalgreater{>}
Chris@10 9795 \catcode`\^=\other \def\normalcaret{^}
Chris@10 9796 \catcode`\_=\other \def\normalunderscore{_}
Chris@10 9797 \catcode`\|=\other \def\normalverticalbar{|}
Chris@10 9798 \catcode`\~=\other \def\normaltilde{~}
Chris@10 9799
Chris@10 9800 % This macro is used to make a character print one way in \tt
Chris@10 9801 % (where it can probably be output as-is), and another way in other fonts,
Chris@10 9802 % where something hairier probably needs to be done.
Chris@10 9803 %
Chris@10 9804 % #1 is what to print if we are indeed using \tt; #2 is what to print
Chris@10 9805 % otherwise. Since all the Computer Modern typewriter fonts have zero
Chris@10 9806 % interword stretch (and shrink), and it is reasonable to expect all
Chris@10 9807 % typewriter fonts to have this, we can check that font parameter.
Chris@10 9808 %
Chris@10 9809 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
Chris@10 9810
Chris@10 9811 % Same as above, but check for italic font. Actually this also catches
Chris@10 9812 % non-italic slanted fonts since it is impossible to distinguish them from
Chris@10 9813 % italic fonts. But since this is only used by $ and it uses \sl anyway
Chris@10 9814 % this is not a problem.
Chris@10 9815 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
Chris@10 9816
Chris@10 9817 % Turn off all special characters except @
Chris@10 9818 % (and those which the user can use as if they were ordinary).
Chris@10 9819 % Most of these we simply print from the \tt font, but for some, we can
Chris@10 9820 % use math or other variants that look better in normal text.
Chris@10 9821
Chris@10 9822 \catcode`\"=\active
Chris@10 9823 \def\activedoublequote{{\tt\char34}}
Chris@10 9824 \let"=\activedoublequote
Chris@10 9825 \catcode`\~=\active
Chris@10 9826 \def~{{\tt\char126}}
Chris@10 9827 \chardef\hat=`\^
Chris@10 9828 \catcode`\^=\active
Chris@10 9829 \def^{{\tt \hat}}
Chris@10 9830
Chris@10 9831 \catcode`\_=\active
Chris@10 9832 \def_{\ifusingtt\normalunderscore\_}
Chris@10 9833 \let\realunder=_
Chris@10 9834 % Subroutine for the previous macro.
Chris@10 9835 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
Chris@10 9836
Chris@10 9837 \catcode`\|=\active
Chris@10 9838 \def|{{\tt\char124}}
Chris@10 9839 \chardef \less=`\<
Chris@10 9840 \catcode`\<=\active
Chris@10 9841 \def<{{\tt \less}}
Chris@10 9842 \chardef \gtr=`\>
Chris@10 9843 \catcode`\>=\active
Chris@10 9844 \def>{{\tt \gtr}}
Chris@10 9845 \catcode`\+=\active
Chris@10 9846 \def+{{\tt \char 43}}
Chris@10 9847 \catcode`\$=\active
Chris@10 9848 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
Chris@10 9849
Chris@10 9850 % If a .fmt file is being used, characters that might appear in a file
Chris@10 9851 % name cannot be active until we have parsed the command line.
Chris@10 9852 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
Chris@10 9853 % \otherifyactive is called near the end of this file.
Chris@10 9854 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
Chris@10 9855
Chris@10 9856 % Used sometimes to turn off (effectively) the active characters even after
Chris@10 9857 % parsing them.
Chris@10 9858 \def\turnoffactive{%
Chris@10 9859 \normalturnoffactive
Chris@10 9860 \otherbackslash
Chris@10 9861 }
Chris@10 9862
Chris@10 9863 \catcode`\@=0
Chris@10 9864
Chris@10 9865 % \backslashcurfont outputs one backslash character in current font,
Chris@10 9866 % as in \char`\\.
Chris@10 9867 \global\chardef\backslashcurfont=`\\
Chris@10 9868 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
Chris@10 9869
Chris@10 9870 % \realbackslash is an actual character `\' with catcode other, and
Chris@10 9871 % \doublebackslash is two of them (for the pdf outlines).
Chris@10 9872 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
Chris@10 9873
Chris@10 9874 % In texinfo, backslash is an active character; it prints the backslash
Chris@10 9875 % in fixed width font.
Chris@10 9876 \catcode`\\=\active % @ for escape char from now on.
Chris@10 9877
Chris@10 9878 % The story here is that in math mode, the \char of \backslashcurfont
Chris@10 9879 % ends up printing the roman \ from the math symbol font (because \char
Chris@10 9880 % in math mode uses the \mathcode, and plain.tex sets
Chris@10 9881 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
Chris@10 9882 % print a typewriter backslash, hence we use an explicit \mathchar,
Chris@10 9883 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
Chris@10 9884 % ignored family value; char position "5C). We can't use " for the
Chris@10 9885 % usual hex value because it has already been made active.
Chris@10 9886 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
Chris@10 9887 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
Chris@10 9888
Chris@10 9889 % On startup, @fixbackslash assigns:
Chris@10 9890 % @let \ = @normalbackslash
Chris@10 9891 % \rawbackslash defines an active \ to do \backslashcurfont.
Chris@10 9892 % \otherbackslash defines an active \ to be a literal `\' character with
Chris@10 9893 % catcode other. We switch back and forth between these.
Chris@10 9894 @gdef@rawbackslash{@let\=@backslashcurfont}
Chris@10 9895 @gdef@otherbackslash{@let\=@realbackslash}
Chris@10 9896
Chris@10 9897 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
Chris@10 9898 % the literal character `\'.
Chris@10 9899 %
Chris@10 9900 @def@normalturnoffactive{%
Chris@10 9901 @let"=@normaldoublequote
Chris@10 9902 @let$=@normaldollar %$ font-lock fix
Chris@10 9903 @let+=@normalplus
Chris@10 9904 @let<=@normalless
Chris@10 9905 @let>=@normalgreater
Chris@10 9906 @let\=@normalbackslash
Chris@10 9907 @let^=@normalcaret
Chris@10 9908 @let_=@normalunderscore
Chris@10 9909 @let|=@normalverticalbar
Chris@10 9910 @let~=@normaltilde
Chris@10 9911 @markupsetuplqdefault
Chris@10 9912 @markupsetuprqdefault
Chris@10 9913 @unsepspaces
Chris@10 9914 }
Chris@10 9915
Chris@10 9916 % Make _ and + \other characters, temporarily.
Chris@10 9917 % This is canceled by @fixbackslash.
Chris@10 9918 @otherifyactive
Chris@10 9919
Chris@10 9920 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
Chris@10 9921 % That is what \eatinput is for; after that, the `\' should revert to printing
Chris@10 9922 % a backslash.
Chris@10 9923 %
Chris@10 9924 @gdef@eatinput input texinfo{@fixbackslash}
Chris@10 9925 @global@let\ = @eatinput
Chris@10 9926
Chris@10 9927 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
Chris@10 9928 % the first `\' in the file would cause an error. This macro tries to fix
Chris@10 9929 % that, assuming it is called before the first `\' could plausibly occur.
Chris@10 9930 % Also turn back on active characters that might appear in the input
Chris@10 9931 % file name, in case not using a pre-dumped format.
Chris@10 9932 %
Chris@10 9933 @gdef@fixbackslash{%
Chris@10 9934 @ifx\@eatinput @let\ = @normalbackslash @fi
Chris@10 9935 @catcode`+=@active
Chris@10 9936 @catcode`@_=@active
Chris@10 9937 }
Chris@10 9938
Chris@10 9939 % Say @foo, not \foo, in error messages.
Chris@10 9940 @escapechar = `@@
Chris@10 9941
Chris@10 9942 % These (along with & and #) are made active for url-breaking, so need
Chris@10 9943 % active definitions as the normal characters.
Chris@10 9944 @def@normaldot{.}
Chris@10 9945 @def@normalquest{?}
Chris@10 9946 @def@normalslash{/}
Chris@10 9947
Chris@10 9948 % These look ok in all fonts, so just make them not special.
Chris@10 9949 % @hashchar{} gets its own user-level command, because of #line.
Chris@10 9950 @catcode`@& = @other @def@normalamp{&}
Chris@10 9951 @catcode`@# = @other @def@normalhash{#}
Chris@10 9952 @catcode`@% = @other @def@normalpercent{%}
Chris@10 9953
Chris@10 9954 @let @hashchar = @normalhash
Chris@10 9955
Chris@10 9956 @c Finally, make ` and ' active, so that txicodequoteundirected and
Chris@10 9957 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
Chris@10 9958 @c don't make ` and ' active, @code will not get them as active chars.
Chris@10 9959 @c Do this last of all since we use ` in the previous @catcode assignments.
Chris@10 9960 @catcode`@'=@active
Chris@10 9961 @catcode`@`=@active
Chris@10 9962 @markupsetuplqdefault
Chris@10 9963 @markupsetuprqdefault
Chris@10 9964
Chris@10 9965 @c Local variables:
Chris@10 9966 @c eval: (add-hook 'write-file-hooks 'time-stamp)
Chris@10 9967 @c page-delimiter: "^\\\\message"
Chris@10 9968 @c time-stamp-start: "def\\\\texinfoversion{"
Chris@10 9969 @c time-stamp-format: "%:y-%02m-%02d.%02H"
Chris@10 9970 @c time-stamp-end: "}"
Chris@10 9971 @c End:
Chris@10 9972
Chris@10 9973 @c vim:sw=2:
Chris@10 9974
Chris@10 9975 @ignore
Chris@10 9976 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
Chris@10 9977 @end ignore