1*43c1707eStholo% texinfo.tex -- TeX macros to handle Texinfo files. 2*43c1707eStholo% 3*43c1707eStholo% Load plain if necessary, i.e., if running under initex. 4*43c1707eStholo\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi 5*43c1707eStholo% 6*43c1707eStholo\def\texinfoversion{2000-12-11.07} 7*43c1707eStholo% 8*43c1707eStholo% Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000 9*43c1707eStholo% Free Software Foundation, Inc. 10*43c1707eStholo% 11*43c1707eStholo% This texinfo.tex file is free software; you can redistribute it and/or 12*43c1707eStholo% modify it under the terms of the GNU General Public License as 13*43c1707eStholo% published by the Free Software Foundation; either version 2, or (at 14*43c1707eStholo% your option) any later version. 15*43c1707eStholo% 16*43c1707eStholo% This texinfo.tex file is distributed in the hope that it will be 17*43c1707eStholo% useful, but WITHOUT ANY WARRANTY; without even the implied warranty 18*43c1707eStholo% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19*43c1707eStholo% General Public License for more details. 20*43c1707eStholo% 21*43c1707eStholo% You should have received a copy of the GNU General Public License 22*43c1707eStholo% along with this texinfo.tex file; see the file COPYING. If not, write 23*43c1707eStholo% to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 24*43c1707eStholo% Boston, MA 02111-1307, USA. 25*43c1707eStholo% 26*43c1707eStholo% In other words, you are welcome to use, share and improve this program. 27*43c1707eStholo% You are forbidden to forbid anyone else to use, share and improve 28*43c1707eStholo% what you give them. Help stamp out software-hoarding! 29*43c1707eStholo% 30*43c1707eStholo% Please try the latest version of texinfo.tex before submitting bug 31*43c1707eStholo% reports; you can get the latest version from: 32*43c1707eStholo% ftp://ftp.gnu.org/gnu/texinfo.tex 33*43c1707eStholo% (and all GNU mirrors, see http://www.gnu.org/order/ftp.html) 34*43c1707eStholo% ftp://texinfo.org/tex/texinfo.tex 35*43c1707eStholo% ftp://us.ctan.org/macros/texinfo/texinfo.tex 36*43c1707eStholo% (and all CTAN mirrors, finger ctan@us.ctan.org for a list). 37*43c1707eStholo% /home/gd/gnu/doc/texinfo.tex on the GNU machines. 38*43c1707eStholo% The texinfo.tex in any given Texinfo distribution could well be out 39*43c1707eStholo% of date, so if that's what you're using, please check. 40*43c1707eStholo% Texinfo has a small home page at http://texinfo.org/. 41*43c1707eStholo% 42*43c1707eStholo% Send bug reports to bug-texinfo@gnu.org. Please include including a 43*43c1707eStholo% complete document in each bug report with which we can reproduce the 44*43c1707eStholo% problem. Patches are, of course, greatly appreciated. 45*43c1707eStholo% 46*43c1707eStholo% To process a Texinfo manual with TeX, it's most reliable to use the 47*43c1707eStholo% texi2dvi shell script that comes with the distribution. For a simple 48*43c1707eStholo% manual foo.texi, however, you can get away with this: 49*43c1707eStholo% tex foo.texi 50*43c1707eStholo% texindex foo.?? 51*43c1707eStholo% tex foo.texi 52*43c1707eStholo% tex foo.texi 53*43c1707eStholo% dvips foo.dvi -o # or whatever, to process the dvi file; this makes foo.ps. 54*43c1707eStholo% The extra runs of TeX get the cross-reference information correct. 55*43c1707eStholo% Sometimes one run after texindex suffices, and sometimes you need more 56*43c1707eStholo% than two; texi2dvi does it as many times as necessary. 57*43c1707eStholo% 58*43c1707eStholo% It is possible to adapt texinfo.tex for other languages. You can get 59*43c1707eStholo% the existing language-specific files from ftp://ftp.gnu.org/gnu/texinfo/. 60*43c1707eStholo 61*43c1707eStholo\message{Loading texinfo [version \texinfoversion]:} 62*43c1707eStholo 63*43c1707eStholo% If in a .fmt file, print the version number 64*43c1707eStholo% and turn on active characters that we couldn't do earlier because 65*43c1707eStholo% they might have appeared in the input file name. 66*43c1707eStholo\everyjob{\message{[Texinfo version \texinfoversion]}% 67*43c1707eStholo \catcode`+=\active \catcode`\_=\active} 68*43c1707eStholo 69*43c1707eStholo% Save some parts of plain tex whose names we will redefine. 70*43c1707eStholo\let\ptexb=\b 71*43c1707eStholo\let\ptexbullet=\bullet 72*43c1707eStholo\let\ptexc=\c 73*43c1707eStholo\let\ptexcomma=\, 74*43c1707eStholo\let\ptexdot=\. 75*43c1707eStholo\let\ptexdots=\dots 76*43c1707eStholo\let\ptexend=\end 77*43c1707eStholo\let\ptexequiv=\equiv 78*43c1707eStholo\let\ptexexclam=\! 79*43c1707eStholo\let\ptexi=\i 80*43c1707eStholo\let\ptexlbrace=\{ 81*43c1707eStholo\let\ptexrbrace=\} 82*43c1707eStholo\let\ptexstar=\* 83*43c1707eStholo\let\ptext=\t 84*43c1707eStholo 85*43c1707eStholo% We never want plain's outer \+ definition in Texinfo. 86*43c1707eStholo% For @tex, we can use \tabalign. 87*43c1707eStholo\let\+ = \relax 88*43c1707eStholo 89*43c1707eStholo\message{Basics,} 90*43c1707eStholo\chardef\other=12 91*43c1707eStholo 92*43c1707eStholo% If this character appears in an error message or help string, it 93*43c1707eStholo% starts a new line in the output. 94*43c1707eStholo\newlinechar = `^^J 95*43c1707eStholo 96*43c1707eStholo% Set up fixed words for English if not already set. 97*43c1707eStholo\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi 98*43c1707eStholo\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi 99*43c1707eStholo\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi 100*43c1707eStholo\ifx\putwordin\undefined \gdef\putwordin{in}\fi 101*43c1707eStholo\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi 102*43c1707eStholo\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi 103*43c1707eStholo\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi 104*43c1707eStholo\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi 105*43c1707eStholo\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi 106*43c1707eStholo\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi 107*43c1707eStholo\ifx\putwordof\undefined \gdef\putwordof{of}\fi 108*43c1707eStholo\ifx\putwordon\undefined \gdef\putwordon{on}\fi 109*43c1707eStholo\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi 110*43c1707eStholo\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi 111*43c1707eStholo\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi 112*43c1707eStholo\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi 113*43c1707eStholo\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi 114*43c1707eStholo\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi 115*43c1707eStholo\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi 116*43c1707eStholo% 117*43c1707eStholo\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi 118*43c1707eStholo\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi 119*43c1707eStholo\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi 120*43c1707eStholo\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi 121*43c1707eStholo\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi 122*43c1707eStholo\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi 123*43c1707eStholo\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi 124*43c1707eStholo\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi 125*43c1707eStholo\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi 126*43c1707eStholo\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi 127*43c1707eStholo\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi 128*43c1707eStholo\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi 129*43c1707eStholo% 130*43c1707eStholo\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi 131*43c1707eStholo\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi 132*43c1707eStholo\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi 133*43c1707eStholo\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi 134*43c1707eStholo\ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi 135*43c1707eStholo\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi 136*43c1707eStholo\ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi 137*43c1707eStholo 138*43c1707eStholo% Ignore a token. 139*43c1707eStholo% 140*43c1707eStholo\def\gobble#1{} 141*43c1707eStholo 142*43c1707eStholo\hyphenation{ap-pen-dix} 143*43c1707eStholo\hyphenation{mini-buf-fer mini-buf-fers} 144*43c1707eStholo\hyphenation{eshell} 145*43c1707eStholo\hyphenation{white-space} 146*43c1707eStholo 147*43c1707eStholo% Margin to add to right of even pages, to left of odd pages. 148*43c1707eStholo\newdimen \bindingoffset 149*43c1707eStholo\newdimen \normaloffset 150*43c1707eStholo\newdimen\pagewidth \newdimen\pageheight 151*43c1707eStholo 152*43c1707eStholo% Sometimes it is convenient to have everything in the transcript file 153*43c1707eStholo% and nothing on the terminal. We don't just call \tracingall here, 154*43c1707eStholo% since that produces some useless output on the terminal. 155*43c1707eStholo% 156*43c1707eStholo\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% 157*43c1707eStholo\ifx\eTeXversion\undefined 158*43c1707eStholo\def\loggingall{\tracingcommands2 \tracingstats2 159*43c1707eStholo \tracingpages1 \tracingoutput1 \tracinglostchars1 160*43c1707eStholo \tracingmacros2 \tracingparagraphs1 \tracingrestores1 161*43c1707eStholo \showboxbreadth\maxdimen\showboxdepth\maxdimen 162*43c1707eStholo}% 163*43c1707eStholo\else 164*43c1707eStholo\def\loggingall{\tracingcommands3 \tracingstats2 165*43c1707eStholo \tracingpages1 \tracingoutput1 \tracinglostchars1 166*43c1707eStholo \tracingmacros2 \tracingparagraphs1 \tracingrestores1 167*43c1707eStholo \tracingscantokens1 \tracingassigns1 \tracingifs1 168*43c1707eStholo \tracinggroups1 \tracingnesting2 169*43c1707eStholo \showboxbreadth\maxdimen\showboxdepth\maxdimen 170*43c1707eStholo}% 171*43c1707eStholo\fi 172*43c1707eStholo 173*43c1707eStholo% For @cropmarks command. 174*43c1707eStholo% Do @cropmarks to get crop marks. 175*43c1707eStholo% 176*43c1707eStholo\newif\ifcropmarks 177*43c1707eStholo\let\cropmarks = \cropmarkstrue 178*43c1707eStholo% 179*43c1707eStholo% Dimensions to add cropmarks at corners. 180*43c1707eStholo% Added by P. A. MacKay, 12 Nov. 1986 181*43c1707eStholo% 182*43c1707eStholo\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines 183*43c1707eStholo\newdimen\cornerlong \cornerlong=1pc 184*43c1707eStholo\newdimen\cornerthick \cornerthick=.3pt 185*43c1707eStholo\newdimen\topandbottommargin \topandbottommargin=.75in 186*43c1707eStholo 187*43c1707eStholo% Main output routine. 188*43c1707eStholo\chardef\PAGE = 255 189*43c1707eStholo\output = {\onepageout{\pagecontents\PAGE}} 190*43c1707eStholo 191*43c1707eStholo\newbox\headlinebox 192*43c1707eStholo\newbox\footlinebox 193*43c1707eStholo 194*43c1707eStholo% \onepageout takes a vbox as an argument. Note that \pagecontents 195*43c1707eStholo% does insertions, but you have to call it yourself. 196*43c1707eStholo\def\onepageout#1{% 197*43c1707eStholo \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi 198*43c1707eStholo % 199*43c1707eStholo \ifodd\pageno \advance\hoffset by \bindingoffset 200*43c1707eStholo \else \advance\hoffset by -\bindingoffset\fi 201*43c1707eStholo % 202*43c1707eStholo % Do this outside of the \shipout so @code etc. will be expanded in 203*43c1707eStholo % the headline as they should be, not taken literally (outputting ''code). 204*43c1707eStholo \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% 205*43c1707eStholo \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% 206*43c1707eStholo % 207*43c1707eStholo {% 208*43c1707eStholo % Have to do this stuff outside the \shipout because we want it to 209*43c1707eStholo % take effect in \write's, yet the group defined by the \vbox ends 210*43c1707eStholo % before the \shipout runs. 211*43c1707eStholo % 212*43c1707eStholo \escapechar = `\\ % use backslash in output files. 213*43c1707eStholo \indexdummies % don't expand commands in the output. 214*43c1707eStholo \normalturnoffactive % \ in index entries must not stay \, e.g., if 215*43c1707eStholo % the page break happens to be in the middle of an example. 216*43c1707eStholo \shipout\vbox{% 217*43c1707eStholo % Do this early so pdf references go to the beginning of the page. 218*43c1707eStholo \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi 219*43c1707eStholo % 220*43c1707eStholo \ifcropmarks \vbox to \outervsize\bgroup 221*43c1707eStholo \hsize = \outerhsize 222*43c1707eStholo \vskip-\topandbottommargin 223*43c1707eStholo \vtop to0pt{% 224*43c1707eStholo \line{\ewtop\hfil\ewtop}% 225*43c1707eStholo \nointerlineskip 226*43c1707eStholo \line{% 227*43c1707eStholo \vbox{\moveleft\cornerthick\nstop}% 228*43c1707eStholo \hfill 229*43c1707eStholo \vbox{\moveright\cornerthick\nstop}% 230*43c1707eStholo }% 231*43c1707eStholo \vss}% 232*43c1707eStholo \vskip\topandbottommargin 233*43c1707eStholo \line\bgroup 234*43c1707eStholo \hfil % center the page within the outer (page) hsize. 235*43c1707eStholo \ifodd\pageno\hskip\bindingoffset\fi 236*43c1707eStholo \vbox\bgroup 237*43c1707eStholo \fi 238*43c1707eStholo % 239*43c1707eStholo \unvbox\headlinebox 240*43c1707eStholo \pagebody{#1}% 241*43c1707eStholo \ifdim\ht\footlinebox > 0pt 242*43c1707eStholo % Only leave this space if the footline is nonempty. 243*43c1707eStholo % (We lessened \vsize for it in \oddfootingxxx.) 244*43c1707eStholo % The \baselineskip=24pt in plain's \makefootline has no effect. 245*43c1707eStholo \vskip 2\baselineskip 246*43c1707eStholo \unvbox\footlinebox 247*43c1707eStholo \fi 248*43c1707eStholo % 249*43c1707eStholo \ifcropmarks 250*43c1707eStholo \egroup % end of \vbox\bgroup 251*43c1707eStholo \hfil\egroup % end of (centering) \line\bgroup 252*43c1707eStholo \vskip\topandbottommargin plus1fill minus1fill 253*43c1707eStholo \boxmaxdepth = \cornerthick 254*43c1707eStholo \vbox to0pt{\vss 255*43c1707eStholo \line{% 256*43c1707eStholo \vbox{\moveleft\cornerthick\nsbot}% 257*43c1707eStholo \hfill 258*43c1707eStholo \vbox{\moveright\cornerthick\nsbot}% 259*43c1707eStholo }% 260*43c1707eStholo \nointerlineskip 261*43c1707eStholo \line{\ewbot\hfil\ewbot}% 262*43c1707eStholo }% 263*43c1707eStholo \egroup % \vbox from first cropmarks clause 264*43c1707eStholo \fi 265*43c1707eStholo }% end of \shipout\vbox 266*43c1707eStholo }% end of group with \turnoffactive 267*43c1707eStholo \advancepageno 268*43c1707eStholo \ifnum\outputpenalty>-20000 \else\dosupereject\fi 269*43c1707eStholo} 270*43c1707eStholo 271*43c1707eStholo\newinsert\margin \dimen\margin=\maxdimen 272*43c1707eStholo 273*43c1707eStholo\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} 274*43c1707eStholo{\catcode`\@ =11 275*43c1707eStholo\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi 276*43c1707eStholo% marginal hacks, juha@viisa.uucp (Juha Takala) 277*43c1707eStholo\ifvoid\margin\else % marginal info is present 278*43c1707eStholo \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi 279*43c1707eStholo\dimen@=\dp#1 \unvbox#1 280*43c1707eStholo\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi 281*43c1707eStholo\ifr@ggedbottom \kern-\dimen@ \vfil \fi} 282*43c1707eStholo} 283*43c1707eStholo 284*43c1707eStholo% Here are the rules for the cropmarks. Note that they are 285*43c1707eStholo% offset so that the space between them is truly \outerhsize or \outervsize 286*43c1707eStholo% (P. A. MacKay, 12 November, 1986) 287*43c1707eStholo% 288*43c1707eStholo\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} 289*43c1707eStholo\def\nstop{\vbox 290*43c1707eStholo {\hrule height\cornerthick depth\cornerlong width\cornerthick}} 291*43c1707eStholo\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} 292*43c1707eStholo\def\nsbot{\vbox 293*43c1707eStholo {\hrule height\cornerlong depth\cornerthick width\cornerthick}} 294*43c1707eStholo 295*43c1707eStholo% Parse an argument, then pass it to #1. The argument is the rest of 296*43c1707eStholo% the input line (except we remove a trailing comment). #1 should be a 297*43c1707eStholo% macro which expects an ordinary undelimited TeX argument. 298*43c1707eStholo% 299*43c1707eStholo\def\parsearg#1{% 300*43c1707eStholo \let\next = #1% 301*43c1707eStholo \begingroup 302*43c1707eStholo \obeylines 303*43c1707eStholo \futurelet\temp\parseargx 304*43c1707eStholo} 305*43c1707eStholo 306*43c1707eStholo% If the next token is an obeyed space (from an @example environment or 307*43c1707eStholo% the like), remove it and recurse. Otherwise, we're done. 308*43c1707eStholo\def\parseargx{% 309*43c1707eStholo % \obeyedspace is defined far below, after the definition of \sepspaces. 310*43c1707eStholo \ifx\obeyedspace\temp 311*43c1707eStholo \expandafter\parseargdiscardspace 312*43c1707eStholo \else 313*43c1707eStholo \expandafter\parseargline 314*43c1707eStholo \fi 315*43c1707eStholo} 316*43c1707eStholo 317*43c1707eStholo% Remove a single space (as the delimiter token to the macro call). 318*43c1707eStholo{\obeyspaces % 319*43c1707eStholo \gdef\parseargdiscardspace {\futurelet\temp\parseargx}} 320*43c1707eStholo 321*43c1707eStholo{\obeylines % 322*43c1707eStholo \gdef\parseargline#1^^M{% 323*43c1707eStholo \endgroup % End of the group started in \parsearg. 324*43c1707eStholo % 325*43c1707eStholo % First remove any @c comment, then any @comment. 326*43c1707eStholo % Result of each macro is put in \toks0. 327*43c1707eStholo \argremovec #1\c\relax % 328*43c1707eStholo \expandafter\argremovecomment \the\toks0 \comment\relax % 329*43c1707eStholo % 330*43c1707eStholo % Call the caller's macro, saved as \next in \parsearg. 331*43c1707eStholo \expandafter\next\expandafter{\the\toks0}% 332*43c1707eStholo }% 333*43c1707eStholo} 334*43c1707eStholo 335*43c1707eStholo% Since all \c{,omment} does is throw away the argument, we can let TeX 336*43c1707eStholo% do that for us. The \relax here is matched by the \relax in the call 337*43c1707eStholo% in \parseargline; it could be more or less anything, its purpose is 338*43c1707eStholo% just to delimit the argument to the \c. 339*43c1707eStholo\def\argremovec#1\c#2\relax{\toks0 = {#1}} 340*43c1707eStholo\def\argremovecomment#1\comment#2\relax{\toks0 = {#1}} 341*43c1707eStholo 342*43c1707eStholo% \argremovec{,omment} might leave us with trailing spaces, though; e.g., 343*43c1707eStholo% @end itemize @c foo 344*43c1707eStholo% will have two active spaces as part of the argument with the 345*43c1707eStholo% `itemize'. Here we remove all active spaces from #1, and assign the 346*43c1707eStholo% result to \toks0. 347*43c1707eStholo% 348*43c1707eStholo% This loses if there are any *other* active characters besides spaces 349*43c1707eStholo% in the argument -- _ ^ +, for example -- since they get expanded. 350*43c1707eStholo% Fortunately, Texinfo does not define any such commands. (If it ever 351*43c1707eStholo% does, the catcode of the characters in questionwill have to be changed 352*43c1707eStholo% here.) But this means we cannot call \removeactivespaces as part of 353*43c1707eStholo% \argremovec{,omment}, since @c uses \parsearg, and thus the argument 354*43c1707eStholo% that \parsearg gets might well have any character at all in it. 355*43c1707eStholo% 356*43c1707eStholo\def\removeactivespaces#1{% 357*43c1707eStholo \begingroup 358*43c1707eStholo \ignoreactivespaces 359*43c1707eStholo \edef\temp{#1}% 360*43c1707eStholo \global\toks0 = \expandafter{\temp}% 361*43c1707eStholo \endgroup 362*43c1707eStholo} 363*43c1707eStholo 364*43c1707eStholo% Change the active space to expand to nothing. 365*43c1707eStholo% 366*43c1707eStholo\begingroup 367*43c1707eStholo \obeyspaces 368*43c1707eStholo \gdef\ignoreactivespaces{\obeyspaces\let =\empty} 369*43c1707eStholo\endgroup 370*43c1707eStholo 371*43c1707eStholo 372*43c1707eStholo\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} 373*43c1707eStholo 374*43c1707eStholo%% These are used to keep @begin/@end levels from running away 375*43c1707eStholo%% Call \inENV within environments (after a \begingroup) 376*43c1707eStholo\newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi} 377*43c1707eStholo\def\ENVcheck{% 378*43c1707eStholo\ifENV\errmessage{Still within an environment; press RETURN to continue} 379*43c1707eStholo\endgroup\fi} % This is not perfect, but it should reduce lossage 380*43c1707eStholo 381*43c1707eStholo% @begin foo is the same as @foo, for now. 382*43c1707eStholo\newhelp\EMsimple{Press RETURN to continue.} 383*43c1707eStholo 384*43c1707eStholo\outer\def\begin{\parsearg\beginxxx} 385*43c1707eStholo 386*43c1707eStholo\def\beginxxx #1{% 387*43c1707eStholo\expandafter\ifx\csname #1\endcsname\relax 388*43c1707eStholo{\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else 389*43c1707eStholo\csname #1\endcsname\fi} 390*43c1707eStholo 391*43c1707eStholo% @end foo executes the definition of \Efoo. 392*43c1707eStholo% 393*43c1707eStholo\def\end{\parsearg\endxxx} 394*43c1707eStholo\def\endxxx #1{% 395*43c1707eStholo \removeactivespaces{#1}% 396*43c1707eStholo \edef\endthing{\the\toks0}% 397*43c1707eStholo % 398*43c1707eStholo \expandafter\ifx\csname E\endthing\endcsname\relax 399*43c1707eStholo \expandafter\ifx\csname \endthing\endcsname\relax 400*43c1707eStholo % There's no \foo, i.e., no ``environment'' foo. 401*43c1707eStholo \errhelp = \EMsimple 402*43c1707eStholo \errmessage{Undefined command `@end \endthing'}% 403*43c1707eStholo \else 404*43c1707eStholo \unmatchedenderror\endthing 405*43c1707eStholo \fi 406*43c1707eStholo \else 407*43c1707eStholo % Everything's ok; the right environment has been started. 408*43c1707eStholo \csname E\endthing\endcsname 409*43c1707eStholo \fi 410*43c1707eStholo} 411*43c1707eStholo 412*43c1707eStholo% There is an environment #1, but it hasn't been started. Give an error. 413*43c1707eStholo% 414*43c1707eStholo\def\unmatchedenderror#1{% 415*43c1707eStholo \errhelp = \EMsimple 416*43c1707eStholo \errmessage{This `@end #1' doesn't have a matching `@#1'}% 417*43c1707eStholo} 418*43c1707eStholo 419*43c1707eStholo% Define the control sequence \E#1 to give an unmatched @end error. 420*43c1707eStholo% 421*43c1707eStholo\def\defineunmatchedend#1{% 422*43c1707eStholo \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}% 423*43c1707eStholo} 424*43c1707eStholo 425*43c1707eStholo 426*43c1707eStholo% Single-spacing is done by various environments (specifically, in 427*43c1707eStholo% \nonfillstart and \quotations). 428*43c1707eStholo\newskip\singlespaceskip \singlespaceskip = 12.5pt 429*43c1707eStholo\def\singlespace{% 430*43c1707eStholo % Why was this kern here? It messes up equalizing space above and below 431*43c1707eStholo % environments. --karl, 6may93 432*43c1707eStholo %{\advance \baselineskip by -\singlespaceskip 433*43c1707eStholo %\kern \baselineskip}% 434*43c1707eStholo \setleading \singlespaceskip 435*43c1707eStholo} 436*43c1707eStholo 437*43c1707eStholo%% Simple single-character @ commands 438*43c1707eStholo 439*43c1707eStholo% @@ prints an @ 440*43c1707eStholo% Kludge this until the fonts are right (grr). 441*43c1707eStholo\def\@{{\tt\char64}} 442*43c1707eStholo 443*43c1707eStholo% This is turned off because it was never documented 444*43c1707eStholo% and you can use @w{...} around a quote to suppress ligatures. 445*43c1707eStholo%% Define @` and @' to be the same as ` and ' 446*43c1707eStholo%% but suppressing ligatures. 447*43c1707eStholo%\def\`{{`}} 448*43c1707eStholo%\def\'{{'}} 449*43c1707eStholo 450*43c1707eStholo% Used to generate quoted braces. 451*43c1707eStholo\def\mylbrace {{\tt\char123}} 452*43c1707eStholo\def\myrbrace {{\tt\char125}} 453*43c1707eStholo\let\{=\mylbrace 454*43c1707eStholo\let\}=\myrbrace 455*43c1707eStholo\begingroup 456*43c1707eStholo % Definitions to produce actual \{ & \} command in an index. 457*43c1707eStholo \catcode`\{ = 12 \catcode`\} = 12 458*43c1707eStholo \catcode`\[ = 1 \catcode`\] = 2 459*43c1707eStholo \catcode`\@ = 0 \catcode`\\ = 12 460*43c1707eStholo @gdef@lbracecmd[\{]% 461*43c1707eStholo @gdef@rbracecmd[\}]% 462*43c1707eStholo@endgroup 463*43c1707eStholo 464*43c1707eStholo% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent 465*43c1707eStholo% Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H. 466*43c1707eStholo\let\, = \c 467*43c1707eStholo\let\dotaccent = \. 468*43c1707eStholo\def\ringaccent#1{{\accent23 #1}} 469*43c1707eStholo\let\tieaccent = \t 470*43c1707eStholo\let\ubaraccent = \b 471*43c1707eStholo\let\udotaccent = \d 472*43c1707eStholo 473*43c1707eStholo% Other special characters: @questiondown @exclamdown 474*43c1707eStholo% Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss. 475*43c1707eStholo\def\questiondown{?`} 476*43c1707eStholo\def\exclamdown{!`} 477*43c1707eStholo 478*43c1707eStholo% Dotless i and dotless j, used for accents. 479*43c1707eStholo\def\imacro{i} 480*43c1707eStholo\def\jmacro{j} 481*43c1707eStholo\def\dotless#1{% 482*43c1707eStholo \def\temp{#1}% 483*43c1707eStholo \ifx\temp\imacro \ptexi 484*43c1707eStholo \else\ifx\temp\jmacro \j 485*43c1707eStholo \else \errmessage{@dotless can be used only with i or j}% 486*43c1707eStholo \fi\fi 487*43c1707eStholo} 488*43c1707eStholo 489*43c1707eStholo% Be sure we're in horizontal mode when doing a tie, since we make space 490*43c1707eStholo% equivalent to this in @example-like environments. Otherwise, a space 491*43c1707eStholo% at the beginning of a line will start with \penalty -- and 492*43c1707eStholo% since \penalty is valid in vertical mode, we'd end up putting the 493*43c1707eStholo% penalty on the vertical list instead of in the new paragraph. 494*43c1707eStholo{\catcode`@ = 11 495*43c1707eStholo % Avoid using \@M directly, because that causes trouble 496*43c1707eStholo % if the definition is written into an index file. 497*43c1707eStholo \global\let\tiepenalty = \@M 498*43c1707eStholo \gdef\tie{\leavevmode\penalty\tiepenalty\ } 499*43c1707eStholo} 500*43c1707eStholo 501*43c1707eStholo% @: forces normal size whitespace following. 502*43c1707eStholo\def\:{\spacefactor=1000 } 503*43c1707eStholo 504*43c1707eStholo% @* forces a line break. 505*43c1707eStholo\def\*{\hfil\break\hbox{}\ignorespaces} 506*43c1707eStholo 507*43c1707eStholo% @. is an end-of-sentence period. 508*43c1707eStholo\def\.{.\spacefactor=3000 } 509*43c1707eStholo 510*43c1707eStholo% @! is an end-of-sentence bang. 511*43c1707eStholo\def\!{!\spacefactor=3000 } 512*43c1707eStholo 513*43c1707eStholo% @? is an end-of-sentence query. 514*43c1707eStholo\def\?{?\spacefactor=3000 } 515*43c1707eStholo 516*43c1707eStholo% @w prevents a word break. Without the \leavevmode, @w at the 517*43c1707eStholo% beginning of a paragraph, when TeX is still in vertical mode, would 518*43c1707eStholo% produce a whole line of output instead of starting the paragraph. 519*43c1707eStholo\def\w#1{\leavevmode\hbox{#1}} 520*43c1707eStholo 521*43c1707eStholo% @group ... @end group forces ... to be all on one page, by enclosing 522*43c1707eStholo% it in a TeX vbox. We use \vtop instead of \vbox to construct the box 523*43c1707eStholo% to keep its height that of a normal line. According to the rules for 524*43c1707eStholo% \topskip (p.114 of the TeXbook), the glue inserted is 525*43c1707eStholo% max (\topskip - \ht (first item), 0). If that height is large, 526*43c1707eStholo% therefore, no glue is inserted, and the space between the headline and 527*43c1707eStholo% the text is small, which looks bad. 528*43c1707eStholo% 529*43c1707eStholo\def\group{\begingroup 530*43c1707eStholo \ifnum\catcode13=\active \else 531*43c1707eStholo \errhelp = \groupinvalidhelp 532*43c1707eStholo \errmessage{@group invalid in context where filling is enabled}% 533*43c1707eStholo \fi 534*43c1707eStholo % 535*43c1707eStholo % The \vtop we start below produces a box with normal height and large 536*43c1707eStholo % depth; thus, TeX puts \baselineskip glue before it, and (when the 537*43c1707eStholo % next line of text is done) \lineskip glue after it. (See p.82 of 538*43c1707eStholo % the TeXbook.) Thus, space below is not quite equal to space 539*43c1707eStholo % above. But it's pretty close. 540*43c1707eStholo \def\Egroup{% 541*43c1707eStholo \egroup % End the \vtop. 542*43c1707eStholo \endgroup % End the \group. 543*43c1707eStholo }% 544*43c1707eStholo % 545*43c1707eStholo \vtop\bgroup 546*43c1707eStholo % We have to put a strut on the last line in case the @group is in 547*43c1707eStholo % the midst of an example, rather than completely enclosing it. 548*43c1707eStholo % Otherwise, the interline space between the last line of the group 549*43c1707eStholo % and the first line afterwards is too small. But we can't put the 550*43c1707eStholo % strut in \Egroup, since there it would be on a line by itself. 551*43c1707eStholo % Hence this just inserts a strut at the beginning of each line. 552*43c1707eStholo \everypar = {\strut}% 553*43c1707eStholo % 554*43c1707eStholo % Since we have a strut on every line, we don't need any of TeX's 555*43c1707eStholo % normal interline spacing. 556*43c1707eStholo \offinterlineskip 557*43c1707eStholo % 558*43c1707eStholo % OK, but now we have to do something about blank 559*43c1707eStholo % lines in the input in @example-like environments, which normally 560*43c1707eStholo % just turn into \lisppar, which will insert no space now that we've 561*43c1707eStholo % turned off the interline space. Simplest is to make them be an 562*43c1707eStholo % empty paragraph. 563*43c1707eStholo \ifx\par\lisppar 564*43c1707eStholo \edef\par{\leavevmode \par}% 565*43c1707eStholo % 566*43c1707eStholo % Reset ^^M's definition to new definition of \par. 567*43c1707eStholo \obeylines 568*43c1707eStholo \fi 569*43c1707eStholo % 570*43c1707eStholo % Do @comment since we are called inside an environment such as 571*43c1707eStholo % @example, where each end-of-line in the input causes an 572*43c1707eStholo % end-of-line in the output. We don't want the end-of-line after 573*43c1707eStholo % the `@group' to put extra space in the output. Since @group 574*43c1707eStholo % should appear on a line by itself (according to the Texinfo 575*43c1707eStholo % manual), we don't worry about eating any user text. 576*43c1707eStholo \comment 577*43c1707eStholo} 578*43c1707eStholo% 579*43c1707eStholo% TeX puts in an \escapechar (i.e., `@') at the beginning of the help 580*43c1707eStholo% message, so this ends up printing `@group can only ...'. 581*43c1707eStholo% 582*43c1707eStholo\newhelp\groupinvalidhelp{% 583*43c1707eSthologroup can only be used in environments such as @example,^^J% 584*43c1707eStholowhere each line of input produces a line of output.} 585*43c1707eStholo 586*43c1707eStholo% @need space-in-mils 587*43c1707eStholo% forces a page break if there is not space-in-mils remaining. 588*43c1707eStholo 589*43c1707eStholo\newdimen\mil \mil=0.001in 590*43c1707eStholo 591*43c1707eStholo\def\need{\parsearg\needx} 592*43c1707eStholo 593*43c1707eStholo% Old definition--didn't work. 594*43c1707eStholo%\def\needx #1{\par % 595*43c1707eStholo%% This method tries to make TeX break the page naturally 596*43c1707eStholo%% if the depth of the box does not fit. 597*43c1707eStholo%{\baselineskip=0pt% 598*43c1707eStholo%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak 599*43c1707eStholo%\prevdepth=-1000pt 600*43c1707eStholo%}} 601*43c1707eStholo 602*43c1707eStholo\def\needx#1{% 603*43c1707eStholo % Ensure vertical mode, so we don't make a big box in the middle of a 604*43c1707eStholo % paragraph. 605*43c1707eStholo \par 606*43c1707eStholo % 607*43c1707eStholo % If the @need value is less than one line space, it's useless. 608*43c1707eStholo \dimen0 = #1\mil 609*43c1707eStholo \dimen2 = \ht\strutbox 610*43c1707eStholo \advance\dimen2 by \dp\strutbox 611*43c1707eStholo \ifdim\dimen0 > \dimen2 612*43c1707eStholo % 613*43c1707eStholo % Do a \strut just to make the height of this box be normal, so the 614*43c1707eStholo % normal leading is inserted relative to the preceding line. 615*43c1707eStholo % And a page break here is fine. 616*43c1707eStholo \vtop to #1\mil{\strut\vfil}% 617*43c1707eStholo % 618*43c1707eStholo % TeX does not even consider page breaks if a penalty added to the 619*43c1707eStholo % main vertical list is 10000 or more. But in order to see if the 620*43c1707eStholo % empty box we just added fits on the page, we must make it consider 621*43c1707eStholo % page breaks. On the other hand, we don't want to actually break the 622*43c1707eStholo % page after the empty box. So we use a penalty of 9999. 623*43c1707eStholo % 624*43c1707eStholo % There is an extremely small chance that TeX will actually break the 625*43c1707eStholo % page at this \penalty, if there are no other feasible breakpoints in 626*43c1707eStholo % sight. (If the user is using lots of big @group commands, which 627*43c1707eStholo % almost-but-not-quite fill up a page, TeX will have a hard time doing 628*43c1707eStholo % good page breaking, for example.) However, I could not construct an 629*43c1707eStholo % example where a page broke at this \penalty; if it happens in a real 630*43c1707eStholo % document, then we can reconsider our strategy. 631*43c1707eStholo \penalty9999 632*43c1707eStholo % 633*43c1707eStholo % Back up by the size of the box, whether we did a page break or not. 634*43c1707eStholo \kern -#1\mil 635*43c1707eStholo % 636*43c1707eStholo % Do not allow a page break right after this kern. 637*43c1707eStholo \nobreak 638*43c1707eStholo \fi 639*43c1707eStholo} 640*43c1707eStholo 641*43c1707eStholo% @br forces paragraph break 642*43c1707eStholo 643*43c1707eStholo\let\br = \par 644*43c1707eStholo 645*43c1707eStholo% @dots{} output an ellipsis using the current font. 646*43c1707eStholo% We do .5em per period so that it has the same spacing in a typewriter 647*43c1707eStholo% font as three actual period characters. 648*43c1707eStholo% 649*43c1707eStholo\def\dots{% 650*43c1707eStholo \leavevmode 651*43c1707eStholo \hbox to 1.5em{% 652*43c1707eStholo \hskip 0pt plus 0.25fil minus 0.25fil 653*43c1707eStholo .\hss.\hss.% 654*43c1707eStholo \hskip 0pt plus 0.5fil minus 0.5fil 655*43c1707eStholo }% 656*43c1707eStholo} 657*43c1707eStholo 658*43c1707eStholo% @enddots{} is an end-of-sentence ellipsis. 659*43c1707eStholo% 660*43c1707eStholo\def\enddots{% 661*43c1707eStholo \leavevmode 662*43c1707eStholo \hbox to 2em{% 663*43c1707eStholo \hskip 0pt plus 0.25fil minus 0.25fil 664*43c1707eStholo .\hss.\hss.\hss.% 665*43c1707eStholo \hskip 0pt plus 0.5fil minus 0.5fil 666*43c1707eStholo }% 667*43c1707eStholo \spacefactor=3000 668*43c1707eStholo} 669*43c1707eStholo 670*43c1707eStholo 671*43c1707eStholo% @page forces the start of a new page 672*43c1707eStholo% 673*43c1707eStholo\def\page{\par\vfill\supereject} 674*43c1707eStholo 675*43c1707eStholo% @exdent text.... 676*43c1707eStholo% outputs text on separate line in roman font, starting at standard page margin 677*43c1707eStholo 678*43c1707eStholo% This records the amount of indent in the innermost environment. 679*43c1707eStholo% That's how much \exdent should take out. 680*43c1707eStholo\newskip\exdentamount 681*43c1707eStholo 682*43c1707eStholo% This defn is used inside fill environments such as @defun. 683*43c1707eStholo\def\exdent{\parsearg\exdentyyy} 684*43c1707eStholo\def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}} 685*43c1707eStholo 686*43c1707eStholo% This defn is used inside nofill environments such as @example. 687*43c1707eStholo\def\nofillexdent{\parsearg\nofillexdentyyy} 688*43c1707eStholo\def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount 689*43c1707eStholo\leftline{\hskip\leftskip{\rm#1}}}} 690*43c1707eStholo 691*43c1707eStholo% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current 692*43c1707eStholo% paragraph. For more general purposes, use the \margin insertion 693*43c1707eStholo% class. WHICH is `l' or `r'. 694*43c1707eStholo% 695*43c1707eStholo\newskip\inmarginspacing \inmarginspacing=1cm 696*43c1707eStholo\def\strutdepth{\dp\strutbox} 697*43c1707eStholo% 698*43c1707eStholo\def\doinmargin#1#2{\strut\vadjust{% 699*43c1707eStholo \nobreak 700*43c1707eStholo \kern-\strutdepth 701*43c1707eStholo \vtop to \strutdepth{% 702*43c1707eStholo \baselineskip=\strutdepth 703*43c1707eStholo \vss 704*43c1707eStholo % if you have multiple lines of stuff to put here, you'll need to 705*43c1707eStholo % make the vbox yourself of the appropriate size. 706*43c1707eStholo \ifx#1l% 707*43c1707eStholo \llap{\ignorespaces #2\hskip\inmarginspacing}% 708*43c1707eStholo \else 709*43c1707eStholo \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% 710*43c1707eStholo \fi 711*43c1707eStholo \null 712*43c1707eStholo }% 713*43c1707eStholo}} 714*43c1707eStholo\def\inleftmargin{\doinmargin l} 715*43c1707eStholo\def\inrightmargin{\doinmargin r} 716*43c1707eStholo% 717*43c1707eStholo% @inmargin{TEXT [, RIGHT-TEXT]} 718*43c1707eStholo% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; 719*43c1707eStholo% else use TEXT for both). 720*43c1707eStholo% 721*43c1707eStholo\def\inmargin#1{\parseinmargin #1,,\finish} 722*43c1707eStholo\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. 723*43c1707eStholo \setbox0 = \hbox{\ignorespaces #2}% 724*43c1707eStholo \ifdim\wd0 > 0pt 725*43c1707eStholo \def\lefttext{#1}% have both texts 726*43c1707eStholo \def\righttext{#2}% 727*43c1707eStholo \else 728*43c1707eStholo \def\lefttext{#1}% have only one text 729*43c1707eStholo \def\righttext{#1}% 730*43c1707eStholo \fi 731*43c1707eStholo % 732*43c1707eStholo \ifodd\pageno 733*43c1707eStholo \def\temp{\inleftmargin\lefttext}% 734*43c1707eStholo \else 735*43c1707eStholo \def\temp{\inrightmargin\righttext}% 736*43c1707eStholo \fi 737*43c1707eStholo \temp 738*43c1707eStholo} 739*43c1707eStholo 740*43c1707eStholo% @include file insert text of that file as input. 741*43c1707eStholo% Allow normal characters that we make active in the argument (a file name). 742*43c1707eStholo\def\include{\begingroup 743*43c1707eStholo \catcode`\\=12 744*43c1707eStholo \catcode`~=12 745*43c1707eStholo \catcode`^=12 746*43c1707eStholo \catcode`_=12 747*43c1707eStholo \catcode`|=12 748*43c1707eStholo \catcode`<=12 749*43c1707eStholo \catcode`>=12 750*43c1707eStholo \catcode`+=12 751*43c1707eStholo \parsearg\includezzz} 752*43c1707eStholo% Restore active chars for included file. 753*43c1707eStholo\def\includezzz#1{\endgroup\begingroup 754*43c1707eStholo % Read the included file in a group so nested @include's work. 755*43c1707eStholo \def\thisfile{#1}% 756*43c1707eStholo \input\thisfile 757*43c1707eStholo\endgroup} 758*43c1707eStholo 759*43c1707eStholo\def\thisfile{} 760*43c1707eStholo 761*43c1707eStholo% @center line outputs that line, centered 762*43c1707eStholo 763*43c1707eStholo\def\center{\parsearg\centerzzz} 764*43c1707eStholo\def\centerzzz #1{{\advance\hsize by -\leftskip 765*43c1707eStholo\advance\hsize by -\rightskip 766*43c1707eStholo\centerline{#1}}} 767*43c1707eStholo 768*43c1707eStholo% @sp n outputs n lines of vertical space 769*43c1707eStholo 770*43c1707eStholo\def\sp{\parsearg\spxxx} 771*43c1707eStholo\def\spxxx #1{\vskip #1\baselineskip} 772*43c1707eStholo 773*43c1707eStholo% @comment ...line which is ignored... 774*43c1707eStholo% @c is the same as @comment 775*43c1707eStholo% @ignore ... @end ignore is another way to write a comment 776*43c1707eStholo 777*43c1707eStholo\def\comment{\begingroup \catcode`\^^M=\other% 778*43c1707eStholo\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% 779*43c1707eStholo\commentxxx} 780*43c1707eStholo{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} 781*43c1707eStholo 782*43c1707eStholo\let\c=\comment 783*43c1707eStholo 784*43c1707eStholo% @paragraphindent NCHARS 785*43c1707eStholo% We'll use ems for NCHARS, close enough. 786*43c1707eStholo% We cannot implement @paragraphindent asis, though. 787*43c1707eStholo% 788*43c1707eStholo\def\asisword{asis} % no translation, these are keywords 789*43c1707eStholo\def\noneword{none} 790*43c1707eStholo% 791*43c1707eStholo\def\paragraphindent{\parsearg\doparagraphindent} 792*43c1707eStholo\def\doparagraphindent#1{% 793*43c1707eStholo \def\temp{#1}% 794*43c1707eStholo \ifx\temp\asisword 795*43c1707eStholo \else 796*43c1707eStholo \ifx\temp\noneword 797*43c1707eStholo \defaultparindent = 0pt 798*43c1707eStholo \else 799*43c1707eStholo \defaultparindent = #1em 800*43c1707eStholo \fi 801*43c1707eStholo \fi 802*43c1707eStholo \parindent = \defaultparindent 803*43c1707eStholo} 804*43c1707eStholo 805*43c1707eStholo% @exampleindent NCHARS 806*43c1707eStholo% We'll use ems for NCHARS like @paragraphindent. 807*43c1707eStholo% It seems @exampleindent asis isn't necessary, but 808*43c1707eStholo% I preserve it to make it similar to @paragraphindent. 809*43c1707eStholo\def\exampleindent{\parsearg\doexampleindent} 810*43c1707eStholo\def\doexampleindent#1{% 811*43c1707eStholo \def\temp{#1}% 812*43c1707eStholo \ifx\temp\asisword 813*43c1707eStholo \else 814*43c1707eStholo \ifx\temp\noneword 815*43c1707eStholo \lispnarrowing = 0pt 816*43c1707eStholo \else 817*43c1707eStholo \lispnarrowing = #1em 818*43c1707eStholo \fi 819*43c1707eStholo \fi 820*43c1707eStholo} 821*43c1707eStholo 822*43c1707eStholo% @asis just yields its argument. Used with @table, for example. 823*43c1707eStholo% 824*43c1707eStholo\def\asis#1{#1} 825*43c1707eStholo 826*43c1707eStholo% @math means output in math mode. 827*43c1707eStholo% We don't use $'s directly in the definition of \math because control 828*43c1707eStholo% sequences like \math are expanded when the toc file is written. Then, 829*43c1707eStholo% we read the toc file back, the $'s will be normal characters (as they 830*43c1707eStholo% should be, according to the definition of Texinfo). So we must use a 831*43c1707eStholo% control sequence to switch into and out of math mode. 832*43c1707eStholo% 833*43c1707eStholo% This isn't quite enough for @math to work properly in indices, but it 834*43c1707eStholo% seems unlikely it will ever be needed there. 835*43c1707eStholo% 836*43c1707eStholo\let\implicitmath = $ 837*43c1707eStholo\def\math#1{\implicitmath #1\implicitmath} 838*43c1707eStholo 839*43c1707eStholo% @bullet and @minus need the same treatment as @math, just above. 840*43c1707eStholo\def\bullet{\implicitmath\ptexbullet\implicitmath} 841*43c1707eStholo\def\minus{\implicitmath-\implicitmath} 842*43c1707eStholo 843*43c1707eStholo% @refill is a no-op. 844*43c1707eStholo\let\refill=\relax 845*43c1707eStholo 846*43c1707eStholo% If working on a large document in chapters, it is convenient to 847*43c1707eStholo% be able to disable indexing, cross-referencing, and contents, for test runs. 848*43c1707eStholo% This is done with @novalidate (before @setfilename). 849*43c1707eStholo% 850*43c1707eStholo\newif\iflinks \linkstrue % by default we want the aux files. 851*43c1707eStholo\let\novalidate = \linksfalse 852*43c1707eStholo 853*43c1707eStholo% @setfilename is done at the beginning of every texinfo file. 854*43c1707eStholo% So open here the files we need to have open while reading the input. 855*43c1707eStholo% This makes it possible to make a .fmt file for texinfo. 856*43c1707eStholo\def\setfilename{% 857*43c1707eStholo \iflinks 858*43c1707eStholo \readauxfile 859*43c1707eStholo \fi % \openindices needs to do some work in any case. 860*43c1707eStholo \openindices 861*43c1707eStholo \fixbackslash % Turn off hack to swallow `\input texinfo'. 862*43c1707eStholo \global\let\setfilename=\comment % Ignore extra @setfilename cmds. 863*43c1707eStholo % 864*43c1707eStholo % If texinfo.cnf is present on the system, read it. 865*43c1707eStholo % Useful for site-wide @afourpaper, etc. 866*43c1707eStholo % Just to be on the safe side, close the input stream before the \input. 867*43c1707eStholo \openin 1 texinfo.cnf 868*43c1707eStholo \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi 869*43c1707eStholo \closein1 870*43c1707eStholo \temp 871*43c1707eStholo % 872*43c1707eStholo \comment % Ignore the actual filename. 873*43c1707eStholo} 874*43c1707eStholo 875*43c1707eStholo% Called from \setfilename. 876*43c1707eStholo% 877*43c1707eStholo\def\openindices{% 878*43c1707eStholo \newindex{cp}% 879*43c1707eStholo \newcodeindex{fn}% 880*43c1707eStholo \newcodeindex{vr}% 881*43c1707eStholo \newcodeindex{tp}% 882*43c1707eStholo \newcodeindex{ky}% 883*43c1707eStholo \newcodeindex{pg}% 884*43c1707eStholo} 885*43c1707eStholo 886*43c1707eStholo% @bye. 887*43c1707eStholo\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} 888*43c1707eStholo 889*43c1707eStholo 890*43c1707eStholo\message{pdf,} 891*43c1707eStholo% adobe `portable' document format 892*43c1707eStholo\newcount\tempnum 893*43c1707eStholo\newcount\lnkcount 894*43c1707eStholo\newtoks\filename 895*43c1707eStholo\newcount\filenamelength 896*43c1707eStholo\newcount\pgn 897*43c1707eStholo\newtoks\toksA 898*43c1707eStholo\newtoks\toksB 899*43c1707eStholo\newtoks\toksC 900*43c1707eStholo\newtoks\toksD 901*43c1707eStholo\newbox\boxA 902*43c1707eStholo\newcount\countA 903*43c1707eStholo\newif\ifpdf 904*43c1707eStholo\newif\ifpdfmakepagedest 905*43c1707eStholo 906*43c1707eStholo\ifx\pdfoutput\undefined 907*43c1707eStholo \pdffalse 908*43c1707eStholo \let\pdfmkdest = \gobble 909*43c1707eStholo \let\pdfurl = \gobble 910*43c1707eStholo \let\endlink = \relax 911*43c1707eStholo \let\linkcolor = \relax 912*43c1707eStholo \let\pdfmakeoutlines = \relax 913*43c1707eStholo\else 914*43c1707eStholo \pdftrue 915*43c1707eStholo \pdfoutput = 1 916*43c1707eStholo \input pdfcolor 917*43c1707eStholo \def\dopdfimage#1#2#3{% 918*43c1707eStholo \def\imagewidth{#2}% 919*43c1707eStholo \def\imageheight{#3}% 920*43c1707eStholo \ifnum\pdftexversion < 14 921*43c1707eStholo \pdfimage 922*43c1707eStholo \else 923*43c1707eStholo \pdfximage 924*43c1707eStholo \fi 925*43c1707eStholo \ifx\empty\imagewidth\else width \imagewidth \fi 926*43c1707eStholo \ifx\empty\imageheight\else height \imageheight \fi 927*43c1707eStholo {#1.pdf}% 928*43c1707eStholo \ifnum\pdftexversion < 14 \else 929*43c1707eStholo \pdfrefximage \pdflastximage 930*43c1707eStholo \fi} 931*43c1707eStholo \def\pdfmkdest#1{\pdfdest name{#1@} xyz} 932*43c1707eStholo \def\pdfmkpgn#1{#1@} 933*43c1707eStholo \let\linkcolor = \Blue % was Cyan, but that seems light? 934*43c1707eStholo \def\endlink{\Black\pdfendlink} 935*43c1707eStholo % Adding outlines to PDF; macros for calculating structure of outlines 936*43c1707eStholo % come from Petr Olsak 937*43c1707eStholo \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% 938*43c1707eStholo \else \csname#1\endcsname \fi} 939*43c1707eStholo \def\advancenumber#1{\tempnum=\expnumber{#1}\relax 940*43c1707eStholo \advance\tempnum by1 941*43c1707eStholo \expandafter\xdef\csname#1\endcsname{\the\tempnum}} 942*43c1707eStholo \def\pdfmakeoutlines{{% 943*43c1707eStholo \openin 1 \jobname.toc 944*43c1707eStholo \ifeof 1\else\bgroup 945*43c1707eStholo \closein 1 946*43c1707eStholo \indexnofonts 947*43c1707eStholo \def\tt{} 948*43c1707eStholo \let\_ = \normalunderscore 949*43c1707eStholo % Thanh's hack / proper braces in bookmarks 950*43c1707eStholo \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace 951*43c1707eStholo \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace 952*43c1707eStholo % 953*43c1707eStholo \def\chapentry ##1##2##3{} 954*43c1707eStholo \def\unnumbchapentry ##1##2{} 955*43c1707eStholo \def\secentry ##1##2##3##4{\advancenumber{chap##2}} 956*43c1707eStholo \def\unnumbsecentry ##1##2{} 957*43c1707eStholo \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}} 958*43c1707eStholo \def\unnumbsubsecentry ##1##2{} 959*43c1707eStholo \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}} 960*43c1707eStholo \def\unnumbsubsubsecentry ##1##2{} 961*43c1707eStholo \input \jobname.toc 962*43c1707eStholo \def\chapentry ##1##2##3{% 963*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}} 964*43c1707eStholo \def\unnumbchapentry ##1##2{% 965*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 966*43c1707eStholo \def\secentry ##1##2##3##4{% 967*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}} 968*43c1707eStholo \def\unnumbsecentry ##1##2{% 969*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 970*43c1707eStholo \def\subsecentry ##1##2##3##4##5{% 971*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}} 972*43c1707eStholo \def\unnumbsubsecentry ##1##2{% 973*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 974*43c1707eStholo \def\subsubsecentry ##1##2##3##4##5##6{% 975*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##6}}{##1}} 976*43c1707eStholo \def\unnumbsubsubsecentry ##1##2{% 977*43c1707eStholo \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 978*43c1707eStholo \input \jobname.toc 979*43c1707eStholo \egroup\fi 980*43c1707eStholo }} 981*43c1707eStholo \def\makelinks #1,{% 982*43c1707eStholo \def\params{#1}\def\E{END}% 983*43c1707eStholo \ifx\params\E 984*43c1707eStholo \let\nextmakelinks=\relax 985*43c1707eStholo \else 986*43c1707eStholo \let\nextmakelinks=\makelinks 987*43c1707eStholo \ifnum\lnkcount>0,\fi 988*43c1707eStholo \picknum{#1}% 989*43c1707eStholo \startlink attr{/Border [0 0 0]} 990*43c1707eStholo goto name{\pdfmkpgn{\the\pgn}}% 991*43c1707eStholo \linkcolor #1% 992*43c1707eStholo \advance\lnkcount by 1% 993*43c1707eStholo \endlink 994*43c1707eStholo \fi 995*43c1707eStholo \nextmakelinks 996*43c1707eStholo } 997*43c1707eStholo \def\picknum#1{\expandafter\pn#1} 998*43c1707eStholo \def\pn#1{% 999*43c1707eStholo \def\p{#1}% 1000*43c1707eStholo \ifx\p\lbrace 1001*43c1707eStholo \let\nextpn=\ppn 1002*43c1707eStholo \else 1003*43c1707eStholo \let\nextpn=\ppnn 1004*43c1707eStholo \def\first{#1} 1005*43c1707eStholo \fi 1006*43c1707eStholo \nextpn 1007*43c1707eStholo } 1008*43c1707eStholo \def\ppn#1{\pgn=#1\gobble} 1009*43c1707eStholo \def\ppnn{\pgn=\first} 1010*43c1707eStholo \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,} 1011*43c1707eStholo \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} 1012*43c1707eStholo \def\skipspaces#1{\def\PP{#1}\def\D{|}% 1013*43c1707eStholo \ifx\PP\D\let\nextsp\relax 1014*43c1707eStholo \else\let\nextsp\skipspaces 1015*43c1707eStholo \ifx\p\space\else\addtokens{\filename}{\PP}% 1016*43c1707eStholo \advance\filenamelength by 1 1017*43c1707eStholo \fi 1018*43c1707eStholo \fi 1019*43c1707eStholo \nextsp} 1020*43c1707eStholo \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} 1021*43c1707eStholo \ifnum\pdftexversion < 14 1022*43c1707eStholo \let \startlink \pdfannotlink 1023*43c1707eStholo \else 1024*43c1707eStholo \let \startlink \pdfstartlink 1025*43c1707eStholo \fi 1026*43c1707eStholo \def\pdfurl#1{% 1027*43c1707eStholo \begingroup 1028*43c1707eStholo \normalturnoffactive\def\@{@}% 1029*43c1707eStholo \leavevmode\Red 1030*43c1707eStholo \startlink attr{/Border [0 0 0]}% 1031*43c1707eStholo user{/Subtype /Link /A << /S /URI /URI (#1) >>}% 1032*43c1707eStholo % #1 1033*43c1707eStholo \endgroup} 1034*43c1707eStholo \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} 1035*43c1707eStholo \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} 1036*43c1707eStholo \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} 1037*43c1707eStholo \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} 1038*43c1707eStholo \def\maketoks{% 1039*43c1707eStholo \expandafter\poptoks\the\toksA|ENDTOKS| 1040*43c1707eStholo \ifx\first0\adn0 1041*43c1707eStholo \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 1042*43c1707eStholo \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 1043*43c1707eStholo \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 1044*43c1707eStholo \else 1045*43c1707eStholo \ifnum0=\countA\else\makelink\fi 1046*43c1707eStholo \ifx\first.\let\next=\done\else 1047*43c1707eStholo \let\next=\maketoks 1048*43c1707eStholo \addtokens{\toksB}{\the\toksD} 1049*43c1707eStholo \ifx\first,\addtokens{\toksB}{\space}\fi 1050*43c1707eStholo \fi 1051*43c1707eStholo \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 1052*43c1707eStholo \next} 1053*43c1707eStholo \def\makelink{\addtokens{\toksB}% 1054*43c1707eStholo {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} 1055*43c1707eStholo \def\pdflink#1{% 1056*43c1707eStholo \startlink attr{/Border [0 0 0]} goto name{\mkpgn{#1}} 1057*43c1707eStholo \linkcolor #1\endlink} 1058*43c1707eStholo \def\mkpgn#1{#1@} 1059*43c1707eStholo \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} 1060*43c1707eStholo\fi % \ifx\pdfoutput 1061*43c1707eStholo 1062*43c1707eStholo 1063*43c1707eStholo\message{fonts,} 1064*43c1707eStholo% Font-change commands. 1065*43c1707eStholo 1066*43c1707eStholo% Texinfo sort of supports the sans serif font style, which plain TeX does not. 1067*43c1707eStholo% So we set up a \sf analogous to plain's \rm, etc. 1068*43c1707eStholo\newfam\sffam 1069*43c1707eStholo\def\sf{\fam=\sffam \tensf} 1070*43c1707eStholo\let\li = \sf % Sometimes we call it \li, not \sf. 1071*43c1707eStholo 1072*43c1707eStholo% We don't need math for this one. 1073*43c1707eStholo\def\ttsl{\tenttsl} 1074*43c1707eStholo 1075*43c1707eStholo% Use Computer Modern fonts at \magstephalf (11pt). 1076*43c1707eStholo\newcount\mainmagstep 1077*43c1707eStholo\mainmagstep=\magstephalf 1078*43c1707eStholo 1079*43c1707eStholo% Set the font macro #1 to the font named #2, adding on the 1080*43c1707eStholo% specified font prefix (normally `cm'). 1081*43c1707eStholo% #3 is the font's design size, #4 is a scale factor 1082*43c1707eStholo\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} 1083*43c1707eStholo 1084*43c1707eStholo% Use cm as the default font prefix. 1085*43c1707eStholo% To specify the font prefix, you must define \fontprefix 1086*43c1707eStholo% before you read in texinfo.tex. 1087*43c1707eStholo\ifx\fontprefix\undefined 1088*43c1707eStholo\def\fontprefix{cm} 1089*43c1707eStholo\fi 1090*43c1707eStholo% Support font families that don't use the same naming scheme as CM. 1091*43c1707eStholo\def\rmshape{r} 1092*43c1707eStholo\def\rmbshape{bx} %where the normal face is bold 1093*43c1707eStholo\def\bfshape{b} 1094*43c1707eStholo\def\bxshape{bx} 1095*43c1707eStholo\def\ttshape{tt} 1096*43c1707eStholo\def\ttbshape{tt} 1097*43c1707eStholo\def\ttslshape{sltt} 1098*43c1707eStholo\def\itshape{ti} 1099*43c1707eStholo\def\itbshape{bxti} 1100*43c1707eStholo\def\slshape{sl} 1101*43c1707eStholo\def\slbshape{bxsl} 1102*43c1707eStholo\def\sfshape{ss} 1103*43c1707eStholo\def\sfbshape{ss} 1104*43c1707eStholo\def\scshape{csc} 1105*43c1707eStholo\def\scbshape{csc} 1106*43c1707eStholo 1107*43c1707eStholo\ifx\bigger\relax 1108*43c1707eStholo\let\mainmagstep=\magstep1 1109*43c1707eStholo\setfont\textrm\rmshape{12}{1000} 1110*43c1707eStholo\setfont\texttt\ttshape{12}{1000} 1111*43c1707eStholo\else 1112*43c1707eStholo\setfont\textrm\rmshape{10}{\mainmagstep} 1113*43c1707eStholo\setfont\texttt\ttshape{10}{\mainmagstep} 1114*43c1707eStholo\fi 1115*43c1707eStholo% Instead of cmb10, you many want to use cmbx10. 1116*43c1707eStholo% cmbx10 is a prettier font on its own, but cmb10 1117*43c1707eStholo% looks better when embedded in a line with cmr10. 1118*43c1707eStholo\setfont\textbf\bfshape{10}{\mainmagstep} 1119*43c1707eStholo\setfont\textit\itshape{10}{\mainmagstep} 1120*43c1707eStholo\setfont\textsl\slshape{10}{\mainmagstep} 1121*43c1707eStholo\setfont\textsf\sfshape{10}{\mainmagstep} 1122*43c1707eStholo\setfont\textsc\scshape{10}{\mainmagstep} 1123*43c1707eStholo\setfont\textttsl\ttslshape{10}{\mainmagstep} 1124*43c1707eStholo\font\texti=cmmi10 scaled \mainmagstep 1125*43c1707eStholo\font\textsy=cmsy10 scaled \mainmagstep 1126*43c1707eStholo 1127*43c1707eStholo% A few fonts for @defun, etc. 1128*43c1707eStholo\setfont\defbf\bxshape{10}{\magstep1} %was 1314 1129*43c1707eStholo\setfont\deftt\ttshape{10}{\magstep1} 1130*43c1707eStholo\def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf} 1131*43c1707eStholo 1132*43c1707eStholo% Fonts for indices, footnotes, small examples (9pt). 1133*43c1707eStholo\setfont\smallrm\rmshape{9}{1000} 1134*43c1707eStholo\setfont\smalltt\ttshape{9}{1000} 1135*43c1707eStholo\setfont\smallbf\bfshape{10}{900} 1136*43c1707eStholo\setfont\smallit\itshape{9}{1000} 1137*43c1707eStholo\setfont\smallsl\slshape{9}{1000} 1138*43c1707eStholo\setfont\smallsf\sfshape{9}{1000} 1139*43c1707eStholo\setfont\smallsc\scshape{10}{900} 1140*43c1707eStholo\setfont\smallttsl\ttslshape{10}{900} 1141*43c1707eStholo\font\smalli=cmmi9 1142*43c1707eStholo\font\smallsy=cmsy9 1143*43c1707eStholo 1144*43c1707eStholo% Fonts for title page: 1145*43c1707eStholo\setfont\titlerm\rmbshape{12}{\magstep3} 1146*43c1707eStholo\setfont\titleit\itbshape{10}{\magstep4} 1147*43c1707eStholo\setfont\titlesl\slbshape{10}{\magstep4} 1148*43c1707eStholo\setfont\titlett\ttbshape{12}{\magstep3} 1149*43c1707eStholo\setfont\titlettsl\ttslshape{10}{\magstep4} 1150*43c1707eStholo\setfont\titlesf\sfbshape{17}{\magstep1} 1151*43c1707eStholo\let\titlebf=\titlerm 1152*43c1707eStholo\setfont\titlesc\scbshape{10}{\magstep4} 1153*43c1707eStholo\font\titlei=cmmi12 scaled \magstep3 1154*43c1707eStholo\font\titlesy=cmsy10 scaled \magstep4 1155*43c1707eStholo\def\authorrm{\secrm} 1156*43c1707eStholo 1157*43c1707eStholo% Chapter (and unnumbered) fonts (17.28pt). 1158*43c1707eStholo\setfont\chaprm\rmbshape{12}{\magstep2} 1159*43c1707eStholo\setfont\chapit\itbshape{10}{\magstep3} 1160*43c1707eStholo\setfont\chapsl\slbshape{10}{\magstep3} 1161*43c1707eStholo\setfont\chaptt\ttbshape{12}{\magstep2} 1162*43c1707eStholo\setfont\chapttsl\ttslshape{10}{\magstep3} 1163*43c1707eStholo\setfont\chapsf\sfbshape{17}{1000} 1164*43c1707eStholo\let\chapbf=\chaprm 1165*43c1707eStholo\setfont\chapsc\scbshape{10}{\magstep3} 1166*43c1707eStholo\font\chapi=cmmi12 scaled \magstep2 1167*43c1707eStholo\font\chapsy=cmsy10 scaled \magstep3 1168*43c1707eStholo 1169*43c1707eStholo% Section fonts (14.4pt). 1170*43c1707eStholo\setfont\secrm\rmbshape{12}{\magstep1} 1171*43c1707eStholo\setfont\secit\itbshape{10}{\magstep2} 1172*43c1707eStholo\setfont\secsl\slbshape{10}{\magstep2} 1173*43c1707eStholo\setfont\sectt\ttbshape{12}{\magstep1} 1174*43c1707eStholo\setfont\secttsl\ttslshape{10}{\magstep2} 1175*43c1707eStholo\setfont\secsf\sfbshape{12}{\magstep1} 1176*43c1707eStholo\let\secbf\secrm 1177*43c1707eStholo\setfont\secsc\scbshape{10}{\magstep2} 1178*43c1707eStholo\font\seci=cmmi12 scaled \magstep1 1179*43c1707eStholo\font\secsy=cmsy10 scaled \magstep2 1180*43c1707eStholo 1181*43c1707eStholo% \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad. 1182*43c1707eStholo% \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded. 1183*43c1707eStholo% \setfont\ssecsl\slshape{10}{\magstep1} 1184*43c1707eStholo% \setfont\ssectt\ttshape{10}{\magstep1} 1185*43c1707eStholo% \setfont\ssecsf\sfshape{10}{\magstep1} 1186*43c1707eStholo 1187*43c1707eStholo%\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx. 1188*43c1707eStholo%\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than 1189*43c1707eStholo%\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1. 1190*43c1707eStholo%\setfont\ssectt\ttshape{10}{1315} 1191*43c1707eStholo%\setfont\ssecsf\sfshape{10}{1315} 1192*43c1707eStholo 1193*43c1707eStholo%\let\ssecbf=\ssecrm 1194*43c1707eStholo 1195*43c1707eStholo% Subsection fonts (13.15pt). 1196*43c1707eStholo\setfont\ssecrm\rmbshape{12}{\magstephalf} 1197*43c1707eStholo\setfont\ssecit\itbshape{10}{1315} 1198*43c1707eStholo\setfont\ssecsl\slbshape{10}{1315} 1199*43c1707eStholo\setfont\ssectt\ttbshape{12}{\magstephalf} 1200*43c1707eStholo\setfont\ssecttsl\ttslshape{10}{1315} 1201*43c1707eStholo\setfont\ssecsf\sfbshape{12}{\magstephalf} 1202*43c1707eStholo\let\ssecbf\ssecrm 1203*43c1707eStholo\setfont\ssecsc\scbshape{10}{\magstep1} 1204*43c1707eStholo\font\sseci=cmmi12 scaled \magstephalf 1205*43c1707eStholo\font\ssecsy=cmsy10 scaled 1315 1206*43c1707eStholo% The smallcaps and symbol fonts should actually be scaled \magstep1.5, 1207*43c1707eStholo% but that is not a standard magnification. 1208*43c1707eStholo 1209*43c1707eStholo% In order for the font changes to affect most math symbols and letters, 1210*43c1707eStholo% we have to define the \textfont of the standard families. Since 1211*43c1707eStholo% texinfo doesn't allow for producing subscripts and superscripts, we 1212*43c1707eStholo% don't bother to reset \scriptfont and \scriptscriptfont (which would 1213*43c1707eStholo% also require loading a lot more fonts). 1214*43c1707eStholo% 1215*43c1707eStholo\def\resetmathfonts{% 1216*43c1707eStholo \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy 1217*43c1707eStholo \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf 1218*43c1707eStholo \textfont\ttfam = \tentt \textfont\sffam = \tensf 1219*43c1707eStholo} 1220*43c1707eStholo 1221*43c1707eStholo 1222*43c1707eStholo% The font-changing commands redefine the meanings of \tenSTYLE, instead 1223*43c1707eStholo% of just \STYLE. We do this so that font changes will continue to work 1224*43c1707eStholo% in math mode, where it is the current \fam that is relevant in most 1225*43c1707eStholo% cases, not the current font. Plain TeX does \def\bf{\fam=\bffam 1226*43c1707eStholo% \tenbf}, for example. By redefining \tenbf, we obviate the need to 1227*43c1707eStholo% redefine \bf itself. 1228*43c1707eStholo\def\textfonts{% 1229*43c1707eStholo \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl 1230*43c1707eStholo \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc 1231*43c1707eStholo \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl 1232*43c1707eStholo \resetmathfonts} 1233*43c1707eStholo\def\titlefonts{% 1234*43c1707eStholo \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl 1235*43c1707eStholo \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc 1236*43c1707eStholo \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy 1237*43c1707eStholo \let\tenttsl=\titlettsl 1238*43c1707eStholo \resetmathfonts \setleading{25pt}} 1239*43c1707eStholo\def\titlefont#1{{\titlefonts\rm #1}} 1240*43c1707eStholo\def\chapfonts{% 1241*43c1707eStholo \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl 1242*43c1707eStholo \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc 1243*43c1707eStholo \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl 1244*43c1707eStholo \resetmathfonts \setleading{19pt}} 1245*43c1707eStholo\def\secfonts{% 1246*43c1707eStholo \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl 1247*43c1707eStholo \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc 1248*43c1707eStholo \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl 1249*43c1707eStholo \resetmathfonts \setleading{16pt}} 1250*43c1707eStholo\def\subsecfonts{% 1251*43c1707eStholo \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl 1252*43c1707eStholo \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc 1253*43c1707eStholo \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl 1254*43c1707eStholo \resetmathfonts \setleading{15pt}} 1255*43c1707eStholo\let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf? 1256*43c1707eStholo\def\smallfonts{% 1257*43c1707eStholo \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl 1258*43c1707eStholo \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc 1259*43c1707eStholo \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy 1260*43c1707eStholo \let\tenttsl=\smallttsl 1261*43c1707eStholo \resetmathfonts \setleading{11pt}} 1262*43c1707eStholo 1263*43c1707eStholo% Set up the default fonts, so we can use them for creating boxes. 1264*43c1707eStholo% 1265*43c1707eStholo\textfonts 1266*43c1707eStholo 1267*43c1707eStholo% Define these so they can be easily changed for other fonts. 1268*43c1707eStholo\def\angleleft{$\langle$} 1269*43c1707eStholo\def\angleright{$\rangle$} 1270*43c1707eStholo 1271*43c1707eStholo% Count depth in font-changes, for error checks 1272*43c1707eStholo\newcount\fontdepth \fontdepth=0 1273*43c1707eStholo 1274*43c1707eStholo% Fonts for short table of contents. 1275*43c1707eStholo\setfont\shortcontrm\rmshape{12}{1000} 1276*43c1707eStholo\setfont\shortcontbf\bxshape{12}{1000} 1277*43c1707eStholo\setfont\shortcontsl\slshape{12}{1000} 1278*43c1707eStholo 1279*43c1707eStholo%% Add scribe-like font environments, plus @l for inline lisp (usually sans 1280*43c1707eStholo%% serif) and @ii for TeX italic 1281*43c1707eStholo 1282*43c1707eStholo% \smartitalic{ARG} outputs arg in italics, followed by an italic correction 1283*43c1707eStholo% unless the following character is such as not to need one. 1284*43c1707eStholo\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi} 1285*43c1707eStholo\def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx} 1286*43c1707eStholo\def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx} 1287*43c1707eStholo 1288*43c1707eStholo\let\i=\smartitalic 1289*43c1707eStholo\let\var=\smartslanted 1290*43c1707eStholo\let\dfn=\smartslanted 1291*43c1707eStholo\let\emph=\smartitalic 1292*43c1707eStholo\let\cite=\smartslanted 1293*43c1707eStholo 1294*43c1707eStholo\def\b#1{{\bf #1}} 1295*43c1707eStholo\let\strong=\b 1296*43c1707eStholo 1297*43c1707eStholo% We can't just use \exhyphenpenalty, because that only has effect at 1298*43c1707eStholo% the end of a paragraph. Restore normal hyphenation at the end of the 1299*43c1707eStholo% group within which \nohyphenation is presumably called. 1300*43c1707eStholo% 1301*43c1707eStholo\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} 1302*43c1707eStholo\def\restorehyphenation{\hyphenchar\font = `- } 1303*43c1707eStholo 1304*43c1707eStholo\def\t#1{% 1305*43c1707eStholo {\tt \rawbackslash \frenchspacing #1}% 1306*43c1707eStholo \null 1307*43c1707eStholo} 1308*43c1707eStholo\let\ttfont=\t 1309*43c1707eStholo\def\samp#1{`\tclose{#1}'\null} 1310*43c1707eStholo\setfont\keyrm\rmshape{8}{1000} 1311*43c1707eStholo\font\keysy=cmsy9 1312*43c1707eStholo\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% 1313*43c1707eStholo \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% 1314*43c1707eStholo \vbox{\hrule\kern-0.4pt 1315*43c1707eStholo \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% 1316*43c1707eStholo \kern-0.4pt\hrule}% 1317*43c1707eStholo \kern-.06em\raise0.4pt\hbox{\angleright}}}} 1318*43c1707eStholo% The old definition, with no lozenge: 1319*43c1707eStholo%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} 1320*43c1707eStholo\def\ctrl #1{{\tt \rawbackslash \hat}#1} 1321*43c1707eStholo 1322*43c1707eStholo% @file, @option are the same as @samp. 1323*43c1707eStholo\let\file=\samp 1324*43c1707eStholo\let\option=\samp 1325*43c1707eStholo 1326*43c1707eStholo% @code is a modification of @t, 1327*43c1707eStholo% which makes spaces the same size as normal in the surrounding text. 1328*43c1707eStholo\def\tclose#1{% 1329*43c1707eStholo {% 1330*43c1707eStholo % Change normal interword space to be same as for the current font. 1331*43c1707eStholo \spaceskip = \fontdimen2\font 1332*43c1707eStholo % 1333*43c1707eStholo % Switch to typewriter. 1334*43c1707eStholo \tt 1335*43c1707eStholo % 1336*43c1707eStholo % But `\ ' produces the large typewriter interword space. 1337*43c1707eStholo \def\ {{\spaceskip = 0pt{} }}% 1338*43c1707eStholo % 1339*43c1707eStholo % Turn off hyphenation. 1340*43c1707eStholo \nohyphenation 1341*43c1707eStholo % 1342*43c1707eStholo \rawbackslash 1343*43c1707eStholo \frenchspacing 1344*43c1707eStholo #1% 1345*43c1707eStholo }% 1346*43c1707eStholo \null 1347*43c1707eStholo} 1348*43c1707eStholo 1349*43c1707eStholo% We *must* turn on hyphenation at `-' and `_' in \code. 1350*43c1707eStholo% Otherwise, it is too hard to avoid overfull hboxes 1351*43c1707eStholo% in the Emacs manual, the Library manual, etc. 1352*43c1707eStholo 1353*43c1707eStholo% Unfortunately, TeX uses one parameter (\hyphenchar) to control 1354*43c1707eStholo% both hyphenation at - and hyphenation within words. 1355*43c1707eStholo% We must therefore turn them both off (\tclose does that) 1356*43c1707eStholo% and arrange explicitly to hyphenate at a dash. 1357*43c1707eStholo% -- rms. 1358*43c1707eStholo{ 1359*43c1707eStholo \catcode`\-=\active 1360*43c1707eStholo \catcode`\_=\active 1361*43c1707eStholo % 1362*43c1707eStholo \global\def\code{\begingroup 1363*43c1707eStholo \catcode`\-=\active \let-\codedash 1364*43c1707eStholo \catcode`\_=\active \let_\codeunder 1365*43c1707eStholo \codex 1366*43c1707eStholo } 1367*43c1707eStholo % 1368*43c1707eStholo % If we end up with any active - characters when handling the index, 1369*43c1707eStholo % just treat them as a normal -. 1370*43c1707eStholo \global\def\indexbreaks{\catcode`\-=\active \let-\realdash} 1371*43c1707eStholo} 1372*43c1707eStholo 1373*43c1707eStholo\def\realdash{-} 1374*43c1707eStholo\def\codedash{-\discretionary{}{}{}} 1375*43c1707eStholo\def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}} 1376*43c1707eStholo\def\codex #1{\tclose{#1}\endgroup} 1377*43c1707eStholo 1378*43c1707eStholo%\let\exp=\tclose %Was temporary 1379*43c1707eStholo 1380*43c1707eStholo% @kbd is like @code, except that if the argument is just one @key command, 1381*43c1707eStholo% then @kbd has no effect. 1382*43c1707eStholo 1383*43c1707eStholo% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), 1384*43c1707eStholo% `example' (@kbd uses ttsl only inside of @example and friends), 1385*43c1707eStholo% or `code' (@kbd uses normal tty font always). 1386*43c1707eStholo\def\kbdinputstyle{\parsearg\kbdinputstylexxx} 1387*43c1707eStholo\def\kbdinputstylexxx#1{% 1388*43c1707eStholo \def\arg{#1}% 1389*43c1707eStholo \ifx\arg\worddistinct 1390*43c1707eStholo \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% 1391*43c1707eStholo \else\ifx\arg\wordexample 1392*43c1707eStholo \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% 1393*43c1707eStholo \else\ifx\arg\wordcode 1394*43c1707eStholo \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% 1395*43c1707eStholo \fi\fi\fi 1396*43c1707eStholo} 1397*43c1707eStholo\def\worddistinct{distinct} 1398*43c1707eStholo\def\wordexample{example} 1399*43c1707eStholo\def\wordcode{code} 1400*43c1707eStholo 1401*43c1707eStholo% Default is kbdinputdistinct. (Too much of a hassle to call the macro, 1402*43c1707eStholo% the catcodes are wrong for parsearg to work.) 1403*43c1707eStholo\gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl} 1404*43c1707eStholo 1405*43c1707eStholo\def\xkey{\key} 1406*43c1707eStholo\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% 1407*43c1707eStholo\ifx\one\xkey\ifx\threex\three \key{#2}% 1408*43c1707eStholo\else{\tclose{\kbdfont\look}}\fi 1409*43c1707eStholo\else{\tclose{\kbdfont\look}}\fi} 1410*43c1707eStholo 1411*43c1707eStholo% For @url, @env, @command quotes seem unnecessary, so use \code. 1412*43c1707eStholo\let\url=\code 1413*43c1707eStholo\let\env=\code 1414*43c1707eStholo\let\command=\code 1415*43c1707eStholo 1416*43c1707eStholo% @uref (abbreviation for `urlref') takes an optional (comma-separated) 1417*43c1707eStholo% second argument specifying the text to display and an optional third 1418*43c1707eStholo% arg as text to display instead of (rather than in addition to) the url 1419*43c1707eStholo% itself. First (mandatory) arg is the url. Perhaps eventually put in 1420*43c1707eStholo% a hypertex \special here. 1421*43c1707eStholo% 1422*43c1707eStholo\def\uref#1{\douref #1,,,\finish} 1423*43c1707eStholo\def\douref#1,#2,#3,#4\finish{\begingroup 1424*43c1707eStholo \unsepspaces 1425*43c1707eStholo \pdfurl{#1}% 1426*43c1707eStholo \setbox0 = \hbox{\ignorespaces #3}% 1427*43c1707eStholo \ifdim\wd0 > 0pt 1428*43c1707eStholo \unhbox0 % third arg given, show only that 1429*43c1707eStholo \else 1430*43c1707eStholo \setbox0 = \hbox{\ignorespaces #2}% 1431*43c1707eStholo \ifdim\wd0 > 0pt 1432*43c1707eStholo \ifpdf 1433*43c1707eStholo \unhbox0 % PDF: 2nd arg given, show only it 1434*43c1707eStholo \else 1435*43c1707eStholo \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url 1436*43c1707eStholo \fi 1437*43c1707eStholo \else 1438*43c1707eStholo \code{#1}% only url given, so show it 1439*43c1707eStholo \fi 1440*43c1707eStholo \fi 1441*43c1707eStholo \endlink 1442*43c1707eStholo\endgroup} 1443*43c1707eStholo 1444*43c1707eStholo% rms does not like angle brackets --karl, 17may97. 1445*43c1707eStholo% So now @email is just like @uref, unless we are pdf. 1446*43c1707eStholo% 1447*43c1707eStholo%\def\email#1{\angleleft{\tt #1}\angleright} 1448*43c1707eStholo\ifpdf 1449*43c1707eStholo \def\email#1{\doemail#1,,\finish} 1450*43c1707eStholo \def\doemail#1,#2,#3\finish{\begingroup 1451*43c1707eStholo \unsepspaces 1452*43c1707eStholo \pdfurl{mailto:#1}% 1453*43c1707eStholo \setbox0 = \hbox{\ignorespaces #2}% 1454*43c1707eStholo \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi 1455*43c1707eStholo \endlink 1456*43c1707eStholo \endgroup} 1457*43c1707eStholo\else 1458*43c1707eStholo \let\email=\uref 1459*43c1707eStholo\fi 1460*43c1707eStholo 1461*43c1707eStholo% Check if we are currently using a typewriter font. Since all the 1462*43c1707eStholo% Computer Modern typewriter fonts have zero interword stretch (and 1463*43c1707eStholo% shrink), and it is reasonable to expect all typewriter fonts to have 1464*43c1707eStholo% this property, we can check that font parameter. 1465*43c1707eStholo% 1466*43c1707eStholo\def\ifmonospace{\ifdim\fontdimen3\font=0pt } 1467*43c1707eStholo 1468*43c1707eStholo% Typeset a dimension, e.g., `in' or `pt'. The only reason for the 1469*43c1707eStholo% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. 1470*43c1707eStholo% 1471*43c1707eStholo\def\dmn#1{\thinspace #1} 1472*43c1707eStholo 1473*43c1707eStholo\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} 1474*43c1707eStholo 1475*43c1707eStholo% @l was never documented to mean ``switch to the Lisp font'', 1476*43c1707eStholo% and it is not used as such in any manual I can find. We need it for 1477*43c1707eStholo% Polish suppressed-l. --karl, 22sep96. 1478*43c1707eStholo%\def\l#1{{\li #1}\null} 1479*43c1707eStholo 1480*43c1707eStholo% Explicit font changes: @r, @sc, undocumented @ii. 1481*43c1707eStholo\def\r#1{{\rm #1}} % roman font 1482*43c1707eStholo\def\sc#1{{\smallcaps#1}} % smallcaps font 1483*43c1707eStholo\def\ii#1{{\it #1}} % italic font 1484*43c1707eStholo 1485*43c1707eStholo% @acronym downcases the argument and prints in smallcaps. 1486*43c1707eStholo\def\acronym#1{{\smallcaps \lowercase{#1}}} 1487*43c1707eStholo 1488*43c1707eStholo% @pounds{} is a sterling sign. 1489*43c1707eStholo\def\pounds{{\it\$}} 1490*43c1707eStholo 1491*43c1707eStholo 1492*43c1707eStholo\message{page headings,} 1493*43c1707eStholo 1494*43c1707eStholo\newskip\titlepagetopglue \titlepagetopglue = 1.5in 1495*43c1707eStholo\newskip\titlepagebottomglue \titlepagebottomglue = 2pc 1496*43c1707eStholo 1497*43c1707eStholo% First the title page. Must do @settitle before @titlepage. 1498*43c1707eStholo\newif\ifseenauthor 1499*43c1707eStholo\newif\iffinishedtitlepage 1500*43c1707eStholo 1501*43c1707eStholo% Do an implicit @contents or @shortcontents after @end titlepage if the 1502*43c1707eStholo% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. 1503*43c1707eStholo% 1504*43c1707eStholo\newif\ifsetcontentsaftertitlepage 1505*43c1707eStholo \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue 1506*43c1707eStholo\newif\ifsetshortcontentsaftertitlepage 1507*43c1707eStholo \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue 1508*43c1707eStholo 1509*43c1707eStholo\def\shorttitlepage{\parsearg\shorttitlepagezzz} 1510*43c1707eStholo\def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% 1511*43c1707eStholo \endgroup\page\hbox{}\page} 1512*43c1707eStholo 1513*43c1707eStholo\def\titlepage{\begingroup \parindent=0pt \textfonts 1514*43c1707eStholo \let\subtitlerm=\tenrm 1515*43c1707eStholo \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}% 1516*43c1707eStholo % 1517*43c1707eStholo \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}% 1518*43c1707eStholo % 1519*43c1707eStholo % Leave some space at the very top of the page. 1520*43c1707eStholo \vglue\titlepagetopglue 1521*43c1707eStholo % 1522*43c1707eStholo % Now you can print the title using @title. 1523*43c1707eStholo \def\title{\parsearg\titlezzz}% 1524*43c1707eStholo \def\titlezzz##1{\leftline{\titlefonts\rm ##1} 1525*43c1707eStholo % print a rule at the page bottom also. 1526*43c1707eStholo \finishedtitlepagefalse 1527*43c1707eStholo \vskip4pt \hrule height 4pt width \hsize \vskip4pt}% 1528*43c1707eStholo % No rule at page bottom unless we print one at the top with @title. 1529*43c1707eStholo \finishedtitlepagetrue 1530*43c1707eStholo % 1531*43c1707eStholo % Now you can put text using @subtitle. 1532*43c1707eStholo \def\subtitle{\parsearg\subtitlezzz}% 1533*43c1707eStholo \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}% 1534*43c1707eStholo % 1535*43c1707eStholo % @author should come last, but may come many times. 1536*43c1707eStholo \def\author{\parsearg\authorzzz}% 1537*43c1707eStholo \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi 1538*43c1707eStholo {\authorfont \leftline{##1}}}% 1539*43c1707eStholo % 1540*43c1707eStholo % Most title ``pages'' are actually two pages long, with space 1541*43c1707eStholo % at the top of the second. We don't want the ragged left on the second. 1542*43c1707eStholo \let\oldpage = \page 1543*43c1707eStholo \def\page{% 1544*43c1707eStholo \iffinishedtitlepage\else 1545*43c1707eStholo \finishtitlepage 1546*43c1707eStholo \fi 1547*43c1707eStholo \oldpage 1548*43c1707eStholo \let\page = \oldpage 1549*43c1707eStholo \hbox{}}% 1550*43c1707eStholo% \def\page{\oldpage \hbox{}} 1551*43c1707eStholo} 1552*43c1707eStholo 1553*43c1707eStholo\def\Etitlepage{% 1554*43c1707eStholo \iffinishedtitlepage\else 1555*43c1707eStholo \finishtitlepage 1556*43c1707eStholo \fi 1557*43c1707eStholo % It is important to do the page break before ending the group, 1558*43c1707eStholo % because the headline and footline are only empty inside the group. 1559*43c1707eStholo % If we use the new definition of \page, we always get a blank page 1560*43c1707eStholo % after the title page, which we certainly don't want. 1561*43c1707eStholo \oldpage 1562*43c1707eStholo \endgroup 1563*43c1707eStholo % 1564*43c1707eStholo % If they want short, they certainly want long too. 1565*43c1707eStholo \ifsetshortcontentsaftertitlepage 1566*43c1707eStholo \shortcontents 1567*43c1707eStholo \contents 1568*43c1707eStholo \global\let\shortcontents = \relax 1569*43c1707eStholo \global\let\contents = \relax 1570*43c1707eStholo \fi 1571*43c1707eStholo % 1572*43c1707eStholo \ifsetcontentsaftertitlepage 1573*43c1707eStholo \contents 1574*43c1707eStholo \global\let\contents = \relax 1575*43c1707eStholo \global\let\shortcontents = \relax 1576*43c1707eStholo \fi 1577*43c1707eStholo % 1578*43c1707eStholo \ifpdf \pdfmakepagedesttrue \fi 1579*43c1707eStholo % 1580*43c1707eStholo \HEADINGSon 1581*43c1707eStholo} 1582*43c1707eStholo 1583*43c1707eStholo\def\finishtitlepage{% 1584*43c1707eStholo \vskip4pt \hrule height 2pt width \hsize 1585*43c1707eStholo \vskip\titlepagebottomglue 1586*43c1707eStholo \finishedtitlepagetrue 1587*43c1707eStholo} 1588*43c1707eStholo 1589*43c1707eStholo%%% Set up page headings and footings. 1590*43c1707eStholo 1591*43c1707eStholo\let\thispage=\folio 1592*43c1707eStholo 1593*43c1707eStholo\newtoks\evenheadline % headline on even pages 1594*43c1707eStholo\newtoks\oddheadline % headline on odd pages 1595*43c1707eStholo\newtoks\evenfootline % footline on even pages 1596*43c1707eStholo\newtoks\oddfootline % footline on odd pages 1597*43c1707eStholo 1598*43c1707eStholo% Now make Tex use those variables 1599*43c1707eStholo\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline 1600*43c1707eStholo \else \the\evenheadline \fi}} 1601*43c1707eStholo\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline 1602*43c1707eStholo \else \the\evenfootline \fi}\HEADINGShook} 1603*43c1707eStholo\let\HEADINGShook=\relax 1604*43c1707eStholo 1605*43c1707eStholo% Commands to set those variables. 1606*43c1707eStholo% For example, this is what @headings on does 1607*43c1707eStholo% @evenheading @thistitle|@thispage|@thischapter 1608*43c1707eStholo% @oddheading @thischapter|@thispage|@thistitle 1609*43c1707eStholo% @evenfooting @thisfile|| 1610*43c1707eStholo% @oddfooting ||@thisfile 1611*43c1707eStholo 1612*43c1707eStholo\def\evenheading{\parsearg\evenheadingxxx} 1613*43c1707eStholo\def\oddheading{\parsearg\oddheadingxxx} 1614*43c1707eStholo\def\everyheading{\parsearg\everyheadingxxx} 1615*43c1707eStholo 1616*43c1707eStholo\def\evenfooting{\parsearg\evenfootingxxx} 1617*43c1707eStholo\def\oddfooting{\parsearg\oddfootingxxx} 1618*43c1707eStholo\def\everyfooting{\parsearg\everyfootingxxx} 1619*43c1707eStholo 1620*43c1707eStholo{\catcode`\@=0 % 1621*43c1707eStholo 1622*43c1707eStholo\gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish} 1623*43c1707eStholo\gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{% 1624*43c1707eStholo\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 1625*43c1707eStholo 1626*43c1707eStholo\gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish} 1627*43c1707eStholo\gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{% 1628*43c1707eStholo\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 1629*43c1707eStholo 1630*43c1707eStholo\gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}% 1631*43c1707eStholo 1632*43c1707eStholo\gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish} 1633*43c1707eStholo\gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{% 1634*43c1707eStholo\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 1635*43c1707eStholo 1636*43c1707eStholo\gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish} 1637*43c1707eStholo\gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{% 1638*43c1707eStholo \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% 1639*43c1707eStholo % 1640*43c1707eStholo % Leave some space for the footline. Hopefully ok to assume 1641*43c1707eStholo % @evenfooting will not be used by itself. 1642*43c1707eStholo \global\advance\pageheight by -\baselineskip 1643*43c1707eStholo \global\advance\vsize by -\baselineskip 1644*43c1707eStholo} 1645*43c1707eStholo 1646*43c1707eStholo\gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}} 1647*43c1707eStholo% 1648*43c1707eStholo}% unbind the catcode of @. 1649*43c1707eStholo 1650*43c1707eStholo% @headings double turns headings on for double-sided printing. 1651*43c1707eStholo% @headings single turns headings on for single-sided printing. 1652*43c1707eStholo% @headings off turns them off. 1653*43c1707eStholo% @headings on same as @headings double, retained for compatibility. 1654*43c1707eStholo% @headings after turns on double-sided headings after this page. 1655*43c1707eStholo% @headings doubleafter turns on double-sided headings after this page. 1656*43c1707eStholo% @headings singleafter turns on single-sided headings after this page. 1657*43c1707eStholo% By default, they are off at the start of a document, 1658*43c1707eStholo% and turned `on' after @end titlepage. 1659*43c1707eStholo 1660*43c1707eStholo\def\headings #1 {\csname HEADINGS#1\endcsname} 1661*43c1707eStholo 1662*43c1707eStholo\def\HEADINGSoff{ 1663*43c1707eStholo\global\evenheadline={\hfil} \global\evenfootline={\hfil} 1664*43c1707eStholo\global\oddheadline={\hfil} \global\oddfootline={\hfil}} 1665*43c1707eStholo\HEADINGSoff 1666*43c1707eStholo% When we turn headings on, set the page number to 1. 1667*43c1707eStholo% For double-sided printing, put current file name in lower left corner, 1668*43c1707eStholo% chapter name on inside top of right hand pages, document 1669*43c1707eStholo% title on inside top of left hand pages, and page numbers on outside top 1670*43c1707eStholo% edge of all pages. 1671*43c1707eStholo\def\HEADINGSdouble{ 1672*43c1707eStholo\global\pageno=1 1673*43c1707eStholo\global\evenfootline={\hfil} 1674*43c1707eStholo\global\oddfootline={\hfil} 1675*43c1707eStholo\global\evenheadline={\line{\folio\hfil\thistitle}} 1676*43c1707eStholo\global\oddheadline={\line{\thischapter\hfil\folio}} 1677*43c1707eStholo\global\let\contentsalignmacro = \chapoddpage 1678*43c1707eStholo} 1679*43c1707eStholo\let\contentsalignmacro = \chappager 1680*43c1707eStholo 1681*43c1707eStholo% For single-sided printing, chapter title goes across top left of page, 1682*43c1707eStholo% page number on top right. 1683*43c1707eStholo\def\HEADINGSsingle{ 1684*43c1707eStholo\global\pageno=1 1685*43c1707eStholo\global\evenfootline={\hfil} 1686*43c1707eStholo\global\oddfootline={\hfil} 1687*43c1707eStholo\global\evenheadline={\line{\thischapter\hfil\folio}} 1688*43c1707eStholo\global\oddheadline={\line{\thischapter\hfil\folio}} 1689*43c1707eStholo\global\let\contentsalignmacro = \chappager 1690*43c1707eStholo} 1691*43c1707eStholo\def\HEADINGSon{\HEADINGSdouble} 1692*43c1707eStholo 1693*43c1707eStholo\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} 1694*43c1707eStholo\let\HEADINGSdoubleafter=\HEADINGSafter 1695*43c1707eStholo\def\HEADINGSdoublex{% 1696*43c1707eStholo\global\evenfootline={\hfil} 1697*43c1707eStholo\global\oddfootline={\hfil} 1698*43c1707eStholo\global\evenheadline={\line{\folio\hfil\thistitle}} 1699*43c1707eStholo\global\oddheadline={\line{\thischapter\hfil\folio}} 1700*43c1707eStholo\global\let\contentsalignmacro = \chapoddpage 1701*43c1707eStholo} 1702*43c1707eStholo 1703*43c1707eStholo\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} 1704*43c1707eStholo\def\HEADINGSsinglex{% 1705*43c1707eStholo\global\evenfootline={\hfil} 1706*43c1707eStholo\global\oddfootline={\hfil} 1707*43c1707eStholo\global\evenheadline={\line{\thischapter\hfil\folio}} 1708*43c1707eStholo\global\oddheadline={\line{\thischapter\hfil\folio}} 1709*43c1707eStholo\global\let\contentsalignmacro = \chappager 1710*43c1707eStholo} 1711*43c1707eStholo 1712*43c1707eStholo% Subroutines used in generating headings 1713*43c1707eStholo% This produces Day Month Year style of output. 1714*43c1707eStholo% Only define if not already defined, in case a txi-??.tex file has set 1715*43c1707eStholo% up a different format (e.g., txi-cs.tex does this). 1716*43c1707eStholo\ifx\today\undefined 1717*43c1707eStholo\def\today{% 1718*43c1707eStholo \number\day\space 1719*43c1707eStholo \ifcase\month 1720*43c1707eStholo \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr 1721*43c1707eStholo \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug 1722*43c1707eStholo \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec 1723*43c1707eStholo \fi 1724*43c1707eStholo \space\number\year} 1725*43c1707eStholo\fi 1726*43c1707eStholo 1727*43c1707eStholo% @settitle line... specifies the title of the document, for headings. 1728*43c1707eStholo% It generates no output of its own. 1729*43c1707eStholo\def\thistitle{\putwordNoTitle} 1730*43c1707eStholo\def\settitle{\parsearg\settitlezzz} 1731*43c1707eStholo\def\settitlezzz #1{\gdef\thistitle{#1}} 1732*43c1707eStholo 1733*43c1707eStholo 1734*43c1707eStholo\message{tables,} 1735*43c1707eStholo% Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x). 1736*43c1707eStholo 1737*43c1707eStholo% default indentation of table text 1738*43c1707eStholo\newdimen\tableindent \tableindent=.8in 1739*43c1707eStholo% default indentation of @itemize and @enumerate text 1740*43c1707eStholo\newdimen\itemindent \itemindent=.3in 1741*43c1707eStholo% margin between end of table item and start of table text. 1742*43c1707eStholo\newdimen\itemmargin \itemmargin=.1in 1743*43c1707eStholo 1744*43c1707eStholo% used internally for \itemindent minus \itemmargin 1745*43c1707eStholo\newdimen\itemmax 1746*43c1707eStholo 1747*43c1707eStholo% Note @table, @vtable, and @vtable define @item, @itemx, etc., with 1748*43c1707eStholo% these defs. 1749*43c1707eStholo% They also define \itemindex 1750*43c1707eStholo% to index the item name in whatever manner is desired (perhaps none). 1751*43c1707eStholo 1752*43c1707eStholo\newif\ifitemxneedsnegativevskip 1753*43c1707eStholo 1754*43c1707eStholo\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} 1755*43c1707eStholo 1756*43c1707eStholo\def\internalBitem{\smallbreak \parsearg\itemzzz} 1757*43c1707eStholo\def\internalBitemx{\itemxpar \parsearg\itemzzz} 1758*43c1707eStholo 1759*43c1707eStholo\def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz} 1760*43c1707eStholo\def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz} 1761*43c1707eStholo 1762*43c1707eStholo\def\internalBkitem{\smallbreak \parsearg\kitemzzz} 1763*43c1707eStholo\def\internalBkitemx{\itemxpar \parsearg\kitemzzz} 1764*43c1707eStholo 1765*43c1707eStholo\def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}% 1766*43c1707eStholo \itemzzz {#1}} 1767*43c1707eStholo 1768*43c1707eStholo\def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}% 1769*43c1707eStholo \itemzzz {#1}} 1770*43c1707eStholo 1771*43c1707eStholo\def\itemzzz #1{\begingroup % 1772*43c1707eStholo \advance\hsize by -\rightskip 1773*43c1707eStholo \advance\hsize by -\tableindent 1774*43c1707eStholo \setbox0=\hbox{\itemfont{#1}}% 1775*43c1707eStholo \itemindex{#1}% 1776*43c1707eStholo \nobreak % This prevents a break before @itemx. 1777*43c1707eStholo % 1778*43c1707eStholo % If the item text does not fit in the space we have, put it on a line 1779*43c1707eStholo % by itself, and do not allow a page break either before or after that 1780*43c1707eStholo % line. We do not start a paragraph here because then if the next 1781*43c1707eStholo % command is, e.g., @kindex, the whatsit would get put into the 1782*43c1707eStholo % horizontal list on a line by itself, resulting in extra blank space. 1783*43c1707eStholo \ifdim \wd0>\itemmax 1784*43c1707eStholo % 1785*43c1707eStholo % Make this a paragraph so we get the \parskip glue and wrapping, 1786*43c1707eStholo % but leave it ragged-right. 1787*43c1707eStholo \begingroup 1788*43c1707eStholo \advance\leftskip by-\tableindent 1789*43c1707eStholo \advance\hsize by\tableindent 1790*43c1707eStholo \advance\rightskip by0pt plus1fil 1791*43c1707eStholo \leavevmode\unhbox0\par 1792*43c1707eStholo \endgroup 1793*43c1707eStholo % 1794*43c1707eStholo % We're going to be starting a paragraph, but we don't want the 1795*43c1707eStholo % \parskip glue -- logically it's part of the @item we just started. 1796*43c1707eStholo \nobreak \vskip-\parskip 1797*43c1707eStholo % 1798*43c1707eStholo % Stop a page break at the \parskip glue coming up. Unfortunately 1799*43c1707eStholo % we can't prevent a possible page break at the following 1800*43c1707eStholo % \baselineskip glue. 1801*43c1707eStholo \nobreak 1802*43c1707eStholo \endgroup 1803*43c1707eStholo \itemxneedsnegativevskipfalse 1804*43c1707eStholo \else 1805*43c1707eStholo % The item text fits into the space. Start a paragraph, so that the 1806*43c1707eStholo % following text (if any) will end up on the same line. 1807*43c1707eStholo \noindent 1808*43c1707eStholo % Do this with kerns and \unhbox so that if there is a footnote in 1809*43c1707eStholo % the item text, it can migrate to the main vertical list and 1810*43c1707eStholo % eventually be printed. 1811*43c1707eStholo \nobreak\kern-\tableindent 1812*43c1707eStholo \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 1813*43c1707eStholo \unhbox0 1814*43c1707eStholo \nobreak\kern\dimen0 1815*43c1707eStholo \endgroup 1816*43c1707eStholo \itemxneedsnegativevskiptrue 1817*43c1707eStholo \fi 1818*43c1707eStholo} 1819*43c1707eStholo 1820*43c1707eStholo\def\item{\errmessage{@item while not in a table}} 1821*43c1707eStholo\def\itemx{\errmessage{@itemx while not in a table}} 1822*43c1707eStholo\def\kitem{\errmessage{@kitem while not in a table}} 1823*43c1707eStholo\def\kitemx{\errmessage{@kitemx while not in a table}} 1824*43c1707eStholo\def\xitem{\errmessage{@xitem while not in a table}} 1825*43c1707eStholo\def\xitemx{\errmessage{@xitemx while not in a table}} 1826*43c1707eStholo 1827*43c1707eStholo% Contains a kludge to get @end[description] to work. 1828*43c1707eStholo\def\description{\tablez{\dontindex}{1}{}{}{}{}} 1829*43c1707eStholo 1830*43c1707eStholo% @table, @ftable, @vtable. 1831*43c1707eStholo\def\table{\begingroup\inENV\obeylines\obeyspaces\tablex} 1832*43c1707eStholo{\obeylines\obeyspaces% 1833*43c1707eStholo\gdef\tablex #1^^M{% 1834*43c1707eStholo\tabley\dontindex#1 \endtabley}} 1835*43c1707eStholo 1836*43c1707eStholo\def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex} 1837*43c1707eStholo{\obeylines\obeyspaces% 1838*43c1707eStholo\gdef\ftablex #1^^M{% 1839*43c1707eStholo\tabley\fnitemindex#1 \endtabley 1840*43c1707eStholo\def\Eftable{\endgraf\afterenvbreak\endgroup}% 1841*43c1707eStholo\let\Etable=\relax}} 1842*43c1707eStholo 1843*43c1707eStholo\def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex} 1844*43c1707eStholo{\obeylines\obeyspaces% 1845*43c1707eStholo\gdef\vtablex #1^^M{% 1846*43c1707eStholo\tabley\vritemindex#1 \endtabley 1847*43c1707eStholo\def\Evtable{\endgraf\afterenvbreak\endgroup}% 1848*43c1707eStholo\let\Etable=\relax}} 1849*43c1707eStholo 1850*43c1707eStholo\def\dontindex #1{} 1851*43c1707eStholo\def\fnitemindex #1{\doind {fn}{\code{#1}}}% 1852*43c1707eStholo\def\vritemindex #1{\doind {vr}{\code{#1}}}% 1853*43c1707eStholo 1854*43c1707eStholo{\obeyspaces % 1855*43c1707eStholo\gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup% 1856*43c1707eStholo\tablez{#1}{#2}{#3}{#4}{#5}{#6}}} 1857*43c1707eStholo 1858*43c1707eStholo\def\tablez #1#2#3#4#5#6{% 1859*43c1707eStholo\aboveenvbreak % 1860*43c1707eStholo\begingroup % 1861*43c1707eStholo\def\Edescription{\Etable}% Necessary kludge. 1862*43c1707eStholo\let\itemindex=#1% 1863*43c1707eStholo\ifnum 0#3>0 \advance \leftskip by #3\mil \fi % 1864*43c1707eStholo\ifnum 0#4>0 \tableindent=#4\mil \fi % 1865*43c1707eStholo\ifnum 0#5>0 \advance \rightskip by #5\mil \fi % 1866*43c1707eStholo\def\itemfont{#2}% 1867*43c1707eStholo\itemmax=\tableindent % 1868*43c1707eStholo\advance \itemmax by -\itemmargin % 1869*43c1707eStholo\advance \leftskip by \tableindent % 1870*43c1707eStholo\exdentamount=\tableindent 1871*43c1707eStholo\parindent = 0pt 1872*43c1707eStholo\parskip = \smallskipamount 1873*43c1707eStholo\ifdim \parskip=0pt \parskip=2pt \fi% 1874*43c1707eStholo\def\Etable{\endgraf\afterenvbreak\endgroup}% 1875*43c1707eStholo\let\item = \internalBitem % 1876*43c1707eStholo\let\itemx = \internalBitemx % 1877*43c1707eStholo\let\kitem = \internalBkitem % 1878*43c1707eStholo\let\kitemx = \internalBkitemx % 1879*43c1707eStholo\let\xitem = \internalBxitem % 1880*43c1707eStholo\let\xitemx = \internalBxitemx % 1881*43c1707eStholo} 1882*43c1707eStholo 1883*43c1707eStholo% This is the counter used by @enumerate, which is really @itemize 1884*43c1707eStholo 1885*43c1707eStholo\newcount \itemno 1886*43c1707eStholo 1887*43c1707eStholo\def\itemize{\parsearg\itemizezzz} 1888*43c1707eStholo 1889*43c1707eStholo\def\itemizezzz #1{% 1890*43c1707eStholo \begingroup % ended by the @end itemize 1891*43c1707eStholo \itemizey {#1}{\Eitemize} 1892*43c1707eStholo} 1893*43c1707eStholo 1894*43c1707eStholo\def\itemizey #1#2{% 1895*43c1707eStholo\aboveenvbreak % 1896*43c1707eStholo\itemmax=\itemindent % 1897*43c1707eStholo\advance \itemmax by -\itemmargin % 1898*43c1707eStholo\advance \leftskip by \itemindent % 1899*43c1707eStholo\exdentamount=\itemindent 1900*43c1707eStholo\parindent = 0pt % 1901*43c1707eStholo\parskip = \smallskipamount % 1902*43c1707eStholo\ifdim \parskip=0pt \parskip=2pt \fi% 1903*43c1707eStholo\def#2{\endgraf\afterenvbreak\endgroup}% 1904*43c1707eStholo\def\itemcontents{#1}% 1905*43c1707eStholo\let\item=\itemizeitem} 1906*43c1707eStholo 1907*43c1707eStholo% Set sfcode to normal for the chars that usually have another value. 1908*43c1707eStholo% These are `.?!:;,' 1909*43c1707eStholo\def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000 1910*43c1707eStholo \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 } 1911*43c1707eStholo 1912*43c1707eStholo% \splitoff TOKENS\endmark defines \first to be the first token in 1913*43c1707eStholo% TOKENS, and \rest to be the remainder. 1914*43c1707eStholo% 1915*43c1707eStholo\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% 1916*43c1707eStholo 1917*43c1707eStholo% Allow an optional argument of an uppercase letter, lowercase letter, 1918*43c1707eStholo% or number, to specify the first label in the enumerated list. No 1919*43c1707eStholo% argument is the same as `1'. 1920*43c1707eStholo% 1921*43c1707eStholo\def\enumerate{\parsearg\enumeratezzz} 1922*43c1707eStholo\def\enumeratezzz #1{\enumeratey #1 \endenumeratey} 1923*43c1707eStholo\def\enumeratey #1 #2\endenumeratey{% 1924*43c1707eStholo \begingroup % ended by the @end enumerate 1925*43c1707eStholo % 1926*43c1707eStholo % If we were given no argument, pretend we were given `1'. 1927*43c1707eStholo \def\thearg{#1}% 1928*43c1707eStholo \ifx\thearg\empty \def\thearg{1}\fi 1929*43c1707eStholo % 1930*43c1707eStholo % Detect if the argument is a single token. If so, it might be a 1931*43c1707eStholo % letter. Otherwise, the only valid thing it can be is a number. 1932*43c1707eStholo % (We will always have one token, because of the test we just made. 1933*43c1707eStholo % This is a good thing, since \splitoff doesn't work given nothing at 1934*43c1707eStholo % all -- the first parameter is undelimited.) 1935*43c1707eStholo \expandafter\splitoff\thearg\endmark 1936*43c1707eStholo \ifx\rest\empty 1937*43c1707eStholo % Only one token in the argument. It could still be anything. 1938*43c1707eStholo % A ``lowercase letter'' is one whose \lccode is nonzero. 1939*43c1707eStholo % An ``uppercase letter'' is one whose \lccode is both nonzero, and 1940*43c1707eStholo % not equal to itself. 1941*43c1707eStholo % Otherwise, we assume it's a number. 1942*43c1707eStholo % 1943*43c1707eStholo % We need the \relax at the end of the \ifnum lines to stop TeX from 1944*43c1707eStholo % continuing to look for a <number>. 1945*43c1707eStholo % 1946*43c1707eStholo \ifnum\lccode\expandafter`\thearg=0\relax 1947*43c1707eStholo \numericenumerate % a number (we hope) 1948*43c1707eStholo \else 1949*43c1707eStholo % It's a letter. 1950*43c1707eStholo \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax 1951*43c1707eStholo \lowercaseenumerate % lowercase letter 1952*43c1707eStholo \else 1953*43c1707eStholo \uppercaseenumerate % uppercase letter 1954*43c1707eStholo \fi 1955*43c1707eStholo \fi 1956*43c1707eStholo \else 1957*43c1707eStholo % Multiple tokens in the argument. We hope it's a number. 1958*43c1707eStholo \numericenumerate 1959*43c1707eStholo \fi 1960*43c1707eStholo} 1961*43c1707eStholo 1962*43c1707eStholo% An @enumerate whose labels are integers. The starting integer is 1963*43c1707eStholo% given in \thearg. 1964*43c1707eStholo% 1965*43c1707eStholo\def\numericenumerate{% 1966*43c1707eStholo \itemno = \thearg 1967*43c1707eStholo \startenumeration{\the\itemno}% 1968*43c1707eStholo} 1969*43c1707eStholo 1970*43c1707eStholo% The starting (lowercase) letter is in \thearg. 1971*43c1707eStholo\def\lowercaseenumerate{% 1972*43c1707eStholo \itemno = \expandafter`\thearg 1973*43c1707eStholo \startenumeration{% 1974*43c1707eStholo % Be sure we're not beyond the end of the alphabet. 1975*43c1707eStholo \ifnum\itemno=0 1976*43c1707eStholo \errmessage{No more lowercase letters in @enumerate; get a bigger 1977*43c1707eStholo alphabet}% 1978*43c1707eStholo \fi 1979*43c1707eStholo \char\lccode\itemno 1980*43c1707eStholo }% 1981*43c1707eStholo} 1982*43c1707eStholo 1983*43c1707eStholo% The starting (uppercase) letter is in \thearg. 1984*43c1707eStholo\def\uppercaseenumerate{% 1985*43c1707eStholo \itemno = \expandafter`\thearg 1986*43c1707eStholo \startenumeration{% 1987*43c1707eStholo % Be sure we're not beyond the end of the alphabet. 1988*43c1707eStholo \ifnum\itemno=0 1989*43c1707eStholo \errmessage{No more uppercase letters in @enumerate; get a bigger 1990*43c1707eStholo alphabet} 1991*43c1707eStholo \fi 1992*43c1707eStholo \char\uccode\itemno 1993*43c1707eStholo }% 1994*43c1707eStholo} 1995*43c1707eStholo 1996*43c1707eStholo% Call itemizey, adding a period to the first argument and supplying the 1997*43c1707eStholo% common last two arguments. Also subtract one from the initial value in 1998*43c1707eStholo% \itemno, since @item increments \itemno. 1999*43c1707eStholo% 2000*43c1707eStholo\def\startenumeration#1{% 2001*43c1707eStholo \advance\itemno by -1 2002*43c1707eStholo \itemizey{#1.}\Eenumerate\flushcr 2003*43c1707eStholo} 2004*43c1707eStholo 2005*43c1707eStholo% @alphaenumerate and @capsenumerate are abbreviations for giving an arg 2006*43c1707eStholo% to @enumerate. 2007*43c1707eStholo% 2008*43c1707eStholo\def\alphaenumerate{\enumerate{a}} 2009*43c1707eStholo\def\capsenumerate{\enumerate{A}} 2010*43c1707eStholo\def\Ealphaenumerate{\Eenumerate} 2011*43c1707eStholo\def\Ecapsenumerate{\Eenumerate} 2012*43c1707eStholo 2013*43c1707eStholo% Definition of @item while inside @itemize. 2014*43c1707eStholo 2015*43c1707eStholo\def\itemizeitem{% 2016*43c1707eStholo\advance\itemno by 1 2017*43c1707eStholo{\let\par=\endgraf \smallbreak}% 2018*43c1707eStholo\ifhmode \errmessage{In hmode at itemizeitem}\fi 2019*43c1707eStholo{\parskip=0in \hskip 0pt 2020*43c1707eStholo\hbox to 0pt{\hss \itemcontents\hskip \itemmargin}% 2021*43c1707eStholo\vadjust{\penalty 1200}}% 2022*43c1707eStholo\flushcr} 2023*43c1707eStholo 2024*43c1707eStholo% @multitable macros 2025*43c1707eStholo% Amy Hendrickson, 8/18/94, 3/6/96 2026*43c1707eStholo% 2027*43c1707eStholo% @multitable ... @end multitable will make as many columns as desired. 2028*43c1707eStholo% Contents of each column will wrap at width given in preamble. Width 2029*43c1707eStholo% can be specified either with sample text given in a template line, 2030*43c1707eStholo% or in percent of \hsize, the current width of text on page. 2031*43c1707eStholo 2032*43c1707eStholo% Table can continue over pages but will only break between lines. 2033*43c1707eStholo 2034*43c1707eStholo% To make preamble: 2035*43c1707eStholo% 2036*43c1707eStholo% Either define widths of columns in terms of percent of \hsize: 2037*43c1707eStholo% @multitable @columnfractions .25 .3 .45 2038*43c1707eStholo% @item ... 2039*43c1707eStholo% 2040*43c1707eStholo% Numbers following @columnfractions are the percent of the total 2041*43c1707eStholo% current hsize to be used for each column. You may use as many 2042*43c1707eStholo% columns as desired. 2043*43c1707eStholo 2044*43c1707eStholo 2045*43c1707eStholo% Or use a template: 2046*43c1707eStholo% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 2047*43c1707eStholo% @item ... 2048*43c1707eStholo% using the widest term desired in each column. 2049*43c1707eStholo% 2050*43c1707eStholo% For those who want to use more than one line's worth of words in 2051*43c1707eStholo% the preamble, break the line within one argument and it 2052*43c1707eStholo% will parse correctly, i.e., 2053*43c1707eStholo% 2054*43c1707eStholo% @multitable {Column 1 template} {Column 2 template} {Column 3 2055*43c1707eStholo% template} 2056*43c1707eStholo% Not: 2057*43c1707eStholo% @multitable {Column 1 template} {Column 2 template} 2058*43c1707eStholo% {Column 3 template} 2059*43c1707eStholo 2060*43c1707eStholo% Each new table line starts with @item, each subsequent new column 2061*43c1707eStholo% starts with @tab. Empty columns may be produced by supplying @tab's 2062*43c1707eStholo% with nothing between them for as many times as empty columns are needed, 2063*43c1707eStholo% ie, @tab@tab@tab will produce two empty columns. 2064*43c1707eStholo 2065*43c1707eStholo% @item, @tab, @multitable or @end multitable do not need to be on their 2066*43c1707eStholo% own lines, but it will not hurt if they are. 2067*43c1707eStholo 2068*43c1707eStholo% Sample multitable: 2069*43c1707eStholo 2070*43c1707eStholo% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 2071*43c1707eStholo% @item first col stuff @tab second col stuff @tab third col 2072*43c1707eStholo% @item 2073*43c1707eStholo% first col stuff 2074*43c1707eStholo% @tab 2075*43c1707eStholo% second col stuff 2076*43c1707eStholo% @tab 2077*43c1707eStholo% third col 2078*43c1707eStholo% @item first col stuff @tab second col stuff 2079*43c1707eStholo% @tab Many paragraphs of text may be used in any column. 2080*43c1707eStholo% 2081*43c1707eStholo% They will wrap at the width determined by the template. 2082*43c1707eStholo% @item@tab@tab This will be in third column. 2083*43c1707eStholo% @end multitable 2084*43c1707eStholo 2085*43c1707eStholo% Default dimensions may be reset by user. 2086*43c1707eStholo% @multitableparskip is vertical space between paragraphs in table. 2087*43c1707eStholo% @multitableparindent is paragraph indent in table. 2088*43c1707eStholo% @multitablecolmargin is horizontal space to be left between columns. 2089*43c1707eStholo% @multitablelinespace is space to leave between table items, baseline 2090*43c1707eStholo% to baseline. 2091*43c1707eStholo% 0pt means it depends on current normal line spacing. 2092*43c1707eStholo% 2093*43c1707eStholo\newskip\multitableparskip 2094*43c1707eStholo\newskip\multitableparindent 2095*43c1707eStholo\newdimen\multitablecolspace 2096*43c1707eStholo\newskip\multitablelinespace 2097*43c1707eStholo\multitableparskip=0pt 2098*43c1707eStholo\multitableparindent=6pt 2099*43c1707eStholo\multitablecolspace=12pt 2100*43c1707eStholo\multitablelinespace=0pt 2101*43c1707eStholo 2102*43c1707eStholo% Macros used to set up halign preamble: 2103*43c1707eStholo% 2104*43c1707eStholo\let\endsetuptable\relax 2105*43c1707eStholo\def\xendsetuptable{\endsetuptable} 2106*43c1707eStholo\let\columnfractions\relax 2107*43c1707eStholo\def\xcolumnfractions{\columnfractions} 2108*43c1707eStholo\newif\ifsetpercent 2109*43c1707eStholo 2110*43c1707eStholo% #1 is the part of the @columnfraction before the decimal point, which 2111*43c1707eStholo% is presumably either 0 or the empty string (but we don't check, we 2112*43c1707eStholo% just throw it away). #2 is the decimal part, which we use as the 2113*43c1707eStholo% percent of \hsize for this column. 2114*43c1707eStholo\def\pickupwholefraction#1.#2 {% 2115*43c1707eStholo \global\advance\colcount by 1 2116*43c1707eStholo \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}% 2117*43c1707eStholo \setuptable 2118*43c1707eStholo} 2119*43c1707eStholo 2120*43c1707eStholo\newcount\colcount 2121*43c1707eStholo\def\setuptable#1{% 2122*43c1707eStholo \def\firstarg{#1}% 2123*43c1707eStholo \ifx\firstarg\xendsetuptable 2124*43c1707eStholo \let\go = \relax 2125*43c1707eStholo \else 2126*43c1707eStholo \ifx\firstarg\xcolumnfractions 2127*43c1707eStholo \global\setpercenttrue 2128*43c1707eStholo \else 2129*43c1707eStholo \ifsetpercent 2130*43c1707eStholo \let\go\pickupwholefraction 2131*43c1707eStholo \else 2132*43c1707eStholo \global\advance\colcount by 1 2133*43c1707eStholo \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator; 2134*43c1707eStholo % typically that is always in the input, anyway. 2135*43c1707eStholo \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% 2136*43c1707eStholo \fi 2137*43c1707eStholo \fi 2138*43c1707eStholo \ifx\go\pickupwholefraction 2139*43c1707eStholo % Put the argument back for the \pickupwholefraction call, so 2140*43c1707eStholo % we'll always have a period there to be parsed. 2141*43c1707eStholo \def\go{\pickupwholefraction#1}% 2142*43c1707eStholo \else 2143*43c1707eStholo \let\go = \setuptable 2144*43c1707eStholo \fi% 2145*43c1707eStholo \fi 2146*43c1707eStholo \go 2147*43c1707eStholo} 2148*43c1707eStholo 2149*43c1707eStholo% This used to have \hskip1sp. But then the space in a template line is 2150*43c1707eStholo% not enough. That is bad. So let's go back to just & until we 2151*43c1707eStholo% encounter the problem it was intended to solve again. 2152*43c1707eStholo% --karl, nathan@acm.org, 20apr99. 2153*43c1707eStholo\def\tab{&} 2154*43c1707eStholo 2155*43c1707eStholo% @multitable ... @end multitable definitions: 2156*43c1707eStholo% 2157*43c1707eStholo\def\multitable{\parsearg\dotable} 2158*43c1707eStholo\def\dotable#1{\bgroup 2159*43c1707eStholo \vskip\parskip 2160*43c1707eStholo \let\item\crcr 2161*43c1707eStholo \tolerance=9500 2162*43c1707eStholo \hbadness=9500 2163*43c1707eStholo \setmultitablespacing 2164*43c1707eStholo \parskip=\multitableparskip 2165*43c1707eStholo \parindent=\multitableparindent 2166*43c1707eStholo \overfullrule=0pt 2167*43c1707eStholo \global\colcount=0 2168*43c1707eStholo \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}% 2169*43c1707eStholo % 2170*43c1707eStholo % To parse everything between @multitable and @item: 2171*43c1707eStholo \setuptable#1 \endsetuptable 2172*43c1707eStholo % 2173*43c1707eStholo % \everycr will reset column counter, \colcount, at the end of 2174*43c1707eStholo % each line. Every column entry will cause \colcount to advance by one. 2175*43c1707eStholo % The table preamble 2176*43c1707eStholo % looks at the current \colcount to find the correct column width. 2177*43c1707eStholo \everycr{\noalign{% 2178*43c1707eStholo % 2179*43c1707eStholo % \filbreak%% keeps underfull box messages off when table breaks over pages. 2180*43c1707eStholo % Maybe so, but it also creates really weird page breaks when the table 2181*43c1707eStholo % breaks over pages. Wouldn't \vfil be better? Wait until the problem 2182*43c1707eStholo % manifests itself, so it can be fixed for real --karl. 2183*43c1707eStholo \global\colcount=0\relax}}% 2184*43c1707eStholo % 2185*43c1707eStholo % This preamble sets up a generic column definition, which will 2186*43c1707eStholo % be used as many times as user calls for columns. 2187*43c1707eStholo % \vtop will set a single line and will also let text wrap and 2188*43c1707eStholo % continue for many paragraphs if desired. 2189*43c1707eStholo \halign\bgroup&\global\advance\colcount by 1\relax 2190*43c1707eStholo \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname 2191*43c1707eStholo % 2192*43c1707eStholo % In order to keep entries from bumping into each other 2193*43c1707eStholo % we will add a \leftskip of \multitablecolspace to all columns after 2194*43c1707eStholo % the first one. 2195*43c1707eStholo % 2196*43c1707eStholo % If a template has been used, we will add \multitablecolspace 2197*43c1707eStholo % to the width of each template entry. 2198*43c1707eStholo % 2199*43c1707eStholo % If the user has set preamble in terms of percent of \hsize we will 2200*43c1707eStholo % use that dimension as the width of the column, and the \leftskip 2201*43c1707eStholo % will keep entries from bumping into each other. Table will start at 2202*43c1707eStholo % left margin and final column will justify at right margin. 2203*43c1707eStholo % 2204*43c1707eStholo % Make sure we don't inherit \rightskip from the outer environment. 2205*43c1707eStholo \rightskip=0pt 2206*43c1707eStholo \ifnum\colcount=1 2207*43c1707eStholo % The first column will be indented with the surrounding text. 2208*43c1707eStholo \advance\hsize by\leftskip 2209*43c1707eStholo \else 2210*43c1707eStholo \ifsetpercent \else 2211*43c1707eStholo % If user has not set preamble in terms of percent of \hsize 2212*43c1707eStholo % we will advance \hsize by \multitablecolspace. 2213*43c1707eStholo \advance\hsize by \multitablecolspace 2214*43c1707eStholo \fi 2215*43c1707eStholo % In either case we will make \leftskip=\multitablecolspace: 2216*43c1707eStholo \leftskip=\multitablecolspace 2217*43c1707eStholo \fi 2218*43c1707eStholo % Ignoring space at the beginning and end avoids an occasional spurious 2219*43c1707eStholo % blank line, when TeX decides to break the line at the space before the 2220*43c1707eStholo % box from the multistrut, so the strut ends up on a line by itself. 2221*43c1707eStholo % For example: 2222*43c1707eStholo % @multitable @columnfractions .11 .89 2223*43c1707eStholo % @item @code{#} 2224*43c1707eStholo % @tab Legal holiday which is valid in major parts of the whole country. 2225*43c1707eStholo % Is automatically provided with highlighting sequences respectively marking 2226*43c1707eStholo % characters. 2227*43c1707eStholo \noindent\ignorespaces##\unskip\multistrut}\cr 2228*43c1707eStholo} 2229*43c1707eStholo 2230*43c1707eStholo\def\setmultitablespacing{% test to see if user has set \multitablelinespace. 2231*43c1707eStholo% If so, do nothing. If not, give it an appropriate dimension based on 2232*43c1707eStholo% current baselineskip. 2233*43c1707eStholo\ifdim\multitablelinespace=0pt 2234*43c1707eStholo\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip 2235*43c1707eStholo\global\advance\multitablelinespace by-\ht0 2236*43c1707eStholo%% strut to put in table in case some entry doesn't have descenders, 2237*43c1707eStholo%% to keep lines equally spaced 2238*43c1707eStholo\let\multistrut = \strut 2239*43c1707eStholo\else 2240*43c1707eStholo%% FIXME: what is \box0 supposed to be? 2241*43c1707eStholo\gdef\multistrut{\vrule height\multitablelinespace depth\dp0 2242*43c1707eStholowidth0pt\relax} \fi 2243*43c1707eStholo%% Test to see if parskip is larger than space between lines of 2244*43c1707eStholo%% table. If not, do nothing. 2245*43c1707eStholo%% If so, set to same dimension as multitablelinespace. 2246*43c1707eStholo\ifdim\multitableparskip>\multitablelinespace 2247*43c1707eStholo\global\multitableparskip=\multitablelinespace 2248*43c1707eStholo\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller 2249*43c1707eStholo %% than skip between lines in the table. 2250*43c1707eStholo\fi% 2251*43c1707eStholo\ifdim\multitableparskip=0pt 2252*43c1707eStholo\global\multitableparskip=\multitablelinespace 2253*43c1707eStholo\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller 2254*43c1707eStholo %% than skip between lines in the table. 2255*43c1707eStholo\fi} 2256*43c1707eStholo 2257*43c1707eStholo 2258*43c1707eStholo\message{conditionals,} 2259*43c1707eStholo% Prevent errors for section commands. 2260*43c1707eStholo% Used in @ignore and in failing conditionals. 2261*43c1707eStholo\def\ignoresections{% 2262*43c1707eStholo \let\chapter=\relax 2263*43c1707eStholo \let\unnumbered=\relax 2264*43c1707eStholo \let\top=\relax 2265*43c1707eStholo \let\unnumberedsec=\relax 2266*43c1707eStholo \let\unnumberedsection=\relax 2267*43c1707eStholo \let\unnumberedsubsec=\relax 2268*43c1707eStholo \let\unnumberedsubsection=\relax 2269*43c1707eStholo \let\unnumberedsubsubsec=\relax 2270*43c1707eStholo \let\unnumberedsubsubsection=\relax 2271*43c1707eStholo \let\section=\relax 2272*43c1707eStholo \let\subsec=\relax 2273*43c1707eStholo \let\subsubsec=\relax 2274*43c1707eStholo \let\subsection=\relax 2275*43c1707eStholo \let\subsubsection=\relax 2276*43c1707eStholo \let\appendix=\relax 2277*43c1707eStholo \let\appendixsec=\relax 2278*43c1707eStholo \let\appendixsection=\relax 2279*43c1707eStholo \let\appendixsubsec=\relax 2280*43c1707eStholo \let\appendixsubsection=\relax 2281*43c1707eStholo \let\appendixsubsubsec=\relax 2282*43c1707eStholo \let\appendixsubsubsection=\relax 2283*43c1707eStholo \let\contents=\relax 2284*43c1707eStholo \let\smallbook=\relax 2285*43c1707eStholo \let\titlepage=\relax 2286*43c1707eStholo} 2287*43c1707eStholo 2288*43c1707eStholo% Used in nested conditionals, where we have to parse the Texinfo source 2289*43c1707eStholo% and so want to turn off most commands, in case they are used 2290*43c1707eStholo% incorrectly. 2291*43c1707eStholo% 2292*43c1707eStholo\def\ignoremorecommands{% 2293*43c1707eStholo \let\defcodeindex = \relax 2294*43c1707eStholo \let\defcv = \relax 2295*43c1707eStholo \let\deffn = \relax 2296*43c1707eStholo \let\deffnx = \relax 2297*43c1707eStholo \let\defindex = \relax 2298*43c1707eStholo \let\defivar = \relax 2299*43c1707eStholo \let\defmac = \relax 2300*43c1707eStholo \let\defmethod = \relax 2301*43c1707eStholo \let\defop = \relax 2302*43c1707eStholo \let\defopt = \relax 2303*43c1707eStholo \let\defspec = \relax 2304*43c1707eStholo \let\deftp = \relax 2305*43c1707eStholo \let\deftypefn = \relax 2306*43c1707eStholo \let\deftypefun = \relax 2307*43c1707eStholo \let\deftypeivar = \relax 2308*43c1707eStholo \let\deftypeop = \relax 2309*43c1707eStholo \let\deftypevar = \relax 2310*43c1707eStholo \let\deftypevr = \relax 2311*43c1707eStholo \let\defun = \relax 2312*43c1707eStholo \let\defvar = \relax 2313*43c1707eStholo \let\defvr = \relax 2314*43c1707eStholo \let\ref = \relax 2315*43c1707eStholo \let\xref = \relax 2316*43c1707eStholo \let\printindex = \relax 2317*43c1707eStholo \let\pxref = \relax 2318*43c1707eStholo \let\settitle = \relax 2319*43c1707eStholo \let\setchapternewpage = \relax 2320*43c1707eStholo \let\setchapterstyle = \relax 2321*43c1707eStholo \let\everyheading = \relax 2322*43c1707eStholo \let\evenheading = \relax 2323*43c1707eStholo \let\oddheading = \relax 2324*43c1707eStholo \let\everyfooting = \relax 2325*43c1707eStholo \let\evenfooting = \relax 2326*43c1707eStholo \let\oddfooting = \relax 2327*43c1707eStholo \let\headings = \relax 2328*43c1707eStholo \let\include = \relax 2329*43c1707eStholo \let\lowersections = \relax 2330*43c1707eStholo \let\down = \relax 2331*43c1707eStholo \let\raisesections = \relax 2332*43c1707eStholo \let\up = \relax 2333*43c1707eStholo \let\set = \relax 2334*43c1707eStholo \let\clear = \relax 2335*43c1707eStholo \let\item = \relax 2336*43c1707eStholo} 2337*43c1707eStholo 2338*43c1707eStholo% Ignore @ignore ... @end ignore. 2339*43c1707eStholo% 2340*43c1707eStholo\def\ignore{\doignore{ignore}} 2341*43c1707eStholo 2342*43c1707eStholo% Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text. 2343*43c1707eStholo% 2344*43c1707eStholo\def\ifinfo{\doignore{ifinfo}} 2345*43c1707eStholo\def\ifhtml{\doignore{ifhtml}} 2346*43c1707eStholo\def\ifnottex{\doignore{ifnottex}} 2347*43c1707eStholo\def\html{\doignore{html}} 2348*43c1707eStholo\def\menu{\doignore{menu}} 2349*43c1707eStholo\def\direntry{\doignore{direntry}} 2350*43c1707eStholo 2351*43c1707eStholo% @dircategory CATEGORY -- specify a category of the dir file 2352*43c1707eStholo% which this file should belong to. Ignore this in TeX. 2353*43c1707eStholo\let\dircategory = \comment 2354*43c1707eStholo 2355*43c1707eStholo% Ignore text until a line `@end #1'. 2356*43c1707eStholo% 2357*43c1707eStholo\def\doignore#1{\begingroup 2358*43c1707eStholo % Don't complain about control sequences we have declared \outer. 2359*43c1707eStholo \ignoresections 2360*43c1707eStholo % 2361*43c1707eStholo % Define a command to swallow text until we reach `@end #1'. 2362*43c1707eStholo % This @ is a catcode 12 token (that is the normal catcode of @ in 2363*43c1707eStholo % this texinfo.tex file). We change the catcode of @ below to match. 2364*43c1707eStholo \long\def\doignoretext##1@end #1{\enddoignore}% 2365*43c1707eStholo % 2366*43c1707eStholo % Make sure that spaces turn into tokens that match what \doignoretext wants. 2367*43c1707eStholo \catcode32 = 10 2368*43c1707eStholo % 2369*43c1707eStholo % Ignore braces, too, so mismatched braces don't cause trouble. 2370*43c1707eStholo \catcode`\{ = 9 2371*43c1707eStholo \catcode`\} = 9 2372*43c1707eStholo % 2373*43c1707eStholo % We must not have @c interpreted as a control sequence. 2374*43c1707eStholo \catcode`\@ = 12 2375*43c1707eStholo % 2376*43c1707eStholo % Make the letter c a comment character so that the rest of the line 2377*43c1707eStholo % will be ignored. This way, the document can have (for example) 2378*43c1707eStholo % @c @end ifinfo 2379*43c1707eStholo % and the @end ifinfo will be properly ignored. 2380*43c1707eStholo % (We've just changed @ to catcode 12.) 2381*43c1707eStholo \catcode`\c = 14 2382*43c1707eStholo % 2383*43c1707eStholo % And now expand that command. 2384*43c1707eStholo \doignoretext 2385*43c1707eStholo} 2386*43c1707eStholo 2387*43c1707eStholo% What we do to finish off ignored text. 2388*43c1707eStholo% 2389*43c1707eStholo\def\enddoignore{\endgroup\ignorespaces}% 2390*43c1707eStholo 2391*43c1707eStholo\newif\ifwarnedobs\warnedobsfalse 2392*43c1707eStholo\def\obstexwarn{% 2393*43c1707eStholo \ifwarnedobs\relax\else 2394*43c1707eStholo % We need to warn folks that they may have trouble with TeX 3.0. 2395*43c1707eStholo % This uses \immediate\write16 rather than \message to get newlines. 2396*43c1707eStholo \immediate\write16{} 2397*43c1707eStholo \immediate\write16{WARNING: for users of Unix TeX 3.0!} 2398*43c1707eStholo \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).} 2399*43c1707eStholo \immediate\write16{If you are running another version of TeX, relax.} 2400*43c1707eStholo \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.} 2401*43c1707eStholo \immediate\write16{ Then upgrade your TeX installation if you can.} 2402*43c1707eStholo \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)} 2403*43c1707eStholo \immediate\write16{If you are stuck with version 3.0, run the} 2404*43c1707eStholo \immediate\write16{ script ``tex3patch'' from the Texinfo distribution} 2405*43c1707eStholo \immediate\write16{ to use a workaround.} 2406*43c1707eStholo \immediate\write16{} 2407*43c1707eStholo \global\warnedobstrue 2408*43c1707eStholo \fi 2409*43c1707eStholo} 2410*43c1707eStholo 2411*43c1707eStholo% **In TeX 3.0, setting text in \nullfont hangs tex. For a 2412*43c1707eStholo% workaround (which requires the file ``dummy.tfm'' to be installed), 2413*43c1707eStholo% uncomment the following line: 2414*43c1707eStholo%%%%%\font\nullfont=dummy\let\obstexwarn=\relax 2415*43c1707eStholo 2416*43c1707eStholo% Ignore text, except that we keep track of conditional commands for 2417*43c1707eStholo% purposes of nesting, up to an `@end #1' command. 2418*43c1707eStholo% 2419*43c1707eStholo\def\nestedignore#1{% 2420*43c1707eStholo \obstexwarn 2421*43c1707eStholo % We must actually expand the ignored text to look for the @end 2422*43c1707eStholo % command, so that nested ignore constructs work. Thus, we put the 2423*43c1707eStholo % text into a \vbox and then do nothing with the result. To minimize 2424*43c1707eStholo % the change of memory overflow, we follow the approach outlined on 2425*43c1707eStholo % page 401 of the TeXbook: make the current font be a dummy font. 2426*43c1707eStholo % 2427*43c1707eStholo \setbox0 = \vbox\bgroup 2428*43c1707eStholo % Don't complain about control sequences we have declared \outer. 2429*43c1707eStholo \ignoresections 2430*43c1707eStholo % 2431*43c1707eStholo % Define `@end #1' to end the box, which will in turn undefine the 2432*43c1707eStholo % @end command again. 2433*43c1707eStholo \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}% 2434*43c1707eStholo % 2435*43c1707eStholo % We are going to be parsing Texinfo commands. Most cause no 2436*43c1707eStholo % trouble when they are used incorrectly, but some commands do 2437*43c1707eStholo % complicated argument parsing or otherwise get confused, so we 2438*43c1707eStholo % undefine them. 2439*43c1707eStholo % 2440*43c1707eStholo % We can't do anything about stray @-signs, unfortunately; 2441*43c1707eStholo % they'll produce `undefined control sequence' errors. 2442*43c1707eStholo \ignoremorecommands 2443*43c1707eStholo % 2444*43c1707eStholo % Set the current font to be \nullfont, a TeX primitive, and define 2445*43c1707eStholo % all the font commands to also use \nullfont. We don't use 2446*43c1707eStholo % dummy.tfm, as suggested in the TeXbook, because not all sites 2447*43c1707eStholo % might have that installed. Therefore, math mode will still 2448*43c1707eStholo % produce output, but that should be an extremely small amount of 2449*43c1707eStholo % stuff compared to the main input. 2450*43c1707eStholo % 2451*43c1707eStholo \nullfont 2452*43c1707eStholo \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont 2453*43c1707eStholo \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont 2454*43c1707eStholo \let\tensf=\nullfont 2455*43c1707eStholo % Similarly for index fonts (mostly for their use in smallexample). 2456*43c1707eStholo \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont 2457*43c1707eStholo \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont 2458*43c1707eStholo \let\smallsf=\nullfont 2459*43c1707eStholo % 2460*43c1707eStholo % Don't complain when characters are missing from the fonts. 2461*43c1707eStholo \tracinglostchars = 0 2462*43c1707eStholo % 2463*43c1707eStholo % Don't bother to do space factor calculations. 2464*43c1707eStholo \frenchspacing 2465*43c1707eStholo % 2466*43c1707eStholo % Don't report underfull hboxes. 2467*43c1707eStholo \hbadness = 10000 2468*43c1707eStholo % 2469*43c1707eStholo % Do minimal line-breaking. 2470*43c1707eStholo \pretolerance = 10000 2471*43c1707eStholo % 2472*43c1707eStholo % Do not execute instructions in @tex 2473*43c1707eStholo \def\tex{\doignore{tex}}% 2474*43c1707eStholo % Do not execute macro definitions. 2475*43c1707eStholo % `c' is a comment character, so the word `macro' will get cut off. 2476*43c1707eStholo \def\macro{\doignore{ma}}% 2477*43c1707eStholo} 2478*43c1707eStholo 2479*43c1707eStholo% @set VAR sets the variable VAR to an empty value. 2480*43c1707eStholo% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. 2481*43c1707eStholo% 2482*43c1707eStholo% Since we want to separate VAR from REST-OF-LINE (which might be 2483*43c1707eStholo% empty), we can't just use \parsearg; we have to insert a space of our 2484*43c1707eStholo% own to delimit the rest of the line, and then take it out again if we 2485*43c1707eStholo% didn't need it. Make sure the catcode of space is correct to avoid 2486*43c1707eStholo% losing inside @example, for instance. 2487*43c1707eStholo% 2488*43c1707eStholo\def\set{\begingroup\catcode` =10 2489*43c1707eStholo \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR. 2490*43c1707eStholo \parsearg\setxxx} 2491*43c1707eStholo\def\setxxx#1{\setyyy#1 \endsetyyy} 2492*43c1707eStholo\def\setyyy#1 #2\endsetyyy{% 2493*43c1707eStholo \def\temp{#2}% 2494*43c1707eStholo \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty 2495*43c1707eStholo \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted. 2496*43c1707eStholo \fi 2497*43c1707eStholo \endgroup 2498*43c1707eStholo} 2499*43c1707eStholo% Can't use \xdef to pre-expand #2 and save some time, since \temp or 2500*43c1707eStholo% \next or other control sequences that we've defined might get us into 2501*43c1707eStholo% an infinite loop. Consider `@set foo @cite{bar}'. 2502*43c1707eStholo\def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}} 2503*43c1707eStholo 2504*43c1707eStholo% @clear VAR clears (i.e., unsets) the variable VAR. 2505*43c1707eStholo% 2506*43c1707eStholo\def\clear{\parsearg\clearxxx} 2507*43c1707eStholo\def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax} 2508*43c1707eStholo 2509*43c1707eStholo% @value{foo} gets the text saved in variable foo. 2510*43c1707eStholo{ 2511*43c1707eStholo \catcode`\_ = \active 2512*43c1707eStholo % 2513*43c1707eStholo % We might end up with active _ or - characters in the argument if 2514*43c1707eStholo % we're called from @code, as @code{@value{foo-bar_}}. So \let any 2515*43c1707eStholo % such active characters to their normal equivalents. 2516*43c1707eStholo \gdef\value{\begingroup 2517*43c1707eStholo \catcode`\-=12 \catcode`\_=12 2518*43c1707eStholo \indexbreaks \let_\normalunderscore 2519*43c1707eStholo \valuexxx} 2520*43c1707eStholo} 2521*43c1707eStholo\def\valuexxx#1{\expandablevalue{#1}\endgroup} 2522*43c1707eStholo 2523*43c1707eStholo% We have this subroutine so that we can handle at least some @value's 2524*43c1707eStholo% properly in indexes (we \let\value to this in \indexdummies). Ones 2525*43c1707eStholo% whose names contain - or _ still won't work, but we can't do anything 2526*43c1707eStholo% about that. The command has to be fully expandable, since the result 2527*43c1707eStholo% winds up in the index file. This means that if the variable's value 2528*43c1707eStholo% contains other Texinfo commands, it's almost certain it will fail 2529*43c1707eStholo% (although perhaps we could fix that with sufficient work to do a 2530*43c1707eStholo% one-level expansion on the result, instead of complete). 2531*43c1707eStholo% 2532*43c1707eStholo\def\expandablevalue#1{% 2533*43c1707eStholo \expandafter\ifx\csname SET#1\endcsname\relax 2534*43c1707eStholo {[No value for ``#1'']}% 2535*43c1707eStholo \else 2536*43c1707eStholo \csname SET#1\endcsname 2537*43c1707eStholo \fi 2538*43c1707eStholo} 2539*43c1707eStholo 2540*43c1707eStholo% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined 2541*43c1707eStholo% with @set. 2542*43c1707eStholo% 2543*43c1707eStholo\def\ifset{\parsearg\ifsetxxx} 2544*43c1707eStholo\def\ifsetxxx #1{% 2545*43c1707eStholo \expandafter\ifx\csname SET#1\endcsname\relax 2546*43c1707eStholo \expandafter\ifsetfail 2547*43c1707eStholo \else 2548*43c1707eStholo \expandafter\ifsetsucceed 2549*43c1707eStholo \fi 2550*43c1707eStholo} 2551*43c1707eStholo\def\ifsetsucceed{\conditionalsucceed{ifset}} 2552*43c1707eStholo\def\ifsetfail{\nestedignore{ifset}} 2553*43c1707eStholo\defineunmatchedend{ifset} 2554*43c1707eStholo 2555*43c1707eStholo% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been 2556*43c1707eStholo% defined with @set, or has been undefined with @clear. 2557*43c1707eStholo% 2558*43c1707eStholo\def\ifclear{\parsearg\ifclearxxx} 2559*43c1707eStholo\def\ifclearxxx #1{% 2560*43c1707eStholo \expandafter\ifx\csname SET#1\endcsname\relax 2561*43c1707eStholo \expandafter\ifclearsucceed 2562*43c1707eStholo \else 2563*43c1707eStholo \expandafter\ifclearfail 2564*43c1707eStholo \fi 2565*43c1707eStholo} 2566*43c1707eStholo\def\ifclearsucceed{\conditionalsucceed{ifclear}} 2567*43c1707eStholo\def\ifclearfail{\nestedignore{ifclear}} 2568*43c1707eStholo\defineunmatchedend{ifclear} 2569*43c1707eStholo 2570*43c1707eStholo% @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text 2571*43c1707eStholo% following, through the first @end iftex (etc.). Make `@end iftex' 2572*43c1707eStholo% (etc.) valid only after an @iftex. 2573*43c1707eStholo% 2574*43c1707eStholo\def\iftex{\conditionalsucceed{iftex}} 2575*43c1707eStholo\def\ifnothtml{\conditionalsucceed{ifnothtml}} 2576*43c1707eStholo\def\ifnotinfo{\conditionalsucceed{ifnotinfo}} 2577*43c1707eStholo\defineunmatchedend{iftex} 2578*43c1707eStholo\defineunmatchedend{ifnothtml} 2579*43c1707eStholo\defineunmatchedend{ifnotinfo} 2580*43c1707eStholo 2581*43c1707eStholo% We can't just want to start a group at @iftex (for example) and end it 2582*43c1707eStholo% at @end iftex, since then @set commands inside the conditional have no 2583*43c1707eStholo% effect (they'd get reverted at the end of the group). So we must 2584*43c1707eStholo% define \Eiftex to redefine itself to be its previous value. (We can't 2585*43c1707eStholo% just define it to fail again with an ``unmatched end'' error, since 2586*43c1707eStholo% the @ifset might be nested.) 2587*43c1707eStholo% 2588*43c1707eStholo\def\conditionalsucceed#1{% 2589*43c1707eStholo \edef\temp{% 2590*43c1707eStholo % Remember the current value of \E#1. 2591*43c1707eStholo \let\nece{prevE#1} = \nece{E#1}% 2592*43c1707eStholo % 2593*43c1707eStholo % At the `@end #1', redefine \E#1 to be its previous value. 2594*43c1707eStholo \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}% 2595*43c1707eStholo }% 2596*43c1707eStholo \temp 2597*43c1707eStholo} 2598*43c1707eStholo 2599*43c1707eStholo% We need to expand lots of \csname's, but we don't want to expand the 2600*43c1707eStholo% control sequences after we've constructed them. 2601*43c1707eStholo% 2602*43c1707eStholo\def\nece#1{\expandafter\noexpand\csname#1\endcsname} 2603*43c1707eStholo 2604*43c1707eStholo% @defininfoenclose. 2605*43c1707eStholo\let\definfoenclose=\comment 2606*43c1707eStholo 2607*43c1707eStholo 2608*43c1707eStholo\message{indexing,} 2609*43c1707eStholo% Index generation facilities 2610*43c1707eStholo 2611*43c1707eStholo% Define \newwrite to be identical to plain tex's \newwrite 2612*43c1707eStholo% except not \outer, so it can be used within \newindex. 2613*43c1707eStholo{\catcode`\@=11 2614*43c1707eStholo\gdef\newwrite{\alloc@7\write\chardef\sixt@@n}} 2615*43c1707eStholo 2616*43c1707eStholo% \newindex {foo} defines an index named foo. 2617*43c1707eStholo% It automatically defines \fooindex such that 2618*43c1707eStholo% \fooindex ...rest of line... puts an entry in the index foo. 2619*43c1707eStholo% It also defines \fooindfile to be the number of the output channel for 2620*43c1707eStholo% the file that accumulates this index. The file's extension is foo. 2621*43c1707eStholo% The name of an index should be no more than 2 characters long 2622*43c1707eStholo% for the sake of vms. 2623*43c1707eStholo% 2624*43c1707eStholo\def\newindex#1{% 2625*43c1707eStholo \iflinks 2626*43c1707eStholo \expandafter\newwrite \csname#1indfile\endcsname 2627*43c1707eStholo \openout \csname#1indfile\endcsname \jobname.#1 % Open the file 2628*43c1707eStholo \fi 2629*43c1707eStholo \expandafter\xdef\csname#1index\endcsname{% % Define @#1index 2630*43c1707eStholo \noexpand\doindex{#1}} 2631*43c1707eStholo} 2632*43c1707eStholo 2633*43c1707eStholo% @defindex foo == \newindex{foo} 2634*43c1707eStholo% 2635*43c1707eStholo\def\defindex{\parsearg\newindex} 2636*43c1707eStholo 2637*43c1707eStholo% Define @defcodeindex, like @defindex except put all entries in @code. 2638*43c1707eStholo% 2639*43c1707eStholo\def\defcodeindex{\parsearg\newcodeindex} 2640*43c1707eStholo% 2641*43c1707eStholo\def\newcodeindex#1{% 2642*43c1707eStholo \iflinks 2643*43c1707eStholo \expandafter\newwrite \csname#1indfile\endcsname 2644*43c1707eStholo \openout \csname#1indfile\endcsname \jobname.#1 2645*43c1707eStholo \fi 2646*43c1707eStholo \expandafter\xdef\csname#1index\endcsname{% 2647*43c1707eStholo \noexpand\docodeindex{#1}}% 2648*43c1707eStholo} 2649*43c1707eStholo 2650*43c1707eStholo 2651*43c1707eStholo% @synindex foo bar makes index foo feed into index bar. 2652*43c1707eStholo% Do this instead of @defindex foo if you don't want it as a separate index. 2653*43c1707eStholo% 2654*43c1707eStholo% @syncodeindex foo bar similar, but put all entries made for index foo 2655*43c1707eStholo% inside @code. 2656*43c1707eStholo% 2657*43c1707eStholo\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} 2658*43c1707eStholo\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} 2659*43c1707eStholo 2660*43c1707eStholo% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), 2661*43c1707eStholo% #3 the target index (bar). 2662*43c1707eStholo\def\dosynindex#1#2#3{% 2663*43c1707eStholo % Only do \closeout if we haven't already done it, else we'll end up 2664*43c1707eStholo % closing the target index. 2665*43c1707eStholo \expandafter \ifx\csname donesynindex#2\endcsname \undefined 2666*43c1707eStholo % The \closeout helps reduce unnecessary open files; the limit on the 2667*43c1707eStholo % Acorn RISC OS is a mere 16 files. 2668*43c1707eStholo \expandafter\closeout\csname#2indfile\endcsname 2669*43c1707eStholo \expandafter\let\csname\donesynindex#2\endcsname = 1 2670*43c1707eStholo \fi 2671*43c1707eStholo % redefine \fooindfile: 2672*43c1707eStholo \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname 2673*43c1707eStholo \expandafter\let\csname#2indfile\endcsname=\temp 2674*43c1707eStholo % redefine \fooindex: 2675*43c1707eStholo \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% 2676*43c1707eStholo} 2677*43c1707eStholo 2678*43c1707eStholo% Define \doindex, the driver for all \fooindex macros. 2679*43c1707eStholo% Argument #1 is generated by the calling \fooindex macro, 2680*43c1707eStholo% and it is "foo", the name of the index. 2681*43c1707eStholo 2682*43c1707eStholo% \doindex just uses \parsearg; it calls \doind for the actual work. 2683*43c1707eStholo% This is because \doind is more useful to call from other macros. 2684*43c1707eStholo 2685*43c1707eStholo% There is also \dosubind {index}{topic}{subtopic} 2686*43c1707eStholo% which makes an entry in a two-level index such as the operation index. 2687*43c1707eStholo 2688*43c1707eStholo\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} 2689*43c1707eStholo\def\singleindexer #1{\doind{\indexname}{#1}} 2690*43c1707eStholo 2691*43c1707eStholo% like the previous two, but they put @code around the argument. 2692*43c1707eStholo\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} 2693*43c1707eStholo\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} 2694*43c1707eStholo 2695*43c1707eStholo\def\indexdummies{% 2696*43c1707eStholo\def\ { }% 2697*43c1707eStholo% Take care of the plain tex accent commands. 2698*43c1707eStholo\def\"{\realbackslash "}% 2699*43c1707eStholo\def\`{\realbackslash `}% 2700*43c1707eStholo\def\'{\realbackslash '}% 2701*43c1707eStholo\def\^{\realbackslash ^}% 2702*43c1707eStholo\def\~{\realbackslash ~}% 2703*43c1707eStholo\def\={\realbackslash =}% 2704*43c1707eStholo\def\b{\realbackslash b}% 2705*43c1707eStholo\def\c{\realbackslash c}% 2706*43c1707eStholo\def\d{\realbackslash d}% 2707*43c1707eStholo\def\u{\realbackslash u}% 2708*43c1707eStholo\def\v{\realbackslash v}% 2709*43c1707eStholo\def\H{\realbackslash H}% 2710*43c1707eStholo% Take care of the plain tex special European modified letters. 2711*43c1707eStholo\def\oe{\realbackslash oe}% 2712*43c1707eStholo\def\ae{\realbackslash ae}% 2713*43c1707eStholo\def\aa{\realbackslash aa}% 2714*43c1707eStholo\def\OE{\realbackslash OE}% 2715*43c1707eStholo\def\AE{\realbackslash AE}% 2716*43c1707eStholo\def\AA{\realbackslash AA}% 2717*43c1707eStholo\def\o{\realbackslash o}% 2718*43c1707eStholo\def\O{\realbackslash O}% 2719*43c1707eStholo\def\l{\realbackslash l}% 2720*43c1707eStholo\def\L{\realbackslash L}% 2721*43c1707eStholo\def\ss{\realbackslash ss}% 2722*43c1707eStholo% Take care of texinfo commands likely to appear in an index entry. 2723*43c1707eStholo% (Must be a way to avoid doing expansion at all, and thus not have to 2724*43c1707eStholo% laboriously list every single command here.) 2725*43c1707eStholo\def\@{@}% will be @@ when we switch to @ as escape char. 2726*43c1707eStholo% Need these in case \tex is in effect and \{ is a \delimiter again. 2727*43c1707eStholo% But can't use \lbracecmd and \rbracecmd because texindex assumes 2728*43c1707eStholo% braces and backslashes are used only as delimiters. 2729*43c1707eStholo\let\{ = \mylbrace 2730*43c1707eStholo\let\} = \myrbrace 2731*43c1707eStholo\def\_{{\realbackslash _}}% 2732*43c1707eStholo\def\w{\realbackslash w }% 2733*43c1707eStholo\def\bf{\realbackslash bf }% 2734*43c1707eStholo%\def\rm{\realbackslash rm }% 2735*43c1707eStholo\def\sl{\realbackslash sl }% 2736*43c1707eStholo\def\sf{\realbackslash sf}% 2737*43c1707eStholo\def\tt{\realbackslash tt}% 2738*43c1707eStholo\def\gtr{\realbackslash gtr}% 2739*43c1707eStholo\def\less{\realbackslash less}% 2740*43c1707eStholo\def\hat{\realbackslash hat}% 2741*43c1707eStholo\def\TeX{\realbackslash TeX}% 2742*43c1707eStholo\def\dots{\realbackslash dots }% 2743*43c1707eStholo\def\result{\realbackslash result}% 2744*43c1707eStholo\def\equiv{\realbackslash equiv}% 2745*43c1707eStholo\def\expansion{\realbackslash expansion}% 2746*43c1707eStholo\def\print{\realbackslash print}% 2747*43c1707eStholo\def\error{\realbackslash error}% 2748*43c1707eStholo\def\point{\realbackslash point}% 2749*43c1707eStholo\def\copyright{\realbackslash copyright}% 2750*43c1707eStholo\def\tclose##1{\realbackslash tclose {##1}}% 2751*43c1707eStholo\def\code##1{\realbackslash code {##1}}% 2752*43c1707eStholo\def\uref##1{\realbackslash uref {##1}}% 2753*43c1707eStholo\def\url##1{\realbackslash url {##1}}% 2754*43c1707eStholo\def\env##1{\realbackslash env {##1}}% 2755*43c1707eStholo\def\command##1{\realbackslash command {##1}}% 2756*43c1707eStholo\def\option##1{\realbackslash option {##1}}% 2757*43c1707eStholo\def\dotless##1{\realbackslash dotless {##1}}% 2758*43c1707eStholo\def\samp##1{\realbackslash samp {##1}}% 2759*43c1707eStholo\def\,##1{\realbackslash ,{##1}}% 2760*43c1707eStholo\def\t##1{\realbackslash t {##1}}% 2761*43c1707eStholo\def\r##1{\realbackslash r {##1}}% 2762*43c1707eStholo\def\i##1{\realbackslash i {##1}}% 2763*43c1707eStholo\def\b##1{\realbackslash b {##1}}% 2764*43c1707eStholo\def\sc##1{\realbackslash sc {##1}}% 2765*43c1707eStholo\def\cite##1{\realbackslash cite {##1}}% 2766*43c1707eStholo\def\key##1{\realbackslash key {##1}}% 2767*43c1707eStholo\def\file##1{\realbackslash file {##1}}% 2768*43c1707eStholo\def\var##1{\realbackslash var {##1}}% 2769*43c1707eStholo\def\kbd##1{\realbackslash kbd {##1}}% 2770*43c1707eStholo\def\dfn##1{\realbackslash dfn {##1}}% 2771*43c1707eStholo\def\emph##1{\realbackslash emph {##1}}% 2772*43c1707eStholo\def\acronym##1{\realbackslash acronym {##1}}% 2773*43c1707eStholo% 2774*43c1707eStholo% Handle some cases of @value -- where the variable name does not 2775*43c1707eStholo% contain - or _, and the value does not contain any 2776*43c1707eStholo% (non-fully-expandable) commands. 2777*43c1707eStholo\let\value = \expandablevalue 2778*43c1707eStholo% 2779*43c1707eStholo\unsepspaces 2780*43c1707eStholo% Turn off macro expansion 2781*43c1707eStholo\turnoffmacros 2782*43c1707eStholo} 2783*43c1707eStholo 2784*43c1707eStholo% If an index command is used in an @example environment, any spaces 2785*43c1707eStholo% therein should become regular spaces in the raw index file, not the 2786*43c1707eStholo% expansion of \tie (\\leavevmode \penalty \@M \ ). 2787*43c1707eStholo{\obeyspaces 2788*43c1707eStholo \gdef\unsepspaces{\obeyspaces\let =\space}} 2789*43c1707eStholo 2790*43c1707eStholo% \indexnofonts no-ops all font-change commands. 2791*43c1707eStholo% This is used when outputting the strings to sort the index by. 2792*43c1707eStholo\def\indexdummyfont#1{#1} 2793*43c1707eStholo\def\indexdummytex{TeX} 2794*43c1707eStholo\def\indexdummydots{...} 2795*43c1707eStholo 2796*43c1707eStholo\def\indexnofonts{% 2797*43c1707eStholo% Just ignore accents. 2798*43c1707eStholo\let\,=\indexdummyfont 2799*43c1707eStholo\let\"=\indexdummyfont 2800*43c1707eStholo\let\`=\indexdummyfont 2801*43c1707eStholo\let\'=\indexdummyfont 2802*43c1707eStholo\let\^=\indexdummyfont 2803*43c1707eStholo\let\~=\indexdummyfont 2804*43c1707eStholo\let\==\indexdummyfont 2805*43c1707eStholo\let\b=\indexdummyfont 2806*43c1707eStholo\let\c=\indexdummyfont 2807*43c1707eStholo\let\d=\indexdummyfont 2808*43c1707eStholo\let\u=\indexdummyfont 2809*43c1707eStholo\let\v=\indexdummyfont 2810*43c1707eStholo\let\H=\indexdummyfont 2811*43c1707eStholo\let\dotless=\indexdummyfont 2812*43c1707eStholo% Take care of the plain tex special European modified letters. 2813*43c1707eStholo\def\oe{oe}% 2814*43c1707eStholo\def\ae{ae}% 2815*43c1707eStholo\def\aa{aa}% 2816*43c1707eStholo\def\OE{OE}% 2817*43c1707eStholo\def\AE{AE}% 2818*43c1707eStholo\def\AA{AA}% 2819*43c1707eStholo\def\o{o}% 2820*43c1707eStholo\def\O{O}% 2821*43c1707eStholo\def\l{l}% 2822*43c1707eStholo\def\L{L}% 2823*43c1707eStholo\def\ss{ss}% 2824*43c1707eStholo\let\w=\indexdummyfont 2825*43c1707eStholo\let\t=\indexdummyfont 2826*43c1707eStholo\let\r=\indexdummyfont 2827*43c1707eStholo\let\i=\indexdummyfont 2828*43c1707eStholo\let\b=\indexdummyfont 2829*43c1707eStholo\let\emph=\indexdummyfont 2830*43c1707eStholo\let\strong=\indexdummyfont 2831*43c1707eStholo\let\cite=\indexdummyfont 2832*43c1707eStholo\let\sc=\indexdummyfont 2833*43c1707eStholo%Don't no-op \tt, since it isn't a user-level command 2834*43c1707eStholo% and is used in the definitions of the active chars like <, >, |... 2835*43c1707eStholo%\let\tt=\indexdummyfont 2836*43c1707eStholo\let\tclose=\indexdummyfont 2837*43c1707eStholo\let\code=\indexdummyfont 2838*43c1707eStholo\let\url=\indexdummyfont 2839*43c1707eStholo\let\uref=\indexdummyfont 2840*43c1707eStholo\let\env=\indexdummyfont 2841*43c1707eStholo\let\acronym=\indexdummyfont 2842*43c1707eStholo\let\command=\indexdummyfont 2843*43c1707eStholo\let\option=\indexdummyfont 2844*43c1707eStholo\let\file=\indexdummyfont 2845*43c1707eStholo\let\samp=\indexdummyfont 2846*43c1707eStholo\let\kbd=\indexdummyfont 2847*43c1707eStholo\let\key=\indexdummyfont 2848*43c1707eStholo\let\var=\indexdummyfont 2849*43c1707eStholo\let\TeX=\indexdummytex 2850*43c1707eStholo\let\dots=\indexdummydots 2851*43c1707eStholo\def\@{@}% 2852*43c1707eStholo} 2853*43c1707eStholo 2854*43c1707eStholo% To define \realbackslash, we must make \ not be an escape. 2855*43c1707eStholo% We must first make another character (@) an escape 2856*43c1707eStholo% so we do not become unable to do a definition. 2857*43c1707eStholo 2858*43c1707eStholo{\catcode`\@=0 \catcode`\\=\other 2859*43c1707eStholo @gdef@realbackslash{\}} 2860*43c1707eStholo 2861*43c1707eStholo\let\indexbackslash=0 %overridden during \printindex. 2862*43c1707eStholo\let\SETmarginindex=\relax % put index entries in margin (undocumented)? 2863*43c1707eStholo 2864*43c1707eStholo% For \ifx comparisons. 2865*43c1707eStholo\def\emptymacro{\empty} 2866*43c1707eStholo 2867*43c1707eStholo% Most index entries go through here, but \dosubind is the general case. 2868*43c1707eStholo% 2869*43c1707eStholo\def\doind#1#2{\dosubind{#1}{#2}\empty} 2870*43c1707eStholo 2871*43c1707eStholo% Workhorse for all \fooindexes. 2872*43c1707eStholo% #1 is name of index, #2 is stuff to put there, #3 is subentry -- 2873*43c1707eStholo% \empty if called from \doind, as we usually are. The main exception 2874*43c1707eStholo% is with defuns, which call us directly. 2875*43c1707eStholo% 2876*43c1707eStholo\def\dosubind#1#2#3{% 2877*43c1707eStholo % Put the index entry in the margin if desired. 2878*43c1707eStholo \ifx\SETmarginindex\relax\else 2879*43c1707eStholo \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}% 2880*43c1707eStholo \fi 2881*43c1707eStholo {% 2882*43c1707eStholo \count255=\lastpenalty 2883*43c1707eStholo {% 2884*43c1707eStholo \indexdummies % Must do this here, since \bf, etc expand at this stage 2885*43c1707eStholo \escapechar=`\\ 2886*43c1707eStholo {% 2887*43c1707eStholo \let\folio = 0% We will expand all macros now EXCEPT \folio. 2888*43c1707eStholo \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now 2889*43c1707eStholo % so it will be output as is; and it will print as backslash. 2890*43c1707eStholo % 2891*43c1707eStholo \def\thirdarg{#3}% 2892*43c1707eStholo % 2893*43c1707eStholo % If third arg is present, precede it with space in sort key. 2894*43c1707eStholo \ifx\thirdarg\emptymacro 2895*43c1707eStholo \let\subentry = \empty 2896*43c1707eStholo \else 2897*43c1707eStholo \def\subentry{ #3}% 2898*43c1707eStholo \fi 2899*43c1707eStholo % 2900*43c1707eStholo % First process the index entry with all font commands turned 2901*43c1707eStholo % off to get the string to sort by. 2902*43c1707eStholo {\indexnofonts \xdef\indexsorttmp{#2\subentry}}% 2903*43c1707eStholo % 2904*43c1707eStholo % Now the real index entry with the fonts. 2905*43c1707eStholo \toks0 = {#2}% 2906*43c1707eStholo % 2907*43c1707eStholo % If third (subentry) arg is present, add it to the index 2908*43c1707eStholo % string. And include a space. 2909*43c1707eStholo \ifx\thirdarg\emptymacro \else 2910*43c1707eStholo \toks0 = \expandafter{\the\toks0 \space #3}% 2911*43c1707eStholo \fi 2912*43c1707eStholo % 2913*43c1707eStholo % Set up the complete index entry, with both the sort key 2914*43c1707eStholo % and the original text, including any font commands. We write 2915*43c1707eStholo % three arguments to \entry to the .?? file, texindex reduces to 2916*43c1707eStholo % two when writing the .??s sorted result. 2917*43c1707eStholo \edef\temp{% 2918*43c1707eStholo \write\csname#1indfile\endcsname{% 2919*43c1707eStholo \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}% 2920*43c1707eStholo }% 2921*43c1707eStholo % 2922*43c1707eStholo % If a skip is the last thing on the list now, preserve it 2923*43c1707eStholo % by backing up by \lastskip, doing the \write, then inserting 2924*43c1707eStholo % the skip again. Otherwise, the whatsit generated by the 2925*43c1707eStholo % \write will make \lastskip zero. The result is that sequences 2926*43c1707eStholo % like this: 2927*43c1707eStholo % @end defun 2928*43c1707eStholo % @tindex whatever 2929*43c1707eStholo % @defun ... 2930*43c1707eStholo % will have extra space inserted, because the \medbreak in the 2931*43c1707eStholo % start of the @defun won't see the skip inserted by the @end of 2932*43c1707eStholo % the previous defun. 2933*43c1707eStholo % 2934*43c1707eStholo % But don't do any of this if we're not in vertical mode. We 2935*43c1707eStholo % don't want to do a \vskip and prematurely end a paragraph. 2936*43c1707eStholo % 2937*43c1707eStholo % Avoid page breaks due to these extra skips, too. 2938*43c1707eStholo % 2939*43c1707eStholo \iflinks 2940*43c1707eStholo \ifvmode 2941*43c1707eStholo \skip0 = \lastskip 2942*43c1707eStholo \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi 2943*43c1707eStholo \fi 2944*43c1707eStholo % 2945*43c1707eStholo \temp % do the write 2946*43c1707eStholo % 2947*43c1707eStholo % 2948*43c1707eStholo \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi 2949*43c1707eStholo \fi 2950*43c1707eStholo }% 2951*43c1707eStholo }% 2952*43c1707eStholo \penalty\count255 2953*43c1707eStholo }% 2954*43c1707eStholo} 2955*43c1707eStholo 2956*43c1707eStholo% The index entry written in the file actually looks like 2957*43c1707eStholo% \entry {sortstring}{page}{topic} 2958*43c1707eStholo% or 2959*43c1707eStholo% \entry {sortstring}{page}{topic}{subtopic} 2960*43c1707eStholo% The texindex program reads in these files and writes files 2961*43c1707eStholo% containing these kinds of lines: 2962*43c1707eStholo% \initial {c} 2963*43c1707eStholo% before the first topic whose initial is c 2964*43c1707eStholo% \entry {topic}{pagelist} 2965*43c1707eStholo% for a topic that is used without subtopics 2966*43c1707eStholo% \primary {topic} 2967*43c1707eStholo% for the beginning of a topic that is used with subtopics 2968*43c1707eStholo% \secondary {subtopic}{pagelist} 2969*43c1707eStholo% for each subtopic. 2970*43c1707eStholo 2971*43c1707eStholo% Define the user-accessible indexing commands 2972*43c1707eStholo% @findex, @vindex, @kindex, @cindex. 2973*43c1707eStholo 2974*43c1707eStholo\def\findex {\fnindex} 2975*43c1707eStholo\def\kindex {\kyindex} 2976*43c1707eStholo\def\cindex {\cpindex} 2977*43c1707eStholo\def\vindex {\vrindex} 2978*43c1707eStholo\def\tindex {\tpindex} 2979*43c1707eStholo\def\pindex {\pgindex} 2980*43c1707eStholo 2981*43c1707eStholo\def\cindexsub {\begingroup\obeylines\cindexsub} 2982*43c1707eStholo{\obeylines % 2983*43c1707eStholo\gdef\cindexsub "#1" #2^^M{\endgroup % 2984*43c1707eStholo\dosubind{cp}{#2}{#1}}} 2985*43c1707eStholo 2986*43c1707eStholo% Define the macros used in formatting output of the sorted index material. 2987*43c1707eStholo 2988*43c1707eStholo% @printindex causes a particular index (the ??s file) to get printed. 2989*43c1707eStholo% It does not print any chapter heading (usually an @unnumbered). 2990*43c1707eStholo% 2991*43c1707eStholo\def\printindex{\parsearg\doprintindex} 2992*43c1707eStholo\def\doprintindex#1{\begingroup 2993*43c1707eStholo \dobreak \chapheadingskip{10000}% 2994*43c1707eStholo % 2995*43c1707eStholo \smallfonts \rm 2996*43c1707eStholo \tolerance = 9500 2997*43c1707eStholo \indexbreaks 2998*43c1707eStholo % 2999*43c1707eStholo % See if the index file exists and is nonempty. 3000*43c1707eStholo % Change catcode of @ here so that if the index file contains 3001*43c1707eStholo % \initial {@} 3002*43c1707eStholo % as its first line, TeX doesn't complain about mismatched braces 3003*43c1707eStholo % (because it thinks @} is a control sequence). 3004*43c1707eStholo \catcode`\@ = 11 3005*43c1707eStholo \openin 1 \jobname.#1s 3006*43c1707eStholo \ifeof 1 3007*43c1707eStholo % \enddoublecolumns gets confused if there is no text in the index, 3008*43c1707eStholo % and it loses the chapter title and the aux file entries for the 3009*43c1707eStholo % index. The easiest way to prevent this problem is to make sure 3010*43c1707eStholo % there is some text. 3011*43c1707eStholo \putwordIndexNonexistent 3012*43c1707eStholo \else 3013*43c1707eStholo % 3014*43c1707eStholo % If the index file exists but is empty, then \openin leaves \ifeof 3015*43c1707eStholo % false. We have to make TeX try to read something from the file, so 3016*43c1707eStholo % it can discover if there is anything in it. 3017*43c1707eStholo \read 1 to \temp 3018*43c1707eStholo \ifeof 1 3019*43c1707eStholo \putwordIndexIsEmpty 3020*43c1707eStholo \else 3021*43c1707eStholo % Index files are almost Texinfo source, but we use \ as the escape 3022*43c1707eStholo % character. It would be better to use @, but that's too big a change 3023*43c1707eStholo % to make right now. 3024*43c1707eStholo \def\indexbackslash{\rawbackslashxx}% 3025*43c1707eStholo \catcode`\\ = 0 3026*43c1707eStholo \escapechar = `\\ 3027*43c1707eStholo \begindoublecolumns 3028*43c1707eStholo \input \jobname.#1s 3029*43c1707eStholo \enddoublecolumns 3030*43c1707eStholo \fi 3031*43c1707eStholo \fi 3032*43c1707eStholo \closein 1 3033*43c1707eStholo\endgroup} 3034*43c1707eStholo 3035*43c1707eStholo% These macros are used by the sorted index file itself. 3036*43c1707eStholo% Change them to control the appearance of the index. 3037*43c1707eStholo 3038*43c1707eStholo\def\initial#1{{% 3039*43c1707eStholo % Some minor font changes for the special characters. 3040*43c1707eStholo \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt 3041*43c1707eStholo % 3042*43c1707eStholo % Remove any glue we may have, we'll be inserting our own. 3043*43c1707eStholo \removelastskip 3044*43c1707eStholo % 3045*43c1707eStholo % We like breaks before the index initials, so insert a bonus. 3046*43c1707eStholo \penalty -300 3047*43c1707eStholo % 3048*43c1707eStholo % Typeset the initial. Making this add up to a whole number of 3049*43c1707eStholo % baselineskips increases the chance of the dots lining up from column 3050*43c1707eStholo % to column. It still won't often be perfect, because of the stretch 3051*43c1707eStholo % we need before each entry, but it's better. 3052*43c1707eStholo % 3053*43c1707eStholo % No shrink because it confuses \balancecolumns. 3054*43c1707eStholo \vskip 1.67\baselineskip plus .5\baselineskip 3055*43c1707eStholo \leftline{\secbf #1}% 3056*43c1707eStholo \vskip .33\baselineskip plus .1\baselineskip 3057*43c1707eStholo % 3058*43c1707eStholo % Do our best not to break after the initial. 3059*43c1707eStholo \nobreak 3060*43c1707eStholo}} 3061*43c1707eStholo 3062*43c1707eStholo% This typesets a paragraph consisting of #1, dot leaders, and then #2 3063*43c1707eStholo% flush to the right margin. It is used for index and table of contents 3064*43c1707eStholo% entries. The paragraph is indented by \leftskip. 3065*43c1707eStholo% 3066*43c1707eStholo\def\entry#1#2{\begingroup 3067*43c1707eStholo % 3068*43c1707eStholo % Start a new paragraph if necessary, so our assignments below can't 3069*43c1707eStholo % affect previous text. 3070*43c1707eStholo \par 3071*43c1707eStholo % 3072*43c1707eStholo % Do not fill out the last line with white space. 3073*43c1707eStholo \parfillskip = 0in 3074*43c1707eStholo % 3075*43c1707eStholo % No extra space above this paragraph. 3076*43c1707eStholo \parskip = 0in 3077*43c1707eStholo % 3078*43c1707eStholo % Do not prefer a separate line ending with a hyphen to fewer lines. 3079*43c1707eStholo \finalhyphendemerits = 0 3080*43c1707eStholo % 3081*43c1707eStholo % \hangindent is only relevant when the entry text and page number 3082*43c1707eStholo % don't both fit on one line. In that case, bob suggests starting the 3083*43c1707eStholo % dots pretty far over on the line. Unfortunately, a large 3084*43c1707eStholo % indentation looks wrong when the entry text itself is broken across 3085*43c1707eStholo % lines. So we use a small indentation and put up with long leaders. 3086*43c1707eStholo % 3087*43c1707eStholo % \hangafter is reset to 1 (which is the value we want) at the start 3088*43c1707eStholo % of each paragraph, so we need not do anything with that. 3089*43c1707eStholo \hangindent = 2em 3090*43c1707eStholo % 3091*43c1707eStholo % When the entry text needs to be broken, just fill out the first line 3092*43c1707eStholo % with blank space. 3093*43c1707eStholo \rightskip = 0pt plus1fil 3094*43c1707eStholo % 3095*43c1707eStholo % A bit of stretch before each entry for the benefit of balancing columns. 3096*43c1707eStholo \vskip 0pt plus1pt 3097*43c1707eStholo % 3098*43c1707eStholo % Start a ``paragraph'' for the index entry so the line breaking 3099*43c1707eStholo % parameters we've set above will have an effect. 3100*43c1707eStholo \noindent 3101*43c1707eStholo % 3102*43c1707eStholo % Insert the text of the index entry. TeX will do line-breaking on it. 3103*43c1707eStholo #1% 3104*43c1707eStholo % The following is kludged to not output a line of dots in the index if 3105*43c1707eStholo % there are no page numbers. The next person who breaks this will be 3106*43c1707eStholo % cursed by a Unix daemon. 3107*43c1707eStholo \def\tempa{{\rm }}% 3108*43c1707eStholo \def\tempb{#2}% 3109*43c1707eStholo \edef\tempc{\tempa}% 3110*43c1707eStholo \edef\tempd{\tempb}% 3111*43c1707eStholo \ifx\tempc\tempd\ \else% 3112*43c1707eStholo % 3113*43c1707eStholo % If we must, put the page number on a line of its own, and fill out 3114*43c1707eStholo % this line with blank space. (The \hfil is overwhelmed with the 3115*43c1707eStholo % fill leaders glue in \indexdotfill if the page number does fit.) 3116*43c1707eStholo \hfil\penalty50 3117*43c1707eStholo \null\nobreak\indexdotfill % Have leaders before the page number. 3118*43c1707eStholo % 3119*43c1707eStholo % The `\ ' here is removed by the implicit \unskip that TeX does as 3120*43c1707eStholo % part of (the primitive) \par. Without it, a spurious underfull 3121*43c1707eStholo % \hbox ensues. 3122*43c1707eStholo \ifpdf 3123*43c1707eStholo \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. 3124*43c1707eStholo \else 3125*43c1707eStholo \ #2% The page number ends the paragraph. 3126*43c1707eStholo \fi 3127*43c1707eStholo \fi% 3128*43c1707eStholo \par 3129*43c1707eStholo\endgroup} 3130*43c1707eStholo 3131*43c1707eStholo% Like \dotfill except takes at least 1 em. 3132*43c1707eStholo\def\indexdotfill{\cleaders 3133*43c1707eStholo \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill} 3134*43c1707eStholo 3135*43c1707eStholo\def\primary #1{\line{#1\hfil}} 3136*43c1707eStholo 3137*43c1707eStholo\newskip\secondaryindent \secondaryindent=0.5cm 3138*43c1707eStholo 3139*43c1707eStholo\def\secondary #1#2{ 3140*43c1707eStholo{\parfillskip=0in \parskip=0in 3141*43c1707eStholo\hangindent =1in \hangafter=1 3142*43c1707eStholo\noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par 3143*43c1707eStholo}} 3144*43c1707eStholo 3145*43c1707eStholo% Define two-column mode, which we use to typeset indexes. 3146*43c1707eStholo% Adapted from the TeXbook, page 416, which is to say, 3147*43c1707eStholo% the manmac.tex format used to print the TeXbook itself. 3148*43c1707eStholo\catcode`\@=11 3149*43c1707eStholo 3150*43c1707eStholo\newbox\partialpage 3151*43c1707eStholo\newdimen\doublecolumnhsize 3152*43c1707eStholo 3153*43c1707eStholo\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns 3154*43c1707eStholo % Grab any single-column material above us. 3155*43c1707eStholo \output = {% 3156*43c1707eStholo % 3157*43c1707eStholo % Here is a possibility not foreseen in manmac: if we accumulate a 3158*43c1707eStholo % whole lot of material, we might end up calling this \output 3159*43c1707eStholo % routine twice in a row (see the doublecol-lose test, which is 3160*43c1707eStholo % essentially a couple of indexes with @setchapternewpage off). In 3161*43c1707eStholo % that case we just ship out what is in \partialpage with the normal 3162*43c1707eStholo % output routine. Generally, \partialpage will be empty when this 3163*43c1707eStholo % runs and this will be a no-op. See the indexspread.tex test case. 3164*43c1707eStholo \ifvoid\partialpage \else 3165*43c1707eStholo \onepageout{\pagecontents\partialpage}% 3166*43c1707eStholo \fi 3167*43c1707eStholo % 3168*43c1707eStholo \global\setbox\partialpage = \vbox{% 3169*43c1707eStholo % Unvbox the main output page. 3170*43c1707eStholo \unvbox\PAGE 3171*43c1707eStholo \kern-\topskip \kern\baselineskip 3172*43c1707eStholo }% 3173*43c1707eStholo }% 3174*43c1707eStholo \eject % run that output routine to set \partialpage 3175*43c1707eStholo % 3176*43c1707eStholo % Use the double-column output routine for subsequent pages. 3177*43c1707eStholo \output = {\doublecolumnout}% 3178*43c1707eStholo % 3179*43c1707eStholo % Change the page size parameters. We could do this once outside this 3180*43c1707eStholo % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 3181*43c1707eStholo % format, but then we repeat the same computation. Repeating a couple 3182*43c1707eStholo % of assignments once per index is clearly meaningless for the 3183*43c1707eStholo % execution time, so we may as well do it in one place. 3184*43c1707eStholo % 3185*43c1707eStholo % First we halve the line length, less a little for the gutter between 3186*43c1707eStholo % the columns. We compute the gutter based on the line length, so it 3187*43c1707eStholo % changes automatically with the paper format. The magic constant 3188*43c1707eStholo % below is chosen so that the gutter has the same value (well, +-<1pt) 3189*43c1707eStholo % as it did when we hard-coded it. 3190*43c1707eStholo % 3191*43c1707eStholo % We put the result in a separate register, \doublecolumhsize, so we 3192*43c1707eStholo % can restore it in \pagesofar, after \hsize itself has (potentially) 3193*43c1707eStholo % been clobbered. 3194*43c1707eStholo % 3195*43c1707eStholo \doublecolumnhsize = \hsize 3196*43c1707eStholo \advance\doublecolumnhsize by -.04154\hsize 3197*43c1707eStholo \divide\doublecolumnhsize by 2 3198*43c1707eStholo \hsize = \doublecolumnhsize 3199*43c1707eStholo % 3200*43c1707eStholo % Double the \vsize as well. (We don't need a separate register here, 3201*43c1707eStholo % since nobody clobbers \vsize.) 3202*43c1707eStholo \vsize = 2\vsize 3203*43c1707eStholo} 3204*43c1707eStholo 3205*43c1707eStholo% The double-column output routine for all double-column pages except 3206*43c1707eStholo% the last. 3207*43c1707eStholo% 3208*43c1707eStholo\def\doublecolumnout{% 3209*43c1707eStholo \splittopskip=\topskip \splitmaxdepth=\maxdepth 3210*43c1707eStholo % Get the available space for the double columns -- the normal 3211*43c1707eStholo % (undoubled) page height minus any material left over from the 3212*43c1707eStholo % previous page. 3213*43c1707eStholo \dimen@ = \vsize 3214*43c1707eStholo \divide\dimen@ by 2 3215*43c1707eStholo \advance\dimen@ by -\ht\partialpage 3216*43c1707eStholo % 3217*43c1707eStholo % box0 will be the left-hand column, box2 the right. 3218*43c1707eStholo \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ 3219*43c1707eStholo \onepageout\pagesofar 3220*43c1707eStholo \unvbox255 3221*43c1707eStholo \penalty\outputpenalty 3222*43c1707eStholo} 3223*43c1707eStholo% 3224*43c1707eStholo% Re-output the contents of the output page -- any previous material, 3225*43c1707eStholo% followed by the two boxes we just split, in box0 and box2. 3226*43c1707eStholo\def\pagesofar{% 3227*43c1707eStholo \unvbox\partialpage 3228*43c1707eStholo % 3229*43c1707eStholo \hsize = \doublecolumnhsize 3230*43c1707eStholo \wd0=\hsize \wd2=\hsize 3231*43c1707eStholo \hbox to\pagewidth{\box0\hfil\box2}% 3232*43c1707eStholo} 3233*43c1707eStholo% 3234*43c1707eStholo% All done with double columns. 3235*43c1707eStholo\def\enddoublecolumns{% 3236*43c1707eStholo \output = {% 3237*43c1707eStholo % Split the last of the double-column material. Leave it on the 3238*43c1707eStholo % current page, no automatic page break. 3239*43c1707eStholo \balancecolumns 3240*43c1707eStholo % 3241*43c1707eStholo % If we end up splitting too much material for the current page, 3242*43c1707eStholo % though, there will be another page break right after this \output 3243*43c1707eStholo % invocation ends. Having called \balancecolumns once, we do not 3244*43c1707eStholo % want to call it again. Therefore, reset \output to its normal 3245*43c1707eStholo % definition right away. (We hope \balancecolumns will never be 3246*43c1707eStholo % called on to balance too much material, but if it is, this makes 3247*43c1707eStholo % the output somewhat more palatable.) 3248*43c1707eStholo \global\output = {\onepageout{\pagecontents\PAGE}}% 3249*43c1707eStholo }% 3250*43c1707eStholo \eject 3251*43c1707eStholo \endgroup % started in \begindoublecolumns 3252*43c1707eStholo % 3253*43c1707eStholo % \pagegoal was set to the doubled \vsize above, since we restarted 3254*43c1707eStholo % the current page. We're now back to normal single-column 3255*43c1707eStholo % typesetting, so reset \pagegoal to the normal \vsize (after the 3256*43c1707eStholo % \endgroup where \vsize got restored). 3257*43c1707eStholo \pagegoal = \vsize 3258*43c1707eStholo} 3259*43c1707eStholo% 3260*43c1707eStholo% Called at the end of the double column material. 3261*43c1707eStholo\def\balancecolumns{% 3262*43c1707eStholo \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. 3263*43c1707eStholo \dimen@ = \ht0 3264*43c1707eStholo \advance\dimen@ by \topskip 3265*43c1707eStholo \advance\dimen@ by-\baselineskip 3266*43c1707eStholo \divide\dimen@ by 2 % target to split to 3267*43c1707eStholo %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% 3268*43c1707eStholo \splittopskip = \topskip 3269*43c1707eStholo % Loop until we get a decent breakpoint. 3270*43c1707eStholo {% 3271*43c1707eStholo \vbadness = 10000 3272*43c1707eStholo \loop 3273*43c1707eStholo \global\setbox3 = \copy0 3274*43c1707eStholo \global\setbox1 = \vsplit3 to \dimen@ 3275*43c1707eStholo \ifdim\ht3>\dimen@ 3276*43c1707eStholo \global\advance\dimen@ by 1pt 3277*43c1707eStholo \repeat 3278*43c1707eStholo }% 3279*43c1707eStholo %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% 3280*43c1707eStholo \setbox0=\vbox to\dimen@{\unvbox1}% 3281*43c1707eStholo \setbox2=\vbox to\dimen@{\unvbox3}% 3282*43c1707eStholo % 3283*43c1707eStholo \pagesofar 3284*43c1707eStholo} 3285*43c1707eStholo\catcode`\@ = \other 3286*43c1707eStholo 3287*43c1707eStholo 3288*43c1707eStholo\message{sectioning,} 3289*43c1707eStholo% Chapters, sections, etc. 3290*43c1707eStholo 3291*43c1707eStholo\newcount\chapno 3292*43c1707eStholo\newcount\secno \secno=0 3293*43c1707eStholo\newcount\subsecno \subsecno=0 3294*43c1707eStholo\newcount\subsubsecno \subsubsecno=0 3295*43c1707eStholo 3296*43c1707eStholo% This counter is funny since it counts through charcodes of letters A, B, ... 3297*43c1707eStholo\newcount\appendixno \appendixno = `\@ 3298*43c1707eStholo% \def\appendixletter{\char\the\appendixno} 3299*43c1707eStholo% We do the following for the sake of pdftex, which needs the actual 3300*43c1707eStholo% letter in the expansion, not just typeset. 3301*43c1707eStholo\def\appendixletter{% 3302*43c1707eStholo \ifnum\appendixno=`A A% 3303*43c1707eStholo \else\ifnum\appendixno=`B B% 3304*43c1707eStholo \else\ifnum\appendixno=`C C% 3305*43c1707eStholo \else\ifnum\appendixno=`D D% 3306*43c1707eStholo \else\ifnum\appendixno=`E E% 3307*43c1707eStholo \else\ifnum\appendixno=`F F% 3308*43c1707eStholo \else\ifnum\appendixno=`G G% 3309*43c1707eStholo \else\ifnum\appendixno=`H H% 3310*43c1707eStholo \else\ifnum\appendixno=`I I% 3311*43c1707eStholo \else\ifnum\appendixno=`J J% 3312*43c1707eStholo \else\ifnum\appendixno=`K K% 3313*43c1707eStholo \else\ifnum\appendixno=`L L% 3314*43c1707eStholo \else\ifnum\appendixno=`M M% 3315*43c1707eStholo \else\ifnum\appendixno=`N N% 3316*43c1707eStholo \else\ifnum\appendixno=`O O% 3317*43c1707eStholo \else\ifnum\appendixno=`P P% 3318*43c1707eStholo \else\ifnum\appendixno=`Q Q% 3319*43c1707eStholo \else\ifnum\appendixno=`R R% 3320*43c1707eStholo \else\ifnum\appendixno=`S S% 3321*43c1707eStholo \else\ifnum\appendixno=`T T% 3322*43c1707eStholo \else\ifnum\appendixno=`U U% 3323*43c1707eStholo \else\ifnum\appendixno=`V V% 3324*43c1707eStholo \else\ifnum\appendixno=`W W% 3325*43c1707eStholo \else\ifnum\appendixno=`X X% 3326*43c1707eStholo \else\ifnum\appendixno=`Y Y% 3327*43c1707eStholo \else\ifnum\appendixno=`Z Z% 3328*43c1707eStholo % The \the is necessary, despite appearances, because \appendixletter is 3329*43c1707eStholo % expanded while writing the .toc file. \char\appendixno is not 3330*43c1707eStholo % expandable, thus it is written literally, thus all appendixes come out 3331*43c1707eStholo % with the same letter (or @) in the toc without it. 3332*43c1707eStholo \else\char\the\appendixno 3333*43c1707eStholo \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 3334*43c1707eStholo \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} 3335*43c1707eStholo 3336*43c1707eStholo% Each @chapter defines this as the name of the chapter. 3337*43c1707eStholo% page headings and footings can use it. @section does likewise. 3338*43c1707eStholo\def\thischapter{} 3339*43c1707eStholo\def\thissection{} 3340*43c1707eStholo 3341*43c1707eStholo\newcount\absseclevel % used to calculate proper heading level 3342*43c1707eStholo\newcount\secbase\secbase=0 % @raise/lowersections modify this count 3343*43c1707eStholo 3344*43c1707eStholo% @raisesections: treat @section as chapter, @subsection as section, etc. 3345*43c1707eStholo\def\raisesections{\global\advance\secbase by -1} 3346*43c1707eStholo\let\up=\raisesections % original BFox name 3347*43c1707eStholo 3348*43c1707eStholo% @lowersections: treat @chapter as section, @section as subsection, etc. 3349*43c1707eStholo\def\lowersections{\global\advance\secbase by 1} 3350*43c1707eStholo\let\down=\lowersections % original BFox name 3351*43c1707eStholo 3352*43c1707eStholo% Choose a numbered-heading macro 3353*43c1707eStholo% #1 is heading level if unmodified by @raisesections or @lowersections 3354*43c1707eStholo% #2 is text for heading 3355*43c1707eStholo\def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 3356*43c1707eStholo\ifcase\absseclevel 3357*43c1707eStholo \chapterzzz{#2} 3358*43c1707eStholo\or 3359*43c1707eStholo \seczzz{#2} 3360*43c1707eStholo\or 3361*43c1707eStholo \numberedsubseczzz{#2} 3362*43c1707eStholo\or 3363*43c1707eStholo \numberedsubsubseczzz{#2} 3364*43c1707eStholo\else 3365*43c1707eStholo \ifnum \absseclevel<0 3366*43c1707eStholo \chapterzzz{#2} 3367*43c1707eStholo \else 3368*43c1707eStholo \numberedsubsubseczzz{#2} 3369*43c1707eStholo \fi 3370*43c1707eStholo\fi 3371*43c1707eStholo} 3372*43c1707eStholo 3373*43c1707eStholo% like \numhead, but chooses appendix heading levels 3374*43c1707eStholo\def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 3375*43c1707eStholo\ifcase\absseclevel 3376*43c1707eStholo \appendixzzz{#2} 3377*43c1707eStholo\or 3378*43c1707eStholo \appendixsectionzzz{#2} 3379*43c1707eStholo\or 3380*43c1707eStholo \appendixsubseczzz{#2} 3381*43c1707eStholo\or 3382*43c1707eStholo \appendixsubsubseczzz{#2} 3383*43c1707eStholo\else 3384*43c1707eStholo \ifnum \absseclevel<0 3385*43c1707eStholo \appendixzzz{#2} 3386*43c1707eStholo \else 3387*43c1707eStholo \appendixsubsubseczzz{#2} 3388*43c1707eStholo \fi 3389*43c1707eStholo\fi 3390*43c1707eStholo} 3391*43c1707eStholo 3392*43c1707eStholo% like \numhead, but chooses numberless heading levels 3393*43c1707eStholo\def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 3394*43c1707eStholo\ifcase\absseclevel 3395*43c1707eStholo \unnumberedzzz{#2} 3396*43c1707eStholo\or 3397*43c1707eStholo \unnumberedseczzz{#2} 3398*43c1707eStholo\or 3399*43c1707eStholo \unnumberedsubseczzz{#2} 3400*43c1707eStholo\or 3401*43c1707eStholo \unnumberedsubsubseczzz{#2} 3402*43c1707eStholo\else 3403*43c1707eStholo \ifnum \absseclevel<0 3404*43c1707eStholo \unnumberedzzz{#2} 3405*43c1707eStholo \else 3406*43c1707eStholo \unnumberedsubsubseczzz{#2} 3407*43c1707eStholo \fi 3408*43c1707eStholo\fi 3409*43c1707eStholo} 3410*43c1707eStholo 3411*43c1707eStholo% @chapter, @appendix, @unnumbered. 3412*43c1707eStholo\def\thischaptername{No Chapter Title} 3413*43c1707eStholo\outer\def\chapter{\parsearg\chapteryyy} 3414*43c1707eStholo\def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz 3415*43c1707eStholo\def\chapterzzz #1{% 3416*43c1707eStholo\secno=0 \subsecno=0 \subsubsecno=0 3417*43c1707eStholo\global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}% 3418*43c1707eStholo\chapmacro {#1}{\the\chapno}% 3419*43c1707eStholo\gdef\thissection{#1}% 3420*43c1707eStholo\gdef\thischaptername{#1}% 3421*43c1707eStholo% We don't substitute the actual chapter name into \thischapter 3422*43c1707eStholo% because we don't want its macros evaluated now. 3423*43c1707eStholo\xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}% 3424*43c1707eStholo\toks0 = {#1}% 3425*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}% 3426*43c1707eStholo {\the\chapno}}}% 3427*43c1707eStholo\temp 3428*43c1707eStholo\donoderef 3429*43c1707eStholo\global\let\section = \numberedsec 3430*43c1707eStholo\global\let\subsection = \numberedsubsec 3431*43c1707eStholo\global\let\subsubsection = \numberedsubsubsec 3432*43c1707eStholo} 3433*43c1707eStholo 3434*43c1707eStholo\outer\def\appendix{\parsearg\appendixyyy} 3435*43c1707eStholo\def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz 3436*43c1707eStholo\def\appendixzzz #1{% 3437*43c1707eStholo\secno=0 \subsecno=0 \subsubsecno=0 3438*43c1707eStholo\global\advance \appendixno by 1 3439*43c1707eStholo\message{\putwordAppendix\space \appendixletter}% 3440*43c1707eStholo\chapmacro {#1}{\putwordAppendix{} \appendixletter}% 3441*43c1707eStholo\gdef\thissection{#1}% 3442*43c1707eStholo\gdef\thischaptername{#1}% 3443*43c1707eStholo\xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}% 3444*43c1707eStholo\toks0 = {#1}% 3445*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}% 3446*43c1707eStholo {\putwordAppendix{} \appendixletter}}}% 3447*43c1707eStholo\temp 3448*43c1707eStholo\appendixnoderef 3449*43c1707eStholo\global\let\section = \appendixsec 3450*43c1707eStholo\global\let\subsection = \appendixsubsec 3451*43c1707eStholo\global\let\subsubsection = \appendixsubsubsec 3452*43c1707eStholo} 3453*43c1707eStholo 3454*43c1707eStholo% @centerchap is like @unnumbered, but the heading is centered. 3455*43c1707eStholo\outer\def\centerchap{\parsearg\centerchapyyy} 3456*43c1707eStholo\def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}} 3457*43c1707eStholo 3458*43c1707eStholo% @top is like @unnumbered. 3459*43c1707eStholo\outer\def\top{\parsearg\unnumberedyyy} 3460*43c1707eStholo 3461*43c1707eStholo\outer\def\unnumbered{\parsearg\unnumberedyyy} 3462*43c1707eStholo\def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz 3463*43c1707eStholo\def\unnumberedzzz #1{% 3464*43c1707eStholo\secno=0 \subsecno=0 \subsubsecno=0 3465*43c1707eStholo% 3466*43c1707eStholo% This used to be simply \message{#1}, but TeX fully expands the 3467*43c1707eStholo% argument to \message. Therefore, if #1 contained @-commands, TeX 3468*43c1707eStholo% expanded them. For example, in `@unnumbered The @cite{Book}', TeX 3469*43c1707eStholo% expanded @cite (which turns out to cause errors because \cite is meant 3470*43c1707eStholo% to be executed, not expanded). 3471*43c1707eStholo% 3472*43c1707eStholo% Anyway, we don't want the fully-expanded definition of @cite to appear 3473*43c1707eStholo% as a result of the \message, we just want `@cite' itself. We use 3474*43c1707eStholo% \the<toks register> to achieve this: TeX expands \the<toks> only once, 3475*43c1707eStholo% simply yielding the contents of <toks register>. (We also do this for 3476*43c1707eStholo% the toc entries.) 3477*43c1707eStholo\toks0 = {#1}\message{(\the\toks0)}% 3478*43c1707eStholo% 3479*43c1707eStholo\unnumbchapmacro {#1}% 3480*43c1707eStholo\gdef\thischapter{#1}\gdef\thissection{#1}% 3481*43c1707eStholo\toks0 = {#1}% 3482*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}% 3483*43c1707eStholo\temp 3484*43c1707eStholo\unnumbnoderef 3485*43c1707eStholo\global\let\section = \unnumberedsec 3486*43c1707eStholo\global\let\subsection = \unnumberedsubsec 3487*43c1707eStholo\global\let\subsubsection = \unnumberedsubsubsec 3488*43c1707eStholo} 3489*43c1707eStholo 3490*43c1707eStholo% Sections. 3491*43c1707eStholo\outer\def\numberedsec{\parsearg\secyyy} 3492*43c1707eStholo\def\secyyy #1{\numhead1{#1}} % normally calls seczzz 3493*43c1707eStholo\def\seczzz #1{% 3494*43c1707eStholo\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 % 3495*43c1707eStholo\gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}% 3496*43c1707eStholo\toks0 = {#1}% 3497*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}% 3498*43c1707eStholo {\the\chapno}{\the\secno}}}% 3499*43c1707eStholo\temp 3500*43c1707eStholo\donoderef 3501*43c1707eStholo\nobreak 3502*43c1707eStholo} 3503*43c1707eStholo 3504*43c1707eStholo\outer\def\appendixsection{\parsearg\appendixsecyyy} 3505*43c1707eStholo\outer\def\appendixsec{\parsearg\appendixsecyyy} 3506*43c1707eStholo\def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz 3507*43c1707eStholo\def\appendixsectionzzz #1{% 3508*43c1707eStholo\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 % 3509*43c1707eStholo\gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}% 3510*43c1707eStholo\toks0 = {#1}% 3511*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}% 3512*43c1707eStholo {\appendixletter}{\the\secno}}}% 3513*43c1707eStholo\temp 3514*43c1707eStholo\appendixnoderef 3515*43c1707eStholo\nobreak 3516*43c1707eStholo} 3517*43c1707eStholo 3518*43c1707eStholo\outer\def\unnumberedsec{\parsearg\unnumberedsecyyy} 3519*43c1707eStholo\def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz 3520*43c1707eStholo\def\unnumberedseczzz #1{% 3521*43c1707eStholo\plainsecheading {#1}\gdef\thissection{#1}% 3522*43c1707eStholo\toks0 = {#1}% 3523*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}% 3524*43c1707eStholo\temp 3525*43c1707eStholo\unnumbnoderef 3526*43c1707eStholo\nobreak 3527*43c1707eStholo} 3528*43c1707eStholo 3529*43c1707eStholo% Subsections. 3530*43c1707eStholo\outer\def\numberedsubsec{\parsearg\numberedsubsecyyy} 3531*43c1707eStholo\def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz 3532*43c1707eStholo\def\numberedsubseczzz #1{% 3533*43c1707eStholo\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % 3534*43c1707eStholo\subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}% 3535*43c1707eStholo\toks0 = {#1}% 3536*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}% 3537*43c1707eStholo {\the\chapno}{\the\secno}{\the\subsecno}}}% 3538*43c1707eStholo\temp 3539*43c1707eStholo\donoderef 3540*43c1707eStholo\nobreak 3541*43c1707eStholo} 3542*43c1707eStholo 3543*43c1707eStholo\outer\def\appendixsubsec{\parsearg\appendixsubsecyyy} 3544*43c1707eStholo\def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz 3545*43c1707eStholo\def\appendixsubseczzz #1{% 3546*43c1707eStholo\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % 3547*43c1707eStholo\subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}% 3548*43c1707eStholo\toks0 = {#1}% 3549*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}% 3550*43c1707eStholo {\appendixletter}{\the\secno}{\the\subsecno}}}% 3551*43c1707eStholo\temp 3552*43c1707eStholo\appendixnoderef 3553*43c1707eStholo\nobreak 3554*43c1707eStholo} 3555*43c1707eStholo 3556*43c1707eStholo\outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy} 3557*43c1707eStholo\def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz 3558*43c1707eStholo\def\unnumberedsubseczzz #1{% 3559*43c1707eStholo\plainsubsecheading {#1}\gdef\thissection{#1}% 3560*43c1707eStholo\toks0 = {#1}% 3561*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry% 3562*43c1707eStholo {\the\toks0}}}% 3563*43c1707eStholo\temp 3564*43c1707eStholo\unnumbnoderef 3565*43c1707eStholo\nobreak 3566*43c1707eStholo} 3567*43c1707eStholo 3568*43c1707eStholo% Subsubsections. 3569*43c1707eStholo\outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy} 3570*43c1707eStholo\def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz 3571*43c1707eStholo\def\numberedsubsubseczzz #1{% 3572*43c1707eStholo\gdef\thissection{#1}\global\advance \subsubsecno by 1 % 3573*43c1707eStholo\subsubsecheading {#1} 3574*43c1707eStholo {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}% 3575*43c1707eStholo\toks0 = {#1}% 3576*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}% 3577*43c1707eStholo {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}% 3578*43c1707eStholo\temp 3579*43c1707eStholo\donoderef 3580*43c1707eStholo\nobreak 3581*43c1707eStholo} 3582*43c1707eStholo 3583*43c1707eStholo\outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy} 3584*43c1707eStholo\def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz 3585*43c1707eStholo\def\appendixsubsubseczzz #1{% 3586*43c1707eStholo\gdef\thissection{#1}\global\advance \subsubsecno by 1 % 3587*43c1707eStholo\subsubsecheading {#1} 3588*43c1707eStholo {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}% 3589*43c1707eStholo\toks0 = {#1}% 3590*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}% 3591*43c1707eStholo {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}% 3592*43c1707eStholo\temp 3593*43c1707eStholo\appendixnoderef 3594*43c1707eStholo\nobreak 3595*43c1707eStholo} 3596*43c1707eStholo 3597*43c1707eStholo\outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy} 3598*43c1707eStholo\def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz 3599*43c1707eStholo\def\unnumberedsubsubseczzz #1{% 3600*43c1707eStholo\plainsubsubsecheading {#1}\gdef\thissection{#1}% 3601*43c1707eStholo\toks0 = {#1}% 3602*43c1707eStholo\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry% 3603*43c1707eStholo {\the\toks0}}}% 3604*43c1707eStholo\temp 3605*43c1707eStholo\unnumbnoderef 3606*43c1707eStholo\nobreak 3607*43c1707eStholo} 3608*43c1707eStholo 3609*43c1707eStholo% These are variants which are not "outer", so they can appear in @ifinfo. 3610*43c1707eStholo% Actually, they should now be obsolete; ordinary section commands should work. 3611*43c1707eStholo\def\infotop{\parsearg\unnumberedzzz} 3612*43c1707eStholo\def\infounnumbered{\parsearg\unnumberedzzz} 3613*43c1707eStholo\def\infounnumberedsec{\parsearg\unnumberedseczzz} 3614*43c1707eStholo\def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz} 3615*43c1707eStholo\def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz} 3616*43c1707eStholo 3617*43c1707eStholo\def\infoappendix{\parsearg\appendixzzz} 3618*43c1707eStholo\def\infoappendixsec{\parsearg\appendixseczzz} 3619*43c1707eStholo\def\infoappendixsubsec{\parsearg\appendixsubseczzz} 3620*43c1707eStholo\def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz} 3621*43c1707eStholo 3622*43c1707eStholo\def\infochapter{\parsearg\chapterzzz} 3623*43c1707eStholo\def\infosection{\parsearg\sectionzzz} 3624*43c1707eStholo\def\infosubsection{\parsearg\subsectionzzz} 3625*43c1707eStholo\def\infosubsubsection{\parsearg\subsubsectionzzz} 3626*43c1707eStholo 3627*43c1707eStholo% These macros control what the section commands do, according 3628*43c1707eStholo% to what kind of chapter we are in (ordinary, appendix, or unnumbered). 3629*43c1707eStholo% Define them by default for a numbered chapter. 3630*43c1707eStholo\global\let\section = \numberedsec 3631*43c1707eStholo\global\let\subsection = \numberedsubsec 3632*43c1707eStholo\global\let\subsubsection = \numberedsubsubsec 3633*43c1707eStholo 3634*43c1707eStholo% Define @majorheading, @heading and @subheading 3635*43c1707eStholo 3636*43c1707eStholo% NOTE on use of \vbox for chapter headings, section headings, and such: 3637*43c1707eStholo% 1) We use \vbox rather than the earlier \line to permit 3638*43c1707eStholo% overlong headings to fold. 3639*43c1707eStholo% 2) \hyphenpenalty is set to 10000 because hyphenation in a 3640*43c1707eStholo% heading is obnoxious; this forbids it. 3641*43c1707eStholo% 3) Likewise, headings look best if no \parindent is used, and 3642*43c1707eStholo% if justification is not attempted. Hence \raggedright. 3643*43c1707eStholo 3644*43c1707eStholo 3645*43c1707eStholo\def\majorheading{\parsearg\majorheadingzzz} 3646*43c1707eStholo\def\majorheadingzzz #1{% 3647*43c1707eStholo{\advance\chapheadingskip by 10pt \chapbreak }% 3648*43c1707eStholo{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 3649*43c1707eStholo \parindent=0pt\raggedright 3650*43c1707eStholo \rm #1\hfill}}\bigskip \par\penalty 200} 3651*43c1707eStholo 3652*43c1707eStholo\def\chapheading{\parsearg\chapheadingzzz} 3653*43c1707eStholo\def\chapheadingzzz #1{\chapbreak % 3654*43c1707eStholo{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 3655*43c1707eStholo \parindent=0pt\raggedright 3656*43c1707eStholo \rm #1\hfill}}\bigskip \par\penalty 200} 3657*43c1707eStholo 3658*43c1707eStholo% @heading, @subheading, @subsubheading. 3659*43c1707eStholo\def\heading{\parsearg\plainsecheading} 3660*43c1707eStholo\def\subheading{\parsearg\plainsubsecheading} 3661*43c1707eStholo\def\subsubheading{\parsearg\plainsubsubsecheading} 3662*43c1707eStholo 3663*43c1707eStholo% These macros generate a chapter, section, etc. heading only 3664*43c1707eStholo% (including whitespace, linebreaking, etc. around it), 3665*43c1707eStholo% given all the information in convenient, parsed form. 3666*43c1707eStholo 3667*43c1707eStholo%%% Args are the skip and penalty (usually negative) 3668*43c1707eStholo\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} 3669*43c1707eStholo 3670*43c1707eStholo\def\setchapterstyle #1 {\csname CHAPF#1\endcsname} 3671*43c1707eStholo 3672*43c1707eStholo%%% Define plain chapter starts, and page on/off switching for it 3673*43c1707eStholo% Parameter controlling skip before chapter headings (if needed) 3674*43c1707eStholo 3675*43c1707eStholo\newskip\chapheadingskip 3676*43c1707eStholo 3677*43c1707eStholo\def\chapbreak{\dobreak \chapheadingskip {-4000}} 3678*43c1707eStholo\def\chappager{\par\vfill\supereject} 3679*43c1707eStholo\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} 3680*43c1707eStholo 3681*43c1707eStholo\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} 3682*43c1707eStholo 3683*43c1707eStholo\def\CHAPPAGoff{% 3684*43c1707eStholo\global\let\contentsalignmacro = \chappager 3685*43c1707eStholo\global\let\pchapsepmacro=\chapbreak 3686*43c1707eStholo\global\let\pagealignmacro=\chappager} 3687*43c1707eStholo 3688*43c1707eStholo\def\CHAPPAGon{% 3689*43c1707eStholo\global\let\contentsalignmacro = \chappager 3690*43c1707eStholo\global\let\pchapsepmacro=\chappager 3691*43c1707eStholo\global\let\pagealignmacro=\chappager 3692*43c1707eStholo\global\def\HEADINGSon{\HEADINGSsingle}} 3693*43c1707eStholo 3694*43c1707eStholo\def\CHAPPAGodd{ 3695*43c1707eStholo\global\let\contentsalignmacro = \chapoddpage 3696*43c1707eStholo\global\let\pchapsepmacro=\chapoddpage 3697*43c1707eStholo\global\let\pagealignmacro=\chapoddpage 3698*43c1707eStholo\global\def\HEADINGSon{\HEADINGSdouble}} 3699*43c1707eStholo 3700*43c1707eStholo\CHAPPAGon 3701*43c1707eStholo 3702*43c1707eStholo\def\CHAPFplain{ 3703*43c1707eStholo\global\let\chapmacro=\chfplain 3704*43c1707eStholo\global\let\unnumbchapmacro=\unnchfplain 3705*43c1707eStholo\global\let\centerchapmacro=\centerchfplain} 3706*43c1707eStholo 3707*43c1707eStholo% Plain chapter opening. 3708*43c1707eStholo% #1 is the text, #2 the chapter number or empty if unnumbered. 3709*43c1707eStholo\def\chfplain#1#2{% 3710*43c1707eStholo \pchapsepmacro 3711*43c1707eStholo {% 3712*43c1707eStholo \chapfonts \rm 3713*43c1707eStholo \def\chapnum{#2}% 3714*43c1707eStholo \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}% 3715*43c1707eStholo \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 3716*43c1707eStholo \hangindent = \wd0 \centerparametersmaybe 3717*43c1707eStholo \unhbox0 #1\par}% 3718*43c1707eStholo }% 3719*43c1707eStholo \nobreak\bigskip % no page break after a chapter title 3720*43c1707eStholo \nobreak 3721*43c1707eStholo} 3722*43c1707eStholo 3723*43c1707eStholo% Plain opening for unnumbered. 3724*43c1707eStholo\def\unnchfplain#1{\chfplain{#1}{}} 3725*43c1707eStholo 3726*43c1707eStholo% @centerchap -- centered and unnumbered. 3727*43c1707eStholo\let\centerparametersmaybe = \relax 3728*43c1707eStholo\def\centerchfplain#1{{% 3729*43c1707eStholo \def\centerparametersmaybe{% 3730*43c1707eStholo \advance\rightskip by 3\rightskip 3731*43c1707eStholo \leftskip = \rightskip 3732*43c1707eStholo \parfillskip = 0pt 3733*43c1707eStholo }% 3734*43c1707eStholo \chfplain{#1}{}% 3735*43c1707eStholo}} 3736*43c1707eStholo 3737*43c1707eStholo\CHAPFplain % The default 3738*43c1707eStholo 3739*43c1707eStholo\def\unnchfopen #1{% 3740*43c1707eStholo\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 3741*43c1707eStholo \parindent=0pt\raggedright 3742*43c1707eStholo \rm #1\hfill}}\bigskip \par\nobreak 3743*43c1707eStholo} 3744*43c1707eStholo 3745*43c1707eStholo\def\chfopen #1#2{\chapoddpage {\chapfonts 3746*43c1707eStholo\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% 3747*43c1707eStholo\par\penalty 5000 % 3748*43c1707eStholo} 3749*43c1707eStholo 3750*43c1707eStholo\def\centerchfopen #1{% 3751*43c1707eStholo\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 3752*43c1707eStholo \parindent=0pt 3753*43c1707eStholo \hfill {\rm #1}\hfill}}\bigskip \par\nobreak 3754*43c1707eStholo} 3755*43c1707eStholo 3756*43c1707eStholo\def\CHAPFopen{ 3757*43c1707eStholo\global\let\chapmacro=\chfopen 3758*43c1707eStholo\global\let\unnumbchapmacro=\unnchfopen 3759*43c1707eStholo\global\let\centerchapmacro=\centerchfopen} 3760*43c1707eStholo 3761*43c1707eStholo 3762*43c1707eStholo% Section titles. 3763*43c1707eStholo\newskip\secheadingskip 3764*43c1707eStholo\def\secheadingbreak{\dobreak \secheadingskip {-1000}} 3765*43c1707eStholo\def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}} 3766*43c1707eStholo\def\plainsecheading#1{\sectionheading{sec}{}{#1}} 3767*43c1707eStholo 3768*43c1707eStholo% Subsection titles. 3769*43c1707eStholo\newskip \subsecheadingskip 3770*43c1707eStholo\def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}} 3771*43c1707eStholo\def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}} 3772*43c1707eStholo\def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}} 3773*43c1707eStholo 3774*43c1707eStholo% Subsubsection titles. 3775*43c1707eStholo\let\subsubsecheadingskip = \subsecheadingskip 3776*43c1707eStholo\let\subsubsecheadingbreak = \subsecheadingbreak 3777*43c1707eStholo\def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}} 3778*43c1707eStholo\def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}} 3779*43c1707eStholo 3780*43c1707eStholo 3781*43c1707eStholo% Print any size section title. 3782*43c1707eStholo% 3783*43c1707eStholo% #1 is the section type (sec/subsec/subsubsec), #2 is the section 3784*43c1707eStholo% number (maybe empty), #3 the text. 3785*43c1707eStholo\def\sectionheading#1#2#3{% 3786*43c1707eStholo {% 3787*43c1707eStholo \expandafter\advance\csname #1headingskip\endcsname by \parskip 3788*43c1707eStholo \csname #1headingbreak\endcsname 3789*43c1707eStholo }% 3790*43c1707eStholo {% 3791*43c1707eStholo % Switch to the right set of fonts. 3792*43c1707eStholo \csname #1fonts\endcsname \rm 3793*43c1707eStholo % 3794*43c1707eStholo % Only insert the separating space if we have a section number. 3795*43c1707eStholo \def\secnum{#2}% 3796*43c1707eStholo \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}% 3797*43c1707eStholo % 3798*43c1707eStholo \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 3799*43c1707eStholo \hangindent = \wd0 % zero if no section number 3800*43c1707eStholo \unhbox0 #3}% 3801*43c1707eStholo }% 3802*43c1707eStholo \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak 3803*43c1707eStholo} 3804*43c1707eStholo 3805*43c1707eStholo 3806*43c1707eStholo\message{toc,} 3807*43c1707eStholo% Table of contents. 3808*43c1707eStholo\newwrite\tocfile 3809*43c1707eStholo 3810*43c1707eStholo% Write an entry to the toc file, opening it if necessary. 3811*43c1707eStholo% Called from @chapter, etc. We supply {\folio} at the end of the 3812*43c1707eStholo% argument, which will end up as the last argument to the \...entry macro. 3813*43c1707eStholo% 3814*43c1707eStholo% We open the .toc file here instead of at @setfilename or any other 3815*43c1707eStholo% given time so that @contents can be put in the document anywhere. 3816*43c1707eStholo% 3817*43c1707eStholo\newif\iftocfileopened 3818*43c1707eStholo\def\writetocentry#1{% 3819*43c1707eStholo \iftocfileopened\else 3820*43c1707eStholo \immediate\openout\tocfile = \jobname.toc 3821*43c1707eStholo \global\tocfileopenedtrue 3822*43c1707eStholo \fi 3823*43c1707eStholo \iflinks \write\tocfile{#1{\folio}}\fi 3824*43c1707eStholo} 3825*43c1707eStholo 3826*43c1707eStholo\newskip\contentsrightmargin \contentsrightmargin=1in 3827*43c1707eStholo\newcount\savepageno 3828*43c1707eStholo\newcount\lastnegativepageno \lastnegativepageno = -1 3829*43c1707eStholo 3830*43c1707eStholo% Finish up the main text and prepare to read what we've written 3831*43c1707eStholo% to \tocfile. 3832*43c1707eStholo% 3833*43c1707eStholo\def\startcontents#1{% 3834*43c1707eStholo % If @setchapternewpage on, and @headings double, the contents should 3835*43c1707eStholo % start on an odd page, unlike chapters. Thus, we maintain 3836*43c1707eStholo % \contentsalignmacro in parallel with \pagealignmacro. 3837*43c1707eStholo % From: Torbjorn Granlund <tege@matematik.su.se> 3838*43c1707eStholo \contentsalignmacro 3839*43c1707eStholo \immediate\closeout\tocfile 3840*43c1707eStholo % 3841*43c1707eStholo % Don't need to put `Contents' or `Short Contents' in the headline. 3842*43c1707eStholo % It is abundantly clear what they are. 3843*43c1707eStholo \unnumbchapmacro{#1}\def\thischapter{}% 3844*43c1707eStholo \savepageno = \pageno 3845*43c1707eStholo \begingroup % Set up to handle contents files properly. 3846*43c1707eStholo \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11 3847*43c1707eStholo % We can't do this, because then an actual ^ in a section 3848*43c1707eStholo % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97. 3849*43c1707eStholo %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi 3850*43c1707eStholo \raggedbottom % Worry more about breakpoints than the bottom. 3851*43c1707eStholo \advance\hsize by -\contentsrightmargin % Don't use the full line length. 3852*43c1707eStholo % 3853*43c1707eStholo % Roman numerals for page numbers. 3854*43c1707eStholo \ifnum \pageno>0 \pageno = \lastnegativepageno \fi 3855*43c1707eStholo} 3856*43c1707eStholo 3857*43c1707eStholo 3858*43c1707eStholo% Normal (long) toc. 3859*43c1707eStholo\def\contents{% 3860*43c1707eStholo \startcontents{\putwordTOC}% 3861*43c1707eStholo \openin 1 \jobname.toc 3862*43c1707eStholo \ifeof 1 \else 3863*43c1707eStholo \closein 1 3864*43c1707eStholo \input \jobname.toc 3865*43c1707eStholo \fi 3866*43c1707eStholo \vfill \eject 3867*43c1707eStholo \contentsalignmacro % in case @setchapternewpage odd is in effect 3868*43c1707eStholo \pdfmakeoutlines 3869*43c1707eStholo \endgroup 3870*43c1707eStholo \lastnegativepageno = \pageno 3871*43c1707eStholo \pageno = \savepageno 3872*43c1707eStholo} 3873*43c1707eStholo 3874*43c1707eStholo% And just the chapters. 3875*43c1707eStholo\def\summarycontents{% 3876*43c1707eStholo \startcontents{\putwordShortTOC}% 3877*43c1707eStholo % 3878*43c1707eStholo \let\chapentry = \shortchapentry 3879*43c1707eStholo \let\unnumbchapentry = \shortunnumberedentry 3880*43c1707eStholo % We want a true roman here for the page numbers. 3881*43c1707eStholo \secfonts 3882*43c1707eStholo \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl 3883*43c1707eStholo \rm 3884*43c1707eStholo \hyphenpenalty = 10000 3885*43c1707eStholo \advance\baselineskip by 1pt % Open it up a little. 3886*43c1707eStholo \def\secentry ##1##2##3##4{} 3887*43c1707eStholo \def\unnumbsecentry ##1##2{} 3888*43c1707eStholo \def\subsecentry ##1##2##3##4##5{} 3889*43c1707eStholo \def\unnumbsubsecentry ##1##2{} 3890*43c1707eStholo \def\subsubsecentry ##1##2##3##4##5##6{} 3891*43c1707eStholo \def\unnumbsubsubsecentry ##1##2{} 3892*43c1707eStholo \openin 1 \jobname.toc 3893*43c1707eStholo \ifeof 1 \else 3894*43c1707eStholo \closein 1 3895*43c1707eStholo \input \jobname.toc 3896*43c1707eStholo \fi 3897*43c1707eStholo \vfill \eject 3898*43c1707eStholo \contentsalignmacro % in case @setchapternewpage odd is in effect 3899*43c1707eStholo \endgroup 3900*43c1707eStholo \lastnegativepageno = \pageno 3901*43c1707eStholo \pageno = \savepageno 3902*43c1707eStholo} 3903*43c1707eStholo\let\shortcontents = \summarycontents 3904*43c1707eStholo 3905*43c1707eStholo\ifpdf 3906*43c1707eStholo \pdfcatalog{/PageMode /UseOutlines}% 3907*43c1707eStholo\fi 3908*43c1707eStholo 3909*43c1707eStholo% These macros generate individual entries in the table of contents. 3910*43c1707eStholo% The first argument is the chapter or section name. 3911*43c1707eStholo% The last argument is the page number. 3912*43c1707eStholo% The arguments in between are the chapter number, section number, ... 3913*43c1707eStholo 3914*43c1707eStholo% Chapter-level things, for both the long and short contents. 3915*43c1707eStholo\def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}} 3916*43c1707eStholo 3917*43c1707eStholo% See comments in \dochapentry re vbox and related settings 3918*43c1707eStholo\def\shortchapentry#1#2#3{% 3919*43c1707eStholo \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}% 3920*43c1707eStholo} 3921*43c1707eStholo 3922*43c1707eStholo% Typeset the label for a chapter or appendix for the short contents. 3923*43c1707eStholo% The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter. 3924*43c1707eStholo% We could simplify the code here by writing out an \appendixentry 3925*43c1707eStholo% command in the toc file for appendices, instead of using \chapentry 3926*43c1707eStholo% for both, but it doesn't seem worth it. 3927*43c1707eStholo% 3928*43c1707eStholo\newdimen\shortappendixwidth 3929*43c1707eStholo% 3930*43c1707eStholo\def\shortchaplabel#1{% 3931*43c1707eStholo % Compute width of word "Appendix", may change with language. 3932*43c1707eStholo \setbox0 = \hbox{\shortcontrm \putwordAppendix}% 3933*43c1707eStholo \shortappendixwidth = \wd0 3934*43c1707eStholo % 3935*43c1707eStholo % We typeset #1 in a box of constant width, regardless of the text of 3936*43c1707eStholo % #1, so the chapter titles will come out aligned. 3937*43c1707eStholo \setbox0 = \hbox{#1}% 3938*43c1707eStholo \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi 3939*43c1707eStholo % 3940*43c1707eStholo % This space should be plenty, since a single number is .5em, and the 3941*43c1707eStholo % widest letter (M) is 1em, at least in the Computer Modern fonts. 3942*43c1707eStholo % (This space doesn't include the extra space that gets added after 3943*43c1707eStholo % the label; that gets put in by \shortchapentry above.) 3944*43c1707eStholo \advance\dimen0 by 1.1em 3945*43c1707eStholo \hbox to \dimen0{#1\hfil}% 3946*43c1707eStholo} 3947*43c1707eStholo 3948*43c1707eStholo\def\unnumbchapentry#1#2{\dochapentry{#1}{#2}} 3949*43c1707eStholo\def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}} 3950*43c1707eStholo 3951*43c1707eStholo% Sections. 3952*43c1707eStholo\def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}} 3953*43c1707eStholo\def\unnumbsecentry#1#2{\dosecentry{#1}{#2}} 3954*43c1707eStholo 3955*43c1707eStholo% Subsections. 3956*43c1707eStholo\def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}} 3957*43c1707eStholo\def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}} 3958*43c1707eStholo 3959*43c1707eStholo% And subsubsections. 3960*43c1707eStholo\def\subsubsecentry#1#2#3#4#5#6{% 3961*43c1707eStholo \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}} 3962*43c1707eStholo\def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}} 3963*43c1707eStholo 3964*43c1707eStholo% This parameter controls the indentation of the various levels. 3965*43c1707eStholo\newdimen\tocindent \tocindent = 3pc 3966*43c1707eStholo 3967*43c1707eStholo% Now for the actual typesetting. In all these, #1 is the text and #2 is the 3968*43c1707eStholo% page number. 3969*43c1707eStholo% 3970*43c1707eStholo% If the toc has to be broken over pages, we want it to be at chapters 3971*43c1707eStholo% if at all possible; hence the \penalty. 3972*43c1707eStholo\def\dochapentry#1#2{% 3973*43c1707eStholo \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip 3974*43c1707eStholo \begingroup 3975*43c1707eStholo \chapentryfonts 3976*43c1707eStholo \tocentry{#1}{\dopageno\bgroup#2\egroup}% 3977*43c1707eStholo \endgroup 3978*43c1707eStholo \nobreak\vskip .25\baselineskip plus.1\baselineskip 3979*43c1707eStholo} 3980*43c1707eStholo 3981*43c1707eStholo\def\dosecentry#1#2{\begingroup 3982*43c1707eStholo \secentryfonts \leftskip=\tocindent 3983*43c1707eStholo \tocentry{#1}{\dopageno\bgroup#2\egroup}% 3984*43c1707eStholo\endgroup} 3985*43c1707eStholo 3986*43c1707eStholo\def\dosubsecentry#1#2{\begingroup 3987*43c1707eStholo \subsecentryfonts \leftskip=2\tocindent 3988*43c1707eStholo \tocentry{#1}{\dopageno\bgroup#2\egroup}% 3989*43c1707eStholo\endgroup} 3990*43c1707eStholo 3991*43c1707eStholo\def\dosubsubsecentry#1#2{\begingroup 3992*43c1707eStholo \subsubsecentryfonts \leftskip=3\tocindent 3993*43c1707eStholo \tocentry{#1}{\dopageno\bgroup#2\egroup}% 3994*43c1707eStholo\endgroup} 3995*43c1707eStholo 3996*43c1707eStholo% Final typesetting of a toc entry; we use the same \entry macro as for 3997*43c1707eStholo% the index entries, but we want to suppress hyphenation here. (We 3998*43c1707eStholo% can't do that in the \entry macro, since index entries might consist 3999*43c1707eStholo% of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.) 4000*43c1707eStholo\def\tocentry#1#2{\begingroup 4001*43c1707eStholo \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks 4002*43c1707eStholo % Do not use \turnoffactive in these arguments. Since the toc is 4003*43c1707eStholo % typeset in cmr, so characters such as _ would come out wrong; we 4004*43c1707eStholo % have to do the usual translation tricks. 4005*43c1707eStholo \entry{#1}{#2}% 4006*43c1707eStholo\endgroup} 4007*43c1707eStholo 4008*43c1707eStholo% Space between chapter (or whatever) number and the title. 4009*43c1707eStholo\def\labelspace{\hskip1em \relax} 4010*43c1707eStholo 4011*43c1707eStholo\def\dopageno#1{{\rm #1}} 4012*43c1707eStholo\def\doshortpageno#1{{\rm #1}} 4013*43c1707eStholo 4014*43c1707eStholo\def\chapentryfonts{\secfonts \rm} 4015*43c1707eStholo\def\secentryfonts{\textfonts} 4016*43c1707eStholo\let\subsecentryfonts = \textfonts 4017*43c1707eStholo\let\subsubsecentryfonts = \textfonts 4018*43c1707eStholo 4019*43c1707eStholo 4020*43c1707eStholo\message{environments,} 4021*43c1707eStholo% @foo ... @end foo. 4022*43c1707eStholo 4023*43c1707eStholo% Since these characters are used in examples, it should be an even number of 4024*43c1707eStholo% \tt widths. Each \tt character is 1en, so two makes it 1em. 4025*43c1707eStholo% Furthermore, these definitions must come after we define our fonts. 4026*43c1707eStholo\newbox\dblarrowbox \newbox\longdblarrowbox 4027*43c1707eStholo\newbox\pushcharbox \newbox\bullbox 4028*43c1707eStholo\newbox\equivbox \newbox\errorbox 4029*43c1707eStholo 4030*43c1707eStholo%{\tentt 4031*43c1707eStholo%\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil} 4032*43c1707eStholo%\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil} 4033*43c1707eStholo%\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil} 4034*43c1707eStholo%\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil} 4035*43c1707eStholo% Adapted from the manmac format (p.420 of TeXbook) 4036*43c1707eStholo%\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex 4037*43c1707eStholo% depth .1ex\hfil} 4038*43c1707eStholo%} 4039*43c1707eStholo 4040*43c1707eStholo% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. 4041*43c1707eStholo\def\point{$\star$} 4042*43c1707eStholo\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} 4043*43c1707eStholo\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} 4044*43c1707eStholo\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} 4045*43c1707eStholo\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} 4046*43c1707eStholo 4047*43c1707eStholo% Adapted from the TeXbook's \boxit. 4048*43c1707eStholo{\tentt \global\dimen0 = 3em}% Width of the box. 4049*43c1707eStholo\dimen2 = .55pt % Thickness of rules 4050*43c1707eStholo% The text. (`r' is open on the right, `e' somewhat less so on the left.) 4051*43c1707eStholo\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} 4052*43c1707eStholo 4053*43c1707eStholo\global\setbox\errorbox=\hbox to \dimen0{\hfil 4054*43c1707eStholo \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. 4055*43c1707eStholo \advance\hsize by -2\dimen2 % Rules. 4056*43c1707eStholo \vbox{ 4057*43c1707eStholo \hrule height\dimen2 4058*43c1707eStholo \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. 4059*43c1707eStholo \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. 4060*43c1707eStholo \kern3pt\vrule width\dimen2}% Space to right. 4061*43c1707eStholo \hrule height\dimen2} 4062*43c1707eStholo \hfil} 4063*43c1707eStholo 4064*43c1707eStholo% The @error{} command. 4065*43c1707eStholo\def\error{\leavevmode\lower.7ex\copy\errorbox} 4066*43c1707eStholo 4067*43c1707eStholo% @tex ... @end tex escapes into raw Tex temporarily. 4068*43c1707eStholo% One exception: @ is still an escape character, so that @end tex works. 4069*43c1707eStholo% But \@ or @@ will get a plain tex @ character. 4070*43c1707eStholo 4071*43c1707eStholo\def\tex{\begingroup 4072*43c1707eStholo \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 4073*43c1707eStholo \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 4074*43c1707eStholo \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie 4075*43c1707eStholo \catcode `\%=14 4076*43c1707eStholo \catcode 43=12 % plus 4077*43c1707eStholo \catcode`\"=12 4078*43c1707eStholo \catcode`\==12 4079*43c1707eStholo \catcode`\|=12 4080*43c1707eStholo \catcode`\<=12 4081*43c1707eStholo \catcode`\>=12 4082*43c1707eStholo \escapechar=`\\ 4083*43c1707eStholo % 4084*43c1707eStholo \let\b=\ptexb 4085*43c1707eStholo \let\bullet=\ptexbullet 4086*43c1707eStholo \let\c=\ptexc 4087*43c1707eStholo \let\,=\ptexcomma 4088*43c1707eStholo \let\.=\ptexdot 4089*43c1707eStholo \let\dots=\ptexdots 4090*43c1707eStholo \let\equiv=\ptexequiv 4091*43c1707eStholo \let\!=\ptexexclam 4092*43c1707eStholo \let\i=\ptexi 4093*43c1707eStholo \let\{=\ptexlbrace 4094*43c1707eStholo \let\+=\tabalign 4095*43c1707eStholo \let\}=\ptexrbrace 4096*43c1707eStholo \let\*=\ptexstar 4097*43c1707eStholo \let\t=\ptext 4098*43c1707eStholo % 4099*43c1707eStholo \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% 4100*43c1707eStholo \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% 4101*43c1707eStholo \def\@{@}% 4102*43c1707eStholo\let\Etex=\endgroup} 4103*43c1707eStholo 4104*43c1707eStholo% Define @lisp ... @endlisp. 4105*43c1707eStholo% @lisp does a \begingroup so it can rebind things, 4106*43c1707eStholo% including the definition of @endlisp (which normally is erroneous). 4107*43c1707eStholo 4108*43c1707eStholo% Amount to narrow the margins by for @lisp. 4109*43c1707eStholo\newskip\lispnarrowing \lispnarrowing=0.4in 4110*43c1707eStholo 4111*43c1707eStholo% This is the definition that ^^M gets inside @lisp, @example, and other 4112*43c1707eStholo% such environments. \null is better than a space, since it doesn't 4113*43c1707eStholo% have any width. 4114*43c1707eStholo\def\lisppar{\null\endgraf} 4115*43c1707eStholo 4116*43c1707eStholo% Make each space character in the input produce a normal interword 4117*43c1707eStholo% space in the output. Don't allow a line break at this space, as this 4118*43c1707eStholo% is used only in environments like @example, where each line of input 4119*43c1707eStholo% should produce a line of output anyway. 4120*43c1707eStholo% 4121*43c1707eStholo{\obeyspaces % 4122*43c1707eStholo\gdef\sepspaces{\obeyspaces\let =\tie}} 4123*43c1707eStholo 4124*43c1707eStholo% Define \obeyedspace to be our active space, whatever it is. This is 4125*43c1707eStholo% for use in \parsearg. 4126*43c1707eStholo{\sepspaces% 4127*43c1707eStholo\global\let\obeyedspace= } 4128*43c1707eStholo 4129*43c1707eStholo% This space is always present above and below environments. 4130*43c1707eStholo\newskip\envskipamount \envskipamount = 0pt 4131*43c1707eStholo 4132*43c1707eStholo% Make spacing and below environment symmetrical. We use \parskip here 4133*43c1707eStholo% to help in doing that, since in @example-like environments \parskip 4134*43c1707eStholo% is reset to zero; thus the \afterenvbreak inserts no space -- but the 4135*43c1707eStholo% start of the next paragraph will insert \parskip 4136*43c1707eStholo% 4137*43c1707eStholo\def\aboveenvbreak{{\advance\envskipamount by \parskip 4138*43c1707eStholo\endgraf \ifdim\lastskip<\envskipamount 4139*43c1707eStholo\removelastskip \penalty-50 \vskip\envskipamount \fi}} 4140*43c1707eStholo 4141*43c1707eStholo\let\afterenvbreak = \aboveenvbreak 4142*43c1707eStholo 4143*43c1707eStholo% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins. 4144*43c1707eStholo\let\nonarrowing=\relax 4145*43c1707eStholo 4146*43c1707eStholo% @cartouche ... @end cartouche: draw rectangle w/rounded corners around 4147*43c1707eStholo% environment contents. 4148*43c1707eStholo\font\circle=lcircle10 4149*43c1707eStholo\newdimen\circthick 4150*43c1707eStholo\newdimen\cartouter\newdimen\cartinner 4151*43c1707eStholo\newskip\normbskip\newskip\normpskip\newskip\normlskip 4152*43c1707eStholo\circthick=\fontdimen8\circle 4153*43c1707eStholo% 4154*43c1707eStholo\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth 4155*43c1707eStholo\def\ctr{{\hskip 6pt\circle\char'010}} 4156*43c1707eStholo\def\cbl{{\circle\char'012\hskip -6pt}} 4157*43c1707eStholo\def\cbr{{\hskip 6pt\circle\char'011}} 4158*43c1707eStholo\def\carttop{\hbox to \cartouter{\hskip\lskip 4159*43c1707eStholo \ctl\leaders\hrule height\circthick\hfil\ctr 4160*43c1707eStholo \hskip\rskip}} 4161*43c1707eStholo\def\cartbot{\hbox to \cartouter{\hskip\lskip 4162*43c1707eStholo \cbl\leaders\hrule height\circthick\hfil\cbr 4163*43c1707eStholo \hskip\rskip}} 4164*43c1707eStholo% 4165*43c1707eStholo\newskip\lskip\newskip\rskip 4166*43c1707eStholo 4167*43c1707eStholo\long\def\cartouche{% 4168*43c1707eStholo\begingroup 4169*43c1707eStholo \lskip=\leftskip \rskip=\rightskip 4170*43c1707eStholo \leftskip=0pt\rightskip=0pt %we want these *outside*. 4171*43c1707eStholo \cartinner=\hsize \advance\cartinner by-\lskip 4172*43c1707eStholo \advance\cartinner by-\rskip 4173*43c1707eStholo \cartouter=\hsize 4174*43c1707eStholo \advance\cartouter by 18.4pt % allow for 3pt kerns on either 4175*43c1707eStholo% side, and for 6pt waste from 4176*43c1707eStholo% each corner char, and rule thickness 4177*43c1707eStholo \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip 4178*43c1707eStholo % Flag to tell @lisp, etc., not to narrow margin. 4179*43c1707eStholo \let\nonarrowing=\comment 4180*43c1707eStholo \vbox\bgroup 4181*43c1707eStholo \baselineskip=0pt\parskip=0pt\lineskip=0pt 4182*43c1707eStholo \carttop 4183*43c1707eStholo \hbox\bgroup 4184*43c1707eStholo \hskip\lskip 4185*43c1707eStholo \vrule\kern3pt 4186*43c1707eStholo \vbox\bgroup 4187*43c1707eStholo \hsize=\cartinner 4188*43c1707eStholo \kern3pt 4189*43c1707eStholo \begingroup 4190*43c1707eStholo \baselineskip=\normbskip 4191*43c1707eStholo \lineskip=\normlskip 4192*43c1707eStholo \parskip=\normpskip 4193*43c1707eStholo \vskip -\parskip 4194*43c1707eStholo\def\Ecartouche{% 4195*43c1707eStholo \endgroup 4196*43c1707eStholo \kern3pt 4197*43c1707eStholo \egroup 4198*43c1707eStholo \kern3pt\vrule 4199*43c1707eStholo \hskip\rskip 4200*43c1707eStholo \egroup 4201*43c1707eStholo \cartbot 4202*43c1707eStholo \egroup 4203*43c1707eStholo\endgroup 4204*43c1707eStholo}} 4205*43c1707eStholo 4206*43c1707eStholo 4207*43c1707eStholo% This macro is called at the beginning of all the @example variants, 4208*43c1707eStholo% inside a group. 4209*43c1707eStholo\def\nonfillstart{% 4210*43c1707eStholo \aboveenvbreak 4211*43c1707eStholo \inENV % This group ends at the end of the body 4212*43c1707eStholo \hfuzz = 12pt % Don't be fussy 4213*43c1707eStholo \sepspaces % Make spaces be word-separators rather than space tokens. 4214*43c1707eStholo \singlespace 4215*43c1707eStholo \let\par = \lisppar % don't ignore blank lines 4216*43c1707eStholo \obeylines % each line of input is a line of output 4217*43c1707eStholo \parskip = 0pt 4218*43c1707eStholo \parindent = 0pt 4219*43c1707eStholo \emergencystretch = 0pt % don't try to avoid overfull boxes 4220*43c1707eStholo % @cartouche defines \nonarrowing to inhibit narrowing 4221*43c1707eStholo % at next level down. 4222*43c1707eStholo \ifx\nonarrowing\relax 4223*43c1707eStholo \advance \leftskip by \lispnarrowing 4224*43c1707eStholo \exdentamount=\lispnarrowing 4225*43c1707eStholo \let\exdent=\nofillexdent 4226*43c1707eStholo \let\nonarrowing=\relax 4227*43c1707eStholo \fi 4228*43c1707eStholo} 4229*43c1707eStholo 4230*43c1707eStholo% Define the \E... control sequence only if we are inside the particular 4231*43c1707eStholo% environment, so the error checking in \end will work. 4232*43c1707eStholo% 4233*43c1707eStholo% To end an @example-like environment, we first end the paragraph (via 4234*43c1707eStholo% \afterenvbreak's vertical glue), and then the group. That way we keep 4235*43c1707eStholo% the zero \parskip that the environments set -- \parskip glue will be 4236*43c1707eStholo% inserted at the beginning of the next paragraph in the document, after 4237*43c1707eStholo% the environment. 4238*43c1707eStholo% 4239*43c1707eStholo\def\nonfillfinish{\afterenvbreak\endgroup} 4240*43c1707eStholo 4241*43c1707eStholo% @lisp: indented, narrowed, typewriter font. 4242*43c1707eStholo\def\lisp{\begingroup 4243*43c1707eStholo \nonfillstart 4244*43c1707eStholo \let\Elisp = \nonfillfinish 4245*43c1707eStholo \tt 4246*43c1707eStholo \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. 4247*43c1707eStholo \gobble % eat return 4248*43c1707eStholo} 4249*43c1707eStholo 4250*43c1707eStholo% @example: Same as @lisp. 4251*43c1707eStholo\def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp} 4252*43c1707eStholo 4253*43c1707eStholo% @small... is usually equivalent to the non-small (@smallbook 4254*43c1707eStholo% redefines). We must call \example (or whatever) last in the 4255*43c1707eStholo% definition, since it reads the return following the @example (or 4256*43c1707eStholo% whatever) command. 4257*43c1707eStholo% 4258*43c1707eStholo% This actually allows (for example) @end display inside an 4259*43c1707eStholo% @smalldisplay. Too bad, but makeinfo will catch the error anyway. 4260*43c1707eStholo% 4261*43c1707eStholo\def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display} 4262*43c1707eStholo\def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp} 4263*43c1707eStholo\def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format} 4264*43c1707eStholo\def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp} 4265*43c1707eStholo 4266*43c1707eStholo% Real @smallexample and @smalllisp (when @smallbook): use smaller fonts. 4267*43c1707eStholo% Originally contributed by Pavel@xerox. 4268*43c1707eStholo\def\smalllispx{\begingroup 4269*43c1707eStholo \def\Esmalllisp{\nonfillfinish\endgroup}% 4270*43c1707eStholo \def\Esmallexample{\nonfillfinish\endgroup}% 4271*43c1707eStholo \smallfonts 4272*43c1707eStholo \lisp 4273*43c1707eStholo} 4274*43c1707eStholo 4275*43c1707eStholo% @display: same as @lisp except keep current font. 4276*43c1707eStholo% 4277*43c1707eStholo\def\display{\begingroup 4278*43c1707eStholo \nonfillstart 4279*43c1707eStholo \let\Edisplay = \nonfillfinish 4280*43c1707eStholo \gobble 4281*43c1707eStholo} 4282*43c1707eStholo 4283*43c1707eStholo% @smalldisplay (when @smallbook): @display plus smaller fonts. 4284*43c1707eStholo% 4285*43c1707eStholo\def\smalldisplayx{\begingroup 4286*43c1707eStholo \def\Esmalldisplay{\nonfillfinish\endgroup}% 4287*43c1707eStholo \smallfonts \rm 4288*43c1707eStholo \display 4289*43c1707eStholo} 4290*43c1707eStholo 4291*43c1707eStholo% @format: same as @display except don't narrow margins. 4292*43c1707eStholo% 4293*43c1707eStholo\def\format{\begingroup 4294*43c1707eStholo \let\nonarrowing = t 4295*43c1707eStholo \nonfillstart 4296*43c1707eStholo \let\Eformat = \nonfillfinish 4297*43c1707eStholo \gobble 4298*43c1707eStholo} 4299*43c1707eStholo 4300*43c1707eStholo% @smallformat (when @smallbook): @format plus smaller fonts. 4301*43c1707eStholo% 4302*43c1707eStholo\def\smallformatx{\begingroup 4303*43c1707eStholo \def\Esmallformat{\nonfillfinish\endgroup}% 4304*43c1707eStholo \smallfonts \rm 4305*43c1707eStholo \format 4306*43c1707eStholo} 4307*43c1707eStholo 4308*43c1707eStholo% @flushleft (same as @format). 4309*43c1707eStholo% 4310*43c1707eStholo\def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format} 4311*43c1707eStholo 4312*43c1707eStholo% @flushright. 4313*43c1707eStholo% 4314*43c1707eStholo\def\flushright{\begingroup 4315*43c1707eStholo \let\nonarrowing = t 4316*43c1707eStholo \nonfillstart 4317*43c1707eStholo \let\Eflushright = \nonfillfinish 4318*43c1707eStholo \advance\leftskip by 0pt plus 1fill 4319*43c1707eStholo \gobble 4320*43c1707eStholo} 4321*43c1707eStholo 4322*43c1707eStholo 4323*43c1707eStholo% @quotation does normal linebreaking (hence we can't use \nonfillstart) 4324*43c1707eStholo% and narrows the margins. 4325*43c1707eStholo% 4326*43c1707eStholo\def\quotation{% 4327*43c1707eStholo \begingroup\inENV %This group ends at the end of the @quotation body 4328*43c1707eStholo {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip 4329*43c1707eStholo \singlespace 4330*43c1707eStholo \parindent=0pt 4331*43c1707eStholo % We have retained a nonzero parskip for the environment, since we're 4332*43c1707eStholo % doing normal filling. So to avoid extra space below the environment... 4333*43c1707eStholo \def\Equotation{\parskip = 0pt \nonfillfinish}% 4334*43c1707eStholo % 4335*43c1707eStholo % @cartouche defines \nonarrowing to inhibit narrowing at next level down. 4336*43c1707eStholo \ifx\nonarrowing\relax 4337*43c1707eStholo \advance\leftskip by \lispnarrowing 4338*43c1707eStholo \advance\rightskip by \lispnarrowing 4339*43c1707eStholo \exdentamount = \lispnarrowing 4340*43c1707eStholo \let\nonarrowing = \relax 4341*43c1707eStholo \fi 4342*43c1707eStholo} 4343*43c1707eStholo 4344*43c1707eStholo 4345*43c1707eStholo% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} 4346*43c1707eStholo% If we want to allow any <char> as delimiter, 4347*43c1707eStholo% we need the curly braces so that makeinfo sees the @verb command, eg: 4348*43c1707eStholo% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org 4349*43c1707eStholo% 4350*43c1707eStholo% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. 4351*43c1707eStholo% 4352*43c1707eStholo% [Knuth] p. 344; only we need to do '@' too 4353*43c1707eStholo\def\dospecials{% 4354*43c1707eStholo \do\ \do\\\do\@\do\{\do\}\do\$\do\&% 4355*43c1707eStholo \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~} 4356*43c1707eStholo% 4357*43c1707eStholo% [Knuth] p. 380 4358*43c1707eStholo\def\uncatcodespecials{% 4359*43c1707eStholo \def\do##1{\catcode`##1=12}\dospecials} 4360*43c1707eStholo% 4361*43c1707eStholo% [Knuth] pp. 380,381,391 4362*43c1707eStholo% Disable Spanish ligatures ?` and !` of \tt font 4363*43c1707eStholo\begingroup 4364*43c1707eStholo \catcode`\`=\active\gdef`{\relax\lq} 4365*43c1707eStholo\endgroup 4366*43c1707eStholo% 4367*43c1707eStholo% Setup for the @verb command. 4368*43c1707eStholo% 4369*43c1707eStholo% Eight spaces for a tab 4370*43c1707eStholo\begingroup 4371*43c1707eStholo \catcode`\^^I=\active 4372*43c1707eStholo \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} 4373*43c1707eStholo\endgroup 4374*43c1707eStholo% 4375*43c1707eStholo\def\setupverb{% 4376*43c1707eStholo \tt % easiest (and conventionally used) font for verbatim 4377*43c1707eStholo \def\par{\leavevmode\endgraf}% 4378*43c1707eStholo \catcode`\`=\active 4379*43c1707eStholo \tabeightspaces 4380*43c1707eStholo % Respect line breaks, 4381*43c1707eStholo % print special symbols as themselves, and 4382*43c1707eStholo % make each space count 4383*43c1707eStholo % must do in this order: 4384*43c1707eStholo \obeylines \uncatcodespecials \sepspaces 4385*43c1707eStholo} 4386*43c1707eStholo 4387*43c1707eStholo% Setup for the @verbatim environment 4388*43c1707eStholo% 4389*43c1707eStholo% Real tab expansion 4390*43c1707eStholo\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount 4391*43c1707eStholo% 4392*43c1707eStholo\def\starttabbox{\setbox0=\hbox\bgroup} 4393*43c1707eStholo\begingroup 4394*43c1707eStholo \catcode`\^^I=\active 4395*43c1707eStholo \gdef\tabexpand{% 4396*43c1707eStholo \catcode`\^^I=\active 4397*43c1707eStholo \def^^I{\leavevmode\egroup 4398*43c1707eStholo \dimen0=\wd0 % the width so far, or since the previous tab 4399*43c1707eStholo \divide\dimen0 by\tabw 4400*43c1707eStholo \multiply\dimen0 by\tabw % compute previous multiple of \tabw 4401*43c1707eStholo \advance\dimen0 by\tabw % advance to next multiple of \tabw 4402*43c1707eStholo \wd0=\dimen0 \box0 \starttabbox 4403*43c1707eStholo }% 4404*43c1707eStholo } 4405*43c1707eStholo\endgroup 4406*43c1707eStholo\def\setupverbatim{% 4407*43c1707eStholo % Easiest (and conventionally used) font for verbatim 4408*43c1707eStholo \tt 4409*43c1707eStholo \def\par{\leavevmode\egroup\box0\endgraf}% 4410*43c1707eStholo \catcode`\`=\active 4411*43c1707eStholo \tabexpand 4412*43c1707eStholo % Respect line breaks, 4413*43c1707eStholo % print special symbols as themselves, and 4414*43c1707eStholo % make each space count 4415*43c1707eStholo % must do in this order: 4416*43c1707eStholo \obeylines \uncatcodespecials \sepspaces 4417*43c1707eStholo \everypar{\starttabbox}% 4418*43c1707eStholo} 4419*43c1707eStholo 4420*43c1707eStholo% Do the @verb magic: verbatim text is quoted by unique 4421*43c1707eStholo% delimiter characters. Before first delimiter expect a 4422*43c1707eStholo% right brace, after last delimiter expect closing brace: 4423*43c1707eStholo% 4424*43c1707eStholo% \def\doverb'{'<char>#1<char>'}'{#1} 4425*43c1707eStholo% 4426*43c1707eStholo% [Knuth] p. 382; only eat outer {} 4427*43c1707eStholo\begingroup 4428*43c1707eStholo \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12 4429*43c1707eStholo \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] 4430*43c1707eStholo\endgroup 4431*43c1707eStholo% 4432*43c1707eStholo\def\verb{\begingroup\setupverb\doverb} 4433*43c1707eStholo% 4434*43c1707eStholo% 4435*43c1707eStholo% Do the @verbatim magic: define the macro \doverbatim so that 4436*43c1707eStholo% the (first) argument ends when '@end verbatim' is reached, ie: 4437*43c1707eStholo% 4438*43c1707eStholo% \def\doverbatim#1@end verbatim{#1} 4439*43c1707eStholo% 4440*43c1707eStholo% For Texinfo it's a lot easier than for LaTeX, 4441*43c1707eStholo% because texinfo's \verbatim doesn't stop at '\end{verbatim}': 4442*43c1707eStholo% we need not redefine '\', '{' and '}' 4443*43c1707eStholo% 4444*43c1707eStholo% Inspired by LaTeX's verbatim command set [latex.ltx] 4445*43c1707eStholo%% Include LaTeX hack for completeness -- never know 4446*43c1707eStholo%% \begingroup 4447*43c1707eStholo%% \catcode`|=0 \catcode`[=1 4448*43c1707eStholo%% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active 4449*43c1707eStholo%% \catcode`\\=12|gdef|doverbatim#1@end verbatim[ 4450*43c1707eStholo%% #1|endgroup|def|Everbatim[]|end[verbatim]] 4451*43c1707eStholo%% |endgroup 4452*43c1707eStholo\begingroup 4453*43c1707eStholo \catcode`\ =\active 4454*43c1707eStholo \gdef\doverbatim#1@end verbatim{#1\end{verbatim}} 4455*43c1707eStholo\endgroup 4456*43c1707eStholo% 4457*43c1707eStholo\def\verbatim{% 4458*43c1707eStholo \def\Everbatim{\nonfillfinish\endgroup}% 4459*43c1707eStholo \begingroup 4460*43c1707eStholo \nonfillstart 4461*43c1707eStholo \advance\leftskip by -\defbodyindent 4462*43c1707eStholo \begingroup\setupverbatim\doverbatim 4463*43c1707eStholo} 4464*43c1707eStholo 4465*43c1707eStholo% @verbatiminclude FILE - insert text of file in verbatim environment. 4466*43c1707eStholo% 4467*43c1707eStholo% Allow normal characters that we make active in the argument (a file name). 4468*43c1707eStholo\def\verbatiminclude{% 4469*43c1707eStholo \begingroup 4470*43c1707eStholo \catcode`\\=12 4471*43c1707eStholo \catcode`~=12 4472*43c1707eStholo \catcode`^=12 4473*43c1707eStholo \catcode`_=12 4474*43c1707eStholo \catcode`|=12 4475*43c1707eStholo \catcode`<=12 4476*43c1707eStholo \catcode`>=12 4477*43c1707eStholo \catcode`+=12 4478*43c1707eStholo \parsearg\doverbatiminclude 4479*43c1707eStholo} 4480*43c1707eStholo\def\setupverbatiminclude{% 4481*43c1707eStholo \begingroup 4482*43c1707eStholo \nonfillstart 4483*43c1707eStholo \advance\leftskip by -\defbodyindent 4484*43c1707eStholo \begingroup\setupverbatim 4485*43c1707eStholo} 4486*43c1707eStholo% 4487*43c1707eStholo\def\doverbatiminclude#1{% 4488*43c1707eStholo % Restore active chars for included file. 4489*43c1707eStholo \endgroup 4490*43c1707eStholo \begingroup 4491*43c1707eStholo \def\thisfile{#1}% 4492*43c1707eStholo \expandafter\expandafter\setupverbatiminclude\input\thisfile 4493*43c1707eStholo \endgroup\nonfillfinish\endgroup 4494*43c1707eStholo} 4495*43c1707eStholo 4496*43c1707eStholo 4497*43c1707eStholo\message{defuns,} 4498*43c1707eStholo% @defun etc. 4499*43c1707eStholo 4500*43c1707eStholo% Allow user to change definition object font (\df) internally 4501*43c1707eStholo\def\setdeffont #1 {\csname DEF#1\endcsname} 4502*43c1707eStholo 4503*43c1707eStholo\newskip\defbodyindent \defbodyindent=.4in 4504*43c1707eStholo\newskip\defargsindent \defargsindent=50pt 4505*43c1707eStholo\newskip\deftypemargin \deftypemargin=12pt 4506*43c1707eStholo\newskip\deflastargmargin \deflastargmargin=18pt 4507*43c1707eStholo 4508*43c1707eStholo\newcount\parencount 4509*43c1707eStholo% define \functionparens, which makes ( and ) and & do special things. 4510*43c1707eStholo% \functionparens affects the group it is contained in. 4511*43c1707eStholo\def\activeparens{% 4512*43c1707eStholo\catcode`\(=\active \catcode`\)=\active \catcode`\&=\active 4513*43c1707eStholo\catcode`\[=\active \catcode`\]=\active} 4514*43c1707eStholo 4515*43c1707eStholo% Make control sequences which act like normal parenthesis chars. 4516*43c1707eStholo\let\lparen = ( \let\rparen = ) 4517*43c1707eStholo 4518*43c1707eStholo{\activeparens % Now, smart parens don't turn on until &foo (see \amprm) 4519*43c1707eStholo 4520*43c1707eStholo% Be sure that we always have a definition for `(', etc. For example, 4521*43c1707eStholo% if the fn name has parens in it, \boldbrax will not be in effect yet, 4522*43c1707eStholo% so TeX would otherwise complain about undefined control sequence. 4523*43c1707eStholo\global\let(=\lparen \global\let)=\rparen 4524*43c1707eStholo\global\let[=\lbrack \global\let]=\rbrack 4525*43c1707eStholo 4526*43c1707eStholo\gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 } 4527*43c1707eStholo\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} 4528*43c1707eStholo% This is used to turn on special parens 4529*43c1707eStholo% but make & act ordinary (given that it's active). 4530*43c1707eStholo\gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr} 4531*43c1707eStholo 4532*43c1707eStholo% Definitions of (, ) and & used in args for functions. 4533*43c1707eStholo% This is the definition of ( outside of all parentheses. 4534*43c1707eStholo\gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested 4535*43c1707eStholo \global\advance\parencount by 1 4536*43c1707eStholo} 4537*43c1707eStholo% 4538*43c1707eStholo% This is the definition of ( when already inside a level of parens. 4539*43c1707eStholo\gdef\opnested{\char`\(\global\advance\parencount by 1 } 4540*43c1707eStholo% 4541*43c1707eStholo\gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0. 4542*43c1707eStholo % also in that case restore the outer-level definition of (. 4543*43c1707eStholo \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi 4544*43c1707eStholo \global\advance \parencount by -1 } 4545*43c1707eStholo% If we encounter &foo, then turn on ()-hacking afterwards 4546*43c1707eStholo\gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ } 4547*43c1707eStholo% 4548*43c1707eStholo\gdef\normalparens{\boldbrax\let&=\ampnr} 4549*43c1707eStholo} % End of definition inside \activeparens 4550*43c1707eStholo%% These parens (in \boldbrax) actually are a little bolder than the 4551*43c1707eStholo%% contained text. This is especially needed for [ and ] 4552*43c1707eStholo\def\opnr{{\sf\char`\(}\global\advance\parencount by 1 } 4553*43c1707eStholo\def\clnr{{\sf\char`\)}\global\advance\parencount by -1 } 4554*43c1707eStholo\let\ampnr = \& 4555*43c1707eStholo\def\lbrb{{\bf\char`\[}} 4556*43c1707eStholo\def\rbrb{{\bf\char`\]}} 4557*43c1707eStholo 4558*43c1707eStholo% Active &'s sneak into the index arguments, so make sure it's defined. 4559*43c1707eStholo{ 4560*43c1707eStholo \catcode`& = 13 4561*43c1707eStholo \global\let& = \ampnr 4562*43c1707eStholo} 4563*43c1707eStholo 4564*43c1707eStholo% First, defname, which formats the header line itself. 4565*43c1707eStholo% #1 should be the function name. 4566*43c1707eStholo% #2 should be the type of definition, such as "Function". 4567*43c1707eStholo 4568*43c1707eStholo\def\defname #1#2{% 4569*43c1707eStholo% Get the values of \leftskip and \rightskip as they were 4570*43c1707eStholo% outside the @def... 4571*43c1707eStholo\dimen2=\leftskip 4572*43c1707eStholo\advance\dimen2 by -\defbodyindent 4573*43c1707eStholo\noindent 4574*43c1707eStholo\setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}% 4575*43c1707eStholo\dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line 4576*43c1707eStholo\dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations 4577*43c1707eStholo\parshape 2 0in \dimen0 \defargsindent \dimen1 4578*43c1707eStholo% Now output arg 2 ("Function" or some such) 4579*43c1707eStholo% ending at \deftypemargin from the right margin, 4580*43c1707eStholo% but stuck inside a box of width 0 so it does not interfere with linebreaking 4581*43c1707eStholo{% Adjust \hsize to exclude the ambient margins, 4582*43c1707eStholo% so that \rightline will obey them. 4583*43c1707eStholo\advance \hsize by -\dimen2 4584*43c1707eStholo\rlap{\rightline{{\rm #2}\hskip -1.25pc }}}% 4585*43c1707eStholo% Make all lines underfull and no complaints: 4586*43c1707eStholo\tolerance=10000 \hbadness=10000 4587*43c1707eStholo\advance\leftskip by -\defbodyindent 4588*43c1707eStholo\exdentamount=\defbodyindent 4589*43c1707eStholo{\df #1}\enskip % Generate function name 4590*43c1707eStholo} 4591*43c1707eStholo 4592*43c1707eStholo% Actually process the body of a definition 4593*43c1707eStholo% #1 should be the terminating control sequence, such as \Edefun. 4594*43c1707eStholo% #2 should be the "another name" control sequence, such as \defunx. 4595*43c1707eStholo% #3 should be the control sequence that actually processes the header, 4596*43c1707eStholo% such as \defunheader. 4597*43c1707eStholo 4598*43c1707eStholo\def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody 4599*43c1707eStholo\medbreak % 4600*43c1707eStholo% Define the end token that this defining construct specifies 4601*43c1707eStholo% so that it will exit this group. 4602*43c1707eStholo\def#1{\endgraf\endgroup\medbreak}% 4603*43c1707eStholo\def#2{\begingroup\obeylines\activeparens\spacesplit#3}% 4604*43c1707eStholo\parindent=0in 4605*43c1707eStholo\advance\leftskip by \defbodyindent 4606*43c1707eStholo\exdentamount=\defbodyindent 4607*43c1707eStholo\begingroup % 4608*43c1707eStholo\catcode 61=\active % 61 is `=' 4609*43c1707eStholo\obeylines\activeparens\spacesplit#3} 4610*43c1707eStholo 4611*43c1707eStholo% #1 is the \E... control sequence to end the definition (which we define). 4612*43c1707eStholo% #2 is the \...x control sequence for consecutive fns (which we define). 4613*43c1707eStholo% #3 is the control sequence to call to resume processing. 4614*43c1707eStholo% #4, delimited by the space, is the class name. 4615*43c1707eStholo% 4616*43c1707eStholo\def\defmethparsebody#1#2#3#4 {\begingroup\inENV % 4617*43c1707eStholo\medbreak % 4618*43c1707eStholo% Define the end token that this defining construct specifies 4619*43c1707eStholo% so that it will exit this group. 4620*43c1707eStholo\def#1{\endgraf\endgroup\medbreak}% 4621*43c1707eStholo\def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}% 4622*43c1707eStholo\parindent=0in 4623*43c1707eStholo\advance\leftskip by \defbodyindent 4624*43c1707eStholo\exdentamount=\defbodyindent 4625*43c1707eStholo\begingroup\obeylines\activeparens\spacesplit{#3{#4}}} 4626*43c1707eStholo 4627*43c1707eStholo% Used for @deftypemethod and @deftypeivar. 4628*43c1707eStholo% #1 is the \E... control sequence to end the definition (which we define). 4629*43c1707eStholo% #2 is the \...x control sequence for consecutive fns (which we define). 4630*43c1707eStholo% #3 is the control sequence to call to resume processing. 4631*43c1707eStholo% #4, delimited by a space, is the class name. 4632*43c1707eStholo% #5 is the method's return type. 4633*43c1707eStholo% 4634*43c1707eStholo\def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV 4635*43c1707eStholo \medbreak 4636*43c1707eStholo \def#1{\endgraf\endgroup\medbreak}% 4637*43c1707eStholo \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}% 4638*43c1707eStholo \parindent=0in 4639*43c1707eStholo \advance\leftskip by \defbodyindent 4640*43c1707eStholo \exdentamount=\defbodyindent 4641*43c1707eStholo \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}} 4642*43c1707eStholo 4643*43c1707eStholo% Used for @deftypeop. The change from \deftypemethparsebody is an 4644*43c1707eStholo% extra argument at the beginning which is the `category', instead of it 4645*43c1707eStholo% being the hardwired string `Method' or `Instance Variable'. We have 4646*43c1707eStholo% to account for this both in the \...x definition and in parsing the 4647*43c1707eStholo% input at hand. Thus also need a control sequence (passed as #5) for 4648*43c1707eStholo% the \E... definition to assign the category name to. 4649*43c1707eStholo% 4650*43c1707eStholo\def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV 4651*43c1707eStholo \medbreak 4652*43c1707eStholo \def#1{\endgraf\endgroup\medbreak}% 4653*43c1707eStholo \def#2##1 ##2 ##3 {% 4654*43c1707eStholo \def#4{##1}% 4655*43c1707eStholo \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}% 4656*43c1707eStholo \parindent=0in 4657*43c1707eStholo \advance\leftskip by \defbodyindent 4658*43c1707eStholo \exdentamount=\defbodyindent 4659*43c1707eStholo \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}} 4660*43c1707eStholo 4661*43c1707eStholo\def\defopparsebody #1#2#3#4#5 {\begingroup\inENV % 4662*43c1707eStholo\medbreak % 4663*43c1707eStholo% Define the end token that this defining construct specifies 4664*43c1707eStholo% so that it will exit this group. 4665*43c1707eStholo\def#1{\endgraf\endgroup\medbreak}% 4666*43c1707eStholo\def#2##1 ##2 {\def#4{##1}% 4667*43c1707eStholo\begingroup\obeylines\activeparens\spacesplit{#3{##2}}}% 4668*43c1707eStholo\parindent=0in 4669*43c1707eStholo\advance\leftskip by \defbodyindent 4670*43c1707eStholo\exdentamount=\defbodyindent 4671*43c1707eStholo\begingroup\obeylines\activeparens\spacesplit{#3{#5}}} 4672*43c1707eStholo 4673*43c1707eStholo% These parsing functions are similar to the preceding ones 4674*43c1707eStholo% except that they do not make parens into active characters. 4675*43c1707eStholo% These are used for "variables" since they have no arguments. 4676*43c1707eStholo 4677*43c1707eStholo\def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody 4678*43c1707eStholo\medbreak % 4679*43c1707eStholo% Define the end token that this defining construct specifies 4680*43c1707eStholo% so that it will exit this group. 4681*43c1707eStholo\def#1{\endgraf\endgroup\medbreak}% 4682*43c1707eStholo\def#2{\begingroup\obeylines\spacesplit#3}% 4683*43c1707eStholo\parindent=0in 4684*43c1707eStholo\advance\leftskip by \defbodyindent 4685*43c1707eStholo\exdentamount=\defbodyindent 4686*43c1707eStholo\begingroup % 4687*43c1707eStholo\catcode 61=\active % 4688*43c1707eStholo\obeylines\spacesplit#3} 4689*43c1707eStholo 4690*43c1707eStholo% This is used for \def{tp,vr}parsebody. It could probably be used for 4691*43c1707eStholo% some of the others, too, with some judicious conditionals. 4692*43c1707eStholo% 4693*43c1707eStholo\def\parsebodycommon#1#2#3{% 4694*43c1707eStholo \begingroup\inENV % 4695*43c1707eStholo \medbreak % 4696*43c1707eStholo % Define the end token that this defining construct specifies 4697*43c1707eStholo % so that it will exit this group. 4698*43c1707eStholo \def#1{\endgraf\endgroup\medbreak}% 4699*43c1707eStholo \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}% 4700*43c1707eStholo \parindent=0in 4701*43c1707eStholo \advance\leftskip by \defbodyindent 4702*43c1707eStholo \exdentamount=\defbodyindent 4703*43c1707eStholo \begingroup\obeylines 4704*43c1707eStholo} 4705*43c1707eStholo 4706*43c1707eStholo\def\defvrparsebody#1#2#3#4 {% 4707*43c1707eStholo \parsebodycommon{#1}{#2}{#3}% 4708*43c1707eStholo \spacesplit{#3{#4}}% 4709*43c1707eStholo} 4710*43c1707eStholo 4711*43c1707eStholo% This loses on `@deftp {Data Type} {struct termios}' -- it thinks the 4712*43c1707eStholo% type is just `struct', because we lose the braces in `{struct 4713*43c1707eStholo% termios}' when \spacesplit reads its undelimited argument. Sigh. 4714*43c1707eStholo% \let\deftpparsebody=\defvrparsebody 4715*43c1707eStholo% 4716*43c1707eStholo% So, to get around this, we put \empty in with the type name. That 4717*43c1707eStholo% way, TeX won't find exactly `{...}' as an undelimited argument, and 4718*43c1707eStholo% won't strip off the braces. 4719*43c1707eStholo% 4720*43c1707eStholo\def\deftpparsebody #1#2#3#4 {% 4721*43c1707eStholo \parsebodycommon{#1}{#2}{#3}% 4722*43c1707eStholo \spacesplit{\parsetpheaderline{#3{#4}}}\empty 4723*43c1707eStholo} 4724*43c1707eStholo 4725*43c1707eStholo% Fine, but then we have to eventually remove the \empty *and* the 4726*43c1707eStholo% braces (if any). That's what this does. 4727*43c1707eStholo% 4728*43c1707eStholo\def\removeemptybraces\empty#1\relax{#1} 4729*43c1707eStholo 4730*43c1707eStholo% After \spacesplit has done its work, this is called -- #1 is the final 4731*43c1707eStholo% thing to call, #2 the type name (which starts with \empty), and #3 4732*43c1707eStholo% (which might be empty) the arguments. 4733*43c1707eStholo% 4734*43c1707eStholo\def\parsetpheaderline#1#2#3{% 4735*43c1707eStholo #1{\removeemptybraces#2\relax}{#3}% 4736*43c1707eStholo}% 4737*43c1707eStholo 4738*43c1707eStholo\def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV % 4739*43c1707eStholo\medbreak % 4740*43c1707eStholo% Define the end token that this defining construct specifies 4741*43c1707eStholo% so that it will exit this group. 4742*43c1707eStholo\def#1{\endgraf\endgroup\medbreak}% 4743*43c1707eStholo\def#2##1 ##2 {\def#4{##1}% 4744*43c1707eStholo\begingroup\obeylines\spacesplit{#3{##2}}}% 4745*43c1707eStholo\parindent=0in 4746*43c1707eStholo\advance\leftskip by \defbodyindent 4747*43c1707eStholo\exdentamount=\defbodyindent 4748*43c1707eStholo\begingroup\obeylines\spacesplit{#3{#5}}} 4749*43c1707eStholo 4750*43c1707eStholo% Split up #2 at the first space token. 4751*43c1707eStholo% call #1 with two arguments: 4752*43c1707eStholo% the first is all of #2 before the space token, 4753*43c1707eStholo% the second is all of #2 after that space token. 4754*43c1707eStholo% If #2 contains no space token, all of it is passed as the first arg 4755*43c1707eStholo% and the second is passed as empty. 4756*43c1707eStholo 4757*43c1707eStholo{\obeylines 4758*43c1707eStholo\gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}% 4759*43c1707eStholo\long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{% 4760*43c1707eStholo\ifx\relax #3% 4761*43c1707eStholo#1{#2}{}\else #1{#2}{#3#4}\fi}} 4762*43c1707eStholo 4763*43c1707eStholo% So much for the things common to all kinds of definitions. 4764*43c1707eStholo 4765*43c1707eStholo% Define @defun. 4766*43c1707eStholo 4767*43c1707eStholo% First, define the processing that is wanted for arguments of \defun 4768*43c1707eStholo% Use this to expand the args and terminate the paragraph they make up 4769*43c1707eStholo 4770*43c1707eStholo\def\defunargs#1{\functionparens \sl 4771*43c1707eStholo% Expand, preventing hyphenation at `-' chars. 4772*43c1707eStholo% Note that groups don't affect changes in \hyphenchar. 4773*43c1707eStholo% Set the font temporarily and use \font in case \setfont made \tensl a macro. 4774*43c1707eStholo{\tensl\hyphenchar\font=0}% 4775*43c1707eStholo#1% 4776*43c1707eStholo{\tensl\hyphenchar\font=45}% 4777*43c1707eStholo\ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi% 4778*43c1707eStholo\interlinepenalty=10000 4779*43c1707eStholo\advance\rightskip by 0pt plus 1fil 4780*43c1707eStholo\endgraf\nobreak\vskip -\parskip\nobreak 4781*43c1707eStholo} 4782*43c1707eStholo 4783*43c1707eStholo\def\deftypefunargs #1{% 4784*43c1707eStholo% Expand, preventing hyphenation at `-' chars. 4785*43c1707eStholo% Note that groups don't affect changes in \hyphenchar. 4786*43c1707eStholo% Use \boldbraxnoamp, not \functionparens, so that & is not special. 4787*43c1707eStholo\boldbraxnoamp 4788*43c1707eStholo\tclose{#1}% avoid \code because of side effects on active chars 4789*43c1707eStholo\interlinepenalty=10000 4790*43c1707eStholo\advance\rightskip by 0pt plus 1fil 4791*43c1707eStholo\endgraf\nobreak\vskip -\parskip\nobreak 4792*43c1707eStholo} 4793*43c1707eStholo 4794*43c1707eStholo% Do complete processing of one @defun or @defunx line already parsed. 4795*43c1707eStholo 4796*43c1707eStholo% @deffn Command forward-char nchars 4797*43c1707eStholo 4798*43c1707eStholo\def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader} 4799*43c1707eStholo 4800*43c1707eStholo\def\deffnheader #1#2#3{\doind {fn}{\code{#2}}% 4801*43c1707eStholo\begingroup\defname {#2}{#1}\defunargs{#3}\endgroup % 4802*43c1707eStholo\catcode 61=\other % Turn off change made in \defparsebody 4803*43c1707eStholo} 4804*43c1707eStholo 4805*43c1707eStholo% @defun == @deffn Function 4806*43c1707eStholo 4807*43c1707eStholo\def\defun{\defparsebody\Edefun\defunx\defunheader} 4808*43c1707eStholo 4809*43c1707eStholo\def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index 4810*43c1707eStholo\begingroup\defname {#1}{\putwordDeffunc}% 4811*43c1707eStholo\defunargs {#2}\endgroup % 4812*43c1707eStholo\catcode 61=\other % Turn off change made in \defparsebody 4813*43c1707eStholo} 4814*43c1707eStholo 4815*43c1707eStholo% @deftypefun int foobar (int @var{foo}, float @var{bar}) 4816*43c1707eStholo 4817*43c1707eStholo\def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader} 4818*43c1707eStholo 4819*43c1707eStholo% #1 is the data type. #2 is the name and args. 4820*43c1707eStholo\def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax} 4821*43c1707eStholo% #1 is the data type, #2 the name, #3 the args. 4822*43c1707eStholo\def\deftypefunheaderx #1#2 #3\relax{% 4823*43c1707eStholo\doind {fn}{\code{#2}}% Make entry in function index 4824*43c1707eStholo\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}% 4825*43c1707eStholo\deftypefunargs {#3}\endgroup % 4826*43c1707eStholo\catcode 61=\other % Turn off change made in \defparsebody 4827*43c1707eStholo} 4828*43c1707eStholo 4829*43c1707eStholo% @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar}) 4830*43c1707eStholo 4831*43c1707eStholo\def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader} 4832*43c1707eStholo 4833*43c1707eStholo% \defheaderxcond#1\relax$$$ 4834*43c1707eStholo% puts #1 in @code, followed by a space, but does nothing if #1 is null. 4835*43c1707eStholo\def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi} 4836*43c1707eStholo 4837*43c1707eStholo% #1 is the classification. #2 is the data type. #3 is the name and args. 4838*43c1707eStholo\def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax} 4839*43c1707eStholo% #1 is the classification, #2 the data type, #3 the name, #4 the args. 4840*43c1707eStholo\def\deftypefnheaderx #1#2#3 #4\relax{% 4841*43c1707eStholo\doind {fn}{\code{#3}}% Make entry in function index 4842*43c1707eStholo\begingroup 4843*43c1707eStholo\normalparens % notably, turn off `&' magic, which prevents 4844*43c1707eStholo% at least some C++ text from working 4845*43c1707eStholo\defname {\defheaderxcond#2\relax$$$#3}{#1}% 4846*43c1707eStholo\deftypefunargs {#4}\endgroup % 4847*43c1707eStholo\catcode 61=\other % Turn off change made in \defparsebody 4848*43c1707eStholo} 4849*43c1707eStholo 4850*43c1707eStholo% @defmac == @deffn Macro 4851*43c1707eStholo 4852*43c1707eStholo\def\defmac{\defparsebody\Edefmac\defmacx\defmacheader} 4853*43c1707eStholo 4854*43c1707eStholo\def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index 4855*43c1707eStholo\begingroup\defname {#1}{\putwordDefmac}% 4856*43c1707eStholo\defunargs {#2}\endgroup % 4857*43c1707eStholo\catcode 61=\other % Turn off change made in \defparsebody 4858*43c1707eStholo} 4859*43c1707eStholo 4860*43c1707eStholo% @defspec == @deffn Special Form 4861*43c1707eStholo 4862*43c1707eStholo\def\defspec{\defparsebody\Edefspec\defspecx\defspecheader} 4863*43c1707eStholo 4864*43c1707eStholo\def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index 4865*43c1707eStholo\begingroup\defname {#1}{\putwordDefspec}% 4866*43c1707eStholo\defunargs {#2}\endgroup % 4867*43c1707eStholo\catcode 61=\other % Turn off change made in \defparsebody 4868*43c1707eStholo} 4869*43c1707eStholo 4870*43c1707eStholo% @defop CATEGORY CLASS OPERATION ARG... 4871*43c1707eStholo% 4872*43c1707eStholo\def\defop #1 {\def\defoptype{#1}% 4873*43c1707eStholo\defopparsebody\Edefop\defopx\defopheader\defoptype} 4874*43c1707eStholo% 4875*43c1707eStholo\def\defopheader#1#2#3{% 4876*43c1707eStholo\dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index 4877*43c1707eStholo\begingroup\defname {#2}{\defoptype\ \putwordon\ #1}% 4878*43c1707eStholo\defunargs {#3}\endgroup % 4879*43c1707eStholo} 4880*43c1707eStholo 4881*43c1707eStholo% @deftypeop CATEGORY CLASS TYPE OPERATION ARG... 4882*43c1707eStholo% 4883*43c1707eStholo\def\deftypeop #1 {\def\deftypeopcategory{#1}% 4884*43c1707eStholo \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader 4885*43c1707eStholo \deftypeopcategory} 4886*43c1707eStholo% 4887*43c1707eStholo% #1 is the class name, #2 the data type, #3 the operation name, #4 the args. 4888*43c1707eStholo\def\deftypeopheader#1#2#3#4{% 4889*43c1707eStholo \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index 4890*43c1707eStholo \begingroup 4891*43c1707eStholo \defname{\defheaderxcond#2\relax$$$#3} 4892*43c1707eStholo {\deftypeopcategory\ \putwordon\ \code{#1}}% 4893*43c1707eStholo \deftypefunargs{#4}% 4894*43c1707eStholo \endgroup 4895*43c1707eStholo} 4896*43c1707eStholo 4897*43c1707eStholo% @deftypemethod CLASS TYPE METHOD ARG... 4898*43c1707eStholo% 4899*43c1707eStholo\def\deftypemethod{% 4900*43c1707eStholo \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader} 4901*43c1707eStholo% 4902*43c1707eStholo% #1 is the class name, #2 the data type, #3 the method name, #4 the args. 4903*43c1707eStholo\def\deftypemethodheader#1#2#3#4{% 4904*43c1707eStholo \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index 4905*43c1707eStholo \begingroup 4906*43c1707eStholo \defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}% 4907*43c1707eStholo \deftypefunargs{#4}% 4908*43c1707eStholo \endgroup 4909*43c1707eStholo} 4910*43c1707eStholo 4911*43c1707eStholo% @deftypeivar CLASS TYPE VARNAME 4912*43c1707eStholo% 4913*43c1707eStholo\def\deftypeivar{% 4914*43c1707eStholo \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader} 4915*43c1707eStholo% 4916*43c1707eStholo% #1 is the class name, #2 the data type, #3 the variable name. 4917*43c1707eStholo\def\deftypeivarheader#1#2#3{% 4918*43c1707eStholo \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index 4919*43c1707eStholo \begingroup 4920*43c1707eStholo \defname{\defheaderxcond#2\relax$$$#3} 4921*43c1707eStholo {\putwordInstanceVariableof\ \code{#1}}% 4922*43c1707eStholo \defvarargs{#3}% 4923*43c1707eStholo \endgroup 4924*43c1707eStholo} 4925*43c1707eStholo 4926*43c1707eStholo% @defmethod == @defop Method 4927*43c1707eStholo% 4928*43c1707eStholo\def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader} 4929*43c1707eStholo% 4930*43c1707eStholo% #1 is the class name, #2 the method name, #3 the args. 4931*43c1707eStholo\def\defmethodheader#1#2#3{% 4932*43c1707eStholo \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index 4933*43c1707eStholo \begingroup 4934*43c1707eStholo \defname{#2}{\putwordMethodon\ \code{#1}}% 4935*43c1707eStholo \defunargs{#3}% 4936*43c1707eStholo \endgroup 4937*43c1707eStholo} 4938*43c1707eStholo 4939*43c1707eStholo% @defcv {Class Option} foo-class foo-flag 4940*43c1707eStholo 4941*43c1707eStholo\def\defcv #1 {\def\defcvtype{#1}% 4942*43c1707eStholo\defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype} 4943*43c1707eStholo 4944*43c1707eStholo\def\defcvarheader #1#2#3{% 4945*43c1707eStholo\dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index 4946*43c1707eStholo\begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}% 4947*43c1707eStholo\defvarargs {#3}\endgroup % 4948*43c1707eStholo} 4949*43c1707eStholo 4950*43c1707eStholo% @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME 4951*43c1707eStholo% 4952*43c1707eStholo\def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader} 4953*43c1707eStholo% 4954*43c1707eStholo\def\defivarheader#1#2#3{% 4955*43c1707eStholo \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index 4956*43c1707eStholo \begingroup 4957*43c1707eStholo \defname{#2}{\putwordInstanceVariableof\ #1}% 4958*43c1707eStholo \defvarargs{#3}% 4959*43c1707eStholo \endgroup 4960*43c1707eStholo} 4961*43c1707eStholo 4962*43c1707eStholo% @defvar 4963*43c1707eStholo% First, define the processing that is wanted for arguments of @defvar. 4964*43c1707eStholo% This is actually simple: just print them in roman. 4965*43c1707eStholo% This must expand the args and terminate the paragraph they make up 4966*43c1707eStholo\def\defvarargs #1{\normalparens #1% 4967*43c1707eStholo\interlinepenalty=10000 4968*43c1707eStholo\endgraf\nobreak\vskip -\parskip\nobreak} 4969*43c1707eStholo 4970*43c1707eStholo% @defvr Counter foo-count 4971*43c1707eStholo 4972*43c1707eStholo\def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader} 4973*43c1707eStholo 4974*43c1707eStholo\def\defvrheader #1#2#3{\doind {vr}{\code{#2}}% 4975*43c1707eStholo\begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup} 4976*43c1707eStholo 4977*43c1707eStholo% @defvar == @defvr Variable 4978*43c1707eStholo 4979*43c1707eStholo\def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader} 4980*43c1707eStholo 4981*43c1707eStholo\def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index 4982*43c1707eStholo\begingroup\defname {#1}{\putwordDefvar}% 4983*43c1707eStholo\defvarargs {#2}\endgroup % 4984*43c1707eStholo} 4985*43c1707eStholo 4986*43c1707eStholo% @defopt == @defvr {User Option} 4987*43c1707eStholo 4988*43c1707eStholo\def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader} 4989*43c1707eStholo 4990*43c1707eStholo\def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index 4991*43c1707eStholo\begingroup\defname {#1}{\putwordDefopt}% 4992*43c1707eStholo\defvarargs {#2}\endgroup % 4993*43c1707eStholo} 4994*43c1707eStholo 4995*43c1707eStholo% @deftypevar int foobar 4996*43c1707eStholo 4997*43c1707eStholo\def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader} 4998*43c1707eStholo 4999*43c1707eStholo% #1 is the data type. #2 is the name, perhaps followed by text that 5000*43c1707eStholo% is actually part of the data type, which should not be put into the index. 5001*43c1707eStholo\def\deftypevarheader #1#2{% 5002*43c1707eStholo\dovarind#2 \relax% Make entry in variables index 5003*43c1707eStholo\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}% 5004*43c1707eStholo\interlinepenalty=10000 5005*43c1707eStholo\endgraf\nobreak\vskip -\parskip\nobreak 5006*43c1707eStholo\endgroup} 5007*43c1707eStholo\def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}} 5008*43c1707eStholo 5009*43c1707eStholo% @deftypevr {Global Flag} int enable 5010*43c1707eStholo 5011*43c1707eStholo\def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader} 5012*43c1707eStholo 5013*43c1707eStholo\def\deftypevrheader #1#2#3{\dovarind#3 \relax% 5014*43c1707eStholo\begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1} 5015*43c1707eStholo\interlinepenalty=10000 5016*43c1707eStholo\endgraf\nobreak\vskip -\parskip\nobreak 5017*43c1707eStholo\endgroup} 5018*43c1707eStholo 5019*43c1707eStholo% Now define @deftp 5020*43c1707eStholo% Args are printed in bold, a slight difference from @defvar. 5021*43c1707eStholo 5022*43c1707eStholo\def\deftpargs #1{\bf \defvarargs{#1}} 5023*43c1707eStholo 5024*43c1707eStholo% @deftp Class window height width ... 5025*43c1707eStholo 5026*43c1707eStholo\def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader} 5027*43c1707eStholo 5028*43c1707eStholo\def\deftpheader #1#2#3{\doind {tp}{\code{#2}}% 5029*43c1707eStholo\begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup} 5030*43c1707eStholo 5031*43c1707eStholo% These definitions are used if you use @defunx (etc.) 5032*43c1707eStholo% anywhere other than immediately after a @defun or @defunx. 5033*43c1707eStholo% 5034*43c1707eStholo\def\defcvx#1 {\errmessage{@defcvx in invalid context}} 5035*43c1707eStholo\def\deffnx#1 {\errmessage{@deffnx in invalid context}} 5036*43c1707eStholo\def\defivarx#1 {\errmessage{@defivarx in invalid context}} 5037*43c1707eStholo\def\defmacx#1 {\errmessage{@defmacx in invalid context}} 5038*43c1707eStholo\def\defmethodx#1 {\errmessage{@defmethodx in invalid context}} 5039*43c1707eStholo\def\defoptx #1 {\errmessage{@defoptx in invalid context}} 5040*43c1707eStholo\def\defopx#1 {\errmessage{@defopx in invalid context}} 5041*43c1707eStholo\def\defspecx#1 {\errmessage{@defspecx in invalid context}} 5042*43c1707eStholo\def\deftpx#1 {\errmessage{@deftpx in invalid context}} 5043*43c1707eStholo\def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}} 5044*43c1707eStholo\def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}} 5045*43c1707eStholo\def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}} 5046*43c1707eStholo\def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}} 5047*43c1707eStholo\def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}} 5048*43c1707eStholo\def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}} 5049*43c1707eStholo\def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}} 5050*43c1707eStholo\def\defunx#1 {\errmessage{@defunx in invalid context}} 5051*43c1707eStholo\def\defvarx#1 {\errmessage{@defvarx in invalid context}} 5052*43c1707eStholo\def\defvrx#1 {\errmessage{@defvrx in invalid context}} 5053*43c1707eStholo 5054*43c1707eStholo 5055*43c1707eStholo\message{macros,} 5056*43c1707eStholo% @macro. 5057*43c1707eStholo 5058*43c1707eStholo% To do this right we need a feature of e-TeX, \scantokens, 5059*43c1707eStholo% which we arrange to emulate with a temporary file in ordinary TeX. 5060*43c1707eStholo\ifx\eTeXversion\undefined 5061*43c1707eStholo \newwrite\macscribble 5062*43c1707eStholo \def\scanmacro#1{% 5063*43c1707eStholo \begingroup \newlinechar`\^^M 5064*43c1707eStholo % Undo catcode changes of \startcontents and \doprintindex 5065*43c1707eStholo \catcode`\@=0 \catcode`\\=12 \escapechar=`\@ 5066*43c1707eStholo % Append \endinput to make sure that TeX does not see the ending newline. 5067*43c1707eStholo \toks0={#1\endinput}% 5068*43c1707eStholo \immediate\openout\macscribble=\jobname.tmp 5069*43c1707eStholo \immediate\write\macscribble{\the\toks0}% 5070*43c1707eStholo \immediate\closeout\macscribble 5071*43c1707eStholo \let\xeatspaces\eatspaces 5072*43c1707eStholo \input \jobname.tmp 5073*43c1707eStholo \endgroup 5074*43c1707eStholo} 5075*43c1707eStholo\else 5076*43c1707eStholo\def\scanmacro#1{% 5077*43c1707eStholo\begingroup \newlinechar`\^^M 5078*43c1707eStholo% Undo catcode changes of \startcontents and \doprintindex 5079*43c1707eStholo\catcode`\@=0 \catcode`\\=12 \escapechar=`\@ 5080*43c1707eStholo\let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup} 5081*43c1707eStholo\fi 5082*43c1707eStholo 5083*43c1707eStholo\newcount\paramno % Count of parameters 5084*43c1707eStholo\newtoks\macname % Macro name 5085*43c1707eStholo\newif\ifrecursive % Is it recursive? 5086*43c1707eStholo\def\macrolist{} % List of all defined macros in the form 5087*43c1707eStholo % \do\macro1\do\macro2... 5088*43c1707eStholo 5089*43c1707eStholo% Utility routines. 5090*43c1707eStholo% Thisdoes \let #1 = #2, except with \csnames. 5091*43c1707eStholo\def\cslet#1#2{% 5092*43c1707eStholo\expandafter\expandafter 5093*43c1707eStholo\expandafter\let 5094*43c1707eStholo\expandafter\expandafter 5095*43c1707eStholo\csname#1\endcsname 5096*43c1707eStholo\csname#2\endcsname} 5097*43c1707eStholo 5098*43c1707eStholo% Trim leading and trailing spaces off a string. 5099*43c1707eStholo% Concepts from aro-bend problem 15 (see CTAN). 5100*43c1707eStholo{\catcode`\@=11 5101*43c1707eStholo\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} 5102*43c1707eStholo\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} 5103*43c1707eStholo\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} 5104*43c1707eStholo\def\unbrace#1{#1} 5105*43c1707eStholo\unbrace{\gdef\trim@@@ #1 } #2@{#1} 5106*43c1707eStholo} 5107*43c1707eStholo 5108*43c1707eStholo% Trim a single trailing ^^M off a string. 5109*43c1707eStholo{\catcode`\^^M=12\catcode`\Q=3% 5110*43c1707eStholo\gdef\eatcr #1{\eatcra #1Q^^MQ}% 5111*43c1707eStholo\gdef\eatcra#1^^MQ{\eatcrb#1Q}% 5112*43c1707eStholo\gdef\eatcrb#1Q#2Q{#1}% 5113*43c1707eStholo} 5114*43c1707eStholo 5115*43c1707eStholo% Macro bodies are absorbed as an argument in a context where 5116*43c1707eStholo% all characters are catcode 10, 11 or 12, except \ which is active 5117*43c1707eStholo% (as in normal texinfo). It is necessary to change the definition of \. 5118*43c1707eStholo 5119*43c1707eStholo% It's necessary to have hard CRs when the macro is executed. This is 5120*43c1707eStholo% done by making ^^M (\endlinechar) catcode 12 when reading the macro 5121*43c1707eStholo% body, and then making it the \newlinechar in \scanmacro. 5122*43c1707eStholo 5123*43c1707eStholo\def\macrobodyctxt{% 5124*43c1707eStholo \catcode`\~=12 5125*43c1707eStholo \catcode`\^=12 5126*43c1707eStholo \catcode`\_=12 5127*43c1707eStholo \catcode`\|=12 5128*43c1707eStholo \catcode`\<=12 5129*43c1707eStholo \catcode`\>=12 5130*43c1707eStholo \catcode`\+=12 5131*43c1707eStholo \catcode`\{=12 5132*43c1707eStholo \catcode`\}=12 5133*43c1707eStholo \catcode`\@=12 5134*43c1707eStholo \catcode`\^^M=12 5135*43c1707eStholo \usembodybackslash} 5136*43c1707eStholo 5137*43c1707eStholo\def\macroargctxt{% 5138*43c1707eStholo \catcode`\~=12 5139*43c1707eStholo \catcode`\^=12 5140*43c1707eStholo \catcode`\_=12 5141*43c1707eStholo \catcode`\|=12 5142*43c1707eStholo \catcode`\<=12 5143*43c1707eStholo \catcode`\>=12 5144*43c1707eStholo \catcode`\+=12 5145*43c1707eStholo \catcode`\@=12 5146*43c1707eStholo \catcode`\\=12} 5147*43c1707eStholo 5148*43c1707eStholo% \mbodybackslash is the definition of \ in @macro bodies. 5149*43c1707eStholo% It maps \foo\ => \csname macarg.foo\endcsname => #N 5150*43c1707eStholo% where N is the macro parameter number. 5151*43c1707eStholo% We define \csname macarg.\endcsname to be \realbackslash, so 5152*43c1707eStholo% \\ in macro replacement text gets you a backslash. 5153*43c1707eStholo 5154*43c1707eStholo{\catcode`@=0 @catcode`@\=@active 5155*43c1707eStholo @gdef@usembodybackslash{@let\=@mbodybackslash} 5156*43c1707eStholo @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} 5157*43c1707eStholo} 5158*43c1707eStholo\expandafter\def\csname macarg.\endcsname{\realbackslash} 5159*43c1707eStholo 5160*43c1707eStholo\def\macro{\recursivefalse\parsearg\macroxxx} 5161*43c1707eStholo\def\rmacro{\recursivetrue\parsearg\macroxxx} 5162*43c1707eStholo 5163*43c1707eStholo\def\macroxxx#1{% 5164*43c1707eStholo \getargs{#1}% now \macname is the macname and \argl the arglist 5165*43c1707eStholo \ifx\argl\empty % no arguments 5166*43c1707eStholo \paramno=0% 5167*43c1707eStholo \else 5168*43c1707eStholo \expandafter\parsemargdef \argl;% 5169*43c1707eStholo \fi 5170*43c1707eStholo \if1\csname ismacro.\the\macname\endcsname 5171*43c1707eStholo \message{Warning: redefining \the\macname}% 5172*43c1707eStholo \else 5173*43c1707eStholo \expandafter\ifx\csname \the\macname\endcsname \relax 5174*43c1707eStholo \else \errmessage{The name \the\macname\space is reserved}\fi 5175*43c1707eStholo \global\cslet{macsave.\the\macname}{\the\macname}% 5176*43c1707eStholo \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% 5177*43c1707eStholo % Add the macroname to \macrolist 5178*43c1707eStholo \toks0 = \expandafter{\macrolist\do}% 5179*43c1707eStholo \xdef\macrolist{\the\toks0 5180*43c1707eStholo \expandafter\noexpand\csname\the\macname\endcsname}% 5181*43c1707eStholo \fi 5182*43c1707eStholo \begingroup \macrobodyctxt 5183*43c1707eStholo \ifrecursive \expandafter\parsermacbody 5184*43c1707eStholo \else \expandafter\parsemacbody 5185*43c1707eStholo \fi} 5186*43c1707eStholo 5187*43c1707eStholo\def\unmacro{\parsearg\unmacroxxx} 5188*43c1707eStholo\def\unmacroxxx#1{% 5189*43c1707eStholo \if1\csname ismacro.#1\endcsname 5190*43c1707eStholo \global\cslet{#1}{macsave.#1}% 5191*43c1707eStholo \global\expandafter\let \csname ismacro.#1\endcsname=0% 5192*43c1707eStholo % Remove the macro name from \macrolist 5193*43c1707eStholo \begingroup 5194*43c1707eStholo \edef\tempa{\expandafter\noexpand\csname#1\endcsname}% 5195*43c1707eStholo \def\do##1{% 5196*43c1707eStholo \def\tempb{##1}% 5197*43c1707eStholo \ifx\tempa\tempb 5198*43c1707eStholo % remove this 5199*43c1707eStholo \else 5200*43c1707eStholo \toks0 = \expandafter{\newmacrolist\do}% 5201*43c1707eStholo \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}% 5202*43c1707eStholo \fi}% 5203*43c1707eStholo \def\newmacrolist{}% 5204*43c1707eStholo % Execute macro list to define \newmacrolist 5205*43c1707eStholo \macrolist 5206*43c1707eStholo \global\let\macrolist\newmacrolist 5207*43c1707eStholo \endgroup 5208*43c1707eStholo \else 5209*43c1707eStholo \errmessage{Macro #1 not defined}% 5210*43c1707eStholo \fi 5211*43c1707eStholo} 5212*43c1707eStholo 5213*43c1707eStholo% This makes use of the obscure feature that if the last token of a 5214*43c1707eStholo% <parameter list> is #, then the preceding argument is delimited by 5215*43c1707eStholo% an opening brace, and that opening brace is not consumed. 5216*43c1707eStholo\def\getargs#1{\getargsxxx#1{}} 5217*43c1707eStholo\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} 5218*43c1707eStholo\def\getmacname #1 #2\relax{\macname={#1}} 5219*43c1707eStholo\def\getmacargs#1{\def\argl{#1}} 5220*43c1707eStholo 5221*43c1707eStholo% Parse the optional {params} list. Set up \paramno and \paramlist 5222*43c1707eStholo% so \defmacro knows what to do. Define \macarg.blah for each blah 5223*43c1707eStholo% in the params list, to be ##N where N is the position in that list. 5224*43c1707eStholo% That gets used by \mbodybackslash (above). 5225*43c1707eStholo 5226*43c1707eStholo% We need to get `macro parameter char #' into several definitions. 5227*43c1707eStholo% The technique used is stolen from LaTeX: let \hash be something 5228*43c1707eStholo% unexpandable, insert that wherever you need a #, and then redefine 5229*43c1707eStholo% it to # just before using the token list produced. 5230*43c1707eStholo% 5231*43c1707eStholo% The same technique is used to protect \eatspaces till just before 5232*43c1707eStholo% the macro is used. 5233*43c1707eStholo 5234*43c1707eStholo\def\parsemargdef#1;{\paramno=0\def\paramlist{}% 5235*43c1707eStholo \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} 5236*43c1707eStholo\def\parsemargdefxxx#1,{% 5237*43c1707eStholo \if#1;\let\next=\relax 5238*43c1707eStholo \else \let\next=\parsemargdefxxx 5239*43c1707eStholo \advance\paramno by 1% 5240*43c1707eStholo \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname 5241*43c1707eStholo {\xeatspaces{\hash\the\paramno}}% 5242*43c1707eStholo \edef\paramlist{\paramlist\hash\the\paramno,}% 5243*43c1707eStholo \fi\next} 5244*43c1707eStholo 5245*43c1707eStholo% These two commands read recursive and nonrecursive macro bodies. 5246*43c1707eStholo% (They're different since rec and nonrec macros end differently.) 5247*43c1707eStholo 5248*43c1707eStholo\long\def\parsemacbody#1@end macro% 5249*43c1707eStholo{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 5250*43c1707eStholo\long\def\parsermacbody#1@end rmacro% 5251*43c1707eStholo{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 5252*43c1707eStholo 5253*43c1707eStholo% This defines the macro itself. There are six cases: recursive and 5254*43c1707eStholo% nonrecursive macros of zero, one, and many arguments. 5255*43c1707eStholo% Much magic with \expandafter here. 5256*43c1707eStholo% \xdef is used so that macro definitions will survive the file 5257*43c1707eStholo% they're defined in; @include reads the file inside a group. 5258*43c1707eStholo\def\defmacro{% 5259*43c1707eStholo \let\hash=##% convert placeholders to macro parameter chars 5260*43c1707eStholo \ifrecursive 5261*43c1707eStholo \ifcase\paramno 5262*43c1707eStholo % 0 5263*43c1707eStholo \expandafter\xdef\csname\the\macname\endcsname{% 5264*43c1707eStholo \noexpand\scanmacro{\temp}}% 5265*43c1707eStholo \or % 1 5266*43c1707eStholo \expandafter\xdef\csname\the\macname\endcsname{% 5267*43c1707eStholo \bgroup\noexpand\macroargctxt 5268*43c1707eStholo \noexpand\braceorline 5269*43c1707eStholo \expandafter\noexpand\csname\the\macname xxx\endcsname}% 5270*43c1707eStholo \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 5271*43c1707eStholo \egroup\noexpand\scanmacro{\temp}}% 5272*43c1707eStholo \else % many 5273*43c1707eStholo \expandafter\xdef\csname\the\macname\endcsname{% 5274*43c1707eStholo \bgroup\noexpand\macroargctxt 5275*43c1707eStholo \noexpand\csname\the\macname xx\endcsname}% 5276*43c1707eStholo \expandafter\xdef\csname\the\macname xx\endcsname##1{% 5277*43c1707eStholo \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 5278*43c1707eStholo \expandafter\expandafter 5279*43c1707eStholo \expandafter\xdef 5280*43c1707eStholo \expandafter\expandafter 5281*43c1707eStholo \csname\the\macname xxx\endcsname 5282*43c1707eStholo \paramlist{\egroup\noexpand\scanmacro{\temp}}% 5283*43c1707eStholo \fi 5284*43c1707eStholo \else 5285*43c1707eStholo \ifcase\paramno 5286*43c1707eStholo % 0 5287*43c1707eStholo \expandafter\xdef\csname\the\macname\endcsname{% 5288*43c1707eStholo \noexpand\norecurse{\the\macname}% 5289*43c1707eStholo \noexpand\scanmacro{\temp}\egroup}% 5290*43c1707eStholo \or % 1 5291*43c1707eStholo \expandafter\xdef\csname\the\macname\endcsname{% 5292*43c1707eStholo \bgroup\noexpand\macroargctxt 5293*43c1707eStholo \noexpand\braceorline 5294*43c1707eStholo \expandafter\noexpand\csname\the\macname xxx\endcsname}% 5295*43c1707eStholo \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 5296*43c1707eStholo \egroup 5297*43c1707eStholo \noexpand\norecurse{\the\macname}% 5298*43c1707eStholo \noexpand\scanmacro{\temp}\egroup}% 5299*43c1707eStholo \else % many 5300*43c1707eStholo \expandafter\xdef\csname\the\macname\endcsname{% 5301*43c1707eStholo \bgroup\noexpand\macroargctxt 5302*43c1707eStholo \expandafter\noexpand\csname\the\macname xx\endcsname}% 5303*43c1707eStholo \expandafter\xdef\csname\the\macname xx\endcsname##1{% 5304*43c1707eStholo \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 5305*43c1707eStholo \expandafter\expandafter 5306*43c1707eStholo \expandafter\xdef 5307*43c1707eStholo \expandafter\expandafter 5308*43c1707eStholo \csname\the\macname xxx\endcsname 5309*43c1707eStholo \paramlist{% 5310*43c1707eStholo \egroup 5311*43c1707eStholo \noexpand\norecurse{\the\macname}% 5312*43c1707eStholo \noexpand\scanmacro{\temp}\egroup}% 5313*43c1707eStholo \fi 5314*43c1707eStholo \fi} 5315*43c1707eStholo 5316*43c1707eStholo\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} 5317*43c1707eStholo 5318*43c1707eStholo% \braceorline decides whether the next nonwhitespace character is a 5319*43c1707eStholo% {. If so it reads up to the closing }, if not, it reads the whole 5320*43c1707eStholo% line. Whatever was read is then fed to the next control sequence 5321*43c1707eStholo% as an argument (by \parsebrace or \parsearg) 5322*43c1707eStholo\def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx} 5323*43c1707eStholo\def\braceorlinexxx{% 5324*43c1707eStholo \ifx\nchar\bgroup\else 5325*43c1707eStholo \expandafter\parsearg 5326*43c1707eStholo \fi \next} 5327*43c1707eStholo 5328*43c1707eStholo% We mant to disable all macros during \shipout so that they are not 5329*43c1707eStholo% expanded by \write. 5330*43c1707eStholo\def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}% 5331*43c1707eStholo \edef\next{\macrolist}\expandafter\endgroup\next} 5332*43c1707eStholo 5333*43c1707eStholo 5334*43c1707eStholo% @alias. 5335*43c1707eStholo% We need some trickery to remove the optional spaces around the equal 5336*43c1707eStholo% sign. Just make them active and then expand them all to nothing. 5337*43c1707eStholo\def\alias{\begingroup\obeyspaces\parsearg\aliasxxx} 5338*43c1707eStholo\def\aliasxxx #1{\aliasyyy#1\relax} 5339*43c1707eStholo\def\aliasyyy #1=#2\relax{\ignoreactivespaces 5340*43c1707eStholo\edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=% 5341*43c1707eStholo \expandafter\noexpand\csname#2\endcsname}% 5342*43c1707eStholo\expandafter\endgroup\next} 5343*43c1707eStholo 5344*43c1707eStholo 5345*43c1707eStholo\message{cross references,} 5346*43c1707eStholo% @xref etc. 5347*43c1707eStholo 5348*43c1707eStholo\newwrite\auxfile 5349*43c1707eStholo 5350*43c1707eStholo\newif\ifhavexrefs % True if xref values are known. 5351*43c1707eStholo\newif\ifwarnedxrefs % True if we warned once that they aren't known. 5352*43c1707eStholo 5353*43c1707eStholo% @inforef is relatively simple. 5354*43c1707eStholo\def\inforef #1{\inforefzzz #1,,,,**} 5355*43c1707eStholo\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, 5356*43c1707eStholo node \samp{\ignorespaces#1{}}} 5357*43c1707eStholo 5358*43c1707eStholo% @node's job is to define \lastnode. 5359*43c1707eStholo\def\node{\ENVcheck\parsearg\nodezzz} 5360*43c1707eStholo\def\nodezzz#1{\nodexxx [#1,]} 5361*43c1707eStholo\def\nodexxx[#1,#2]{\gdef\lastnode{#1}} 5362*43c1707eStholo\let\nwnode=\node 5363*43c1707eStholo\let\lastnode=\relax 5364*43c1707eStholo 5365*43c1707eStholo% The sectioning commands (@chapter, etc.) call these. 5366*43c1707eStholo\def\donoderef{% 5367*43c1707eStholo \ifx\lastnode\relax\else 5368*43c1707eStholo \expandafter\expandafter\expandafter\setref{\lastnode}% 5369*43c1707eStholo {Ysectionnumberandtype}% 5370*43c1707eStholo \global\let\lastnode=\relax 5371*43c1707eStholo \fi 5372*43c1707eStholo} 5373*43c1707eStholo\def\unnumbnoderef{% 5374*43c1707eStholo \ifx\lastnode\relax\else 5375*43c1707eStholo \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}% 5376*43c1707eStholo \global\let\lastnode=\relax 5377*43c1707eStholo \fi 5378*43c1707eStholo} 5379*43c1707eStholo\def\appendixnoderef{% 5380*43c1707eStholo \ifx\lastnode\relax\else 5381*43c1707eStholo \expandafter\expandafter\expandafter\setref{\lastnode}% 5382*43c1707eStholo {Yappendixletterandtype}% 5383*43c1707eStholo \global\let\lastnode=\relax 5384*43c1707eStholo \fi 5385*43c1707eStholo} 5386*43c1707eStholo 5387*43c1707eStholo 5388*43c1707eStholo% @anchor{NAME} -- define xref target at arbitrary point. 5389*43c1707eStholo% 5390*43c1707eStholo\newcount\savesfregister 5391*43c1707eStholo\gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} 5392*43c1707eStholo\gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} 5393*43c1707eStholo\gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} 5394*43c1707eStholo 5395*43c1707eStholo% \setref{NAME}{SNT} defines a cross-reference point NAME, namely 5396*43c1707eStholo% NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have 5397*43c1707eStholo% to set \indexdummies so commands such as @code in a section title 5398*43c1707eStholo% aren't expanded. It would be nicer not to expand the titles in the 5399*43c1707eStholo% first place, but there's so many layers that that is hard to do. 5400*43c1707eStholo% 5401*43c1707eStholo\def\setref#1#2{{% 5402*43c1707eStholo \indexdummies 5403*43c1707eStholo \pdfmkdest{#1}% 5404*43c1707eStholo \dosetq{#1-title}{Ytitle}% 5405*43c1707eStholo \dosetq{#1-pg}{Ypagenumber}% 5406*43c1707eStholo \dosetq{#1-snt}{#2}% 5407*43c1707eStholo}} 5408*43c1707eStholo 5409*43c1707eStholo% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is 5410*43c1707eStholo% the node name, #2 the name of the Info cross-reference, #3 the printed 5411*43c1707eStholo% node name, #4 the name of the Info file, #5 the name of the printed 5412*43c1707eStholo% manual. All but the node name can be omitted. 5413*43c1707eStholo% 5414*43c1707eStholo\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} 5415*43c1707eStholo\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} 5416*43c1707eStholo\def\ref#1{\xrefX[#1,,,,,,,]} 5417*43c1707eStholo\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup 5418*43c1707eStholo \unsepspaces 5419*43c1707eStholo \def\printedmanual{\ignorespaces #5}% 5420*43c1707eStholo \def\printednodename{\ignorespaces #3}% 5421*43c1707eStholo \setbox1=\hbox{\printedmanual}% 5422*43c1707eStholo \setbox0=\hbox{\printednodename}% 5423*43c1707eStholo \ifdim \wd0 = 0pt 5424*43c1707eStholo % No printed node name was explicitly given. 5425*43c1707eStholo \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax 5426*43c1707eStholo % Use the node name inside the square brackets. 5427*43c1707eStholo \def\printednodename{\ignorespaces #1}% 5428*43c1707eStholo \else 5429*43c1707eStholo % Use the actual chapter/section title appear inside 5430*43c1707eStholo % the square brackets. Use the real section title if we have it. 5431*43c1707eStholo \ifdim \wd1 > 0pt 5432*43c1707eStholo % It is in another manual, so we don't have it. 5433*43c1707eStholo \def\printednodename{\ignorespaces #1}% 5434*43c1707eStholo \else 5435*43c1707eStholo \ifhavexrefs 5436*43c1707eStholo % We know the real title if we have the xref values. 5437*43c1707eStholo \def\printednodename{\refx{#1-title}{}}% 5438*43c1707eStholo \else 5439*43c1707eStholo % Otherwise just copy the Info node name. 5440*43c1707eStholo \def\printednodename{\ignorespaces #1}% 5441*43c1707eStholo \fi% 5442*43c1707eStholo \fi 5443*43c1707eStholo \fi 5444*43c1707eStholo \fi 5445*43c1707eStholo % 5446*43c1707eStholo % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not 5447*43c1707eStholo % insert empty discretionaries after hyphens, which means that it will 5448*43c1707eStholo % not find a line break at a hyphen in a node names. Since some manuals 5449*43c1707eStholo % are best written with fairly long node names, containing hyphens, this 5450*43c1707eStholo % is a loss. Therefore, we give the text of the node name again, so it 5451*43c1707eStholo % is as if TeX is seeing it for the first time. 5452*43c1707eStholo \ifpdf 5453*43c1707eStholo \leavevmode 5454*43c1707eStholo \getfilename{#4}% 5455*43c1707eStholo \ifnum\filenamelength>0 5456*43c1707eStholo \startlink attr{/Border [0 0 0]}% 5457*43c1707eStholo goto file{\the\filename.pdf} name{#1@}% 5458*43c1707eStholo \else 5459*43c1707eStholo \startlink attr{/Border [0 0 0]}% 5460*43c1707eStholo goto name{#1@}% 5461*43c1707eStholo \fi 5462*43c1707eStholo \linkcolor 5463*43c1707eStholo \fi 5464*43c1707eStholo % 5465*43c1707eStholo \ifdim \wd1 > 0pt 5466*43c1707eStholo \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}% 5467*43c1707eStholo \else 5468*43c1707eStholo % _ (for example) has to be the character _ for the purposes of the 5469*43c1707eStholo % control sequence corresponding to the node, but it has to expand 5470*43c1707eStholo % into the usual \leavevmode...\vrule stuff for purposes of 5471*43c1707eStholo % printing. So we \turnoffactive for the \refx-snt, back on for the 5472*43c1707eStholo % printing, back off for the \refx-pg. 5473*43c1707eStholo {\normalturnoffactive 5474*43c1707eStholo % Only output a following space if the -snt ref is nonempty; for 5475*43c1707eStholo % @unnumbered and @anchor, it won't be. 5476*43c1707eStholo \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% 5477*43c1707eStholo \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi 5478*43c1707eStholo }% 5479*43c1707eStholo % [mynode], 5480*43c1707eStholo [\printednodename],\space 5481*43c1707eStholo % page 3 5482*43c1707eStholo \turnoffactive \putwordpage\tie\refx{#1-pg}{}% 5483*43c1707eStholo \fi 5484*43c1707eStholo \endlink 5485*43c1707eStholo\endgroup} 5486*43c1707eStholo 5487*43c1707eStholo% \dosetq is the interface for calls from other macros 5488*43c1707eStholo 5489*43c1707eStholo% Use \normalturnoffactive so that punctuation chars such as underscore 5490*43c1707eStholo% and backslash work in node names. (\turnoffactive doesn't do \.) 5491*43c1707eStholo\def\dosetq#1#2{% 5492*43c1707eStholo {\let\folio=0% 5493*43c1707eStholo \normalturnoffactive 5494*43c1707eStholo \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}% 5495*43c1707eStholo \iflinks 5496*43c1707eStholo \next 5497*43c1707eStholo \fi 5498*43c1707eStholo }% 5499*43c1707eStholo} 5500*43c1707eStholo 5501*43c1707eStholo% \internalsetq {foo}{page} expands into 5502*43c1707eStholo% CHARACTERS 'xrdef {foo}{...expansion of \Ypage...} 5503*43c1707eStholo% When the aux file is read, ' is the escape character 5504*43c1707eStholo 5505*43c1707eStholo\def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}} 5506*43c1707eStholo 5507*43c1707eStholo% Things to be expanded by \internalsetq 5508*43c1707eStholo 5509*43c1707eStholo\def\Ypagenumber{\folio} 5510*43c1707eStholo 5511*43c1707eStholo\def\Ytitle{\thissection} 5512*43c1707eStholo 5513*43c1707eStholo\def\Ynothing{} 5514*43c1707eStholo 5515*43c1707eStholo\def\Ysectionnumberandtype{% 5516*43c1707eStholo\ifnum\secno=0 \putwordChapter\xreftie\the\chapno % 5517*43c1707eStholo\else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno % 5518*43c1707eStholo\else \ifnum \subsubsecno=0 % 5519*43c1707eStholo\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno % 5520*43c1707eStholo\else % 5521*43c1707eStholo\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno % 5522*43c1707eStholo\fi \fi \fi } 5523*43c1707eStholo 5524*43c1707eStholo\def\Yappendixletterandtype{% 5525*43c1707eStholo\ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}% 5526*43c1707eStholo\else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno % 5527*43c1707eStholo\else \ifnum \subsubsecno=0 % 5528*43c1707eStholo\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno % 5529*43c1707eStholo\else % 5530*43c1707eStholo\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno % 5531*43c1707eStholo\fi \fi \fi } 5532*43c1707eStholo 5533*43c1707eStholo\gdef\xreftie{'tie} 5534*43c1707eStholo 5535*43c1707eStholo% Use TeX 3.0's \inputlineno to get the line number, for better error 5536*43c1707eStholo% messages, but if we're using an old version of TeX, don't do anything. 5537*43c1707eStholo% 5538*43c1707eStholo\ifx\inputlineno\thisisundefined 5539*43c1707eStholo \let\linenumber = \empty % Non-3.0. 5540*43c1707eStholo\else 5541*43c1707eStholo \def\linenumber{\the\inputlineno:\space} 5542*43c1707eStholo\fi 5543*43c1707eStholo 5544*43c1707eStholo% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. 5545*43c1707eStholo% If its value is nonempty, SUFFIX is output afterward. 5546*43c1707eStholo 5547*43c1707eStholo\def\refx#1#2{% 5548*43c1707eStholo \expandafter\ifx\csname X#1\endcsname\relax 5549*43c1707eStholo % If not defined, say something at least. 5550*43c1707eStholo \angleleft un\-de\-fined\angleright 5551*43c1707eStholo \iflinks 5552*43c1707eStholo \ifhavexrefs 5553*43c1707eStholo \message{\linenumber Undefined cross reference `#1'.}% 5554*43c1707eStholo \else 5555*43c1707eStholo \ifwarnedxrefs\else 5556*43c1707eStholo \global\warnedxrefstrue 5557*43c1707eStholo \message{Cross reference values unknown; you must run TeX again.}% 5558*43c1707eStholo \fi 5559*43c1707eStholo \fi 5560*43c1707eStholo \fi 5561*43c1707eStholo \else 5562*43c1707eStholo % It's defined, so just use it. 5563*43c1707eStholo \csname X#1\endcsname 5564*43c1707eStholo \fi 5565*43c1707eStholo #2% Output the suffix in any case. 5566*43c1707eStholo} 5567*43c1707eStholo 5568*43c1707eStholo% This is the macro invoked by entries in the aux file. 5569*43c1707eStholo% 5570*43c1707eStholo\def\xrdef#1{\begingroup 5571*43c1707eStholo % Reenable \ as an escape while reading the second argument. 5572*43c1707eStholo \catcode`\\ = 0 5573*43c1707eStholo \afterassignment\endgroup 5574*43c1707eStholo \expandafter\gdef\csname X#1\endcsname 5575*43c1707eStholo} 5576*43c1707eStholo 5577*43c1707eStholo% Read the last existing aux file, if any. No error if none exists. 5578*43c1707eStholo\def\readauxfile{\begingroup 5579*43c1707eStholo \catcode`\^^@=\other 5580*43c1707eStholo \catcode`\^^A=\other 5581*43c1707eStholo \catcode`\^^B=\other 5582*43c1707eStholo \catcode`\^^C=\other 5583*43c1707eStholo \catcode`\^^D=\other 5584*43c1707eStholo \catcode`\^^E=\other 5585*43c1707eStholo \catcode`\^^F=\other 5586*43c1707eStholo \catcode`\^^G=\other 5587*43c1707eStholo \catcode`\^^H=\other 5588*43c1707eStholo \catcode`\^^K=\other 5589*43c1707eStholo \catcode`\^^L=\other 5590*43c1707eStholo \catcode`\^^N=\other 5591*43c1707eStholo \catcode`\^^P=\other 5592*43c1707eStholo \catcode`\^^Q=\other 5593*43c1707eStholo \catcode`\^^R=\other 5594*43c1707eStholo \catcode`\^^S=\other 5595*43c1707eStholo \catcode`\^^T=\other 5596*43c1707eStholo \catcode`\^^U=\other 5597*43c1707eStholo \catcode`\^^V=\other 5598*43c1707eStholo \catcode`\^^W=\other 5599*43c1707eStholo \catcode`\^^X=\other 5600*43c1707eStholo \catcode`\^^Z=\other 5601*43c1707eStholo \catcode`\^^[=\other 5602*43c1707eStholo \catcode`\^^\=\other 5603*43c1707eStholo \catcode`\^^]=\other 5604*43c1707eStholo \catcode`\^^^=\other 5605*43c1707eStholo \catcode`\^^_=\other 5606*43c1707eStholo \catcode`\@=\other 5607*43c1707eStholo \catcode`\^=\other 5608*43c1707eStholo % It was suggested to define this as 7, which would allow ^^e4 etc. 5609*43c1707eStholo % in xref tags, i.e., node names. But since ^^e4 notation isn't 5610*43c1707eStholo % supported in the main text, it doesn't seem desirable. Furthermore, 5611*43c1707eStholo % that is not enough: for node names that actually contain a ^ 5612*43c1707eStholo % character, we would end up writing a line like this: 'xrdef {'hat 5613*43c1707eStholo % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first 5614*43c1707eStholo % argument, and \hat is not an expandable control sequence. It could 5615*43c1707eStholo % all be worked out, but why? Either we support ^^ or we don't. 5616*43c1707eStholo % 5617*43c1707eStholo % The other change necessary for this was to define \auxhat: 5618*43c1707eStholo % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter 5619*43c1707eStholo % and then to call \auxhat in \setq. 5620*43c1707eStholo % 5621*43c1707eStholo \catcode`\~=\other 5622*43c1707eStholo \catcode`\[=\other 5623*43c1707eStholo \catcode`\]=\other 5624*43c1707eStholo \catcode`\"=\other 5625*43c1707eStholo \catcode`\_=\other 5626*43c1707eStholo \catcode`\|=\other 5627*43c1707eStholo \catcode`\<=\other 5628*43c1707eStholo \catcode`\>=\other 5629*43c1707eStholo \catcode`\$=\other 5630*43c1707eStholo \catcode`\#=\other 5631*43c1707eStholo \catcode`\&=\other 5632*43c1707eStholo \catcode`+=\other % avoid \+ for paranoia even though we've turned it off 5633*43c1707eStholo % Make the characters 128-255 be printing characters 5634*43c1707eStholo {% 5635*43c1707eStholo \count 1=128 5636*43c1707eStholo \def\loop{% 5637*43c1707eStholo \catcode\count 1=\other 5638*43c1707eStholo \advance\count 1 by 1 5639*43c1707eStholo \ifnum \count 1<256 \loop \fi 5640*43c1707eStholo }% 5641*43c1707eStholo }% 5642*43c1707eStholo % The aux file uses ' as the escape (for now). 5643*43c1707eStholo % Turn off \ as an escape so we do not lose on 5644*43c1707eStholo % entries which were dumped with control sequences in their names. 5645*43c1707eStholo % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^ 5646*43c1707eStholo % Reference to such entries still does not work the way one would wish, 5647*43c1707eStholo % but at least they do not bomb out when the aux file is read in. 5648*43c1707eStholo \catcode`\{=1 5649*43c1707eStholo \catcode`\}=2 5650*43c1707eStholo \catcode`\%=\other 5651*43c1707eStholo \catcode`\'=0 5652*43c1707eStholo \catcode`\\=\other 5653*43c1707eStholo % 5654*43c1707eStholo \openin 1 \jobname.aux 5655*43c1707eStholo \ifeof 1 \else 5656*43c1707eStholo \closein 1 5657*43c1707eStholo \input \jobname.aux 5658*43c1707eStholo \global\havexrefstrue 5659*43c1707eStholo \global\warnedobstrue 5660*43c1707eStholo \fi 5661*43c1707eStholo % Open the new aux file. TeX will close it automatically at exit. 5662*43c1707eStholo \openout\auxfile=\jobname.aux 5663*43c1707eStholo\endgroup} 5664*43c1707eStholo 5665*43c1707eStholo 5666*43c1707eStholo% Footnotes. 5667*43c1707eStholo 5668*43c1707eStholo\newcount \footnoteno 5669*43c1707eStholo 5670*43c1707eStholo% The trailing space in the following definition for supereject is 5671*43c1707eStholo% vital for proper filling; pages come out unaligned when you do a 5672*43c1707eStholo% pagealignmacro call if that space before the closing brace is 5673*43c1707eStholo% removed. (Generally, numeric constants should always be followed by a 5674*43c1707eStholo% space to prevent strange expansion errors.) 5675*43c1707eStholo\def\supereject{\par\penalty -20000\footnoteno =0 } 5676*43c1707eStholo 5677*43c1707eStholo% @footnotestyle is meaningful for info output only. 5678*43c1707eStholo\let\footnotestyle=\comment 5679*43c1707eStholo 5680*43c1707eStholo\let\ptexfootnote=\footnote 5681*43c1707eStholo 5682*43c1707eStholo{\catcode `\@=11 5683*43c1707eStholo% 5684*43c1707eStholo% Auto-number footnotes. Otherwise like plain. 5685*43c1707eStholo\gdef\footnote{% 5686*43c1707eStholo \global\advance\footnoteno by \@ne 5687*43c1707eStholo \edef\thisfootno{$^{\the\footnoteno}$}% 5688*43c1707eStholo % 5689*43c1707eStholo % In case the footnote comes at the end of a sentence, preserve the 5690*43c1707eStholo % extra spacing after we do the footnote number. 5691*43c1707eStholo \let\@sf\empty 5692*43c1707eStholo \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi 5693*43c1707eStholo % 5694*43c1707eStholo % Remove inadvertent blank space before typesetting the footnote number. 5695*43c1707eStholo \unskip 5696*43c1707eStholo \thisfootno\@sf 5697*43c1707eStholo \footnotezzz 5698*43c1707eStholo}% 5699*43c1707eStholo 5700*43c1707eStholo% Don't bother with the trickery in plain.tex to not require the 5701*43c1707eStholo% footnote text as a parameter. Our footnotes don't need to be so general. 5702*43c1707eStholo% 5703*43c1707eStholo% Oh yes, they do; otherwise, @ifset and anything else that uses 5704*43c1707eStholo% \parseargline fail inside footnotes because the tokens are fixed when 5705*43c1707eStholo% the footnote is read. --karl, 16nov96. 5706*43c1707eStholo% 5707*43c1707eStholo\long\gdef\footnotezzz{\insert\footins\bgroup 5708*43c1707eStholo % We want to typeset this text as a normal paragraph, even if the 5709*43c1707eStholo % footnote reference occurs in (for example) a display environment. 5710*43c1707eStholo % So reset some parameters. 5711*43c1707eStholo \interlinepenalty\interfootnotelinepenalty 5712*43c1707eStholo \splittopskip\ht\strutbox % top baseline for broken footnotes 5713*43c1707eStholo \splitmaxdepth\dp\strutbox 5714*43c1707eStholo \floatingpenalty\@MM 5715*43c1707eStholo \leftskip\z@skip 5716*43c1707eStholo \rightskip\z@skip 5717*43c1707eStholo \spaceskip\z@skip 5718*43c1707eStholo \xspaceskip\z@skip 5719*43c1707eStholo \parindent\defaultparindent 5720*43c1707eStholo % 5721*43c1707eStholo \smallfonts \rm 5722*43c1707eStholo % 5723*43c1707eStholo % Hang the footnote text off the number. 5724*43c1707eStholo \hang 5725*43c1707eStholo \textindent{\thisfootno}% 5726*43c1707eStholo % 5727*43c1707eStholo % Don't crash into the line above the footnote text. Since this 5728*43c1707eStholo % expands into a box, it must come within the paragraph, lest it 5729*43c1707eStholo % provide a place where TeX can split the footnote. 5730*43c1707eStholo \footstrut 5731*43c1707eStholo \futurelet\next\fo@t 5732*43c1707eStholo} 5733*43c1707eStholo\def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t 5734*43c1707eStholo \else\let\next\f@t\fi \next} 5735*43c1707eStholo\def\f@@t{\bgroup\aftergroup\@foot\let\next} 5736*43c1707eStholo\def\f@t#1{#1\@foot} 5737*43c1707eStholo\def\@foot{\strut\par\egroup} 5738*43c1707eStholo 5739*43c1707eStholo}%end \catcode `\@=11 5740*43c1707eStholo 5741*43c1707eStholo% Set the baselineskip to #1, and the lineskip and strut size 5742*43c1707eStholo% correspondingly. There is no deep meaning behind these magic numbers 5743*43c1707eStholo% used as factors; they just match (closely enough) what Knuth defined. 5744*43c1707eStholo% 5745*43c1707eStholo\def\lineskipfactor{.08333} 5746*43c1707eStholo\def\strutheightpercent{.70833} 5747*43c1707eStholo\def\strutdepthpercent {.29167} 5748*43c1707eStholo% 5749*43c1707eStholo\def\setleading#1{% 5750*43c1707eStholo \normalbaselineskip = #1\relax 5751*43c1707eStholo \normallineskip = \lineskipfactor\normalbaselineskip 5752*43c1707eStholo \normalbaselines 5753*43c1707eStholo \setbox\strutbox =\hbox{% 5754*43c1707eStholo \vrule width0pt height\strutheightpercent\baselineskip 5755*43c1707eStholo depth \strutdepthpercent \baselineskip 5756*43c1707eStholo }% 5757*43c1707eStholo} 5758*43c1707eStholo 5759*43c1707eStholo% @| inserts a changebar to the left of the current line. It should 5760*43c1707eStholo% surround any changed text. This approach does *not* work if the 5761*43c1707eStholo% change spans more than two lines of output. To handle that, we would 5762*43c1707eStholo% have adopt a much more difficult approach (putting marks into the main 5763*43c1707eStholo% vertical list for the beginning and end of each change). 5764*43c1707eStholo% 5765*43c1707eStholo\def\|{% 5766*43c1707eStholo % \vadjust can only be used in horizontal mode. 5767*43c1707eStholo \leavevmode 5768*43c1707eStholo % 5769*43c1707eStholo % Append this vertical mode material after the current line in the output. 5770*43c1707eStholo \vadjust{% 5771*43c1707eStholo % We want to insert a rule with the height and depth of the current 5772*43c1707eStholo % leading; that is exactly what \strutbox is supposed to record. 5773*43c1707eStholo \vskip-\baselineskip 5774*43c1707eStholo % 5775*43c1707eStholo % \vadjust-items are inserted at the left edge of the type. So 5776*43c1707eStholo % the \llap here moves out into the left-hand margin. 5777*43c1707eStholo \llap{% 5778*43c1707eStholo % 5779*43c1707eStholo % For a thicker or thinner bar, change the `1pt'. 5780*43c1707eStholo \vrule height\baselineskip width1pt 5781*43c1707eStholo % 5782*43c1707eStholo % This is the space between the bar and the text. 5783*43c1707eStholo \hskip 12pt 5784*43c1707eStholo }% 5785*43c1707eStholo }% 5786*43c1707eStholo} 5787*43c1707eStholo 5788*43c1707eStholo% For a final copy, take out the rectangles 5789*43c1707eStholo% that mark overfull boxes (in case you have decided 5790*43c1707eStholo% that the text looks ok even though it passes the margin). 5791*43c1707eStholo% 5792*43c1707eStholo\def\finalout{\overfullrule=0pt} 5793*43c1707eStholo 5794*43c1707eStholo% @image. We use the macros from epsf.tex to support this. 5795*43c1707eStholo% If epsf.tex is not installed and @image is used, we complain. 5796*43c1707eStholo% 5797*43c1707eStholo% Check for and read epsf.tex up front. If we read it only at @image 5798*43c1707eStholo% time, we might be inside a group, and then its definitions would get 5799*43c1707eStholo% undone and the next image would fail. 5800*43c1707eStholo\openin 1 = epsf.tex 5801*43c1707eStholo\ifeof 1 \else 5802*43c1707eStholo \closein 1 5803*43c1707eStholo % Do not bother showing banner with post-v2.7 epsf.tex (available in 5804*43c1707eStholo % doc/epsf.tex until it shows up on ctan). 5805*43c1707eStholo \def\epsfannounce{\toks0 = }% 5806*43c1707eStholo \input epsf.tex 5807*43c1707eStholo\fi 5808*43c1707eStholo% 5809*43c1707eStholo% We will only complain once about lack of epsf.tex. 5810*43c1707eStholo\newif\ifwarnednoepsf 5811*43c1707eStholo\newhelp\noepsfhelp{epsf.tex must be installed for images to 5812*43c1707eStholo work. It is also included in the Texinfo distribution, or you can get 5813*43c1707eStholo it from ftp://tug.org/tex/epsf.tex.} 5814*43c1707eStholo% 5815*43c1707eStholo\def\image#1{% 5816*43c1707eStholo \ifx\epsfbox\undefined 5817*43c1707eStholo \ifwarnednoepsf \else 5818*43c1707eStholo \errhelp = \noepsfhelp 5819*43c1707eStholo \errmessage{epsf.tex not found, images will be ignored}% 5820*43c1707eStholo \global\warnednoepsftrue 5821*43c1707eStholo \fi 5822*43c1707eStholo \else 5823*43c1707eStholo \imagexxx #1,,,\finish 5824*43c1707eStholo \fi 5825*43c1707eStholo} 5826*43c1707eStholo% 5827*43c1707eStholo% Arguments to @image: 5828*43c1707eStholo% #1 is (mandatory) image filename; we tack on .eps extension. 5829*43c1707eStholo% #2 is (optional) width, #3 is (optional) height. 5830*43c1707eStholo% #4 is just the usual extra ignored arg for parsing this stuff. 5831*43c1707eStholo\def\imagexxx#1,#2,#3,#4\finish{% 5832*43c1707eStholo \ifpdf 5833*43c1707eStholo \centerline{\dopdfimage{#1}{#2}{#3}}% 5834*43c1707eStholo \else 5835*43c1707eStholo % \epsfbox itself resets \epsf?size at each figure. 5836*43c1707eStholo \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi 5837*43c1707eStholo \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi 5838*43c1707eStholo \begingroup 5839*43c1707eStholo \catcode`\^^M = 5 % in case we're inside an example 5840*43c1707eStholo % If the image is by itself, center it. 5841*43c1707eStholo \ifvmode 5842*43c1707eStholo \nobreak\bigskip 5843*43c1707eStholo % Usually we'll have text after the image which will insert 5844*43c1707eStholo % \parskip glue, so insert it here too to equalize the space 5845*43c1707eStholo % above and below. 5846*43c1707eStholo \nobreak\vskip\parskip 5847*43c1707eStholo \nobreak 5848*43c1707eStholo \centerline{\epsfbox{#1.eps}}% 5849*43c1707eStholo \bigbreak 5850*43c1707eStholo \else 5851*43c1707eStholo % In the middle of a paragraph, no extra space. 5852*43c1707eStholo \epsfbox{#1.eps}% 5853*43c1707eStholo \fi 5854*43c1707eStholo \endgroup 5855*43c1707eStholo \fi 5856*43c1707eStholo} 5857*43c1707eStholo 5858*43c1707eStholo 5859*43c1707eStholo\message{localization,} 5860*43c1707eStholo% and i18n. 5861*43c1707eStholo 5862*43c1707eStholo% @documentlanguage is usually given very early, just after 5863*43c1707eStholo% @setfilename. If done too late, it may not override everything 5864*43c1707eStholo% properly. Single argument is the language abbreviation. 5865*43c1707eStholo% It would be nice if we could set up a hyphenation file here. 5866*43c1707eStholo% 5867*43c1707eStholo\def\documentlanguage{\parsearg\dodocumentlanguage} 5868*43c1707eStholo\def\dodocumentlanguage#1{% 5869*43c1707eStholo \tex % read txi-??.tex file in plain TeX. 5870*43c1707eStholo % Read the file if it exists. 5871*43c1707eStholo \openin 1 txi-#1.tex 5872*43c1707eStholo \ifeof1 5873*43c1707eStholo \errhelp = \nolanghelp 5874*43c1707eStholo \errmessage{Cannot read language file txi-#1.tex}% 5875*43c1707eStholo \let\temp = \relax 5876*43c1707eStholo \else 5877*43c1707eStholo \def\temp{\input txi-#1.tex }% 5878*43c1707eStholo \fi 5879*43c1707eStholo \temp 5880*43c1707eStholo \endgroup 5881*43c1707eStholo} 5882*43c1707eStholo\newhelp\nolanghelp{The given language definition file cannot be found or 5883*43c1707eStholois empty. Maybe you need to install it? In the current directory 5884*43c1707eStholoshould work if nowhere else does.} 5885*43c1707eStholo 5886*43c1707eStholo 5887*43c1707eStholo% @documentencoding should change something in TeX eventually, most 5888*43c1707eStholo% likely, but for now just recognize it. 5889*43c1707eStholo\let\documentencoding = \comment 5890*43c1707eStholo 5891*43c1707eStholo 5892*43c1707eStholo% Page size parameters. 5893*43c1707eStholo% 5894*43c1707eStholo\newdimen\defaultparindent \defaultparindent = 15pt 5895*43c1707eStholo 5896*43c1707eStholo\chapheadingskip = 15pt plus 4pt minus 2pt 5897*43c1707eStholo\secheadingskip = 12pt plus 3pt minus 2pt 5898*43c1707eStholo\subsecheadingskip = 9pt plus 2pt minus 2pt 5899*43c1707eStholo 5900*43c1707eStholo% Prevent underfull vbox error messages. 5901*43c1707eStholo\vbadness = 10000 5902*43c1707eStholo 5903*43c1707eStholo% Don't be so finicky about underfull hboxes, either. 5904*43c1707eStholo\hbadness = 2000 5905*43c1707eStholo 5906*43c1707eStholo% Following George Bush, just get rid of widows and orphans. 5907*43c1707eStholo\widowpenalty=10000 5908*43c1707eStholo\clubpenalty=10000 5909*43c1707eStholo 5910*43c1707eStholo% Use TeX 3.0's \emergencystretch to help line breaking, but if we're 5911*43c1707eStholo% using an old version of TeX, don't do anything. We want the amount of 5912*43c1707eStholo% stretch added to depend on the line length, hence the dependence on 5913*43c1707eStholo% \hsize. We call this whenever the paper size is set. 5914*43c1707eStholo% 5915*43c1707eStholo\def\setemergencystretch{% 5916*43c1707eStholo \ifx\emergencystretch\thisisundefined 5917*43c1707eStholo % Allow us to assign to \emergencystretch anyway. 5918*43c1707eStholo \def\emergencystretch{\dimen0}% 5919*43c1707eStholo \else 5920*43c1707eStholo \emergencystretch = .15\hsize 5921*43c1707eStholo \fi 5922*43c1707eStholo} 5923*43c1707eStholo 5924*43c1707eStholo% Parameters in order: 1) textheight; 2) textwidth; 3) voffset; 5925*43c1707eStholo% 4) hoffset; 5) binding offset; 6) topskip. Then whoever calls us can 5926*43c1707eStholo% set \parskip and call \setleading for \baselineskip. 5927*43c1707eStholo% 5928*43c1707eStholo\def\internalpagesizes#1#2#3#4#5#6{% 5929*43c1707eStholo \voffset = #3\relax 5930*43c1707eStholo \topskip = #6\relax 5931*43c1707eStholo \splittopskip = \topskip 5932*43c1707eStholo % 5933*43c1707eStholo \vsize = #1\relax 5934*43c1707eStholo \advance\vsize by \topskip 5935*43c1707eStholo \outervsize = \vsize 5936*43c1707eStholo \advance\outervsize by 2\topandbottommargin 5937*43c1707eStholo \pageheight = \vsize 5938*43c1707eStholo % 5939*43c1707eStholo \hsize = #2\relax 5940*43c1707eStholo \outerhsize = \hsize 5941*43c1707eStholo \advance\outerhsize by 0.5in 5942*43c1707eStholo \pagewidth = \hsize 5943*43c1707eStholo % 5944*43c1707eStholo \normaloffset = #4\relax 5945*43c1707eStholo \bindingoffset = #5\relax 5946*43c1707eStholo % 5947*43c1707eStholo \parindent = \defaultparindent 5948*43c1707eStholo \setemergencystretch 5949*43c1707eStholo} 5950*43c1707eStholo 5951*43c1707eStholo% @letterpaper (the default). 5952*43c1707eStholo\def\letterpaper{{\globaldefs = 1 5953*43c1707eStholo \parskip = 3pt plus 2pt minus 1pt 5954*43c1707eStholo \setleading{13.2pt}% 5955*43c1707eStholo % 5956*43c1707eStholo % If page is nothing but text, make it come out even. 5957*43c1707eStholo \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}% 5958*43c1707eStholo}} 5959*43c1707eStholo 5960*43c1707eStholo% Use @smallbook to reset parameters for 7x9.5 (or so) format. 5961*43c1707eStholo\def\smallbook{{\globaldefs = 1 5962*43c1707eStholo \parskip = 2pt plus 1pt 5963*43c1707eStholo \setleading{12pt}% 5964*43c1707eStholo % 5965*43c1707eStholo \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}% 5966*43c1707eStholo % 5967*43c1707eStholo \lispnarrowing = 0.3in 5968*43c1707eStholo \tolerance = 700 5969*43c1707eStholo \hfuzz = 1pt 5970*43c1707eStholo \contentsrightmargin = 0pt 5971*43c1707eStholo \deftypemargin = 0pt 5972*43c1707eStholo \defbodyindent = .5cm 5973*43c1707eStholo % 5974*43c1707eStholo \let\smalldisplay = \smalldisplayx 5975*43c1707eStholo \let\smallexample = \smalllispx 5976*43c1707eStholo \let\smallformat = \smallformatx 5977*43c1707eStholo \let\smalllisp = \smalllispx 5978*43c1707eStholo}} 5979*43c1707eStholo 5980*43c1707eStholo% Use @afourpaper to print on European A4 paper. 5981*43c1707eStholo\def\afourpaper{{\globaldefs = 1 5982*43c1707eStholo \setleading{12pt}% 5983*43c1707eStholo \parskip = 3pt plus 2pt minus 1pt 5984*43c1707eStholo % 5985*43c1707eStholo \internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}% 5986*43c1707eStholo % 5987*43c1707eStholo \tolerance = 700 5988*43c1707eStholo \hfuzz = 1pt 5989*43c1707eStholo}} 5990*43c1707eStholo 5991*43c1707eStholo% A specific text layout, 24x15cm overall, intended for A4 paper. Top margin 5992*43c1707eStholo% 29mm, hence bottom margin 28mm, nominal side margin 3cm. 5993*43c1707eStholo\def\afourlatex{{\globaldefs = 1 5994*43c1707eStholo \setleading{13.6pt}% 5995*43c1707eStholo % 5996*43c1707eStholo \afourpaper 5997*43c1707eStholo \internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}% 5998*43c1707eStholo % 5999*43c1707eStholo \globaldefs = 0 6000*43c1707eStholo}} 6001*43c1707eStholo 6002*43c1707eStholo% Use @afourwide to print on European A4 paper in wide format. 6003*43c1707eStholo\def\afourwide{% 6004*43c1707eStholo \afourpaper 6005*43c1707eStholo \internalpagesizes{6.5in}{9.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}% 6006*43c1707eStholo % 6007*43c1707eStholo \globaldefs = 0 6008*43c1707eStholo} 6009*43c1707eStholo 6010*43c1707eStholo% @pagesizes TEXTHEIGHT[,TEXTWIDTH] 6011*43c1707eStholo% Perhaps we should allow setting the margins, \topskip, \parskip, 6012*43c1707eStholo% and/or leading, also. Or perhaps we should compute them somehow. 6013*43c1707eStholo% 6014*43c1707eStholo\def\pagesizes{\parsearg\pagesizesxxx} 6015*43c1707eStholo\def\pagesizesxxx#1{\pagesizesyyy #1,,\finish} 6016*43c1707eStholo\def\pagesizesyyy#1,#2,#3\finish{{% 6017*43c1707eStholo \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi 6018*43c1707eStholo \globaldefs = 1 6019*43c1707eStholo % 6020*43c1707eStholo \parskip = 3pt plus 2pt minus 1pt 6021*43c1707eStholo \setleading{13.2pt}% 6022*43c1707eStholo % 6023*43c1707eStholo \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}% 6024*43c1707eStholo}} 6025*43c1707eStholo 6026*43c1707eStholo% Set default to letter. 6027*43c1707eStholo% 6028*43c1707eStholo\letterpaper 6029*43c1707eStholo 6030*43c1707eStholo 6031*43c1707eStholo\message{and turning on texinfo input format.} 6032*43c1707eStholo 6033*43c1707eStholo% Define macros to output various characters with catcode for normal text. 6034*43c1707eStholo\catcode`\"=\other 6035*43c1707eStholo\catcode`\~=\other 6036*43c1707eStholo\catcode`\^=\other 6037*43c1707eStholo\catcode`\_=\other 6038*43c1707eStholo\catcode`\|=\other 6039*43c1707eStholo\catcode`\<=\other 6040*43c1707eStholo\catcode`\>=\other 6041*43c1707eStholo\catcode`\+=\other 6042*43c1707eStholo\catcode`\$=\other 6043*43c1707eStholo\def\normaldoublequote{"} 6044*43c1707eStholo\def\normaltilde{~} 6045*43c1707eStholo\def\normalcaret{^} 6046*43c1707eStholo\def\normalunderscore{_} 6047*43c1707eStholo\def\normalverticalbar{|} 6048*43c1707eStholo\def\normalless{<} 6049*43c1707eStholo\def\normalgreater{>} 6050*43c1707eStholo\def\normalplus{+} 6051*43c1707eStholo\def\normaldollar{$} 6052*43c1707eStholo 6053*43c1707eStholo% This macro is used to make a character print one way in ttfont 6054*43c1707eStholo% where it can probably just be output, and another way in other fonts, 6055*43c1707eStholo% where something hairier probably needs to be done. 6056*43c1707eStholo% 6057*43c1707eStholo% #1 is what to print if we are indeed using \tt; #2 is what to print 6058*43c1707eStholo% otherwise. Since all the Computer Modern typewriter fonts have zero 6059*43c1707eStholo% interword stretch (and shrink), and it is reasonable to expect all 6060*43c1707eStholo% typewriter fonts to have this, we can check that font parameter. 6061*43c1707eStholo% 6062*43c1707eStholo\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} 6063*43c1707eStholo 6064*43c1707eStholo% Same as above, but check for italic font. Actually this also catches 6065*43c1707eStholo% non-italic slanted fonts since it is impossible to distinguish them from 6066*43c1707eStholo% italic fonts. But since this is only used by $ and it uses \sl anyway 6067*43c1707eStholo% this is not a problem. 6068*43c1707eStholo\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} 6069*43c1707eStholo 6070*43c1707eStholo% Turn off all special characters except @ 6071*43c1707eStholo% (and those which the user can use as if they were ordinary). 6072*43c1707eStholo% Most of these we simply print from the \tt font, but for some, we can 6073*43c1707eStholo% use math or other variants that look better in normal text. 6074*43c1707eStholo 6075*43c1707eStholo\catcode`\"=\active 6076*43c1707eStholo\def\activedoublequote{{\tt\char34}} 6077*43c1707eStholo\let"=\activedoublequote 6078*43c1707eStholo\catcode`\~=\active 6079*43c1707eStholo\def~{{\tt\char126}} 6080*43c1707eStholo\chardef\hat=`\^ 6081*43c1707eStholo\catcode`\^=\active 6082*43c1707eStholo\def^{{\tt \hat}} 6083*43c1707eStholo 6084*43c1707eStholo\catcode`\_=\active 6085*43c1707eStholo\def_{\ifusingtt\normalunderscore\_} 6086*43c1707eStholo% Subroutine for the previous macro. 6087*43c1707eStholo\def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}} 6088*43c1707eStholo 6089*43c1707eStholo\catcode`\|=\active 6090*43c1707eStholo\def|{{\tt\char124}} 6091*43c1707eStholo\chardef \less=`\< 6092*43c1707eStholo\catcode`\<=\active 6093*43c1707eStholo\def<{{\tt \less}} 6094*43c1707eStholo\chardef \gtr=`\> 6095*43c1707eStholo\catcode`\>=\active 6096*43c1707eStholo\def>{{\tt \gtr}} 6097*43c1707eStholo\catcode`\+=\active 6098*43c1707eStholo\def+{{\tt \char 43}} 6099*43c1707eStholo\catcode`\$=\active 6100*43c1707eStholo\def${\ifusingit{{\sl\$}}\normaldollar} 6101*43c1707eStholo%\catcode 27=\active 6102*43c1707eStholo%\def^^[{$\diamondsuit$} 6103*43c1707eStholo 6104*43c1707eStholo% Set up an active definition for =, but don't enable it most of the time. 6105*43c1707eStholo{\catcode`\==\active 6106*43c1707eStholo\global\def={{\tt \char 61}}} 6107*43c1707eStholo 6108*43c1707eStholo\catcode`+=\active 6109*43c1707eStholo\catcode`\_=\active 6110*43c1707eStholo 6111*43c1707eStholo% If a .fmt file is being used, characters that might appear in a file 6112*43c1707eStholo% name cannot be active until we have parsed the command line. 6113*43c1707eStholo% So turn them off again, and have \everyjob (or @setfilename) turn them on. 6114*43c1707eStholo% \otherifyactive is called near the end of this file. 6115*43c1707eStholo\def\otherifyactive{\catcode`+=\other \catcode`\_=\other} 6116*43c1707eStholo 6117*43c1707eStholo\catcode`\@=0 6118*43c1707eStholo 6119*43c1707eStholo% \rawbackslashxx output one backslash character in current font 6120*43c1707eStholo\global\chardef\rawbackslashxx=`\\ 6121*43c1707eStholo%{\catcode`\\=\other 6122*43c1707eStholo%@gdef@rawbackslashxx{\}} 6123*43c1707eStholo 6124*43c1707eStholo% \rawbackslash redefines \ as input to do \rawbackslashxx. 6125*43c1707eStholo{\catcode`\\=\active 6126*43c1707eStholo@gdef@rawbackslash{@let\=@rawbackslashxx }} 6127*43c1707eStholo 6128*43c1707eStholo% \normalbackslash outputs one backslash in fixed width font. 6129*43c1707eStholo\def\normalbackslash{{\tt\rawbackslashxx}} 6130*43c1707eStholo 6131*43c1707eStholo% \catcode 17=0 % Define control-q 6132*43c1707eStholo\catcode`\\=\active 6133*43c1707eStholo 6134*43c1707eStholo% Used sometimes to turn off (effectively) the active characters 6135*43c1707eStholo% even after parsing them. 6136*43c1707eStholo@def@turnoffactive{@let"=@normaldoublequote 6137*43c1707eStholo@let\=@realbackslash 6138*43c1707eStholo@let~=@normaltilde 6139*43c1707eStholo@let^=@normalcaret 6140*43c1707eStholo@let_=@normalunderscore 6141*43c1707eStholo@let|=@normalverticalbar 6142*43c1707eStholo@let<=@normalless 6143*43c1707eStholo@let>=@normalgreater 6144*43c1707eStholo@let+=@normalplus 6145*43c1707eStholo@let$=@normaldollar} 6146*43c1707eStholo 6147*43c1707eStholo@def@normalturnoffactive{@let"=@normaldoublequote 6148*43c1707eStholo@let\=@normalbackslash 6149*43c1707eStholo@let~=@normaltilde 6150*43c1707eStholo@let^=@normalcaret 6151*43c1707eStholo@let_=@normalunderscore 6152*43c1707eStholo@let|=@normalverticalbar 6153*43c1707eStholo@let<=@normalless 6154*43c1707eStholo@let>=@normalgreater 6155*43c1707eStholo@let+=@normalplus 6156*43c1707eStholo@let$=@normaldollar} 6157*43c1707eStholo 6158*43c1707eStholo% Make _ and + \other characters, temporarily. 6159*43c1707eStholo% This is canceled by @fixbackslash. 6160*43c1707eStholo@otherifyactive 6161*43c1707eStholo 6162*43c1707eStholo% If a .fmt file is being used, we don't want the `\input texinfo' to show up. 6163*43c1707eStholo% That is what \eatinput is for; after that, the `\' should revert to printing 6164*43c1707eStholo% a backslash. 6165*43c1707eStholo% 6166*43c1707eStholo@gdef@eatinput input texinfo{@fixbackslash} 6167*43c1707eStholo@global@let\ = @eatinput 6168*43c1707eStholo 6169*43c1707eStholo% On the other hand, perhaps the file did not have a `\input texinfo'. Then 6170*43c1707eStholo% the first `\{ in the file would cause an error. This macro tries to fix 6171*43c1707eStholo% that, assuming it is called before the first `\' could plausibly occur. 6172*43c1707eStholo% Also back turn on active characters that might appear in the input 6173*43c1707eStholo% file name, in case not using a pre-dumped format. 6174*43c1707eStholo% 6175*43c1707eStholo@gdef@fixbackslash{% 6176*43c1707eStholo @ifx\@eatinput @let\ = @normalbackslash @fi 6177*43c1707eStholo @catcode`+=@active 6178*43c1707eStholo @catcode`@_=@active 6179*43c1707eStholo} 6180*43c1707eStholo 6181*43c1707eStholo% Say @foo, not \foo, in error messages. 6182*43c1707eStholo@escapechar = `@@ 6183*43c1707eStholo 6184*43c1707eStholo% These look ok in all fonts, so just make them not special. 6185*43c1707eStholo@catcode`@& = @other 6186*43c1707eStholo@catcode`@# = @other 6187*43c1707eStholo@catcode`@% = @other 6188*43c1707eStholo 6189*43c1707eStholo@c Set initial fonts. 6190*43c1707eStholo@textfonts 6191*43c1707eStholo@rm 6192*43c1707eStholo 6193*43c1707eStholo 6194*43c1707eStholo@c Local variables: 6195*43c1707eStholo@c eval: (add-hook 'write-file-hooks 'time-stamp) 6196*43c1707eStholo@c page-delimiter: "^\\\\message" 6197*43c1707eStholo@c time-stamp-start: "def\\\\texinfoversion{" 6198*43c1707eStholo@c time-stamp-format: "%:y-%02m-%02d.%02H" 6199*43c1707eStholo@c time-stamp-end: "}" 6200*43c1707eStholo@c End: 6201