xref: /onnv-gate/usr/src/grub/grub-0.97/docs/texinfo.tex (revision 8044:b3af80bbf173)
1*8044SWilliam.Kucharski@Sun.COM% texinfo.tex -- TeX macros to handle Texinfo files.
2*8044SWilliam.Kucharski@Sun.COM%
3*8044SWilliam.Kucharski@Sun.COM% Load plain if necessary, i.e., if running under initex.
4*8044SWilliam.Kucharski@Sun.COM\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5*8044SWilliam.Kucharski@Sun.COM%
6*8044SWilliam.Kucharski@Sun.COM\def\texinfoversion{2004-11-25.16}
7*8044SWilliam.Kucharski@Sun.COM%
8*8044SWilliam.Kucharski@Sun.COM% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9*8044SWilliam.Kucharski@Sun.COM% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
10*8044SWilliam.Kucharski@Sun.COM% Foundation, Inc.
11*8044SWilliam.Kucharski@Sun.COM%
12*8044SWilliam.Kucharski@Sun.COM% This texinfo.tex file is free software; you can redistribute it and/or
13*8044SWilliam.Kucharski@Sun.COM% modify it under the terms of the GNU General Public License as
14*8044SWilliam.Kucharski@Sun.COM% published by the Free Software Foundation; either version 2, or (at
15*8044SWilliam.Kucharski@Sun.COM% your option) any later version.
16*8044SWilliam.Kucharski@Sun.COM%
17*8044SWilliam.Kucharski@Sun.COM% This texinfo.tex file is distributed in the hope that it will be
18*8044SWilliam.Kucharski@Sun.COM% useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19*8044SWilliam.Kucharski@Sun.COM% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20*8044SWilliam.Kucharski@Sun.COM% General Public License for more details.
21*8044SWilliam.Kucharski@Sun.COM%
22*8044SWilliam.Kucharski@Sun.COM% You should have received a copy of the GNU General Public License
23*8044SWilliam.Kucharski@Sun.COM% along with this texinfo.tex file; see the file COPYING.  If not, write
24*8044SWilliam.Kucharski@Sun.COM% to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25*8044SWilliam.Kucharski@Sun.COM% Boston, MA 02111-1307, USA.
26*8044SWilliam.Kucharski@Sun.COM%
27*8044SWilliam.Kucharski@Sun.COM% As a special exception, when this file is read by TeX when processing
28*8044SWilliam.Kucharski@Sun.COM% a Texinfo source document, you may use the result without
29*8044SWilliam.Kucharski@Sun.COM% restriction.  (This has been our intent since Texinfo was invented.)
30*8044SWilliam.Kucharski@Sun.COM%
31*8044SWilliam.Kucharski@Sun.COM% Please try the latest version of texinfo.tex before submitting bug
32*8044SWilliam.Kucharski@Sun.COM% reports; you can get the latest version from:
33*8044SWilliam.Kucharski@Sun.COM%   http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34*8044SWilliam.Kucharski@Sun.COM%   ftp://tug.org/tex/texinfo.tex
35*8044SWilliam.Kucharski@Sun.COM%     (and all CTAN mirrors, see http://www.ctan.org).
36*8044SWilliam.Kucharski@Sun.COM% The texinfo.tex in any given distribution could well be out
37*8044SWilliam.Kucharski@Sun.COM% of date, so if that's what you're using, please check.
38*8044SWilliam.Kucharski@Sun.COM%
39*8044SWilliam.Kucharski@Sun.COM% Send bug reports to bug-texinfo@gnu.org.  Please include including a
40*8044SWilliam.Kucharski@Sun.COM% complete document in each bug report with which we can reproduce the
41*8044SWilliam.Kucharski@Sun.COM% problem.  Patches are, of course, greatly appreciated.
42*8044SWilliam.Kucharski@Sun.COM%
43*8044SWilliam.Kucharski@Sun.COM% To process a Texinfo manual with TeX, it's most reliable to use the
44*8044SWilliam.Kucharski@Sun.COM% texi2dvi shell script that comes with the distribution.  For a simple
45*8044SWilliam.Kucharski@Sun.COM% manual foo.texi, however, you can get away with this:
46*8044SWilliam.Kucharski@Sun.COM%   tex foo.texi
47*8044SWilliam.Kucharski@Sun.COM%   texindex foo.??
48*8044SWilliam.Kucharski@Sun.COM%   tex foo.texi
49*8044SWilliam.Kucharski@Sun.COM%   tex foo.texi
50*8044SWilliam.Kucharski@Sun.COM%   dvips foo.dvi -o  # or whatever; this makes foo.ps.
51*8044SWilliam.Kucharski@Sun.COM% The extra TeX runs get the cross-reference information correct.
52*8044SWilliam.Kucharski@Sun.COM% Sometimes one run after texindex suffices, and sometimes you need more
53*8044SWilliam.Kucharski@Sun.COM% than two; texi2dvi does it as many times as necessary.
54*8044SWilliam.Kucharski@Sun.COM%
55*8044SWilliam.Kucharski@Sun.COM% It is possible to adapt texinfo.tex for other languages, to some
56*8044SWilliam.Kucharski@Sun.COM% extent.  You can get the existing language-specific files from the
57*8044SWilliam.Kucharski@Sun.COM% full Texinfo distribution.
58*8044SWilliam.Kucharski@Sun.COM%
59*8044SWilliam.Kucharski@Sun.COM% The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60*8044SWilliam.Kucharski@Sun.COM
61*8044SWilliam.Kucharski@Sun.COM
62*8044SWilliam.Kucharski@Sun.COM\message{Loading texinfo [version \texinfoversion]:}
63*8044SWilliam.Kucharski@Sun.COM
64*8044SWilliam.Kucharski@Sun.COM% If in a .fmt file, print the version number
65*8044SWilliam.Kucharski@Sun.COM% and turn on active characters that we couldn't do earlier because
66*8044SWilliam.Kucharski@Sun.COM% they might have appeared in the input file name.
67*8044SWilliam.Kucharski@Sun.COM\everyjob{\message{[Texinfo version \texinfoversion]}%
68*8044SWilliam.Kucharski@Sun.COM  \catcode`+=\active \catcode`\_=\active}
69*8044SWilliam.Kucharski@Sun.COM
70*8044SWilliam.Kucharski@Sun.COM\message{Basics,}
71*8044SWilliam.Kucharski@Sun.COM\chardef\other=12
72*8044SWilliam.Kucharski@Sun.COM
73*8044SWilliam.Kucharski@Sun.COM% We never want plain's \outer definition of \+ in Texinfo.
74*8044SWilliam.Kucharski@Sun.COM% For @tex, we can use \tabalign.
75*8044SWilliam.Kucharski@Sun.COM\let\+ = \relax
76*8044SWilliam.Kucharski@Sun.COM
77*8044SWilliam.Kucharski@Sun.COM% Save some plain tex macros whose names we will redefine.
78*8044SWilliam.Kucharski@Sun.COM\let\ptexb=\b
79*8044SWilliam.Kucharski@Sun.COM\let\ptexbullet=\bullet
80*8044SWilliam.Kucharski@Sun.COM\let\ptexc=\c
81*8044SWilliam.Kucharski@Sun.COM\let\ptexcomma=\,
82*8044SWilliam.Kucharski@Sun.COM\let\ptexdot=\.
83*8044SWilliam.Kucharski@Sun.COM\let\ptexdots=\dots
84*8044SWilliam.Kucharski@Sun.COM\let\ptexend=\end
85*8044SWilliam.Kucharski@Sun.COM\let\ptexequiv=\equiv
86*8044SWilliam.Kucharski@Sun.COM\let\ptexexclam=\!
87*8044SWilliam.Kucharski@Sun.COM\let\ptexfootnote=\footnote
88*8044SWilliam.Kucharski@Sun.COM\let\ptexgtr=>
89*8044SWilliam.Kucharski@Sun.COM\let\ptexhat=^
90*8044SWilliam.Kucharski@Sun.COM\let\ptexi=\i
91*8044SWilliam.Kucharski@Sun.COM\let\ptexindent=\indent
92*8044SWilliam.Kucharski@Sun.COM\let\ptexinsert=\insert
93*8044SWilliam.Kucharski@Sun.COM\let\ptexlbrace=\{
94*8044SWilliam.Kucharski@Sun.COM\let\ptexless=<
95*8044SWilliam.Kucharski@Sun.COM\let\ptexnewwrite\newwrite
96*8044SWilliam.Kucharski@Sun.COM\let\ptexnoindent=\noindent
97*8044SWilliam.Kucharski@Sun.COM\let\ptexplus=+
98*8044SWilliam.Kucharski@Sun.COM\let\ptexrbrace=\}
99*8044SWilliam.Kucharski@Sun.COM\let\ptexslash=\/
100*8044SWilliam.Kucharski@Sun.COM\let\ptexstar=\*
101*8044SWilliam.Kucharski@Sun.COM\let\ptext=\t
102*8044SWilliam.Kucharski@Sun.COM
103*8044SWilliam.Kucharski@Sun.COM% If this character appears in an error message or help string, it
104*8044SWilliam.Kucharski@Sun.COM% starts a new line in the output.
105*8044SWilliam.Kucharski@Sun.COM\newlinechar = `^^J
106*8044SWilliam.Kucharski@Sun.COM
107*8044SWilliam.Kucharski@Sun.COM% Use TeX 3.0's \inputlineno to get the line number, for better error
108*8044SWilliam.Kucharski@Sun.COM% messages, but if we're using an old version of TeX, don't do anything.
109*8044SWilliam.Kucharski@Sun.COM%
110*8044SWilliam.Kucharski@Sun.COM\ifx\inputlineno\thisisundefined
111*8044SWilliam.Kucharski@Sun.COM  \let\linenumber = \empty % Pre-3.0.
112*8044SWilliam.Kucharski@Sun.COM\else
113*8044SWilliam.Kucharski@Sun.COM  \def\linenumber{l.\the\inputlineno:\space}
114*8044SWilliam.Kucharski@Sun.COM\fi
115*8044SWilliam.Kucharski@Sun.COM
116*8044SWilliam.Kucharski@Sun.COM% Set up fixed words for English if not already set.
117*8044SWilliam.Kucharski@Sun.COM\ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
118*8044SWilliam.Kucharski@Sun.COM\ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
119*8044SWilliam.Kucharski@Sun.COM\ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
120*8044SWilliam.Kucharski@Sun.COM\ifx\putwordin\undefined        \gdef\putwordin{in}\fi
121*8044SWilliam.Kucharski@Sun.COM\ifx\putwordIndexIsEmpty\undefined     \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122*8044SWilliam.Kucharski@Sun.COM\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123*8044SWilliam.Kucharski@Sun.COM\ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
124*8044SWilliam.Kucharski@Sun.COM\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
126*8044SWilliam.Kucharski@Sun.COM\ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
127*8044SWilliam.Kucharski@Sun.COM\ifx\putwordof\undefined        \gdef\putwordof{of}\fi
128*8044SWilliam.Kucharski@Sun.COM\ifx\putwordon\undefined        \gdef\putwordon{on}\fi
129*8044SWilliam.Kucharski@Sun.COM\ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
130*8044SWilliam.Kucharski@Sun.COM\ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
131*8044SWilliam.Kucharski@Sun.COM\ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
132*8044SWilliam.Kucharski@Sun.COM\ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
133*8044SWilliam.Kucharski@Sun.COM\ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
134*8044SWilliam.Kucharski@Sun.COM\ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
135*8044SWilliam.Kucharski@Sun.COM\ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
136*8044SWilliam.Kucharski@Sun.COM%
137*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148*8044SWilliam.Kucharski@Sun.COM\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149*8044SWilliam.Kucharski@Sun.COM%
150*8044SWilliam.Kucharski@Sun.COM\ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
151*8044SWilliam.Kucharski@Sun.COM\ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
152*8044SWilliam.Kucharski@Sun.COM\ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
153*8044SWilliam.Kucharski@Sun.COM\ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
154*8044SWilliam.Kucharski@Sun.COM\ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
155*8044SWilliam.Kucharski@Sun.COM
156*8044SWilliam.Kucharski@Sun.COM% In some macros, we cannot use the `\? notation---the left quote is
157*8044SWilliam.Kucharski@Sun.COM% in some cases the escape char.
158*8044SWilliam.Kucharski@Sun.COM\chardef\colonChar = `\:
159*8044SWilliam.Kucharski@Sun.COM\chardef\commaChar = `\,
160*8044SWilliam.Kucharski@Sun.COM\chardef\dotChar   = `\.
161*8044SWilliam.Kucharski@Sun.COM\chardef\exclamChar= `\!
162*8044SWilliam.Kucharski@Sun.COM\chardef\questChar = `\?
163*8044SWilliam.Kucharski@Sun.COM\chardef\semiChar  = `\;
164*8044SWilliam.Kucharski@Sun.COM\chardef\underChar = `\_
165*8044SWilliam.Kucharski@Sun.COM
166*8044SWilliam.Kucharski@Sun.COM\chardef\spaceChar = `\ %
167*8044SWilliam.Kucharski@Sun.COM\chardef\spacecat = 10
168*8044SWilliam.Kucharski@Sun.COM\def\spaceisspace{\catcode\spaceChar=\spacecat}
169*8044SWilliam.Kucharski@Sun.COM
170*8044SWilliam.Kucharski@Sun.COM% Ignore a token.
171*8044SWilliam.Kucharski@Sun.COM%
172*8044SWilliam.Kucharski@Sun.COM\def\gobble#1{}
173*8044SWilliam.Kucharski@Sun.COM
174*8044SWilliam.Kucharski@Sun.COM% The following is used inside several \edef's.
175*8044SWilliam.Kucharski@Sun.COM\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
176*8044SWilliam.Kucharski@Sun.COM
177*8044SWilliam.Kucharski@Sun.COM% Hyphenation fixes.
178*8044SWilliam.Kucharski@Sun.COM\hyphenation{
179*8044SWilliam.Kucharski@Sun.COM  Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
180*8044SWilliam.Kucharski@Sun.COM  ap-pen-dix bit-map bit-maps
181*8044SWilliam.Kucharski@Sun.COM  data-base data-bases eshell fall-ing half-way long-est man-u-script
182*8044SWilliam.Kucharski@Sun.COM  man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
183*8044SWilliam.Kucharski@Sun.COM  par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
184*8044SWilliam.Kucharski@Sun.COM  spell-ing spell-ings
185*8044SWilliam.Kucharski@Sun.COM  stand-alone strong-est time-stamp time-stamps which-ever white-space
186*8044SWilliam.Kucharski@Sun.COM  wide-spread wrap-around
187*8044SWilliam.Kucharski@Sun.COM}
188*8044SWilliam.Kucharski@Sun.COM
189*8044SWilliam.Kucharski@Sun.COM% Margin to add to right of even pages, to left of odd pages.
190*8044SWilliam.Kucharski@Sun.COM\newdimen\bindingoffset
191*8044SWilliam.Kucharski@Sun.COM\newdimen\normaloffset
192*8044SWilliam.Kucharski@Sun.COM\newdimen\pagewidth \newdimen\pageheight
193*8044SWilliam.Kucharski@Sun.COM
194*8044SWilliam.Kucharski@Sun.COM% For a final copy, take out the rectangles
195*8044SWilliam.Kucharski@Sun.COM% that mark overfull boxes (in case you have decided
196*8044SWilliam.Kucharski@Sun.COM% that the text looks ok even though it passes the margin).
197*8044SWilliam.Kucharski@Sun.COM%
198*8044SWilliam.Kucharski@Sun.COM\def\finalout{\overfullrule=0pt}
199*8044SWilliam.Kucharski@Sun.COM
200*8044SWilliam.Kucharski@Sun.COM% @| inserts a changebar to the left of the current line.  It should
201*8044SWilliam.Kucharski@Sun.COM% surround any changed text.  This approach does *not* work if the
202*8044SWilliam.Kucharski@Sun.COM% change spans more than two lines of output.  To handle that, we would
203*8044SWilliam.Kucharski@Sun.COM% have adopt a much more difficult approach (putting marks into the main
204*8044SWilliam.Kucharski@Sun.COM% vertical list for the beginning and end of each change).
205*8044SWilliam.Kucharski@Sun.COM%
206*8044SWilliam.Kucharski@Sun.COM\def\|{%
207*8044SWilliam.Kucharski@Sun.COM  % \vadjust can only be used in horizontal mode.
208*8044SWilliam.Kucharski@Sun.COM  \leavevmode
209*8044SWilliam.Kucharski@Sun.COM  %
210*8044SWilliam.Kucharski@Sun.COM  % Append this vertical mode material after the current line in the output.
211*8044SWilliam.Kucharski@Sun.COM  \vadjust{%
212*8044SWilliam.Kucharski@Sun.COM    % We want to insert a rule with the height and depth of the current
213*8044SWilliam.Kucharski@Sun.COM    % leading; that is exactly what \strutbox is supposed to record.
214*8044SWilliam.Kucharski@Sun.COM    \vskip-\baselineskip
215*8044SWilliam.Kucharski@Sun.COM    %
216*8044SWilliam.Kucharski@Sun.COM    % \vadjust-items are inserted at the left edge of the type.  So
217*8044SWilliam.Kucharski@Sun.COM    % the \llap here moves out into the left-hand margin.
218*8044SWilliam.Kucharski@Sun.COM    \llap{%
219*8044SWilliam.Kucharski@Sun.COM      %
220*8044SWilliam.Kucharski@Sun.COM      % For a thicker or thinner bar, change the `1pt'.
221*8044SWilliam.Kucharski@Sun.COM      \vrule height\baselineskip width1pt
222*8044SWilliam.Kucharski@Sun.COM      %
223*8044SWilliam.Kucharski@Sun.COM      % This is the space between the bar and the text.
224*8044SWilliam.Kucharski@Sun.COM      \hskip 12pt
225*8044SWilliam.Kucharski@Sun.COM    }%
226*8044SWilliam.Kucharski@Sun.COM  }%
227*8044SWilliam.Kucharski@Sun.COM}
228*8044SWilliam.Kucharski@Sun.COM
229*8044SWilliam.Kucharski@Sun.COM% Sometimes it is convenient to have everything in the transcript file
230*8044SWilliam.Kucharski@Sun.COM% and nothing on the terminal.  We don't just call \tracingall here,
231*8044SWilliam.Kucharski@Sun.COM% since that produces some useless output on the terminal.  We also make
232*8044SWilliam.Kucharski@Sun.COM% some effort to order the tracing commands to reduce output in the log
233*8044SWilliam.Kucharski@Sun.COM% file; cf. trace.sty in LaTeX.
234*8044SWilliam.Kucharski@Sun.COM%
235*8044SWilliam.Kucharski@Sun.COM\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
236*8044SWilliam.Kucharski@Sun.COM\def\loggingall{%
237*8044SWilliam.Kucharski@Sun.COM  \tracingstats2
238*8044SWilliam.Kucharski@Sun.COM  \tracingpages1
239*8044SWilliam.Kucharski@Sun.COM  \tracinglostchars2  % 2 gives us more in etex
240*8044SWilliam.Kucharski@Sun.COM  \tracingparagraphs1
241*8044SWilliam.Kucharski@Sun.COM  \tracingoutput1
242*8044SWilliam.Kucharski@Sun.COM  \tracingmacros2
243*8044SWilliam.Kucharski@Sun.COM  \tracingrestores1
244*8044SWilliam.Kucharski@Sun.COM  \showboxbreadth\maxdimen \showboxdepth\maxdimen
245*8044SWilliam.Kucharski@Sun.COM  \ifx\eTeXversion\undefined\else % etex gives us more logging
246*8044SWilliam.Kucharski@Sun.COM    \tracingscantokens1
247*8044SWilliam.Kucharski@Sun.COM    \tracingifs1
248*8044SWilliam.Kucharski@Sun.COM    \tracinggroups1
249*8044SWilliam.Kucharski@Sun.COM    \tracingnesting2
250*8044SWilliam.Kucharski@Sun.COM    \tracingassigns1
251*8044SWilliam.Kucharski@Sun.COM  \fi
252*8044SWilliam.Kucharski@Sun.COM  \tracingcommands3  % 3 gives us more in etex
253*8044SWilliam.Kucharski@Sun.COM  \errorcontextlines16
254*8044SWilliam.Kucharski@Sun.COM}%
255*8044SWilliam.Kucharski@Sun.COM
256*8044SWilliam.Kucharski@Sun.COM% add check for \lastpenalty to plain's definitions.  If the last thing
257*8044SWilliam.Kucharski@Sun.COM% we did was a \nobreak, we don't want to insert more space.
258*8044SWilliam.Kucharski@Sun.COM%
259*8044SWilliam.Kucharski@Sun.COM\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
260*8044SWilliam.Kucharski@Sun.COM  \removelastskip\penalty-50\smallskip\fi\fi}
261*8044SWilliam.Kucharski@Sun.COM\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
262*8044SWilliam.Kucharski@Sun.COM  \removelastskip\penalty-100\medskip\fi\fi}
263*8044SWilliam.Kucharski@Sun.COM\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
264*8044SWilliam.Kucharski@Sun.COM  \removelastskip\penalty-200\bigskip\fi\fi}
265*8044SWilliam.Kucharski@Sun.COM
266*8044SWilliam.Kucharski@Sun.COM% For @cropmarks command.
267*8044SWilliam.Kucharski@Sun.COM% Do @cropmarks to get crop marks.
268*8044SWilliam.Kucharski@Sun.COM%
269*8044SWilliam.Kucharski@Sun.COM\newif\ifcropmarks
270*8044SWilliam.Kucharski@Sun.COM\let\cropmarks = \cropmarkstrue
271*8044SWilliam.Kucharski@Sun.COM%
272*8044SWilliam.Kucharski@Sun.COM% Dimensions to add cropmarks at corners.
273*8044SWilliam.Kucharski@Sun.COM% Added by P. A. MacKay, 12 Nov. 1986
274*8044SWilliam.Kucharski@Sun.COM%
275*8044SWilliam.Kucharski@Sun.COM\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
276*8044SWilliam.Kucharski@Sun.COM\newdimen\cornerlong  \cornerlong=1pc
277*8044SWilliam.Kucharski@Sun.COM\newdimen\cornerthick \cornerthick=.3pt
278*8044SWilliam.Kucharski@Sun.COM\newdimen\topandbottommargin \topandbottommargin=.75in
279*8044SWilliam.Kucharski@Sun.COM
280*8044SWilliam.Kucharski@Sun.COM% Main output routine.
281*8044SWilliam.Kucharski@Sun.COM\chardef\PAGE = 255
282*8044SWilliam.Kucharski@Sun.COM\output = {\onepageout{\pagecontents\PAGE}}
283*8044SWilliam.Kucharski@Sun.COM
284*8044SWilliam.Kucharski@Sun.COM\newbox\headlinebox
285*8044SWilliam.Kucharski@Sun.COM\newbox\footlinebox
286*8044SWilliam.Kucharski@Sun.COM
287*8044SWilliam.Kucharski@Sun.COM% \onepageout takes a vbox as an argument.  Note that \pagecontents
288*8044SWilliam.Kucharski@Sun.COM% does insertions, but you have to call it yourself.
289*8044SWilliam.Kucharski@Sun.COM\def\onepageout#1{%
290*8044SWilliam.Kucharski@Sun.COM  \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
291*8044SWilliam.Kucharski@Sun.COM  %
292*8044SWilliam.Kucharski@Sun.COM  \ifodd\pageno  \advance\hoffset by \bindingoffset
293*8044SWilliam.Kucharski@Sun.COM  \else \advance\hoffset by -\bindingoffset\fi
294*8044SWilliam.Kucharski@Sun.COM  %
295*8044SWilliam.Kucharski@Sun.COM  % Do this outside of the \shipout so @code etc. will be expanded in
296*8044SWilliam.Kucharski@Sun.COM  % the headline as they should be, not taken literally (outputting ''code).
297*8044SWilliam.Kucharski@Sun.COM  \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
298*8044SWilliam.Kucharski@Sun.COM  \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
299*8044SWilliam.Kucharski@Sun.COM  %
300*8044SWilliam.Kucharski@Sun.COM  {%
301*8044SWilliam.Kucharski@Sun.COM    % Have to do this stuff outside the \shipout because we want it to
302*8044SWilliam.Kucharski@Sun.COM    % take effect in \write's, yet the group defined by the \vbox ends
303*8044SWilliam.Kucharski@Sun.COM    % before the \shipout runs.
304*8044SWilliam.Kucharski@Sun.COM    %
305*8044SWilliam.Kucharski@Sun.COM    \escapechar = `\\     % use backslash in output files.
306*8044SWilliam.Kucharski@Sun.COM    \indexdummies         % don't expand commands in the output.
307*8044SWilliam.Kucharski@Sun.COM    \normalturnoffactive  % \ in index entries must not stay \, e.g., if
308*8044SWilliam.Kucharski@Sun.COM                   % the page break happens to be in the middle of an example.
309*8044SWilliam.Kucharski@Sun.COM    \shipout\vbox{%
310*8044SWilliam.Kucharski@Sun.COM      % Do this early so pdf references go to the beginning of the page.
311*8044SWilliam.Kucharski@Sun.COM      \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
312*8044SWilliam.Kucharski@Sun.COM      %
313*8044SWilliam.Kucharski@Sun.COM      \ifcropmarks \vbox to \outervsize\bgroup
314*8044SWilliam.Kucharski@Sun.COM        \hsize = \outerhsize
315*8044SWilliam.Kucharski@Sun.COM        \vskip-\topandbottommargin
316*8044SWilliam.Kucharski@Sun.COM        \vtop to0pt{%
317*8044SWilliam.Kucharski@Sun.COM          \line{\ewtop\hfil\ewtop}%
318*8044SWilliam.Kucharski@Sun.COM          \nointerlineskip
319*8044SWilliam.Kucharski@Sun.COM          \line{%
320*8044SWilliam.Kucharski@Sun.COM            \vbox{\moveleft\cornerthick\nstop}%
321*8044SWilliam.Kucharski@Sun.COM            \hfill
322*8044SWilliam.Kucharski@Sun.COM            \vbox{\moveright\cornerthick\nstop}%
323*8044SWilliam.Kucharski@Sun.COM          }%
324*8044SWilliam.Kucharski@Sun.COM          \vss}%
325*8044SWilliam.Kucharski@Sun.COM        \vskip\topandbottommargin
326*8044SWilliam.Kucharski@Sun.COM        \line\bgroup
327*8044SWilliam.Kucharski@Sun.COM          \hfil % center the page within the outer (page) hsize.
328*8044SWilliam.Kucharski@Sun.COM          \ifodd\pageno\hskip\bindingoffset\fi
329*8044SWilliam.Kucharski@Sun.COM          \vbox\bgroup
330*8044SWilliam.Kucharski@Sun.COM      \fi
331*8044SWilliam.Kucharski@Sun.COM      %
332*8044SWilliam.Kucharski@Sun.COM      \unvbox\headlinebox
333*8044SWilliam.Kucharski@Sun.COM      \pagebody{#1}%
334*8044SWilliam.Kucharski@Sun.COM      \ifdim\ht\footlinebox > 0pt
335*8044SWilliam.Kucharski@Sun.COM        % Only leave this space if the footline is nonempty.
336*8044SWilliam.Kucharski@Sun.COM        % (We lessened \vsize for it in \oddfootingxxx.)
337*8044SWilliam.Kucharski@Sun.COM        % The \baselineskip=24pt in plain's \makefootline has no effect.
338*8044SWilliam.Kucharski@Sun.COM        \vskip 2\baselineskip
339*8044SWilliam.Kucharski@Sun.COM        \unvbox\footlinebox
340*8044SWilliam.Kucharski@Sun.COM      \fi
341*8044SWilliam.Kucharski@Sun.COM      %
342*8044SWilliam.Kucharski@Sun.COM      \ifcropmarks
343*8044SWilliam.Kucharski@Sun.COM          \egroup % end of \vbox\bgroup
344*8044SWilliam.Kucharski@Sun.COM        \hfil\egroup % end of (centering) \line\bgroup
345*8044SWilliam.Kucharski@Sun.COM        \vskip\topandbottommargin plus1fill minus1fill
346*8044SWilliam.Kucharski@Sun.COM        \boxmaxdepth = \cornerthick
347*8044SWilliam.Kucharski@Sun.COM        \vbox to0pt{\vss
348*8044SWilliam.Kucharski@Sun.COM          \line{%
349*8044SWilliam.Kucharski@Sun.COM            \vbox{\moveleft\cornerthick\nsbot}%
350*8044SWilliam.Kucharski@Sun.COM            \hfill
351*8044SWilliam.Kucharski@Sun.COM            \vbox{\moveright\cornerthick\nsbot}%
352*8044SWilliam.Kucharski@Sun.COM          }%
353*8044SWilliam.Kucharski@Sun.COM          \nointerlineskip
354*8044SWilliam.Kucharski@Sun.COM          \line{\ewbot\hfil\ewbot}%
355*8044SWilliam.Kucharski@Sun.COM        }%
356*8044SWilliam.Kucharski@Sun.COM      \egroup % \vbox from first cropmarks clause
357*8044SWilliam.Kucharski@Sun.COM      \fi
358*8044SWilliam.Kucharski@Sun.COM    }% end of \shipout\vbox
359*8044SWilliam.Kucharski@Sun.COM  }% end of group with \normalturnoffactive
360*8044SWilliam.Kucharski@Sun.COM  \advancepageno
361*8044SWilliam.Kucharski@Sun.COM  \ifnum\outputpenalty>-20000 \else\dosupereject\fi
362*8044SWilliam.Kucharski@Sun.COM}
363*8044SWilliam.Kucharski@Sun.COM
364*8044SWilliam.Kucharski@Sun.COM\newinsert\margin \dimen\margin=\maxdimen
365*8044SWilliam.Kucharski@Sun.COM
366*8044SWilliam.Kucharski@Sun.COM\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
367*8044SWilliam.Kucharski@Sun.COM{\catcode`\@ =11
368*8044SWilliam.Kucharski@Sun.COM\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
369*8044SWilliam.Kucharski@Sun.COM% marginal hacks, juha@viisa.uucp (Juha Takala)
370*8044SWilliam.Kucharski@Sun.COM\ifvoid\margin\else % marginal info is present
371*8044SWilliam.Kucharski@Sun.COM  \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
372*8044SWilliam.Kucharski@Sun.COM\dimen@=\dp#1 \unvbox#1
373*8044SWilliam.Kucharski@Sun.COM\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
374*8044SWilliam.Kucharski@Sun.COM\ifr@ggedbottom \kern-\dimen@ \vfil \fi}
375*8044SWilliam.Kucharski@Sun.COM}
376*8044SWilliam.Kucharski@Sun.COM
377*8044SWilliam.Kucharski@Sun.COM% Here are the rules for the cropmarks.  Note that they are
378*8044SWilliam.Kucharski@Sun.COM% offset so that the space between them is truly \outerhsize or \outervsize
379*8044SWilliam.Kucharski@Sun.COM% (P. A. MacKay, 12 November, 1986)
380*8044SWilliam.Kucharski@Sun.COM%
381*8044SWilliam.Kucharski@Sun.COM\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
382*8044SWilliam.Kucharski@Sun.COM\def\nstop{\vbox
383*8044SWilliam.Kucharski@Sun.COM  {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
384*8044SWilliam.Kucharski@Sun.COM\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
385*8044SWilliam.Kucharski@Sun.COM\def\nsbot{\vbox
386*8044SWilliam.Kucharski@Sun.COM  {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
387*8044SWilliam.Kucharski@Sun.COM
388*8044SWilliam.Kucharski@Sun.COM% Parse an argument, then pass it to #1.  The argument is the rest of
389*8044SWilliam.Kucharski@Sun.COM% the input line (except we remove a trailing comment).  #1 should be a
390*8044SWilliam.Kucharski@Sun.COM% macro which expects an ordinary undelimited TeX argument.
391*8044SWilliam.Kucharski@Sun.COM%
392*8044SWilliam.Kucharski@Sun.COM\def\parsearg{\parseargusing{}}
393*8044SWilliam.Kucharski@Sun.COM\def\parseargusing#1#2{%
394*8044SWilliam.Kucharski@Sun.COM  \def\next{#2}%
395*8044SWilliam.Kucharski@Sun.COM  \begingroup
396*8044SWilliam.Kucharski@Sun.COM    \obeylines
397*8044SWilliam.Kucharski@Sun.COM    \spaceisspace
398*8044SWilliam.Kucharski@Sun.COM    #1%
399*8044SWilliam.Kucharski@Sun.COM    \parseargline\empty% Insert the \empty token, see \finishparsearg below.
400*8044SWilliam.Kucharski@Sun.COM}
401*8044SWilliam.Kucharski@Sun.COM
402*8044SWilliam.Kucharski@Sun.COM{\obeylines %
403*8044SWilliam.Kucharski@Sun.COM  \gdef\parseargline#1^^M{%
404*8044SWilliam.Kucharski@Sun.COM    \endgroup % End of the group started in \parsearg.
405*8044SWilliam.Kucharski@Sun.COM    \argremovecomment #1\comment\ArgTerm%
406*8044SWilliam.Kucharski@Sun.COM  }%
407*8044SWilliam.Kucharski@Sun.COM}
408*8044SWilliam.Kucharski@Sun.COM
409*8044SWilliam.Kucharski@Sun.COM% First remove any @comment, then any @c comment.
410*8044SWilliam.Kucharski@Sun.COM\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
411*8044SWilliam.Kucharski@Sun.COM\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
412*8044SWilliam.Kucharski@Sun.COM
413*8044SWilliam.Kucharski@Sun.COM% Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
414*8044SWilliam.Kucharski@Sun.COM%
415*8044SWilliam.Kucharski@Sun.COM% \argremovec might leave us with trailing space, e.g.,
416*8044SWilliam.Kucharski@Sun.COM%    @end itemize  @c foo
417*8044SWilliam.Kucharski@Sun.COM% This space token undergoes the same procedure and is eventually removed
418*8044SWilliam.Kucharski@Sun.COM% by \finishparsearg.
419*8044SWilliam.Kucharski@Sun.COM%
420*8044SWilliam.Kucharski@Sun.COM\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
421*8044SWilliam.Kucharski@Sun.COM\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
422*8044SWilliam.Kucharski@Sun.COM\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
423*8044SWilliam.Kucharski@Sun.COM  \def\temp{#3}%
424*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\empty
425*8044SWilliam.Kucharski@Sun.COM    % We cannot use \next here, as it holds the macro to run;
426*8044SWilliam.Kucharski@Sun.COM    % thus we reuse \temp.
427*8044SWilliam.Kucharski@Sun.COM    \let\temp\finishparsearg
428*8044SWilliam.Kucharski@Sun.COM  \else
429*8044SWilliam.Kucharski@Sun.COM    \let\temp\argcheckspaces
430*8044SWilliam.Kucharski@Sun.COM  \fi
431*8044SWilliam.Kucharski@Sun.COM  % Put the space token in:
432*8044SWilliam.Kucharski@Sun.COM  \temp#1 #3\ArgTerm
433*8044SWilliam.Kucharski@Sun.COM}
434*8044SWilliam.Kucharski@Sun.COM
435*8044SWilliam.Kucharski@Sun.COM% If a _delimited_ argument is enclosed in braces, they get stripped; so
436*8044SWilliam.Kucharski@Sun.COM% to get _exactly_ the rest of the line, we had to prevent such situation.
437*8044SWilliam.Kucharski@Sun.COM% We prepended an \empty token at the very beginning and we expand it now,
438*8044SWilliam.Kucharski@Sun.COM% just before passing the control to \next.
439*8044SWilliam.Kucharski@Sun.COM% (Similarily, we have to think about #3 of \argcheckspacesY above: it is
440*8044SWilliam.Kucharski@Sun.COM% either the null string, or it ends with \^^M---thus there is no danger
441*8044SWilliam.Kucharski@Sun.COM% that a pair of braces would be stripped.
442*8044SWilliam.Kucharski@Sun.COM%
443*8044SWilliam.Kucharski@Sun.COM% But first, we have to remove the trailing space token.
444*8044SWilliam.Kucharski@Sun.COM%
445*8044SWilliam.Kucharski@Sun.COM\def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
446*8044SWilliam.Kucharski@Sun.COM
447*8044SWilliam.Kucharski@Sun.COM% \parseargdef\foo{...}
448*8044SWilliam.Kucharski@Sun.COM%	is roughly equivalent to
449*8044SWilliam.Kucharski@Sun.COM% \def\foo{\parsearg\Xfoo}
450*8044SWilliam.Kucharski@Sun.COM% \def\Xfoo#1{...}
451*8044SWilliam.Kucharski@Sun.COM%
452*8044SWilliam.Kucharski@Sun.COM% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
453*8044SWilliam.Kucharski@Sun.COM% favourite TeX trick.  --kasal, 16nov03
454*8044SWilliam.Kucharski@Sun.COM
455*8044SWilliam.Kucharski@Sun.COM\def\parseargdef#1{%
456*8044SWilliam.Kucharski@Sun.COM  \expandafter \doparseargdef \csname\string#1\endcsname #1%
457*8044SWilliam.Kucharski@Sun.COM}
458*8044SWilliam.Kucharski@Sun.COM\def\doparseargdef#1#2{%
459*8044SWilliam.Kucharski@Sun.COM  \def#2{\parsearg#1}%
460*8044SWilliam.Kucharski@Sun.COM  \def#1##1%
461*8044SWilliam.Kucharski@Sun.COM}
462*8044SWilliam.Kucharski@Sun.COM
463*8044SWilliam.Kucharski@Sun.COM% Several utility definitions with active space:
464*8044SWilliam.Kucharski@Sun.COM{
465*8044SWilliam.Kucharski@Sun.COM  \obeyspaces
466*8044SWilliam.Kucharski@Sun.COM  \gdef\obeyedspace{ }
467*8044SWilliam.Kucharski@Sun.COM
468*8044SWilliam.Kucharski@Sun.COM  % Make each space character in the input produce a normal interword
469*8044SWilliam.Kucharski@Sun.COM  % space in the output.  Don't allow a line break at this space, as this
470*8044SWilliam.Kucharski@Sun.COM  % is used only in environments like @example, where each line of input
471*8044SWilliam.Kucharski@Sun.COM  % should produce a line of output anyway.
472*8044SWilliam.Kucharski@Sun.COM  %
473*8044SWilliam.Kucharski@Sun.COM  \gdef\sepspaces{\obeyspaces\let =\tie}
474*8044SWilliam.Kucharski@Sun.COM
475*8044SWilliam.Kucharski@Sun.COM  % If an index command is used in an @example environment, any spaces
476*8044SWilliam.Kucharski@Sun.COM  % therein should become regular spaces in the raw index file, not the
477*8044SWilliam.Kucharski@Sun.COM  % expansion of \tie (\leavevmode \penalty \@M \ ).
478*8044SWilliam.Kucharski@Sun.COM  \gdef\unsepspaces{\let =\space}
479*8044SWilliam.Kucharski@Sun.COM}
480*8044SWilliam.Kucharski@Sun.COM
481*8044SWilliam.Kucharski@Sun.COM
482*8044SWilliam.Kucharski@Sun.COM\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
483*8044SWilliam.Kucharski@Sun.COM
484*8044SWilliam.Kucharski@Sun.COM% Define the framework for environments in texinfo.tex.  It's used like this:
485*8044SWilliam.Kucharski@Sun.COM%
486*8044SWilliam.Kucharski@Sun.COM%   \envdef\foo{...}
487*8044SWilliam.Kucharski@Sun.COM%   \def\Efoo{...}
488*8044SWilliam.Kucharski@Sun.COM%
489*8044SWilliam.Kucharski@Sun.COM% It's the responsibility of \envdef to insert \begingroup before the
490*8044SWilliam.Kucharski@Sun.COM% actual body; @end closes the group after calling \Efoo.  \envdef also
491*8044SWilliam.Kucharski@Sun.COM% defines \thisenv, so the current environment is known; @end checks
492*8044SWilliam.Kucharski@Sun.COM% whether the environment name matches.  The \checkenv macro can also be
493*8044SWilliam.Kucharski@Sun.COM% used to check whether the current environment is the one expected.
494*8044SWilliam.Kucharski@Sun.COM%
495*8044SWilliam.Kucharski@Sun.COM% Non-false conditionals (@iftex, @ifset) don't fit into this, so they
496*8044SWilliam.Kucharski@Sun.COM% are not treated as enviroments; they don't open a group.  (The
497*8044SWilliam.Kucharski@Sun.COM% implementation of @end takes care not to call \endgroup in this
498*8044SWilliam.Kucharski@Sun.COM% special case.)
499*8044SWilliam.Kucharski@Sun.COM
500*8044SWilliam.Kucharski@Sun.COM
501*8044SWilliam.Kucharski@Sun.COM% At runtime, environments start with this:
502*8044SWilliam.Kucharski@Sun.COM\def\startenvironment#1{\begingroup\def\thisenv{#1}}
503*8044SWilliam.Kucharski@Sun.COM% initialize
504*8044SWilliam.Kucharski@Sun.COM\let\thisenv\empty
505*8044SWilliam.Kucharski@Sun.COM
506*8044SWilliam.Kucharski@Sun.COM% ... but they get defined via ``\envdef\foo{...}'':
507*8044SWilliam.Kucharski@Sun.COM\long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
508*8044SWilliam.Kucharski@Sun.COM\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
509*8044SWilliam.Kucharski@Sun.COM
510*8044SWilliam.Kucharski@Sun.COM% Check whether we're in the right environment:
511*8044SWilliam.Kucharski@Sun.COM\def\checkenv#1{%
512*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
513*8044SWilliam.Kucharski@Sun.COM  \ifx\thisenv\temp
514*8044SWilliam.Kucharski@Sun.COM  \else
515*8044SWilliam.Kucharski@Sun.COM    \badenverr
516*8044SWilliam.Kucharski@Sun.COM  \fi
517*8044SWilliam.Kucharski@Sun.COM}
518*8044SWilliam.Kucharski@Sun.COM
519*8044SWilliam.Kucharski@Sun.COM% Evironment mismatch, #1 expected:
520*8044SWilliam.Kucharski@Sun.COM\def\badenverr{%
521*8044SWilliam.Kucharski@Sun.COM  \errhelp = \EMsimple
522*8044SWilliam.Kucharski@Sun.COM  \errmessage{This command can appear only \inenvironment\temp,
523*8044SWilliam.Kucharski@Sun.COM    not \inenvironment\thisenv}%
524*8044SWilliam.Kucharski@Sun.COM}
525*8044SWilliam.Kucharski@Sun.COM\def\inenvironment#1{%
526*8044SWilliam.Kucharski@Sun.COM  \ifx#1\empty
527*8044SWilliam.Kucharski@Sun.COM    out of any environment%
528*8044SWilliam.Kucharski@Sun.COM  \else
529*8044SWilliam.Kucharski@Sun.COM    in environment \expandafter\string#1%
530*8044SWilliam.Kucharski@Sun.COM  \fi
531*8044SWilliam.Kucharski@Sun.COM}
532*8044SWilliam.Kucharski@Sun.COM
533*8044SWilliam.Kucharski@Sun.COM% @end foo executes the definition of \Efoo.
534*8044SWilliam.Kucharski@Sun.COM% But first, it executes a specialized version of \checkenv
535*8044SWilliam.Kucharski@Sun.COM%
536*8044SWilliam.Kucharski@Sun.COM\parseargdef\end{%
537*8044SWilliam.Kucharski@Sun.COM  \if 1\csname iscond.#1\endcsname
538*8044SWilliam.Kucharski@Sun.COM  \else
539*8044SWilliam.Kucharski@Sun.COM    % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
540*8044SWilliam.Kucharski@Sun.COM    \expandafter\checkenv\csname#1\endcsname
541*8044SWilliam.Kucharski@Sun.COM    \csname E#1\endcsname
542*8044SWilliam.Kucharski@Sun.COM    \endgroup
543*8044SWilliam.Kucharski@Sun.COM  \fi
544*8044SWilliam.Kucharski@Sun.COM}
545*8044SWilliam.Kucharski@Sun.COM
546*8044SWilliam.Kucharski@Sun.COM\newhelp\EMsimple{Press RETURN to continue.}
547*8044SWilliam.Kucharski@Sun.COM
548*8044SWilliam.Kucharski@Sun.COM
549*8044SWilliam.Kucharski@Sun.COM%% Simple single-character @ commands
550*8044SWilliam.Kucharski@Sun.COM
551*8044SWilliam.Kucharski@Sun.COM% @@ prints an @
552*8044SWilliam.Kucharski@Sun.COM% Kludge this until the fonts are right (grr).
553*8044SWilliam.Kucharski@Sun.COM\def\@{{\tt\char64}}
554*8044SWilliam.Kucharski@Sun.COM
555*8044SWilliam.Kucharski@Sun.COM% This is turned off because it was never documented
556*8044SWilliam.Kucharski@Sun.COM% and you can use @w{...} around a quote to suppress ligatures.
557*8044SWilliam.Kucharski@Sun.COM%% Define @` and @' to be the same as ` and '
558*8044SWilliam.Kucharski@Sun.COM%% but suppressing ligatures.
559*8044SWilliam.Kucharski@Sun.COM%\def\`{{`}}
560*8044SWilliam.Kucharski@Sun.COM%\def\'{{'}}
561*8044SWilliam.Kucharski@Sun.COM
562*8044SWilliam.Kucharski@Sun.COM% Used to generate quoted braces.
563*8044SWilliam.Kucharski@Sun.COM\def\mylbrace {{\tt\char123}}
564*8044SWilliam.Kucharski@Sun.COM\def\myrbrace {{\tt\char125}}
565*8044SWilliam.Kucharski@Sun.COM\let\{=\mylbrace
566*8044SWilliam.Kucharski@Sun.COM\let\}=\myrbrace
567*8044SWilliam.Kucharski@Sun.COM\begingroup
568*8044SWilliam.Kucharski@Sun.COM  % Definitions to produce \{ and \} commands for indices,
569*8044SWilliam.Kucharski@Sun.COM  % and @{ and @} for the aux file.
570*8044SWilliam.Kucharski@Sun.COM  \catcode`\{ = \other \catcode`\} = \other
571*8044SWilliam.Kucharski@Sun.COM  \catcode`\[ = 1 \catcode`\] = 2
572*8044SWilliam.Kucharski@Sun.COM  \catcode`\! = 0 \catcode`\\ = \other
573*8044SWilliam.Kucharski@Sun.COM  !gdef!lbracecmd[\{]%
574*8044SWilliam.Kucharski@Sun.COM  !gdef!rbracecmd[\}]%
575*8044SWilliam.Kucharski@Sun.COM  !gdef!lbraceatcmd[@{]%
576*8044SWilliam.Kucharski@Sun.COM  !gdef!rbraceatcmd[@}]%
577*8044SWilliam.Kucharski@Sun.COM!endgroup
578*8044SWilliam.Kucharski@Sun.COM
579*8044SWilliam.Kucharski@Sun.COM% @comma{} to avoid , parsing problems.
580*8044SWilliam.Kucharski@Sun.COM\let\comma = ,
581*8044SWilliam.Kucharski@Sun.COM
582*8044SWilliam.Kucharski@Sun.COM% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
583*8044SWilliam.Kucharski@Sun.COM% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
584*8044SWilliam.Kucharski@Sun.COM\let\, = \c
585*8044SWilliam.Kucharski@Sun.COM\let\dotaccent = \.
586*8044SWilliam.Kucharski@Sun.COM\def\ringaccent#1{{\accent23 #1}}
587*8044SWilliam.Kucharski@Sun.COM\let\tieaccent = \t
588*8044SWilliam.Kucharski@Sun.COM\let\ubaraccent = \b
589*8044SWilliam.Kucharski@Sun.COM\let\udotaccent = \d
590*8044SWilliam.Kucharski@Sun.COM
591*8044SWilliam.Kucharski@Sun.COM% Other special characters: @questiondown @exclamdown @ordf @ordm
592*8044SWilliam.Kucharski@Sun.COM% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
593*8044SWilliam.Kucharski@Sun.COM\def\questiondown{?`}
594*8044SWilliam.Kucharski@Sun.COM\def\exclamdown{!`}
595*8044SWilliam.Kucharski@Sun.COM\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
596*8044SWilliam.Kucharski@Sun.COM\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
597*8044SWilliam.Kucharski@Sun.COM
598*8044SWilliam.Kucharski@Sun.COM% Dotless i and dotless j, used for accents.
599*8044SWilliam.Kucharski@Sun.COM\def\imacro{i}
600*8044SWilliam.Kucharski@Sun.COM\def\jmacro{j}
601*8044SWilliam.Kucharski@Sun.COM\def\dotless#1{%
602*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
603*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\imacro \ptexi
604*8044SWilliam.Kucharski@Sun.COM  \else\ifx\temp\jmacro \j
605*8044SWilliam.Kucharski@Sun.COM  \else \errmessage{@dotless can be used only with i or j}%
606*8044SWilliam.Kucharski@Sun.COM  \fi\fi
607*8044SWilliam.Kucharski@Sun.COM}
608*8044SWilliam.Kucharski@Sun.COM
609*8044SWilliam.Kucharski@Sun.COM% The \TeX{} logo, as in plain, but resetting the spacing so that a
610*8044SWilliam.Kucharski@Sun.COM% period following counts as ending a sentence.  (Idea found in latex.)
611*8044SWilliam.Kucharski@Sun.COM%
612*8044SWilliam.Kucharski@Sun.COM\edef\TeX{\TeX \spacefactor=1000 }
613*8044SWilliam.Kucharski@Sun.COM
614*8044SWilliam.Kucharski@Sun.COM% @LaTeX{} logo.  Not quite the same results as the definition in
615*8044SWilliam.Kucharski@Sun.COM% latex.ltx, since we use a different font for the raised A; it's most
616*8044SWilliam.Kucharski@Sun.COM% convenient for us to use an explicitly smaller font, rather than using
617*8044SWilliam.Kucharski@Sun.COM% the \scriptstyle font (since we don't reset \scriptstyle and
618*8044SWilliam.Kucharski@Sun.COM% \scriptscriptstyle).
619*8044SWilliam.Kucharski@Sun.COM%
620*8044SWilliam.Kucharski@Sun.COM\def\LaTeX{%
621*8044SWilliam.Kucharski@Sun.COM  L\kern-.36em
622*8044SWilliam.Kucharski@Sun.COM  {\setbox0=\hbox{T}%
623*8044SWilliam.Kucharski@Sun.COM   \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
624*8044SWilliam.Kucharski@Sun.COM  \kern-.15em
625*8044SWilliam.Kucharski@Sun.COM  \TeX
626*8044SWilliam.Kucharski@Sun.COM}
627*8044SWilliam.Kucharski@Sun.COM
628*8044SWilliam.Kucharski@Sun.COM% Be sure we're in horizontal mode when doing a tie, since we make space
629*8044SWilliam.Kucharski@Sun.COM% equivalent to this in @example-like environments. Otherwise, a space
630*8044SWilliam.Kucharski@Sun.COM% at the beginning of a line will start with \penalty -- and
631*8044SWilliam.Kucharski@Sun.COM% since \penalty is valid in vertical mode, we'd end up putting the
632*8044SWilliam.Kucharski@Sun.COM% penalty on the vertical list instead of in the new paragraph.
633*8044SWilliam.Kucharski@Sun.COM{\catcode`@ = 11
634*8044SWilliam.Kucharski@Sun.COM % Avoid using \@M directly, because that causes trouble
635*8044SWilliam.Kucharski@Sun.COM % if the definition is written into an index file.
636*8044SWilliam.Kucharski@Sun.COM \global\let\tiepenalty = \@M
637*8044SWilliam.Kucharski@Sun.COM \gdef\tie{\leavevmode\penalty\tiepenalty\ }
638*8044SWilliam.Kucharski@Sun.COM}
639*8044SWilliam.Kucharski@Sun.COM
640*8044SWilliam.Kucharski@Sun.COM% @: forces normal size whitespace following.
641*8044SWilliam.Kucharski@Sun.COM\def\:{\spacefactor=1000 }
642*8044SWilliam.Kucharski@Sun.COM
643*8044SWilliam.Kucharski@Sun.COM% @* forces a line break.
644*8044SWilliam.Kucharski@Sun.COM\def\*{\hfil\break\hbox{}\ignorespaces}
645*8044SWilliam.Kucharski@Sun.COM
646*8044SWilliam.Kucharski@Sun.COM% @/ allows a line break.
647*8044SWilliam.Kucharski@Sun.COM\let\/=\allowbreak
648*8044SWilliam.Kucharski@Sun.COM
649*8044SWilliam.Kucharski@Sun.COM% @. is an end-of-sentence period.
650*8044SWilliam.Kucharski@Sun.COM\def\.{.\spacefactor=3000 }
651*8044SWilliam.Kucharski@Sun.COM
652*8044SWilliam.Kucharski@Sun.COM% @! is an end-of-sentence bang.
653*8044SWilliam.Kucharski@Sun.COM\def\!{!\spacefactor=3000 }
654*8044SWilliam.Kucharski@Sun.COM
655*8044SWilliam.Kucharski@Sun.COM% @? is an end-of-sentence query.
656*8044SWilliam.Kucharski@Sun.COM\def\?{?\spacefactor=3000 }
657*8044SWilliam.Kucharski@Sun.COM
658*8044SWilliam.Kucharski@Sun.COM% @w prevents a word break.  Without the \leavevmode, @w at the
659*8044SWilliam.Kucharski@Sun.COM% beginning of a paragraph, when TeX is still in vertical mode, would
660*8044SWilliam.Kucharski@Sun.COM% produce a whole line of output instead of starting the paragraph.
661*8044SWilliam.Kucharski@Sun.COM\def\w#1{\leavevmode\hbox{#1}}
662*8044SWilliam.Kucharski@Sun.COM
663*8044SWilliam.Kucharski@Sun.COM% @group ... @end group forces ... to be all on one page, by enclosing
664*8044SWilliam.Kucharski@Sun.COM% it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
665*8044SWilliam.Kucharski@Sun.COM% to keep its height that of a normal line.  According to the rules for
666*8044SWilliam.Kucharski@Sun.COM% \topskip (p.114 of the TeXbook), the glue inserted is
667*8044SWilliam.Kucharski@Sun.COM% max (\topskip - \ht (first item), 0).  If that height is large,
668*8044SWilliam.Kucharski@Sun.COM% therefore, no glue is inserted, and the space between the headline and
669*8044SWilliam.Kucharski@Sun.COM% the text is small, which looks bad.
670*8044SWilliam.Kucharski@Sun.COM%
671*8044SWilliam.Kucharski@Sun.COM% Another complication is that the group might be very large.  This can
672*8044SWilliam.Kucharski@Sun.COM% cause the glue on the previous page to be unduly stretched, because it
673*8044SWilliam.Kucharski@Sun.COM% does not have much material.  In this case, it's better to add an
674*8044SWilliam.Kucharski@Sun.COM% explicit \vfill so that the extra space is at the bottom.  The
675*8044SWilliam.Kucharski@Sun.COM% threshold for doing this is if the group is more than \vfilllimit
676*8044SWilliam.Kucharski@Sun.COM% percent of a page (\vfilllimit can be changed inside of @tex).
677*8044SWilliam.Kucharski@Sun.COM%
678*8044SWilliam.Kucharski@Sun.COM\newbox\groupbox
679*8044SWilliam.Kucharski@Sun.COM\def\vfilllimit{0.7}
680*8044SWilliam.Kucharski@Sun.COM%
681*8044SWilliam.Kucharski@Sun.COM\envdef\group{%
682*8044SWilliam.Kucharski@Sun.COM  \ifnum\catcode`\^^M=\active \else
683*8044SWilliam.Kucharski@Sun.COM    \errhelp = \groupinvalidhelp
684*8044SWilliam.Kucharski@Sun.COM    \errmessage{@group invalid in context where filling is enabled}%
685*8044SWilliam.Kucharski@Sun.COM  \fi
686*8044SWilliam.Kucharski@Sun.COM  \startsavinginserts
687*8044SWilliam.Kucharski@Sun.COM  %
688*8044SWilliam.Kucharski@Sun.COM  \setbox\groupbox = \vtop\bgroup
689*8044SWilliam.Kucharski@Sun.COM    % Do @comment since we are called inside an environment such as
690*8044SWilliam.Kucharski@Sun.COM    % @example, where each end-of-line in the input causes an
691*8044SWilliam.Kucharski@Sun.COM    % end-of-line in the output.  We don't want the end-of-line after
692*8044SWilliam.Kucharski@Sun.COM    % the `@group' to put extra space in the output.  Since @group
693*8044SWilliam.Kucharski@Sun.COM    % should appear on a line by itself (according to the Texinfo
694*8044SWilliam.Kucharski@Sun.COM    % manual), we don't worry about eating any user text.
695*8044SWilliam.Kucharski@Sun.COM    \comment
696*8044SWilliam.Kucharski@Sun.COM}
697*8044SWilliam.Kucharski@Sun.COM%
698*8044SWilliam.Kucharski@Sun.COM% The \vtop produces a box with normal height and large depth; thus, TeX puts
699*8044SWilliam.Kucharski@Sun.COM% \baselineskip glue before it, and (when the next line of text is done)
700*8044SWilliam.Kucharski@Sun.COM% \lineskip glue after it.  Thus, space below is not quite equal to space
701*8044SWilliam.Kucharski@Sun.COM% above.  But it's pretty close.
702*8044SWilliam.Kucharski@Sun.COM\def\Egroup{%
703*8044SWilliam.Kucharski@Sun.COM    % To get correct interline space between the last line of the group
704*8044SWilliam.Kucharski@Sun.COM    % and the first line afterwards, we have to propagate \prevdepth.
705*8044SWilliam.Kucharski@Sun.COM    \endgraf % Not \par, as it may have been set to \lisppar.
706*8044SWilliam.Kucharski@Sun.COM    \global\dimen1 = \prevdepth
707*8044SWilliam.Kucharski@Sun.COM  \egroup           % End the \vtop.
708*8044SWilliam.Kucharski@Sun.COM  % \dimen0 is the vertical size of the group's box.
709*8044SWilliam.Kucharski@Sun.COM  \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
710*8044SWilliam.Kucharski@Sun.COM  % \dimen2 is how much space is left on the page (more or less).
711*8044SWilliam.Kucharski@Sun.COM  \dimen2 = \pageheight   \advance\dimen2 by -\pagetotal
712*8044SWilliam.Kucharski@Sun.COM  % if the group doesn't fit on the current page, and it's a big big
713*8044SWilliam.Kucharski@Sun.COM  % group, force a page break.
714*8044SWilliam.Kucharski@Sun.COM  \ifdim \dimen0 > \dimen2
715*8044SWilliam.Kucharski@Sun.COM    \ifdim \pagetotal < \vfilllimit\pageheight
716*8044SWilliam.Kucharski@Sun.COM      \page
717*8044SWilliam.Kucharski@Sun.COM    \fi
718*8044SWilliam.Kucharski@Sun.COM  \fi
719*8044SWilliam.Kucharski@Sun.COM  \box\groupbox
720*8044SWilliam.Kucharski@Sun.COM  \prevdepth = \dimen1
721*8044SWilliam.Kucharski@Sun.COM  \checkinserts
722*8044SWilliam.Kucharski@Sun.COM}
723*8044SWilliam.Kucharski@Sun.COM%
724*8044SWilliam.Kucharski@Sun.COM% TeX puts in an \escapechar (i.e., `@') at the beginning of the help
725*8044SWilliam.Kucharski@Sun.COM% message, so this ends up printing `@group can only ...'.
726*8044SWilliam.Kucharski@Sun.COM%
727*8044SWilliam.Kucharski@Sun.COM\newhelp\groupinvalidhelp{%
728*8044SWilliam.Kucharski@Sun.COMgroup can only be used in environments such as @example,^^J%
729*8044SWilliam.Kucharski@Sun.COMwhere each line of input produces a line of output.}
730*8044SWilliam.Kucharski@Sun.COM
731*8044SWilliam.Kucharski@Sun.COM% @need space-in-mils
732*8044SWilliam.Kucharski@Sun.COM% forces a page break if there is not space-in-mils remaining.
733*8044SWilliam.Kucharski@Sun.COM
734*8044SWilliam.Kucharski@Sun.COM\newdimen\mil  \mil=0.001in
735*8044SWilliam.Kucharski@Sun.COM
736*8044SWilliam.Kucharski@Sun.COM% Old definition--didn't work.
737*8044SWilliam.Kucharski@Sun.COM%\parseargdef\need{\par %
738*8044SWilliam.Kucharski@Sun.COM%% This method tries to make TeX break the page naturally
739*8044SWilliam.Kucharski@Sun.COM%% if the depth of the box does not fit.
740*8044SWilliam.Kucharski@Sun.COM%{\baselineskip=0pt%
741*8044SWilliam.Kucharski@Sun.COM%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
742*8044SWilliam.Kucharski@Sun.COM%\prevdepth=-1000pt
743*8044SWilliam.Kucharski@Sun.COM%}}
744*8044SWilliam.Kucharski@Sun.COM
745*8044SWilliam.Kucharski@Sun.COM\parseargdef\need{%
746*8044SWilliam.Kucharski@Sun.COM  % Ensure vertical mode, so we don't make a big box in the middle of a
747*8044SWilliam.Kucharski@Sun.COM  % paragraph.
748*8044SWilliam.Kucharski@Sun.COM  \par
749*8044SWilliam.Kucharski@Sun.COM  %
750*8044SWilliam.Kucharski@Sun.COM  % If the @need value is less than one line space, it's useless.
751*8044SWilliam.Kucharski@Sun.COM  \dimen0 = #1\mil
752*8044SWilliam.Kucharski@Sun.COM  \dimen2 = \ht\strutbox
753*8044SWilliam.Kucharski@Sun.COM  \advance\dimen2 by \dp\strutbox
754*8044SWilliam.Kucharski@Sun.COM  \ifdim\dimen0 > \dimen2
755*8044SWilliam.Kucharski@Sun.COM    %
756*8044SWilliam.Kucharski@Sun.COM    % Do a \strut just to make the height of this box be normal, so the
757*8044SWilliam.Kucharski@Sun.COM    % normal leading is inserted relative to the preceding line.
758*8044SWilliam.Kucharski@Sun.COM    % And a page break here is fine.
759*8044SWilliam.Kucharski@Sun.COM    \vtop to #1\mil{\strut\vfil}%
760*8044SWilliam.Kucharski@Sun.COM    %
761*8044SWilliam.Kucharski@Sun.COM    % TeX does not even consider page breaks if a penalty added to the
762*8044SWilliam.Kucharski@Sun.COM    % main vertical list is 10000 or more.  But in order to see if the
763*8044SWilliam.Kucharski@Sun.COM    % empty box we just added fits on the page, we must make it consider
764*8044SWilliam.Kucharski@Sun.COM    % page breaks.  On the other hand, we don't want to actually break the
765*8044SWilliam.Kucharski@Sun.COM    % page after the empty box.  So we use a penalty of 9999.
766*8044SWilliam.Kucharski@Sun.COM    %
767*8044SWilliam.Kucharski@Sun.COM    % There is an extremely small chance that TeX will actually break the
768*8044SWilliam.Kucharski@Sun.COM    % page at this \penalty, if there are no other feasible breakpoints in
769*8044SWilliam.Kucharski@Sun.COM    % sight.  (If the user is using lots of big @group commands, which
770*8044SWilliam.Kucharski@Sun.COM    % almost-but-not-quite fill up a page, TeX will have a hard time doing
771*8044SWilliam.Kucharski@Sun.COM    % good page breaking, for example.)  However, I could not construct an
772*8044SWilliam.Kucharski@Sun.COM    % example where a page broke at this \penalty; if it happens in a real
773*8044SWilliam.Kucharski@Sun.COM    % document, then we can reconsider our strategy.
774*8044SWilliam.Kucharski@Sun.COM    \penalty9999
775*8044SWilliam.Kucharski@Sun.COM    %
776*8044SWilliam.Kucharski@Sun.COM    % Back up by the size of the box, whether we did a page break or not.
777*8044SWilliam.Kucharski@Sun.COM    \kern -#1\mil
778*8044SWilliam.Kucharski@Sun.COM    %
779*8044SWilliam.Kucharski@Sun.COM    % Do not allow a page break right after this kern.
780*8044SWilliam.Kucharski@Sun.COM    \nobreak
781*8044SWilliam.Kucharski@Sun.COM  \fi
782*8044SWilliam.Kucharski@Sun.COM}
783*8044SWilliam.Kucharski@Sun.COM
784*8044SWilliam.Kucharski@Sun.COM% @br   forces paragraph break (and is undocumented).
785*8044SWilliam.Kucharski@Sun.COM
786*8044SWilliam.Kucharski@Sun.COM\let\br = \par
787*8044SWilliam.Kucharski@Sun.COM
788*8044SWilliam.Kucharski@Sun.COM% @page forces the start of a new page.
789*8044SWilliam.Kucharski@Sun.COM%
790*8044SWilliam.Kucharski@Sun.COM\def\page{\par\vfill\supereject}
791*8044SWilliam.Kucharski@Sun.COM
792*8044SWilliam.Kucharski@Sun.COM% @exdent text....
793*8044SWilliam.Kucharski@Sun.COM% outputs text on separate line in roman font, starting at standard page margin
794*8044SWilliam.Kucharski@Sun.COM
795*8044SWilliam.Kucharski@Sun.COM% This records the amount of indent in the innermost environment.
796*8044SWilliam.Kucharski@Sun.COM% That's how much \exdent should take out.
797*8044SWilliam.Kucharski@Sun.COM\newskip\exdentamount
798*8044SWilliam.Kucharski@Sun.COM
799*8044SWilliam.Kucharski@Sun.COM% This defn is used inside fill environments such as @defun.
800*8044SWilliam.Kucharski@Sun.COM\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
801*8044SWilliam.Kucharski@Sun.COM
802*8044SWilliam.Kucharski@Sun.COM% This defn is used inside nofill environments such as @example.
803*8044SWilliam.Kucharski@Sun.COM\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
804*8044SWilliam.Kucharski@Sun.COM  \leftline{\hskip\leftskip{\rm#1}}}}
805*8044SWilliam.Kucharski@Sun.COM
806*8044SWilliam.Kucharski@Sun.COM% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
807*8044SWilliam.Kucharski@Sun.COM% paragraph.  For more general purposes, use the \margin insertion
808*8044SWilliam.Kucharski@Sun.COM% class.  WHICH is `l' or `r'.
809*8044SWilliam.Kucharski@Sun.COM%
810*8044SWilliam.Kucharski@Sun.COM\newskip\inmarginspacing \inmarginspacing=1cm
811*8044SWilliam.Kucharski@Sun.COM\def\strutdepth{\dp\strutbox}
812*8044SWilliam.Kucharski@Sun.COM%
813*8044SWilliam.Kucharski@Sun.COM\def\doinmargin#1#2{\strut\vadjust{%
814*8044SWilliam.Kucharski@Sun.COM  \nobreak
815*8044SWilliam.Kucharski@Sun.COM  \kern-\strutdepth
816*8044SWilliam.Kucharski@Sun.COM  \vtop to \strutdepth{%
817*8044SWilliam.Kucharski@Sun.COM    \baselineskip=\strutdepth
818*8044SWilliam.Kucharski@Sun.COM    \vss
819*8044SWilliam.Kucharski@Sun.COM    % if you have multiple lines of stuff to put here, you'll need to
820*8044SWilliam.Kucharski@Sun.COM    % make the vbox yourself of the appropriate size.
821*8044SWilliam.Kucharski@Sun.COM    \ifx#1l%
822*8044SWilliam.Kucharski@Sun.COM      \llap{\ignorespaces #2\hskip\inmarginspacing}%
823*8044SWilliam.Kucharski@Sun.COM    \else
824*8044SWilliam.Kucharski@Sun.COM      \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
825*8044SWilliam.Kucharski@Sun.COM    \fi
826*8044SWilliam.Kucharski@Sun.COM    \null
827*8044SWilliam.Kucharski@Sun.COM  }%
828*8044SWilliam.Kucharski@Sun.COM}}
829*8044SWilliam.Kucharski@Sun.COM\def\inleftmargin{\doinmargin l}
830*8044SWilliam.Kucharski@Sun.COM\def\inrightmargin{\doinmargin r}
831*8044SWilliam.Kucharski@Sun.COM%
832*8044SWilliam.Kucharski@Sun.COM% @inmargin{TEXT [, RIGHT-TEXT]}
833*8044SWilliam.Kucharski@Sun.COM% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
834*8044SWilliam.Kucharski@Sun.COM% else use TEXT for both).
835*8044SWilliam.Kucharski@Sun.COM%
836*8044SWilliam.Kucharski@Sun.COM\def\inmargin#1{\parseinmargin #1,,\finish}
837*8044SWilliam.Kucharski@Sun.COM\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
838*8044SWilliam.Kucharski@Sun.COM  \setbox0 = \hbox{\ignorespaces #2}%
839*8044SWilliam.Kucharski@Sun.COM  \ifdim\wd0 > 0pt
840*8044SWilliam.Kucharski@Sun.COM    \def\lefttext{#1}%  have both texts
841*8044SWilliam.Kucharski@Sun.COM    \def\righttext{#2}%
842*8044SWilliam.Kucharski@Sun.COM  \else
843*8044SWilliam.Kucharski@Sun.COM    \def\lefttext{#1}%  have only one text
844*8044SWilliam.Kucharski@Sun.COM    \def\righttext{#1}%
845*8044SWilliam.Kucharski@Sun.COM  \fi
846*8044SWilliam.Kucharski@Sun.COM  %
847*8044SWilliam.Kucharski@Sun.COM  \ifodd\pageno
848*8044SWilliam.Kucharski@Sun.COM    \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
849*8044SWilliam.Kucharski@Sun.COM  \else
850*8044SWilliam.Kucharski@Sun.COM    \def\temp{\inleftmargin\lefttext}%
851*8044SWilliam.Kucharski@Sun.COM  \fi
852*8044SWilliam.Kucharski@Sun.COM  \temp
853*8044SWilliam.Kucharski@Sun.COM}
854*8044SWilliam.Kucharski@Sun.COM
855*8044SWilliam.Kucharski@Sun.COM% @include file    insert text of that file as input.
856*8044SWilliam.Kucharski@Sun.COM%
857*8044SWilliam.Kucharski@Sun.COM\def\include{\parseargusing\filenamecatcodes\includezzz}
858*8044SWilliam.Kucharski@Sun.COM\def\includezzz#1{%
859*8044SWilliam.Kucharski@Sun.COM  \pushthisfilestack
860*8044SWilliam.Kucharski@Sun.COM  \def\thisfile{#1}%
861*8044SWilliam.Kucharski@Sun.COM  {%
862*8044SWilliam.Kucharski@Sun.COM    \makevalueexpandable
863*8044SWilliam.Kucharski@Sun.COM    \def\temp{\input #1 }%
864*8044SWilliam.Kucharski@Sun.COM    \expandafter
865*8044SWilliam.Kucharski@Sun.COM  }\temp
866*8044SWilliam.Kucharski@Sun.COM  \popthisfilestack
867*8044SWilliam.Kucharski@Sun.COM}
868*8044SWilliam.Kucharski@Sun.COM\def\filenamecatcodes{%
869*8044SWilliam.Kucharski@Sun.COM  \catcode`\\=\other
870*8044SWilliam.Kucharski@Sun.COM  \catcode`~=\other
871*8044SWilliam.Kucharski@Sun.COM  \catcode`^=\other
872*8044SWilliam.Kucharski@Sun.COM  \catcode`_=\other
873*8044SWilliam.Kucharski@Sun.COM  \catcode`|=\other
874*8044SWilliam.Kucharski@Sun.COM  \catcode`<=\other
875*8044SWilliam.Kucharski@Sun.COM  \catcode`>=\other
876*8044SWilliam.Kucharski@Sun.COM  \catcode`+=\other
877*8044SWilliam.Kucharski@Sun.COM  \catcode`-=\other
878*8044SWilliam.Kucharski@Sun.COM}
879*8044SWilliam.Kucharski@Sun.COM
880*8044SWilliam.Kucharski@Sun.COM\def\pushthisfilestack{%
881*8044SWilliam.Kucharski@Sun.COM  \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
882*8044SWilliam.Kucharski@Sun.COM}
883*8044SWilliam.Kucharski@Sun.COM\def\pushthisfilestackX{%
884*8044SWilliam.Kucharski@Sun.COM  \expandafter\pushthisfilestackY\thisfile\StackTerm
885*8044SWilliam.Kucharski@Sun.COM}
886*8044SWilliam.Kucharski@Sun.COM\def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
887*8044SWilliam.Kucharski@Sun.COM  \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
888*8044SWilliam.Kucharski@Sun.COM}
889*8044SWilliam.Kucharski@Sun.COM
890*8044SWilliam.Kucharski@Sun.COM\def\popthisfilestack{\errthisfilestackempty}
891*8044SWilliam.Kucharski@Sun.COM\def\errthisfilestackempty{\errmessage{Internal error:
892*8044SWilliam.Kucharski@Sun.COM  the stack of filenames is empty.}}
893*8044SWilliam.Kucharski@Sun.COM
894*8044SWilliam.Kucharski@Sun.COM\def\thisfile{}
895*8044SWilliam.Kucharski@Sun.COM
896*8044SWilliam.Kucharski@Sun.COM% @center line
897*8044SWilliam.Kucharski@Sun.COM% outputs that line, centered.
898*8044SWilliam.Kucharski@Sun.COM%
899*8044SWilliam.Kucharski@Sun.COM\parseargdef\center{%
900*8044SWilliam.Kucharski@Sun.COM  \ifhmode
901*8044SWilliam.Kucharski@Sun.COM    \let\next\centerH
902*8044SWilliam.Kucharski@Sun.COM  \else
903*8044SWilliam.Kucharski@Sun.COM    \let\next\centerV
904*8044SWilliam.Kucharski@Sun.COM  \fi
905*8044SWilliam.Kucharski@Sun.COM  \next{\hfil \ignorespaces#1\unskip \hfil}%
906*8044SWilliam.Kucharski@Sun.COM}
907*8044SWilliam.Kucharski@Sun.COM\def\centerH#1{%
908*8044SWilliam.Kucharski@Sun.COM  {%
909*8044SWilliam.Kucharski@Sun.COM    \hfil\break
910*8044SWilliam.Kucharski@Sun.COM    \advance\hsize by -\leftskip
911*8044SWilliam.Kucharski@Sun.COM    \advance\hsize by -\rightskip
912*8044SWilliam.Kucharski@Sun.COM    \line{#1}%
913*8044SWilliam.Kucharski@Sun.COM    \break
914*8044SWilliam.Kucharski@Sun.COM  }%
915*8044SWilliam.Kucharski@Sun.COM}
916*8044SWilliam.Kucharski@Sun.COM\def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
917*8044SWilliam.Kucharski@Sun.COM
918*8044SWilliam.Kucharski@Sun.COM% @sp n   outputs n lines of vertical space
919*8044SWilliam.Kucharski@Sun.COM
920*8044SWilliam.Kucharski@Sun.COM\parseargdef\sp{\vskip #1\baselineskip}
921*8044SWilliam.Kucharski@Sun.COM
922*8044SWilliam.Kucharski@Sun.COM% @comment ...line which is ignored...
923*8044SWilliam.Kucharski@Sun.COM% @c is the same as @comment
924*8044SWilliam.Kucharski@Sun.COM% @ignore ... @end ignore  is another way to write a comment
925*8044SWilliam.Kucharski@Sun.COM
926*8044SWilliam.Kucharski@Sun.COM\def\comment{\begingroup \catcode`\^^M=\other%
927*8044SWilliam.Kucharski@Sun.COM\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
928*8044SWilliam.Kucharski@Sun.COM\commentxxx}
929*8044SWilliam.Kucharski@Sun.COM{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
930*8044SWilliam.Kucharski@Sun.COM
931*8044SWilliam.Kucharski@Sun.COM\let\c=\comment
932*8044SWilliam.Kucharski@Sun.COM
933*8044SWilliam.Kucharski@Sun.COM% @paragraphindent NCHARS
934*8044SWilliam.Kucharski@Sun.COM% We'll use ems for NCHARS, close enough.
935*8044SWilliam.Kucharski@Sun.COM% NCHARS can also be the word `asis' or `none'.
936*8044SWilliam.Kucharski@Sun.COM% We cannot feasibly implement @paragraphindent asis, though.
937*8044SWilliam.Kucharski@Sun.COM%
938*8044SWilliam.Kucharski@Sun.COM\def\asisword{asis} % no translation, these are keywords
939*8044SWilliam.Kucharski@Sun.COM\def\noneword{none}
940*8044SWilliam.Kucharski@Sun.COM%
941*8044SWilliam.Kucharski@Sun.COM\parseargdef\paragraphindent{%
942*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
943*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\asisword
944*8044SWilliam.Kucharski@Sun.COM  \else
945*8044SWilliam.Kucharski@Sun.COM    \ifx\temp\noneword
946*8044SWilliam.Kucharski@Sun.COM      \defaultparindent = 0pt
947*8044SWilliam.Kucharski@Sun.COM    \else
948*8044SWilliam.Kucharski@Sun.COM      \defaultparindent = #1em
949*8044SWilliam.Kucharski@Sun.COM    \fi
950*8044SWilliam.Kucharski@Sun.COM  \fi
951*8044SWilliam.Kucharski@Sun.COM  \parindent = \defaultparindent
952*8044SWilliam.Kucharski@Sun.COM}
953*8044SWilliam.Kucharski@Sun.COM
954*8044SWilliam.Kucharski@Sun.COM% @exampleindent NCHARS
955*8044SWilliam.Kucharski@Sun.COM% We'll use ems for NCHARS like @paragraphindent.
956*8044SWilliam.Kucharski@Sun.COM% It seems @exampleindent asis isn't necessary, but
957*8044SWilliam.Kucharski@Sun.COM% I preserve it to make it similar to @paragraphindent.
958*8044SWilliam.Kucharski@Sun.COM\parseargdef\exampleindent{%
959*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
960*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\asisword
961*8044SWilliam.Kucharski@Sun.COM  \else
962*8044SWilliam.Kucharski@Sun.COM    \ifx\temp\noneword
963*8044SWilliam.Kucharski@Sun.COM      \lispnarrowing = 0pt
964*8044SWilliam.Kucharski@Sun.COM    \else
965*8044SWilliam.Kucharski@Sun.COM      \lispnarrowing = #1em
966*8044SWilliam.Kucharski@Sun.COM    \fi
967*8044SWilliam.Kucharski@Sun.COM  \fi
968*8044SWilliam.Kucharski@Sun.COM}
969*8044SWilliam.Kucharski@Sun.COM
970*8044SWilliam.Kucharski@Sun.COM% @firstparagraphindent WORD
971*8044SWilliam.Kucharski@Sun.COM% If WORD is `none', then suppress indentation of the first paragraph
972*8044SWilliam.Kucharski@Sun.COM% after a section heading.  If WORD is `insert', then do indent at such
973*8044SWilliam.Kucharski@Sun.COM% paragraphs.
974*8044SWilliam.Kucharski@Sun.COM%
975*8044SWilliam.Kucharski@Sun.COM% The paragraph indentation is suppressed or not by calling
976*8044SWilliam.Kucharski@Sun.COM% \suppressfirstparagraphindent, which the sectioning commands do.
977*8044SWilliam.Kucharski@Sun.COM% We switch the definition of this back and forth according to WORD.
978*8044SWilliam.Kucharski@Sun.COM% By default, we suppress indentation.
979*8044SWilliam.Kucharski@Sun.COM%
980*8044SWilliam.Kucharski@Sun.COM\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
981*8044SWilliam.Kucharski@Sun.COM\def\insertword{insert}
982*8044SWilliam.Kucharski@Sun.COM%
983*8044SWilliam.Kucharski@Sun.COM\parseargdef\firstparagraphindent{%
984*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
985*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\noneword
986*8044SWilliam.Kucharski@Sun.COM    \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
987*8044SWilliam.Kucharski@Sun.COM  \else\ifx\temp\insertword
988*8044SWilliam.Kucharski@Sun.COM    \let\suppressfirstparagraphindent = \relax
989*8044SWilliam.Kucharski@Sun.COM  \else
990*8044SWilliam.Kucharski@Sun.COM    \errhelp = \EMsimple
991*8044SWilliam.Kucharski@Sun.COM    \errmessage{Unknown @firstparagraphindent option `\temp'}%
992*8044SWilliam.Kucharski@Sun.COM  \fi\fi
993*8044SWilliam.Kucharski@Sun.COM}
994*8044SWilliam.Kucharski@Sun.COM
995*8044SWilliam.Kucharski@Sun.COM% Here is how we actually suppress indentation.  Redefine \everypar to
996*8044SWilliam.Kucharski@Sun.COM% \kern backwards by \parindent, and then reset itself to empty.
997*8044SWilliam.Kucharski@Sun.COM%
998*8044SWilliam.Kucharski@Sun.COM% We also make \indent itself not actually do anything until the next
999*8044SWilliam.Kucharski@Sun.COM% paragraph.
1000*8044SWilliam.Kucharski@Sun.COM%
1001*8044SWilliam.Kucharski@Sun.COM\gdef\dosuppressfirstparagraphindent{%
1002*8044SWilliam.Kucharski@Sun.COM  \gdef\indent{%
1003*8044SWilliam.Kucharski@Sun.COM    \restorefirstparagraphindent
1004*8044SWilliam.Kucharski@Sun.COM    \indent
1005*8044SWilliam.Kucharski@Sun.COM  }%
1006*8044SWilliam.Kucharski@Sun.COM  \gdef\noindent{%
1007*8044SWilliam.Kucharski@Sun.COM    \restorefirstparagraphindent
1008*8044SWilliam.Kucharski@Sun.COM    \noindent
1009*8044SWilliam.Kucharski@Sun.COM  }%
1010*8044SWilliam.Kucharski@Sun.COM  \global\everypar = {%
1011*8044SWilliam.Kucharski@Sun.COM    \kern -\parindent
1012*8044SWilliam.Kucharski@Sun.COM    \restorefirstparagraphindent
1013*8044SWilliam.Kucharski@Sun.COM  }%
1014*8044SWilliam.Kucharski@Sun.COM}
1015*8044SWilliam.Kucharski@Sun.COM
1016*8044SWilliam.Kucharski@Sun.COM\gdef\restorefirstparagraphindent{%
1017*8044SWilliam.Kucharski@Sun.COM  \global \let \indent = \ptexindent
1018*8044SWilliam.Kucharski@Sun.COM  \global \let \noindent = \ptexnoindent
1019*8044SWilliam.Kucharski@Sun.COM  \global \everypar = {}%
1020*8044SWilliam.Kucharski@Sun.COM}
1021*8044SWilliam.Kucharski@Sun.COM
1022*8044SWilliam.Kucharski@Sun.COM
1023*8044SWilliam.Kucharski@Sun.COM% @asis just yields its argument.  Used with @table, for example.
1024*8044SWilliam.Kucharski@Sun.COM%
1025*8044SWilliam.Kucharski@Sun.COM\def\asis#1{#1}
1026*8044SWilliam.Kucharski@Sun.COM
1027*8044SWilliam.Kucharski@Sun.COM% @math outputs its argument in math mode.
1028*8044SWilliam.Kucharski@Sun.COM%
1029*8044SWilliam.Kucharski@Sun.COM% One complication: _ usually means subscripts, but it could also mean
1030*8044SWilliam.Kucharski@Sun.COM% an actual _ character, as in @math{@var{some_variable} + 1}.  So make
1031*8044SWilliam.Kucharski@Sun.COM% _ active, and distinguish by seeing if the current family is \slfam,
1032*8044SWilliam.Kucharski@Sun.COM% which is what @var uses.
1033*8044SWilliam.Kucharski@Sun.COM{
1034*8044SWilliam.Kucharski@Sun.COM  \catcode\underChar = \active
1035*8044SWilliam.Kucharski@Sun.COM  \gdef\mathunderscore{%
1036*8044SWilliam.Kucharski@Sun.COM    \catcode\underChar=\active
1037*8044SWilliam.Kucharski@Sun.COM    \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1038*8044SWilliam.Kucharski@Sun.COM  }
1039*8044SWilliam.Kucharski@Sun.COM}
1040*8044SWilliam.Kucharski@Sun.COM% Another complication: we want \\ (and @\) to output a \ character.
1041*8044SWilliam.Kucharski@Sun.COM% FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1042*8044SWilliam.Kucharski@Sun.COM% this is not advertised and we don't care.  Texinfo does not
1043*8044SWilliam.Kucharski@Sun.COM% otherwise define @\.
1044*8044SWilliam.Kucharski@Sun.COM%
1045*8044SWilliam.Kucharski@Sun.COM% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1046*8044SWilliam.Kucharski@Sun.COM\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1047*8044SWilliam.Kucharski@Sun.COM%
1048*8044SWilliam.Kucharski@Sun.COM\def\math{%
1049*8044SWilliam.Kucharski@Sun.COM  \tex
1050*8044SWilliam.Kucharski@Sun.COM  \mathunderscore
1051*8044SWilliam.Kucharski@Sun.COM  \let\\ = \mathbackslash
1052*8044SWilliam.Kucharski@Sun.COM  \mathactive
1053*8044SWilliam.Kucharski@Sun.COM  $\finishmath
1054*8044SWilliam.Kucharski@Sun.COM}
1055*8044SWilliam.Kucharski@Sun.COM\def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1056*8044SWilliam.Kucharski@Sun.COM
1057*8044SWilliam.Kucharski@Sun.COM% Some active characters (such as <) are spaced differently in math.
1058*8044SWilliam.Kucharski@Sun.COM% We have to reset their definitions in case the @math was an argument
1059*8044SWilliam.Kucharski@Sun.COM% to a command which sets the catcodes (such as @item or @section).
1060*8044SWilliam.Kucharski@Sun.COM%
1061*8044SWilliam.Kucharski@Sun.COM{
1062*8044SWilliam.Kucharski@Sun.COM  \catcode`^ = \active
1063*8044SWilliam.Kucharski@Sun.COM  \catcode`< = \active
1064*8044SWilliam.Kucharski@Sun.COM  \catcode`> = \active
1065*8044SWilliam.Kucharski@Sun.COM  \catcode`+ = \active
1066*8044SWilliam.Kucharski@Sun.COM  \gdef\mathactive{%
1067*8044SWilliam.Kucharski@Sun.COM    \let^ = \ptexhat
1068*8044SWilliam.Kucharski@Sun.COM    \let< = \ptexless
1069*8044SWilliam.Kucharski@Sun.COM    \let> = \ptexgtr
1070*8044SWilliam.Kucharski@Sun.COM    \let+ = \ptexplus
1071*8044SWilliam.Kucharski@Sun.COM  }
1072*8044SWilliam.Kucharski@Sun.COM}
1073*8044SWilliam.Kucharski@Sun.COM
1074*8044SWilliam.Kucharski@Sun.COM% @bullet and @minus need the same treatment as @math, just above.
1075*8044SWilliam.Kucharski@Sun.COM\def\bullet{$\ptexbullet$}
1076*8044SWilliam.Kucharski@Sun.COM\def\minus{$-$}
1077*8044SWilliam.Kucharski@Sun.COM
1078*8044SWilliam.Kucharski@Sun.COM% @dots{} outputs an ellipsis using the current font.
1079*8044SWilliam.Kucharski@Sun.COM% We do .5em per period so that it has the same spacing in a typewriter
1080*8044SWilliam.Kucharski@Sun.COM% font as three actual period characters.
1081*8044SWilliam.Kucharski@Sun.COM%
1082*8044SWilliam.Kucharski@Sun.COM\def\dots{%
1083*8044SWilliam.Kucharski@Sun.COM  \leavevmode
1084*8044SWilliam.Kucharski@Sun.COM  \hbox to 1.5em{%
1085*8044SWilliam.Kucharski@Sun.COM    \hskip 0pt plus 0.25fil
1086*8044SWilliam.Kucharski@Sun.COM    .\hfil.\hfil.%
1087*8044SWilliam.Kucharski@Sun.COM    \hskip 0pt plus 0.5fil
1088*8044SWilliam.Kucharski@Sun.COM  }%
1089*8044SWilliam.Kucharski@Sun.COM}
1090*8044SWilliam.Kucharski@Sun.COM
1091*8044SWilliam.Kucharski@Sun.COM% @enddots{} is an end-of-sentence ellipsis.
1092*8044SWilliam.Kucharski@Sun.COM%
1093*8044SWilliam.Kucharski@Sun.COM\def\enddots{%
1094*8044SWilliam.Kucharski@Sun.COM  \dots
1095*8044SWilliam.Kucharski@Sun.COM  \spacefactor=3000
1096*8044SWilliam.Kucharski@Sun.COM}
1097*8044SWilliam.Kucharski@Sun.COM
1098*8044SWilliam.Kucharski@Sun.COM% @comma{} is so commas can be inserted into text without messing up
1099*8044SWilliam.Kucharski@Sun.COM% Texinfo's parsing.
1100*8044SWilliam.Kucharski@Sun.COM%
1101*8044SWilliam.Kucharski@Sun.COM\let\comma = ,
1102*8044SWilliam.Kucharski@Sun.COM
1103*8044SWilliam.Kucharski@Sun.COM% @refill is a no-op.
1104*8044SWilliam.Kucharski@Sun.COM\let\refill=\relax
1105*8044SWilliam.Kucharski@Sun.COM
1106*8044SWilliam.Kucharski@Sun.COM% If working on a large document in chapters, it is convenient to
1107*8044SWilliam.Kucharski@Sun.COM% be able to disable indexing, cross-referencing, and contents, for test runs.
1108*8044SWilliam.Kucharski@Sun.COM% This is done with @novalidate (before @setfilename).
1109*8044SWilliam.Kucharski@Sun.COM%
1110*8044SWilliam.Kucharski@Sun.COM\newif\iflinks \linkstrue % by default we want the aux files.
1111*8044SWilliam.Kucharski@Sun.COM\let\novalidate = \linksfalse
1112*8044SWilliam.Kucharski@Sun.COM
1113*8044SWilliam.Kucharski@Sun.COM% @setfilename is done at the beginning of every texinfo file.
1114*8044SWilliam.Kucharski@Sun.COM% So open here the files we need to have open while reading the input.
1115*8044SWilliam.Kucharski@Sun.COM% This makes it possible to make a .fmt file for texinfo.
1116*8044SWilliam.Kucharski@Sun.COM\def\setfilename{%
1117*8044SWilliam.Kucharski@Sun.COM   \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1118*8044SWilliam.Kucharski@Sun.COM   \iflinks
1119*8044SWilliam.Kucharski@Sun.COM     \tryauxfile
1120*8044SWilliam.Kucharski@Sun.COM     % Open the new aux file.  TeX will close it automatically at exit.
1121*8044SWilliam.Kucharski@Sun.COM     \immediate\openout\auxfile=\jobname.aux
1122*8044SWilliam.Kucharski@Sun.COM   \fi % \openindices needs to do some work in any case.
1123*8044SWilliam.Kucharski@Sun.COM   \openindices
1124*8044SWilliam.Kucharski@Sun.COM   \let\setfilename=\comment % Ignore extra @setfilename cmds.
1125*8044SWilliam.Kucharski@Sun.COM   %
1126*8044SWilliam.Kucharski@Sun.COM   % If texinfo.cnf is present on the system, read it.
1127*8044SWilliam.Kucharski@Sun.COM   % Useful for site-wide @afourpaper, etc.
1128*8044SWilliam.Kucharski@Sun.COM   \openin 1 texinfo.cnf
1129*8044SWilliam.Kucharski@Sun.COM   \ifeof 1 \else \input texinfo.cnf \fi
1130*8044SWilliam.Kucharski@Sun.COM   \closein 1
1131*8044SWilliam.Kucharski@Sun.COM   %
1132*8044SWilliam.Kucharski@Sun.COM   \comment % Ignore the actual filename.
1133*8044SWilliam.Kucharski@Sun.COM}
1134*8044SWilliam.Kucharski@Sun.COM
1135*8044SWilliam.Kucharski@Sun.COM% Called from \setfilename.
1136*8044SWilliam.Kucharski@Sun.COM%
1137*8044SWilliam.Kucharski@Sun.COM\def\openindices{%
1138*8044SWilliam.Kucharski@Sun.COM  \newindex{cp}%
1139*8044SWilliam.Kucharski@Sun.COM  \newcodeindex{fn}%
1140*8044SWilliam.Kucharski@Sun.COM  \newcodeindex{vr}%
1141*8044SWilliam.Kucharski@Sun.COM  \newcodeindex{tp}%
1142*8044SWilliam.Kucharski@Sun.COM  \newcodeindex{ky}%
1143*8044SWilliam.Kucharski@Sun.COM  \newcodeindex{pg}%
1144*8044SWilliam.Kucharski@Sun.COM}
1145*8044SWilliam.Kucharski@Sun.COM
1146*8044SWilliam.Kucharski@Sun.COM% @bye.
1147*8044SWilliam.Kucharski@Sun.COM\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1148*8044SWilliam.Kucharski@Sun.COM
1149*8044SWilliam.Kucharski@Sun.COM
1150*8044SWilliam.Kucharski@Sun.COM\message{pdf,}
1151*8044SWilliam.Kucharski@Sun.COM% adobe `portable' document format
1152*8044SWilliam.Kucharski@Sun.COM\newcount\tempnum
1153*8044SWilliam.Kucharski@Sun.COM\newcount\lnkcount
1154*8044SWilliam.Kucharski@Sun.COM\newtoks\filename
1155*8044SWilliam.Kucharski@Sun.COM\newcount\filenamelength
1156*8044SWilliam.Kucharski@Sun.COM\newcount\pgn
1157*8044SWilliam.Kucharski@Sun.COM\newtoks\toksA
1158*8044SWilliam.Kucharski@Sun.COM\newtoks\toksB
1159*8044SWilliam.Kucharski@Sun.COM\newtoks\toksC
1160*8044SWilliam.Kucharski@Sun.COM\newtoks\toksD
1161*8044SWilliam.Kucharski@Sun.COM\newbox\boxA
1162*8044SWilliam.Kucharski@Sun.COM\newcount\countA
1163*8044SWilliam.Kucharski@Sun.COM\newif\ifpdf
1164*8044SWilliam.Kucharski@Sun.COM\newif\ifpdfmakepagedest
1165*8044SWilliam.Kucharski@Sun.COM
1166*8044SWilliam.Kucharski@Sun.COM% when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1167*8044SWilliam.Kucharski@Sun.COM% can be set).  So we test for \relax and 0 as well as \undefined,
1168*8044SWilliam.Kucharski@Sun.COM% borrowed from ifpdf.sty.
1169*8044SWilliam.Kucharski@Sun.COM\ifx\pdfoutput\undefined
1170*8044SWilliam.Kucharski@Sun.COM\else
1171*8044SWilliam.Kucharski@Sun.COM  \ifx\pdfoutput\relax
1172*8044SWilliam.Kucharski@Sun.COM  \else
1173*8044SWilliam.Kucharski@Sun.COM    \ifcase\pdfoutput
1174*8044SWilliam.Kucharski@Sun.COM    \else
1175*8044SWilliam.Kucharski@Sun.COM      \pdftrue
1176*8044SWilliam.Kucharski@Sun.COM    \fi
1177*8044SWilliam.Kucharski@Sun.COM  \fi
1178*8044SWilliam.Kucharski@Sun.COM\fi
1179*8044SWilliam.Kucharski@Sun.COM%
1180*8044SWilliam.Kucharski@Sun.COM\ifpdf
1181*8044SWilliam.Kucharski@Sun.COM  \input pdfcolor
1182*8044SWilliam.Kucharski@Sun.COM  \pdfcatalog{/PageMode /UseOutlines}%
1183*8044SWilliam.Kucharski@Sun.COM  \def\dopdfimage#1#2#3{%
1184*8044SWilliam.Kucharski@Sun.COM    \def\imagewidth{#2}%
1185*8044SWilliam.Kucharski@Sun.COM    \def\imageheight{#3}%
1186*8044SWilliam.Kucharski@Sun.COM    % without \immediate, pdftex seg faults when the same image is
1187*8044SWilliam.Kucharski@Sun.COM    % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1188*8044SWilliam.Kucharski@Sun.COM    \ifnum\pdftexversion < 14
1189*8044SWilliam.Kucharski@Sun.COM      \immediate\pdfimage
1190*8044SWilliam.Kucharski@Sun.COM    \else
1191*8044SWilliam.Kucharski@Sun.COM      \immediate\pdfximage
1192*8044SWilliam.Kucharski@Sun.COM    \fi
1193*8044SWilliam.Kucharski@Sun.COM      \ifx\empty\imagewidth\else width \imagewidth \fi
1194*8044SWilliam.Kucharski@Sun.COM      \ifx\empty\imageheight\else height \imageheight \fi
1195*8044SWilliam.Kucharski@Sun.COM      \ifnum\pdftexversion<13
1196*8044SWilliam.Kucharski@Sun.COM         #1.pdf%
1197*8044SWilliam.Kucharski@Sun.COM       \else
1198*8044SWilliam.Kucharski@Sun.COM         {#1.pdf}%
1199*8044SWilliam.Kucharski@Sun.COM       \fi
1200*8044SWilliam.Kucharski@Sun.COM    \ifnum\pdftexversion < 14 \else
1201*8044SWilliam.Kucharski@Sun.COM      \pdfrefximage \pdflastximage
1202*8044SWilliam.Kucharski@Sun.COM    \fi}
1203*8044SWilliam.Kucharski@Sun.COM  \def\pdfmkdest#1{{%
1204*8044SWilliam.Kucharski@Sun.COM    % We have to set dummies so commands such as @code in a section title
1205*8044SWilliam.Kucharski@Sun.COM    % aren't expanded.
1206*8044SWilliam.Kucharski@Sun.COM    \atdummies
1207*8044SWilliam.Kucharski@Sun.COM    \normalturnoffactive
1208*8044SWilliam.Kucharski@Sun.COM    \pdfdest name{#1} xyz%
1209*8044SWilliam.Kucharski@Sun.COM  }}
1210*8044SWilliam.Kucharski@Sun.COM  \def\pdfmkpgn#1{#1}
1211*8044SWilliam.Kucharski@Sun.COM  \let\linkcolor = \Blue  % was Cyan, but that seems light?
1212*8044SWilliam.Kucharski@Sun.COM  \def\endlink{\Black\pdfendlink}
1213*8044SWilliam.Kucharski@Sun.COM  % Adding outlines to PDF; macros for calculating structure of outlines
1214*8044SWilliam.Kucharski@Sun.COM  % come from Petr Olsak
1215*8044SWilliam.Kucharski@Sun.COM  \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1216*8044SWilliam.Kucharski@Sun.COM    \else \csname#1\endcsname \fi}
1217*8044SWilliam.Kucharski@Sun.COM  \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1218*8044SWilliam.Kucharski@Sun.COM    \advance\tempnum by 1
1219*8044SWilliam.Kucharski@Sun.COM    \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1220*8044SWilliam.Kucharski@Sun.COM  %
1221*8044SWilliam.Kucharski@Sun.COM  % #1 is the section text.  #2 is the pdf expression for the number
1222*8044SWilliam.Kucharski@Sun.COM  % of subentries (or empty, for subsubsections).  #3 is the node
1223*8044SWilliam.Kucharski@Sun.COM  % text, which might be empty if this toc entry had no
1224*8044SWilliam.Kucharski@Sun.COM  % corresponding node.  #4 is the page number.
1225*8044SWilliam.Kucharski@Sun.COM  %
1226*8044SWilliam.Kucharski@Sun.COM  \def\dopdfoutline#1#2#3#4{%
1227*8044SWilliam.Kucharski@Sun.COM    % Generate a link to the node text if that exists; else, use the
1228*8044SWilliam.Kucharski@Sun.COM    % page number.  We could generate a destination for the section
1229*8044SWilliam.Kucharski@Sun.COM    % text in the case where a section has no node, but it doesn't
1230*8044SWilliam.Kucharski@Sun.COM    % seem worthwhile, since most documents are normally structured.
1231*8044SWilliam.Kucharski@Sun.COM    \def\pdfoutlinedest{#3}%
1232*8044SWilliam.Kucharski@Sun.COM    \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1233*8044SWilliam.Kucharski@Sun.COM    %
1234*8044SWilliam.Kucharski@Sun.COM    \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1235*8044SWilliam.Kucharski@Sun.COM  }
1236*8044SWilliam.Kucharski@Sun.COM  %
1237*8044SWilliam.Kucharski@Sun.COM  \def\pdfmakeoutlines{%
1238*8044SWilliam.Kucharski@Sun.COM    \begingroup
1239*8044SWilliam.Kucharski@Sun.COM      % Thanh's hack / proper braces in bookmarks
1240*8044SWilliam.Kucharski@Sun.COM      \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1241*8044SWilliam.Kucharski@Sun.COM      \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1242*8044SWilliam.Kucharski@Sun.COM      %
1243*8044SWilliam.Kucharski@Sun.COM      % Read toc silently, to get counts of subentries for \pdfoutline.
1244*8044SWilliam.Kucharski@Sun.COM      \def\numchapentry##1##2##3##4{%
1245*8044SWilliam.Kucharski@Sun.COM	\def\thischapnum{##2}%
1246*8044SWilliam.Kucharski@Sun.COM	\def\thissecnum{0}%
1247*8044SWilliam.Kucharski@Sun.COM	\def\thissubsecnum{0}%
1248*8044SWilliam.Kucharski@Sun.COM      }%
1249*8044SWilliam.Kucharski@Sun.COM      \def\numsecentry##1##2##3##4{%
1250*8044SWilliam.Kucharski@Sun.COM	\advancenumber{chap\thischapnum}%
1251*8044SWilliam.Kucharski@Sun.COM	\def\thissecnum{##2}%
1252*8044SWilliam.Kucharski@Sun.COM	\def\thissubsecnum{0}%
1253*8044SWilliam.Kucharski@Sun.COM      }%
1254*8044SWilliam.Kucharski@Sun.COM      \def\numsubsecentry##1##2##3##4{%
1255*8044SWilliam.Kucharski@Sun.COM	\advancenumber{sec\thissecnum}%
1256*8044SWilliam.Kucharski@Sun.COM	\def\thissubsecnum{##2}%
1257*8044SWilliam.Kucharski@Sun.COM      }%
1258*8044SWilliam.Kucharski@Sun.COM      \def\numsubsubsecentry##1##2##3##4{%
1259*8044SWilliam.Kucharski@Sun.COM	\advancenumber{subsec\thissubsecnum}%
1260*8044SWilliam.Kucharski@Sun.COM      }%
1261*8044SWilliam.Kucharski@Sun.COM      \def\thischapnum{0}%
1262*8044SWilliam.Kucharski@Sun.COM      \def\thissecnum{0}%
1263*8044SWilliam.Kucharski@Sun.COM      \def\thissubsecnum{0}%
1264*8044SWilliam.Kucharski@Sun.COM      %
1265*8044SWilliam.Kucharski@Sun.COM      % use \def rather than \let here because we redefine \chapentry et
1266*8044SWilliam.Kucharski@Sun.COM      % al. a second time, below.
1267*8044SWilliam.Kucharski@Sun.COM      \def\appentry{\numchapentry}%
1268*8044SWilliam.Kucharski@Sun.COM      \def\appsecentry{\numsecentry}%
1269*8044SWilliam.Kucharski@Sun.COM      \def\appsubsecentry{\numsubsecentry}%
1270*8044SWilliam.Kucharski@Sun.COM      \def\appsubsubsecentry{\numsubsubsecentry}%
1271*8044SWilliam.Kucharski@Sun.COM      \def\unnchapentry{\numchapentry}%
1272*8044SWilliam.Kucharski@Sun.COM      \def\unnsecentry{\numsecentry}%
1273*8044SWilliam.Kucharski@Sun.COM      \def\unnsubsecentry{\numsubsecentry}%
1274*8044SWilliam.Kucharski@Sun.COM      \def\unnsubsubsecentry{\numsubsubsecentry}%
1275*8044SWilliam.Kucharski@Sun.COM      \input \jobname.toc
1276*8044SWilliam.Kucharski@Sun.COM      %
1277*8044SWilliam.Kucharski@Sun.COM      % Read toc second time, this time actually producing the outlines.
1278*8044SWilliam.Kucharski@Sun.COM      % The `-' means take the \expnumber as the absolute number of
1279*8044SWilliam.Kucharski@Sun.COM      % subentries, which we calculated on our first read of the .toc above.
1280*8044SWilliam.Kucharski@Sun.COM      %
1281*8044SWilliam.Kucharski@Sun.COM      % We use the node names as the destinations.
1282*8044SWilliam.Kucharski@Sun.COM      \def\numchapentry##1##2##3##4{%
1283*8044SWilliam.Kucharski@Sun.COM        \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1284*8044SWilliam.Kucharski@Sun.COM      \def\numsecentry##1##2##3##4{%
1285*8044SWilliam.Kucharski@Sun.COM        \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1286*8044SWilliam.Kucharski@Sun.COM      \def\numsubsecentry##1##2##3##4{%
1287*8044SWilliam.Kucharski@Sun.COM        \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1288*8044SWilliam.Kucharski@Sun.COM      \def\numsubsubsecentry##1##2##3##4{% count is always zero
1289*8044SWilliam.Kucharski@Sun.COM        \dopdfoutline{##1}{}{##3}{##4}}%
1290*8044SWilliam.Kucharski@Sun.COM      %
1291*8044SWilliam.Kucharski@Sun.COM      % PDF outlines are displayed using system fonts, instead of
1292*8044SWilliam.Kucharski@Sun.COM      % document fonts.  Therefore we cannot use special characters,
1293*8044SWilliam.Kucharski@Sun.COM      % since the encoding is unknown.  For example, the eogonek from
1294*8044SWilliam.Kucharski@Sun.COM      % Latin 2 (0xea) gets translated to a | character.  Info from
1295*8044SWilliam.Kucharski@Sun.COM      % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1296*8044SWilliam.Kucharski@Sun.COM      %
1297*8044SWilliam.Kucharski@Sun.COM      % xx to do this right, we have to translate 8-bit characters to
1298*8044SWilliam.Kucharski@Sun.COM      % their "best" equivalent, based on the @documentencoding.  Right
1299*8044SWilliam.Kucharski@Sun.COM      % now, I guess we'll just let the pdf reader have its way.
1300*8044SWilliam.Kucharski@Sun.COM      \indexnofonts
1301*8044SWilliam.Kucharski@Sun.COM      \turnoffactive
1302*8044SWilliam.Kucharski@Sun.COM      \input \jobname.toc
1303*8044SWilliam.Kucharski@Sun.COM    \endgroup
1304*8044SWilliam.Kucharski@Sun.COM  }
1305*8044SWilliam.Kucharski@Sun.COM  %
1306*8044SWilliam.Kucharski@Sun.COM  \def\makelinks #1,{%
1307*8044SWilliam.Kucharski@Sun.COM    \def\params{#1}\def\E{END}%
1308*8044SWilliam.Kucharski@Sun.COM    \ifx\params\E
1309*8044SWilliam.Kucharski@Sun.COM      \let\nextmakelinks=\relax
1310*8044SWilliam.Kucharski@Sun.COM    \else
1311*8044SWilliam.Kucharski@Sun.COM      \let\nextmakelinks=\makelinks
1312*8044SWilliam.Kucharski@Sun.COM      \ifnum\lnkcount>0,\fi
1313*8044SWilliam.Kucharski@Sun.COM      \picknum{#1}%
1314*8044SWilliam.Kucharski@Sun.COM      \startlink attr{/Border [0 0 0]}
1315*8044SWilliam.Kucharski@Sun.COM        goto name{\pdfmkpgn{\the\pgn}}%
1316*8044SWilliam.Kucharski@Sun.COM      \linkcolor #1%
1317*8044SWilliam.Kucharski@Sun.COM      \advance\lnkcount by 1%
1318*8044SWilliam.Kucharski@Sun.COM      \endlink
1319*8044SWilliam.Kucharski@Sun.COM    \fi
1320*8044SWilliam.Kucharski@Sun.COM    \nextmakelinks
1321*8044SWilliam.Kucharski@Sun.COM  }
1322*8044SWilliam.Kucharski@Sun.COM  \def\picknum#1{\expandafter\pn#1}
1323*8044SWilliam.Kucharski@Sun.COM  \def\pn#1{%
1324*8044SWilliam.Kucharski@Sun.COM    \def\p{#1}%
1325*8044SWilliam.Kucharski@Sun.COM    \ifx\p\lbrace
1326*8044SWilliam.Kucharski@Sun.COM      \let\nextpn=\ppn
1327*8044SWilliam.Kucharski@Sun.COM    \else
1328*8044SWilliam.Kucharski@Sun.COM      \let\nextpn=\ppnn
1329*8044SWilliam.Kucharski@Sun.COM      \def\first{#1}
1330*8044SWilliam.Kucharski@Sun.COM    \fi
1331*8044SWilliam.Kucharski@Sun.COM    \nextpn
1332*8044SWilliam.Kucharski@Sun.COM  }
1333*8044SWilliam.Kucharski@Sun.COM  \def\ppn#1{\pgn=#1\gobble}
1334*8044SWilliam.Kucharski@Sun.COM  \def\ppnn{\pgn=\first}
1335*8044SWilliam.Kucharski@Sun.COM  \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1336*8044SWilliam.Kucharski@Sun.COM  \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1337*8044SWilliam.Kucharski@Sun.COM    \ifx\PP\D\let\nextsp\relax
1338*8044SWilliam.Kucharski@Sun.COM    \else\let\nextsp\skipspaces
1339*8044SWilliam.Kucharski@Sun.COM      \ifx\p\space\else\addtokens{\filename}{\PP}%
1340*8044SWilliam.Kucharski@Sun.COM        \advance\filenamelength by 1
1341*8044SWilliam.Kucharski@Sun.COM      \fi
1342*8044SWilliam.Kucharski@Sun.COM    \fi
1343*8044SWilliam.Kucharski@Sun.COM    \nextsp}
1344*8044SWilliam.Kucharski@Sun.COM  \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1345*8044SWilliam.Kucharski@Sun.COM  \ifnum\pdftexversion < 14
1346*8044SWilliam.Kucharski@Sun.COM    \let \startlink \pdfannotlink
1347*8044SWilliam.Kucharski@Sun.COM  \else
1348*8044SWilliam.Kucharski@Sun.COM    \let \startlink \pdfstartlink
1349*8044SWilliam.Kucharski@Sun.COM  \fi
1350*8044SWilliam.Kucharski@Sun.COM  \def\pdfurl#1{%
1351*8044SWilliam.Kucharski@Sun.COM    \begingroup
1352*8044SWilliam.Kucharski@Sun.COM      \normalturnoffactive\def\@{@}%
1353*8044SWilliam.Kucharski@Sun.COM      \makevalueexpandable
1354*8044SWilliam.Kucharski@Sun.COM      \leavevmode\Red
1355*8044SWilliam.Kucharski@Sun.COM      \startlink attr{/Border [0 0 0]}%
1356*8044SWilliam.Kucharski@Sun.COM        user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1357*8044SWilliam.Kucharski@Sun.COM    \endgroup}
1358*8044SWilliam.Kucharski@Sun.COM  \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1359*8044SWilliam.Kucharski@Sun.COM  \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1360*8044SWilliam.Kucharski@Sun.COM  \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1361*8044SWilliam.Kucharski@Sun.COM  \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1362*8044SWilliam.Kucharski@Sun.COM  \def\maketoks{%
1363*8044SWilliam.Kucharski@Sun.COM    \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1364*8044SWilliam.Kucharski@Sun.COM    \ifx\first0\adn0
1365*8044SWilliam.Kucharski@Sun.COM    \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1366*8044SWilliam.Kucharski@Sun.COM    \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1367*8044SWilliam.Kucharski@Sun.COM    \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1368*8044SWilliam.Kucharski@Sun.COM    \else
1369*8044SWilliam.Kucharski@Sun.COM      \ifnum0=\countA\else\makelink\fi
1370*8044SWilliam.Kucharski@Sun.COM      \ifx\first.\let\next=\done\else
1371*8044SWilliam.Kucharski@Sun.COM        \let\next=\maketoks
1372*8044SWilliam.Kucharski@Sun.COM        \addtokens{\toksB}{\the\toksD}
1373*8044SWilliam.Kucharski@Sun.COM        \ifx\first,\addtokens{\toksB}{\space}\fi
1374*8044SWilliam.Kucharski@Sun.COM      \fi
1375*8044SWilliam.Kucharski@Sun.COM    \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1376*8044SWilliam.Kucharski@Sun.COM    \next}
1377*8044SWilliam.Kucharski@Sun.COM  \def\makelink{\addtokens{\toksB}%
1378*8044SWilliam.Kucharski@Sun.COM    {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1379*8044SWilliam.Kucharski@Sun.COM  \def\pdflink#1{%
1380*8044SWilliam.Kucharski@Sun.COM    \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1381*8044SWilliam.Kucharski@Sun.COM    \linkcolor #1\endlink}
1382*8044SWilliam.Kucharski@Sun.COM  \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1383*8044SWilliam.Kucharski@Sun.COM\else
1384*8044SWilliam.Kucharski@Sun.COM  \let\pdfmkdest = \gobble
1385*8044SWilliam.Kucharski@Sun.COM  \let\pdfurl = \gobble
1386*8044SWilliam.Kucharski@Sun.COM  \let\endlink = \relax
1387*8044SWilliam.Kucharski@Sun.COM  \let\linkcolor = \relax
1388*8044SWilliam.Kucharski@Sun.COM  \let\pdfmakeoutlines = \relax
1389*8044SWilliam.Kucharski@Sun.COM\fi  % \ifx\pdfoutput
1390*8044SWilliam.Kucharski@Sun.COM
1391*8044SWilliam.Kucharski@Sun.COM
1392*8044SWilliam.Kucharski@Sun.COM\message{fonts,}
1393*8044SWilliam.Kucharski@Sun.COM
1394*8044SWilliam.Kucharski@Sun.COM% Change the current font style to #1, remembering it in \curfontstyle.
1395*8044SWilliam.Kucharski@Sun.COM% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1396*8044SWilliam.Kucharski@Sun.COM% italics, not bold italics.
1397*8044SWilliam.Kucharski@Sun.COM%
1398*8044SWilliam.Kucharski@Sun.COM\def\setfontstyle#1{%
1399*8044SWilliam.Kucharski@Sun.COM  \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1400*8044SWilliam.Kucharski@Sun.COM  \csname ten#1\endcsname  % change the current font
1401*8044SWilliam.Kucharski@Sun.COM}
1402*8044SWilliam.Kucharski@Sun.COM
1403*8044SWilliam.Kucharski@Sun.COM% Select #1 fonts with the current style.
1404*8044SWilliam.Kucharski@Sun.COM%
1405*8044SWilliam.Kucharski@Sun.COM\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1406*8044SWilliam.Kucharski@Sun.COM
1407*8044SWilliam.Kucharski@Sun.COM\def\rm{\fam=0 \setfontstyle{rm}}
1408*8044SWilliam.Kucharski@Sun.COM\def\it{\fam=\itfam \setfontstyle{it}}
1409*8044SWilliam.Kucharski@Sun.COM\def\sl{\fam=\slfam \setfontstyle{sl}}
1410*8044SWilliam.Kucharski@Sun.COM\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1411*8044SWilliam.Kucharski@Sun.COM\def\tt{\fam=\ttfam \setfontstyle{tt}}
1412*8044SWilliam.Kucharski@Sun.COM
1413*8044SWilliam.Kucharski@Sun.COM% Texinfo sort of supports the sans serif font style, which plain TeX does not.
1414*8044SWilliam.Kucharski@Sun.COM% So we set up a \sf.
1415*8044SWilliam.Kucharski@Sun.COM\newfam\sffam
1416*8044SWilliam.Kucharski@Sun.COM\def\sf{\fam=\sffam \setfontstyle{sf}}
1417*8044SWilliam.Kucharski@Sun.COM\let\li = \sf % Sometimes we call it \li, not \sf.
1418*8044SWilliam.Kucharski@Sun.COM
1419*8044SWilliam.Kucharski@Sun.COM% We don't need math for this font style.
1420*8044SWilliam.Kucharski@Sun.COM\def\ttsl{\setfontstyle{ttsl}}
1421*8044SWilliam.Kucharski@Sun.COM
1422*8044SWilliam.Kucharski@Sun.COM% Default leading.
1423*8044SWilliam.Kucharski@Sun.COM\newdimen\textleading  \textleading = 13.2pt
1424*8044SWilliam.Kucharski@Sun.COM
1425*8044SWilliam.Kucharski@Sun.COM% Set the baselineskip to #1, and the lineskip and strut size
1426*8044SWilliam.Kucharski@Sun.COM% correspondingly.  There is no deep meaning behind these magic numbers
1427*8044SWilliam.Kucharski@Sun.COM% used as factors; they just match (closely enough) what Knuth defined.
1428*8044SWilliam.Kucharski@Sun.COM%
1429*8044SWilliam.Kucharski@Sun.COM\def\lineskipfactor{.08333}
1430*8044SWilliam.Kucharski@Sun.COM\def\strutheightpercent{.70833}
1431*8044SWilliam.Kucharski@Sun.COM\def\strutdepthpercent {.29167}
1432*8044SWilliam.Kucharski@Sun.COM%
1433*8044SWilliam.Kucharski@Sun.COM\def\setleading#1{%
1434*8044SWilliam.Kucharski@Sun.COM  \normalbaselineskip = #1\relax
1435*8044SWilliam.Kucharski@Sun.COM  \normallineskip = \lineskipfactor\normalbaselineskip
1436*8044SWilliam.Kucharski@Sun.COM  \normalbaselines
1437*8044SWilliam.Kucharski@Sun.COM  \setbox\strutbox =\hbox{%
1438*8044SWilliam.Kucharski@Sun.COM    \vrule width0pt height\strutheightpercent\baselineskip
1439*8044SWilliam.Kucharski@Sun.COM                    depth \strutdepthpercent \baselineskip
1440*8044SWilliam.Kucharski@Sun.COM  }%
1441*8044SWilliam.Kucharski@Sun.COM}
1442*8044SWilliam.Kucharski@Sun.COM
1443*8044SWilliam.Kucharski@Sun.COM% Set the font macro #1 to the font named #2, adding on the
1444*8044SWilliam.Kucharski@Sun.COM% specified font prefix (normally `cm').
1445*8044SWilliam.Kucharski@Sun.COM% #3 is the font's design size, #4 is a scale factor
1446*8044SWilliam.Kucharski@Sun.COM\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1447*8044SWilliam.Kucharski@Sun.COM
1448*8044SWilliam.Kucharski@Sun.COM% Use cm as the default font prefix.
1449*8044SWilliam.Kucharski@Sun.COM% To specify the font prefix, you must define \fontprefix
1450*8044SWilliam.Kucharski@Sun.COM% before you read in texinfo.tex.
1451*8044SWilliam.Kucharski@Sun.COM\ifx\fontprefix\undefined
1452*8044SWilliam.Kucharski@Sun.COM\def\fontprefix{cm}
1453*8044SWilliam.Kucharski@Sun.COM\fi
1454*8044SWilliam.Kucharski@Sun.COM% Support font families that don't use the same naming scheme as CM.
1455*8044SWilliam.Kucharski@Sun.COM\def\rmshape{r}
1456*8044SWilliam.Kucharski@Sun.COM\def\rmbshape{bx}               %where the normal face is bold
1457*8044SWilliam.Kucharski@Sun.COM\def\bfshape{b}
1458*8044SWilliam.Kucharski@Sun.COM\def\bxshape{bx}
1459*8044SWilliam.Kucharski@Sun.COM\def\ttshape{tt}
1460*8044SWilliam.Kucharski@Sun.COM\def\ttbshape{tt}
1461*8044SWilliam.Kucharski@Sun.COM\def\ttslshape{sltt}
1462*8044SWilliam.Kucharski@Sun.COM\def\itshape{ti}
1463*8044SWilliam.Kucharski@Sun.COM\def\itbshape{bxti}
1464*8044SWilliam.Kucharski@Sun.COM\def\slshape{sl}
1465*8044SWilliam.Kucharski@Sun.COM\def\slbshape{bxsl}
1466*8044SWilliam.Kucharski@Sun.COM\def\sfshape{ss}
1467*8044SWilliam.Kucharski@Sun.COM\def\sfbshape{ss}
1468*8044SWilliam.Kucharski@Sun.COM\def\scshape{csc}
1469*8044SWilliam.Kucharski@Sun.COM\def\scbshape{csc}
1470*8044SWilliam.Kucharski@Sun.COM
1471*8044SWilliam.Kucharski@Sun.COM% Text fonts (11.2pt, magstep1).
1472*8044SWilliam.Kucharski@Sun.COM\def\textnominalsize{11pt}
1473*8044SWilliam.Kucharski@Sun.COM\edef\mainmagstep{\magstephalf}
1474*8044SWilliam.Kucharski@Sun.COM\setfont\textrm\rmshape{10}{\mainmagstep}
1475*8044SWilliam.Kucharski@Sun.COM\setfont\texttt\ttshape{10}{\mainmagstep}
1476*8044SWilliam.Kucharski@Sun.COM\setfont\textbf\bfshape{10}{\mainmagstep}
1477*8044SWilliam.Kucharski@Sun.COM\setfont\textit\itshape{10}{\mainmagstep}
1478*8044SWilliam.Kucharski@Sun.COM\setfont\textsl\slshape{10}{\mainmagstep}
1479*8044SWilliam.Kucharski@Sun.COM\setfont\textsf\sfshape{10}{\mainmagstep}
1480*8044SWilliam.Kucharski@Sun.COM\setfont\textsc\scshape{10}{\mainmagstep}
1481*8044SWilliam.Kucharski@Sun.COM\setfont\textttsl\ttslshape{10}{\mainmagstep}
1482*8044SWilliam.Kucharski@Sun.COM\font\texti=cmmi10 scaled \mainmagstep
1483*8044SWilliam.Kucharski@Sun.COM\font\textsy=cmsy10 scaled \mainmagstep
1484*8044SWilliam.Kucharski@Sun.COM
1485*8044SWilliam.Kucharski@Sun.COM% A few fonts for @defun names and args.
1486*8044SWilliam.Kucharski@Sun.COM\setfont\defbf\bfshape{10}{\magstep1}
1487*8044SWilliam.Kucharski@Sun.COM\setfont\deftt\ttshape{10}{\magstep1}
1488*8044SWilliam.Kucharski@Sun.COM\setfont\defttsl\ttslshape{10}{\magstep1}
1489*8044SWilliam.Kucharski@Sun.COM\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1490*8044SWilliam.Kucharski@Sun.COM
1491*8044SWilliam.Kucharski@Sun.COM% Fonts for indices, footnotes, small examples (9pt).
1492*8044SWilliam.Kucharski@Sun.COM\def\smallnominalsize{9pt}
1493*8044SWilliam.Kucharski@Sun.COM\setfont\smallrm\rmshape{9}{1000}
1494*8044SWilliam.Kucharski@Sun.COM\setfont\smalltt\ttshape{9}{1000}
1495*8044SWilliam.Kucharski@Sun.COM\setfont\smallbf\bfshape{10}{900}
1496*8044SWilliam.Kucharski@Sun.COM\setfont\smallit\itshape{9}{1000}
1497*8044SWilliam.Kucharski@Sun.COM\setfont\smallsl\slshape{9}{1000}
1498*8044SWilliam.Kucharski@Sun.COM\setfont\smallsf\sfshape{9}{1000}
1499*8044SWilliam.Kucharski@Sun.COM\setfont\smallsc\scshape{10}{900}
1500*8044SWilliam.Kucharski@Sun.COM\setfont\smallttsl\ttslshape{10}{900}
1501*8044SWilliam.Kucharski@Sun.COM\font\smalli=cmmi9
1502*8044SWilliam.Kucharski@Sun.COM\font\smallsy=cmsy9
1503*8044SWilliam.Kucharski@Sun.COM
1504*8044SWilliam.Kucharski@Sun.COM% Fonts for small examples (8pt).
1505*8044SWilliam.Kucharski@Sun.COM\def\smallernominalsize{8pt}
1506*8044SWilliam.Kucharski@Sun.COM\setfont\smallerrm\rmshape{8}{1000}
1507*8044SWilliam.Kucharski@Sun.COM\setfont\smallertt\ttshape{8}{1000}
1508*8044SWilliam.Kucharski@Sun.COM\setfont\smallerbf\bfshape{10}{800}
1509*8044SWilliam.Kucharski@Sun.COM\setfont\smallerit\itshape{8}{1000}
1510*8044SWilliam.Kucharski@Sun.COM\setfont\smallersl\slshape{8}{1000}
1511*8044SWilliam.Kucharski@Sun.COM\setfont\smallersf\sfshape{8}{1000}
1512*8044SWilliam.Kucharski@Sun.COM\setfont\smallersc\scshape{10}{800}
1513*8044SWilliam.Kucharski@Sun.COM\setfont\smallerttsl\ttslshape{10}{800}
1514*8044SWilliam.Kucharski@Sun.COM\font\smalleri=cmmi8
1515*8044SWilliam.Kucharski@Sun.COM\font\smallersy=cmsy8
1516*8044SWilliam.Kucharski@Sun.COM
1517*8044SWilliam.Kucharski@Sun.COM% Fonts for title page (20.4pt):
1518*8044SWilliam.Kucharski@Sun.COM\def\titlenominalsize{20pt}
1519*8044SWilliam.Kucharski@Sun.COM\setfont\titlerm\rmbshape{12}{\magstep3}
1520*8044SWilliam.Kucharski@Sun.COM\setfont\titleit\itbshape{10}{\magstep4}
1521*8044SWilliam.Kucharski@Sun.COM\setfont\titlesl\slbshape{10}{\magstep4}
1522*8044SWilliam.Kucharski@Sun.COM\setfont\titlett\ttbshape{12}{\magstep3}
1523*8044SWilliam.Kucharski@Sun.COM\setfont\titlettsl\ttslshape{10}{\magstep4}
1524*8044SWilliam.Kucharski@Sun.COM\setfont\titlesf\sfbshape{17}{\magstep1}
1525*8044SWilliam.Kucharski@Sun.COM\let\titlebf=\titlerm
1526*8044SWilliam.Kucharski@Sun.COM\setfont\titlesc\scbshape{10}{\magstep4}
1527*8044SWilliam.Kucharski@Sun.COM\font\titlei=cmmi12 scaled \magstep3
1528*8044SWilliam.Kucharski@Sun.COM\font\titlesy=cmsy10 scaled \magstep4
1529*8044SWilliam.Kucharski@Sun.COM\def\authorrm{\secrm}
1530*8044SWilliam.Kucharski@Sun.COM\def\authortt{\sectt}
1531*8044SWilliam.Kucharski@Sun.COM
1532*8044SWilliam.Kucharski@Sun.COM% Chapter (and unnumbered) fonts (17.28pt).
1533*8044SWilliam.Kucharski@Sun.COM\def\chapnominalsize{17pt}
1534*8044SWilliam.Kucharski@Sun.COM\setfont\chaprm\rmbshape{12}{\magstep2}
1535*8044SWilliam.Kucharski@Sun.COM\setfont\chapit\itbshape{10}{\magstep3}
1536*8044SWilliam.Kucharski@Sun.COM\setfont\chapsl\slbshape{10}{\magstep3}
1537*8044SWilliam.Kucharski@Sun.COM\setfont\chaptt\ttbshape{12}{\magstep2}
1538*8044SWilliam.Kucharski@Sun.COM\setfont\chapttsl\ttslshape{10}{\magstep3}
1539*8044SWilliam.Kucharski@Sun.COM\setfont\chapsf\sfbshape{17}{1000}
1540*8044SWilliam.Kucharski@Sun.COM\let\chapbf=\chaprm
1541*8044SWilliam.Kucharski@Sun.COM\setfont\chapsc\scbshape{10}{\magstep3}
1542*8044SWilliam.Kucharski@Sun.COM\font\chapi=cmmi12 scaled \magstep2
1543*8044SWilliam.Kucharski@Sun.COM\font\chapsy=cmsy10 scaled \magstep3
1544*8044SWilliam.Kucharski@Sun.COM
1545*8044SWilliam.Kucharski@Sun.COM% Section fonts (14.4pt).
1546*8044SWilliam.Kucharski@Sun.COM\def\secnominalsize{14pt}
1547*8044SWilliam.Kucharski@Sun.COM\setfont\secrm\rmbshape{12}{\magstep1}
1548*8044SWilliam.Kucharski@Sun.COM\setfont\secit\itbshape{10}{\magstep2}
1549*8044SWilliam.Kucharski@Sun.COM\setfont\secsl\slbshape{10}{\magstep2}
1550*8044SWilliam.Kucharski@Sun.COM\setfont\sectt\ttbshape{12}{\magstep1}
1551*8044SWilliam.Kucharski@Sun.COM\setfont\secttsl\ttslshape{10}{\magstep2}
1552*8044SWilliam.Kucharski@Sun.COM\setfont\secsf\sfbshape{12}{\magstep1}
1553*8044SWilliam.Kucharski@Sun.COM\let\secbf\secrm
1554*8044SWilliam.Kucharski@Sun.COM\setfont\secsc\scbshape{10}{\magstep2}
1555*8044SWilliam.Kucharski@Sun.COM\font\seci=cmmi12 scaled \magstep1
1556*8044SWilliam.Kucharski@Sun.COM\font\secsy=cmsy10 scaled \magstep2
1557*8044SWilliam.Kucharski@Sun.COM
1558*8044SWilliam.Kucharski@Sun.COM% Subsection fonts (13.15pt).
1559*8044SWilliam.Kucharski@Sun.COM\def\ssecnominalsize{13pt}
1560*8044SWilliam.Kucharski@Sun.COM\setfont\ssecrm\rmbshape{12}{\magstephalf}
1561*8044SWilliam.Kucharski@Sun.COM\setfont\ssecit\itbshape{10}{1315}
1562*8044SWilliam.Kucharski@Sun.COM\setfont\ssecsl\slbshape{10}{1315}
1563*8044SWilliam.Kucharski@Sun.COM\setfont\ssectt\ttbshape{12}{\magstephalf}
1564*8044SWilliam.Kucharski@Sun.COM\setfont\ssecttsl\ttslshape{10}{1315}
1565*8044SWilliam.Kucharski@Sun.COM\setfont\ssecsf\sfbshape{12}{\magstephalf}
1566*8044SWilliam.Kucharski@Sun.COM\let\ssecbf\ssecrm
1567*8044SWilliam.Kucharski@Sun.COM\setfont\ssecsc\scbshape{10}{1315}
1568*8044SWilliam.Kucharski@Sun.COM\font\sseci=cmmi12 scaled \magstephalf
1569*8044SWilliam.Kucharski@Sun.COM\font\ssecsy=cmsy10 scaled 1315
1570*8044SWilliam.Kucharski@Sun.COM
1571*8044SWilliam.Kucharski@Sun.COM% Reduced fonts for @acro in text (10pt).
1572*8044SWilliam.Kucharski@Sun.COM\def\reducednominalsize{10pt}
1573*8044SWilliam.Kucharski@Sun.COM\setfont\reducedrm\rmshape{10}{1000}
1574*8044SWilliam.Kucharski@Sun.COM\setfont\reducedtt\ttshape{10}{1000}
1575*8044SWilliam.Kucharski@Sun.COM\setfont\reducedbf\bfshape{10}{1000}
1576*8044SWilliam.Kucharski@Sun.COM\setfont\reducedit\itshape{10}{1000}
1577*8044SWilliam.Kucharski@Sun.COM\setfont\reducedsl\slshape{10}{1000}
1578*8044SWilliam.Kucharski@Sun.COM\setfont\reducedsf\sfshape{10}{1000}
1579*8044SWilliam.Kucharski@Sun.COM\setfont\reducedsc\scshape{10}{1000}
1580*8044SWilliam.Kucharski@Sun.COM\setfont\reducedttsl\ttslshape{10}{1000}
1581*8044SWilliam.Kucharski@Sun.COM\font\reducedi=cmmi10
1582*8044SWilliam.Kucharski@Sun.COM\font\reducedsy=cmsy10
1583*8044SWilliam.Kucharski@Sun.COM
1584*8044SWilliam.Kucharski@Sun.COM% In order for the font changes to affect most math symbols and letters,
1585*8044SWilliam.Kucharski@Sun.COM% we have to define the \textfont of the standard families.  Since
1586*8044SWilliam.Kucharski@Sun.COM% texinfo doesn't allow for producing subscripts and superscripts except
1587*8044SWilliam.Kucharski@Sun.COM% in the main text, we don't bother to reset \scriptfont and
1588*8044SWilliam.Kucharski@Sun.COM% \scriptscriptfont (which would also require loading a lot more fonts).
1589*8044SWilliam.Kucharski@Sun.COM%
1590*8044SWilliam.Kucharski@Sun.COM\def\resetmathfonts{%
1591*8044SWilliam.Kucharski@Sun.COM  \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1592*8044SWilliam.Kucharski@Sun.COM  \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1593*8044SWilliam.Kucharski@Sun.COM  \textfont\ttfam=\tentt \textfont\sffam=\tensf
1594*8044SWilliam.Kucharski@Sun.COM}
1595*8044SWilliam.Kucharski@Sun.COM
1596*8044SWilliam.Kucharski@Sun.COM% The font-changing commands redefine the meanings of \tenSTYLE, instead
1597*8044SWilliam.Kucharski@Sun.COM% of just \STYLE.  We do this because \STYLE needs to also set the
1598*8044SWilliam.Kucharski@Sun.COM% current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
1599*8044SWilliam.Kucharski@Sun.COM% \tenSTYLE to set the current font.
1600*8044SWilliam.Kucharski@Sun.COM%
1601*8044SWilliam.Kucharski@Sun.COM% Each font-changing command also sets the names \lsize (one size lower)
1602*8044SWilliam.Kucharski@Sun.COM% and \lllsize (three sizes lower).  These relative commands are used in
1603*8044SWilliam.Kucharski@Sun.COM% the LaTeX logo and acronyms.
1604*8044SWilliam.Kucharski@Sun.COM%
1605*8044SWilliam.Kucharski@Sun.COM% This all needs generalizing, badly.
1606*8044SWilliam.Kucharski@Sun.COM%
1607*8044SWilliam.Kucharski@Sun.COM\def\textfonts{%
1608*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1609*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1610*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1611*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\textttsl
1612*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{text}%
1613*8044SWilliam.Kucharski@Sun.COM  \def\lsize{reduced}\def\lllsize{smaller}%
1614*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{\textleading}}
1615*8044SWilliam.Kucharski@Sun.COM\def\titlefonts{%
1616*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1617*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1618*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1619*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\titlettsl
1620*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{title}%
1621*8044SWilliam.Kucharski@Sun.COM  \def\lsize{chap}\def\lllsize{subsec}%
1622*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{25pt}}
1623*8044SWilliam.Kucharski@Sun.COM\def\titlefont#1{{\titlefonts\rm #1}}
1624*8044SWilliam.Kucharski@Sun.COM\def\chapfonts{%
1625*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1626*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1627*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1628*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\chapttsl
1629*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{chap}%
1630*8044SWilliam.Kucharski@Sun.COM  \def\lsize{sec}\def\lllsize{text}%
1631*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{19pt}}
1632*8044SWilliam.Kucharski@Sun.COM\def\secfonts{%
1633*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1634*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1635*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1636*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\secttsl
1637*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{sec}%
1638*8044SWilliam.Kucharski@Sun.COM  \def\lsize{subsec}\def\lllsize{reduced}%
1639*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{16pt}}
1640*8044SWilliam.Kucharski@Sun.COM\def\subsecfonts{%
1641*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1642*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1643*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1644*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\ssecttsl
1645*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{ssec}%
1646*8044SWilliam.Kucharski@Sun.COM  \def\lsize{text}\def\lllsize{small}%
1647*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{15pt}}
1648*8044SWilliam.Kucharski@Sun.COM\let\subsubsecfonts = \subsecfonts
1649*8044SWilliam.Kucharski@Sun.COM\def\reducedfonts{%
1650*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1651*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1652*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1653*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\reducedttsl
1654*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{reduced}%
1655*8044SWilliam.Kucharski@Sun.COM  \def\lsize{small}\def\lllsize{smaller}%
1656*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{10.5pt}}
1657*8044SWilliam.Kucharski@Sun.COM\def\smallfonts{%
1658*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1659*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1660*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1661*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\smallttsl
1662*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{small}%
1663*8044SWilliam.Kucharski@Sun.COM  \def\lsize{smaller}\def\lllsize{smaller}%
1664*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{10.5pt}}
1665*8044SWilliam.Kucharski@Sun.COM\def\smallerfonts{%
1666*8044SWilliam.Kucharski@Sun.COM  \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1667*8044SWilliam.Kucharski@Sun.COM  \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1668*8044SWilliam.Kucharski@Sun.COM  \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1669*8044SWilliam.Kucharski@Sun.COM  \let\tenttsl=\smallerttsl
1670*8044SWilliam.Kucharski@Sun.COM  \def\curfontsize{smaller}%
1671*8044SWilliam.Kucharski@Sun.COM  \def\lsize{smaller}\def\lllsize{smaller}%
1672*8044SWilliam.Kucharski@Sun.COM  \resetmathfonts \setleading{9.5pt}}
1673*8044SWilliam.Kucharski@Sun.COM
1674*8044SWilliam.Kucharski@Sun.COM% Set the fonts to use with the @small... environments.
1675*8044SWilliam.Kucharski@Sun.COM\let\smallexamplefonts = \smallfonts
1676*8044SWilliam.Kucharski@Sun.COM
1677*8044SWilliam.Kucharski@Sun.COM% About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
1678*8044SWilliam.Kucharski@Sun.COM% can fit this many characters:
1679*8044SWilliam.Kucharski@Sun.COM%   8.5x11=86   smallbook=72  a4=90  a5=69
1680*8044SWilliam.Kucharski@Sun.COM% If we use \scriptfonts (8pt), then we can fit this many characters:
1681*8044SWilliam.Kucharski@Sun.COM%   8.5x11=90+  smallbook=80  a4=90+  a5=77
1682*8044SWilliam.Kucharski@Sun.COM% For me, subjectively, the few extra characters that fit aren't worth
1683*8044SWilliam.Kucharski@Sun.COM% the additional smallness of 8pt.  So I'm making the default 9pt.
1684*8044SWilliam.Kucharski@Sun.COM%
1685*8044SWilliam.Kucharski@Sun.COM% By the way, for comparison, here's what fits with @example (10pt):
1686*8044SWilliam.Kucharski@Sun.COM%   8.5x11=71  smallbook=60  a4=75  a5=58
1687*8044SWilliam.Kucharski@Sun.COM%
1688*8044SWilliam.Kucharski@Sun.COM% I wish the USA used A4 paper.
1689*8044SWilliam.Kucharski@Sun.COM% --karl, 24jan03.
1690*8044SWilliam.Kucharski@Sun.COM
1691*8044SWilliam.Kucharski@Sun.COM
1692*8044SWilliam.Kucharski@Sun.COM% Set up the default fonts, so we can use them for creating boxes.
1693*8044SWilliam.Kucharski@Sun.COM%
1694*8044SWilliam.Kucharski@Sun.COM\textfonts \rm
1695*8044SWilliam.Kucharski@Sun.COM
1696*8044SWilliam.Kucharski@Sun.COM% Define these so they can be easily changed for other fonts.
1697*8044SWilliam.Kucharski@Sun.COM\def\angleleft{$\langle$}
1698*8044SWilliam.Kucharski@Sun.COM\def\angleright{$\rangle$}
1699*8044SWilliam.Kucharski@Sun.COM
1700*8044SWilliam.Kucharski@Sun.COM% Count depth in font-changes, for error checks
1701*8044SWilliam.Kucharski@Sun.COM\newcount\fontdepth \fontdepth=0
1702*8044SWilliam.Kucharski@Sun.COM
1703*8044SWilliam.Kucharski@Sun.COM% Fonts for short table of contents.
1704*8044SWilliam.Kucharski@Sun.COM\setfont\shortcontrm\rmshape{12}{1000}
1705*8044SWilliam.Kucharski@Sun.COM\setfont\shortcontbf\bfshape{10}{\magstep1}  % no cmb12
1706*8044SWilliam.Kucharski@Sun.COM\setfont\shortcontsl\slshape{12}{1000}
1707*8044SWilliam.Kucharski@Sun.COM\setfont\shortconttt\ttshape{12}{1000}
1708*8044SWilliam.Kucharski@Sun.COM
1709*8044SWilliam.Kucharski@Sun.COM%% Add scribe-like font environments, plus @l for inline lisp (usually sans
1710*8044SWilliam.Kucharski@Sun.COM%% serif) and @ii for TeX italic
1711*8044SWilliam.Kucharski@Sun.COM
1712*8044SWilliam.Kucharski@Sun.COM% \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1713*8044SWilliam.Kucharski@Sun.COM% unless the following character is such as not to need one.
1714*8044SWilliam.Kucharski@Sun.COM\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1715*8044SWilliam.Kucharski@Sun.COM                    \ptexslash\fi\fi\fi}
1716*8044SWilliam.Kucharski@Sun.COM\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1717*8044SWilliam.Kucharski@Sun.COM\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1718*8044SWilliam.Kucharski@Sun.COM
1719*8044SWilliam.Kucharski@Sun.COM% like \smartslanted except unconditionally uses \ttsl.
1720*8044SWilliam.Kucharski@Sun.COM% @var is set to this for defun arguments.
1721*8044SWilliam.Kucharski@Sun.COM\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1722*8044SWilliam.Kucharski@Sun.COM
1723*8044SWilliam.Kucharski@Sun.COM% like \smartslanted except unconditionally use \sl.  We never want
1724*8044SWilliam.Kucharski@Sun.COM% ttsl for book titles, do we?
1725*8044SWilliam.Kucharski@Sun.COM\def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1726*8044SWilliam.Kucharski@Sun.COM
1727*8044SWilliam.Kucharski@Sun.COM\let\i=\smartitalic
1728*8044SWilliam.Kucharski@Sun.COM\let\slanted=\smartslanted
1729*8044SWilliam.Kucharski@Sun.COM\let\var=\smartslanted
1730*8044SWilliam.Kucharski@Sun.COM\let\dfn=\smartslanted
1731*8044SWilliam.Kucharski@Sun.COM\let\emph=\smartitalic
1732*8044SWilliam.Kucharski@Sun.COM
1733*8044SWilliam.Kucharski@Sun.COM% @b, explicit bold.
1734*8044SWilliam.Kucharski@Sun.COM\def\b#1{{\bf #1}}
1735*8044SWilliam.Kucharski@Sun.COM\let\strong=\b
1736*8044SWilliam.Kucharski@Sun.COM
1737*8044SWilliam.Kucharski@Sun.COM% @sansserif, explicit sans.
1738*8044SWilliam.Kucharski@Sun.COM\def\sansserif#1{{\sf #1}}
1739*8044SWilliam.Kucharski@Sun.COM
1740*8044SWilliam.Kucharski@Sun.COM% We can't just use \exhyphenpenalty, because that only has effect at
1741*8044SWilliam.Kucharski@Sun.COM% the end of a paragraph.  Restore normal hyphenation at the end of the
1742*8044SWilliam.Kucharski@Sun.COM% group within which \nohyphenation is presumably called.
1743*8044SWilliam.Kucharski@Sun.COM%
1744*8044SWilliam.Kucharski@Sun.COM\def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
1745*8044SWilliam.Kucharski@Sun.COM\def\restorehyphenation{\hyphenchar\font = `- }
1746*8044SWilliam.Kucharski@Sun.COM
1747*8044SWilliam.Kucharski@Sun.COM% Set sfcode to normal for the chars that usually have another value.
1748*8044SWilliam.Kucharski@Sun.COM% Can't use plain's \frenchspacing because it uses the `\x notation, and
1749*8044SWilliam.Kucharski@Sun.COM% sometimes \x has an active definition that messes things up.
1750*8044SWilliam.Kucharski@Sun.COM%
1751*8044SWilliam.Kucharski@Sun.COM\catcode`@=11
1752*8044SWilliam.Kucharski@Sun.COM  \def\frenchspacing{%
1753*8044SWilliam.Kucharski@Sun.COM    \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1754*8044SWilliam.Kucharski@Sun.COM    \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1755*8044SWilliam.Kucharski@Sun.COM  }
1756*8044SWilliam.Kucharski@Sun.COM\catcode`@=\other
1757*8044SWilliam.Kucharski@Sun.COM
1758*8044SWilliam.Kucharski@Sun.COM\def\t#1{%
1759*8044SWilliam.Kucharski@Sun.COM  {\tt \rawbackslash \frenchspacing #1}%
1760*8044SWilliam.Kucharski@Sun.COM  \null
1761*8044SWilliam.Kucharski@Sun.COM}
1762*8044SWilliam.Kucharski@Sun.COM\def\samp#1{`\tclose{#1}'\null}
1763*8044SWilliam.Kucharski@Sun.COM\setfont\keyrm\rmshape{8}{1000}
1764*8044SWilliam.Kucharski@Sun.COM\font\keysy=cmsy9
1765*8044SWilliam.Kucharski@Sun.COM\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1766*8044SWilliam.Kucharski@Sun.COM  \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1767*8044SWilliam.Kucharski@Sun.COM    \vbox{\hrule\kern-0.4pt
1768*8044SWilliam.Kucharski@Sun.COM     \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1769*8044SWilliam.Kucharski@Sun.COM    \kern-0.4pt\hrule}%
1770*8044SWilliam.Kucharski@Sun.COM  \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1771*8044SWilliam.Kucharski@Sun.COM% The old definition, with no lozenge:
1772*8044SWilliam.Kucharski@Sun.COM%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1773*8044SWilliam.Kucharski@Sun.COM\def\ctrl #1{{\tt \rawbackslash \hat}#1}
1774*8044SWilliam.Kucharski@Sun.COM
1775*8044SWilliam.Kucharski@Sun.COM% @file, @option are the same as @samp.
1776*8044SWilliam.Kucharski@Sun.COM\let\file=\samp
1777*8044SWilliam.Kucharski@Sun.COM\let\option=\samp
1778*8044SWilliam.Kucharski@Sun.COM
1779*8044SWilliam.Kucharski@Sun.COM% @code is a modification of @t,
1780*8044SWilliam.Kucharski@Sun.COM% which makes spaces the same size as normal in the surrounding text.
1781*8044SWilliam.Kucharski@Sun.COM\def\tclose#1{%
1782*8044SWilliam.Kucharski@Sun.COM  {%
1783*8044SWilliam.Kucharski@Sun.COM    % Change normal interword space to be same as for the current font.
1784*8044SWilliam.Kucharski@Sun.COM    \spaceskip = \fontdimen2\font
1785*8044SWilliam.Kucharski@Sun.COM    %
1786*8044SWilliam.Kucharski@Sun.COM    % Switch to typewriter.
1787*8044SWilliam.Kucharski@Sun.COM    \tt
1788*8044SWilliam.Kucharski@Sun.COM    %
1789*8044SWilliam.Kucharski@Sun.COM    % But `\ ' produces the large typewriter interword space.
1790*8044SWilliam.Kucharski@Sun.COM    \def\ {{\spaceskip = 0pt{} }}%
1791*8044SWilliam.Kucharski@Sun.COM    %
1792*8044SWilliam.Kucharski@Sun.COM    % Turn off hyphenation.
1793*8044SWilliam.Kucharski@Sun.COM    \nohyphenation
1794*8044SWilliam.Kucharski@Sun.COM    %
1795*8044SWilliam.Kucharski@Sun.COM    \rawbackslash
1796*8044SWilliam.Kucharski@Sun.COM    \frenchspacing
1797*8044SWilliam.Kucharski@Sun.COM    #1%
1798*8044SWilliam.Kucharski@Sun.COM  }%
1799*8044SWilliam.Kucharski@Sun.COM  \null
1800*8044SWilliam.Kucharski@Sun.COM}
1801*8044SWilliam.Kucharski@Sun.COM
1802*8044SWilliam.Kucharski@Sun.COM% We *must* turn on hyphenation at `-' and `_' in @code.
1803*8044SWilliam.Kucharski@Sun.COM% Otherwise, it is too hard to avoid overfull hboxes
1804*8044SWilliam.Kucharski@Sun.COM% in the Emacs manual, the Library manual, etc.
1805*8044SWilliam.Kucharski@Sun.COM
1806*8044SWilliam.Kucharski@Sun.COM% Unfortunately, TeX uses one parameter (\hyphenchar) to control
1807*8044SWilliam.Kucharski@Sun.COM% both hyphenation at - and hyphenation within words.
1808*8044SWilliam.Kucharski@Sun.COM% We must therefore turn them both off (\tclose does that)
1809*8044SWilliam.Kucharski@Sun.COM% and arrange explicitly to hyphenate at a dash.
1810*8044SWilliam.Kucharski@Sun.COM%  -- rms.
1811*8044SWilliam.Kucharski@Sun.COM{
1812*8044SWilliam.Kucharski@Sun.COM  \catcode`\-=\active
1813*8044SWilliam.Kucharski@Sun.COM  \catcode`\_=\active
1814*8044SWilliam.Kucharski@Sun.COM  %
1815*8044SWilliam.Kucharski@Sun.COM  \global\def\code{\begingroup
1816*8044SWilliam.Kucharski@Sun.COM    \catcode`\-=\active \let-\codedash
1817*8044SWilliam.Kucharski@Sun.COM    \catcode`\_=\active \let_\codeunder
1818*8044SWilliam.Kucharski@Sun.COM    \codex
1819*8044SWilliam.Kucharski@Sun.COM  }
1820*8044SWilliam.Kucharski@Sun.COM}
1821*8044SWilliam.Kucharski@Sun.COM
1822*8044SWilliam.Kucharski@Sun.COM\def\realdash{-}
1823*8044SWilliam.Kucharski@Sun.COM\def\codedash{-\discretionary{}{}{}}
1824*8044SWilliam.Kucharski@Sun.COM\def\codeunder{%
1825*8044SWilliam.Kucharski@Sun.COM  % this is all so @math{@code{var_name}+1} can work.  In math mode, _
1826*8044SWilliam.Kucharski@Sun.COM  % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1827*8044SWilliam.Kucharski@Sun.COM  % will therefore expand the active definition of _, which is us
1828*8044SWilliam.Kucharski@Sun.COM  % (inside @code that is), therefore an endless loop.
1829*8044SWilliam.Kucharski@Sun.COM  \ifusingtt{\ifmmode
1830*8044SWilliam.Kucharski@Sun.COM               \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1831*8044SWilliam.Kucharski@Sun.COM             \else\normalunderscore \fi
1832*8044SWilliam.Kucharski@Sun.COM             \discretionary{}{}{}}%
1833*8044SWilliam.Kucharski@Sun.COM            {\_}%
1834*8044SWilliam.Kucharski@Sun.COM}
1835*8044SWilliam.Kucharski@Sun.COM\def\codex #1{\tclose{#1}\endgroup}
1836*8044SWilliam.Kucharski@Sun.COM
1837*8044SWilliam.Kucharski@Sun.COM% @kbd is like @code, except that if the argument is just one @key command,
1838*8044SWilliam.Kucharski@Sun.COM% then @kbd has no effect.
1839*8044SWilliam.Kucharski@Sun.COM
1840*8044SWilliam.Kucharski@Sun.COM% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1841*8044SWilliam.Kucharski@Sun.COM%   `example' (@kbd uses ttsl only inside of @example and friends),
1842*8044SWilliam.Kucharski@Sun.COM%   or `code' (@kbd uses normal tty font always).
1843*8044SWilliam.Kucharski@Sun.COM\parseargdef\kbdinputstyle{%
1844*8044SWilliam.Kucharski@Sun.COM  \def\arg{#1}%
1845*8044SWilliam.Kucharski@Sun.COM  \ifx\arg\worddistinct
1846*8044SWilliam.Kucharski@Sun.COM    \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1847*8044SWilliam.Kucharski@Sun.COM  \else\ifx\arg\wordexample
1848*8044SWilliam.Kucharski@Sun.COM    \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1849*8044SWilliam.Kucharski@Sun.COM  \else\ifx\arg\wordcode
1850*8044SWilliam.Kucharski@Sun.COM    \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1851*8044SWilliam.Kucharski@Sun.COM  \else
1852*8044SWilliam.Kucharski@Sun.COM    \errhelp = \EMsimple
1853*8044SWilliam.Kucharski@Sun.COM    \errmessage{Unknown @kbdinputstyle option `\arg'}%
1854*8044SWilliam.Kucharski@Sun.COM  \fi\fi\fi
1855*8044SWilliam.Kucharski@Sun.COM}
1856*8044SWilliam.Kucharski@Sun.COM\def\worddistinct{distinct}
1857*8044SWilliam.Kucharski@Sun.COM\def\wordexample{example}
1858*8044SWilliam.Kucharski@Sun.COM\def\wordcode{code}
1859*8044SWilliam.Kucharski@Sun.COM
1860*8044SWilliam.Kucharski@Sun.COM% Default is `distinct.'
1861*8044SWilliam.Kucharski@Sun.COM\kbdinputstyle distinct
1862*8044SWilliam.Kucharski@Sun.COM
1863*8044SWilliam.Kucharski@Sun.COM\def\xkey{\key}
1864*8044SWilliam.Kucharski@Sun.COM\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1865*8044SWilliam.Kucharski@Sun.COM\ifx\one\xkey\ifx\threex\three \key{#2}%
1866*8044SWilliam.Kucharski@Sun.COM\else{\tclose{\kbdfont\look}}\fi
1867*8044SWilliam.Kucharski@Sun.COM\else{\tclose{\kbdfont\look}}\fi}
1868*8044SWilliam.Kucharski@Sun.COM
1869*8044SWilliam.Kucharski@Sun.COM% For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1870*8044SWilliam.Kucharski@Sun.COM\let\indicateurl=\code
1871*8044SWilliam.Kucharski@Sun.COM\let\env=\code
1872*8044SWilliam.Kucharski@Sun.COM\let\command=\code
1873*8044SWilliam.Kucharski@Sun.COM
1874*8044SWilliam.Kucharski@Sun.COM% @uref (abbreviation for `urlref') takes an optional (comma-separated)
1875*8044SWilliam.Kucharski@Sun.COM% second argument specifying the text to display and an optional third
1876*8044SWilliam.Kucharski@Sun.COM% arg as text to display instead of (rather than in addition to) the url
1877*8044SWilliam.Kucharski@Sun.COM% itself.  First (mandatory) arg is the url.  Perhaps eventually put in
1878*8044SWilliam.Kucharski@Sun.COM% a hypertex \special here.
1879*8044SWilliam.Kucharski@Sun.COM%
1880*8044SWilliam.Kucharski@Sun.COM\def\uref#1{\douref #1,,,\finish}
1881*8044SWilliam.Kucharski@Sun.COM\def\douref#1,#2,#3,#4\finish{\begingroup
1882*8044SWilliam.Kucharski@Sun.COM  \unsepspaces
1883*8044SWilliam.Kucharski@Sun.COM  \pdfurl{#1}%
1884*8044SWilliam.Kucharski@Sun.COM  \setbox0 = \hbox{\ignorespaces #3}%
1885*8044SWilliam.Kucharski@Sun.COM  \ifdim\wd0 > 0pt
1886*8044SWilliam.Kucharski@Sun.COM    \unhbox0 % third arg given, show only that
1887*8044SWilliam.Kucharski@Sun.COM  \else
1888*8044SWilliam.Kucharski@Sun.COM    \setbox0 = \hbox{\ignorespaces #2}%
1889*8044SWilliam.Kucharski@Sun.COM    \ifdim\wd0 > 0pt
1890*8044SWilliam.Kucharski@Sun.COM      \ifpdf
1891*8044SWilliam.Kucharski@Sun.COM        \unhbox0             % PDF: 2nd arg given, show only it
1892*8044SWilliam.Kucharski@Sun.COM      \else
1893*8044SWilliam.Kucharski@Sun.COM        \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1894*8044SWilliam.Kucharski@Sun.COM      \fi
1895*8044SWilliam.Kucharski@Sun.COM    \else
1896*8044SWilliam.Kucharski@Sun.COM      \code{#1}% only url given, so show it
1897*8044SWilliam.Kucharski@Sun.COM    \fi
1898*8044SWilliam.Kucharski@Sun.COM  \fi
1899*8044SWilliam.Kucharski@Sun.COM  \endlink
1900*8044SWilliam.Kucharski@Sun.COM\endgroup}
1901*8044SWilliam.Kucharski@Sun.COM
1902*8044SWilliam.Kucharski@Sun.COM% @url synonym for @uref, since that's how everyone uses it.
1903*8044SWilliam.Kucharski@Sun.COM%
1904*8044SWilliam.Kucharski@Sun.COM\let\url=\uref
1905*8044SWilliam.Kucharski@Sun.COM
1906*8044SWilliam.Kucharski@Sun.COM% rms does not like angle brackets --karl, 17may97.
1907*8044SWilliam.Kucharski@Sun.COM% So now @email is just like @uref, unless we are pdf.
1908*8044SWilliam.Kucharski@Sun.COM%
1909*8044SWilliam.Kucharski@Sun.COM%\def\email#1{\angleleft{\tt #1}\angleright}
1910*8044SWilliam.Kucharski@Sun.COM\ifpdf
1911*8044SWilliam.Kucharski@Sun.COM  \def\email#1{\doemail#1,,\finish}
1912*8044SWilliam.Kucharski@Sun.COM  \def\doemail#1,#2,#3\finish{\begingroup
1913*8044SWilliam.Kucharski@Sun.COM    \unsepspaces
1914*8044SWilliam.Kucharski@Sun.COM    \pdfurl{mailto:#1}%
1915*8044SWilliam.Kucharski@Sun.COM    \setbox0 = \hbox{\ignorespaces #2}%
1916*8044SWilliam.Kucharski@Sun.COM    \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1917*8044SWilliam.Kucharski@Sun.COM    \endlink
1918*8044SWilliam.Kucharski@Sun.COM  \endgroup}
1919*8044SWilliam.Kucharski@Sun.COM\else
1920*8044SWilliam.Kucharski@Sun.COM  \let\email=\uref
1921*8044SWilliam.Kucharski@Sun.COM\fi
1922*8044SWilliam.Kucharski@Sun.COM
1923*8044SWilliam.Kucharski@Sun.COM% Check if we are currently using a typewriter font.  Since all the
1924*8044SWilliam.Kucharski@Sun.COM% Computer Modern typewriter fonts have zero interword stretch (and
1925*8044SWilliam.Kucharski@Sun.COM% shrink), and it is reasonable to expect all typewriter fonts to have
1926*8044SWilliam.Kucharski@Sun.COM% this property, we can check that font parameter.
1927*8044SWilliam.Kucharski@Sun.COM%
1928*8044SWilliam.Kucharski@Sun.COM\def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1929*8044SWilliam.Kucharski@Sun.COM
1930*8044SWilliam.Kucharski@Sun.COM% Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
1931*8044SWilliam.Kucharski@Sun.COM% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1932*8044SWilliam.Kucharski@Sun.COM%
1933*8044SWilliam.Kucharski@Sun.COM\def\dmn#1{\thinspace #1}
1934*8044SWilliam.Kucharski@Sun.COM
1935*8044SWilliam.Kucharski@Sun.COM\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1936*8044SWilliam.Kucharski@Sun.COM
1937*8044SWilliam.Kucharski@Sun.COM% @l was never documented to mean ``switch to the Lisp font'',
1938*8044SWilliam.Kucharski@Sun.COM% and it is not used as such in any manual I can find.  We need it for
1939*8044SWilliam.Kucharski@Sun.COM% Polish suppressed-l.  --karl, 22sep96.
1940*8044SWilliam.Kucharski@Sun.COM%\def\l#1{{\li #1}\null}
1941*8044SWilliam.Kucharski@Sun.COM
1942*8044SWilliam.Kucharski@Sun.COM% Explicit font changes: @r, @sc, undocumented @ii.
1943*8044SWilliam.Kucharski@Sun.COM\def\r#1{{\rm #1}}              % roman font
1944*8044SWilliam.Kucharski@Sun.COM\def\sc#1{{\smallcaps#1}}       % smallcaps font
1945*8044SWilliam.Kucharski@Sun.COM\def\ii#1{{\it #1}}             % italic font
1946*8044SWilliam.Kucharski@Sun.COM
1947*8044SWilliam.Kucharski@Sun.COM% @acronym for "FBI", "NATO", and the like.
1948*8044SWilliam.Kucharski@Sun.COM% We print this one point size smaller, since it's intended for
1949*8044SWilliam.Kucharski@Sun.COM% all-uppercase.
1950*8044SWilliam.Kucharski@Sun.COM%
1951*8044SWilliam.Kucharski@Sun.COM\def\acronym#1{\doacronym #1,,\finish}
1952*8044SWilliam.Kucharski@Sun.COM\def\doacronym#1,#2,#3\finish{%
1953*8044SWilliam.Kucharski@Sun.COM  {\selectfonts\lsize #1}%
1954*8044SWilliam.Kucharski@Sun.COM  \def\temp{#2}%
1955*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\empty \else
1956*8044SWilliam.Kucharski@Sun.COM    \space ({\unsepspaces \ignorespaces \temp \unskip})%
1957*8044SWilliam.Kucharski@Sun.COM  \fi
1958*8044SWilliam.Kucharski@Sun.COM}
1959*8044SWilliam.Kucharski@Sun.COM
1960*8044SWilliam.Kucharski@Sun.COM% @abbr for "Comput. J." and the like.
1961*8044SWilliam.Kucharski@Sun.COM% No font change, but don't do end-of-sentence spacing.
1962*8044SWilliam.Kucharski@Sun.COM%
1963*8044SWilliam.Kucharski@Sun.COM\def\abbr#1{\doabbr #1,,\finish}
1964*8044SWilliam.Kucharski@Sun.COM\def\doabbr#1,#2,#3\finish{%
1965*8044SWilliam.Kucharski@Sun.COM  {\frenchspacing #1}%
1966*8044SWilliam.Kucharski@Sun.COM  \def\temp{#2}%
1967*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\empty \else
1968*8044SWilliam.Kucharski@Sun.COM    \space ({\unsepspaces \ignorespaces \temp \unskip})%
1969*8044SWilliam.Kucharski@Sun.COM  \fi
1970*8044SWilliam.Kucharski@Sun.COM}
1971*8044SWilliam.Kucharski@Sun.COM
1972*8044SWilliam.Kucharski@Sun.COM% @pounds{} is a sterling sign, which Knuth put in the CM italic font.
1973*8044SWilliam.Kucharski@Sun.COM%
1974*8044SWilliam.Kucharski@Sun.COM\def\pounds{{\it\$}}
1975*8044SWilliam.Kucharski@Sun.COM
1976*8044SWilliam.Kucharski@Sun.COM% @euro{} comes from a separate font, depending on the current style.
1977*8044SWilliam.Kucharski@Sun.COM% We use the free feym* fonts from the eurosym package by Henrik
1978*8044SWilliam.Kucharski@Sun.COM% Theiling, which support regular, slanted, bold and bold slanted (and
1979*8044SWilliam.Kucharski@Sun.COM% "outlined" (blackboard board, sort of) versions, which we don't need).
1980*8044SWilliam.Kucharski@Sun.COM% It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
1981*8044SWilliam.Kucharski@Sun.COM%
1982*8044SWilliam.Kucharski@Sun.COM% Although only regular is the truly official Euro symbol, we ignore
1983*8044SWilliam.Kucharski@Sun.COM% that.  The Euro is designed to be slightly taller than the regular
1984*8044SWilliam.Kucharski@Sun.COM% font height.
1985*8044SWilliam.Kucharski@Sun.COM%
1986*8044SWilliam.Kucharski@Sun.COM% feymr - regular
1987*8044SWilliam.Kucharski@Sun.COM% feymo - slanted
1988*8044SWilliam.Kucharski@Sun.COM% feybr - bold
1989*8044SWilliam.Kucharski@Sun.COM% feybo - bold slanted
1990*8044SWilliam.Kucharski@Sun.COM%
1991*8044SWilliam.Kucharski@Sun.COM% There is no good (free) typewriter version, to my knowledge.
1992*8044SWilliam.Kucharski@Sun.COM% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
1993*8044SWilliam.Kucharski@Sun.COM% Hmm.
1994*8044SWilliam.Kucharski@Sun.COM%
1995*8044SWilliam.Kucharski@Sun.COM% Also doesn't work in math.  Do we need to do math with euro symbols?
1996*8044SWilliam.Kucharski@Sun.COM% Hope not.
1997*8044SWilliam.Kucharski@Sun.COM%
1998*8044SWilliam.Kucharski@Sun.COM%
1999*8044SWilliam.Kucharski@Sun.COM\def\euro{{\eurofont e}}
2000*8044SWilliam.Kucharski@Sun.COM\def\eurofont{%
2001*8044SWilliam.Kucharski@Sun.COM  % We set the font at each command, rather than predefining it in
2002*8044SWilliam.Kucharski@Sun.COM  % \textfonts and the other font-switching commands, so that
2003*8044SWilliam.Kucharski@Sun.COM  % installations which never need the symbold don't have to have the
2004*8044SWilliam.Kucharski@Sun.COM  % font installed.
2005*8044SWilliam.Kucharski@Sun.COM  %
2006*8044SWilliam.Kucharski@Sun.COM  % There is only one designed size (nominal 10pt), so we always scale
2007*8044SWilliam.Kucharski@Sun.COM  % that to the current nominal size.
2008*8044SWilliam.Kucharski@Sun.COM  %
2009*8044SWilliam.Kucharski@Sun.COM  % By the way, simply using "at 1em" works for cmr10 and the like, but
2010*8044SWilliam.Kucharski@Sun.COM  % does not work for cmbx10 and other extended/shrunken fonts.
2011*8044SWilliam.Kucharski@Sun.COM  %
2012*8044SWilliam.Kucharski@Sun.COM  \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2013*8044SWilliam.Kucharski@Sun.COM  %
2014*8044SWilliam.Kucharski@Sun.COM  \ifx\curfontstyle\bfstylename
2015*8044SWilliam.Kucharski@Sun.COM    % bold:
2016*8044SWilliam.Kucharski@Sun.COM    \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2017*8044SWilliam.Kucharski@Sun.COM  \else
2018*8044SWilliam.Kucharski@Sun.COM    % regular:
2019*8044SWilliam.Kucharski@Sun.COM    \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2020*8044SWilliam.Kucharski@Sun.COM  \fi
2021*8044SWilliam.Kucharski@Sun.COM  \thiseurofont
2022*8044SWilliam.Kucharski@Sun.COM}
2023*8044SWilliam.Kucharski@Sun.COM
2024*8044SWilliam.Kucharski@Sun.COM% @registeredsymbol - R in a circle.  The font for the R should really
2025*8044SWilliam.Kucharski@Sun.COM% be smaller yet, but lllsize is the best we can do for now.
2026*8044SWilliam.Kucharski@Sun.COM% Adapted from the plain.tex definition of \copyright.
2027*8044SWilliam.Kucharski@Sun.COM%
2028*8044SWilliam.Kucharski@Sun.COM\def\registeredsymbol{%
2029*8044SWilliam.Kucharski@Sun.COM  $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2030*8044SWilliam.Kucharski@Sun.COM               \hfil\crcr\Orb}}%
2031*8044SWilliam.Kucharski@Sun.COM    }$%
2032*8044SWilliam.Kucharski@Sun.COM}
2033*8044SWilliam.Kucharski@Sun.COM
2034*8044SWilliam.Kucharski@Sun.COM% Laurent Siebenmann reports \Orb undefined with:
2035*8044SWilliam.Kucharski@Sun.COM%  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
2036*8044SWilliam.Kucharski@Sun.COM% so we'll define it if necessary.
2037*8044SWilliam.Kucharski@Sun.COM%
2038*8044SWilliam.Kucharski@Sun.COM\ifx\Orb\undefined
2039*8044SWilliam.Kucharski@Sun.COM\def\Orb{\mathhexbox20D}
2040*8044SWilliam.Kucharski@Sun.COM\fi
2041*8044SWilliam.Kucharski@Sun.COM
2042*8044SWilliam.Kucharski@Sun.COM
2043*8044SWilliam.Kucharski@Sun.COM\message{page headings,}
2044*8044SWilliam.Kucharski@Sun.COM
2045*8044SWilliam.Kucharski@Sun.COM\newskip\titlepagetopglue \titlepagetopglue = 1.5in
2046*8044SWilliam.Kucharski@Sun.COM\newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2047*8044SWilliam.Kucharski@Sun.COM
2048*8044SWilliam.Kucharski@Sun.COM% First the title page.  Must do @settitle before @titlepage.
2049*8044SWilliam.Kucharski@Sun.COM\newif\ifseenauthor
2050*8044SWilliam.Kucharski@Sun.COM\newif\iffinishedtitlepage
2051*8044SWilliam.Kucharski@Sun.COM
2052*8044SWilliam.Kucharski@Sun.COM% Do an implicit @contents or @shortcontents after @end titlepage if the
2053*8044SWilliam.Kucharski@Sun.COM% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2054*8044SWilliam.Kucharski@Sun.COM%
2055*8044SWilliam.Kucharski@Sun.COM\newif\ifsetcontentsaftertitlepage
2056*8044SWilliam.Kucharski@Sun.COM \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2057*8044SWilliam.Kucharski@Sun.COM\newif\ifsetshortcontentsaftertitlepage
2058*8044SWilliam.Kucharski@Sun.COM \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2059*8044SWilliam.Kucharski@Sun.COM
2060*8044SWilliam.Kucharski@Sun.COM\parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2061*8044SWilliam.Kucharski@Sun.COM        \endgroup\page\hbox{}\page}
2062*8044SWilliam.Kucharski@Sun.COM
2063*8044SWilliam.Kucharski@Sun.COM\envdef\titlepage{%
2064*8044SWilliam.Kucharski@Sun.COM  % Open one extra group, as we want to close it in the middle of \Etitlepage.
2065*8044SWilliam.Kucharski@Sun.COM  \begingroup
2066*8044SWilliam.Kucharski@Sun.COM    \parindent=0pt \textfonts
2067*8044SWilliam.Kucharski@Sun.COM    % Leave some space at the very top of the page.
2068*8044SWilliam.Kucharski@Sun.COM    \vglue\titlepagetopglue
2069*8044SWilliam.Kucharski@Sun.COM    % No rule at page bottom unless we print one at the top with @title.
2070*8044SWilliam.Kucharski@Sun.COM    \finishedtitlepagetrue
2071*8044SWilliam.Kucharski@Sun.COM    %
2072*8044SWilliam.Kucharski@Sun.COM    % Most title ``pages'' are actually two pages long, with space
2073*8044SWilliam.Kucharski@Sun.COM    % at the top of the second.  We don't want the ragged left on the second.
2074*8044SWilliam.Kucharski@Sun.COM    \let\oldpage = \page
2075*8044SWilliam.Kucharski@Sun.COM    \def\page{%
2076*8044SWilliam.Kucharski@Sun.COM      \iffinishedtitlepage\else
2077*8044SWilliam.Kucharski@Sun.COM	 \finishtitlepage
2078*8044SWilliam.Kucharski@Sun.COM      \fi
2079*8044SWilliam.Kucharski@Sun.COM      \let\page = \oldpage
2080*8044SWilliam.Kucharski@Sun.COM      \page
2081*8044SWilliam.Kucharski@Sun.COM      \null
2082*8044SWilliam.Kucharski@Sun.COM    }%
2083*8044SWilliam.Kucharski@Sun.COM}
2084*8044SWilliam.Kucharski@Sun.COM
2085*8044SWilliam.Kucharski@Sun.COM\def\Etitlepage{%
2086*8044SWilliam.Kucharski@Sun.COM    \iffinishedtitlepage\else
2087*8044SWilliam.Kucharski@Sun.COM	\finishtitlepage
2088*8044SWilliam.Kucharski@Sun.COM    \fi
2089*8044SWilliam.Kucharski@Sun.COM    % It is important to do the page break before ending the group,
2090*8044SWilliam.Kucharski@Sun.COM    % because the headline and footline are only empty inside the group.
2091*8044SWilliam.Kucharski@Sun.COM    % If we use the new definition of \page, we always get a blank page
2092*8044SWilliam.Kucharski@Sun.COM    % after the title page, which we certainly don't want.
2093*8044SWilliam.Kucharski@Sun.COM    \oldpage
2094*8044SWilliam.Kucharski@Sun.COM  \endgroup
2095*8044SWilliam.Kucharski@Sun.COM  %
2096*8044SWilliam.Kucharski@Sun.COM  % Need this before the \...aftertitlepage checks so that if they are
2097*8044SWilliam.Kucharski@Sun.COM  % in effect the toc pages will come out with page numbers.
2098*8044SWilliam.Kucharski@Sun.COM  \HEADINGSon
2099*8044SWilliam.Kucharski@Sun.COM  %
2100*8044SWilliam.Kucharski@Sun.COM  % If they want short, they certainly want long too.
2101*8044SWilliam.Kucharski@Sun.COM  \ifsetshortcontentsaftertitlepage
2102*8044SWilliam.Kucharski@Sun.COM    \shortcontents
2103*8044SWilliam.Kucharski@Sun.COM    \contents
2104*8044SWilliam.Kucharski@Sun.COM    \global\let\shortcontents = \relax
2105*8044SWilliam.Kucharski@Sun.COM    \global\let\contents = \relax
2106*8044SWilliam.Kucharski@Sun.COM  \fi
2107*8044SWilliam.Kucharski@Sun.COM  %
2108*8044SWilliam.Kucharski@Sun.COM  \ifsetcontentsaftertitlepage
2109*8044SWilliam.Kucharski@Sun.COM    \contents
2110*8044SWilliam.Kucharski@Sun.COM    \global\let\contents = \relax
2111*8044SWilliam.Kucharski@Sun.COM    \global\let\shortcontents = \relax
2112*8044SWilliam.Kucharski@Sun.COM  \fi
2113*8044SWilliam.Kucharski@Sun.COM}
2114*8044SWilliam.Kucharski@Sun.COM
2115*8044SWilliam.Kucharski@Sun.COM\def\finishtitlepage{%
2116*8044SWilliam.Kucharski@Sun.COM  \vskip4pt \hrule height 2pt width \hsize
2117*8044SWilliam.Kucharski@Sun.COM  \vskip\titlepagebottomglue
2118*8044SWilliam.Kucharski@Sun.COM  \finishedtitlepagetrue
2119*8044SWilliam.Kucharski@Sun.COM}
2120*8044SWilliam.Kucharski@Sun.COM
2121*8044SWilliam.Kucharski@Sun.COM%%% Macros to be used within @titlepage:
2122*8044SWilliam.Kucharski@Sun.COM
2123*8044SWilliam.Kucharski@Sun.COM\let\subtitlerm=\tenrm
2124*8044SWilliam.Kucharski@Sun.COM\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2125*8044SWilliam.Kucharski@Sun.COM
2126*8044SWilliam.Kucharski@Sun.COM\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2127*8044SWilliam.Kucharski@Sun.COM		\let\tt=\authortt}
2128*8044SWilliam.Kucharski@Sun.COM
2129*8044SWilliam.Kucharski@Sun.COM\parseargdef\title{%
2130*8044SWilliam.Kucharski@Sun.COM  \checkenv\titlepage
2131*8044SWilliam.Kucharski@Sun.COM  \leftline{\titlefonts\rm #1}
2132*8044SWilliam.Kucharski@Sun.COM  % print a rule at the page bottom also.
2133*8044SWilliam.Kucharski@Sun.COM  \finishedtitlepagefalse
2134*8044SWilliam.Kucharski@Sun.COM  \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2135*8044SWilliam.Kucharski@Sun.COM}
2136*8044SWilliam.Kucharski@Sun.COM
2137*8044SWilliam.Kucharski@Sun.COM\parseargdef\subtitle{%
2138*8044SWilliam.Kucharski@Sun.COM  \checkenv\titlepage
2139*8044SWilliam.Kucharski@Sun.COM  {\subtitlefont \rightline{#1}}%
2140*8044SWilliam.Kucharski@Sun.COM}
2141*8044SWilliam.Kucharski@Sun.COM
2142*8044SWilliam.Kucharski@Sun.COM% @author should come last, but may come many times.
2143*8044SWilliam.Kucharski@Sun.COM% It can also be used inside @quotation.
2144*8044SWilliam.Kucharski@Sun.COM%
2145*8044SWilliam.Kucharski@Sun.COM\parseargdef\author{%
2146*8044SWilliam.Kucharski@Sun.COM  \def\temp{\quotation}%
2147*8044SWilliam.Kucharski@Sun.COM  \ifx\thisenv\temp
2148*8044SWilliam.Kucharski@Sun.COM    \def\quotationauthor{#1}% printed in \Equotation.
2149*8044SWilliam.Kucharski@Sun.COM  \else
2150*8044SWilliam.Kucharski@Sun.COM    \checkenv\titlepage
2151*8044SWilliam.Kucharski@Sun.COM    \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2152*8044SWilliam.Kucharski@Sun.COM    {\authorfont \leftline{#1}}%
2153*8044SWilliam.Kucharski@Sun.COM  \fi
2154*8044SWilliam.Kucharski@Sun.COM}
2155*8044SWilliam.Kucharski@Sun.COM
2156*8044SWilliam.Kucharski@Sun.COM
2157*8044SWilliam.Kucharski@Sun.COM%%% Set up page headings and footings.
2158*8044SWilliam.Kucharski@Sun.COM
2159*8044SWilliam.Kucharski@Sun.COM\let\thispage=\folio
2160*8044SWilliam.Kucharski@Sun.COM
2161*8044SWilliam.Kucharski@Sun.COM\newtoks\evenheadline    % headline on even pages
2162*8044SWilliam.Kucharski@Sun.COM\newtoks\oddheadline     % headline on odd pages
2163*8044SWilliam.Kucharski@Sun.COM\newtoks\evenfootline    % footline on even pages
2164*8044SWilliam.Kucharski@Sun.COM\newtoks\oddfootline     % footline on odd pages
2165*8044SWilliam.Kucharski@Sun.COM
2166*8044SWilliam.Kucharski@Sun.COM% Now make TeX use those variables
2167*8044SWilliam.Kucharski@Sun.COM\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2168*8044SWilliam.Kucharski@Sun.COM                            \else \the\evenheadline \fi}}
2169*8044SWilliam.Kucharski@Sun.COM\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2170*8044SWilliam.Kucharski@Sun.COM                            \else \the\evenfootline \fi}\HEADINGShook}
2171*8044SWilliam.Kucharski@Sun.COM\let\HEADINGShook=\relax
2172*8044SWilliam.Kucharski@Sun.COM
2173*8044SWilliam.Kucharski@Sun.COM% Commands to set those variables.
2174*8044SWilliam.Kucharski@Sun.COM% For example, this is what  @headings on  does
2175*8044SWilliam.Kucharski@Sun.COM% @evenheading @thistitle|@thispage|@thischapter
2176*8044SWilliam.Kucharski@Sun.COM% @oddheading @thischapter|@thispage|@thistitle
2177*8044SWilliam.Kucharski@Sun.COM% @evenfooting @thisfile||
2178*8044SWilliam.Kucharski@Sun.COM% @oddfooting ||@thisfile
2179*8044SWilliam.Kucharski@Sun.COM
2180*8044SWilliam.Kucharski@Sun.COM
2181*8044SWilliam.Kucharski@Sun.COM\def\evenheading{\parsearg\evenheadingxxx}
2182*8044SWilliam.Kucharski@Sun.COM\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2183*8044SWilliam.Kucharski@Sun.COM\def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2184*8044SWilliam.Kucharski@Sun.COM\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2185*8044SWilliam.Kucharski@Sun.COM
2186*8044SWilliam.Kucharski@Sun.COM\def\oddheading{\parsearg\oddheadingxxx}
2187*8044SWilliam.Kucharski@Sun.COM\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2188*8044SWilliam.Kucharski@Sun.COM\def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2189*8044SWilliam.Kucharski@Sun.COM\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2190*8044SWilliam.Kucharski@Sun.COM
2191*8044SWilliam.Kucharski@Sun.COM\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2192*8044SWilliam.Kucharski@Sun.COM
2193*8044SWilliam.Kucharski@Sun.COM\def\evenfooting{\parsearg\evenfootingxxx}
2194*8044SWilliam.Kucharski@Sun.COM\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2195*8044SWilliam.Kucharski@Sun.COM\def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2196*8044SWilliam.Kucharski@Sun.COM\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2197*8044SWilliam.Kucharski@Sun.COM
2198*8044SWilliam.Kucharski@Sun.COM\def\oddfooting{\parsearg\oddfootingxxx}
2199*8044SWilliam.Kucharski@Sun.COM\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2200*8044SWilliam.Kucharski@Sun.COM\def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2201*8044SWilliam.Kucharski@Sun.COM  \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2202*8044SWilliam.Kucharski@Sun.COM  %
2203*8044SWilliam.Kucharski@Sun.COM  % Leave some space for the footline.  Hopefully ok to assume
2204*8044SWilliam.Kucharski@Sun.COM  % @evenfooting will not be used by itself.
2205*8044SWilliam.Kucharski@Sun.COM  \global\advance\pageheight by -\baselineskip
2206*8044SWilliam.Kucharski@Sun.COM  \global\advance\vsize by -\baselineskip
2207*8044SWilliam.Kucharski@Sun.COM}
2208*8044SWilliam.Kucharski@Sun.COM
2209*8044SWilliam.Kucharski@Sun.COM\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2210*8044SWilliam.Kucharski@Sun.COM
2211*8044SWilliam.Kucharski@Sun.COM
2212*8044SWilliam.Kucharski@Sun.COM% @headings double      turns headings on for double-sided printing.
2213*8044SWilliam.Kucharski@Sun.COM% @headings single      turns headings on for single-sided printing.
2214*8044SWilliam.Kucharski@Sun.COM% @headings off         turns them off.
2215*8044SWilliam.Kucharski@Sun.COM% @headings on          same as @headings double, retained for compatibility.
2216*8044SWilliam.Kucharski@Sun.COM% @headings after       turns on double-sided headings after this page.
2217*8044SWilliam.Kucharski@Sun.COM% @headings doubleafter turns on double-sided headings after this page.
2218*8044SWilliam.Kucharski@Sun.COM% @headings singleafter turns on single-sided headings after this page.
2219*8044SWilliam.Kucharski@Sun.COM% By default, they are off at the start of a document,
2220*8044SWilliam.Kucharski@Sun.COM% and turned `on' after @end titlepage.
2221*8044SWilliam.Kucharski@Sun.COM
2222*8044SWilliam.Kucharski@Sun.COM\def\headings #1 {\csname HEADINGS#1\endcsname}
2223*8044SWilliam.Kucharski@Sun.COM
2224*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSoff{%
2225*8044SWilliam.Kucharski@Sun.COM\global\evenheadline={\hfil} \global\evenfootline={\hfil}
2226*8044SWilliam.Kucharski@Sun.COM\global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2227*8044SWilliam.Kucharski@Sun.COM\HEADINGSoff
2228*8044SWilliam.Kucharski@Sun.COM% When we turn headings on, set the page number to 1.
2229*8044SWilliam.Kucharski@Sun.COM% For double-sided printing, put current file name in lower left corner,
2230*8044SWilliam.Kucharski@Sun.COM% chapter name on inside top of right hand pages, document
2231*8044SWilliam.Kucharski@Sun.COM% title on inside top of left hand pages, and page numbers on outside top
2232*8044SWilliam.Kucharski@Sun.COM% edge of all pages.
2233*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSdouble{%
2234*8044SWilliam.Kucharski@Sun.COM\global\pageno=1
2235*8044SWilliam.Kucharski@Sun.COM\global\evenfootline={\hfil}
2236*8044SWilliam.Kucharski@Sun.COM\global\oddfootline={\hfil}
2237*8044SWilliam.Kucharski@Sun.COM\global\evenheadline={\line{\folio\hfil\thistitle}}
2238*8044SWilliam.Kucharski@Sun.COM\global\oddheadline={\line{\thischapter\hfil\folio}}
2239*8044SWilliam.Kucharski@Sun.COM\global\let\contentsalignmacro = \chapoddpage
2240*8044SWilliam.Kucharski@Sun.COM}
2241*8044SWilliam.Kucharski@Sun.COM\let\contentsalignmacro = \chappager
2242*8044SWilliam.Kucharski@Sun.COM
2243*8044SWilliam.Kucharski@Sun.COM% For single-sided printing, chapter title goes across top left of page,
2244*8044SWilliam.Kucharski@Sun.COM% page number on top right.
2245*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSsingle{%
2246*8044SWilliam.Kucharski@Sun.COM\global\pageno=1
2247*8044SWilliam.Kucharski@Sun.COM\global\evenfootline={\hfil}
2248*8044SWilliam.Kucharski@Sun.COM\global\oddfootline={\hfil}
2249*8044SWilliam.Kucharski@Sun.COM\global\evenheadline={\line{\thischapter\hfil\folio}}
2250*8044SWilliam.Kucharski@Sun.COM\global\oddheadline={\line{\thischapter\hfil\folio}}
2251*8044SWilliam.Kucharski@Sun.COM\global\let\contentsalignmacro = \chappager
2252*8044SWilliam.Kucharski@Sun.COM}
2253*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSon{\HEADINGSdouble}
2254*8044SWilliam.Kucharski@Sun.COM
2255*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2256*8044SWilliam.Kucharski@Sun.COM\let\HEADINGSdoubleafter=\HEADINGSafter
2257*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSdoublex{%
2258*8044SWilliam.Kucharski@Sun.COM\global\evenfootline={\hfil}
2259*8044SWilliam.Kucharski@Sun.COM\global\oddfootline={\hfil}
2260*8044SWilliam.Kucharski@Sun.COM\global\evenheadline={\line{\folio\hfil\thistitle}}
2261*8044SWilliam.Kucharski@Sun.COM\global\oddheadline={\line{\thischapter\hfil\folio}}
2262*8044SWilliam.Kucharski@Sun.COM\global\let\contentsalignmacro = \chapoddpage
2263*8044SWilliam.Kucharski@Sun.COM}
2264*8044SWilliam.Kucharski@Sun.COM
2265*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2266*8044SWilliam.Kucharski@Sun.COM\def\HEADINGSsinglex{%
2267*8044SWilliam.Kucharski@Sun.COM\global\evenfootline={\hfil}
2268*8044SWilliam.Kucharski@Sun.COM\global\oddfootline={\hfil}
2269*8044SWilliam.Kucharski@Sun.COM\global\evenheadline={\line{\thischapter\hfil\folio}}
2270*8044SWilliam.Kucharski@Sun.COM\global\oddheadline={\line{\thischapter\hfil\folio}}
2271*8044SWilliam.Kucharski@Sun.COM\global\let\contentsalignmacro = \chappager
2272*8044SWilliam.Kucharski@Sun.COM}
2273*8044SWilliam.Kucharski@Sun.COM
2274*8044SWilliam.Kucharski@Sun.COM% Subroutines used in generating headings
2275*8044SWilliam.Kucharski@Sun.COM% This produces Day Month Year style of output.
2276*8044SWilliam.Kucharski@Sun.COM% Only define if not already defined, in case a txi-??.tex file has set
2277*8044SWilliam.Kucharski@Sun.COM% up a different format (e.g., txi-cs.tex does this).
2278*8044SWilliam.Kucharski@Sun.COM\ifx\today\undefined
2279*8044SWilliam.Kucharski@Sun.COM\def\today{%
2280*8044SWilliam.Kucharski@Sun.COM  \number\day\space
2281*8044SWilliam.Kucharski@Sun.COM  \ifcase\month
2282*8044SWilliam.Kucharski@Sun.COM  \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2283*8044SWilliam.Kucharski@Sun.COM  \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2284*8044SWilliam.Kucharski@Sun.COM  \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2285*8044SWilliam.Kucharski@Sun.COM  \fi
2286*8044SWilliam.Kucharski@Sun.COM  \space\number\year}
2287*8044SWilliam.Kucharski@Sun.COM\fi
2288*8044SWilliam.Kucharski@Sun.COM
2289*8044SWilliam.Kucharski@Sun.COM% @settitle line...  specifies the title of the document, for headings.
2290*8044SWilliam.Kucharski@Sun.COM% It generates no output of its own.
2291*8044SWilliam.Kucharski@Sun.COM\def\thistitle{\putwordNoTitle}
2292*8044SWilliam.Kucharski@Sun.COM\def\settitle{\parsearg{\gdef\thistitle}}
2293*8044SWilliam.Kucharski@Sun.COM
2294*8044SWilliam.Kucharski@Sun.COM
2295*8044SWilliam.Kucharski@Sun.COM\message{tables,}
2296*8044SWilliam.Kucharski@Sun.COM% Tables -- @table, @ftable, @vtable, @item(x).
2297*8044SWilliam.Kucharski@Sun.COM
2298*8044SWilliam.Kucharski@Sun.COM% default indentation of table text
2299*8044SWilliam.Kucharski@Sun.COM\newdimen\tableindent \tableindent=.8in
2300*8044SWilliam.Kucharski@Sun.COM% default indentation of @itemize and @enumerate text
2301*8044SWilliam.Kucharski@Sun.COM\newdimen\itemindent  \itemindent=.3in
2302*8044SWilliam.Kucharski@Sun.COM% margin between end of table item and start of table text.
2303*8044SWilliam.Kucharski@Sun.COM\newdimen\itemmargin  \itemmargin=.1in
2304*8044SWilliam.Kucharski@Sun.COM
2305*8044SWilliam.Kucharski@Sun.COM% used internally for \itemindent minus \itemmargin
2306*8044SWilliam.Kucharski@Sun.COM\newdimen\itemmax
2307*8044SWilliam.Kucharski@Sun.COM
2308*8044SWilliam.Kucharski@Sun.COM% Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2309*8044SWilliam.Kucharski@Sun.COM% these defs.
2310*8044SWilliam.Kucharski@Sun.COM% They also define \itemindex
2311*8044SWilliam.Kucharski@Sun.COM% to index the item name in whatever manner is desired (perhaps none).
2312*8044SWilliam.Kucharski@Sun.COM
2313*8044SWilliam.Kucharski@Sun.COM\newif\ifitemxneedsnegativevskip
2314*8044SWilliam.Kucharski@Sun.COM
2315*8044SWilliam.Kucharski@Sun.COM\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2316*8044SWilliam.Kucharski@Sun.COM
2317*8044SWilliam.Kucharski@Sun.COM\def\internalBitem{\smallbreak \parsearg\itemzzz}
2318*8044SWilliam.Kucharski@Sun.COM\def\internalBitemx{\itemxpar \parsearg\itemzzz}
2319*8044SWilliam.Kucharski@Sun.COM
2320*8044SWilliam.Kucharski@Sun.COM\def\itemzzz #1{\begingroup %
2321*8044SWilliam.Kucharski@Sun.COM  \advance\hsize by -\rightskip
2322*8044SWilliam.Kucharski@Sun.COM  \advance\hsize by -\tableindent
2323*8044SWilliam.Kucharski@Sun.COM  \setbox0=\hbox{\itemindicate{#1}}%
2324*8044SWilliam.Kucharski@Sun.COM  \itemindex{#1}%
2325*8044SWilliam.Kucharski@Sun.COM  \nobreak % This prevents a break before @itemx.
2326*8044SWilliam.Kucharski@Sun.COM  %
2327*8044SWilliam.Kucharski@Sun.COM  % If the item text does not fit in the space we have, put it on a line
2328*8044SWilliam.Kucharski@Sun.COM  % by itself, and do not allow a page break either before or after that
2329*8044SWilliam.Kucharski@Sun.COM  % line.  We do not start a paragraph here because then if the next
2330*8044SWilliam.Kucharski@Sun.COM  % command is, e.g., @kindex, the whatsit would get put into the
2331*8044SWilliam.Kucharski@Sun.COM  % horizontal list on a line by itself, resulting in extra blank space.
2332*8044SWilliam.Kucharski@Sun.COM  \ifdim \wd0>\itemmax
2333*8044SWilliam.Kucharski@Sun.COM    %
2334*8044SWilliam.Kucharski@Sun.COM    % Make this a paragraph so we get the \parskip glue and wrapping,
2335*8044SWilliam.Kucharski@Sun.COM    % but leave it ragged-right.
2336*8044SWilliam.Kucharski@Sun.COM    \begingroup
2337*8044SWilliam.Kucharski@Sun.COM      \advance\leftskip by-\tableindent
2338*8044SWilliam.Kucharski@Sun.COM      \advance\hsize by\tableindent
2339*8044SWilliam.Kucharski@Sun.COM      \advance\rightskip by0pt plus1fil
2340*8044SWilliam.Kucharski@Sun.COM      \leavevmode\unhbox0\par
2341*8044SWilliam.Kucharski@Sun.COM    \endgroup
2342*8044SWilliam.Kucharski@Sun.COM    %
2343*8044SWilliam.Kucharski@Sun.COM    % We're going to be starting a paragraph, but we don't want the
2344*8044SWilliam.Kucharski@Sun.COM    % \parskip glue -- logically it's part of the @item we just started.
2345*8044SWilliam.Kucharski@Sun.COM    \nobreak \vskip-\parskip
2346*8044SWilliam.Kucharski@Sun.COM    %
2347*8044SWilliam.Kucharski@Sun.COM    % Stop a page break at the \parskip glue coming up.  However, if
2348*8044SWilliam.Kucharski@Sun.COM    % what follows is an environment such as @example, there will be no
2349*8044SWilliam.Kucharski@Sun.COM    % \parskip glue; then the negative vskip we just inserted would
2350*8044SWilliam.Kucharski@Sun.COM    % cause the example and the item to crash together.  So we use this
2351*8044SWilliam.Kucharski@Sun.COM    % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2352*8044SWilliam.Kucharski@Sun.COM    % \parskip glue after all.  Section titles are handled this way also.
2353*8044SWilliam.Kucharski@Sun.COM    %
2354*8044SWilliam.Kucharski@Sun.COM    \penalty 10001
2355*8044SWilliam.Kucharski@Sun.COM    \endgroup
2356*8044SWilliam.Kucharski@Sun.COM    \itemxneedsnegativevskipfalse
2357*8044SWilliam.Kucharski@Sun.COM  \else
2358*8044SWilliam.Kucharski@Sun.COM    % The item text fits into the space.  Start a paragraph, so that the
2359*8044SWilliam.Kucharski@Sun.COM    % following text (if any) will end up on the same line.
2360*8044SWilliam.Kucharski@Sun.COM    \noindent
2361*8044SWilliam.Kucharski@Sun.COM    % Do this with kerns and \unhbox so that if there is a footnote in
2362*8044SWilliam.Kucharski@Sun.COM    % the item text, it can migrate to the main vertical list and
2363*8044SWilliam.Kucharski@Sun.COM    % eventually be printed.
2364*8044SWilliam.Kucharski@Sun.COM    \nobreak\kern-\tableindent
2365*8044SWilliam.Kucharski@Sun.COM    \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2366*8044SWilliam.Kucharski@Sun.COM    \unhbox0
2367*8044SWilliam.Kucharski@Sun.COM    \nobreak\kern\dimen0
2368*8044SWilliam.Kucharski@Sun.COM    \endgroup
2369*8044SWilliam.Kucharski@Sun.COM    \itemxneedsnegativevskiptrue
2370*8044SWilliam.Kucharski@Sun.COM  \fi
2371*8044SWilliam.Kucharski@Sun.COM}
2372*8044SWilliam.Kucharski@Sun.COM
2373*8044SWilliam.Kucharski@Sun.COM\def\item{\errmessage{@item while not in a list environment}}
2374*8044SWilliam.Kucharski@Sun.COM\def\itemx{\errmessage{@itemx while not in a list environment}}
2375*8044SWilliam.Kucharski@Sun.COM
2376*8044SWilliam.Kucharski@Sun.COM% @table, @ftable, @vtable.
2377*8044SWilliam.Kucharski@Sun.COM\envdef\table{%
2378*8044SWilliam.Kucharski@Sun.COM  \let\itemindex\gobble
2379*8044SWilliam.Kucharski@Sun.COM  \tablecheck{table}%
2380*8044SWilliam.Kucharski@Sun.COM}
2381*8044SWilliam.Kucharski@Sun.COM\envdef\ftable{%
2382*8044SWilliam.Kucharski@Sun.COM  \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2383*8044SWilliam.Kucharski@Sun.COM  \tablecheck{ftable}%
2384*8044SWilliam.Kucharski@Sun.COM}
2385*8044SWilliam.Kucharski@Sun.COM\envdef\vtable{%
2386*8044SWilliam.Kucharski@Sun.COM  \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2387*8044SWilliam.Kucharski@Sun.COM  \tablecheck{vtable}%
2388*8044SWilliam.Kucharski@Sun.COM}
2389*8044SWilliam.Kucharski@Sun.COM\def\tablecheck#1{%
2390*8044SWilliam.Kucharski@Sun.COM  \ifnum \the\catcode`\^^M=\active
2391*8044SWilliam.Kucharski@Sun.COM    \endgroup
2392*8044SWilliam.Kucharski@Sun.COM    \errmessage{This command won't work in this context; perhaps the problem is
2393*8044SWilliam.Kucharski@Sun.COM      that we are \inenvironment\thisenv}%
2394*8044SWilliam.Kucharski@Sun.COM    \def\next{\doignore{#1}}%
2395*8044SWilliam.Kucharski@Sun.COM  \else
2396*8044SWilliam.Kucharski@Sun.COM    \let\next\tablex
2397*8044SWilliam.Kucharski@Sun.COM  \fi
2398*8044SWilliam.Kucharski@Sun.COM  \next
2399*8044SWilliam.Kucharski@Sun.COM}
2400*8044SWilliam.Kucharski@Sun.COM\def\tablex#1{%
2401*8044SWilliam.Kucharski@Sun.COM  \def\itemindicate{#1}%
2402*8044SWilliam.Kucharski@Sun.COM  \parsearg\tabley
2403*8044SWilliam.Kucharski@Sun.COM}
2404*8044SWilliam.Kucharski@Sun.COM\def\tabley#1{%
2405*8044SWilliam.Kucharski@Sun.COM  {%
2406*8044SWilliam.Kucharski@Sun.COM    \makevalueexpandable
2407*8044SWilliam.Kucharski@Sun.COM    \edef\temp{\noexpand\tablez #1\space\space\space}%
2408*8044SWilliam.Kucharski@Sun.COM    \expandafter
2409*8044SWilliam.Kucharski@Sun.COM  }\temp \endtablez
2410*8044SWilliam.Kucharski@Sun.COM}
2411*8044SWilliam.Kucharski@Sun.COM\def\tablez #1 #2 #3 #4\endtablez{%
2412*8044SWilliam.Kucharski@Sun.COM  \aboveenvbreak
2413*8044SWilliam.Kucharski@Sun.COM  \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2414*8044SWilliam.Kucharski@Sun.COM  \ifnum 0#2>0 \tableindent=#2\mil \fi
2415*8044SWilliam.Kucharski@Sun.COM  \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2416*8044SWilliam.Kucharski@Sun.COM  \itemmax=\tableindent
2417*8044SWilliam.Kucharski@Sun.COM  \advance \itemmax by -\itemmargin
2418*8044SWilliam.Kucharski@Sun.COM  \advance \leftskip by \tableindent
2419*8044SWilliam.Kucharski@Sun.COM  \exdentamount=\tableindent
2420*8044SWilliam.Kucharski@Sun.COM  \parindent = 0pt
2421*8044SWilliam.Kucharski@Sun.COM  \parskip = \smallskipamount
2422*8044SWilliam.Kucharski@Sun.COM  \ifdim \parskip=0pt \parskip=2pt \fi
2423*8044SWilliam.Kucharski@Sun.COM  \let\item = \internalBitem
2424*8044SWilliam.Kucharski@Sun.COM  \let\itemx = \internalBitemx
2425*8044SWilliam.Kucharski@Sun.COM}
2426*8044SWilliam.Kucharski@Sun.COM\def\Etable{\endgraf\afterenvbreak}
2427*8044SWilliam.Kucharski@Sun.COM\let\Eftable\Etable
2428*8044SWilliam.Kucharski@Sun.COM\let\Evtable\Etable
2429*8044SWilliam.Kucharski@Sun.COM\let\Eitemize\Etable
2430*8044SWilliam.Kucharski@Sun.COM\let\Eenumerate\Etable
2431*8044SWilliam.Kucharski@Sun.COM
2432*8044SWilliam.Kucharski@Sun.COM% This is the counter used by @enumerate, which is really @itemize
2433*8044SWilliam.Kucharski@Sun.COM
2434*8044SWilliam.Kucharski@Sun.COM\newcount \itemno
2435*8044SWilliam.Kucharski@Sun.COM
2436*8044SWilliam.Kucharski@Sun.COM\envdef\itemize{\parsearg\doitemize}
2437*8044SWilliam.Kucharski@Sun.COM
2438*8044SWilliam.Kucharski@Sun.COM\def\doitemize#1{%
2439*8044SWilliam.Kucharski@Sun.COM  \aboveenvbreak
2440*8044SWilliam.Kucharski@Sun.COM  \itemmax=\itemindent
2441*8044SWilliam.Kucharski@Sun.COM  \advance\itemmax by -\itemmargin
2442*8044SWilliam.Kucharski@Sun.COM  \advance\leftskip by \itemindent
2443*8044SWilliam.Kucharski@Sun.COM  \exdentamount=\itemindent
2444*8044SWilliam.Kucharski@Sun.COM  \parindent=0pt
2445*8044SWilliam.Kucharski@Sun.COM  \parskip=\smallskipamount
2446*8044SWilliam.Kucharski@Sun.COM  \ifdim\parskip=0pt \parskip=2pt \fi
2447*8044SWilliam.Kucharski@Sun.COM  \def\itemcontents{#1}%
2448*8044SWilliam.Kucharski@Sun.COM  % @itemize with no arg is equivalent to @itemize @bullet.
2449*8044SWilliam.Kucharski@Sun.COM  \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2450*8044SWilliam.Kucharski@Sun.COM  \let\item=\itemizeitem
2451*8044SWilliam.Kucharski@Sun.COM}
2452*8044SWilliam.Kucharski@Sun.COM
2453*8044SWilliam.Kucharski@Sun.COM% Definition of @item while inside @itemize and @enumerate.
2454*8044SWilliam.Kucharski@Sun.COM%
2455*8044SWilliam.Kucharski@Sun.COM\def\itemizeitem{%
2456*8044SWilliam.Kucharski@Sun.COM  \advance\itemno by 1  % for enumerations
2457*8044SWilliam.Kucharski@Sun.COM  {\let\par=\endgraf \smallbreak}% reasonable place to break
2458*8044SWilliam.Kucharski@Sun.COM  {%
2459*8044SWilliam.Kucharski@Sun.COM   % If the document has an @itemize directly after a section title, a
2460*8044SWilliam.Kucharski@Sun.COM   % \nobreak will be last on the list, and \sectionheading will have
2461*8044SWilliam.Kucharski@Sun.COM   % done a \vskip-\parskip.  In that case, we don't want to zero
2462*8044SWilliam.Kucharski@Sun.COM   % parskip, or the item text will crash with the heading.  On the
2463*8044SWilliam.Kucharski@Sun.COM   % other hand, when there is normal text preceding the item (as there
2464*8044SWilliam.Kucharski@Sun.COM   % usually is), we do want to zero parskip, or there would be too much
2465*8044SWilliam.Kucharski@Sun.COM   % space.  In that case, we won't have a \nobreak before.  At least
2466*8044SWilliam.Kucharski@Sun.COM   % that's the theory.
2467*8044SWilliam.Kucharski@Sun.COM   \ifnum\lastpenalty<10000 \parskip=0in \fi
2468*8044SWilliam.Kucharski@Sun.COM   \noindent
2469*8044SWilliam.Kucharski@Sun.COM   \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2470*8044SWilliam.Kucharski@Sun.COM   \vadjust{\penalty 1200}}% not good to break after first line of item.
2471*8044SWilliam.Kucharski@Sun.COM  \flushcr
2472*8044SWilliam.Kucharski@Sun.COM}
2473*8044SWilliam.Kucharski@Sun.COM
2474*8044SWilliam.Kucharski@Sun.COM% \splitoff TOKENS\endmark defines \first to be the first token in
2475*8044SWilliam.Kucharski@Sun.COM% TOKENS, and \rest to be the remainder.
2476*8044SWilliam.Kucharski@Sun.COM%
2477*8044SWilliam.Kucharski@Sun.COM\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2478*8044SWilliam.Kucharski@Sun.COM
2479*8044SWilliam.Kucharski@Sun.COM% Allow an optional argument of an uppercase letter, lowercase letter,
2480*8044SWilliam.Kucharski@Sun.COM% or number, to specify the first label in the enumerated list.  No
2481*8044SWilliam.Kucharski@Sun.COM% argument is the same as `1'.
2482*8044SWilliam.Kucharski@Sun.COM%
2483*8044SWilliam.Kucharski@Sun.COM\envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
2484*8044SWilliam.Kucharski@Sun.COM\def\enumeratey #1 #2\endenumeratey{%
2485*8044SWilliam.Kucharski@Sun.COM  % If we were given no argument, pretend we were given `1'.
2486*8044SWilliam.Kucharski@Sun.COM  \def\thearg{#1}%
2487*8044SWilliam.Kucharski@Sun.COM  \ifx\thearg\empty \def\thearg{1}\fi
2488*8044SWilliam.Kucharski@Sun.COM  %
2489*8044SWilliam.Kucharski@Sun.COM  % Detect if the argument is a single token.  If so, it might be a
2490*8044SWilliam.Kucharski@Sun.COM  % letter.  Otherwise, the only valid thing it can be is a number.
2491*8044SWilliam.Kucharski@Sun.COM  % (We will always have one token, because of the test we just made.
2492*8044SWilliam.Kucharski@Sun.COM  % This is a good thing, since \splitoff doesn't work given nothing at
2493*8044SWilliam.Kucharski@Sun.COM  % all -- the first parameter is undelimited.)
2494*8044SWilliam.Kucharski@Sun.COM  \expandafter\splitoff\thearg\endmark
2495*8044SWilliam.Kucharski@Sun.COM  \ifx\rest\empty
2496*8044SWilliam.Kucharski@Sun.COM    % Only one token in the argument.  It could still be anything.
2497*8044SWilliam.Kucharski@Sun.COM    % A ``lowercase letter'' is one whose \lccode is nonzero.
2498*8044SWilliam.Kucharski@Sun.COM    % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2499*8044SWilliam.Kucharski@Sun.COM    %   not equal to itself.
2500*8044SWilliam.Kucharski@Sun.COM    % Otherwise, we assume it's a number.
2501*8044SWilliam.Kucharski@Sun.COM    %
2502*8044SWilliam.Kucharski@Sun.COM    % We need the \relax at the end of the \ifnum lines to stop TeX from
2503*8044SWilliam.Kucharski@Sun.COM    % continuing to look for a <number>.
2504*8044SWilliam.Kucharski@Sun.COM    %
2505*8044SWilliam.Kucharski@Sun.COM    \ifnum\lccode\expandafter`\thearg=0\relax
2506*8044SWilliam.Kucharski@Sun.COM      \numericenumerate % a number (we hope)
2507*8044SWilliam.Kucharski@Sun.COM    \else
2508*8044SWilliam.Kucharski@Sun.COM      % It's a letter.
2509*8044SWilliam.Kucharski@Sun.COM      \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2510*8044SWilliam.Kucharski@Sun.COM        \lowercaseenumerate % lowercase letter
2511*8044SWilliam.Kucharski@Sun.COM      \else
2512*8044SWilliam.Kucharski@Sun.COM        \uppercaseenumerate % uppercase letter
2513*8044SWilliam.Kucharski@Sun.COM      \fi
2514*8044SWilliam.Kucharski@Sun.COM    \fi
2515*8044SWilliam.Kucharski@Sun.COM  \else
2516*8044SWilliam.Kucharski@Sun.COM    % Multiple tokens in the argument.  We hope it's a number.
2517*8044SWilliam.Kucharski@Sun.COM    \numericenumerate
2518*8044SWilliam.Kucharski@Sun.COM  \fi
2519*8044SWilliam.Kucharski@Sun.COM}
2520*8044SWilliam.Kucharski@Sun.COM
2521*8044SWilliam.Kucharski@Sun.COM% An @enumerate whose labels are integers.  The starting integer is
2522*8044SWilliam.Kucharski@Sun.COM% given in \thearg.
2523*8044SWilliam.Kucharski@Sun.COM%
2524*8044SWilliam.Kucharski@Sun.COM\def\numericenumerate{%
2525*8044SWilliam.Kucharski@Sun.COM  \itemno = \thearg
2526*8044SWilliam.Kucharski@Sun.COM  \startenumeration{\the\itemno}%
2527*8044SWilliam.Kucharski@Sun.COM}
2528*8044SWilliam.Kucharski@Sun.COM
2529*8044SWilliam.Kucharski@Sun.COM% The starting (lowercase) letter is in \thearg.
2530*8044SWilliam.Kucharski@Sun.COM\def\lowercaseenumerate{%
2531*8044SWilliam.Kucharski@Sun.COM  \itemno = \expandafter`\thearg
2532*8044SWilliam.Kucharski@Sun.COM  \startenumeration{%
2533*8044SWilliam.Kucharski@Sun.COM    % Be sure we're not beyond the end of the alphabet.
2534*8044SWilliam.Kucharski@Sun.COM    \ifnum\itemno=0
2535*8044SWilliam.Kucharski@Sun.COM      \errmessage{No more lowercase letters in @enumerate; get a bigger
2536*8044SWilliam.Kucharski@Sun.COM                  alphabet}%
2537*8044SWilliam.Kucharski@Sun.COM    \fi
2538*8044SWilliam.Kucharski@Sun.COM    \char\lccode\itemno
2539*8044SWilliam.Kucharski@Sun.COM  }%
2540*8044SWilliam.Kucharski@Sun.COM}
2541*8044SWilliam.Kucharski@Sun.COM
2542*8044SWilliam.Kucharski@Sun.COM% The starting (uppercase) letter is in \thearg.
2543*8044SWilliam.Kucharski@Sun.COM\def\uppercaseenumerate{%
2544*8044SWilliam.Kucharski@Sun.COM  \itemno = \expandafter`\thearg
2545*8044SWilliam.Kucharski@Sun.COM  \startenumeration{%
2546*8044SWilliam.Kucharski@Sun.COM    % Be sure we're not beyond the end of the alphabet.
2547*8044SWilliam.Kucharski@Sun.COM    \ifnum\itemno=0
2548*8044SWilliam.Kucharski@Sun.COM      \errmessage{No more uppercase letters in @enumerate; get a bigger
2549*8044SWilliam.Kucharski@Sun.COM                  alphabet}
2550*8044SWilliam.Kucharski@Sun.COM    \fi
2551*8044SWilliam.Kucharski@Sun.COM    \char\uccode\itemno
2552*8044SWilliam.Kucharski@Sun.COM  }%
2553*8044SWilliam.Kucharski@Sun.COM}
2554*8044SWilliam.Kucharski@Sun.COM
2555*8044SWilliam.Kucharski@Sun.COM% Call \doitemize, adding a period to the first argument and supplying the
2556*8044SWilliam.Kucharski@Sun.COM% common last two arguments.  Also subtract one from the initial value in
2557*8044SWilliam.Kucharski@Sun.COM% \itemno, since @item increments \itemno.
2558*8044SWilliam.Kucharski@Sun.COM%
2559*8044SWilliam.Kucharski@Sun.COM\def\startenumeration#1{%
2560*8044SWilliam.Kucharski@Sun.COM  \advance\itemno by -1
2561*8044SWilliam.Kucharski@Sun.COM  \doitemize{#1.}\flushcr
2562*8044SWilliam.Kucharski@Sun.COM}
2563*8044SWilliam.Kucharski@Sun.COM
2564*8044SWilliam.Kucharski@Sun.COM% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2565*8044SWilliam.Kucharski@Sun.COM% to @enumerate.
2566*8044SWilliam.Kucharski@Sun.COM%
2567*8044SWilliam.Kucharski@Sun.COM\def\alphaenumerate{\enumerate{a}}
2568*8044SWilliam.Kucharski@Sun.COM\def\capsenumerate{\enumerate{A}}
2569*8044SWilliam.Kucharski@Sun.COM\def\Ealphaenumerate{\Eenumerate}
2570*8044SWilliam.Kucharski@Sun.COM\def\Ecapsenumerate{\Eenumerate}
2571*8044SWilliam.Kucharski@Sun.COM
2572*8044SWilliam.Kucharski@Sun.COM
2573*8044SWilliam.Kucharski@Sun.COM% @multitable macros
2574*8044SWilliam.Kucharski@Sun.COM% Amy Hendrickson, 8/18/94, 3/6/96
2575*8044SWilliam.Kucharski@Sun.COM%
2576*8044SWilliam.Kucharski@Sun.COM% @multitable ... @end multitable will make as many columns as desired.
2577*8044SWilliam.Kucharski@Sun.COM% Contents of each column will wrap at width given in preamble.  Width
2578*8044SWilliam.Kucharski@Sun.COM% can be specified either with sample text given in a template line,
2579*8044SWilliam.Kucharski@Sun.COM% or in percent of \hsize, the current width of text on page.
2580*8044SWilliam.Kucharski@Sun.COM
2581*8044SWilliam.Kucharski@Sun.COM% Table can continue over pages but will only break between lines.
2582*8044SWilliam.Kucharski@Sun.COM
2583*8044SWilliam.Kucharski@Sun.COM% To make preamble:
2584*8044SWilliam.Kucharski@Sun.COM%
2585*8044SWilliam.Kucharski@Sun.COM% Either define widths of columns in terms of percent of \hsize:
2586*8044SWilliam.Kucharski@Sun.COM%   @multitable @columnfractions .25 .3 .45
2587*8044SWilliam.Kucharski@Sun.COM%   @item ...
2588*8044SWilliam.Kucharski@Sun.COM%
2589*8044SWilliam.Kucharski@Sun.COM%   Numbers following @columnfractions are the percent of the total
2590*8044SWilliam.Kucharski@Sun.COM%   current hsize to be used for each column. You may use as many
2591*8044SWilliam.Kucharski@Sun.COM%   columns as desired.
2592*8044SWilliam.Kucharski@Sun.COM
2593*8044SWilliam.Kucharski@Sun.COM
2594*8044SWilliam.Kucharski@Sun.COM% Or use a template:
2595*8044SWilliam.Kucharski@Sun.COM%   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2596*8044SWilliam.Kucharski@Sun.COM%   @item ...
2597*8044SWilliam.Kucharski@Sun.COM%   using the widest term desired in each column.
2598*8044SWilliam.Kucharski@Sun.COM
2599*8044SWilliam.Kucharski@Sun.COM% Each new table line starts with @item, each subsequent new column
2600*8044SWilliam.Kucharski@Sun.COM% starts with @tab. Empty columns may be produced by supplying @tab's
2601*8044SWilliam.Kucharski@Sun.COM% with nothing between them for as many times as empty columns are needed,
2602*8044SWilliam.Kucharski@Sun.COM% ie, @tab@tab@tab will produce two empty columns.
2603*8044SWilliam.Kucharski@Sun.COM
2604*8044SWilliam.Kucharski@Sun.COM% @item, @tab do not need to be on their own lines, but it will not hurt
2605*8044SWilliam.Kucharski@Sun.COM% if they are.
2606*8044SWilliam.Kucharski@Sun.COM
2607*8044SWilliam.Kucharski@Sun.COM% Sample multitable:
2608*8044SWilliam.Kucharski@Sun.COM
2609*8044SWilliam.Kucharski@Sun.COM%   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2610*8044SWilliam.Kucharski@Sun.COM%   @item first col stuff @tab second col stuff @tab third col
2611*8044SWilliam.Kucharski@Sun.COM%   @item
2612*8044SWilliam.Kucharski@Sun.COM%   first col stuff
2613*8044SWilliam.Kucharski@Sun.COM%   @tab
2614*8044SWilliam.Kucharski@Sun.COM%   second col stuff
2615*8044SWilliam.Kucharski@Sun.COM%   @tab
2616*8044SWilliam.Kucharski@Sun.COM%   third col
2617*8044SWilliam.Kucharski@Sun.COM%   @item first col stuff @tab second col stuff
2618*8044SWilliam.Kucharski@Sun.COM%   @tab Many paragraphs of text may be used in any column.
2619*8044SWilliam.Kucharski@Sun.COM%
2620*8044SWilliam.Kucharski@Sun.COM%         They will wrap at the width determined by the template.
2621*8044SWilliam.Kucharski@Sun.COM%   @item@tab@tab This will be in third column.
2622*8044SWilliam.Kucharski@Sun.COM%   @end multitable
2623*8044SWilliam.Kucharski@Sun.COM
2624*8044SWilliam.Kucharski@Sun.COM% Default dimensions may be reset by user.
2625*8044SWilliam.Kucharski@Sun.COM% @multitableparskip is vertical space between paragraphs in table.
2626*8044SWilliam.Kucharski@Sun.COM% @multitableparindent is paragraph indent in table.
2627*8044SWilliam.Kucharski@Sun.COM% @multitablecolmargin is horizontal space to be left between columns.
2628*8044SWilliam.Kucharski@Sun.COM% @multitablelinespace is space to leave between table items, baseline
2629*8044SWilliam.Kucharski@Sun.COM%                                                            to baseline.
2630*8044SWilliam.Kucharski@Sun.COM%   0pt means it depends on current normal line spacing.
2631*8044SWilliam.Kucharski@Sun.COM%
2632*8044SWilliam.Kucharski@Sun.COM\newskip\multitableparskip
2633*8044SWilliam.Kucharski@Sun.COM\newskip\multitableparindent
2634*8044SWilliam.Kucharski@Sun.COM\newdimen\multitablecolspace
2635*8044SWilliam.Kucharski@Sun.COM\newskip\multitablelinespace
2636*8044SWilliam.Kucharski@Sun.COM\multitableparskip=0pt
2637*8044SWilliam.Kucharski@Sun.COM\multitableparindent=6pt
2638*8044SWilliam.Kucharski@Sun.COM\multitablecolspace=12pt
2639*8044SWilliam.Kucharski@Sun.COM\multitablelinespace=0pt
2640*8044SWilliam.Kucharski@Sun.COM
2641*8044SWilliam.Kucharski@Sun.COM% Macros used to set up halign preamble:
2642*8044SWilliam.Kucharski@Sun.COM%
2643*8044SWilliam.Kucharski@Sun.COM\let\endsetuptable\relax
2644*8044SWilliam.Kucharski@Sun.COM\def\xendsetuptable{\endsetuptable}
2645*8044SWilliam.Kucharski@Sun.COM\let\columnfractions\relax
2646*8044SWilliam.Kucharski@Sun.COM\def\xcolumnfractions{\columnfractions}
2647*8044SWilliam.Kucharski@Sun.COM\newif\ifsetpercent
2648*8044SWilliam.Kucharski@Sun.COM
2649*8044SWilliam.Kucharski@Sun.COM% #1 is the @columnfraction, usually a decimal number like .5, but might
2650*8044SWilliam.Kucharski@Sun.COM% be just 1.  We just use it, whatever it is.
2651*8044SWilliam.Kucharski@Sun.COM%
2652*8044SWilliam.Kucharski@Sun.COM\def\pickupwholefraction#1 {%
2653*8044SWilliam.Kucharski@Sun.COM  \global\advance\colcount by 1
2654*8044SWilliam.Kucharski@Sun.COM  \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2655*8044SWilliam.Kucharski@Sun.COM  \setuptable
2656*8044SWilliam.Kucharski@Sun.COM}
2657*8044SWilliam.Kucharski@Sun.COM
2658*8044SWilliam.Kucharski@Sun.COM\newcount\colcount
2659*8044SWilliam.Kucharski@Sun.COM\def\setuptable#1{%
2660*8044SWilliam.Kucharski@Sun.COM  \def\firstarg{#1}%
2661*8044SWilliam.Kucharski@Sun.COM  \ifx\firstarg\xendsetuptable
2662*8044SWilliam.Kucharski@Sun.COM    \let\go = \relax
2663*8044SWilliam.Kucharski@Sun.COM  \else
2664*8044SWilliam.Kucharski@Sun.COM    \ifx\firstarg\xcolumnfractions
2665*8044SWilliam.Kucharski@Sun.COM      \global\setpercenttrue
2666*8044SWilliam.Kucharski@Sun.COM    \else
2667*8044SWilliam.Kucharski@Sun.COM      \ifsetpercent
2668*8044SWilliam.Kucharski@Sun.COM         \let\go\pickupwholefraction
2669*8044SWilliam.Kucharski@Sun.COM      \else
2670*8044SWilliam.Kucharski@Sun.COM         \global\advance\colcount by 1
2671*8044SWilliam.Kucharski@Sun.COM         \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2672*8044SWilliam.Kucharski@Sun.COM                   % separator; typically that is always in the input, anyway.
2673*8044SWilliam.Kucharski@Sun.COM         \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2674*8044SWilliam.Kucharski@Sun.COM      \fi
2675*8044SWilliam.Kucharski@Sun.COM    \fi
2676*8044SWilliam.Kucharski@Sun.COM    \ifx\go\pickupwholefraction
2677*8044SWilliam.Kucharski@Sun.COM      % Put the argument back for the \pickupwholefraction call, so
2678*8044SWilliam.Kucharski@Sun.COM      % we'll always have a period there to be parsed.
2679*8044SWilliam.Kucharski@Sun.COM      \def\go{\pickupwholefraction#1}%
2680*8044SWilliam.Kucharski@Sun.COM    \else
2681*8044SWilliam.Kucharski@Sun.COM      \let\go = \setuptable
2682*8044SWilliam.Kucharski@Sun.COM    \fi%
2683*8044SWilliam.Kucharski@Sun.COM  \fi
2684*8044SWilliam.Kucharski@Sun.COM  \go
2685*8044SWilliam.Kucharski@Sun.COM}
2686*8044SWilliam.Kucharski@Sun.COM
2687*8044SWilliam.Kucharski@Sun.COM% multitable-only commands.
2688*8044SWilliam.Kucharski@Sun.COM%
2689*8044SWilliam.Kucharski@Sun.COM% @headitem starts a heading row, which we typeset in bold.
2690*8044SWilliam.Kucharski@Sun.COM% Assignments have to be global since we are inside the implicit group
2691*8044SWilliam.Kucharski@Sun.COM% of an alignment entry.  Note that \everycr resets \everytab.
2692*8044SWilliam.Kucharski@Sun.COM\def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2693*8044SWilliam.Kucharski@Sun.COM%
2694*8044SWilliam.Kucharski@Sun.COM% A \tab used to include \hskip1sp.  But then the space in a template
2695*8044SWilliam.Kucharski@Sun.COM% line is not enough.  That is bad.  So let's go back to just `&' until
2696*8044SWilliam.Kucharski@Sun.COM% we encounter the problem it was intended to solve again.
2697*8044SWilliam.Kucharski@Sun.COM%					--karl, nathan@acm.org, 20apr99.
2698*8044SWilliam.Kucharski@Sun.COM\def\tab{\checkenv\multitable &\the\everytab}%
2699*8044SWilliam.Kucharski@Sun.COM
2700*8044SWilliam.Kucharski@Sun.COM% @multitable ... @end multitable definitions:
2701*8044SWilliam.Kucharski@Sun.COM%
2702*8044SWilliam.Kucharski@Sun.COM\newtoks\everytab  % insert after every tab.
2703*8044SWilliam.Kucharski@Sun.COM%
2704*8044SWilliam.Kucharski@Sun.COM\envdef\multitable{%
2705*8044SWilliam.Kucharski@Sun.COM  \vskip\parskip
2706*8044SWilliam.Kucharski@Sun.COM  \startsavinginserts
2707*8044SWilliam.Kucharski@Sun.COM  %
2708*8044SWilliam.Kucharski@Sun.COM  % @item within a multitable starts a normal row.
2709*8044SWilliam.Kucharski@Sun.COM  % We use \def instead of \let so that if one of the multitable entries
2710*8044SWilliam.Kucharski@Sun.COM  % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2711*8044SWilliam.Kucharski@Sun.COM  % \endtemplate) expanding \doitemize.
2712*8044SWilliam.Kucharski@Sun.COM  \def\item{\crcr}%
2713*8044SWilliam.Kucharski@Sun.COM  %
2714*8044SWilliam.Kucharski@Sun.COM  \tolerance=9500
2715*8044SWilliam.Kucharski@Sun.COM  \hbadness=9500
2716*8044SWilliam.Kucharski@Sun.COM  \setmultitablespacing
2717*8044SWilliam.Kucharski@Sun.COM  \parskip=\multitableparskip
2718*8044SWilliam.Kucharski@Sun.COM  \parindent=\multitableparindent
2719*8044SWilliam.Kucharski@Sun.COM  \overfullrule=0pt
2720*8044SWilliam.Kucharski@Sun.COM  \global\colcount=0
2721*8044SWilliam.Kucharski@Sun.COM  %
2722*8044SWilliam.Kucharski@Sun.COM  \everycr = {%
2723*8044SWilliam.Kucharski@Sun.COM    \noalign{%
2724*8044SWilliam.Kucharski@Sun.COM      \global\everytab={}%
2725*8044SWilliam.Kucharski@Sun.COM      \global\colcount=0 % Reset the column counter.
2726*8044SWilliam.Kucharski@Sun.COM      % Check for saved footnotes, etc.
2727*8044SWilliam.Kucharski@Sun.COM      \checkinserts
2728*8044SWilliam.Kucharski@Sun.COM      % Keeps underfull box messages off when table breaks over pages.
2729*8044SWilliam.Kucharski@Sun.COM      %\filbreak
2730*8044SWilliam.Kucharski@Sun.COM	% Maybe so, but it also creates really weird page breaks when the
2731*8044SWilliam.Kucharski@Sun.COM	% table breaks over pages. Wouldn't \vfil be better?  Wait until the
2732*8044SWilliam.Kucharski@Sun.COM	% problem manifests itself, so it can be fixed for real --karl.
2733*8044SWilliam.Kucharski@Sun.COM    }%
2734*8044SWilliam.Kucharski@Sun.COM  }%
2735*8044SWilliam.Kucharski@Sun.COM  %
2736*8044SWilliam.Kucharski@Sun.COM  \parsearg\domultitable
2737*8044SWilliam.Kucharski@Sun.COM}
2738*8044SWilliam.Kucharski@Sun.COM\def\domultitable#1{%
2739*8044SWilliam.Kucharski@Sun.COM  % To parse everything between @multitable and @item:
2740*8044SWilliam.Kucharski@Sun.COM  \setuptable#1 \endsetuptable
2741*8044SWilliam.Kucharski@Sun.COM  %
2742*8044SWilliam.Kucharski@Sun.COM  % This preamble sets up a generic column definition, which will
2743*8044SWilliam.Kucharski@Sun.COM  % be used as many times as user calls for columns.
2744*8044SWilliam.Kucharski@Sun.COM  % \vtop will set a single line and will also let text wrap and
2745*8044SWilliam.Kucharski@Sun.COM  % continue for many paragraphs if desired.
2746*8044SWilliam.Kucharski@Sun.COM  \halign\bgroup &%
2747*8044SWilliam.Kucharski@Sun.COM    \global\advance\colcount by 1
2748*8044SWilliam.Kucharski@Sun.COM    \multistrut
2749*8044SWilliam.Kucharski@Sun.COM    \vtop{%
2750*8044SWilliam.Kucharski@Sun.COM      % Use the current \colcount to find the correct column width:
2751*8044SWilliam.Kucharski@Sun.COM      \hsize=\expandafter\csname col\the\colcount\endcsname
2752*8044SWilliam.Kucharski@Sun.COM      %
2753*8044SWilliam.Kucharski@Sun.COM      % In order to keep entries from bumping into each other
2754*8044SWilliam.Kucharski@Sun.COM      % we will add a \leftskip of \multitablecolspace to all columns after
2755*8044SWilliam.Kucharski@Sun.COM      % the first one.
2756*8044SWilliam.Kucharski@Sun.COM      %
2757*8044SWilliam.Kucharski@Sun.COM      % If a template has been used, we will add \multitablecolspace
2758*8044SWilliam.Kucharski@Sun.COM      % to the width of each template entry.
2759*8044SWilliam.Kucharski@Sun.COM      %
2760*8044SWilliam.Kucharski@Sun.COM      % If the user has set preamble in terms of percent of \hsize we will
2761*8044SWilliam.Kucharski@Sun.COM      % use that dimension as the width of the column, and the \leftskip
2762*8044SWilliam.Kucharski@Sun.COM      % will keep entries from bumping into each other.  Table will start at
2763*8044SWilliam.Kucharski@Sun.COM      % left margin and final column will justify at right margin.
2764*8044SWilliam.Kucharski@Sun.COM      %
2765*8044SWilliam.Kucharski@Sun.COM      % Make sure we don't inherit \rightskip from the outer environment.
2766*8044SWilliam.Kucharski@Sun.COM      \rightskip=0pt
2767*8044SWilliam.Kucharski@Sun.COM      \ifnum\colcount=1
2768*8044SWilliam.Kucharski@Sun.COM	% The first column will be indented with the surrounding text.
2769*8044SWilliam.Kucharski@Sun.COM	\advance\hsize by\leftskip
2770*8044SWilliam.Kucharski@Sun.COM      \else
2771*8044SWilliam.Kucharski@Sun.COM	\ifsetpercent \else
2772*8044SWilliam.Kucharski@Sun.COM	  % If user has not set preamble in terms of percent of \hsize
2773*8044SWilliam.Kucharski@Sun.COM	  % we will advance \hsize by \multitablecolspace.
2774*8044SWilliam.Kucharski@Sun.COM	  \advance\hsize by \multitablecolspace
2775*8044SWilliam.Kucharski@Sun.COM	\fi
2776*8044SWilliam.Kucharski@Sun.COM       % In either case we will make \leftskip=\multitablecolspace:
2777*8044SWilliam.Kucharski@Sun.COM      \leftskip=\multitablecolspace
2778*8044SWilliam.Kucharski@Sun.COM      \fi
2779*8044SWilliam.Kucharski@Sun.COM      % Ignoring space at the beginning and end avoids an occasional spurious
2780*8044SWilliam.Kucharski@Sun.COM      % blank line, when TeX decides to break the line at the space before the
2781*8044SWilliam.Kucharski@Sun.COM      % box from the multistrut, so the strut ends up on a line by itself.
2782*8044SWilliam.Kucharski@Sun.COM      % For example:
2783*8044SWilliam.Kucharski@Sun.COM      % @multitable @columnfractions .11 .89
2784*8044SWilliam.Kucharski@Sun.COM      % @item @code{#}
2785*8044SWilliam.Kucharski@Sun.COM      % @tab Legal holiday which is valid in major parts of the whole country.
2786*8044SWilliam.Kucharski@Sun.COM      % Is automatically provided with highlighting sequences respectively
2787*8044SWilliam.Kucharski@Sun.COM      % marking characters.
2788*8044SWilliam.Kucharski@Sun.COM      \noindent\ignorespaces##\unskip\multistrut
2789*8044SWilliam.Kucharski@Sun.COM    }\cr
2790*8044SWilliam.Kucharski@Sun.COM}
2791*8044SWilliam.Kucharski@Sun.COM\def\Emultitable{%
2792*8044SWilliam.Kucharski@Sun.COM  \crcr
2793*8044SWilliam.Kucharski@Sun.COM  \egroup % end the \halign
2794*8044SWilliam.Kucharski@Sun.COM  \global\setpercentfalse
2795*8044SWilliam.Kucharski@Sun.COM}
2796*8044SWilliam.Kucharski@Sun.COM
2797*8044SWilliam.Kucharski@Sun.COM\def\setmultitablespacing{%
2798*8044SWilliam.Kucharski@Sun.COM  \def\multistrut{\strut}% just use the standard line spacing
2799*8044SWilliam.Kucharski@Sun.COM  %
2800*8044SWilliam.Kucharski@Sun.COM  % Compute \multitablelinespace (if not defined by user) for use in
2801*8044SWilliam.Kucharski@Sun.COM  % \multitableparskip calculation.  We used define \multistrut based on
2802*8044SWilliam.Kucharski@Sun.COM  % this, but (ironically) that caused the spacing to be off.
2803*8044SWilliam.Kucharski@Sun.COM  % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2804*8044SWilliam.Kucharski@Sun.COM\ifdim\multitablelinespace=0pt
2805*8044SWilliam.Kucharski@Sun.COM\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2806*8044SWilliam.Kucharski@Sun.COM\global\advance\multitablelinespace by-\ht0
2807*8044SWilliam.Kucharski@Sun.COM\fi
2808*8044SWilliam.Kucharski@Sun.COM%% Test to see if parskip is larger than space between lines of
2809*8044SWilliam.Kucharski@Sun.COM%% table. If not, do nothing.
2810*8044SWilliam.Kucharski@Sun.COM%%        If so, set to same dimension as multitablelinespace.
2811*8044SWilliam.Kucharski@Sun.COM\ifdim\multitableparskip>\multitablelinespace
2812*8044SWilliam.Kucharski@Sun.COM\global\multitableparskip=\multitablelinespace
2813*8044SWilliam.Kucharski@Sun.COM\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2814*8044SWilliam.Kucharski@Sun.COM                                      %% than skip between lines in the table.
2815*8044SWilliam.Kucharski@Sun.COM\fi%
2816*8044SWilliam.Kucharski@Sun.COM\ifdim\multitableparskip=0pt
2817*8044SWilliam.Kucharski@Sun.COM\global\multitableparskip=\multitablelinespace
2818*8044SWilliam.Kucharski@Sun.COM\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2819*8044SWilliam.Kucharski@Sun.COM                                      %% than skip between lines in the table.
2820*8044SWilliam.Kucharski@Sun.COM\fi}
2821*8044SWilliam.Kucharski@Sun.COM
2822*8044SWilliam.Kucharski@Sun.COM
2823*8044SWilliam.Kucharski@Sun.COM\message{conditionals,}
2824*8044SWilliam.Kucharski@Sun.COM
2825*8044SWilliam.Kucharski@Sun.COM% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2826*8044SWilliam.Kucharski@Sun.COM% @ifnotxml always succeed.  They currently do nothing; we don't
2827*8044SWilliam.Kucharski@Sun.COM% attempt to check whether the conditionals are properly nested.  But we
2828*8044SWilliam.Kucharski@Sun.COM% have to remember that they are conditionals, so that @end doesn't
2829*8044SWilliam.Kucharski@Sun.COM% attempt to close an environment group.
2830*8044SWilliam.Kucharski@Sun.COM%
2831*8044SWilliam.Kucharski@Sun.COM\def\makecond#1{%
2832*8044SWilliam.Kucharski@Sun.COM  \expandafter\let\csname #1\endcsname = \relax
2833*8044SWilliam.Kucharski@Sun.COM  \expandafter\let\csname iscond.#1\endcsname = 1
2834*8044SWilliam.Kucharski@Sun.COM}
2835*8044SWilliam.Kucharski@Sun.COM\makecond{iftex}
2836*8044SWilliam.Kucharski@Sun.COM\makecond{ifnotdocbook}
2837*8044SWilliam.Kucharski@Sun.COM\makecond{ifnothtml}
2838*8044SWilliam.Kucharski@Sun.COM\makecond{ifnotinfo}
2839*8044SWilliam.Kucharski@Sun.COM\makecond{ifnotplaintext}
2840*8044SWilliam.Kucharski@Sun.COM\makecond{ifnotxml}
2841*8044SWilliam.Kucharski@Sun.COM
2842*8044SWilliam.Kucharski@Sun.COM% Ignore @ignore, @ifhtml, @ifinfo, and the like.
2843*8044SWilliam.Kucharski@Sun.COM%
2844*8044SWilliam.Kucharski@Sun.COM\def\direntry{\doignore{direntry}}
2845*8044SWilliam.Kucharski@Sun.COM\def\documentdescription{\doignore{documentdescription}}
2846*8044SWilliam.Kucharski@Sun.COM\def\docbook{\doignore{docbook}}
2847*8044SWilliam.Kucharski@Sun.COM\def\html{\doignore{html}}
2848*8044SWilliam.Kucharski@Sun.COM\def\ifdocbook{\doignore{ifdocbook}}
2849*8044SWilliam.Kucharski@Sun.COM\def\ifhtml{\doignore{ifhtml}}
2850*8044SWilliam.Kucharski@Sun.COM\def\ifinfo{\doignore{ifinfo}}
2851*8044SWilliam.Kucharski@Sun.COM\def\ifnottex{\doignore{ifnottex}}
2852*8044SWilliam.Kucharski@Sun.COM\def\ifplaintext{\doignore{ifplaintext}}
2853*8044SWilliam.Kucharski@Sun.COM\def\ifxml{\doignore{ifxml}}
2854*8044SWilliam.Kucharski@Sun.COM\def\ignore{\doignore{ignore}}
2855*8044SWilliam.Kucharski@Sun.COM\def\menu{\doignore{menu}}
2856*8044SWilliam.Kucharski@Sun.COM\def\xml{\doignore{xml}}
2857*8044SWilliam.Kucharski@Sun.COM
2858*8044SWilliam.Kucharski@Sun.COM% Ignore text until a line `@end #1', keeping track of nested conditionals.
2859*8044SWilliam.Kucharski@Sun.COM%
2860*8044SWilliam.Kucharski@Sun.COM% A count to remember the depth of nesting.
2861*8044SWilliam.Kucharski@Sun.COM\newcount\doignorecount
2862*8044SWilliam.Kucharski@Sun.COM
2863*8044SWilliam.Kucharski@Sun.COM\def\doignore#1{\begingroup
2864*8044SWilliam.Kucharski@Sun.COM  % Scan in ``verbatim'' mode:
2865*8044SWilliam.Kucharski@Sun.COM  \catcode`\@ = \other
2866*8044SWilliam.Kucharski@Sun.COM  \catcode`\{ = \other
2867*8044SWilliam.Kucharski@Sun.COM  \catcode`\} = \other
2868*8044SWilliam.Kucharski@Sun.COM  %
2869*8044SWilliam.Kucharski@Sun.COM  % Make sure that spaces turn into tokens that match what \doignoretext wants.
2870*8044SWilliam.Kucharski@Sun.COM  \spaceisspace
2871*8044SWilliam.Kucharski@Sun.COM  %
2872*8044SWilliam.Kucharski@Sun.COM  % Count number of #1's that we've seen.
2873*8044SWilliam.Kucharski@Sun.COM  \doignorecount = 0
2874*8044SWilliam.Kucharski@Sun.COM  %
2875*8044SWilliam.Kucharski@Sun.COM  % Swallow text until we reach the matching `@end #1'.
2876*8044SWilliam.Kucharski@Sun.COM  \dodoignore{#1}%
2877*8044SWilliam.Kucharski@Sun.COM}
2878*8044SWilliam.Kucharski@Sun.COM
2879*8044SWilliam.Kucharski@Sun.COM{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2880*8044SWilliam.Kucharski@Sun.COM  \obeylines %
2881*8044SWilliam.Kucharski@Sun.COM  %
2882*8044SWilliam.Kucharski@Sun.COM  \gdef\dodoignore#1{%
2883*8044SWilliam.Kucharski@Sun.COM    % #1 contains the command name as a string, e.g., `ifinfo'.
2884*8044SWilliam.Kucharski@Sun.COM    %
2885*8044SWilliam.Kucharski@Sun.COM    % Define a command to find the next `@end #1', which must be on a line
2886*8044SWilliam.Kucharski@Sun.COM    % by itself.
2887*8044SWilliam.Kucharski@Sun.COM    \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2888*8044SWilliam.Kucharski@Sun.COM    % And this command to find another #1 command, at the beginning of a
2889*8044SWilliam.Kucharski@Sun.COM    % line.  (Otherwise, we would consider a line `@c @ifset', for
2890*8044SWilliam.Kucharski@Sun.COM    % example, to count as an @ifset for nesting.)
2891*8044SWilliam.Kucharski@Sun.COM    \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2892*8044SWilliam.Kucharski@Sun.COM    %
2893*8044SWilliam.Kucharski@Sun.COM    % And now expand that command.
2894*8044SWilliam.Kucharski@Sun.COM    \obeylines %
2895*8044SWilliam.Kucharski@Sun.COM    \doignoretext ^^M%
2896*8044SWilliam.Kucharski@Sun.COM  }%
2897*8044SWilliam.Kucharski@Sun.COM}
2898*8044SWilliam.Kucharski@Sun.COM
2899*8044SWilliam.Kucharski@Sun.COM\def\doignoreyyy#1{%
2900*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
2901*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\empty			% Nothing found.
2902*8044SWilliam.Kucharski@Sun.COM    \let\next\doignoretextzzz
2903*8044SWilliam.Kucharski@Sun.COM  \else					% Found a nested condition, ...
2904*8044SWilliam.Kucharski@Sun.COM    \advance\doignorecount by 1
2905*8044SWilliam.Kucharski@Sun.COM    \let\next\doignoretextyyy		% ..., look for another.
2906*8044SWilliam.Kucharski@Sun.COM    % If we're here, #1 ends with ^^M\ifinfo (for example).
2907*8044SWilliam.Kucharski@Sun.COM  \fi
2908*8044SWilliam.Kucharski@Sun.COM  \next #1% the token \_STOP_ is present just after this macro.
2909*8044SWilliam.Kucharski@Sun.COM}
2910*8044SWilliam.Kucharski@Sun.COM
2911*8044SWilliam.Kucharski@Sun.COM% We have to swallow the remaining "\_STOP_".
2912*8044SWilliam.Kucharski@Sun.COM%
2913*8044SWilliam.Kucharski@Sun.COM\def\doignoretextzzz#1{%
2914*8044SWilliam.Kucharski@Sun.COM  \ifnum\doignorecount = 0	% We have just found the outermost @end.
2915*8044SWilliam.Kucharski@Sun.COM    \let\next\enddoignore
2916*8044SWilliam.Kucharski@Sun.COM  \else				% Still inside a nested condition.
2917*8044SWilliam.Kucharski@Sun.COM    \advance\doignorecount by -1
2918*8044SWilliam.Kucharski@Sun.COM    \let\next\doignoretext      % Look for the next @end.
2919*8044SWilliam.Kucharski@Sun.COM  \fi
2920*8044SWilliam.Kucharski@Sun.COM  \next
2921*8044SWilliam.Kucharski@Sun.COM}
2922*8044SWilliam.Kucharski@Sun.COM
2923*8044SWilliam.Kucharski@Sun.COM% Finish off ignored text.
2924*8044SWilliam.Kucharski@Sun.COM\def\enddoignore{\endgroup\ignorespaces}
2925*8044SWilliam.Kucharski@Sun.COM
2926*8044SWilliam.Kucharski@Sun.COM
2927*8044SWilliam.Kucharski@Sun.COM% @set VAR sets the variable VAR to an empty value.
2928*8044SWilliam.Kucharski@Sun.COM% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2929*8044SWilliam.Kucharski@Sun.COM%
2930*8044SWilliam.Kucharski@Sun.COM% Since we want to separate VAR from REST-OF-LINE (which might be
2931*8044SWilliam.Kucharski@Sun.COM% empty), we can't just use \parsearg; we have to insert a space of our
2932*8044SWilliam.Kucharski@Sun.COM% own to delimit the rest of the line, and then take it out again if we
2933*8044SWilliam.Kucharski@Sun.COM% didn't need it.
2934*8044SWilliam.Kucharski@Sun.COM% We rely on the fact that \parsearg sets \catcode`\ =10.
2935*8044SWilliam.Kucharski@Sun.COM%
2936*8044SWilliam.Kucharski@Sun.COM\parseargdef\set{\setyyy#1 \endsetyyy}
2937*8044SWilliam.Kucharski@Sun.COM\def\setyyy#1 #2\endsetyyy{%
2938*8044SWilliam.Kucharski@Sun.COM  {%
2939*8044SWilliam.Kucharski@Sun.COM    \makevalueexpandable
2940*8044SWilliam.Kucharski@Sun.COM    \def\temp{#2}%
2941*8044SWilliam.Kucharski@Sun.COM    \edef\next{\gdef\makecsname{SET#1}}%
2942*8044SWilliam.Kucharski@Sun.COM    \ifx\temp\empty
2943*8044SWilliam.Kucharski@Sun.COM      \next{}%
2944*8044SWilliam.Kucharski@Sun.COM    \else
2945*8044SWilliam.Kucharski@Sun.COM      \setzzz#2\endsetzzz
2946*8044SWilliam.Kucharski@Sun.COM    \fi
2947*8044SWilliam.Kucharski@Sun.COM  }%
2948*8044SWilliam.Kucharski@Sun.COM}
2949*8044SWilliam.Kucharski@Sun.COM% Remove the trailing space \setxxx inserted.
2950*8044SWilliam.Kucharski@Sun.COM\def\setzzz#1 \endsetzzz{\next{#1}}
2951*8044SWilliam.Kucharski@Sun.COM
2952*8044SWilliam.Kucharski@Sun.COM% @clear VAR clears (i.e., unsets) the variable VAR.
2953*8044SWilliam.Kucharski@Sun.COM%
2954*8044SWilliam.Kucharski@Sun.COM\parseargdef\clear{%
2955*8044SWilliam.Kucharski@Sun.COM  {%
2956*8044SWilliam.Kucharski@Sun.COM    \makevalueexpandable
2957*8044SWilliam.Kucharski@Sun.COM    \global\expandafter\let\csname SET#1\endcsname=\relax
2958*8044SWilliam.Kucharski@Sun.COM  }%
2959*8044SWilliam.Kucharski@Sun.COM}
2960*8044SWilliam.Kucharski@Sun.COM
2961*8044SWilliam.Kucharski@Sun.COM% @value{foo} gets the text saved in variable foo.
2962*8044SWilliam.Kucharski@Sun.COM\def\value{\begingroup\makevalueexpandable\valuexxx}
2963*8044SWilliam.Kucharski@Sun.COM\def\valuexxx#1{\expandablevalue{#1}\endgroup}
2964*8044SWilliam.Kucharski@Sun.COM{
2965*8044SWilliam.Kucharski@Sun.COM  \catcode`\- = \active \catcode`\_ = \active
2966*8044SWilliam.Kucharski@Sun.COM  %
2967*8044SWilliam.Kucharski@Sun.COM  \gdef\makevalueexpandable{%
2968*8044SWilliam.Kucharski@Sun.COM    \let\value = \expandablevalue
2969*8044SWilliam.Kucharski@Sun.COM    % We don't want these characters active, ...
2970*8044SWilliam.Kucharski@Sun.COM    \catcode`\-=\other \catcode`\_=\other
2971*8044SWilliam.Kucharski@Sun.COM    % ..., but we might end up with active ones in the argument if
2972*8044SWilliam.Kucharski@Sun.COM    % we're called from @code, as @code{@value{foo-bar_}}, though.
2973*8044SWilliam.Kucharski@Sun.COM    % So \let them to their normal equivalents.
2974*8044SWilliam.Kucharski@Sun.COM    \let-\realdash \let_\normalunderscore
2975*8044SWilliam.Kucharski@Sun.COM  }
2976*8044SWilliam.Kucharski@Sun.COM}
2977*8044SWilliam.Kucharski@Sun.COM
2978*8044SWilliam.Kucharski@Sun.COM% We have this subroutine so that we can handle at least some @value's
2979*8044SWilliam.Kucharski@Sun.COM% properly in indexes (we call \makevalueexpandable in \indexdummies).
2980*8044SWilliam.Kucharski@Sun.COM% The command has to be fully expandable (if the variable is set), since
2981*8044SWilliam.Kucharski@Sun.COM% the result winds up in the index file.  This means that if the
2982*8044SWilliam.Kucharski@Sun.COM% variable's value contains other Texinfo commands, it's almost certain
2983*8044SWilliam.Kucharski@Sun.COM% it will fail (although perhaps we could fix that with sufficient work
2984*8044SWilliam.Kucharski@Sun.COM% to do a one-level expansion on the result, instead of complete).
2985*8044SWilliam.Kucharski@Sun.COM%
2986*8044SWilliam.Kucharski@Sun.COM\def\expandablevalue#1{%
2987*8044SWilliam.Kucharski@Sun.COM  \expandafter\ifx\csname SET#1\endcsname\relax
2988*8044SWilliam.Kucharski@Sun.COM    {[No value for ``#1'']}%
2989*8044SWilliam.Kucharski@Sun.COM    \message{Variable `#1', used in @value, is not set.}%
2990*8044SWilliam.Kucharski@Sun.COM  \else
2991*8044SWilliam.Kucharski@Sun.COM    \csname SET#1\endcsname
2992*8044SWilliam.Kucharski@Sun.COM  \fi
2993*8044SWilliam.Kucharski@Sun.COM}
2994*8044SWilliam.Kucharski@Sun.COM
2995*8044SWilliam.Kucharski@Sun.COM% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2996*8044SWilliam.Kucharski@Sun.COM% with @set.
2997*8044SWilliam.Kucharski@Sun.COM%
2998*8044SWilliam.Kucharski@Sun.COM% To get special treatment of `@end ifset,' call \makeond and the redefine.
2999*8044SWilliam.Kucharski@Sun.COM%
3000*8044SWilliam.Kucharski@Sun.COM\makecond{ifset}
3001*8044SWilliam.Kucharski@Sun.COM\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3002*8044SWilliam.Kucharski@Sun.COM\def\doifset#1#2{%
3003*8044SWilliam.Kucharski@Sun.COM  {%
3004*8044SWilliam.Kucharski@Sun.COM    \makevalueexpandable
3005*8044SWilliam.Kucharski@Sun.COM    \let\next=\empty
3006*8044SWilliam.Kucharski@Sun.COM    \expandafter\ifx\csname SET#2\endcsname\relax
3007*8044SWilliam.Kucharski@Sun.COM      #1% If not set, redefine \next.
3008*8044SWilliam.Kucharski@Sun.COM    \fi
3009*8044SWilliam.Kucharski@Sun.COM    \expandafter
3010*8044SWilliam.Kucharski@Sun.COM  }\next
3011*8044SWilliam.Kucharski@Sun.COM}
3012*8044SWilliam.Kucharski@Sun.COM\def\ifsetfail{\doignore{ifset}}
3013*8044SWilliam.Kucharski@Sun.COM
3014*8044SWilliam.Kucharski@Sun.COM% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3015*8044SWilliam.Kucharski@Sun.COM% defined with @set, or has been undefined with @clear.
3016*8044SWilliam.Kucharski@Sun.COM%
3017*8044SWilliam.Kucharski@Sun.COM% The `\else' inside the `\doifset' parameter is a trick to reuse the
3018*8044SWilliam.Kucharski@Sun.COM% above code: if the variable is not set, do nothing, if it is set,
3019*8044SWilliam.Kucharski@Sun.COM% then redefine \next to \ifclearfail.
3020*8044SWilliam.Kucharski@Sun.COM%
3021*8044SWilliam.Kucharski@Sun.COM\makecond{ifclear}
3022*8044SWilliam.Kucharski@Sun.COM\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3023*8044SWilliam.Kucharski@Sun.COM\def\ifclearfail{\doignore{ifclear}}
3024*8044SWilliam.Kucharski@Sun.COM
3025*8044SWilliam.Kucharski@Sun.COM% @dircategory CATEGORY  -- specify a category of the dir file
3026*8044SWilliam.Kucharski@Sun.COM% which this file should belong to.  Ignore this in TeX.
3027*8044SWilliam.Kucharski@Sun.COM\let\dircategory=\comment
3028*8044SWilliam.Kucharski@Sun.COM
3029*8044SWilliam.Kucharski@Sun.COM% @defininfoenclose.
3030*8044SWilliam.Kucharski@Sun.COM\let\definfoenclose=\comment
3031*8044SWilliam.Kucharski@Sun.COM
3032*8044SWilliam.Kucharski@Sun.COM
3033*8044SWilliam.Kucharski@Sun.COM\message{indexing,}
3034*8044SWilliam.Kucharski@Sun.COM% Index generation facilities
3035*8044SWilliam.Kucharski@Sun.COM
3036*8044SWilliam.Kucharski@Sun.COM% Define \newwrite to be identical to plain tex's \newwrite
3037*8044SWilliam.Kucharski@Sun.COM% except not \outer, so it can be used within macros and \if's.
3038*8044SWilliam.Kucharski@Sun.COM\edef\newwrite{\makecsname{ptexnewwrite}}
3039*8044SWilliam.Kucharski@Sun.COM
3040*8044SWilliam.Kucharski@Sun.COM% \newindex {foo} defines an index named foo.
3041*8044SWilliam.Kucharski@Sun.COM% It automatically defines \fooindex such that
3042*8044SWilliam.Kucharski@Sun.COM% \fooindex ...rest of line... puts an entry in the index foo.
3043*8044SWilliam.Kucharski@Sun.COM% It also defines \fooindfile to be the number of the output channel for
3044*8044SWilliam.Kucharski@Sun.COM% the file that accumulates this index.  The file's extension is foo.
3045*8044SWilliam.Kucharski@Sun.COM% The name of an index should be no more than 2 characters long
3046*8044SWilliam.Kucharski@Sun.COM% for the sake of vms.
3047*8044SWilliam.Kucharski@Sun.COM%
3048*8044SWilliam.Kucharski@Sun.COM\def\newindex#1{%
3049*8044SWilliam.Kucharski@Sun.COM  \iflinks
3050*8044SWilliam.Kucharski@Sun.COM    \expandafter\newwrite \csname#1indfile\endcsname
3051*8044SWilliam.Kucharski@Sun.COM    \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3052*8044SWilliam.Kucharski@Sun.COM  \fi
3053*8044SWilliam.Kucharski@Sun.COM  \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
3054*8044SWilliam.Kucharski@Sun.COM    \noexpand\doindex{#1}}
3055*8044SWilliam.Kucharski@Sun.COM}
3056*8044SWilliam.Kucharski@Sun.COM
3057*8044SWilliam.Kucharski@Sun.COM% @defindex foo  ==  \newindex{foo}
3058*8044SWilliam.Kucharski@Sun.COM%
3059*8044SWilliam.Kucharski@Sun.COM\def\defindex{\parsearg\newindex}
3060*8044SWilliam.Kucharski@Sun.COM
3061*8044SWilliam.Kucharski@Sun.COM% Define @defcodeindex, like @defindex except put all entries in @code.
3062*8044SWilliam.Kucharski@Sun.COM%
3063*8044SWilliam.Kucharski@Sun.COM\def\defcodeindex{\parsearg\newcodeindex}
3064*8044SWilliam.Kucharski@Sun.COM%
3065*8044SWilliam.Kucharski@Sun.COM\def\newcodeindex#1{%
3066*8044SWilliam.Kucharski@Sun.COM  \iflinks
3067*8044SWilliam.Kucharski@Sun.COM    \expandafter\newwrite \csname#1indfile\endcsname
3068*8044SWilliam.Kucharski@Sun.COM    \openout \csname#1indfile\endcsname \jobname.#1
3069*8044SWilliam.Kucharski@Sun.COM  \fi
3070*8044SWilliam.Kucharski@Sun.COM  \expandafter\xdef\csname#1index\endcsname{%
3071*8044SWilliam.Kucharski@Sun.COM    \noexpand\docodeindex{#1}}%
3072*8044SWilliam.Kucharski@Sun.COM}
3073*8044SWilliam.Kucharski@Sun.COM
3074*8044SWilliam.Kucharski@Sun.COM
3075*8044SWilliam.Kucharski@Sun.COM% @synindex foo bar    makes index foo feed into index bar.
3076*8044SWilliam.Kucharski@Sun.COM% Do this instead of @defindex foo if you don't want it as a separate index.
3077*8044SWilliam.Kucharski@Sun.COM%
3078*8044SWilliam.Kucharski@Sun.COM% @syncodeindex foo bar   similar, but put all entries made for index foo
3079*8044SWilliam.Kucharski@Sun.COM% inside @code.
3080*8044SWilliam.Kucharski@Sun.COM%
3081*8044SWilliam.Kucharski@Sun.COM\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3082*8044SWilliam.Kucharski@Sun.COM\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3083*8044SWilliam.Kucharski@Sun.COM
3084*8044SWilliam.Kucharski@Sun.COM% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3085*8044SWilliam.Kucharski@Sun.COM% #3 the target index (bar).
3086*8044SWilliam.Kucharski@Sun.COM\def\dosynindex#1#2#3{%
3087*8044SWilliam.Kucharski@Sun.COM  % Only do \closeout if we haven't already done it, else we'll end up
3088*8044SWilliam.Kucharski@Sun.COM  % closing the target index.
3089*8044SWilliam.Kucharski@Sun.COM  \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3090*8044SWilliam.Kucharski@Sun.COM    % The \closeout helps reduce unnecessary open files; the limit on the
3091*8044SWilliam.Kucharski@Sun.COM    % Acorn RISC OS is a mere 16 files.
3092*8044SWilliam.Kucharski@Sun.COM    \expandafter\closeout\csname#2indfile\endcsname
3093*8044SWilliam.Kucharski@Sun.COM    \expandafter\let\csname\donesynindex#2\endcsname = 1
3094*8044SWilliam.Kucharski@Sun.COM  \fi
3095*8044SWilliam.Kucharski@Sun.COM  % redefine \fooindfile:
3096*8044SWilliam.Kucharski@Sun.COM  \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3097*8044SWilliam.Kucharski@Sun.COM  \expandafter\let\csname#2indfile\endcsname=\temp
3098*8044SWilliam.Kucharski@Sun.COM  % redefine \fooindex:
3099*8044SWilliam.Kucharski@Sun.COM  \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3100*8044SWilliam.Kucharski@Sun.COM}
3101*8044SWilliam.Kucharski@Sun.COM
3102*8044SWilliam.Kucharski@Sun.COM% Define \doindex, the driver for all \fooindex macros.
3103*8044SWilliam.Kucharski@Sun.COM% Argument #1 is generated by the calling \fooindex macro,
3104*8044SWilliam.Kucharski@Sun.COM%  and it is "foo", the name of the index.
3105*8044SWilliam.Kucharski@Sun.COM
3106*8044SWilliam.Kucharski@Sun.COM% \doindex just uses \parsearg; it calls \doind for the actual work.
3107*8044SWilliam.Kucharski@Sun.COM% This is because \doind is more useful to call from other macros.
3108*8044SWilliam.Kucharski@Sun.COM
3109*8044SWilliam.Kucharski@Sun.COM% There is also \dosubind {index}{topic}{subtopic}
3110*8044SWilliam.Kucharski@Sun.COM% which makes an entry in a two-level index such as the operation index.
3111*8044SWilliam.Kucharski@Sun.COM
3112*8044SWilliam.Kucharski@Sun.COM\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3113*8044SWilliam.Kucharski@Sun.COM\def\singleindexer #1{\doind{\indexname}{#1}}
3114*8044SWilliam.Kucharski@Sun.COM
3115*8044SWilliam.Kucharski@Sun.COM% like the previous two, but they put @code around the argument.
3116*8044SWilliam.Kucharski@Sun.COM\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3117*8044SWilliam.Kucharski@Sun.COM\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3118*8044SWilliam.Kucharski@Sun.COM
3119*8044SWilliam.Kucharski@Sun.COM% Take care of Texinfo commands that can appear in an index entry.
3120*8044SWilliam.Kucharski@Sun.COM% Since there are some commands we want to expand, and others we don't,
3121*8044SWilliam.Kucharski@Sun.COM% we have to laboriously prevent expansion for those that we don't.
3122*8044SWilliam.Kucharski@Sun.COM%
3123*8044SWilliam.Kucharski@Sun.COM\def\indexdummies{%
3124*8044SWilliam.Kucharski@Sun.COM  \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3125*8044SWilliam.Kucharski@Sun.COM  \def\ {\realbackslash\space }%
3126*8044SWilliam.Kucharski@Sun.COM  % Need these in case \tex is in effect and \{ is a \delimiter again.
3127*8044SWilliam.Kucharski@Sun.COM  % But can't use \lbracecmd and \rbracecmd because texindex assumes
3128*8044SWilliam.Kucharski@Sun.COM  % braces and backslashes are used only as delimiters.
3129*8044SWilliam.Kucharski@Sun.COM  \let\{ = \mylbrace
3130*8044SWilliam.Kucharski@Sun.COM  \let\} = \myrbrace
3131*8044SWilliam.Kucharski@Sun.COM  %
3132*8044SWilliam.Kucharski@Sun.COM  % \definedummyword defines \#1 as \realbackslash #1\space, thus
3133*8044SWilliam.Kucharski@Sun.COM  % effectively preventing its expansion.  This is used only for control
3134*8044SWilliam.Kucharski@Sun.COM  % words, not control letters, because the \space would be incorrect
3135*8044SWilliam.Kucharski@Sun.COM  % for control characters, but is needed to separate the control word
3136*8044SWilliam.Kucharski@Sun.COM  % from whatever follows.
3137*8044SWilliam.Kucharski@Sun.COM  %
3138*8044SWilliam.Kucharski@Sun.COM  % For control letters, we have \definedummyletter, which omits the
3139*8044SWilliam.Kucharski@Sun.COM  % space.
3140*8044SWilliam.Kucharski@Sun.COM  %
3141*8044SWilliam.Kucharski@Sun.COM  % These can be used both for control words that take an argument and
3142*8044SWilliam.Kucharski@Sun.COM  % those that do not.  If it is followed by {arg} in the input, then
3143*8044SWilliam.Kucharski@Sun.COM  % that will dutifully get written to the index (or wherever).
3144*8044SWilliam.Kucharski@Sun.COM  %
3145*8044SWilliam.Kucharski@Sun.COM  \def\definedummyword##1{%
3146*8044SWilliam.Kucharski@Sun.COM    \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3147*8044SWilliam.Kucharski@Sun.COM  }%
3148*8044SWilliam.Kucharski@Sun.COM  \def\definedummyletter##1{%
3149*8044SWilliam.Kucharski@Sun.COM    \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3150*8044SWilliam.Kucharski@Sun.COM  }%
3151*8044SWilliam.Kucharski@Sun.COM  \let\definedummyaccent\definedummyletter
3152*8044SWilliam.Kucharski@Sun.COM  %
3153*8044SWilliam.Kucharski@Sun.COM  % Do the redefinitions.
3154*8044SWilliam.Kucharski@Sun.COM  \commondummies
3155*8044SWilliam.Kucharski@Sun.COM}
3156*8044SWilliam.Kucharski@Sun.COM
3157*8044SWilliam.Kucharski@Sun.COM% For the aux file, @ is the escape character.  So we want to redefine
3158*8044SWilliam.Kucharski@Sun.COM% everything using @ instead of \realbackslash.  When everything uses
3159*8044SWilliam.Kucharski@Sun.COM% @, this will be simpler.
3160*8044SWilliam.Kucharski@Sun.COM%
3161*8044SWilliam.Kucharski@Sun.COM\def\atdummies{%
3162*8044SWilliam.Kucharski@Sun.COM  \def\@{@@}%
3163*8044SWilliam.Kucharski@Sun.COM  \def\ {@ }%
3164*8044SWilliam.Kucharski@Sun.COM  \let\{ = \lbraceatcmd
3165*8044SWilliam.Kucharski@Sun.COM  \let\} = \rbraceatcmd
3166*8044SWilliam.Kucharski@Sun.COM  %
3167*8044SWilliam.Kucharski@Sun.COM  % (See comments in \indexdummies.)
3168*8044SWilliam.Kucharski@Sun.COM  \def\definedummyword##1{%
3169*8044SWilliam.Kucharski@Sun.COM    \expandafter\def\csname ##1\endcsname{@##1\space}%
3170*8044SWilliam.Kucharski@Sun.COM  }%
3171*8044SWilliam.Kucharski@Sun.COM  \def\definedummyletter##1{%
3172*8044SWilliam.Kucharski@Sun.COM    \expandafter\def\csname ##1\endcsname{@##1}%
3173*8044SWilliam.Kucharski@Sun.COM  }%
3174*8044SWilliam.Kucharski@Sun.COM  \let\definedummyaccent\definedummyletter
3175*8044SWilliam.Kucharski@Sun.COM  %
3176*8044SWilliam.Kucharski@Sun.COM  % Do the redefinitions.
3177*8044SWilliam.Kucharski@Sun.COM  \commondummies
3178*8044SWilliam.Kucharski@Sun.COM}
3179*8044SWilliam.Kucharski@Sun.COM
3180*8044SWilliam.Kucharski@Sun.COM% Called from \indexdummies and \atdummies.  \definedummyword and
3181*8044SWilliam.Kucharski@Sun.COM% \definedummyletter must be defined first.
3182*8044SWilliam.Kucharski@Sun.COM%
3183*8044SWilliam.Kucharski@Sun.COM\def\commondummies{%
3184*8044SWilliam.Kucharski@Sun.COM  %
3185*8044SWilliam.Kucharski@Sun.COM  \normalturnoffactive
3186*8044SWilliam.Kucharski@Sun.COM  %
3187*8044SWilliam.Kucharski@Sun.COM  \commondummiesnofonts
3188*8044SWilliam.Kucharski@Sun.COM  %
3189*8044SWilliam.Kucharski@Sun.COM  \definedummyletter{_}%
3190*8044SWilliam.Kucharski@Sun.COM  %
3191*8044SWilliam.Kucharski@Sun.COM  % Non-English letters.
3192*8044SWilliam.Kucharski@Sun.COM  \definedummyword{AA}%
3193*8044SWilliam.Kucharski@Sun.COM  \definedummyword{AE}%
3194*8044SWilliam.Kucharski@Sun.COM  \definedummyword{L}%
3195*8044SWilliam.Kucharski@Sun.COM  \definedummyword{OE}%
3196*8044SWilliam.Kucharski@Sun.COM  \definedummyword{O}%
3197*8044SWilliam.Kucharski@Sun.COM  \definedummyword{aa}%
3198*8044SWilliam.Kucharski@Sun.COM  \definedummyword{ae}%
3199*8044SWilliam.Kucharski@Sun.COM  \definedummyword{l}%
3200*8044SWilliam.Kucharski@Sun.COM  \definedummyword{oe}%
3201*8044SWilliam.Kucharski@Sun.COM  \definedummyword{o}%
3202*8044SWilliam.Kucharski@Sun.COM  \definedummyword{ss}%
3203*8044SWilliam.Kucharski@Sun.COM  \definedummyword{exclamdown}%
3204*8044SWilliam.Kucharski@Sun.COM  \definedummyword{questiondown}%
3205*8044SWilliam.Kucharski@Sun.COM  \definedummyword{ordf}%
3206*8044SWilliam.Kucharski@Sun.COM  \definedummyword{ordm}%
3207*8044SWilliam.Kucharski@Sun.COM  %
3208*8044SWilliam.Kucharski@Sun.COM  % Although these internal commands shouldn't show up, sometimes they do.
3209*8044SWilliam.Kucharski@Sun.COM  \definedummyword{bf}%
3210*8044SWilliam.Kucharski@Sun.COM  \definedummyword{gtr}%
3211*8044SWilliam.Kucharski@Sun.COM  \definedummyword{hat}%
3212*8044SWilliam.Kucharski@Sun.COM  \definedummyword{less}%
3213*8044SWilliam.Kucharski@Sun.COM  \definedummyword{sf}%
3214*8044SWilliam.Kucharski@Sun.COM  \definedummyword{sl}%
3215*8044SWilliam.Kucharski@Sun.COM  \definedummyword{tclose}%
3216*8044SWilliam.Kucharski@Sun.COM  \definedummyword{tt}%
3217*8044SWilliam.Kucharski@Sun.COM  %
3218*8044SWilliam.Kucharski@Sun.COM  \definedummyword{LaTeX}%
3219*8044SWilliam.Kucharski@Sun.COM  \definedummyword{TeX}%
3220*8044SWilliam.Kucharski@Sun.COM  %
3221*8044SWilliam.Kucharski@Sun.COM  % Assorted special characters.
3222*8044SWilliam.Kucharski@Sun.COM  \definedummyword{bullet}%
3223*8044SWilliam.Kucharski@Sun.COM  \definedummyword{comma}%
3224*8044SWilliam.Kucharski@Sun.COM  \definedummyword{copyright}%
3225*8044SWilliam.Kucharski@Sun.COM  \definedummyword{registeredsymbol}%
3226*8044SWilliam.Kucharski@Sun.COM  \definedummyword{dots}%
3227*8044SWilliam.Kucharski@Sun.COM  \definedummyword{enddots}%
3228*8044SWilliam.Kucharski@Sun.COM  \definedummyword{equiv}%
3229*8044SWilliam.Kucharski@Sun.COM  \definedummyword{error}%
3230*8044SWilliam.Kucharski@Sun.COM  \definedummyword{euro}%
3231*8044SWilliam.Kucharski@Sun.COM  \definedummyword{expansion}%
3232*8044SWilliam.Kucharski@Sun.COM  \definedummyword{minus}%
3233*8044SWilliam.Kucharski@Sun.COM  \definedummyword{pounds}%
3234*8044SWilliam.Kucharski@Sun.COM  \definedummyword{point}%
3235*8044SWilliam.Kucharski@Sun.COM  \definedummyword{print}%
3236*8044SWilliam.Kucharski@Sun.COM  \definedummyword{result}%
3237*8044SWilliam.Kucharski@Sun.COM  %
3238*8044SWilliam.Kucharski@Sun.COM  % Handle some cases of @value -- where it does not contain any
3239*8044SWilliam.Kucharski@Sun.COM  % (non-fully-expandable) commands.
3240*8044SWilliam.Kucharski@Sun.COM  \makevalueexpandable
3241*8044SWilliam.Kucharski@Sun.COM  %
3242*8044SWilliam.Kucharski@Sun.COM  % Normal spaces, not active ones.
3243*8044SWilliam.Kucharski@Sun.COM  \unsepspaces
3244*8044SWilliam.Kucharski@Sun.COM  %
3245*8044SWilliam.Kucharski@Sun.COM  % No macro expansion.
3246*8044SWilliam.Kucharski@Sun.COM  \turnoffmacros
3247*8044SWilliam.Kucharski@Sun.COM}
3248*8044SWilliam.Kucharski@Sun.COM
3249*8044SWilliam.Kucharski@Sun.COM% \commondummiesnofonts: common to \commondummies and \indexnofonts.
3250*8044SWilliam.Kucharski@Sun.COM%
3251*8044SWilliam.Kucharski@Sun.COM% Better have this without active chars.
3252*8044SWilliam.Kucharski@Sun.COM{
3253*8044SWilliam.Kucharski@Sun.COM  \catcode`\~=\other
3254*8044SWilliam.Kucharski@Sun.COM  \gdef\commondummiesnofonts{%
3255*8044SWilliam.Kucharski@Sun.COM    % Control letters and accents.
3256*8044SWilliam.Kucharski@Sun.COM    \definedummyletter{!}%
3257*8044SWilliam.Kucharski@Sun.COM    \definedummyaccent{"}%
3258*8044SWilliam.Kucharski@Sun.COM    \definedummyaccent{'}%
3259*8044SWilliam.Kucharski@Sun.COM    \definedummyletter{*}%
3260*8044SWilliam.Kucharski@Sun.COM    \definedummyaccent{,}%
3261*8044SWilliam.Kucharski@Sun.COM    \definedummyletter{.}%
3262*8044SWilliam.Kucharski@Sun.COM    \definedummyletter{/}%
3263*8044SWilliam.Kucharski@Sun.COM    \definedummyletter{:}%
3264*8044SWilliam.Kucharski@Sun.COM    \definedummyaccent{=}%
3265*8044SWilliam.Kucharski@Sun.COM    \definedummyletter{?}%
3266*8044SWilliam.Kucharski@Sun.COM    \definedummyaccent{^}%
3267*8044SWilliam.Kucharski@Sun.COM    \definedummyaccent{`}%
3268*8044SWilliam.Kucharski@Sun.COM    \definedummyaccent{~}%
3269*8044SWilliam.Kucharski@Sun.COM    \definedummyword{u}%
3270*8044SWilliam.Kucharski@Sun.COM    \definedummyword{v}%
3271*8044SWilliam.Kucharski@Sun.COM    \definedummyword{H}%
3272*8044SWilliam.Kucharski@Sun.COM    \definedummyword{dotaccent}%
3273*8044SWilliam.Kucharski@Sun.COM    \definedummyword{ringaccent}%
3274*8044SWilliam.Kucharski@Sun.COM    \definedummyword{tieaccent}%
3275*8044SWilliam.Kucharski@Sun.COM    \definedummyword{ubaraccent}%
3276*8044SWilliam.Kucharski@Sun.COM    \definedummyword{udotaccent}%
3277*8044SWilliam.Kucharski@Sun.COM    \definedummyword{dotless}%
3278*8044SWilliam.Kucharski@Sun.COM    %
3279*8044SWilliam.Kucharski@Sun.COM    % Texinfo font commands.
3280*8044SWilliam.Kucharski@Sun.COM    \definedummyword{b}%
3281*8044SWilliam.Kucharski@Sun.COM    \definedummyword{i}%
3282*8044SWilliam.Kucharski@Sun.COM    \definedummyword{r}%
3283*8044SWilliam.Kucharski@Sun.COM    \definedummyword{sc}%
3284*8044SWilliam.Kucharski@Sun.COM    \definedummyword{t}%
3285*8044SWilliam.Kucharski@Sun.COM    %
3286*8044SWilliam.Kucharski@Sun.COM    % Commands that take arguments.
3287*8044SWilliam.Kucharski@Sun.COM    \definedummyword{acronym}%
3288*8044SWilliam.Kucharski@Sun.COM    \definedummyword{cite}%
3289*8044SWilliam.Kucharski@Sun.COM    \definedummyword{code}%
3290*8044SWilliam.Kucharski@Sun.COM    \definedummyword{command}%
3291*8044SWilliam.Kucharski@Sun.COM    \definedummyword{dfn}%
3292*8044SWilliam.Kucharski@Sun.COM    \definedummyword{emph}%
3293*8044SWilliam.Kucharski@Sun.COM    \definedummyword{env}%
3294*8044SWilliam.Kucharski@Sun.COM    \definedummyword{file}%
3295*8044SWilliam.Kucharski@Sun.COM    \definedummyword{kbd}%
3296*8044SWilliam.Kucharski@Sun.COM    \definedummyword{key}%
3297*8044SWilliam.Kucharski@Sun.COM    \definedummyword{math}%
3298*8044SWilliam.Kucharski@Sun.COM    \definedummyword{option}%
3299*8044SWilliam.Kucharski@Sun.COM    \definedummyword{samp}%
3300*8044SWilliam.Kucharski@Sun.COM    \definedummyword{strong}%
3301*8044SWilliam.Kucharski@Sun.COM    \definedummyword{tie}%
3302*8044SWilliam.Kucharski@Sun.COM    \definedummyword{uref}%
3303*8044SWilliam.Kucharski@Sun.COM    \definedummyword{url}%
3304*8044SWilliam.Kucharski@Sun.COM    \definedummyword{var}%
3305*8044SWilliam.Kucharski@Sun.COM    \definedummyword{verb}%
3306*8044SWilliam.Kucharski@Sun.COM    \definedummyword{w}%
3307*8044SWilliam.Kucharski@Sun.COM  }
3308*8044SWilliam.Kucharski@Sun.COM}
3309*8044SWilliam.Kucharski@Sun.COM
3310*8044SWilliam.Kucharski@Sun.COM% \indexnofonts is used when outputting the strings to sort the index
3311*8044SWilliam.Kucharski@Sun.COM% by, and when constructing control sequence names.  It eliminates all
3312*8044SWilliam.Kucharski@Sun.COM% control sequences and just writes whatever the best ASCII sort string
3313*8044SWilliam.Kucharski@Sun.COM% would be for a given command (usually its argument).
3314*8044SWilliam.Kucharski@Sun.COM%
3315*8044SWilliam.Kucharski@Sun.COM\def\indexnofonts{%
3316*8044SWilliam.Kucharski@Sun.COM  % Accent commands should become @asis.
3317*8044SWilliam.Kucharski@Sun.COM  \def\definedummyaccent##1{%
3318*8044SWilliam.Kucharski@Sun.COM    \expandafter\let\csname ##1\endcsname\asis
3319*8044SWilliam.Kucharski@Sun.COM  }%
3320*8044SWilliam.Kucharski@Sun.COM  % We can just ignore other control letters.
3321*8044SWilliam.Kucharski@Sun.COM  \def\definedummyletter##1{%
3322*8044SWilliam.Kucharski@Sun.COM    \expandafter\def\csname ##1\endcsname{}%
3323*8044SWilliam.Kucharski@Sun.COM  }%
3324*8044SWilliam.Kucharski@Sun.COM  % Hopefully, all control words can become @asis.
3325*8044SWilliam.Kucharski@Sun.COM  \let\definedummyword\definedummyaccent
3326*8044SWilliam.Kucharski@Sun.COM  %
3327*8044SWilliam.Kucharski@Sun.COM  \commondummiesnofonts
3328*8044SWilliam.Kucharski@Sun.COM  %
3329*8044SWilliam.Kucharski@Sun.COM  % Don't no-op \tt, since it isn't a user-level command
3330*8044SWilliam.Kucharski@Sun.COM  % and is used in the definitions of the active chars like <, >, |, etc.
3331*8044SWilliam.Kucharski@Sun.COM  % Likewise with the other plain tex font commands.
3332*8044SWilliam.Kucharski@Sun.COM  %\let\tt=\asis
3333*8044SWilliam.Kucharski@Sun.COM  %
3334*8044SWilliam.Kucharski@Sun.COM  \def\ { }%
3335*8044SWilliam.Kucharski@Sun.COM  \def\@{@}%
3336*8044SWilliam.Kucharski@Sun.COM  % how to handle braces?
3337*8044SWilliam.Kucharski@Sun.COM  \def\_{\normalunderscore}%
3338*8044SWilliam.Kucharski@Sun.COM  %
3339*8044SWilliam.Kucharski@Sun.COM  % Non-English letters.
3340*8044SWilliam.Kucharski@Sun.COM  \def\AA{AA}%
3341*8044SWilliam.Kucharski@Sun.COM  \def\AE{AE}%
3342*8044SWilliam.Kucharski@Sun.COM  \def\L{L}%
3343*8044SWilliam.Kucharski@Sun.COM  \def\OE{OE}%
3344*8044SWilliam.Kucharski@Sun.COM  \def\O{O}%
3345*8044SWilliam.Kucharski@Sun.COM  \def\aa{aa}%
3346*8044SWilliam.Kucharski@Sun.COM  \def\ae{ae}%
3347*8044SWilliam.Kucharski@Sun.COM  \def\l{l}%
3348*8044SWilliam.Kucharski@Sun.COM  \def\oe{oe}%
3349*8044SWilliam.Kucharski@Sun.COM  \def\o{o}%
3350*8044SWilliam.Kucharski@Sun.COM  \def\ss{ss}%
3351*8044SWilliam.Kucharski@Sun.COM  \def\exclamdown{!}%
3352*8044SWilliam.Kucharski@Sun.COM  \def\questiondown{?}%
3353*8044SWilliam.Kucharski@Sun.COM  \def\ordf{a}%
3354*8044SWilliam.Kucharski@Sun.COM  \def\ordm{o}%
3355*8044SWilliam.Kucharski@Sun.COM  %
3356*8044SWilliam.Kucharski@Sun.COM  \def\LaTeX{LaTeX}%
3357*8044SWilliam.Kucharski@Sun.COM  \def\TeX{TeX}%
3358*8044SWilliam.Kucharski@Sun.COM  %
3359*8044SWilliam.Kucharski@Sun.COM  % Assorted special characters.
3360*8044SWilliam.Kucharski@Sun.COM  % (The following {} will end up in the sort string, but that's ok.)
3361*8044SWilliam.Kucharski@Sun.COM  \def\bullet{bullet}%
3362*8044SWilliam.Kucharski@Sun.COM  \def\comma{,}%
3363*8044SWilliam.Kucharski@Sun.COM  \def\copyright{copyright}%
3364*8044SWilliam.Kucharski@Sun.COM  \def\registeredsymbol{R}%
3365*8044SWilliam.Kucharski@Sun.COM  \def\dots{...}%
3366*8044SWilliam.Kucharski@Sun.COM  \def\enddots{...}%
3367*8044SWilliam.Kucharski@Sun.COM  \def\equiv{==}%
3368*8044SWilliam.Kucharski@Sun.COM  \def\error{error}%
3369*8044SWilliam.Kucharski@Sun.COM  \def\euro{euro}%
3370*8044SWilliam.Kucharski@Sun.COM  \def\expansion{==>}%
3371*8044SWilliam.Kucharski@Sun.COM  \def\minus{-}%
3372*8044SWilliam.Kucharski@Sun.COM  \def\pounds{pounds}%
3373*8044SWilliam.Kucharski@Sun.COM  \def\point{.}%
3374*8044SWilliam.Kucharski@Sun.COM  \def\print{-|}%
3375*8044SWilliam.Kucharski@Sun.COM  \def\result{=>}%
3376*8044SWilliam.Kucharski@Sun.COM  %
3377*8044SWilliam.Kucharski@Sun.COM  % Don't write macro names.
3378*8044SWilliam.Kucharski@Sun.COM  \emptyusermacros
3379*8044SWilliam.Kucharski@Sun.COM}
3380*8044SWilliam.Kucharski@Sun.COM
3381*8044SWilliam.Kucharski@Sun.COM\let\indexbackslash=0  %overridden during \printindex.
3382*8044SWilliam.Kucharski@Sun.COM\let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3383*8044SWilliam.Kucharski@Sun.COM
3384*8044SWilliam.Kucharski@Sun.COM% Most index entries go through here, but \dosubind is the general case.
3385*8044SWilliam.Kucharski@Sun.COM% #1 is the index name, #2 is the entry text.
3386*8044SWilliam.Kucharski@Sun.COM\def\doind#1#2{\dosubind{#1}{#2}{}}
3387*8044SWilliam.Kucharski@Sun.COM
3388*8044SWilliam.Kucharski@Sun.COM% Workhorse for all \fooindexes.
3389*8044SWilliam.Kucharski@Sun.COM% #1 is name of index, #2 is stuff to put there, #3 is subentry --
3390*8044SWilliam.Kucharski@Sun.COM% empty if called from \doind, as we usually are (the main exception
3391*8044SWilliam.Kucharski@Sun.COM% is with most defuns, which call us directly).
3392*8044SWilliam.Kucharski@Sun.COM%
3393*8044SWilliam.Kucharski@Sun.COM\def\dosubind#1#2#3{%
3394*8044SWilliam.Kucharski@Sun.COM  \iflinks
3395*8044SWilliam.Kucharski@Sun.COM  {%
3396*8044SWilliam.Kucharski@Sun.COM    % Store the main index entry text (including the third arg).
3397*8044SWilliam.Kucharski@Sun.COM    \toks0 = {#2}%
3398*8044SWilliam.Kucharski@Sun.COM    % If third arg is present, precede it with a space.
3399*8044SWilliam.Kucharski@Sun.COM    \def\thirdarg{#3}%
3400*8044SWilliam.Kucharski@Sun.COM    \ifx\thirdarg\empty \else
3401*8044SWilliam.Kucharski@Sun.COM      \toks0 = \expandafter{\the\toks0 \space #3}%
3402*8044SWilliam.Kucharski@Sun.COM    \fi
3403*8044SWilliam.Kucharski@Sun.COM    %
3404*8044SWilliam.Kucharski@Sun.COM    \edef\writeto{\csname#1indfile\endcsname}%
3405*8044SWilliam.Kucharski@Sun.COM    %
3406*8044SWilliam.Kucharski@Sun.COM    \ifvmode
3407*8044SWilliam.Kucharski@Sun.COM      \dosubindsanitize
3408*8044SWilliam.Kucharski@Sun.COM    \else
3409*8044SWilliam.Kucharski@Sun.COM      \dosubindwrite
3410*8044SWilliam.Kucharski@Sun.COM    \fi
3411*8044SWilliam.Kucharski@Sun.COM  }%
3412*8044SWilliam.Kucharski@Sun.COM  \fi
3413*8044SWilliam.Kucharski@Sun.COM}
3414*8044SWilliam.Kucharski@Sun.COM
3415*8044SWilliam.Kucharski@Sun.COM% Write the entry in \toks0 to the index file:
3416*8044SWilliam.Kucharski@Sun.COM%
3417*8044SWilliam.Kucharski@Sun.COM\def\dosubindwrite{%
3418*8044SWilliam.Kucharski@Sun.COM  % Put the index entry in the margin if desired.
3419*8044SWilliam.Kucharski@Sun.COM  \ifx\SETmarginindex\relax\else
3420*8044SWilliam.Kucharski@Sun.COM    \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3421*8044SWilliam.Kucharski@Sun.COM  \fi
3422*8044SWilliam.Kucharski@Sun.COM  %
3423*8044SWilliam.Kucharski@Sun.COM  % Remember, we are within a group.
3424*8044SWilliam.Kucharski@Sun.COM  \indexdummies % Must do this here, since \bf, etc expand at this stage
3425*8044SWilliam.Kucharski@Sun.COM  \escapechar=`\\
3426*8044SWilliam.Kucharski@Sun.COM  \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3427*8044SWilliam.Kucharski@Sun.COM      % so it will be output as is; and it will print as backslash.
3428*8044SWilliam.Kucharski@Sun.COM  %
3429*8044SWilliam.Kucharski@Sun.COM  % Process the index entry with all font commands turned off, to
3430*8044SWilliam.Kucharski@Sun.COM  % get the string to sort by.
3431*8044SWilliam.Kucharski@Sun.COM  {\indexnofonts
3432*8044SWilliam.Kucharski@Sun.COM   \edef\temp{\the\toks0}% need full expansion
3433*8044SWilliam.Kucharski@Sun.COM   \xdef\indexsorttmp{\temp}%
3434*8044SWilliam.Kucharski@Sun.COM  }%
3435*8044SWilliam.Kucharski@Sun.COM  %
3436*8044SWilliam.Kucharski@Sun.COM  % Set up the complete index entry, with both the sort key and
3437*8044SWilliam.Kucharski@Sun.COM  % the original text, including any font commands.  We write
3438*8044SWilliam.Kucharski@Sun.COM  % three arguments to \entry to the .?? file (four in the
3439*8044SWilliam.Kucharski@Sun.COM  % subentry case), texindex reduces to two when writing the .??s
3440*8044SWilliam.Kucharski@Sun.COM  % sorted result.
3441*8044SWilliam.Kucharski@Sun.COM  \edef\temp{%
3442*8044SWilliam.Kucharski@Sun.COM    \write\writeto{%
3443*8044SWilliam.Kucharski@Sun.COM      \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3444*8044SWilliam.Kucharski@Sun.COM  }%
3445*8044SWilliam.Kucharski@Sun.COM  \temp
3446*8044SWilliam.Kucharski@Sun.COM}
3447*8044SWilliam.Kucharski@Sun.COM
3448*8044SWilliam.Kucharski@Sun.COM% Take care of unwanted page breaks:
3449*8044SWilliam.Kucharski@Sun.COM%
3450*8044SWilliam.Kucharski@Sun.COM% If a skip is the last thing on the list now, preserve it
3451*8044SWilliam.Kucharski@Sun.COM% by backing up by \lastskip, doing the \write, then inserting
3452*8044SWilliam.Kucharski@Sun.COM% the skip again.  Otherwise, the whatsit generated by the
3453*8044SWilliam.Kucharski@Sun.COM% \write will make \lastskip zero.  The result is that sequences
3454*8044SWilliam.Kucharski@Sun.COM% like this:
3455*8044SWilliam.Kucharski@Sun.COM% @end defun
3456*8044SWilliam.Kucharski@Sun.COM% @tindex whatever
3457*8044SWilliam.Kucharski@Sun.COM% @defun ...
3458*8044SWilliam.Kucharski@Sun.COM% will have extra space inserted, because the \medbreak in the
3459*8044SWilliam.Kucharski@Sun.COM% start of the @defun won't see the skip inserted by the @end of
3460*8044SWilliam.Kucharski@Sun.COM% the previous defun.
3461*8044SWilliam.Kucharski@Sun.COM%
3462*8044SWilliam.Kucharski@Sun.COM% But don't do any of this if we're not in vertical mode.  We
3463*8044SWilliam.Kucharski@Sun.COM% don't want to do a \vskip and prematurely end a paragraph.
3464*8044SWilliam.Kucharski@Sun.COM%
3465*8044SWilliam.Kucharski@Sun.COM% Avoid page breaks due to these extra skips, too.
3466*8044SWilliam.Kucharski@Sun.COM%
3467*8044SWilliam.Kucharski@Sun.COM% But wait, there is a catch there:
3468*8044SWilliam.Kucharski@Sun.COM% We'll have to check whether \lastskip is zero skip.  \ifdim is not
3469*8044SWilliam.Kucharski@Sun.COM% sufficient for this purpose, as it ignores stretch and shrink parts
3470*8044SWilliam.Kucharski@Sun.COM% of the skip.  The only way seems to be to check the textual
3471*8044SWilliam.Kucharski@Sun.COM% representation of the skip.
3472*8044SWilliam.Kucharski@Sun.COM%
3473*8044SWilliam.Kucharski@Sun.COM% The following is almost like \def\zeroskipmacro{0.0pt} except that
3474*8044SWilliam.Kucharski@Sun.COM% the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3475*8044SWilliam.Kucharski@Sun.COM%
3476*8044SWilliam.Kucharski@Sun.COM\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3477*8044SWilliam.Kucharski@Sun.COM%
3478*8044SWilliam.Kucharski@Sun.COM% ..., ready, GO:
3479*8044SWilliam.Kucharski@Sun.COM%
3480*8044SWilliam.Kucharski@Sun.COM\def\dosubindsanitize{%
3481*8044SWilliam.Kucharski@Sun.COM  % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3482*8044SWilliam.Kucharski@Sun.COM  \skip0 = \lastskip
3483*8044SWilliam.Kucharski@Sun.COM  \edef\lastskipmacro{\the\lastskip}%
3484*8044SWilliam.Kucharski@Sun.COM  \count255 = \lastpenalty
3485*8044SWilliam.Kucharski@Sun.COM  %
3486*8044SWilliam.Kucharski@Sun.COM  % If \lastskip is nonzero, that means the last item was a
3487*8044SWilliam.Kucharski@Sun.COM  % skip.  And since a skip is discardable, that means this
3488*8044SWilliam.Kucharski@Sun.COM  % -\skip0 glue we're inserting is preceded by a
3489*8044SWilliam.Kucharski@Sun.COM  % non-discardable item, therefore it is not a potential
3490*8044SWilliam.Kucharski@Sun.COM  % breakpoint, therefore no \nobreak needed.
3491*8044SWilliam.Kucharski@Sun.COM  \ifx\lastskipmacro\zeroskipmacro
3492*8044SWilliam.Kucharski@Sun.COM  \else
3493*8044SWilliam.Kucharski@Sun.COM    \vskip-\skip0
3494*8044SWilliam.Kucharski@Sun.COM  \fi
3495*8044SWilliam.Kucharski@Sun.COM  %
3496*8044SWilliam.Kucharski@Sun.COM  \dosubindwrite
3497*8044SWilliam.Kucharski@Sun.COM  %
3498*8044SWilliam.Kucharski@Sun.COM  \ifx\lastskipmacro\zeroskipmacro
3499*8044SWilliam.Kucharski@Sun.COM    % If \lastskip was zero, perhaps the last item was a penalty, and
3500*8044SWilliam.Kucharski@Sun.COM    % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
3501*8044SWilliam.Kucharski@Sun.COM    % to re-insert the same penalty (values >10000 are used for various
3502*8044SWilliam.Kucharski@Sun.COM    % signals); since we just inserted a non-discardable item, any
3503*8044SWilliam.Kucharski@Sun.COM    % following glue (such as a \parskip) would be a breakpoint.  For example:
3504*8044SWilliam.Kucharski@Sun.COM    %
3505*8044SWilliam.Kucharski@Sun.COM    %   @deffn deffn-whatever
3506*8044SWilliam.Kucharski@Sun.COM    %   @vindex index-whatever
3507*8044SWilliam.Kucharski@Sun.COM    %   Description.
3508*8044SWilliam.Kucharski@Sun.COM    % would allow a break between the index-whatever whatsit
3509*8044SWilliam.Kucharski@Sun.COM    % and the "Description." paragraph.
3510*8044SWilliam.Kucharski@Sun.COM    \ifnum\count255>9999 \penalty\count255 \fi
3511*8044SWilliam.Kucharski@Sun.COM  \else
3512*8044SWilliam.Kucharski@Sun.COM    % On the other hand, if we had a nonzero \lastskip,
3513*8044SWilliam.Kucharski@Sun.COM    % this make-up glue would be preceded by a non-discardable item
3514*8044SWilliam.Kucharski@Sun.COM    % (the whatsit from the \write), so we must insert a \nobreak.
3515*8044SWilliam.Kucharski@Sun.COM    \nobreak\vskip\skip0
3516*8044SWilliam.Kucharski@Sun.COM  \fi
3517*8044SWilliam.Kucharski@Sun.COM}
3518*8044SWilliam.Kucharski@Sun.COM
3519*8044SWilliam.Kucharski@Sun.COM% The index entry written in the file actually looks like
3520*8044SWilliam.Kucharski@Sun.COM%  \entry {sortstring}{page}{topic}
3521*8044SWilliam.Kucharski@Sun.COM% or
3522*8044SWilliam.Kucharski@Sun.COM%  \entry {sortstring}{page}{topic}{subtopic}
3523*8044SWilliam.Kucharski@Sun.COM% The texindex program reads in these files and writes files
3524*8044SWilliam.Kucharski@Sun.COM% containing these kinds of lines:
3525*8044SWilliam.Kucharski@Sun.COM%  \initial {c}
3526*8044SWilliam.Kucharski@Sun.COM%     before the first topic whose initial is c
3527*8044SWilliam.Kucharski@Sun.COM%  \entry {topic}{pagelist}
3528*8044SWilliam.Kucharski@Sun.COM%     for a topic that is used without subtopics
3529*8044SWilliam.Kucharski@Sun.COM%  \primary {topic}
3530*8044SWilliam.Kucharski@Sun.COM%     for the beginning of a topic that is used with subtopics
3531*8044SWilliam.Kucharski@Sun.COM%  \secondary {subtopic}{pagelist}
3532*8044SWilliam.Kucharski@Sun.COM%     for each subtopic.
3533*8044SWilliam.Kucharski@Sun.COM
3534*8044SWilliam.Kucharski@Sun.COM% Define the user-accessible indexing commands
3535*8044SWilliam.Kucharski@Sun.COM% @findex, @vindex, @kindex, @cindex.
3536*8044SWilliam.Kucharski@Sun.COM
3537*8044SWilliam.Kucharski@Sun.COM\def\findex {\fnindex}
3538*8044SWilliam.Kucharski@Sun.COM\def\kindex {\kyindex}
3539*8044SWilliam.Kucharski@Sun.COM\def\cindex {\cpindex}
3540*8044SWilliam.Kucharski@Sun.COM\def\vindex {\vrindex}
3541*8044SWilliam.Kucharski@Sun.COM\def\tindex {\tpindex}
3542*8044SWilliam.Kucharski@Sun.COM\def\pindex {\pgindex}
3543*8044SWilliam.Kucharski@Sun.COM
3544*8044SWilliam.Kucharski@Sun.COM\def\cindexsub {\begingroup\obeylines\cindexsub}
3545*8044SWilliam.Kucharski@Sun.COM{\obeylines %
3546*8044SWilliam.Kucharski@Sun.COM\gdef\cindexsub "#1" #2^^M{\endgroup %
3547*8044SWilliam.Kucharski@Sun.COM\dosubind{cp}{#2}{#1}}}
3548*8044SWilliam.Kucharski@Sun.COM
3549*8044SWilliam.Kucharski@Sun.COM% Define the macros used in formatting output of the sorted index material.
3550*8044SWilliam.Kucharski@Sun.COM
3551*8044SWilliam.Kucharski@Sun.COM% @printindex causes a particular index (the ??s file) to get printed.
3552*8044SWilliam.Kucharski@Sun.COM% It does not print any chapter heading (usually an @unnumbered).
3553*8044SWilliam.Kucharski@Sun.COM%
3554*8044SWilliam.Kucharski@Sun.COM\parseargdef\printindex{\begingroup
3555*8044SWilliam.Kucharski@Sun.COM  \dobreak \chapheadingskip{10000}%
3556*8044SWilliam.Kucharski@Sun.COM  %
3557*8044SWilliam.Kucharski@Sun.COM  \smallfonts \rm
3558*8044SWilliam.Kucharski@Sun.COM  \tolerance = 9500
3559*8044SWilliam.Kucharski@Sun.COM  \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3560*8044SWilliam.Kucharski@Sun.COM  %
3561*8044SWilliam.Kucharski@Sun.COM  % See if the index file exists and is nonempty.
3562*8044SWilliam.Kucharski@Sun.COM  % Change catcode of @ here so that if the index file contains
3563*8044SWilliam.Kucharski@Sun.COM  % \initial {@}
3564*8044SWilliam.Kucharski@Sun.COM  % as its first line, TeX doesn't complain about mismatched braces
3565*8044SWilliam.Kucharski@Sun.COM  % (because it thinks @} is a control sequence).
3566*8044SWilliam.Kucharski@Sun.COM  \catcode`\@ = 11
3567*8044SWilliam.Kucharski@Sun.COM  \openin 1 \jobname.#1s
3568*8044SWilliam.Kucharski@Sun.COM  \ifeof 1
3569*8044SWilliam.Kucharski@Sun.COM    % \enddoublecolumns gets confused if there is no text in the index,
3570*8044SWilliam.Kucharski@Sun.COM    % and it loses the chapter title and the aux file entries for the
3571*8044SWilliam.Kucharski@Sun.COM    % index.  The easiest way to prevent this problem is to make sure
3572*8044SWilliam.Kucharski@Sun.COM    % there is some text.
3573*8044SWilliam.Kucharski@Sun.COM    \putwordIndexNonexistent
3574*8044SWilliam.Kucharski@Sun.COM  \else
3575*8044SWilliam.Kucharski@Sun.COM    %
3576*8044SWilliam.Kucharski@Sun.COM    % If the index file exists but is empty, then \openin leaves \ifeof
3577*8044SWilliam.Kucharski@Sun.COM    % false.  We have to make TeX try to read something from the file, so
3578*8044SWilliam.Kucharski@Sun.COM    % it can discover if there is anything in it.
3579*8044SWilliam.Kucharski@Sun.COM    \read 1 to \temp
3580*8044SWilliam.Kucharski@Sun.COM    \ifeof 1
3581*8044SWilliam.Kucharski@Sun.COM      \putwordIndexIsEmpty
3582*8044SWilliam.Kucharski@Sun.COM    \else
3583*8044SWilliam.Kucharski@Sun.COM      % Index files are almost Texinfo source, but we use \ as the escape
3584*8044SWilliam.Kucharski@Sun.COM      % character.  It would be better to use @, but that's too big a change
3585*8044SWilliam.Kucharski@Sun.COM      % to make right now.
3586*8044SWilliam.Kucharski@Sun.COM      \def\indexbackslash{\backslashcurfont}%
3587*8044SWilliam.Kucharski@Sun.COM      \catcode`\\ = 0
3588*8044SWilliam.Kucharski@Sun.COM      \escapechar = `\\
3589*8044SWilliam.Kucharski@Sun.COM      \begindoublecolumns
3590*8044SWilliam.Kucharski@Sun.COM      \input \jobname.#1s
3591*8044SWilliam.Kucharski@Sun.COM      \enddoublecolumns
3592*8044SWilliam.Kucharski@Sun.COM    \fi
3593*8044SWilliam.Kucharski@Sun.COM  \fi
3594*8044SWilliam.Kucharski@Sun.COM  \closein 1
3595*8044SWilliam.Kucharski@Sun.COM\endgroup}
3596*8044SWilliam.Kucharski@Sun.COM
3597*8044SWilliam.Kucharski@Sun.COM% These macros are used by the sorted index file itself.
3598*8044SWilliam.Kucharski@Sun.COM% Change them to control the appearance of the index.
3599*8044SWilliam.Kucharski@Sun.COM
3600*8044SWilliam.Kucharski@Sun.COM\def\initial#1{{%
3601*8044SWilliam.Kucharski@Sun.COM  % Some minor font changes for the special characters.
3602*8044SWilliam.Kucharski@Sun.COM  \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3603*8044SWilliam.Kucharski@Sun.COM  %
3604*8044SWilliam.Kucharski@Sun.COM  % Remove any glue we may have, we'll be inserting our own.
3605*8044SWilliam.Kucharski@Sun.COM  \removelastskip
3606*8044SWilliam.Kucharski@Sun.COM  %
3607*8044SWilliam.Kucharski@Sun.COM  % We like breaks before the index initials, so insert a bonus.
3608*8044SWilliam.Kucharski@Sun.COM  \nobreak
3609*8044SWilliam.Kucharski@Sun.COM  \vskip 0pt plus 3\baselineskip
3610*8044SWilliam.Kucharski@Sun.COM  \penalty 0
3611*8044SWilliam.Kucharski@Sun.COM  \vskip 0pt plus -3\baselineskip
3612*8044SWilliam.Kucharski@Sun.COM  %
3613*8044SWilliam.Kucharski@Sun.COM  % Typeset the initial.  Making this add up to a whole number of
3614*8044SWilliam.Kucharski@Sun.COM  % baselineskips increases the chance of the dots lining up from column
3615*8044SWilliam.Kucharski@Sun.COM  % to column.  It still won't often be perfect, because of the stretch
3616*8044SWilliam.Kucharski@Sun.COM  % we need before each entry, but it's better.
3617*8044SWilliam.Kucharski@Sun.COM  %
3618*8044SWilliam.Kucharski@Sun.COM  % No shrink because it confuses \balancecolumns.
3619*8044SWilliam.Kucharski@Sun.COM  \vskip 1.67\baselineskip plus .5\baselineskip
3620*8044SWilliam.Kucharski@Sun.COM  \leftline{\secbf #1}%
3621*8044SWilliam.Kucharski@Sun.COM  % Do our best not to break after the initial.
3622*8044SWilliam.Kucharski@Sun.COM  \nobreak
3623*8044SWilliam.Kucharski@Sun.COM  \vskip .33\baselineskip plus .1\baselineskip
3624*8044SWilliam.Kucharski@Sun.COM}}
3625*8044SWilliam.Kucharski@Sun.COM
3626*8044SWilliam.Kucharski@Sun.COM% \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3627*8044SWilliam.Kucharski@Sun.COM% then page number (#2) flushed to the right margin.  It is used for index
3628*8044SWilliam.Kucharski@Sun.COM% and table of contents entries.  The paragraph is indented by \leftskip.
3629*8044SWilliam.Kucharski@Sun.COM%
3630*8044SWilliam.Kucharski@Sun.COM% A straightforward implementation would start like this:
3631*8044SWilliam.Kucharski@Sun.COM%	\def\entry#1#2{...
3632*8044SWilliam.Kucharski@Sun.COM% But this frozes the catcodes in the argument, and can cause problems to
3633*8044SWilliam.Kucharski@Sun.COM% @code, which sets - active.  This problem was fixed by a kludge---
3634*8044SWilliam.Kucharski@Sun.COM% ``-'' was active throughout whole index, but this isn't really right.
3635*8044SWilliam.Kucharski@Sun.COM%
3636*8044SWilliam.Kucharski@Sun.COM% The right solution is to prevent \entry from swallowing the whole text.
3637*8044SWilliam.Kucharski@Sun.COM%                                 --kasal, 21nov03
3638*8044SWilliam.Kucharski@Sun.COM\def\entry{%
3639*8044SWilliam.Kucharski@Sun.COM  \begingroup
3640*8044SWilliam.Kucharski@Sun.COM    %
3641*8044SWilliam.Kucharski@Sun.COM    % Start a new paragraph if necessary, so our assignments below can't
3642*8044SWilliam.Kucharski@Sun.COM    % affect previous text.
3643*8044SWilliam.Kucharski@Sun.COM    \par
3644*8044SWilliam.Kucharski@Sun.COM    %
3645*8044SWilliam.Kucharski@Sun.COM    % Do not fill out the last line with white space.
3646*8044SWilliam.Kucharski@Sun.COM    \parfillskip = 0in
3647*8044SWilliam.Kucharski@Sun.COM    %
3648*8044SWilliam.Kucharski@Sun.COM    % No extra space above this paragraph.
3649*8044SWilliam.Kucharski@Sun.COM    \parskip = 0in
3650*8044SWilliam.Kucharski@Sun.COM    %
3651*8044SWilliam.Kucharski@Sun.COM    % Do not prefer a separate line ending with a hyphen to fewer lines.
3652*8044SWilliam.Kucharski@Sun.COM    \finalhyphendemerits = 0
3653*8044SWilliam.Kucharski@Sun.COM    %
3654*8044SWilliam.Kucharski@Sun.COM    % \hangindent is only relevant when the entry text and page number
3655*8044SWilliam.Kucharski@Sun.COM    % don't both fit on one line.  In that case, bob suggests starting the
3656*8044SWilliam.Kucharski@Sun.COM    % dots pretty far over on the line.  Unfortunately, a large
3657*8044SWilliam.Kucharski@Sun.COM    % indentation looks wrong when the entry text itself is broken across
3658*8044SWilliam.Kucharski@Sun.COM    % lines.  So we use a small indentation and put up with long leaders.
3659*8044SWilliam.Kucharski@Sun.COM    %
3660*8044SWilliam.Kucharski@Sun.COM    % \hangafter is reset to 1 (which is the value we want) at the start
3661*8044SWilliam.Kucharski@Sun.COM    % of each paragraph, so we need not do anything with that.
3662*8044SWilliam.Kucharski@Sun.COM    \hangindent = 2em
3663*8044SWilliam.Kucharski@Sun.COM    %
3664*8044SWilliam.Kucharski@Sun.COM    % When the entry text needs to be broken, just fill out the first line
3665*8044SWilliam.Kucharski@Sun.COM    % with blank space.
3666*8044SWilliam.Kucharski@Sun.COM    \rightskip = 0pt plus1fil
3667*8044SWilliam.Kucharski@Sun.COM    %
3668*8044SWilliam.Kucharski@Sun.COM    % A bit of stretch before each entry for the benefit of balancing
3669*8044SWilliam.Kucharski@Sun.COM    % columns.
3670*8044SWilliam.Kucharski@Sun.COM    \vskip 0pt plus1pt
3671*8044SWilliam.Kucharski@Sun.COM    %
3672*8044SWilliam.Kucharski@Sun.COM    % Swallow the left brace of the text (first parameter):
3673*8044SWilliam.Kucharski@Sun.COM    \afterassignment\doentry
3674*8044SWilliam.Kucharski@Sun.COM    \let\temp =
3675*8044SWilliam.Kucharski@Sun.COM}
3676*8044SWilliam.Kucharski@Sun.COM\def\doentry{%
3677*8044SWilliam.Kucharski@Sun.COM    \bgroup % Instead of the swallowed brace.
3678*8044SWilliam.Kucharski@Sun.COM      \noindent
3679*8044SWilliam.Kucharski@Sun.COM      \aftergroup\finishentry
3680*8044SWilliam.Kucharski@Sun.COM      % And now comes the text of the entry.
3681*8044SWilliam.Kucharski@Sun.COM}
3682*8044SWilliam.Kucharski@Sun.COM\def\finishentry#1{%
3683*8044SWilliam.Kucharski@Sun.COM    % #1 is the page number.
3684*8044SWilliam.Kucharski@Sun.COM    %
3685*8044SWilliam.Kucharski@Sun.COM    % The following is kludged to not output a line of dots in the index if
3686*8044SWilliam.Kucharski@Sun.COM    % there are no page numbers.  The next person who breaks this will be
3687*8044SWilliam.Kucharski@Sun.COM    % cursed by a Unix daemon.
3688*8044SWilliam.Kucharski@Sun.COM    \def\tempa{{\rm }}%
3689*8044SWilliam.Kucharski@Sun.COM    \def\tempb{#1}%
3690*8044SWilliam.Kucharski@Sun.COM    \edef\tempc{\tempa}%
3691*8044SWilliam.Kucharski@Sun.COM    \edef\tempd{\tempb}%
3692*8044SWilliam.Kucharski@Sun.COM    \ifx\tempc\tempd
3693*8044SWilliam.Kucharski@Sun.COM      \ %
3694*8044SWilliam.Kucharski@Sun.COM    \else
3695*8044SWilliam.Kucharski@Sun.COM      %
3696*8044SWilliam.Kucharski@Sun.COM      % If we must, put the page number on a line of its own, and fill out
3697*8044SWilliam.Kucharski@Sun.COM      % this line with blank space.  (The \hfil is overwhelmed with the
3698*8044SWilliam.Kucharski@Sun.COM      % fill leaders glue in \indexdotfill if the page number does fit.)
3699*8044SWilliam.Kucharski@Sun.COM      \hfil\penalty50
3700*8044SWilliam.Kucharski@Sun.COM      \null\nobreak\indexdotfill % Have leaders before the page number.
3701*8044SWilliam.Kucharski@Sun.COM      %
3702*8044SWilliam.Kucharski@Sun.COM      % The `\ ' here is removed by the implicit \unskip that TeX does as
3703*8044SWilliam.Kucharski@Sun.COM      % part of (the primitive) \par.  Without it, a spurious underfull
3704*8044SWilliam.Kucharski@Sun.COM      % \hbox ensues.
3705*8044SWilliam.Kucharski@Sun.COM      \ifpdf
3706*8044SWilliam.Kucharski@Sun.COM	\pdfgettoks#1.%
3707*8044SWilliam.Kucharski@Sun.COM	\ \the\toksA
3708*8044SWilliam.Kucharski@Sun.COM      \else
3709*8044SWilliam.Kucharski@Sun.COM	\ #1%
3710*8044SWilliam.Kucharski@Sun.COM      \fi
3711*8044SWilliam.Kucharski@Sun.COM    \fi
3712*8044SWilliam.Kucharski@Sun.COM    \par
3713*8044SWilliam.Kucharski@Sun.COM  \endgroup
3714*8044SWilliam.Kucharski@Sun.COM}
3715*8044SWilliam.Kucharski@Sun.COM
3716*8044SWilliam.Kucharski@Sun.COM% Like \dotfill except takes at least 1 em.
3717*8044SWilliam.Kucharski@Sun.COM\def\indexdotfill{\cleaders
3718*8044SWilliam.Kucharski@Sun.COM  \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3719*8044SWilliam.Kucharski@Sun.COM
3720*8044SWilliam.Kucharski@Sun.COM\def\primary #1{\line{#1\hfil}}
3721*8044SWilliam.Kucharski@Sun.COM
3722*8044SWilliam.Kucharski@Sun.COM\newskip\secondaryindent \secondaryindent=0.5cm
3723*8044SWilliam.Kucharski@Sun.COM\def\secondary#1#2{{%
3724*8044SWilliam.Kucharski@Sun.COM  \parfillskip=0in
3725*8044SWilliam.Kucharski@Sun.COM  \parskip=0in
3726*8044SWilliam.Kucharski@Sun.COM  \hangindent=1in
3727*8044SWilliam.Kucharski@Sun.COM  \hangafter=1
3728*8044SWilliam.Kucharski@Sun.COM  \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3729*8044SWilliam.Kucharski@Sun.COM  \ifpdf
3730*8044SWilliam.Kucharski@Sun.COM    \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3731*8044SWilliam.Kucharski@Sun.COM  \else
3732*8044SWilliam.Kucharski@Sun.COM    #2
3733*8044SWilliam.Kucharski@Sun.COM  \fi
3734*8044SWilliam.Kucharski@Sun.COM  \par
3735*8044SWilliam.Kucharski@Sun.COM}}
3736*8044SWilliam.Kucharski@Sun.COM
3737*8044SWilliam.Kucharski@Sun.COM% Define two-column mode, which we use to typeset indexes.
3738*8044SWilliam.Kucharski@Sun.COM% Adapted from the TeXbook, page 416, which is to say,
3739*8044SWilliam.Kucharski@Sun.COM% the manmac.tex format used to print the TeXbook itself.
3740*8044SWilliam.Kucharski@Sun.COM\catcode`\@=11
3741*8044SWilliam.Kucharski@Sun.COM
3742*8044SWilliam.Kucharski@Sun.COM\newbox\partialpage
3743*8044SWilliam.Kucharski@Sun.COM\newdimen\doublecolumnhsize
3744*8044SWilliam.Kucharski@Sun.COM
3745*8044SWilliam.Kucharski@Sun.COM\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3746*8044SWilliam.Kucharski@Sun.COM  % Grab any single-column material above us.
3747*8044SWilliam.Kucharski@Sun.COM  \output = {%
3748*8044SWilliam.Kucharski@Sun.COM    %
3749*8044SWilliam.Kucharski@Sun.COM    % Here is a possibility not foreseen in manmac: if we accumulate a
3750*8044SWilliam.Kucharski@Sun.COM    % whole lot of material, we might end up calling this \output
3751*8044SWilliam.Kucharski@Sun.COM    % routine twice in a row (see the doublecol-lose test, which is
3752*8044SWilliam.Kucharski@Sun.COM    % essentially a couple of indexes with @setchapternewpage off).  In
3753*8044SWilliam.Kucharski@Sun.COM    % that case we just ship out what is in \partialpage with the normal
3754*8044SWilliam.Kucharski@Sun.COM    % output routine.  Generally, \partialpage will be empty when this
3755*8044SWilliam.Kucharski@Sun.COM    % runs and this will be a no-op.  See the indexspread.tex test case.
3756*8044SWilliam.Kucharski@Sun.COM    \ifvoid\partialpage \else
3757*8044SWilliam.Kucharski@Sun.COM      \onepageout{\pagecontents\partialpage}%
3758*8044SWilliam.Kucharski@Sun.COM    \fi
3759*8044SWilliam.Kucharski@Sun.COM    %
3760*8044SWilliam.Kucharski@Sun.COM    \global\setbox\partialpage = \vbox{%
3761*8044SWilliam.Kucharski@Sun.COM      % Unvbox the main output page.
3762*8044SWilliam.Kucharski@Sun.COM      \unvbox\PAGE
3763*8044SWilliam.Kucharski@Sun.COM      \kern-\topskip \kern\baselineskip
3764*8044SWilliam.Kucharski@Sun.COM    }%
3765*8044SWilliam.Kucharski@Sun.COM  }%
3766*8044SWilliam.Kucharski@Sun.COM  \eject % run that output routine to set \partialpage
3767*8044SWilliam.Kucharski@Sun.COM  %
3768*8044SWilliam.Kucharski@Sun.COM  % Use the double-column output routine for subsequent pages.
3769*8044SWilliam.Kucharski@Sun.COM  \output = {\doublecolumnout}%
3770*8044SWilliam.Kucharski@Sun.COM  %
3771*8044SWilliam.Kucharski@Sun.COM  % Change the page size parameters.  We could do this once outside this
3772*8044SWilliam.Kucharski@Sun.COM  % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3773*8044SWilliam.Kucharski@Sun.COM  % format, but then we repeat the same computation.  Repeating a couple
3774*8044SWilliam.Kucharski@Sun.COM  % of assignments once per index is clearly meaningless for the
3775*8044SWilliam.Kucharski@Sun.COM  % execution time, so we may as well do it in one place.
3776*8044SWilliam.Kucharski@Sun.COM  %
3777*8044SWilliam.Kucharski@Sun.COM  % First we halve the line length, less a little for the gutter between
3778*8044SWilliam.Kucharski@Sun.COM  % the columns.  We compute the gutter based on the line length, so it
3779*8044SWilliam.Kucharski@Sun.COM  % changes automatically with the paper format.  The magic constant
3780*8044SWilliam.Kucharski@Sun.COM  % below is chosen so that the gutter has the same value (well, +-<1pt)
3781*8044SWilliam.Kucharski@Sun.COM  % as it did when we hard-coded it.
3782*8044SWilliam.Kucharski@Sun.COM  %
3783*8044SWilliam.Kucharski@Sun.COM  % We put the result in a separate register, \doublecolumhsize, so we
3784*8044SWilliam.Kucharski@Sun.COM  % can restore it in \pagesofar, after \hsize itself has (potentially)
3785*8044SWilliam.Kucharski@Sun.COM  % been clobbered.
3786*8044SWilliam.Kucharski@Sun.COM  %
3787*8044SWilliam.Kucharski@Sun.COM  \doublecolumnhsize = \hsize
3788*8044SWilliam.Kucharski@Sun.COM    \advance\doublecolumnhsize by -.04154\hsize
3789*8044SWilliam.Kucharski@Sun.COM    \divide\doublecolumnhsize by 2
3790*8044SWilliam.Kucharski@Sun.COM  \hsize = \doublecolumnhsize
3791*8044SWilliam.Kucharski@Sun.COM  %
3792*8044SWilliam.Kucharski@Sun.COM  % Double the \vsize as well.  (We don't need a separate register here,
3793*8044SWilliam.Kucharski@Sun.COM  % since nobody clobbers \vsize.)
3794*8044SWilliam.Kucharski@Sun.COM  \vsize = 2\vsize
3795*8044SWilliam.Kucharski@Sun.COM}
3796*8044SWilliam.Kucharski@Sun.COM
3797*8044SWilliam.Kucharski@Sun.COM% The double-column output routine for all double-column pages except
3798*8044SWilliam.Kucharski@Sun.COM% the last.
3799*8044SWilliam.Kucharski@Sun.COM%
3800*8044SWilliam.Kucharski@Sun.COM\def\doublecolumnout{%
3801*8044SWilliam.Kucharski@Sun.COM  \splittopskip=\topskip \splitmaxdepth=\maxdepth
3802*8044SWilliam.Kucharski@Sun.COM  % Get the available space for the double columns -- the normal
3803*8044SWilliam.Kucharski@Sun.COM  % (undoubled) page height minus any material left over from the
3804*8044SWilliam.Kucharski@Sun.COM  % previous page.
3805*8044SWilliam.Kucharski@Sun.COM  \dimen@ = \vsize
3806*8044SWilliam.Kucharski@Sun.COM  \divide\dimen@ by 2
3807*8044SWilliam.Kucharski@Sun.COM  \advance\dimen@ by -\ht\partialpage
3808*8044SWilliam.Kucharski@Sun.COM  %
3809*8044SWilliam.Kucharski@Sun.COM  % box0 will be the left-hand column, box2 the right.
3810*8044SWilliam.Kucharski@Sun.COM  \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3811*8044SWilliam.Kucharski@Sun.COM  \onepageout\pagesofar
3812*8044SWilliam.Kucharski@Sun.COM  \unvbox255
3813*8044SWilliam.Kucharski@Sun.COM  \penalty\outputpenalty
3814*8044SWilliam.Kucharski@Sun.COM}
3815*8044SWilliam.Kucharski@Sun.COM%
3816*8044SWilliam.Kucharski@Sun.COM% Re-output the contents of the output page -- any previous material,
3817*8044SWilliam.Kucharski@Sun.COM% followed by the two boxes we just split, in box0 and box2.
3818*8044SWilliam.Kucharski@Sun.COM\def\pagesofar{%
3819*8044SWilliam.Kucharski@Sun.COM  \unvbox\partialpage
3820*8044SWilliam.Kucharski@Sun.COM  %
3821*8044SWilliam.Kucharski@Sun.COM  \hsize = \doublecolumnhsize
3822*8044SWilliam.Kucharski@Sun.COM  \wd0=\hsize \wd2=\hsize
3823*8044SWilliam.Kucharski@Sun.COM  \hbox to\pagewidth{\box0\hfil\box2}%
3824*8044SWilliam.Kucharski@Sun.COM}
3825*8044SWilliam.Kucharski@Sun.COM%
3826*8044SWilliam.Kucharski@Sun.COM% All done with double columns.
3827*8044SWilliam.Kucharski@Sun.COM\def\enddoublecolumns{%
3828*8044SWilliam.Kucharski@Sun.COM  \output = {%
3829*8044SWilliam.Kucharski@Sun.COM    % Split the last of the double-column material.  Leave it on the
3830*8044SWilliam.Kucharski@Sun.COM    % current page, no automatic page break.
3831*8044SWilliam.Kucharski@Sun.COM    \balancecolumns
3832*8044SWilliam.Kucharski@Sun.COM    %
3833*8044SWilliam.Kucharski@Sun.COM    % If we end up splitting too much material for the current page,
3834*8044SWilliam.Kucharski@Sun.COM    % though, there will be another page break right after this \output
3835*8044SWilliam.Kucharski@Sun.COM    % invocation ends.  Having called \balancecolumns once, we do not
3836*8044SWilliam.Kucharski@Sun.COM    % want to call it again.  Therefore, reset \output to its normal
3837*8044SWilliam.Kucharski@Sun.COM    % definition right away.  (We hope \balancecolumns will never be
3838*8044SWilliam.Kucharski@Sun.COM    % called on to balance too much material, but if it is, this makes
3839*8044SWilliam.Kucharski@Sun.COM    % the output somewhat more palatable.)
3840*8044SWilliam.Kucharski@Sun.COM    \global\output = {\onepageout{\pagecontents\PAGE}}%
3841*8044SWilliam.Kucharski@Sun.COM  }%
3842*8044SWilliam.Kucharski@Sun.COM  \eject
3843*8044SWilliam.Kucharski@Sun.COM  \endgroup % started in \begindoublecolumns
3844*8044SWilliam.Kucharski@Sun.COM  %
3845*8044SWilliam.Kucharski@Sun.COM  % \pagegoal was set to the doubled \vsize above, since we restarted
3846*8044SWilliam.Kucharski@Sun.COM  % the current page.  We're now back to normal single-column
3847*8044SWilliam.Kucharski@Sun.COM  % typesetting, so reset \pagegoal to the normal \vsize (after the
3848*8044SWilliam.Kucharski@Sun.COM  % \endgroup where \vsize got restored).
3849*8044SWilliam.Kucharski@Sun.COM  \pagegoal = \vsize
3850*8044SWilliam.Kucharski@Sun.COM}
3851*8044SWilliam.Kucharski@Sun.COM%
3852*8044SWilliam.Kucharski@Sun.COM% Called at the end of the double column material.
3853*8044SWilliam.Kucharski@Sun.COM\def\balancecolumns{%
3854*8044SWilliam.Kucharski@Sun.COM  \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3855*8044SWilliam.Kucharski@Sun.COM  \dimen@ = \ht0
3856*8044SWilliam.Kucharski@Sun.COM  \advance\dimen@ by \topskip
3857*8044SWilliam.Kucharski@Sun.COM  \advance\dimen@ by-\baselineskip
3858*8044SWilliam.Kucharski@Sun.COM  \divide\dimen@ by 2 % target to split to
3859*8044SWilliam.Kucharski@Sun.COM  %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3860*8044SWilliam.Kucharski@Sun.COM  \splittopskip = \topskip
3861*8044SWilliam.Kucharski@Sun.COM  % Loop until we get a decent breakpoint.
3862*8044SWilliam.Kucharski@Sun.COM  {%
3863*8044SWilliam.Kucharski@Sun.COM    \vbadness = 10000
3864*8044SWilliam.Kucharski@Sun.COM    \loop
3865*8044SWilliam.Kucharski@Sun.COM      \global\setbox3 = \copy0
3866*8044SWilliam.Kucharski@Sun.COM      \global\setbox1 = \vsplit3 to \dimen@
3867*8044SWilliam.Kucharski@Sun.COM    \ifdim\ht3>\dimen@
3868*8044SWilliam.Kucharski@Sun.COM      \global\advance\dimen@ by 1pt
3869*8044SWilliam.Kucharski@Sun.COM    \repeat
3870*8044SWilliam.Kucharski@Sun.COM  }%
3871*8044SWilliam.Kucharski@Sun.COM  %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3872*8044SWilliam.Kucharski@Sun.COM  \setbox0=\vbox to\dimen@{\unvbox1}%
3873*8044SWilliam.Kucharski@Sun.COM  \setbox2=\vbox to\dimen@{\unvbox3}%
3874*8044SWilliam.Kucharski@Sun.COM  %
3875*8044SWilliam.Kucharski@Sun.COM  \pagesofar
3876*8044SWilliam.Kucharski@Sun.COM}
3877*8044SWilliam.Kucharski@Sun.COM\catcode`\@ = \other
3878*8044SWilliam.Kucharski@Sun.COM
3879*8044SWilliam.Kucharski@Sun.COM
3880*8044SWilliam.Kucharski@Sun.COM\message{sectioning,}
3881*8044SWilliam.Kucharski@Sun.COM% Chapters, sections, etc.
3882*8044SWilliam.Kucharski@Sun.COM
3883*8044SWilliam.Kucharski@Sun.COM% \unnumberedno is an oxymoron, of course.  But we count the unnumbered
3884*8044SWilliam.Kucharski@Sun.COM% sections so that we can refer to them unambiguously in the pdf
3885*8044SWilliam.Kucharski@Sun.COM% outlines by their "section number".  We avoid collisions with chapter
3886*8044SWilliam.Kucharski@Sun.COM% numbers by starting them at 10000.  (If a document ever has 10000
3887*8044SWilliam.Kucharski@Sun.COM% chapters, we're in trouble anyway, I'm sure.)
3888*8044SWilliam.Kucharski@Sun.COM\newcount\unnumberedno \unnumberedno = 10000
3889*8044SWilliam.Kucharski@Sun.COM\newcount\chapno
3890*8044SWilliam.Kucharski@Sun.COM\newcount\secno        \secno=0
3891*8044SWilliam.Kucharski@Sun.COM\newcount\subsecno     \subsecno=0
3892*8044SWilliam.Kucharski@Sun.COM\newcount\subsubsecno  \subsubsecno=0
3893*8044SWilliam.Kucharski@Sun.COM
3894*8044SWilliam.Kucharski@Sun.COM% This counter is funny since it counts through charcodes of letters A, B, ...
3895*8044SWilliam.Kucharski@Sun.COM\newcount\appendixno  \appendixno = `\@
3896*8044SWilliam.Kucharski@Sun.COM%
3897*8044SWilliam.Kucharski@Sun.COM% \def\appendixletter{\char\the\appendixno}
3898*8044SWilliam.Kucharski@Sun.COM% We do the following ugly conditional instead of the above simple
3899*8044SWilliam.Kucharski@Sun.COM% construct for the sake of pdftex, which needs the actual
3900*8044SWilliam.Kucharski@Sun.COM% letter in the expansion, not just typeset.
3901*8044SWilliam.Kucharski@Sun.COM%
3902*8044SWilliam.Kucharski@Sun.COM\def\appendixletter{%
3903*8044SWilliam.Kucharski@Sun.COM  \ifnum\appendixno=`A A%
3904*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`B B%
3905*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`C C%
3906*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`D D%
3907*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`E E%
3908*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`F F%
3909*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`G G%
3910*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`H H%
3911*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`I I%
3912*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`J J%
3913*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`K K%
3914*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`L L%
3915*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`M M%
3916*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`N N%
3917*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`O O%
3918*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`P P%
3919*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`Q Q%
3920*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`R R%
3921*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`S S%
3922*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`T T%
3923*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`U U%
3924*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`V V%
3925*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`W W%
3926*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`X X%
3927*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`Y Y%
3928*8044SWilliam.Kucharski@Sun.COM  \else\ifnum\appendixno=`Z Z%
3929*8044SWilliam.Kucharski@Sun.COM  % The \the is necessary, despite appearances, because \appendixletter is
3930*8044SWilliam.Kucharski@Sun.COM  % expanded while writing the .toc file.  \char\appendixno is not
3931*8044SWilliam.Kucharski@Sun.COM  % expandable, thus it is written literally, thus all appendixes come out
3932*8044SWilliam.Kucharski@Sun.COM  % with the same letter (or @) in the toc without it.
3933*8044SWilliam.Kucharski@Sun.COM  \else\char\the\appendixno
3934*8044SWilliam.Kucharski@Sun.COM  \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3935*8044SWilliam.Kucharski@Sun.COM  \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3936*8044SWilliam.Kucharski@Sun.COM
3937*8044SWilliam.Kucharski@Sun.COM% Each @chapter defines this as the name of the chapter.
3938*8044SWilliam.Kucharski@Sun.COM% page headings and footings can use it.  @section does likewise.
3939*8044SWilliam.Kucharski@Sun.COM% However, they are not reliable, because we don't use marks.
3940*8044SWilliam.Kucharski@Sun.COM\def\thischapter{}
3941*8044SWilliam.Kucharski@Sun.COM\def\thissection{}
3942*8044SWilliam.Kucharski@Sun.COM
3943*8044SWilliam.Kucharski@Sun.COM\newcount\absseclevel % used to calculate proper heading level
3944*8044SWilliam.Kucharski@Sun.COM\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3945*8044SWilliam.Kucharski@Sun.COM
3946*8044SWilliam.Kucharski@Sun.COM% @raisesections: treat @section as chapter, @subsection as section, etc.
3947*8044SWilliam.Kucharski@Sun.COM\def\raisesections{\global\advance\secbase by -1}
3948*8044SWilliam.Kucharski@Sun.COM\let\up=\raisesections % original BFox name
3949*8044SWilliam.Kucharski@Sun.COM
3950*8044SWilliam.Kucharski@Sun.COM% @lowersections: treat @chapter as section, @section as subsection, etc.
3951*8044SWilliam.Kucharski@Sun.COM\def\lowersections{\global\advance\secbase by 1}
3952*8044SWilliam.Kucharski@Sun.COM\let\down=\lowersections % original BFox name
3953*8044SWilliam.Kucharski@Sun.COM
3954*8044SWilliam.Kucharski@Sun.COM% we only have subsub.
3955*8044SWilliam.Kucharski@Sun.COM\chardef\maxseclevel = 3
3956*8044SWilliam.Kucharski@Sun.COM%
3957*8044SWilliam.Kucharski@Sun.COM% A numbered section within an unnumbered changes to unnumbered too.
3958*8044SWilliam.Kucharski@Sun.COM% To achive this, remember the "biggest" unnum. sec. we are currently in:
3959*8044SWilliam.Kucharski@Sun.COM\chardef\unmlevel = \maxseclevel
3960*8044SWilliam.Kucharski@Sun.COM%
3961*8044SWilliam.Kucharski@Sun.COM% Trace whether the current chapter is an appendix or not:
3962*8044SWilliam.Kucharski@Sun.COM% \chapheadtype is "N" or "A", unnumbered chapters are ignored.
3963*8044SWilliam.Kucharski@Sun.COM\def\chapheadtype{N}
3964*8044SWilliam.Kucharski@Sun.COM
3965*8044SWilliam.Kucharski@Sun.COM% Choose a heading macro
3966*8044SWilliam.Kucharski@Sun.COM% #1 is heading type
3967*8044SWilliam.Kucharski@Sun.COM% #2 is heading level
3968*8044SWilliam.Kucharski@Sun.COM% #3 is text for heading
3969*8044SWilliam.Kucharski@Sun.COM\def\genhead#1#2#3{%
3970*8044SWilliam.Kucharski@Sun.COM  % Compute the abs. sec. level:
3971*8044SWilliam.Kucharski@Sun.COM  \absseclevel=#2
3972*8044SWilliam.Kucharski@Sun.COM  \advance\absseclevel by \secbase
3973*8044SWilliam.Kucharski@Sun.COM  % Make sure \absseclevel doesn't fall outside the range:
3974*8044SWilliam.Kucharski@Sun.COM  \ifnum \absseclevel < 0
3975*8044SWilliam.Kucharski@Sun.COM    \absseclevel = 0
3976*8044SWilliam.Kucharski@Sun.COM  \else
3977*8044SWilliam.Kucharski@Sun.COM    \ifnum \absseclevel > 3
3978*8044SWilliam.Kucharski@Sun.COM      \absseclevel = 3
3979*8044SWilliam.Kucharski@Sun.COM    \fi
3980*8044SWilliam.Kucharski@Sun.COM  \fi
3981*8044SWilliam.Kucharski@Sun.COM  % The heading type:
3982*8044SWilliam.Kucharski@Sun.COM  \def\headtype{#1}%
3983*8044SWilliam.Kucharski@Sun.COM  \if \headtype U%
3984*8044SWilliam.Kucharski@Sun.COM    \ifnum \absseclevel < \unmlevel
3985*8044SWilliam.Kucharski@Sun.COM      \chardef\unmlevel = \absseclevel
3986*8044SWilliam.Kucharski@Sun.COM    \fi
3987*8044SWilliam.Kucharski@Sun.COM  \else
3988*8044SWilliam.Kucharski@Sun.COM    % Check for appendix sections:
3989*8044SWilliam.Kucharski@Sun.COM    \ifnum \absseclevel = 0
3990*8044SWilliam.Kucharski@Sun.COM      \edef\chapheadtype{\headtype}%
3991*8044SWilliam.Kucharski@Sun.COM    \else
3992*8044SWilliam.Kucharski@Sun.COM      \if \headtype A\if \chapheadtype N%
3993*8044SWilliam.Kucharski@Sun.COM	\errmessage{@appendix... within a non-appendix chapter}%
3994*8044SWilliam.Kucharski@Sun.COM      \fi\fi
3995*8044SWilliam.Kucharski@Sun.COM    \fi
3996*8044SWilliam.Kucharski@Sun.COM    % Check for numbered within unnumbered:
3997*8044SWilliam.Kucharski@Sun.COM    \ifnum \absseclevel > \unmlevel
3998*8044SWilliam.Kucharski@Sun.COM      \def\headtype{U}%
3999*8044SWilliam.Kucharski@Sun.COM    \else
4000*8044SWilliam.Kucharski@Sun.COM      \chardef\unmlevel = 3
4001*8044SWilliam.Kucharski@Sun.COM    \fi
4002*8044SWilliam.Kucharski@Sun.COM  \fi
4003*8044SWilliam.Kucharski@Sun.COM  % Now print the heading:
4004*8044SWilliam.Kucharski@Sun.COM  \if \headtype U%
4005*8044SWilliam.Kucharski@Sun.COM    \ifcase\absseclevel
4006*8044SWilliam.Kucharski@Sun.COM	\unnumberedzzz{#3}%
4007*8044SWilliam.Kucharski@Sun.COM    \or \unnumberedseczzz{#3}%
4008*8044SWilliam.Kucharski@Sun.COM    \or \unnumberedsubseczzz{#3}%
4009*8044SWilliam.Kucharski@Sun.COM    \or \unnumberedsubsubseczzz{#3}%
4010*8044SWilliam.Kucharski@Sun.COM    \fi
4011*8044SWilliam.Kucharski@Sun.COM  \else
4012*8044SWilliam.Kucharski@Sun.COM    \if \headtype A%
4013*8044SWilliam.Kucharski@Sun.COM      \ifcase\absseclevel
4014*8044SWilliam.Kucharski@Sun.COM	  \appendixzzz{#3}%
4015*8044SWilliam.Kucharski@Sun.COM      \or \appendixsectionzzz{#3}%
4016*8044SWilliam.Kucharski@Sun.COM      \or \appendixsubseczzz{#3}%
4017*8044SWilliam.Kucharski@Sun.COM      \or \appendixsubsubseczzz{#3}%
4018*8044SWilliam.Kucharski@Sun.COM      \fi
4019*8044SWilliam.Kucharski@Sun.COM    \else
4020*8044SWilliam.Kucharski@Sun.COM      \ifcase\absseclevel
4021*8044SWilliam.Kucharski@Sun.COM	  \chapterzzz{#3}%
4022*8044SWilliam.Kucharski@Sun.COM      \or \seczzz{#3}%
4023*8044SWilliam.Kucharski@Sun.COM      \or \numberedsubseczzz{#3}%
4024*8044SWilliam.Kucharski@Sun.COM      \or \numberedsubsubseczzz{#3}%
4025*8044SWilliam.Kucharski@Sun.COM      \fi
4026*8044SWilliam.Kucharski@Sun.COM    \fi
4027*8044SWilliam.Kucharski@Sun.COM  \fi
4028*8044SWilliam.Kucharski@Sun.COM  \suppressfirstparagraphindent
4029*8044SWilliam.Kucharski@Sun.COM}
4030*8044SWilliam.Kucharski@Sun.COM
4031*8044SWilliam.Kucharski@Sun.COM% an interface:
4032*8044SWilliam.Kucharski@Sun.COM\def\numhead{\genhead N}
4033*8044SWilliam.Kucharski@Sun.COM\def\apphead{\genhead A}
4034*8044SWilliam.Kucharski@Sun.COM\def\unnmhead{\genhead U}
4035*8044SWilliam.Kucharski@Sun.COM
4036*8044SWilliam.Kucharski@Sun.COM% @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
4037*8044SWilliam.Kucharski@Sun.COM% all lower-level sectioning counters to zero.
4038*8044SWilliam.Kucharski@Sun.COM%
4039*8044SWilliam.Kucharski@Sun.COM% Also set \chaplevelprefix, which we prepend to @float sequence numbers
4040*8044SWilliam.Kucharski@Sun.COM% (e.g., figures), q.v.  By default (before any chapter), that is empty.
4041*8044SWilliam.Kucharski@Sun.COM\let\chaplevelprefix = \empty
4042*8044SWilliam.Kucharski@Sun.COM%
4043*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4044*8044SWilliam.Kucharski@Sun.COM\def\chapterzzz#1{%
4045*8044SWilliam.Kucharski@Sun.COM  % section resetting is \global in case the chapter is in a group, such
4046*8044SWilliam.Kucharski@Sun.COM  % as an @include file.
4047*8044SWilliam.Kucharski@Sun.COM  \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4048*8044SWilliam.Kucharski@Sun.COM    \global\advance\chapno by 1
4049*8044SWilliam.Kucharski@Sun.COM  %
4050*8044SWilliam.Kucharski@Sun.COM  % Used for \float.
4051*8044SWilliam.Kucharski@Sun.COM  \gdef\chaplevelprefix{\the\chapno.}%
4052*8044SWilliam.Kucharski@Sun.COM  \resetallfloatnos
4053*8044SWilliam.Kucharski@Sun.COM  %
4054*8044SWilliam.Kucharski@Sun.COM  \message{\putwordChapter\space \the\chapno}%
4055*8044SWilliam.Kucharski@Sun.COM  %
4056*8044SWilliam.Kucharski@Sun.COM  % Write the actual heading.
4057*8044SWilliam.Kucharski@Sun.COM  \chapmacro{#1}{Ynumbered}{\the\chapno}%
4058*8044SWilliam.Kucharski@Sun.COM  %
4059*8044SWilliam.Kucharski@Sun.COM  % So @section and the like are numbered underneath this chapter.
4060*8044SWilliam.Kucharski@Sun.COM  \global\let\section = \numberedsec
4061*8044SWilliam.Kucharski@Sun.COM  \global\let\subsection = \numberedsubsec
4062*8044SWilliam.Kucharski@Sun.COM  \global\let\subsubsection = \numberedsubsubsec
4063*8044SWilliam.Kucharski@Sun.COM}
4064*8044SWilliam.Kucharski@Sun.COM
4065*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4066*8044SWilliam.Kucharski@Sun.COM\def\appendixzzz#1{%
4067*8044SWilliam.Kucharski@Sun.COM  \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4068*8044SWilliam.Kucharski@Sun.COM    \global\advance\appendixno by 1
4069*8044SWilliam.Kucharski@Sun.COM  \gdef\chaplevelprefix{\appendixletter.}%
4070*8044SWilliam.Kucharski@Sun.COM  \resetallfloatnos
4071*8044SWilliam.Kucharski@Sun.COM  %
4072*8044SWilliam.Kucharski@Sun.COM  \def\appendixnum{\putwordAppendix\space \appendixletter}%
4073*8044SWilliam.Kucharski@Sun.COM  \message{\appendixnum}%
4074*8044SWilliam.Kucharski@Sun.COM  %
4075*8044SWilliam.Kucharski@Sun.COM  \chapmacro{#1}{Yappendix}{\appendixletter}%
4076*8044SWilliam.Kucharski@Sun.COM  %
4077*8044SWilliam.Kucharski@Sun.COM  \global\let\section = \appendixsec
4078*8044SWilliam.Kucharski@Sun.COM  \global\let\subsection = \appendixsubsec
4079*8044SWilliam.Kucharski@Sun.COM  \global\let\subsubsection = \appendixsubsubsec
4080*8044SWilliam.Kucharski@Sun.COM}
4081*8044SWilliam.Kucharski@Sun.COM
4082*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4083*8044SWilliam.Kucharski@Sun.COM\def\unnumberedzzz#1{%
4084*8044SWilliam.Kucharski@Sun.COM  \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4085*8044SWilliam.Kucharski@Sun.COM    \global\advance\unnumberedno by 1
4086*8044SWilliam.Kucharski@Sun.COM  %
4087*8044SWilliam.Kucharski@Sun.COM  % Since an unnumbered has no number, no prefix for figures.
4088*8044SWilliam.Kucharski@Sun.COM  \global\let\chaplevelprefix = \empty
4089*8044SWilliam.Kucharski@Sun.COM  \resetallfloatnos
4090*8044SWilliam.Kucharski@Sun.COM  %
4091*8044SWilliam.Kucharski@Sun.COM  % This used to be simply \message{#1}, but TeX fully expands the
4092*8044SWilliam.Kucharski@Sun.COM  % argument to \message.  Therefore, if #1 contained @-commands, TeX
4093*8044SWilliam.Kucharski@Sun.COM  % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
4094*8044SWilliam.Kucharski@Sun.COM  % expanded @cite (which turns out to cause errors because \cite is meant
4095*8044SWilliam.Kucharski@Sun.COM  % to be executed, not expanded).
4096*8044SWilliam.Kucharski@Sun.COM  %
4097*8044SWilliam.Kucharski@Sun.COM  % Anyway, we don't want the fully-expanded definition of @cite to appear
4098*8044SWilliam.Kucharski@Sun.COM  % as a result of the \message, we just want `@cite' itself.  We use
4099*8044SWilliam.Kucharski@Sun.COM  % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4100*8044SWilliam.Kucharski@Sun.COM  % simply yielding the contents of <toks register>.  (We also do this for
4101*8044SWilliam.Kucharski@Sun.COM  % the toc entries.)
4102*8044SWilliam.Kucharski@Sun.COM  \toks0 = {#1}%
4103*8044SWilliam.Kucharski@Sun.COM  \message{(\the\toks0)}%
4104*8044SWilliam.Kucharski@Sun.COM  %
4105*8044SWilliam.Kucharski@Sun.COM  \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4106*8044SWilliam.Kucharski@Sun.COM  %
4107*8044SWilliam.Kucharski@Sun.COM  \global\let\section = \unnumberedsec
4108*8044SWilliam.Kucharski@Sun.COM  \global\let\subsection = \unnumberedsubsec
4109*8044SWilliam.Kucharski@Sun.COM  \global\let\subsubsection = \unnumberedsubsubsec
4110*8044SWilliam.Kucharski@Sun.COM}
4111*8044SWilliam.Kucharski@Sun.COM
4112*8044SWilliam.Kucharski@Sun.COM% @centerchap is like @unnumbered, but the heading is centered.
4113*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\centerchap{%
4114*8044SWilliam.Kucharski@Sun.COM  % Well, we could do the following in a group, but that would break
4115*8044SWilliam.Kucharski@Sun.COM  % an assumption that \chapmacro is called at the outermost level.
4116*8044SWilliam.Kucharski@Sun.COM  % Thus we are safer this way:		--kasal, 24feb04
4117*8044SWilliam.Kucharski@Sun.COM  \let\centerparametersmaybe = \centerparameters
4118*8044SWilliam.Kucharski@Sun.COM  \unnmhead0{#1}%
4119*8044SWilliam.Kucharski@Sun.COM  \let\centerparametersmaybe = \relax
4120*8044SWilliam.Kucharski@Sun.COM}
4121*8044SWilliam.Kucharski@Sun.COM
4122*8044SWilliam.Kucharski@Sun.COM% @top is like @unnumbered.
4123*8044SWilliam.Kucharski@Sun.COM\let\top\unnumbered
4124*8044SWilliam.Kucharski@Sun.COM
4125*8044SWilliam.Kucharski@Sun.COM% Sections.
4126*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4127*8044SWilliam.Kucharski@Sun.COM\def\seczzz#1{%
4128*8044SWilliam.Kucharski@Sun.COM  \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
4129*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4130*8044SWilliam.Kucharski@Sun.COM}
4131*8044SWilliam.Kucharski@Sun.COM
4132*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4133*8044SWilliam.Kucharski@Sun.COM\def\appendixsectionzzz#1{%
4134*8044SWilliam.Kucharski@Sun.COM  \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
4135*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4136*8044SWilliam.Kucharski@Sun.COM}
4137*8044SWilliam.Kucharski@Sun.COM\let\appendixsec\appendixsection
4138*8044SWilliam.Kucharski@Sun.COM
4139*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4140*8044SWilliam.Kucharski@Sun.COM\def\unnumberedseczzz#1{%
4141*8044SWilliam.Kucharski@Sun.COM  \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
4142*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4143*8044SWilliam.Kucharski@Sun.COM}
4144*8044SWilliam.Kucharski@Sun.COM
4145*8044SWilliam.Kucharski@Sun.COM% Subsections.
4146*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4147*8044SWilliam.Kucharski@Sun.COM\def\numberedsubseczzz#1{%
4148*8044SWilliam.Kucharski@Sun.COM  \global\subsubsecno=0  \global\advance\subsecno by 1
4149*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4150*8044SWilliam.Kucharski@Sun.COM}
4151*8044SWilliam.Kucharski@Sun.COM
4152*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4153*8044SWilliam.Kucharski@Sun.COM\def\appendixsubseczzz#1{%
4154*8044SWilliam.Kucharski@Sun.COM  \global\subsubsecno=0  \global\advance\subsecno by 1
4155*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{subsec}{Yappendix}%
4156*8044SWilliam.Kucharski@Sun.COM                 {\appendixletter.\the\secno.\the\subsecno}%
4157*8044SWilliam.Kucharski@Sun.COM}
4158*8044SWilliam.Kucharski@Sun.COM
4159*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4160*8044SWilliam.Kucharski@Sun.COM\def\unnumberedsubseczzz#1{%
4161*8044SWilliam.Kucharski@Sun.COM  \global\subsubsecno=0  \global\advance\subsecno by 1
4162*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{subsec}{Ynothing}%
4163*8044SWilliam.Kucharski@Sun.COM                 {\the\unnumberedno.\the\secno.\the\subsecno}%
4164*8044SWilliam.Kucharski@Sun.COM}
4165*8044SWilliam.Kucharski@Sun.COM
4166*8044SWilliam.Kucharski@Sun.COM% Subsubsections.
4167*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4168*8044SWilliam.Kucharski@Sun.COM\def\numberedsubsubseczzz#1{%
4169*8044SWilliam.Kucharski@Sun.COM  \global\advance\subsubsecno by 1
4170*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{subsubsec}{Ynumbered}%
4171*8044SWilliam.Kucharski@Sun.COM                 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4172*8044SWilliam.Kucharski@Sun.COM}
4173*8044SWilliam.Kucharski@Sun.COM
4174*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4175*8044SWilliam.Kucharski@Sun.COM\def\appendixsubsubseczzz#1{%
4176*8044SWilliam.Kucharski@Sun.COM  \global\advance\subsubsecno by 1
4177*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{subsubsec}{Yappendix}%
4178*8044SWilliam.Kucharski@Sun.COM                 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4179*8044SWilliam.Kucharski@Sun.COM}
4180*8044SWilliam.Kucharski@Sun.COM
4181*8044SWilliam.Kucharski@Sun.COM\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4182*8044SWilliam.Kucharski@Sun.COM\def\unnumberedsubsubseczzz#1{%
4183*8044SWilliam.Kucharski@Sun.COM  \global\advance\subsubsecno by 1
4184*8044SWilliam.Kucharski@Sun.COM  \sectionheading{#1}{subsubsec}{Ynothing}%
4185*8044SWilliam.Kucharski@Sun.COM                 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4186*8044SWilliam.Kucharski@Sun.COM}
4187*8044SWilliam.Kucharski@Sun.COM
4188*8044SWilliam.Kucharski@Sun.COM% These macros control what the section commands do, according
4189*8044SWilliam.Kucharski@Sun.COM% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4190*8044SWilliam.Kucharski@Sun.COM% Define them by default for a numbered chapter.
4191*8044SWilliam.Kucharski@Sun.COM\let\section = \numberedsec
4192*8044SWilliam.Kucharski@Sun.COM\let\subsection = \numberedsubsec
4193*8044SWilliam.Kucharski@Sun.COM\let\subsubsection = \numberedsubsubsec
4194*8044SWilliam.Kucharski@Sun.COM
4195*8044SWilliam.Kucharski@Sun.COM% Define @majorheading, @heading and @subheading
4196*8044SWilliam.Kucharski@Sun.COM
4197*8044SWilliam.Kucharski@Sun.COM% NOTE on use of \vbox for chapter headings, section headings, and such:
4198*8044SWilliam.Kucharski@Sun.COM%       1) We use \vbox rather than the earlier \line to permit
4199*8044SWilliam.Kucharski@Sun.COM%          overlong headings to fold.
4200*8044SWilliam.Kucharski@Sun.COM%       2) \hyphenpenalty is set to 10000 because hyphenation in a
4201*8044SWilliam.Kucharski@Sun.COM%          heading is obnoxious; this forbids it.
4202*8044SWilliam.Kucharski@Sun.COM%       3) Likewise, headings look best if no \parindent is used, and
4203*8044SWilliam.Kucharski@Sun.COM%          if justification is not attempted.  Hence \raggedright.
4204*8044SWilliam.Kucharski@Sun.COM
4205*8044SWilliam.Kucharski@Sun.COM
4206*8044SWilliam.Kucharski@Sun.COM\def\majorheading{%
4207*8044SWilliam.Kucharski@Sun.COM  {\advance\chapheadingskip by 10pt \chapbreak }%
4208*8044SWilliam.Kucharski@Sun.COM  \parsearg\chapheadingzzz
4209*8044SWilliam.Kucharski@Sun.COM}
4210*8044SWilliam.Kucharski@Sun.COM
4211*8044SWilliam.Kucharski@Sun.COM\def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4212*8044SWilliam.Kucharski@Sun.COM\def\chapheadingzzz#1{%
4213*8044SWilliam.Kucharski@Sun.COM  {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4214*8044SWilliam.Kucharski@Sun.COM                    \parindent=0pt\raggedright
4215*8044SWilliam.Kucharski@Sun.COM                    \rm #1\hfill}}%
4216*8044SWilliam.Kucharski@Sun.COM  \bigskip \par\penalty 200\relax
4217*8044SWilliam.Kucharski@Sun.COM  \suppressfirstparagraphindent
4218*8044SWilliam.Kucharski@Sun.COM}
4219*8044SWilliam.Kucharski@Sun.COM
4220*8044SWilliam.Kucharski@Sun.COM% @heading, @subheading, @subsubheading.
4221*8044SWilliam.Kucharski@Sun.COM\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4222*8044SWilliam.Kucharski@Sun.COM  \suppressfirstparagraphindent}
4223*8044SWilliam.Kucharski@Sun.COM\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4224*8044SWilliam.Kucharski@Sun.COM  \suppressfirstparagraphindent}
4225*8044SWilliam.Kucharski@Sun.COM\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4226*8044SWilliam.Kucharski@Sun.COM  \suppressfirstparagraphindent}
4227*8044SWilliam.Kucharski@Sun.COM
4228*8044SWilliam.Kucharski@Sun.COM% These macros generate a chapter, section, etc. heading only
4229*8044SWilliam.Kucharski@Sun.COM% (including whitespace, linebreaking, etc. around it),
4230*8044SWilliam.Kucharski@Sun.COM% given all the information in convenient, parsed form.
4231*8044SWilliam.Kucharski@Sun.COM
4232*8044SWilliam.Kucharski@Sun.COM%%% Args are the skip and penalty (usually negative)
4233*8044SWilliam.Kucharski@Sun.COM\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4234*8044SWilliam.Kucharski@Sun.COM
4235*8044SWilliam.Kucharski@Sun.COM%%% Define plain chapter starts, and page on/off switching for it
4236*8044SWilliam.Kucharski@Sun.COM% Parameter controlling skip before chapter headings (if needed)
4237*8044SWilliam.Kucharski@Sun.COM
4238*8044SWilliam.Kucharski@Sun.COM\newskip\chapheadingskip
4239*8044SWilliam.Kucharski@Sun.COM
4240*8044SWilliam.Kucharski@Sun.COM\def\chapbreak{\dobreak \chapheadingskip {-4000}}
4241*8044SWilliam.Kucharski@Sun.COM\def\chappager{\par\vfill\supereject}
4242*8044SWilliam.Kucharski@Sun.COM\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4243*8044SWilliam.Kucharski@Sun.COM
4244*8044SWilliam.Kucharski@Sun.COM\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4245*8044SWilliam.Kucharski@Sun.COM
4246*8044SWilliam.Kucharski@Sun.COM\def\CHAPPAGoff{%
4247*8044SWilliam.Kucharski@Sun.COM\global\let\contentsalignmacro = \chappager
4248*8044SWilliam.Kucharski@Sun.COM\global\let\pchapsepmacro=\chapbreak
4249*8044SWilliam.Kucharski@Sun.COM\global\let\pagealignmacro=\chappager}
4250*8044SWilliam.Kucharski@Sun.COM
4251*8044SWilliam.Kucharski@Sun.COM\def\CHAPPAGon{%
4252*8044SWilliam.Kucharski@Sun.COM\global\let\contentsalignmacro = \chappager
4253*8044SWilliam.Kucharski@Sun.COM\global\let\pchapsepmacro=\chappager
4254*8044SWilliam.Kucharski@Sun.COM\global\let\pagealignmacro=\chappager
4255*8044SWilliam.Kucharski@Sun.COM\global\def\HEADINGSon{\HEADINGSsingle}}
4256*8044SWilliam.Kucharski@Sun.COM
4257*8044SWilliam.Kucharski@Sun.COM\def\CHAPPAGodd{%
4258*8044SWilliam.Kucharski@Sun.COM\global\let\contentsalignmacro = \chapoddpage
4259*8044SWilliam.Kucharski@Sun.COM\global\let\pchapsepmacro=\chapoddpage
4260*8044SWilliam.Kucharski@Sun.COM\global\let\pagealignmacro=\chapoddpage
4261*8044SWilliam.Kucharski@Sun.COM\global\def\HEADINGSon{\HEADINGSdouble}}
4262*8044SWilliam.Kucharski@Sun.COM
4263*8044SWilliam.Kucharski@Sun.COM\CHAPPAGon
4264*8044SWilliam.Kucharski@Sun.COM
4265*8044SWilliam.Kucharski@Sun.COM% Chapter opening.
4266*8044SWilliam.Kucharski@Sun.COM%
4267*8044SWilliam.Kucharski@Sun.COM% #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4268*8044SWilliam.Kucharski@Sun.COM% Yappendix, Yomitfromtoc), #3 the chapter number.
4269*8044SWilliam.Kucharski@Sun.COM%
4270*8044SWilliam.Kucharski@Sun.COM% To test against our argument.
4271*8044SWilliam.Kucharski@Sun.COM\def\Ynothingkeyword{Ynothing}
4272*8044SWilliam.Kucharski@Sun.COM\def\Yomitfromtockeyword{Yomitfromtoc}
4273*8044SWilliam.Kucharski@Sun.COM\def\Yappendixkeyword{Yappendix}
4274*8044SWilliam.Kucharski@Sun.COM%
4275*8044SWilliam.Kucharski@Sun.COM\def\chapmacro#1#2#3{%
4276*8044SWilliam.Kucharski@Sun.COM  \pchapsepmacro
4277*8044SWilliam.Kucharski@Sun.COM  {%
4278*8044SWilliam.Kucharski@Sun.COM    \chapfonts \rm
4279*8044SWilliam.Kucharski@Sun.COM    %
4280*8044SWilliam.Kucharski@Sun.COM    % Have to define \thissection before calling \donoderef, because the
4281*8044SWilliam.Kucharski@Sun.COM    % xref code eventually uses it.  On the other hand, it has to be called
4282*8044SWilliam.Kucharski@Sun.COM    % after \pchapsepmacro, or the headline will change too soon.
4283*8044SWilliam.Kucharski@Sun.COM    \gdef\thissection{#1}%
4284*8044SWilliam.Kucharski@Sun.COM    \gdef\thischaptername{#1}%
4285*8044SWilliam.Kucharski@Sun.COM    %
4286*8044SWilliam.Kucharski@Sun.COM    % Only insert the separating space if we have a chapter/appendix
4287*8044SWilliam.Kucharski@Sun.COM    % number, and don't print the unnumbered ``number''.
4288*8044SWilliam.Kucharski@Sun.COM    \def\temptype{#2}%
4289*8044SWilliam.Kucharski@Sun.COM    \ifx\temptype\Ynothingkeyword
4290*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{}%
4291*8044SWilliam.Kucharski@Sun.COM      \def\toctype{unnchap}%
4292*8044SWilliam.Kucharski@Sun.COM      \def\thischapter{#1}%
4293*8044SWilliam.Kucharski@Sun.COM    \else\ifx\temptype\Yomitfromtockeyword
4294*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4295*8044SWilliam.Kucharski@Sun.COM      \def\toctype{omit}%
4296*8044SWilliam.Kucharski@Sun.COM      \xdef\thischapter{}%
4297*8044SWilliam.Kucharski@Sun.COM    \else\ifx\temptype\Yappendixkeyword
4298*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4299*8044SWilliam.Kucharski@Sun.COM      \def\toctype{app}%
4300*8044SWilliam.Kucharski@Sun.COM      % We don't substitute the actual chapter name into \thischapter
4301*8044SWilliam.Kucharski@Sun.COM      % because we don't want its macros evaluated now.  And we don't
4302*8044SWilliam.Kucharski@Sun.COM      % use \thissection because that changes with each section.
4303*8044SWilliam.Kucharski@Sun.COM      %
4304*8044SWilliam.Kucharski@Sun.COM      \xdef\thischapter{\putwordAppendix{} \appendixletter:
4305*8044SWilliam.Kucharski@Sun.COM                        \noexpand\thischaptername}%
4306*8044SWilliam.Kucharski@Sun.COM    \else
4307*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{#3\enspace}%
4308*8044SWilliam.Kucharski@Sun.COM      \def\toctype{numchap}%
4309*8044SWilliam.Kucharski@Sun.COM      \xdef\thischapter{\putwordChapter{} \the\chapno:
4310*8044SWilliam.Kucharski@Sun.COM                        \noexpand\thischaptername}%
4311*8044SWilliam.Kucharski@Sun.COM    \fi\fi\fi
4312*8044SWilliam.Kucharski@Sun.COM    %
4313*8044SWilliam.Kucharski@Sun.COM    % Write the toc entry for this chapter.  Must come before the
4314*8044SWilliam.Kucharski@Sun.COM    % \donoderef, because we include the current node name in the toc
4315*8044SWilliam.Kucharski@Sun.COM    % entry, and \donoderef resets it to empty.
4316*8044SWilliam.Kucharski@Sun.COM    \writetocentry{\toctype}{#1}{#3}%
4317*8044SWilliam.Kucharski@Sun.COM    %
4318*8044SWilliam.Kucharski@Sun.COM    % For pdftex, we have to write out the node definition (aka, make
4319*8044SWilliam.Kucharski@Sun.COM    % the pdfdest) after any page break, but before the actual text has
4320*8044SWilliam.Kucharski@Sun.COM    % been typeset.  If the destination for the pdf outline is after the
4321*8044SWilliam.Kucharski@Sun.COM    % text, then jumping from the outline may wind up with the text not
4322*8044SWilliam.Kucharski@Sun.COM    % being visible, for instance under high magnification.
4323*8044SWilliam.Kucharski@Sun.COM    \donoderef{#2}%
4324*8044SWilliam.Kucharski@Sun.COM    %
4325*8044SWilliam.Kucharski@Sun.COM    % Typeset the actual heading.
4326*8044SWilliam.Kucharski@Sun.COM    \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4327*8044SWilliam.Kucharski@Sun.COM          \hangindent=\wd0 \centerparametersmaybe
4328*8044SWilliam.Kucharski@Sun.COM          \unhbox0 #1\par}%
4329*8044SWilliam.Kucharski@Sun.COM  }%
4330*8044SWilliam.Kucharski@Sun.COM  \nobreak\bigskip % no page break after a chapter title
4331*8044SWilliam.Kucharski@Sun.COM  \nobreak
4332*8044SWilliam.Kucharski@Sun.COM}
4333*8044SWilliam.Kucharski@Sun.COM
4334*8044SWilliam.Kucharski@Sun.COM% @centerchap -- centered and unnumbered.
4335*8044SWilliam.Kucharski@Sun.COM\let\centerparametersmaybe = \relax
4336*8044SWilliam.Kucharski@Sun.COM\def\centerparameters{%
4337*8044SWilliam.Kucharski@Sun.COM  \advance\rightskip by 3\rightskip
4338*8044SWilliam.Kucharski@Sun.COM  \leftskip = \rightskip
4339*8044SWilliam.Kucharski@Sun.COM  \parfillskip = 0pt
4340*8044SWilliam.Kucharski@Sun.COM}
4341*8044SWilliam.Kucharski@Sun.COM
4342*8044SWilliam.Kucharski@Sun.COM
4343*8044SWilliam.Kucharski@Sun.COM% I don't think this chapter style is supported any more, so I'm not
4344*8044SWilliam.Kucharski@Sun.COM% updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
4345*8044SWilliam.Kucharski@Sun.COM%
4346*8044SWilliam.Kucharski@Sun.COM\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4347*8044SWilliam.Kucharski@Sun.COM%
4348*8044SWilliam.Kucharski@Sun.COM\def\unnchfopen #1{%
4349*8044SWilliam.Kucharski@Sun.COM\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4350*8044SWilliam.Kucharski@Sun.COM                       \parindent=0pt\raggedright
4351*8044SWilliam.Kucharski@Sun.COM                       \rm #1\hfill}}\bigskip \par\nobreak
4352*8044SWilliam.Kucharski@Sun.COM}
4353*8044SWilliam.Kucharski@Sun.COM\def\chfopen #1#2{\chapoddpage {\chapfonts
4354*8044SWilliam.Kucharski@Sun.COM\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4355*8044SWilliam.Kucharski@Sun.COM\par\penalty 5000 %
4356*8044SWilliam.Kucharski@Sun.COM}
4357*8044SWilliam.Kucharski@Sun.COM\def\centerchfopen #1{%
4358*8044SWilliam.Kucharski@Sun.COM\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4359*8044SWilliam.Kucharski@Sun.COM                       \parindent=0pt
4360*8044SWilliam.Kucharski@Sun.COM                       \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4361*8044SWilliam.Kucharski@Sun.COM}
4362*8044SWilliam.Kucharski@Sun.COM\def\CHAPFopen{%
4363*8044SWilliam.Kucharski@Sun.COM  \global\let\chapmacro=\chfopen
4364*8044SWilliam.Kucharski@Sun.COM  \global\let\centerchapmacro=\centerchfopen}
4365*8044SWilliam.Kucharski@Sun.COM
4366*8044SWilliam.Kucharski@Sun.COM
4367*8044SWilliam.Kucharski@Sun.COM% Section titles.  These macros combine the section number parts and
4368*8044SWilliam.Kucharski@Sun.COM% call the generic \sectionheading to do the printing.
4369*8044SWilliam.Kucharski@Sun.COM%
4370*8044SWilliam.Kucharski@Sun.COM\newskip\secheadingskip
4371*8044SWilliam.Kucharski@Sun.COM\def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4372*8044SWilliam.Kucharski@Sun.COM
4373*8044SWilliam.Kucharski@Sun.COM% Subsection titles.
4374*8044SWilliam.Kucharski@Sun.COM\newskip\subsecheadingskip
4375*8044SWilliam.Kucharski@Sun.COM\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4376*8044SWilliam.Kucharski@Sun.COM
4377*8044SWilliam.Kucharski@Sun.COM% Subsubsection titles.
4378*8044SWilliam.Kucharski@Sun.COM\def\subsubsecheadingskip{\subsecheadingskip}
4379*8044SWilliam.Kucharski@Sun.COM\def\subsubsecheadingbreak{\subsecheadingbreak}
4380*8044SWilliam.Kucharski@Sun.COM
4381*8044SWilliam.Kucharski@Sun.COM
4382*8044SWilliam.Kucharski@Sun.COM% Print any size, any type, section title.
4383*8044SWilliam.Kucharski@Sun.COM%
4384*8044SWilliam.Kucharski@Sun.COM% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4385*8044SWilliam.Kucharski@Sun.COM% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4386*8044SWilliam.Kucharski@Sun.COM% section number.
4387*8044SWilliam.Kucharski@Sun.COM%
4388*8044SWilliam.Kucharski@Sun.COM\def\sectionheading#1#2#3#4{%
4389*8044SWilliam.Kucharski@Sun.COM  {%
4390*8044SWilliam.Kucharski@Sun.COM    % Switch to the right set of fonts.
4391*8044SWilliam.Kucharski@Sun.COM    \csname #2fonts\endcsname \rm
4392*8044SWilliam.Kucharski@Sun.COM    %
4393*8044SWilliam.Kucharski@Sun.COM    % Insert space above the heading.
4394*8044SWilliam.Kucharski@Sun.COM    \csname #2headingbreak\endcsname
4395*8044SWilliam.Kucharski@Sun.COM    %
4396*8044SWilliam.Kucharski@Sun.COM    % Only insert the space after the number if we have a section number.
4397*8044SWilliam.Kucharski@Sun.COM    \def\sectionlevel{#2}%
4398*8044SWilliam.Kucharski@Sun.COM    \def\temptype{#3}%
4399*8044SWilliam.Kucharski@Sun.COM    %
4400*8044SWilliam.Kucharski@Sun.COM    \ifx\temptype\Ynothingkeyword
4401*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{}%
4402*8044SWilliam.Kucharski@Sun.COM      \def\toctype{unn}%
4403*8044SWilliam.Kucharski@Sun.COM      \gdef\thissection{#1}%
4404*8044SWilliam.Kucharski@Sun.COM    \else\ifx\temptype\Yomitfromtockeyword
4405*8044SWilliam.Kucharski@Sun.COM      % for @headings -- no section number, don't include in toc,
4406*8044SWilliam.Kucharski@Sun.COM      % and don't redefine \thissection.
4407*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{}%
4408*8044SWilliam.Kucharski@Sun.COM      \def\toctype{omit}%
4409*8044SWilliam.Kucharski@Sun.COM      \let\sectionlevel=\empty
4410*8044SWilliam.Kucharski@Sun.COM    \else\ifx\temptype\Yappendixkeyword
4411*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{#4\enspace}%
4412*8044SWilliam.Kucharski@Sun.COM      \def\toctype{app}%
4413*8044SWilliam.Kucharski@Sun.COM      \gdef\thissection{#1}%
4414*8044SWilliam.Kucharski@Sun.COM    \else
4415*8044SWilliam.Kucharski@Sun.COM      \setbox0 = \hbox{#4\enspace}%
4416*8044SWilliam.Kucharski@Sun.COM      \def\toctype{num}%
4417*8044SWilliam.Kucharski@Sun.COM      \gdef\thissection{#1}%
4418*8044SWilliam.Kucharski@Sun.COM    \fi\fi\fi
4419*8044SWilliam.Kucharski@Sun.COM    %
4420*8044SWilliam.Kucharski@Sun.COM    % Write the toc entry (before \donoderef).  See comments in \chfplain.
4421*8044SWilliam.Kucharski@Sun.COM    \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4422*8044SWilliam.Kucharski@Sun.COM    %
4423*8044SWilliam.Kucharski@Sun.COM    % Write the node reference (= pdf destination for pdftex).
4424*8044SWilliam.Kucharski@Sun.COM    % Again, see comments in \chfplain.
4425*8044SWilliam.Kucharski@Sun.COM    \donoderef{#3}%
4426*8044SWilliam.Kucharski@Sun.COM    %
4427*8044SWilliam.Kucharski@Sun.COM    % Output the actual section heading.
4428*8044SWilliam.Kucharski@Sun.COM    \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4429*8044SWilliam.Kucharski@Sun.COM          \hangindent=\wd0  % zero if no section number
4430*8044SWilliam.Kucharski@Sun.COM          \unhbox0 #1}%
4431*8044SWilliam.Kucharski@Sun.COM  }%
4432*8044SWilliam.Kucharski@Sun.COM  % Add extra space after the heading -- half of whatever came above it.
4433*8044SWilliam.Kucharski@Sun.COM  % Don't allow stretch, though.
4434*8044SWilliam.Kucharski@Sun.COM  \kern .5 \csname #2headingskip\endcsname
4435*8044SWilliam.Kucharski@Sun.COM  %
4436*8044SWilliam.Kucharski@Sun.COM  % Do not let the kern be a potential breakpoint, as it would be if it
4437*8044SWilliam.Kucharski@Sun.COM  % was followed by glue.
4438*8044SWilliam.Kucharski@Sun.COM  \nobreak
4439*8044SWilliam.Kucharski@Sun.COM  %
4440*8044SWilliam.Kucharski@Sun.COM  % We'll almost certainly start a paragraph next, so don't let that
4441*8044SWilliam.Kucharski@Sun.COM  % glue accumulate.  (Not a breakpoint because it's preceded by a
4442*8044SWilliam.Kucharski@Sun.COM  % discardable item.)
4443*8044SWilliam.Kucharski@Sun.COM  \vskip-\parskip
4444*8044SWilliam.Kucharski@Sun.COM  %
4445*8044SWilliam.Kucharski@Sun.COM  % This is purely so the last item on the list is a known \penalty >
4446*8044SWilliam.Kucharski@Sun.COM  % 10000.  This is so \startdefun can avoid allowing breakpoints after
4447*8044SWilliam.Kucharski@Sun.COM  % section headings.  Otherwise, it would insert a valid breakpoint between:
4448*8044SWilliam.Kucharski@Sun.COM  %
4449*8044SWilliam.Kucharski@Sun.COM  %   @section sec-whatever
4450*8044SWilliam.Kucharski@Sun.COM  %   @deffn def-whatever
4451*8044SWilliam.Kucharski@Sun.COM  \penalty 10001
4452*8044SWilliam.Kucharski@Sun.COM}
4453*8044SWilliam.Kucharski@Sun.COM
4454*8044SWilliam.Kucharski@Sun.COM
4455*8044SWilliam.Kucharski@Sun.COM\message{toc,}
4456*8044SWilliam.Kucharski@Sun.COM% Table of contents.
4457*8044SWilliam.Kucharski@Sun.COM\newwrite\tocfile
4458*8044SWilliam.Kucharski@Sun.COM
4459*8044SWilliam.Kucharski@Sun.COM% Write an entry to the toc file, opening it if necessary.
4460*8044SWilliam.Kucharski@Sun.COM% Called from @chapter, etc.
4461*8044SWilliam.Kucharski@Sun.COM%
4462*8044SWilliam.Kucharski@Sun.COM% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4463*8044SWilliam.Kucharski@Sun.COM% We append the current node name (if any) and page number as additional
4464*8044SWilliam.Kucharski@Sun.COM% arguments for the \{chap,sec,...}entry macros which will eventually
4465*8044SWilliam.Kucharski@Sun.COM% read this.  The node name is used in the pdf outlines as the
4466*8044SWilliam.Kucharski@Sun.COM% destination to jump to.
4467*8044SWilliam.Kucharski@Sun.COM%
4468*8044SWilliam.Kucharski@Sun.COM% We open the .toc file for writing here instead of at @setfilename (or
4469*8044SWilliam.Kucharski@Sun.COM% any other fixed time) so that @contents can be anywhere in the document.
4470*8044SWilliam.Kucharski@Sun.COM% But if #1 is `omit', then we don't do anything.  This is used for the
4471*8044SWilliam.Kucharski@Sun.COM% table of contents chapter openings themselves.
4472*8044SWilliam.Kucharski@Sun.COM%
4473*8044SWilliam.Kucharski@Sun.COM\newif\iftocfileopened
4474*8044SWilliam.Kucharski@Sun.COM\def\omitkeyword{omit}%
4475*8044SWilliam.Kucharski@Sun.COM%
4476*8044SWilliam.Kucharski@Sun.COM\def\writetocentry#1#2#3{%
4477*8044SWilliam.Kucharski@Sun.COM  \edef\writetoctype{#1}%
4478*8044SWilliam.Kucharski@Sun.COM  \ifx\writetoctype\omitkeyword \else
4479*8044SWilliam.Kucharski@Sun.COM    \iftocfileopened\else
4480*8044SWilliam.Kucharski@Sun.COM      \immediate\openout\tocfile = \jobname.toc
4481*8044SWilliam.Kucharski@Sun.COM      \global\tocfileopenedtrue
4482*8044SWilliam.Kucharski@Sun.COM    \fi
4483*8044SWilliam.Kucharski@Sun.COM    %
4484*8044SWilliam.Kucharski@Sun.COM    \iflinks
4485*8044SWilliam.Kucharski@Sun.COM      \toks0 = {#2}%
4486*8044SWilliam.Kucharski@Sun.COM      \toks2 = \expandafter{\lastnode}%
4487*8044SWilliam.Kucharski@Sun.COM      \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}%
4488*8044SWilliam.Kucharski@Sun.COM                               {\the\toks2}{\noexpand\folio}}}%
4489*8044SWilliam.Kucharski@Sun.COM      \temp
4490*8044SWilliam.Kucharski@Sun.COM    \fi
4491*8044SWilliam.Kucharski@Sun.COM  \fi
4492*8044SWilliam.Kucharski@Sun.COM  %
4493*8044SWilliam.Kucharski@Sun.COM  % Tell \shipout to create a pdf destination on each page, if we're
4494*8044SWilliam.Kucharski@Sun.COM  % writing pdf.  These are used in the table of contents.  We can't
4495*8044SWilliam.Kucharski@Sun.COM  % just write one on every page because the title pages are numbered
4496*8044SWilliam.Kucharski@Sun.COM  % 1 and 2 (the page numbers aren't printed), and so are the first
4497*8044SWilliam.Kucharski@Sun.COM  % two pages of the document.  Thus, we'd have two destinations named
4498*8044SWilliam.Kucharski@Sun.COM  % `1', and two named `2'.
4499*8044SWilliam.Kucharski@Sun.COM  \ifpdf \global\pdfmakepagedesttrue \fi
4500*8044SWilliam.Kucharski@Sun.COM}
4501*8044SWilliam.Kucharski@Sun.COM
4502*8044SWilliam.Kucharski@Sun.COM\newskip\contentsrightmargin \contentsrightmargin=1in
4503*8044SWilliam.Kucharski@Sun.COM\newcount\savepageno
4504*8044SWilliam.Kucharski@Sun.COM\newcount\lastnegativepageno \lastnegativepageno = -1
4505*8044SWilliam.Kucharski@Sun.COM
4506*8044SWilliam.Kucharski@Sun.COM% Prepare to read what we've written to \tocfile.
4507*8044SWilliam.Kucharski@Sun.COM%
4508*8044SWilliam.Kucharski@Sun.COM\def\startcontents#1{%
4509*8044SWilliam.Kucharski@Sun.COM  % If @setchapternewpage on, and @headings double, the contents should
4510*8044SWilliam.Kucharski@Sun.COM  % start on an odd page, unlike chapters.  Thus, we maintain
4511*8044SWilliam.Kucharski@Sun.COM  % \contentsalignmacro in parallel with \pagealignmacro.
4512*8044SWilliam.Kucharski@Sun.COM  % From: Torbjorn Granlund <tege@matematik.su.se>
4513*8044SWilliam.Kucharski@Sun.COM  \contentsalignmacro
4514*8044SWilliam.Kucharski@Sun.COM  \immediate\closeout\tocfile
4515*8044SWilliam.Kucharski@Sun.COM  %
4516*8044SWilliam.Kucharski@Sun.COM  % Don't need to put `Contents' or `Short Contents' in the headline.
4517*8044SWilliam.Kucharski@Sun.COM  % It is abundantly clear what they are.
4518*8044SWilliam.Kucharski@Sun.COM  \def\thischapter{}%
4519*8044SWilliam.Kucharski@Sun.COM  \chapmacro{#1}{Yomitfromtoc}{}%
4520*8044SWilliam.Kucharski@Sun.COM  %
4521*8044SWilliam.Kucharski@Sun.COM  \savepageno = \pageno
4522*8044SWilliam.Kucharski@Sun.COM  \begingroup                  % Set up to handle contents files properly.
4523*8044SWilliam.Kucharski@Sun.COM    \catcode`\\=0  \catcode`\{=1  \catcode`\}=2  \catcode`\@=11
4524*8044SWilliam.Kucharski@Sun.COM    % We can't do this, because then an actual ^ in a section
4525*8044SWilliam.Kucharski@Sun.COM    % title fails, e.g., @chapter ^ -- exponentiation.  --karl, 9jul97.
4526*8044SWilliam.Kucharski@Sun.COM    %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4527*8044SWilliam.Kucharski@Sun.COM    \raggedbottom             % Worry more about breakpoints than the bottom.
4528*8044SWilliam.Kucharski@Sun.COM    \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4529*8044SWilliam.Kucharski@Sun.COM    %
4530*8044SWilliam.Kucharski@Sun.COM    % Roman numerals for page numbers.
4531*8044SWilliam.Kucharski@Sun.COM    \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4532*8044SWilliam.Kucharski@Sun.COM}
4533*8044SWilliam.Kucharski@Sun.COM
4534*8044SWilliam.Kucharski@Sun.COM
4535*8044SWilliam.Kucharski@Sun.COM% Normal (long) toc.
4536*8044SWilliam.Kucharski@Sun.COM\def\contents{%
4537*8044SWilliam.Kucharski@Sun.COM  \startcontents{\putwordTOC}%
4538*8044SWilliam.Kucharski@Sun.COM    \openin 1 \jobname.toc
4539*8044SWilliam.Kucharski@Sun.COM    \ifeof 1 \else
4540*8044SWilliam.Kucharski@Sun.COM      \input \jobname.toc
4541*8044SWilliam.Kucharski@Sun.COM    \fi
4542*8044SWilliam.Kucharski@Sun.COM    \vfill \eject
4543*8044SWilliam.Kucharski@Sun.COM    \contentsalignmacro % in case @setchapternewpage odd is in effect
4544*8044SWilliam.Kucharski@Sun.COM    \ifeof 1 \else
4545*8044SWilliam.Kucharski@Sun.COM      \pdfmakeoutlines
4546*8044SWilliam.Kucharski@Sun.COM    \fi
4547*8044SWilliam.Kucharski@Sun.COM    \closein 1
4548*8044SWilliam.Kucharski@Sun.COM  \endgroup
4549*8044SWilliam.Kucharski@Sun.COM  \lastnegativepageno = \pageno
4550*8044SWilliam.Kucharski@Sun.COM  \global\pageno = \savepageno
4551*8044SWilliam.Kucharski@Sun.COM}
4552*8044SWilliam.Kucharski@Sun.COM
4553*8044SWilliam.Kucharski@Sun.COM% And just the chapters.
4554*8044SWilliam.Kucharski@Sun.COM\def\summarycontents{%
4555*8044SWilliam.Kucharski@Sun.COM  \startcontents{\putwordShortTOC}%
4556*8044SWilliam.Kucharski@Sun.COM    %
4557*8044SWilliam.Kucharski@Sun.COM    \let\numchapentry = \shortchapentry
4558*8044SWilliam.Kucharski@Sun.COM    \let\appentry = \shortchapentry
4559*8044SWilliam.Kucharski@Sun.COM    \let\unnchapentry = \shortunnchapentry
4560*8044SWilliam.Kucharski@Sun.COM    % We want a true roman here for the page numbers.
4561*8044SWilliam.Kucharski@Sun.COM    \secfonts
4562*8044SWilliam.Kucharski@Sun.COM    \let\rm=\shortcontrm \let\bf=\shortcontbf
4563*8044SWilliam.Kucharski@Sun.COM    \let\sl=\shortcontsl \let\tt=\shortconttt
4564*8044SWilliam.Kucharski@Sun.COM    \rm
4565*8044SWilliam.Kucharski@Sun.COM    \hyphenpenalty = 10000
4566*8044SWilliam.Kucharski@Sun.COM    \advance\baselineskip by 1pt % Open it up a little.
4567*8044SWilliam.Kucharski@Sun.COM    \def\numsecentry##1##2##3##4{}
4568*8044SWilliam.Kucharski@Sun.COM    \let\appsecentry = \numsecentry
4569*8044SWilliam.Kucharski@Sun.COM    \let\unnsecentry = \numsecentry
4570*8044SWilliam.Kucharski@Sun.COM    \let\numsubsecentry = \numsecentry
4571*8044SWilliam.Kucharski@Sun.COM    \let\appsubsecentry = \numsecentry
4572*8044SWilliam.Kucharski@Sun.COM    \let\unnsubsecentry = \numsecentry
4573*8044SWilliam.Kucharski@Sun.COM    \let\numsubsubsecentry = \numsecentry
4574*8044SWilliam.Kucharski@Sun.COM    \let\appsubsubsecentry = \numsecentry
4575*8044SWilliam.Kucharski@Sun.COM    \let\unnsubsubsecentry = \numsecentry
4576*8044SWilliam.Kucharski@Sun.COM    \openin 1 \jobname.toc
4577*8044SWilliam.Kucharski@Sun.COM    \ifeof 1 \else
4578*8044SWilliam.Kucharski@Sun.COM      \input \jobname.toc
4579*8044SWilliam.Kucharski@Sun.COM    \fi
4580*8044SWilliam.Kucharski@Sun.COM    \closein 1
4581*8044SWilliam.Kucharski@Sun.COM    \vfill \eject
4582*8044SWilliam.Kucharski@Sun.COM    \contentsalignmacro % in case @setchapternewpage odd is in effect
4583*8044SWilliam.Kucharski@Sun.COM  \endgroup
4584*8044SWilliam.Kucharski@Sun.COM  \lastnegativepageno = \pageno
4585*8044SWilliam.Kucharski@Sun.COM  \global\pageno = \savepageno
4586*8044SWilliam.Kucharski@Sun.COM}
4587*8044SWilliam.Kucharski@Sun.COM\let\shortcontents = \summarycontents
4588*8044SWilliam.Kucharski@Sun.COM
4589*8044SWilliam.Kucharski@Sun.COM% Typeset the label for a chapter or appendix for the short contents.
4590*8044SWilliam.Kucharski@Sun.COM% The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4591*8044SWilliam.Kucharski@Sun.COM%
4592*8044SWilliam.Kucharski@Sun.COM\def\shortchaplabel#1{%
4593*8044SWilliam.Kucharski@Sun.COM  % This space should be enough, since a single number is .5em, and the
4594*8044SWilliam.Kucharski@Sun.COM  % widest letter (M) is 1em, at least in the Computer Modern fonts.
4595*8044SWilliam.Kucharski@Sun.COM  % But use \hss just in case.
4596*8044SWilliam.Kucharski@Sun.COM  % (This space doesn't include the extra space that gets added after
4597*8044SWilliam.Kucharski@Sun.COM  % the label; that gets put in by \shortchapentry above.)
4598*8044SWilliam.Kucharski@Sun.COM  %
4599*8044SWilliam.Kucharski@Sun.COM  % We'd like to right-justify chapter numbers, but that looks strange
4600*8044SWilliam.Kucharski@Sun.COM  % with appendix letters.  And right-justifying numbers and
4601*8044SWilliam.Kucharski@Sun.COM  % left-justifying letters looks strange when there is less than 10
4602*8044SWilliam.Kucharski@Sun.COM  % chapters.  Have to read the whole toc once to know how many chapters
4603*8044SWilliam.Kucharski@Sun.COM  % there are before deciding ...
4604*8044SWilliam.Kucharski@Sun.COM  \hbox to 1em{#1\hss}%
4605*8044SWilliam.Kucharski@Sun.COM}
4606*8044SWilliam.Kucharski@Sun.COM
4607*8044SWilliam.Kucharski@Sun.COM% These macros generate individual entries in the table of contents.
4608*8044SWilliam.Kucharski@Sun.COM% The first argument is the chapter or section name.
4609*8044SWilliam.Kucharski@Sun.COM% The last argument is the page number.
4610*8044SWilliam.Kucharski@Sun.COM% The arguments in between are the chapter number, section number, ...
4611*8044SWilliam.Kucharski@Sun.COM
4612*8044SWilliam.Kucharski@Sun.COM% Chapters, in the main contents.
4613*8044SWilliam.Kucharski@Sun.COM\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4614*8044SWilliam.Kucharski@Sun.COM%
4615*8044SWilliam.Kucharski@Sun.COM% Chapters, in the short toc.
4616*8044SWilliam.Kucharski@Sun.COM% See comments in \dochapentry re vbox and related settings.
4617*8044SWilliam.Kucharski@Sun.COM\def\shortchapentry#1#2#3#4{%
4618*8044SWilliam.Kucharski@Sun.COM  \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4619*8044SWilliam.Kucharski@Sun.COM}
4620*8044SWilliam.Kucharski@Sun.COM
4621*8044SWilliam.Kucharski@Sun.COM% Appendices, in the main contents.
4622*8044SWilliam.Kucharski@Sun.COM% Need the word Appendix, and a fixed-size box.
4623*8044SWilliam.Kucharski@Sun.COM%
4624*8044SWilliam.Kucharski@Sun.COM\def\appendixbox#1{%
4625*8044SWilliam.Kucharski@Sun.COM  % We use M since it's probably the widest letter.
4626*8044SWilliam.Kucharski@Sun.COM  \setbox0 = \hbox{\putwordAppendix{} M}%
4627*8044SWilliam.Kucharski@Sun.COM  \hbox to \wd0{\putwordAppendix{} #1\hss}}
4628*8044SWilliam.Kucharski@Sun.COM%
4629*8044SWilliam.Kucharski@Sun.COM\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4630*8044SWilliam.Kucharski@Sun.COM
4631*8044SWilliam.Kucharski@Sun.COM% Unnumbered chapters.
4632*8044SWilliam.Kucharski@Sun.COM\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4633*8044SWilliam.Kucharski@Sun.COM\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4634*8044SWilliam.Kucharski@Sun.COM
4635*8044SWilliam.Kucharski@Sun.COM% Sections.
4636*8044SWilliam.Kucharski@Sun.COM\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4637*8044SWilliam.Kucharski@Sun.COM\let\appsecentry=\numsecentry
4638*8044SWilliam.Kucharski@Sun.COM\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4639*8044SWilliam.Kucharski@Sun.COM
4640*8044SWilliam.Kucharski@Sun.COM% Subsections.
4641*8044SWilliam.Kucharski@Sun.COM\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4642*8044SWilliam.Kucharski@Sun.COM\let\appsubsecentry=\numsubsecentry
4643*8044SWilliam.Kucharski@Sun.COM\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4644*8044SWilliam.Kucharski@Sun.COM
4645*8044SWilliam.Kucharski@Sun.COM% And subsubsections.
4646*8044SWilliam.Kucharski@Sun.COM\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4647*8044SWilliam.Kucharski@Sun.COM\let\appsubsubsecentry=\numsubsubsecentry
4648*8044SWilliam.Kucharski@Sun.COM\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4649*8044SWilliam.Kucharski@Sun.COM
4650*8044SWilliam.Kucharski@Sun.COM% This parameter controls the indentation of the various levels.
4651*8044SWilliam.Kucharski@Sun.COM% Same as \defaultparindent.
4652*8044SWilliam.Kucharski@Sun.COM\newdimen\tocindent \tocindent = 15pt
4653*8044SWilliam.Kucharski@Sun.COM
4654*8044SWilliam.Kucharski@Sun.COM% Now for the actual typesetting. In all these, #1 is the text and #2 is the
4655*8044SWilliam.Kucharski@Sun.COM% page number.
4656*8044SWilliam.Kucharski@Sun.COM%
4657*8044SWilliam.Kucharski@Sun.COM% If the toc has to be broken over pages, we want it to be at chapters
4658*8044SWilliam.Kucharski@Sun.COM% if at all possible; hence the \penalty.
4659*8044SWilliam.Kucharski@Sun.COM\def\dochapentry#1#2{%
4660*8044SWilliam.Kucharski@Sun.COM   \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4661*8044SWilliam.Kucharski@Sun.COM   \begingroup
4662*8044SWilliam.Kucharski@Sun.COM     \chapentryfonts
4663*8044SWilliam.Kucharski@Sun.COM     \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4664*8044SWilliam.Kucharski@Sun.COM   \endgroup
4665*8044SWilliam.Kucharski@Sun.COM   \nobreak\vskip .25\baselineskip plus.1\baselineskip
4666*8044SWilliam.Kucharski@Sun.COM}
4667*8044SWilliam.Kucharski@Sun.COM
4668*8044SWilliam.Kucharski@Sun.COM\def\dosecentry#1#2{\begingroup
4669*8044SWilliam.Kucharski@Sun.COM  \secentryfonts \leftskip=\tocindent
4670*8044SWilliam.Kucharski@Sun.COM  \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4671*8044SWilliam.Kucharski@Sun.COM\endgroup}
4672*8044SWilliam.Kucharski@Sun.COM
4673*8044SWilliam.Kucharski@Sun.COM\def\dosubsecentry#1#2{\begingroup
4674*8044SWilliam.Kucharski@Sun.COM  \subsecentryfonts \leftskip=2\tocindent
4675*8044SWilliam.Kucharski@Sun.COM  \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4676*8044SWilliam.Kucharski@Sun.COM\endgroup}
4677*8044SWilliam.Kucharski@Sun.COM
4678*8044SWilliam.Kucharski@Sun.COM\def\dosubsubsecentry#1#2{\begingroup
4679*8044SWilliam.Kucharski@Sun.COM  \subsubsecentryfonts \leftskip=3\tocindent
4680*8044SWilliam.Kucharski@Sun.COM  \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4681*8044SWilliam.Kucharski@Sun.COM\endgroup}
4682*8044SWilliam.Kucharski@Sun.COM
4683*8044SWilliam.Kucharski@Sun.COM% We use the same \entry macro as for the index entries.
4684*8044SWilliam.Kucharski@Sun.COM\let\tocentry = \entry
4685*8044SWilliam.Kucharski@Sun.COM
4686*8044SWilliam.Kucharski@Sun.COM% Space between chapter (or whatever) number and the title.
4687*8044SWilliam.Kucharski@Sun.COM\def\labelspace{\hskip1em \relax}
4688*8044SWilliam.Kucharski@Sun.COM
4689*8044SWilliam.Kucharski@Sun.COM\def\dopageno#1{{\rm #1}}
4690*8044SWilliam.Kucharski@Sun.COM\def\doshortpageno#1{{\rm #1}}
4691*8044SWilliam.Kucharski@Sun.COM
4692*8044SWilliam.Kucharski@Sun.COM\def\chapentryfonts{\secfonts \rm}
4693*8044SWilliam.Kucharski@Sun.COM\def\secentryfonts{\textfonts}
4694*8044SWilliam.Kucharski@Sun.COM\def\subsecentryfonts{\textfonts}
4695*8044SWilliam.Kucharski@Sun.COM\def\subsubsecentryfonts{\textfonts}
4696*8044SWilliam.Kucharski@Sun.COM
4697*8044SWilliam.Kucharski@Sun.COM
4698*8044SWilliam.Kucharski@Sun.COM\message{environments,}
4699*8044SWilliam.Kucharski@Sun.COM% @foo ... @end foo.
4700*8044SWilliam.Kucharski@Sun.COM
4701*8044SWilliam.Kucharski@Sun.COM% @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4702*8044SWilliam.Kucharski@Sun.COM%
4703*8044SWilliam.Kucharski@Sun.COM% Since these characters are used in examples, it should be an even number of
4704*8044SWilliam.Kucharski@Sun.COM% \tt widths. Each \tt character is 1en, so two makes it 1em.
4705*8044SWilliam.Kucharski@Sun.COM%
4706*8044SWilliam.Kucharski@Sun.COM\def\point{$\star$}
4707*8044SWilliam.Kucharski@Sun.COM\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4708*8044SWilliam.Kucharski@Sun.COM\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4709*8044SWilliam.Kucharski@Sun.COM\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4710*8044SWilliam.Kucharski@Sun.COM\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4711*8044SWilliam.Kucharski@Sun.COM
4712*8044SWilliam.Kucharski@Sun.COM% The @error{} command.
4713*8044SWilliam.Kucharski@Sun.COM% Adapted from the TeXbook's \boxit.
4714*8044SWilliam.Kucharski@Sun.COM%
4715*8044SWilliam.Kucharski@Sun.COM\newbox\errorbox
4716*8044SWilliam.Kucharski@Sun.COM%
4717*8044SWilliam.Kucharski@Sun.COM{\tentt \global\dimen0 = 3em}% Width of the box.
4718*8044SWilliam.Kucharski@Sun.COM\dimen2 = .55pt % Thickness of rules
4719*8044SWilliam.Kucharski@Sun.COM% The text. (`r' is open on the right, `e' somewhat less so on the left.)
4720*8044SWilliam.Kucharski@Sun.COM\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4721*8044SWilliam.Kucharski@Sun.COM%
4722*8044SWilliam.Kucharski@Sun.COM\setbox\errorbox=\hbox to \dimen0{\hfil
4723*8044SWilliam.Kucharski@Sun.COM   \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4724*8044SWilliam.Kucharski@Sun.COM   \advance\hsize by -2\dimen2 % Rules.
4725*8044SWilliam.Kucharski@Sun.COM   \vbox{%
4726*8044SWilliam.Kucharski@Sun.COM      \hrule height\dimen2
4727*8044SWilliam.Kucharski@Sun.COM      \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
4728*8044SWilliam.Kucharski@Sun.COM         \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4729*8044SWilliam.Kucharski@Sun.COM         \kern3pt\vrule width\dimen2}% Space to right.
4730*8044SWilliam.Kucharski@Sun.COM      \hrule height\dimen2}
4731*8044SWilliam.Kucharski@Sun.COM    \hfil}
4732*8044SWilliam.Kucharski@Sun.COM%
4733*8044SWilliam.Kucharski@Sun.COM\def\error{\leavevmode\lower.7ex\copy\errorbox}
4734*8044SWilliam.Kucharski@Sun.COM
4735*8044SWilliam.Kucharski@Sun.COM% @tex ... @end tex    escapes into raw Tex temporarily.
4736*8044SWilliam.Kucharski@Sun.COM% One exception: @ is still an escape character, so that @end tex works.
4737*8044SWilliam.Kucharski@Sun.COM% But \@ or @@ will get a plain tex @ character.
4738*8044SWilliam.Kucharski@Sun.COM
4739*8044SWilliam.Kucharski@Sun.COM\envdef\tex{%
4740*8044SWilliam.Kucharski@Sun.COM  \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4741*8044SWilliam.Kucharski@Sun.COM  \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4742*8044SWilliam.Kucharski@Sun.COM  \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4743*8044SWilliam.Kucharski@Sun.COM  \catcode `\%=14
4744*8044SWilliam.Kucharski@Sun.COM  \catcode `\+=\other
4745*8044SWilliam.Kucharski@Sun.COM  \catcode `\"=\other
4746*8044SWilliam.Kucharski@Sun.COM  \catcode `\|=\other
4747*8044SWilliam.Kucharski@Sun.COM  \catcode `\<=\other
4748*8044SWilliam.Kucharski@Sun.COM  \catcode `\>=\other
4749*8044SWilliam.Kucharski@Sun.COM  \escapechar=`\\
4750*8044SWilliam.Kucharski@Sun.COM  %
4751*8044SWilliam.Kucharski@Sun.COM  \let\b=\ptexb
4752*8044SWilliam.Kucharski@Sun.COM  \let\bullet=\ptexbullet
4753*8044SWilliam.Kucharski@Sun.COM  \let\c=\ptexc
4754*8044SWilliam.Kucharski@Sun.COM  \let\,=\ptexcomma
4755*8044SWilliam.Kucharski@Sun.COM  \let\.=\ptexdot
4756*8044SWilliam.Kucharski@Sun.COM  \let\dots=\ptexdots
4757*8044SWilliam.Kucharski@Sun.COM  \let\equiv=\ptexequiv
4758*8044SWilliam.Kucharski@Sun.COM  \let\!=\ptexexclam
4759*8044SWilliam.Kucharski@Sun.COM  \let\i=\ptexi
4760*8044SWilliam.Kucharski@Sun.COM  \let\indent=\ptexindent
4761*8044SWilliam.Kucharski@Sun.COM  \let\noindent=\ptexnoindent
4762*8044SWilliam.Kucharski@Sun.COM  \let\{=\ptexlbrace
4763*8044SWilliam.Kucharski@Sun.COM  \let\+=\tabalign
4764*8044SWilliam.Kucharski@Sun.COM  \let\}=\ptexrbrace
4765*8044SWilliam.Kucharski@Sun.COM  \let\/=\ptexslash
4766*8044SWilliam.Kucharski@Sun.COM  \let\*=\ptexstar
4767*8044SWilliam.Kucharski@Sun.COM  \let\t=\ptext
4768*8044SWilliam.Kucharski@Sun.COM  %
4769*8044SWilliam.Kucharski@Sun.COM  \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4770*8044SWilliam.Kucharski@Sun.COM  \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4771*8044SWilliam.Kucharski@Sun.COM  \def\@{@}%
4772*8044SWilliam.Kucharski@Sun.COM}
4773*8044SWilliam.Kucharski@Sun.COM% There is no need to define \Etex.
4774*8044SWilliam.Kucharski@Sun.COM
4775*8044SWilliam.Kucharski@Sun.COM% Define @lisp ... @end lisp.
4776*8044SWilliam.Kucharski@Sun.COM% @lisp environment forms a group so it can rebind things,
4777*8044SWilliam.Kucharski@Sun.COM% including the definition of @end lisp (which normally is erroneous).
4778*8044SWilliam.Kucharski@Sun.COM
4779*8044SWilliam.Kucharski@Sun.COM% Amount to narrow the margins by for @lisp.
4780*8044SWilliam.Kucharski@Sun.COM\newskip\lispnarrowing \lispnarrowing=0.4in
4781*8044SWilliam.Kucharski@Sun.COM
4782*8044SWilliam.Kucharski@Sun.COM% This is the definition that ^^M gets inside @lisp, @example, and other
4783*8044SWilliam.Kucharski@Sun.COM% such environments.  \null is better than a space, since it doesn't
4784*8044SWilliam.Kucharski@Sun.COM% have any width.
4785*8044SWilliam.Kucharski@Sun.COM\def\lisppar{\null\endgraf}
4786*8044SWilliam.Kucharski@Sun.COM
4787*8044SWilliam.Kucharski@Sun.COM% This space is always present above and below environments.
4788*8044SWilliam.Kucharski@Sun.COM\newskip\envskipamount \envskipamount = 0pt
4789*8044SWilliam.Kucharski@Sun.COM
4790*8044SWilliam.Kucharski@Sun.COM% Make spacing and below environment symmetrical.  We use \parskip here
4791*8044SWilliam.Kucharski@Sun.COM% to help in doing that, since in @example-like environments \parskip
4792*8044SWilliam.Kucharski@Sun.COM% is reset to zero; thus the \afterenvbreak inserts no space -- but the
4793*8044SWilliam.Kucharski@Sun.COM% start of the next paragraph will insert \parskip.
4794*8044SWilliam.Kucharski@Sun.COM%
4795*8044SWilliam.Kucharski@Sun.COM\def\aboveenvbreak{{%
4796*8044SWilliam.Kucharski@Sun.COM  % =10000 instead of <10000 because of a special case in \itemzzz and
4797*8044SWilliam.Kucharski@Sun.COM  % \sectionheading, q.v.
4798*8044SWilliam.Kucharski@Sun.COM  \ifnum \lastpenalty=10000 \else
4799*8044SWilliam.Kucharski@Sun.COM    \advance\envskipamount by \parskip
4800*8044SWilliam.Kucharski@Sun.COM    \endgraf
4801*8044SWilliam.Kucharski@Sun.COM    \ifdim\lastskip<\envskipamount
4802*8044SWilliam.Kucharski@Sun.COM      \removelastskip
4803*8044SWilliam.Kucharski@Sun.COM      % it's not a good place to break if the last penalty was \nobreak
4804*8044SWilliam.Kucharski@Sun.COM      % or better ...
4805*8044SWilliam.Kucharski@Sun.COM      \ifnum\lastpenalty<10000 \penalty-50 \fi
4806*8044SWilliam.Kucharski@Sun.COM      \vskip\envskipamount
4807*8044SWilliam.Kucharski@Sun.COM    \fi
4808*8044SWilliam.Kucharski@Sun.COM  \fi
4809*8044SWilliam.Kucharski@Sun.COM}}
4810*8044SWilliam.Kucharski@Sun.COM
4811*8044SWilliam.Kucharski@Sun.COM\let\afterenvbreak = \aboveenvbreak
4812*8044SWilliam.Kucharski@Sun.COM
4813*8044SWilliam.Kucharski@Sun.COM% \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins.
4814*8044SWilliam.Kucharski@Sun.COM\let\nonarrowing=\relax
4815*8044SWilliam.Kucharski@Sun.COM
4816*8044SWilliam.Kucharski@Sun.COM% @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4817*8044SWilliam.Kucharski@Sun.COM% environment contents.
4818*8044SWilliam.Kucharski@Sun.COM\font\circle=lcircle10
4819*8044SWilliam.Kucharski@Sun.COM\newdimen\circthick
4820*8044SWilliam.Kucharski@Sun.COM\newdimen\cartouter\newdimen\cartinner
4821*8044SWilliam.Kucharski@Sun.COM\newskip\normbskip\newskip\normpskip\newskip\normlskip
4822*8044SWilliam.Kucharski@Sun.COM\circthick=\fontdimen8\circle
4823*8044SWilliam.Kucharski@Sun.COM%
4824*8044SWilliam.Kucharski@Sun.COM\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4825*8044SWilliam.Kucharski@Sun.COM\def\ctr{{\hskip 6pt\circle\char'010}}
4826*8044SWilliam.Kucharski@Sun.COM\def\cbl{{\circle\char'012\hskip -6pt}}
4827*8044SWilliam.Kucharski@Sun.COM\def\cbr{{\hskip 6pt\circle\char'011}}
4828*8044SWilliam.Kucharski@Sun.COM\def\carttop{\hbox to \cartouter{\hskip\lskip
4829*8044SWilliam.Kucharski@Sun.COM        \ctl\leaders\hrule height\circthick\hfil\ctr
4830*8044SWilliam.Kucharski@Sun.COM        \hskip\rskip}}
4831*8044SWilliam.Kucharski@Sun.COM\def\cartbot{\hbox to \cartouter{\hskip\lskip
4832*8044SWilliam.Kucharski@Sun.COM        \cbl\leaders\hrule height\circthick\hfil\cbr
4833*8044SWilliam.Kucharski@Sun.COM        \hskip\rskip}}
4834*8044SWilliam.Kucharski@Sun.COM%
4835*8044SWilliam.Kucharski@Sun.COM\newskip\lskip\newskip\rskip
4836*8044SWilliam.Kucharski@Sun.COM
4837*8044SWilliam.Kucharski@Sun.COM\envdef\cartouche{%
4838*8044SWilliam.Kucharski@Sun.COM  \ifhmode\par\fi  % can't be in the midst of a paragraph.
4839*8044SWilliam.Kucharski@Sun.COM  \startsavinginserts
4840*8044SWilliam.Kucharski@Sun.COM  \lskip=\leftskip \rskip=\rightskip
4841*8044SWilliam.Kucharski@Sun.COM  \leftskip=0pt\rightskip=0pt % we want these *outside*.
4842*8044SWilliam.Kucharski@Sun.COM  \cartinner=\hsize \advance\cartinner by-\lskip
4843*8044SWilliam.Kucharski@Sun.COM  \advance\cartinner by-\rskip
4844*8044SWilliam.Kucharski@Sun.COM  \cartouter=\hsize
4845*8044SWilliam.Kucharski@Sun.COM  \advance\cartouter by 18.4pt	% allow for 3pt kerns on either
4846*8044SWilliam.Kucharski@Sun.COM				% side, and for 6pt waste from
4847*8044SWilliam.Kucharski@Sun.COM				% each corner char, and rule thickness
4848*8044SWilliam.Kucharski@Sun.COM  \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4849*8044SWilliam.Kucharski@Sun.COM  % Flag to tell @lisp, etc., not to narrow margin.
4850*8044SWilliam.Kucharski@Sun.COM  \let\nonarrowing=\comment
4851*8044SWilliam.Kucharski@Sun.COM  \vbox\bgroup
4852*8044SWilliam.Kucharski@Sun.COM      \baselineskip=0pt\parskip=0pt\lineskip=0pt
4853*8044SWilliam.Kucharski@Sun.COM      \carttop
4854*8044SWilliam.Kucharski@Sun.COM      \hbox\bgroup
4855*8044SWilliam.Kucharski@Sun.COM	  \hskip\lskip
4856*8044SWilliam.Kucharski@Sun.COM	  \vrule\kern3pt
4857*8044SWilliam.Kucharski@Sun.COM	  \vbox\bgroup
4858*8044SWilliam.Kucharski@Sun.COM	      \kern3pt
4859*8044SWilliam.Kucharski@Sun.COM	      \hsize=\cartinner
4860*8044SWilliam.Kucharski@Sun.COM	      \baselineskip=\normbskip
4861*8044SWilliam.Kucharski@Sun.COM	      \lineskip=\normlskip
4862*8044SWilliam.Kucharski@Sun.COM	      \parskip=\normpskip
4863*8044SWilliam.Kucharski@Sun.COM	      \vskip -\parskip
4864*8044SWilliam.Kucharski@Sun.COM	      \comment % For explanation, see the end of \def\group.
4865*8044SWilliam.Kucharski@Sun.COM}
4866*8044SWilliam.Kucharski@Sun.COM\def\Ecartouche{%
4867*8044SWilliam.Kucharski@Sun.COM              \ifhmode\par\fi
4868*8044SWilliam.Kucharski@Sun.COM	      \kern3pt
4869*8044SWilliam.Kucharski@Sun.COM	  \egroup
4870*8044SWilliam.Kucharski@Sun.COM	  \kern3pt\vrule
4871*8044SWilliam.Kucharski@Sun.COM	  \hskip\rskip
4872*8044SWilliam.Kucharski@Sun.COM      \egroup
4873*8044SWilliam.Kucharski@Sun.COM      \cartbot
4874*8044SWilliam.Kucharski@Sun.COM  \egroup
4875*8044SWilliam.Kucharski@Sun.COM  \checkinserts
4876*8044SWilliam.Kucharski@Sun.COM}
4877*8044SWilliam.Kucharski@Sun.COM
4878*8044SWilliam.Kucharski@Sun.COM
4879*8044SWilliam.Kucharski@Sun.COM% This macro is called at the beginning of all the @example variants,
4880*8044SWilliam.Kucharski@Sun.COM% inside a group.
4881*8044SWilliam.Kucharski@Sun.COM\def\nonfillstart{%
4882*8044SWilliam.Kucharski@Sun.COM  \aboveenvbreak
4883*8044SWilliam.Kucharski@Sun.COM  \hfuzz = 12pt % Don't be fussy
4884*8044SWilliam.Kucharski@Sun.COM  \sepspaces % Make spaces be word-separators rather than space tokens.
4885*8044SWilliam.Kucharski@Sun.COM  \let\par = \lisppar % don't ignore blank lines
4886*8044SWilliam.Kucharski@Sun.COM  \obeylines % each line of input is a line of output
4887*8044SWilliam.Kucharski@Sun.COM  \parskip = 0pt
4888*8044SWilliam.Kucharski@Sun.COM  \parindent = 0pt
4889*8044SWilliam.Kucharski@Sun.COM  \emergencystretch = 0pt % don't try to avoid overfull boxes
4890*8044SWilliam.Kucharski@Sun.COM  % @cartouche defines \nonarrowing to inhibit narrowing
4891*8044SWilliam.Kucharski@Sun.COM  % at next level down.
4892*8044SWilliam.Kucharski@Sun.COM  \ifx\nonarrowing\relax
4893*8044SWilliam.Kucharski@Sun.COM    \advance \leftskip by \lispnarrowing
4894*8044SWilliam.Kucharski@Sun.COM    \exdentamount=\lispnarrowing
4895*8044SWilliam.Kucharski@Sun.COM  \fi
4896*8044SWilliam.Kucharski@Sun.COM  \let\exdent=\nofillexdent
4897*8044SWilliam.Kucharski@Sun.COM}
4898*8044SWilliam.Kucharski@Sun.COM
4899*8044SWilliam.Kucharski@Sun.COM% If you want all examples etc. small: @set dispenvsize small.
4900*8044SWilliam.Kucharski@Sun.COM% If you want even small examples the full size: @set dispenvsize nosmall.
4901*8044SWilliam.Kucharski@Sun.COM% This affects the following displayed environments:
4902*8044SWilliam.Kucharski@Sun.COM%    @example, @display, @format, @lisp
4903*8044SWilliam.Kucharski@Sun.COM%
4904*8044SWilliam.Kucharski@Sun.COM\def\smallword{small}
4905*8044SWilliam.Kucharski@Sun.COM\def\nosmallword{nosmall}
4906*8044SWilliam.Kucharski@Sun.COM\let\SETdispenvsize\relax
4907*8044SWilliam.Kucharski@Sun.COM\def\setnormaldispenv{%
4908*8044SWilliam.Kucharski@Sun.COM  \ifx\SETdispenvsize\smallword
4909*8044SWilliam.Kucharski@Sun.COM    \smallexamplefonts \rm
4910*8044SWilliam.Kucharski@Sun.COM  \fi
4911*8044SWilliam.Kucharski@Sun.COM}
4912*8044SWilliam.Kucharski@Sun.COM\def\setsmalldispenv{%
4913*8044SWilliam.Kucharski@Sun.COM  \ifx\SETdispenvsize\nosmallword
4914*8044SWilliam.Kucharski@Sun.COM  \else
4915*8044SWilliam.Kucharski@Sun.COM    \smallexamplefonts \rm
4916*8044SWilliam.Kucharski@Sun.COM  \fi
4917*8044SWilliam.Kucharski@Sun.COM}
4918*8044SWilliam.Kucharski@Sun.COM
4919*8044SWilliam.Kucharski@Sun.COM% We often define two environments, @foo and @smallfoo.
4920*8044SWilliam.Kucharski@Sun.COM% Let's do it by one command:
4921*8044SWilliam.Kucharski@Sun.COM\def\makedispenv #1#2{
4922*8044SWilliam.Kucharski@Sun.COM  \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
4923*8044SWilliam.Kucharski@Sun.COM  \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
4924*8044SWilliam.Kucharski@Sun.COM  \expandafter\let\csname E#1\endcsname \afterenvbreak
4925*8044SWilliam.Kucharski@Sun.COM  \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
4926*8044SWilliam.Kucharski@Sun.COM}
4927*8044SWilliam.Kucharski@Sun.COM
4928*8044SWilliam.Kucharski@Sun.COM% Define two synonyms:
4929*8044SWilliam.Kucharski@Sun.COM\def\maketwodispenvs #1#2#3{
4930*8044SWilliam.Kucharski@Sun.COM  \makedispenv{#1}{#3}
4931*8044SWilliam.Kucharski@Sun.COM  \makedispenv{#2}{#3}
4932*8044SWilliam.Kucharski@Sun.COM}
4933*8044SWilliam.Kucharski@Sun.COM
4934*8044SWilliam.Kucharski@Sun.COM% @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
4935*8044SWilliam.Kucharski@Sun.COM%
4936*8044SWilliam.Kucharski@Sun.COM% @smallexample and @smalllisp: use smaller fonts.
4937*8044SWilliam.Kucharski@Sun.COM% Originally contributed by Pavel@xerox.
4938*8044SWilliam.Kucharski@Sun.COM%
4939*8044SWilliam.Kucharski@Sun.COM\maketwodispenvs {lisp}{example}{%
4940*8044SWilliam.Kucharski@Sun.COM  \nonfillstart
4941*8044SWilliam.Kucharski@Sun.COM  \tt
4942*8044SWilliam.Kucharski@Sun.COM  \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4943*8044SWilliam.Kucharski@Sun.COM  \gobble       % eat return
4944*8044SWilliam.Kucharski@Sun.COM}
4945*8044SWilliam.Kucharski@Sun.COM
4946*8044SWilliam.Kucharski@Sun.COM% @display/@smalldisplay: same as @lisp except keep current font.
4947*8044SWilliam.Kucharski@Sun.COM%
4948*8044SWilliam.Kucharski@Sun.COM\makedispenv {display}{%
4949*8044SWilliam.Kucharski@Sun.COM  \nonfillstart
4950*8044SWilliam.Kucharski@Sun.COM  \gobble
4951*8044SWilliam.Kucharski@Sun.COM}
4952*8044SWilliam.Kucharski@Sun.COM
4953*8044SWilliam.Kucharski@Sun.COM% @format/@smallformat: same as @display except don't narrow margins.
4954*8044SWilliam.Kucharski@Sun.COM%
4955*8044SWilliam.Kucharski@Sun.COM\makedispenv{format}{%
4956*8044SWilliam.Kucharski@Sun.COM  \let\nonarrowing = t%
4957*8044SWilliam.Kucharski@Sun.COM  \nonfillstart
4958*8044SWilliam.Kucharski@Sun.COM  \gobble
4959*8044SWilliam.Kucharski@Sun.COM}
4960*8044SWilliam.Kucharski@Sun.COM
4961*8044SWilliam.Kucharski@Sun.COM% @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4962*8044SWilliam.Kucharski@Sun.COM\envdef\flushleft{%
4963*8044SWilliam.Kucharski@Sun.COM  \let\nonarrowing = t%
4964*8044SWilliam.Kucharski@Sun.COM  \nonfillstart
4965*8044SWilliam.Kucharski@Sun.COM  \gobble
4966*8044SWilliam.Kucharski@Sun.COM}
4967*8044SWilliam.Kucharski@Sun.COM\let\Eflushleft = \afterenvbreak
4968*8044SWilliam.Kucharski@Sun.COM
4969*8044SWilliam.Kucharski@Sun.COM% @flushright.
4970*8044SWilliam.Kucharski@Sun.COM%
4971*8044SWilliam.Kucharski@Sun.COM\envdef\flushright{%
4972*8044SWilliam.Kucharski@Sun.COM  \let\nonarrowing = t%
4973*8044SWilliam.Kucharski@Sun.COM  \nonfillstart
4974*8044SWilliam.Kucharski@Sun.COM  \advance\leftskip by 0pt plus 1fill
4975*8044SWilliam.Kucharski@Sun.COM  \gobble
4976*8044SWilliam.Kucharski@Sun.COM}
4977*8044SWilliam.Kucharski@Sun.COM\let\Eflushright = \afterenvbreak
4978*8044SWilliam.Kucharski@Sun.COM
4979*8044SWilliam.Kucharski@Sun.COM
4980*8044SWilliam.Kucharski@Sun.COM% @quotation does normal linebreaking (hence we can't use \nonfillstart)
4981*8044SWilliam.Kucharski@Sun.COM% and narrows the margins.  We keep \parskip nonzero in general, since
4982*8044SWilliam.Kucharski@Sun.COM% we're doing normal filling.  So, when using \aboveenvbreak and
4983*8044SWilliam.Kucharski@Sun.COM% \afterenvbreak, temporarily make \parskip 0.
4984*8044SWilliam.Kucharski@Sun.COM%
4985*8044SWilliam.Kucharski@Sun.COM\envdef\quotation{%
4986*8044SWilliam.Kucharski@Sun.COM  {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4987*8044SWilliam.Kucharski@Sun.COM  \parindent=0pt
4988*8044SWilliam.Kucharski@Sun.COM  %
4989*8044SWilliam.Kucharski@Sun.COM  % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4990*8044SWilliam.Kucharski@Sun.COM  \ifx\nonarrowing\relax
4991*8044SWilliam.Kucharski@Sun.COM    \advance\leftskip by \lispnarrowing
4992*8044SWilliam.Kucharski@Sun.COM    \advance\rightskip by \lispnarrowing
4993*8044SWilliam.Kucharski@Sun.COM    \exdentamount = \lispnarrowing
4994*8044SWilliam.Kucharski@Sun.COM    \let\nonarrowing = \relax
4995*8044SWilliam.Kucharski@Sun.COM  \fi
4996*8044SWilliam.Kucharski@Sun.COM  \parsearg\quotationlabel
4997*8044SWilliam.Kucharski@Sun.COM}
4998*8044SWilliam.Kucharski@Sun.COM
4999*8044SWilliam.Kucharski@Sun.COM% We have retained a nonzero parskip for the environment, since we're
5000*8044SWilliam.Kucharski@Sun.COM% doing normal filling.
5001*8044SWilliam.Kucharski@Sun.COM%
5002*8044SWilliam.Kucharski@Sun.COM\def\Equotation{%
5003*8044SWilliam.Kucharski@Sun.COM  \par
5004*8044SWilliam.Kucharski@Sun.COM  \ifx\quotationauthor\undefined\else
5005*8044SWilliam.Kucharski@Sun.COM    % indent a bit.
5006*8044SWilliam.Kucharski@Sun.COM    \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5007*8044SWilliam.Kucharski@Sun.COM  \fi
5008*8044SWilliam.Kucharski@Sun.COM  {\parskip=0pt \afterenvbreak}%
5009*8044SWilliam.Kucharski@Sun.COM}
5010*8044SWilliam.Kucharski@Sun.COM
5011*8044SWilliam.Kucharski@Sun.COM% If we're given an argument, typeset it in bold with a colon after.
5012*8044SWilliam.Kucharski@Sun.COM\def\quotationlabel#1{%
5013*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
5014*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\empty \else
5015*8044SWilliam.Kucharski@Sun.COM    {\bf #1: }%
5016*8044SWilliam.Kucharski@Sun.COM  \fi
5017*8044SWilliam.Kucharski@Sun.COM}
5018*8044SWilliam.Kucharski@Sun.COM
5019*8044SWilliam.Kucharski@Sun.COM
5020*8044SWilliam.Kucharski@Sun.COM% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5021*8044SWilliam.Kucharski@Sun.COM% If we want to allow any <char> as delimiter,
5022*8044SWilliam.Kucharski@Sun.COM% we need the curly braces so that makeinfo sees the @verb command, eg:
5023*8044SWilliam.Kucharski@Sun.COM% `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
5024*8044SWilliam.Kucharski@Sun.COM%
5025*8044SWilliam.Kucharski@Sun.COM% [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
5026*8044SWilliam.Kucharski@Sun.COM%
5027*8044SWilliam.Kucharski@Sun.COM% [Knuth] p.344; only we need to do the other characters Texinfo sets
5028*8044SWilliam.Kucharski@Sun.COM% active too.  Otherwise, they get lost as the first character on a
5029*8044SWilliam.Kucharski@Sun.COM% verbatim line.
5030*8044SWilliam.Kucharski@Sun.COM\def\dospecials{%
5031*8044SWilliam.Kucharski@Sun.COM  \do\ \do\\\do\{\do\}\do\$\do\&%
5032*8044SWilliam.Kucharski@Sun.COM  \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5033*8044SWilliam.Kucharski@Sun.COM  \do\<\do\>\do\|\do\@\do+\do\"%
5034*8044SWilliam.Kucharski@Sun.COM}
5035*8044SWilliam.Kucharski@Sun.COM%
5036*8044SWilliam.Kucharski@Sun.COM% [Knuth] p. 380
5037*8044SWilliam.Kucharski@Sun.COM\def\uncatcodespecials{%
5038*8044SWilliam.Kucharski@Sun.COM  \def\do##1{\catcode`##1=\other}\dospecials}
5039*8044SWilliam.Kucharski@Sun.COM%
5040*8044SWilliam.Kucharski@Sun.COM% [Knuth] pp. 380,381,391
5041*8044SWilliam.Kucharski@Sun.COM% Disable Spanish ligatures ?` and !` of \tt font
5042*8044SWilliam.Kucharski@Sun.COM\begingroup
5043*8044SWilliam.Kucharski@Sun.COM  \catcode`\`=\active\gdef`{\relax\lq}
5044*8044SWilliam.Kucharski@Sun.COM\endgroup
5045*8044SWilliam.Kucharski@Sun.COM%
5046*8044SWilliam.Kucharski@Sun.COM% Setup for the @verb command.
5047*8044SWilliam.Kucharski@Sun.COM%
5048*8044SWilliam.Kucharski@Sun.COM% Eight spaces for a tab
5049*8044SWilliam.Kucharski@Sun.COM\begingroup
5050*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^I=\active
5051*8044SWilliam.Kucharski@Sun.COM  \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5052*8044SWilliam.Kucharski@Sun.COM\endgroup
5053*8044SWilliam.Kucharski@Sun.COM%
5054*8044SWilliam.Kucharski@Sun.COM\def\setupverb{%
5055*8044SWilliam.Kucharski@Sun.COM  \tt  % easiest (and conventionally used) font for verbatim
5056*8044SWilliam.Kucharski@Sun.COM  \def\par{\leavevmode\endgraf}%
5057*8044SWilliam.Kucharski@Sun.COM  \catcode`\`=\active
5058*8044SWilliam.Kucharski@Sun.COM  \tabeightspaces
5059*8044SWilliam.Kucharski@Sun.COM  % Respect line breaks,
5060*8044SWilliam.Kucharski@Sun.COM  % print special symbols as themselves, and
5061*8044SWilliam.Kucharski@Sun.COM  % make each space count
5062*8044SWilliam.Kucharski@Sun.COM  % must do in this order:
5063*8044SWilliam.Kucharski@Sun.COM  \obeylines \uncatcodespecials \sepspaces
5064*8044SWilliam.Kucharski@Sun.COM}
5065*8044SWilliam.Kucharski@Sun.COM
5066*8044SWilliam.Kucharski@Sun.COM% Setup for the @verbatim environment
5067*8044SWilliam.Kucharski@Sun.COM%
5068*8044SWilliam.Kucharski@Sun.COM% Real tab expansion
5069*8044SWilliam.Kucharski@Sun.COM\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5070*8044SWilliam.Kucharski@Sun.COM%
5071*8044SWilliam.Kucharski@Sun.COM\def\starttabbox{\setbox0=\hbox\bgroup}
5072*8044SWilliam.Kucharski@Sun.COM\begingroup
5073*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^I=\active
5074*8044SWilliam.Kucharski@Sun.COM  \gdef\tabexpand{%
5075*8044SWilliam.Kucharski@Sun.COM    \catcode`\^^I=\active
5076*8044SWilliam.Kucharski@Sun.COM    \def^^I{\leavevmode\egroup
5077*8044SWilliam.Kucharski@Sun.COM      \dimen0=\wd0 % the width so far, or since the previous tab
5078*8044SWilliam.Kucharski@Sun.COM      \divide\dimen0 by\tabw
5079*8044SWilliam.Kucharski@Sun.COM      \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5080*8044SWilliam.Kucharski@Sun.COM      \advance\dimen0 by\tabw  % advance to next multiple of \tabw
5081*8044SWilliam.Kucharski@Sun.COM      \wd0=\dimen0 \box0 \starttabbox
5082*8044SWilliam.Kucharski@Sun.COM    }%
5083*8044SWilliam.Kucharski@Sun.COM  }
5084*8044SWilliam.Kucharski@Sun.COM\endgroup
5085*8044SWilliam.Kucharski@Sun.COM\def\setupverbatim{%
5086*8044SWilliam.Kucharski@Sun.COM  \nonfillstart
5087*8044SWilliam.Kucharski@Sun.COM  \advance\leftskip by -\defbodyindent
5088*8044SWilliam.Kucharski@Sun.COM  % Easiest (and conventionally used) font for verbatim
5089*8044SWilliam.Kucharski@Sun.COM  \tt
5090*8044SWilliam.Kucharski@Sun.COM  \def\par{\leavevmode\egroup\box0\endgraf}%
5091*8044SWilliam.Kucharski@Sun.COM  \catcode`\`=\active
5092*8044SWilliam.Kucharski@Sun.COM  \tabexpand
5093*8044SWilliam.Kucharski@Sun.COM  % Respect line breaks,
5094*8044SWilliam.Kucharski@Sun.COM  % print special symbols as themselves, and
5095*8044SWilliam.Kucharski@Sun.COM  % make each space count
5096*8044SWilliam.Kucharski@Sun.COM  % must do in this order:
5097*8044SWilliam.Kucharski@Sun.COM  \obeylines \uncatcodespecials \sepspaces
5098*8044SWilliam.Kucharski@Sun.COM  \everypar{\starttabbox}%
5099*8044SWilliam.Kucharski@Sun.COM}
5100*8044SWilliam.Kucharski@Sun.COM
5101*8044SWilliam.Kucharski@Sun.COM% Do the @verb magic: verbatim text is quoted by unique
5102*8044SWilliam.Kucharski@Sun.COM% delimiter characters.  Before first delimiter expect a
5103*8044SWilliam.Kucharski@Sun.COM% right brace, after last delimiter expect closing brace:
5104*8044SWilliam.Kucharski@Sun.COM%
5105*8044SWilliam.Kucharski@Sun.COM%    \def\doverb'{'<char>#1<char>'}'{#1}
5106*8044SWilliam.Kucharski@Sun.COM%
5107*8044SWilliam.Kucharski@Sun.COM% [Knuth] p. 382; only eat outer {}
5108*8044SWilliam.Kucharski@Sun.COM\begingroup
5109*8044SWilliam.Kucharski@Sun.COM  \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5110*8044SWilliam.Kucharski@Sun.COM  \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5111*8044SWilliam.Kucharski@Sun.COM\endgroup
5112*8044SWilliam.Kucharski@Sun.COM%
5113*8044SWilliam.Kucharski@Sun.COM\def\verb{\begingroup\setupverb\doverb}
5114*8044SWilliam.Kucharski@Sun.COM%
5115*8044SWilliam.Kucharski@Sun.COM%
5116*8044SWilliam.Kucharski@Sun.COM% Do the @verbatim magic: define the macro \doverbatim so that
5117*8044SWilliam.Kucharski@Sun.COM% the (first) argument ends when '@end verbatim' is reached, ie:
5118*8044SWilliam.Kucharski@Sun.COM%
5119*8044SWilliam.Kucharski@Sun.COM%     \def\doverbatim#1@end verbatim{#1}
5120*8044SWilliam.Kucharski@Sun.COM%
5121*8044SWilliam.Kucharski@Sun.COM% For Texinfo it's a lot easier than for LaTeX,
5122*8044SWilliam.Kucharski@Sun.COM% because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5123*8044SWilliam.Kucharski@Sun.COM% we need not redefine '\', '{' and '}'.
5124*8044SWilliam.Kucharski@Sun.COM%
5125*8044SWilliam.Kucharski@Sun.COM% Inspired by LaTeX's verbatim command set [latex.ltx]
5126*8044SWilliam.Kucharski@Sun.COM%
5127*8044SWilliam.Kucharski@Sun.COM\begingroup
5128*8044SWilliam.Kucharski@Sun.COM  \catcode`\ =\active
5129*8044SWilliam.Kucharski@Sun.COM  \obeylines %
5130*8044SWilliam.Kucharski@Sun.COM  % ignore everything up to the first ^^M, that's the newline at the end
5131*8044SWilliam.Kucharski@Sun.COM  % of the @verbatim input line itself.  Otherwise we get an extra blank
5132*8044SWilliam.Kucharski@Sun.COM  % line in the output.
5133*8044SWilliam.Kucharski@Sun.COM  \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5134*8044SWilliam.Kucharski@Sun.COM  % We really want {...\end verbatim} in the body of the macro, but
5135*8044SWilliam.Kucharski@Sun.COM  % without the active space; thus we have to use \xdef and \gobble.
5136*8044SWilliam.Kucharski@Sun.COM\endgroup
5137*8044SWilliam.Kucharski@Sun.COM%
5138*8044SWilliam.Kucharski@Sun.COM\envdef\verbatim{%
5139*8044SWilliam.Kucharski@Sun.COM    \setupverbatim\doverbatim
5140*8044SWilliam.Kucharski@Sun.COM}
5141*8044SWilliam.Kucharski@Sun.COM\let\Everbatim = \afterenvbreak
5142*8044SWilliam.Kucharski@Sun.COM
5143*8044SWilliam.Kucharski@Sun.COM
5144*8044SWilliam.Kucharski@Sun.COM% @verbatiminclude FILE - insert text of file in verbatim environment.
5145*8044SWilliam.Kucharski@Sun.COM%
5146*8044SWilliam.Kucharski@Sun.COM\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5147*8044SWilliam.Kucharski@Sun.COM%
5148*8044SWilliam.Kucharski@Sun.COM\def\doverbatiminclude#1{%
5149*8044SWilliam.Kucharski@Sun.COM  {%
5150*8044SWilliam.Kucharski@Sun.COM    \makevalueexpandable
5151*8044SWilliam.Kucharski@Sun.COM    \setupverbatim
5152*8044SWilliam.Kucharski@Sun.COM    \input #1
5153*8044SWilliam.Kucharski@Sun.COM    \afterenvbreak
5154*8044SWilliam.Kucharski@Sun.COM  }%
5155*8044SWilliam.Kucharski@Sun.COM}
5156*8044SWilliam.Kucharski@Sun.COM
5157*8044SWilliam.Kucharski@Sun.COM% @copying ... @end copying.
5158*8044SWilliam.Kucharski@Sun.COM% Save the text away for @insertcopying later.
5159*8044SWilliam.Kucharski@Sun.COM%
5160*8044SWilliam.Kucharski@Sun.COM% We save the uninterpreted tokens, rather than creating a box.
5161*8044SWilliam.Kucharski@Sun.COM% Saving the text in a box would be much easier, but then all the
5162*8044SWilliam.Kucharski@Sun.COM% typesetting commands (@smallbook, font changes, etc.) have to be done
5163*8044SWilliam.Kucharski@Sun.COM% beforehand -- and a) we want @copying to be done first in the source
5164*8044SWilliam.Kucharski@Sun.COM% file; b) letting users define the frontmatter in as flexible order as
5165*8044SWilliam.Kucharski@Sun.COM% possible is very desirable.
5166*8044SWilliam.Kucharski@Sun.COM%
5167*8044SWilliam.Kucharski@Sun.COM\def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5168*8044SWilliam.Kucharski@Sun.COM\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5169*8044SWilliam.Kucharski@Sun.COM%
5170*8044SWilliam.Kucharski@Sun.COM\def\insertcopying{%
5171*8044SWilliam.Kucharski@Sun.COM  \begingroup
5172*8044SWilliam.Kucharski@Sun.COM    \parindent = 0pt  % paragraph indentation looks wrong on title page
5173*8044SWilliam.Kucharski@Sun.COM    \scanexp\copyingtext
5174*8044SWilliam.Kucharski@Sun.COM  \endgroup
5175*8044SWilliam.Kucharski@Sun.COM}
5176*8044SWilliam.Kucharski@Sun.COM
5177*8044SWilliam.Kucharski@Sun.COM\message{defuns,}
5178*8044SWilliam.Kucharski@Sun.COM% @defun etc.
5179*8044SWilliam.Kucharski@Sun.COM
5180*8044SWilliam.Kucharski@Sun.COM\newskip\defbodyindent \defbodyindent=.4in
5181*8044SWilliam.Kucharski@Sun.COM\newskip\defargsindent \defargsindent=50pt
5182*8044SWilliam.Kucharski@Sun.COM\newskip\deflastargmargin \deflastargmargin=18pt
5183*8044SWilliam.Kucharski@Sun.COM
5184*8044SWilliam.Kucharski@Sun.COM% Start the processing of @deffn:
5185*8044SWilliam.Kucharski@Sun.COM\def\startdefun{%
5186*8044SWilliam.Kucharski@Sun.COM  \ifnum\lastpenalty<10000
5187*8044SWilliam.Kucharski@Sun.COM    \medbreak
5188*8044SWilliam.Kucharski@Sun.COM  \else
5189*8044SWilliam.Kucharski@Sun.COM    % If there are two @def commands in a row, we'll have a \nobreak,
5190*8044SWilliam.Kucharski@Sun.COM    % which is there to keep the function description together with its
5191*8044SWilliam.Kucharski@Sun.COM    % header.  But if there's nothing but headers, we need to allow a
5192*8044SWilliam.Kucharski@Sun.COM    % break somewhere.  Check specifically for penalty 10002, inserted
5193*8044SWilliam.Kucharski@Sun.COM    % by \defargscommonending, instead of 10000, since the sectioning
5194*8044SWilliam.Kucharski@Sun.COM    % commands also insert a nobreak penalty, and we don't want to allow
5195*8044SWilliam.Kucharski@Sun.COM    % a break between a section heading and a defun.
5196*8044SWilliam.Kucharski@Sun.COM    %
5197*8044SWilliam.Kucharski@Sun.COM    \ifnum\lastpenalty=10002 \penalty2000 \fi
5198*8044SWilliam.Kucharski@Sun.COM    %
5199*8044SWilliam.Kucharski@Sun.COM    % Similarly, after a section heading, do not allow a break.
5200*8044SWilliam.Kucharski@Sun.COM    % But do insert the glue.
5201*8044SWilliam.Kucharski@Sun.COM    \medskip  % preceded by discardable penalty, so not a breakpoint
5202*8044SWilliam.Kucharski@Sun.COM  \fi
5203*8044SWilliam.Kucharski@Sun.COM  %
5204*8044SWilliam.Kucharski@Sun.COM  \parindent=0in
5205*8044SWilliam.Kucharski@Sun.COM  \advance\leftskip by \defbodyindent
5206*8044SWilliam.Kucharski@Sun.COM  \exdentamount=\defbodyindent
5207*8044SWilliam.Kucharski@Sun.COM}
5208*8044SWilliam.Kucharski@Sun.COM
5209*8044SWilliam.Kucharski@Sun.COM\def\dodefunx#1{%
5210*8044SWilliam.Kucharski@Sun.COM  % First, check whether we are in the right environment:
5211*8044SWilliam.Kucharski@Sun.COM  \checkenv#1%
5212*8044SWilliam.Kucharski@Sun.COM  %
5213*8044SWilliam.Kucharski@Sun.COM  % As above, allow line break if we have multiple x headers in a row.
5214*8044SWilliam.Kucharski@Sun.COM  % It's not a great place, though.
5215*8044SWilliam.Kucharski@Sun.COM  \ifnum\lastpenalty=10002 \penalty3000 \fi
5216*8044SWilliam.Kucharski@Sun.COM  %
5217*8044SWilliam.Kucharski@Sun.COM  % And now, it's time to reuse the body of the original defun:
5218*8044SWilliam.Kucharski@Sun.COM  \expandafter\gobbledefun#1%
5219*8044SWilliam.Kucharski@Sun.COM}
5220*8044SWilliam.Kucharski@Sun.COM\def\gobbledefun#1\startdefun{}
5221*8044SWilliam.Kucharski@Sun.COM
5222*8044SWilliam.Kucharski@Sun.COM% \printdefunline \deffnheader{text}
5223*8044SWilliam.Kucharski@Sun.COM%
5224*8044SWilliam.Kucharski@Sun.COM\def\printdefunline#1#2{%
5225*8044SWilliam.Kucharski@Sun.COM  \begingroup
5226*8044SWilliam.Kucharski@Sun.COM    % call \deffnheader:
5227*8044SWilliam.Kucharski@Sun.COM    #1#2 \endheader
5228*8044SWilliam.Kucharski@Sun.COM    % common ending:
5229*8044SWilliam.Kucharski@Sun.COM    \interlinepenalty = 10000
5230*8044SWilliam.Kucharski@Sun.COM    \advance\rightskip by 0pt plus 1fil
5231*8044SWilliam.Kucharski@Sun.COM    \endgraf
5232*8044SWilliam.Kucharski@Sun.COM    \nobreak\vskip -\parskip
5233*8044SWilliam.Kucharski@Sun.COM    \penalty 10002  % signal to \startdefun and \dodefunx
5234*8044SWilliam.Kucharski@Sun.COM    % Some of the @defun-type tags do not enable magic parentheses,
5235*8044SWilliam.Kucharski@Sun.COM    % rendering the following check redundant.  But we don't optimize.
5236*8044SWilliam.Kucharski@Sun.COM    \checkparencounts
5237*8044SWilliam.Kucharski@Sun.COM  \endgroup
5238*8044SWilliam.Kucharski@Sun.COM}
5239*8044SWilliam.Kucharski@Sun.COM
5240*8044SWilliam.Kucharski@Sun.COM\def\Edefun{\endgraf\medbreak}
5241*8044SWilliam.Kucharski@Sun.COM
5242*8044SWilliam.Kucharski@Sun.COM% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5243*8044SWilliam.Kucharski@Sun.COM% the only thing remainnig is to define \deffnheader.
5244*8044SWilliam.Kucharski@Sun.COM%
5245*8044SWilliam.Kucharski@Sun.COM\def\makedefun#1{%
5246*8044SWilliam.Kucharski@Sun.COM  \expandafter\let\csname E#1\endcsname = \Edefun
5247*8044SWilliam.Kucharski@Sun.COM  \edef\temp{\noexpand\domakedefun
5248*8044SWilliam.Kucharski@Sun.COM    \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5249*8044SWilliam.Kucharski@Sun.COM  \temp
5250*8044SWilliam.Kucharski@Sun.COM}
5251*8044SWilliam.Kucharski@Sun.COM
5252*8044SWilliam.Kucharski@Sun.COM% \domakedefun \deffn \deffnx \deffnheader
5253*8044SWilliam.Kucharski@Sun.COM%
5254*8044SWilliam.Kucharski@Sun.COM% Define \deffn and \deffnx, without parameters.
5255*8044SWilliam.Kucharski@Sun.COM% \deffnheader has to be defined explicitly.
5256*8044SWilliam.Kucharski@Sun.COM%
5257*8044SWilliam.Kucharski@Sun.COM\def\domakedefun#1#2#3{%
5258*8044SWilliam.Kucharski@Sun.COM  \envdef#1{%
5259*8044SWilliam.Kucharski@Sun.COM    \startdefun
5260*8044SWilliam.Kucharski@Sun.COM    \parseargusing\activeparens{\printdefunline#3}%
5261*8044SWilliam.Kucharski@Sun.COM  }%
5262*8044SWilliam.Kucharski@Sun.COM  \def#2{\dodefunx#1}%
5263*8044SWilliam.Kucharski@Sun.COM  \def#3%
5264*8044SWilliam.Kucharski@Sun.COM}
5265*8044SWilliam.Kucharski@Sun.COM
5266*8044SWilliam.Kucharski@Sun.COM%%% Untyped functions:
5267*8044SWilliam.Kucharski@Sun.COM
5268*8044SWilliam.Kucharski@Sun.COM% @deffn category name args
5269*8044SWilliam.Kucharski@Sun.COM\makedefun{deffn}{\deffngeneral{}}
5270*8044SWilliam.Kucharski@Sun.COM
5271*8044SWilliam.Kucharski@Sun.COM% @deffn category class name args
5272*8044SWilliam.Kucharski@Sun.COM\makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5273*8044SWilliam.Kucharski@Sun.COM
5274*8044SWilliam.Kucharski@Sun.COM% \defopon {category on}class name args
5275*8044SWilliam.Kucharski@Sun.COM\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5276*8044SWilliam.Kucharski@Sun.COM
5277*8044SWilliam.Kucharski@Sun.COM% \deffngeneral {subind}category name args
5278*8044SWilliam.Kucharski@Sun.COM%
5279*8044SWilliam.Kucharski@Sun.COM\def\deffngeneral#1#2 #3 #4\endheader{%
5280*8044SWilliam.Kucharski@Sun.COM  % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5281*8044SWilliam.Kucharski@Sun.COM  \dosubind{fn}{\code{#3}}{#1}%
5282*8044SWilliam.Kucharski@Sun.COM  \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5283*8044SWilliam.Kucharski@Sun.COM}
5284*8044SWilliam.Kucharski@Sun.COM
5285*8044SWilliam.Kucharski@Sun.COM%%% Typed functions:
5286*8044SWilliam.Kucharski@Sun.COM
5287*8044SWilliam.Kucharski@Sun.COM% @deftypefn category type name args
5288*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypefn}{\deftypefngeneral{}}
5289*8044SWilliam.Kucharski@Sun.COM
5290*8044SWilliam.Kucharski@Sun.COM% @deftypeop category class type name args
5291*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5292*8044SWilliam.Kucharski@Sun.COM
5293*8044SWilliam.Kucharski@Sun.COM% \deftypeopon {category on}class type name args
5294*8044SWilliam.Kucharski@Sun.COM\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5295*8044SWilliam.Kucharski@Sun.COM
5296*8044SWilliam.Kucharski@Sun.COM% \deftypefngeneral {subind}category type name args
5297*8044SWilliam.Kucharski@Sun.COM%
5298*8044SWilliam.Kucharski@Sun.COM\def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5299*8044SWilliam.Kucharski@Sun.COM  \dosubind{fn}{\code{#4}}{#1}%
5300*8044SWilliam.Kucharski@Sun.COM  \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5301*8044SWilliam.Kucharski@Sun.COM}
5302*8044SWilliam.Kucharski@Sun.COM
5303*8044SWilliam.Kucharski@Sun.COM%%% Typed variables:
5304*8044SWilliam.Kucharski@Sun.COM
5305*8044SWilliam.Kucharski@Sun.COM% @deftypevr category type var args
5306*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypevr}{\deftypecvgeneral{}}
5307*8044SWilliam.Kucharski@Sun.COM
5308*8044SWilliam.Kucharski@Sun.COM% @deftypecv category class type var args
5309*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5310*8044SWilliam.Kucharski@Sun.COM
5311*8044SWilliam.Kucharski@Sun.COM% \deftypecvof {category of}class type var args
5312*8044SWilliam.Kucharski@Sun.COM\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5313*8044SWilliam.Kucharski@Sun.COM
5314*8044SWilliam.Kucharski@Sun.COM% \deftypecvgeneral {subind}category type var args
5315*8044SWilliam.Kucharski@Sun.COM%
5316*8044SWilliam.Kucharski@Sun.COM\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5317*8044SWilliam.Kucharski@Sun.COM  \dosubind{vr}{\code{#4}}{#1}%
5318*8044SWilliam.Kucharski@Sun.COM  \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5319*8044SWilliam.Kucharski@Sun.COM}
5320*8044SWilliam.Kucharski@Sun.COM
5321*8044SWilliam.Kucharski@Sun.COM%%% Untyped variables:
5322*8044SWilliam.Kucharski@Sun.COM
5323*8044SWilliam.Kucharski@Sun.COM% @defvr category var args
5324*8044SWilliam.Kucharski@Sun.COM\makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5325*8044SWilliam.Kucharski@Sun.COM
5326*8044SWilliam.Kucharski@Sun.COM% @defcv category class var args
5327*8044SWilliam.Kucharski@Sun.COM\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5328*8044SWilliam.Kucharski@Sun.COM
5329*8044SWilliam.Kucharski@Sun.COM% \defcvof {category of}class var args
5330*8044SWilliam.Kucharski@Sun.COM\def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5331*8044SWilliam.Kucharski@Sun.COM
5332*8044SWilliam.Kucharski@Sun.COM%%% Type:
5333*8044SWilliam.Kucharski@Sun.COM% @deftp category name args
5334*8044SWilliam.Kucharski@Sun.COM\makedefun{deftp}#1 #2 #3\endheader{%
5335*8044SWilliam.Kucharski@Sun.COM  \doind{tp}{\code{#2}}%
5336*8044SWilliam.Kucharski@Sun.COM  \defname{#1}{}{#2}\defunargs{#3\unskip}%
5337*8044SWilliam.Kucharski@Sun.COM}
5338*8044SWilliam.Kucharski@Sun.COM
5339*8044SWilliam.Kucharski@Sun.COM% Remaining @defun-like shortcuts:
5340*8044SWilliam.Kucharski@Sun.COM\makedefun{defun}{\deffnheader{\putwordDeffunc} }
5341*8044SWilliam.Kucharski@Sun.COM\makedefun{defmac}{\deffnheader{\putwordDefmac} }
5342*8044SWilliam.Kucharski@Sun.COM\makedefun{defspec}{\deffnheader{\putwordDefspec} }
5343*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5344*8044SWilliam.Kucharski@Sun.COM\makedefun{defvar}{\defvrheader{\putwordDefvar} }
5345*8044SWilliam.Kucharski@Sun.COM\makedefun{defopt}{\defvrheader{\putwordDefopt} }
5346*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5347*8044SWilliam.Kucharski@Sun.COM\makedefun{defmethod}{\defopon\putwordMethodon}
5348*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5349*8044SWilliam.Kucharski@Sun.COM\makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5350*8044SWilliam.Kucharski@Sun.COM\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5351*8044SWilliam.Kucharski@Sun.COM
5352*8044SWilliam.Kucharski@Sun.COM% \defname, which formats the name of the @def (not the args).
5353*8044SWilliam.Kucharski@Sun.COM% #1 is the category, such as "Function".
5354*8044SWilliam.Kucharski@Sun.COM% #2 is the return type, if any.
5355*8044SWilliam.Kucharski@Sun.COM% #3 is the function name.
5356*8044SWilliam.Kucharski@Sun.COM%
5357*8044SWilliam.Kucharski@Sun.COM% We are followed by (but not passed) the arguments, if any.
5358*8044SWilliam.Kucharski@Sun.COM%
5359*8044SWilliam.Kucharski@Sun.COM\def\defname#1#2#3{%
5360*8044SWilliam.Kucharski@Sun.COM  % Get the values of \leftskip and \rightskip as they were outside the @def...
5361*8044SWilliam.Kucharski@Sun.COM  \advance\leftskip by -\defbodyindent
5362*8044SWilliam.Kucharski@Sun.COM  %
5363*8044SWilliam.Kucharski@Sun.COM  % How we'll format the type name.  Putting it in brackets helps
5364*8044SWilliam.Kucharski@Sun.COM  % distinguish it from the body text that may end up on the next line
5365*8044SWilliam.Kucharski@Sun.COM  % just below it.
5366*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
5367*8044SWilliam.Kucharski@Sun.COM  \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5368*8044SWilliam.Kucharski@Sun.COM  %
5369*8044SWilliam.Kucharski@Sun.COM  % Figure out line sizes for the paragraph shape.
5370*8044SWilliam.Kucharski@Sun.COM  % The first line needs space for \box0; but if \rightskip is nonzero,
5371*8044SWilliam.Kucharski@Sun.COM  % we need only space for the part of \box0 which exceeds it:
5372*8044SWilliam.Kucharski@Sun.COM  \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
5373*8044SWilliam.Kucharski@Sun.COM  % The continuations:
5374*8044SWilliam.Kucharski@Sun.COM  \dimen2=\hsize  \advance\dimen2 by -\defargsindent
5375*8044SWilliam.Kucharski@Sun.COM  % (plain.tex says that \dimen1 should be used only as global.)
5376*8044SWilliam.Kucharski@Sun.COM  \parshape 2 0in \dimen0 \defargsindent \dimen2
5377*8044SWilliam.Kucharski@Sun.COM  %
5378*8044SWilliam.Kucharski@Sun.COM  % Put the type name to the right margin.
5379*8044SWilliam.Kucharski@Sun.COM  \noindent
5380*8044SWilliam.Kucharski@Sun.COM  \hbox to 0pt{%
5381*8044SWilliam.Kucharski@Sun.COM    \hfil\box0 \kern-\hsize
5382*8044SWilliam.Kucharski@Sun.COM    % \hsize has to be shortened this way:
5383*8044SWilliam.Kucharski@Sun.COM    \kern\leftskip
5384*8044SWilliam.Kucharski@Sun.COM    % Intentionally do not respect \rightskip, since we need the space.
5385*8044SWilliam.Kucharski@Sun.COM  }%
5386*8044SWilliam.Kucharski@Sun.COM  %
5387*8044SWilliam.Kucharski@Sun.COM  % Allow all lines to be underfull without complaint:
5388*8044SWilliam.Kucharski@Sun.COM  \tolerance=10000 \hbadness=10000
5389*8044SWilliam.Kucharski@Sun.COM  \exdentamount=\defbodyindent
5390*8044SWilliam.Kucharski@Sun.COM  {%
5391*8044SWilliam.Kucharski@Sun.COM    % defun fonts. We use typewriter by default (used to be bold) because:
5392*8044SWilliam.Kucharski@Sun.COM    % . we're printing identifiers, they should be in tt in principle.
5393*8044SWilliam.Kucharski@Sun.COM    % . in languages with many accents, such as Czech or French, it's
5394*8044SWilliam.Kucharski@Sun.COM    %   common to leave accents off identifiers.  The result looks ok in
5395*8044SWilliam.Kucharski@Sun.COM    %   tt, but exceedingly strange in rm.
5396*8044SWilliam.Kucharski@Sun.COM    % . we don't want -- and --- to be treated as ligatures.
5397*8044SWilliam.Kucharski@Sun.COM    % . this still does not fix the ?` and !` ligatures, but so far no
5398*8044SWilliam.Kucharski@Sun.COM    %   one has made identifiers using them :).
5399*8044SWilliam.Kucharski@Sun.COM    \df \tt
5400*8044SWilliam.Kucharski@Sun.COM    \def\temp{#2}% return value type
5401*8044SWilliam.Kucharski@Sun.COM    \ifx\temp\empty\else \tclose{\temp} \fi
5402*8044SWilliam.Kucharski@Sun.COM    #3% output function name
5403*8044SWilliam.Kucharski@Sun.COM  }%
5404*8044SWilliam.Kucharski@Sun.COM  {\rm\enskip}% hskip 0.5 em of \tenrm
5405*8044SWilliam.Kucharski@Sun.COM  %
5406*8044SWilliam.Kucharski@Sun.COM  \boldbrax
5407*8044SWilliam.Kucharski@Sun.COM  % arguments will be output next, if any.
5408*8044SWilliam.Kucharski@Sun.COM}
5409*8044SWilliam.Kucharski@Sun.COM
5410*8044SWilliam.Kucharski@Sun.COM% Print arguments in slanted roman (not ttsl), inconsistently with using
5411*8044SWilliam.Kucharski@Sun.COM% tt for the name.  This is because literal text is sometimes needed in
5412*8044SWilliam.Kucharski@Sun.COM% the argument list (groff manual), and ttsl and tt are not very
5413*8044SWilliam.Kucharski@Sun.COM% distinguishable.  Prevent hyphenation at `-' chars.
5414*8044SWilliam.Kucharski@Sun.COM%
5415*8044SWilliam.Kucharski@Sun.COM\def\defunargs#1{%
5416*8044SWilliam.Kucharski@Sun.COM  % use sl by default (not ttsl),
5417*8044SWilliam.Kucharski@Sun.COM  % tt for the names.
5418*8044SWilliam.Kucharski@Sun.COM  \df \sl \hyphenchar\font=0
5419*8044SWilliam.Kucharski@Sun.COM  %
5420*8044SWilliam.Kucharski@Sun.COM  % On the other hand, if an argument has two dashes (for instance), we
5421*8044SWilliam.Kucharski@Sun.COM  % want a way to get ttsl.  Let's try @var for that.
5422*8044SWilliam.Kucharski@Sun.COM  \let\var=\ttslanted
5423*8044SWilliam.Kucharski@Sun.COM  #1%
5424*8044SWilliam.Kucharski@Sun.COM  \sl\hyphenchar\font=45
5425*8044SWilliam.Kucharski@Sun.COM}
5426*8044SWilliam.Kucharski@Sun.COM
5427*8044SWilliam.Kucharski@Sun.COM% We want ()&[] to print specially on the defun line.
5428*8044SWilliam.Kucharski@Sun.COM%
5429*8044SWilliam.Kucharski@Sun.COM\def\activeparens{%
5430*8044SWilliam.Kucharski@Sun.COM  \catcode`\(=\active \catcode`\)=\active
5431*8044SWilliam.Kucharski@Sun.COM  \catcode`\[=\active \catcode`\]=\active
5432*8044SWilliam.Kucharski@Sun.COM  \catcode`\&=\active
5433*8044SWilliam.Kucharski@Sun.COM}
5434*8044SWilliam.Kucharski@Sun.COM
5435*8044SWilliam.Kucharski@Sun.COM% Make control sequences which act like normal parenthesis chars.
5436*8044SWilliam.Kucharski@Sun.COM\let\lparen = ( \let\rparen = )
5437*8044SWilliam.Kucharski@Sun.COM
5438*8044SWilliam.Kucharski@Sun.COM% Be sure that we always have a definition for `(', etc.  For example,
5439*8044SWilliam.Kucharski@Sun.COM% if the fn name has parens in it, \boldbrax will not be in effect yet,
5440*8044SWilliam.Kucharski@Sun.COM% so TeX would otherwise complain about undefined control sequence.
5441*8044SWilliam.Kucharski@Sun.COM{
5442*8044SWilliam.Kucharski@Sun.COM  \activeparens
5443*8044SWilliam.Kucharski@Sun.COM  \global\let(=\lparen \global\let)=\rparen
5444*8044SWilliam.Kucharski@Sun.COM  \global\let[=\lbrack \global\let]=\rbrack
5445*8044SWilliam.Kucharski@Sun.COM  \global\let& = \&
5446*8044SWilliam.Kucharski@Sun.COM
5447*8044SWilliam.Kucharski@Sun.COM  \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5448*8044SWilliam.Kucharski@Sun.COM  \gdef\magicamp{\let&=\amprm}
5449*8044SWilliam.Kucharski@Sun.COM}
5450*8044SWilliam.Kucharski@Sun.COM
5451*8044SWilliam.Kucharski@Sun.COM\newcount\parencount
5452*8044SWilliam.Kucharski@Sun.COM
5453*8044SWilliam.Kucharski@Sun.COM% If we encounter &foo, then turn on ()-hacking afterwards
5454*8044SWilliam.Kucharski@Sun.COM\newif\ifampseen
5455*8044SWilliam.Kucharski@Sun.COM\def\amprm#1 {\ampseentrue{\bf\&#1 }}
5456*8044SWilliam.Kucharski@Sun.COM
5457*8044SWilliam.Kucharski@Sun.COM\def\parenfont{%
5458*8044SWilliam.Kucharski@Sun.COM  \ifampseen
5459*8044SWilliam.Kucharski@Sun.COM    % At the first level, print parens in roman,
5460*8044SWilliam.Kucharski@Sun.COM    % otherwise use the default font.
5461*8044SWilliam.Kucharski@Sun.COM    \ifnum \parencount=1 \rm \fi
5462*8044SWilliam.Kucharski@Sun.COM  \else
5463*8044SWilliam.Kucharski@Sun.COM    % The \sf parens (in \boldbrax) actually are a little bolder than
5464*8044SWilliam.Kucharski@Sun.COM    % the contained text.  This is especially needed for [ and ] .
5465*8044SWilliam.Kucharski@Sun.COM    \sf
5466*8044SWilliam.Kucharski@Sun.COM  \fi
5467*8044SWilliam.Kucharski@Sun.COM}
5468*8044SWilliam.Kucharski@Sun.COM\def\infirstlevel#1{%
5469*8044SWilliam.Kucharski@Sun.COM  \ifampseen
5470*8044SWilliam.Kucharski@Sun.COM    \ifnum\parencount=1
5471*8044SWilliam.Kucharski@Sun.COM      #1%
5472*8044SWilliam.Kucharski@Sun.COM    \fi
5473*8044SWilliam.Kucharski@Sun.COM  \fi
5474*8044SWilliam.Kucharski@Sun.COM}
5475*8044SWilliam.Kucharski@Sun.COM\def\bfafterword#1 {#1 \bf}
5476*8044SWilliam.Kucharski@Sun.COM
5477*8044SWilliam.Kucharski@Sun.COM\def\opnr{%
5478*8044SWilliam.Kucharski@Sun.COM  \global\advance\parencount by 1
5479*8044SWilliam.Kucharski@Sun.COM  {\parenfont(}%
5480*8044SWilliam.Kucharski@Sun.COM  \infirstlevel \bfafterword
5481*8044SWilliam.Kucharski@Sun.COM}
5482*8044SWilliam.Kucharski@Sun.COM\def\clnr{%
5483*8044SWilliam.Kucharski@Sun.COM  {\parenfont)}%
5484*8044SWilliam.Kucharski@Sun.COM  \infirstlevel \sl
5485*8044SWilliam.Kucharski@Sun.COM  \global\advance\parencount by -1
5486*8044SWilliam.Kucharski@Sun.COM}
5487*8044SWilliam.Kucharski@Sun.COM
5488*8044SWilliam.Kucharski@Sun.COM\newcount\brackcount
5489*8044SWilliam.Kucharski@Sun.COM\def\lbrb{%
5490*8044SWilliam.Kucharski@Sun.COM  \global\advance\brackcount by 1
5491*8044SWilliam.Kucharski@Sun.COM  {\bf[}%
5492*8044SWilliam.Kucharski@Sun.COM}
5493*8044SWilliam.Kucharski@Sun.COM\def\rbrb{%
5494*8044SWilliam.Kucharski@Sun.COM  {\bf]}%
5495*8044SWilliam.Kucharski@Sun.COM  \global\advance\brackcount by -1
5496*8044SWilliam.Kucharski@Sun.COM}
5497*8044SWilliam.Kucharski@Sun.COM
5498*8044SWilliam.Kucharski@Sun.COM\def\checkparencounts{%
5499*8044SWilliam.Kucharski@Sun.COM  \ifnum\parencount=0 \else \badparencount \fi
5500*8044SWilliam.Kucharski@Sun.COM  \ifnum\brackcount=0 \else \badbrackcount \fi
5501*8044SWilliam.Kucharski@Sun.COM}
5502*8044SWilliam.Kucharski@Sun.COM\def\badparencount{%
5503*8044SWilliam.Kucharski@Sun.COM  \errmessage{Unbalanced parentheses in @def}%
5504*8044SWilliam.Kucharski@Sun.COM  \global\parencount=0
5505*8044SWilliam.Kucharski@Sun.COM}
5506*8044SWilliam.Kucharski@Sun.COM\def\badbrackcount{%
5507*8044SWilliam.Kucharski@Sun.COM  \errmessage{Unbalanced square braces in @def}%
5508*8044SWilliam.Kucharski@Sun.COM  \global\brackcount=0
5509*8044SWilliam.Kucharski@Sun.COM}
5510*8044SWilliam.Kucharski@Sun.COM
5511*8044SWilliam.Kucharski@Sun.COM
5512*8044SWilliam.Kucharski@Sun.COM\message{macros,}
5513*8044SWilliam.Kucharski@Sun.COM% @macro.
5514*8044SWilliam.Kucharski@Sun.COM
5515*8044SWilliam.Kucharski@Sun.COM% To do this right we need a feature of e-TeX, \scantokens,
5516*8044SWilliam.Kucharski@Sun.COM% which we arrange to emulate with a temporary file in ordinary TeX.
5517*8044SWilliam.Kucharski@Sun.COM\ifx\eTeXversion\undefined
5518*8044SWilliam.Kucharski@Sun.COM  \newwrite\macscribble
5519*8044SWilliam.Kucharski@Sun.COM  \def\scantokens#1{%
5520*8044SWilliam.Kucharski@Sun.COM    \toks0={#1}%
5521*8044SWilliam.Kucharski@Sun.COM    \immediate\openout\macscribble=\jobname.tmp
5522*8044SWilliam.Kucharski@Sun.COM    \immediate\write\macscribble{\the\toks0}%
5523*8044SWilliam.Kucharski@Sun.COM    \immediate\closeout\macscribble
5524*8044SWilliam.Kucharski@Sun.COM    \input \jobname.tmp
5525*8044SWilliam.Kucharski@Sun.COM  }
5526*8044SWilliam.Kucharski@Sun.COM\fi
5527*8044SWilliam.Kucharski@Sun.COM
5528*8044SWilliam.Kucharski@Sun.COM\def\scanmacro#1{%
5529*8044SWilliam.Kucharski@Sun.COM  \begingroup
5530*8044SWilliam.Kucharski@Sun.COM    \newlinechar`\^^M
5531*8044SWilliam.Kucharski@Sun.COM    \let\xeatspaces\eatspaces
5532*8044SWilliam.Kucharski@Sun.COM    % Undo catcode changes of \startcontents and \doprintindex
5533*8044SWilliam.Kucharski@Sun.COM    % When called from @insertcopying or (short)caption, we need active
5534*8044SWilliam.Kucharski@Sun.COM    % backslash to get it printed correctly.  Previously, we had
5535*8044SWilliam.Kucharski@Sun.COM    % \catcode`\\=\other instead.  We'll see whether a problem appears
5536*8044SWilliam.Kucharski@Sun.COM    % with macro expansion.				--kasal, 19aug04
5537*8044SWilliam.Kucharski@Sun.COM    \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5538*8044SWilliam.Kucharski@Sun.COM    % ... and \example
5539*8044SWilliam.Kucharski@Sun.COM    \spaceisspace
5540*8044SWilliam.Kucharski@Sun.COM    %
5541*8044SWilliam.Kucharski@Sun.COM    % Append \endinput to make sure that TeX does not see the ending newline.
5542*8044SWilliam.Kucharski@Sun.COM    %
5543*8044SWilliam.Kucharski@Sun.COM    % I've verified that it is necessary both for e-TeX and for ordinary TeX
5544*8044SWilliam.Kucharski@Sun.COM    %							--kasal, 29nov03
5545*8044SWilliam.Kucharski@Sun.COM    \scantokens{#1\endinput}%
5546*8044SWilliam.Kucharski@Sun.COM  \endgroup
5547*8044SWilliam.Kucharski@Sun.COM}
5548*8044SWilliam.Kucharski@Sun.COM
5549*8044SWilliam.Kucharski@Sun.COM\def\scanexp#1{%
5550*8044SWilliam.Kucharski@Sun.COM  \edef\temp{\noexpand\scanmacro{#1}}%
5551*8044SWilliam.Kucharski@Sun.COM  \temp
5552*8044SWilliam.Kucharski@Sun.COM}
5553*8044SWilliam.Kucharski@Sun.COM
5554*8044SWilliam.Kucharski@Sun.COM\newcount\paramno   % Count of parameters
5555*8044SWilliam.Kucharski@Sun.COM\newtoks\macname    % Macro name
5556*8044SWilliam.Kucharski@Sun.COM\newif\ifrecursive  % Is it recursive?
5557*8044SWilliam.Kucharski@Sun.COM\def\macrolist{}    % List of all defined macros in the form
5558*8044SWilliam.Kucharski@Sun.COM                    % \do\macro1\do\macro2...
5559*8044SWilliam.Kucharski@Sun.COM
5560*8044SWilliam.Kucharski@Sun.COM% Utility routines.
5561*8044SWilliam.Kucharski@Sun.COM% This does \let #1 = #2, with \csnames; that is,
5562*8044SWilliam.Kucharski@Sun.COM%   \let \csname#1\endcsname = \csname#2\endcsname
5563*8044SWilliam.Kucharski@Sun.COM% (except of course we have to play expansion games).
5564*8044SWilliam.Kucharski@Sun.COM%
5565*8044SWilliam.Kucharski@Sun.COM\def\cslet#1#2{%
5566*8044SWilliam.Kucharski@Sun.COM  \expandafter\let
5567*8044SWilliam.Kucharski@Sun.COM  \csname#1\expandafter\endcsname
5568*8044SWilliam.Kucharski@Sun.COM  \csname#2\endcsname
5569*8044SWilliam.Kucharski@Sun.COM}
5570*8044SWilliam.Kucharski@Sun.COM
5571*8044SWilliam.Kucharski@Sun.COM% Trim leading and trailing spaces off a string.
5572*8044SWilliam.Kucharski@Sun.COM% Concepts from aro-bend problem 15 (see CTAN).
5573*8044SWilliam.Kucharski@Sun.COM{\catcode`\@=11
5574*8044SWilliam.Kucharski@Sun.COM\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5575*8044SWilliam.Kucharski@Sun.COM\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5576*8044SWilliam.Kucharski@Sun.COM\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5577*8044SWilliam.Kucharski@Sun.COM\def\unbrace#1{#1}
5578*8044SWilliam.Kucharski@Sun.COM\unbrace{\gdef\trim@@@ #1 } #2@{#1}
5579*8044SWilliam.Kucharski@Sun.COM}
5580*8044SWilliam.Kucharski@Sun.COM
5581*8044SWilliam.Kucharski@Sun.COM% Trim a single trailing ^^M off a string.
5582*8044SWilliam.Kucharski@Sun.COM{\catcode`\^^M=\other \catcode`\Q=3%
5583*8044SWilliam.Kucharski@Sun.COM\gdef\eatcr #1{\eatcra #1Q^^MQ}%
5584*8044SWilliam.Kucharski@Sun.COM\gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5585*8044SWilliam.Kucharski@Sun.COM\gdef\eatcrb#1Q#2Q{#1}%
5586*8044SWilliam.Kucharski@Sun.COM}
5587*8044SWilliam.Kucharski@Sun.COM
5588*8044SWilliam.Kucharski@Sun.COM% Macro bodies are absorbed as an argument in a context where
5589*8044SWilliam.Kucharski@Sun.COM% all characters are catcode 10, 11 or 12, except \ which is active
5590*8044SWilliam.Kucharski@Sun.COM% (as in normal texinfo). It is necessary to change the definition of \.
5591*8044SWilliam.Kucharski@Sun.COM
5592*8044SWilliam.Kucharski@Sun.COM% It's necessary to have hard CRs when the macro is executed. This is
5593*8044SWilliam.Kucharski@Sun.COM% done by  making ^^M (\endlinechar) catcode 12 when reading the macro
5594*8044SWilliam.Kucharski@Sun.COM% body, and then making it the \newlinechar in \scanmacro.
5595*8044SWilliam.Kucharski@Sun.COM
5596*8044SWilliam.Kucharski@Sun.COM\def\scanctxt{%
5597*8044SWilliam.Kucharski@Sun.COM  \catcode`\"=\other
5598*8044SWilliam.Kucharski@Sun.COM  \catcode`\+=\other
5599*8044SWilliam.Kucharski@Sun.COM  \catcode`\<=\other
5600*8044SWilliam.Kucharski@Sun.COM  \catcode`\>=\other
5601*8044SWilliam.Kucharski@Sun.COM  \catcode`\@=\other
5602*8044SWilliam.Kucharski@Sun.COM  \catcode`\^=\other
5603*8044SWilliam.Kucharski@Sun.COM  \catcode`\_=\other
5604*8044SWilliam.Kucharski@Sun.COM  \catcode`\|=\other
5605*8044SWilliam.Kucharski@Sun.COM  \catcode`\~=\other
5606*8044SWilliam.Kucharski@Sun.COM}
5607*8044SWilliam.Kucharski@Sun.COM
5608*8044SWilliam.Kucharski@Sun.COM\def\scanargctxt{%
5609*8044SWilliam.Kucharski@Sun.COM  \scanctxt
5610*8044SWilliam.Kucharski@Sun.COM  \catcode`\\=\other
5611*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^M=\other
5612*8044SWilliam.Kucharski@Sun.COM}
5613*8044SWilliam.Kucharski@Sun.COM
5614*8044SWilliam.Kucharski@Sun.COM\def\macrobodyctxt{%
5615*8044SWilliam.Kucharski@Sun.COM  \scanctxt
5616*8044SWilliam.Kucharski@Sun.COM  \catcode`\{=\other
5617*8044SWilliam.Kucharski@Sun.COM  \catcode`\}=\other
5618*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^M=\other
5619*8044SWilliam.Kucharski@Sun.COM  \usembodybackslash
5620*8044SWilliam.Kucharski@Sun.COM}
5621*8044SWilliam.Kucharski@Sun.COM
5622*8044SWilliam.Kucharski@Sun.COM\def\macroargctxt{%
5623*8044SWilliam.Kucharski@Sun.COM  \scanctxt
5624*8044SWilliam.Kucharski@Sun.COM  \catcode`\\=\other
5625*8044SWilliam.Kucharski@Sun.COM}
5626*8044SWilliam.Kucharski@Sun.COM
5627*8044SWilliam.Kucharski@Sun.COM% \mbodybackslash is the definition of \ in @macro bodies.
5628*8044SWilliam.Kucharski@Sun.COM% It maps \foo\ => \csname macarg.foo\endcsname => #N
5629*8044SWilliam.Kucharski@Sun.COM% where N is the macro parameter number.
5630*8044SWilliam.Kucharski@Sun.COM% We define \csname macarg.\endcsname to be \realbackslash, so
5631*8044SWilliam.Kucharski@Sun.COM% \\ in macro replacement text gets you a backslash.
5632*8044SWilliam.Kucharski@Sun.COM
5633*8044SWilliam.Kucharski@Sun.COM{\catcode`@=0 @catcode`@\=@active
5634*8044SWilliam.Kucharski@Sun.COM @gdef@usembodybackslash{@let\=@mbodybackslash}
5635*8044SWilliam.Kucharski@Sun.COM @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5636*8044SWilliam.Kucharski@Sun.COM}
5637*8044SWilliam.Kucharski@Sun.COM\expandafter\def\csname macarg.\endcsname{\realbackslash}
5638*8044SWilliam.Kucharski@Sun.COM
5639*8044SWilliam.Kucharski@Sun.COM\def\macro{\recursivefalse\parsearg\macroxxx}
5640*8044SWilliam.Kucharski@Sun.COM\def\rmacro{\recursivetrue\parsearg\macroxxx}
5641*8044SWilliam.Kucharski@Sun.COM
5642*8044SWilliam.Kucharski@Sun.COM\def\macroxxx#1{%
5643*8044SWilliam.Kucharski@Sun.COM  \getargs{#1}%           now \macname is the macname and \argl the arglist
5644*8044SWilliam.Kucharski@Sun.COM  \ifx\argl\empty       % no arguments
5645*8044SWilliam.Kucharski@Sun.COM     \paramno=0%
5646*8044SWilliam.Kucharski@Sun.COM  \else
5647*8044SWilliam.Kucharski@Sun.COM     \expandafter\parsemargdef \argl;%
5648*8044SWilliam.Kucharski@Sun.COM  \fi
5649*8044SWilliam.Kucharski@Sun.COM  \if1\csname ismacro.\the\macname\endcsname
5650*8044SWilliam.Kucharski@Sun.COM     \message{Warning: redefining \the\macname}%
5651*8044SWilliam.Kucharski@Sun.COM  \else
5652*8044SWilliam.Kucharski@Sun.COM     \expandafter\ifx\csname \the\macname\endcsname \relax
5653*8044SWilliam.Kucharski@Sun.COM     \else \errmessage{Macro name \the\macname\space already defined}\fi
5654*8044SWilliam.Kucharski@Sun.COM     \global\cslet{macsave.\the\macname}{\the\macname}%
5655*8044SWilliam.Kucharski@Sun.COM     \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5656*8044SWilliam.Kucharski@Sun.COM     % Add the macroname to \macrolist
5657*8044SWilliam.Kucharski@Sun.COM     \toks0 = \expandafter{\macrolist\do}%
5658*8044SWilliam.Kucharski@Sun.COM     \xdef\macrolist{\the\toks0
5659*8044SWilliam.Kucharski@Sun.COM       \expandafter\noexpand\csname\the\macname\endcsname}%
5660*8044SWilliam.Kucharski@Sun.COM  \fi
5661*8044SWilliam.Kucharski@Sun.COM  \begingroup \macrobodyctxt
5662*8044SWilliam.Kucharski@Sun.COM  \ifrecursive \expandafter\parsermacbody
5663*8044SWilliam.Kucharski@Sun.COM  \else \expandafter\parsemacbody
5664*8044SWilliam.Kucharski@Sun.COM  \fi}
5665*8044SWilliam.Kucharski@Sun.COM
5666*8044SWilliam.Kucharski@Sun.COM\parseargdef\unmacro{%
5667*8044SWilliam.Kucharski@Sun.COM  \if1\csname ismacro.#1\endcsname
5668*8044SWilliam.Kucharski@Sun.COM    \global\cslet{#1}{macsave.#1}%
5669*8044SWilliam.Kucharski@Sun.COM    \global\expandafter\let \csname ismacro.#1\endcsname=0%
5670*8044SWilliam.Kucharski@Sun.COM    % Remove the macro name from \macrolist:
5671*8044SWilliam.Kucharski@Sun.COM    \begingroup
5672*8044SWilliam.Kucharski@Sun.COM      \expandafter\let\csname#1\endcsname \relax
5673*8044SWilliam.Kucharski@Sun.COM      \let\do\unmacrodo
5674*8044SWilliam.Kucharski@Sun.COM      \xdef\macrolist{\macrolist}%
5675*8044SWilliam.Kucharski@Sun.COM    \endgroup
5676*8044SWilliam.Kucharski@Sun.COM  \else
5677*8044SWilliam.Kucharski@Sun.COM    \errmessage{Macro #1 not defined}%
5678*8044SWilliam.Kucharski@Sun.COM  \fi
5679*8044SWilliam.Kucharski@Sun.COM}
5680*8044SWilliam.Kucharski@Sun.COM
5681*8044SWilliam.Kucharski@Sun.COM% Called by \do from \dounmacro on each macro.  The idea is to omit any
5682*8044SWilliam.Kucharski@Sun.COM% macro definitions that have been changed to \relax.
5683*8044SWilliam.Kucharski@Sun.COM%
5684*8044SWilliam.Kucharski@Sun.COM\def\unmacrodo#1{%
5685*8044SWilliam.Kucharski@Sun.COM  \ifx#1\relax
5686*8044SWilliam.Kucharski@Sun.COM    % remove this
5687*8044SWilliam.Kucharski@Sun.COM  \else
5688*8044SWilliam.Kucharski@Sun.COM    \noexpand\do \noexpand #1%
5689*8044SWilliam.Kucharski@Sun.COM  \fi
5690*8044SWilliam.Kucharski@Sun.COM}
5691*8044SWilliam.Kucharski@Sun.COM
5692*8044SWilliam.Kucharski@Sun.COM% This makes use of the obscure feature that if the last token of a
5693*8044SWilliam.Kucharski@Sun.COM% <parameter list> is #, then the preceding argument is delimited by
5694*8044SWilliam.Kucharski@Sun.COM% an opening brace, and that opening brace is not consumed.
5695*8044SWilliam.Kucharski@Sun.COM\def\getargs#1{\getargsxxx#1{}}
5696*8044SWilliam.Kucharski@Sun.COM\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5697*8044SWilliam.Kucharski@Sun.COM\def\getmacname #1 #2\relax{\macname={#1}}
5698*8044SWilliam.Kucharski@Sun.COM\def\getmacargs#1{\def\argl{#1}}
5699*8044SWilliam.Kucharski@Sun.COM
5700*8044SWilliam.Kucharski@Sun.COM% Parse the optional {params} list.  Set up \paramno and \paramlist
5701*8044SWilliam.Kucharski@Sun.COM% so \defmacro knows what to do.  Define \macarg.blah for each blah
5702*8044SWilliam.Kucharski@Sun.COM% in the params list, to be ##N where N is the position in that list.
5703*8044SWilliam.Kucharski@Sun.COM% That gets used by \mbodybackslash (above).
5704*8044SWilliam.Kucharski@Sun.COM
5705*8044SWilliam.Kucharski@Sun.COM% We need to get `macro parameter char #' into several definitions.
5706*8044SWilliam.Kucharski@Sun.COM% The technique used is stolen from LaTeX:  let \hash be something
5707*8044SWilliam.Kucharski@Sun.COM% unexpandable, insert that wherever you need a #, and then redefine
5708*8044SWilliam.Kucharski@Sun.COM% it to # just before using the token list produced.
5709*8044SWilliam.Kucharski@Sun.COM%
5710*8044SWilliam.Kucharski@Sun.COM% The same technique is used to protect \eatspaces till just before
5711*8044SWilliam.Kucharski@Sun.COM% the macro is used.
5712*8044SWilliam.Kucharski@Sun.COM
5713*8044SWilliam.Kucharski@Sun.COM\def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5714*8044SWilliam.Kucharski@Sun.COM        \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5715*8044SWilliam.Kucharski@Sun.COM\def\parsemargdefxxx#1,{%
5716*8044SWilliam.Kucharski@Sun.COM  \if#1;\let\next=\relax
5717*8044SWilliam.Kucharski@Sun.COM  \else \let\next=\parsemargdefxxx
5718*8044SWilliam.Kucharski@Sun.COM    \advance\paramno by 1%
5719*8044SWilliam.Kucharski@Sun.COM    \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5720*8044SWilliam.Kucharski@Sun.COM        {\xeatspaces{\hash\the\paramno}}%
5721*8044SWilliam.Kucharski@Sun.COM    \edef\paramlist{\paramlist\hash\the\paramno,}%
5722*8044SWilliam.Kucharski@Sun.COM  \fi\next}
5723*8044SWilliam.Kucharski@Sun.COM
5724*8044SWilliam.Kucharski@Sun.COM% These two commands read recursive and nonrecursive macro bodies.
5725*8044SWilliam.Kucharski@Sun.COM% (They're different since rec and nonrec macros end differently.)
5726*8044SWilliam.Kucharski@Sun.COM
5727*8044SWilliam.Kucharski@Sun.COM\long\def\parsemacbody#1@end macro%
5728*8044SWilliam.Kucharski@Sun.COM{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5729*8044SWilliam.Kucharski@Sun.COM\long\def\parsermacbody#1@end rmacro%
5730*8044SWilliam.Kucharski@Sun.COM{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5731*8044SWilliam.Kucharski@Sun.COM
5732*8044SWilliam.Kucharski@Sun.COM% This defines the macro itself. There are six cases: recursive and
5733*8044SWilliam.Kucharski@Sun.COM% nonrecursive macros of zero, one, and many arguments.
5734*8044SWilliam.Kucharski@Sun.COM% Much magic with \expandafter here.
5735*8044SWilliam.Kucharski@Sun.COM% \xdef is used so that macro definitions will survive the file
5736*8044SWilliam.Kucharski@Sun.COM% they're defined in; @include reads the file inside a group.
5737*8044SWilliam.Kucharski@Sun.COM\def\defmacro{%
5738*8044SWilliam.Kucharski@Sun.COM  \let\hash=##% convert placeholders to macro parameter chars
5739*8044SWilliam.Kucharski@Sun.COM  \ifrecursive
5740*8044SWilliam.Kucharski@Sun.COM    \ifcase\paramno
5741*8044SWilliam.Kucharski@Sun.COM    % 0
5742*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname\endcsname{%
5743*8044SWilliam.Kucharski@Sun.COM        \noexpand\scanmacro{\temp}}%
5744*8044SWilliam.Kucharski@Sun.COM    \or % 1
5745*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname\endcsname{%
5746*8044SWilliam.Kucharski@Sun.COM         \bgroup\noexpand\macroargctxt
5747*8044SWilliam.Kucharski@Sun.COM         \noexpand\braceorline
5748*8044SWilliam.Kucharski@Sun.COM         \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5749*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5750*8044SWilliam.Kucharski@Sun.COM         \egroup\noexpand\scanmacro{\temp}}%
5751*8044SWilliam.Kucharski@Sun.COM    \else % many
5752*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname\endcsname{%
5753*8044SWilliam.Kucharski@Sun.COM         \bgroup\noexpand\macroargctxt
5754*8044SWilliam.Kucharski@Sun.COM         \noexpand\csname\the\macname xx\endcsname}%
5755*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5756*8044SWilliam.Kucharski@Sun.COM          \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5757*8044SWilliam.Kucharski@Sun.COM      \expandafter\expandafter
5758*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef
5759*8044SWilliam.Kucharski@Sun.COM      \expandafter\expandafter
5760*8044SWilliam.Kucharski@Sun.COM        \csname\the\macname xxx\endcsname
5761*8044SWilliam.Kucharski@Sun.COM          \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5762*8044SWilliam.Kucharski@Sun.COM    \fi
5763*8044SWilliam.Kucharski@Sun.COM  \else
5764*8044SWilliam.Kucharski@Sun.COM    \ifcase\paramno
5765*8044SWilliam.Kucharski@Sun.COM    % 0
5766*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname\endcsname{%
5767*8044SWilliam.Kucharski@Sun.COM        \noexpand\norecurse{\the\macname}%
5768*8044SWilliam.Kucharski@Sun.COM        \noexpand\scanmacro{\temp}\egroup}%
5769*8044SWilliam.Kucharski@Sun.COM    \or % 1
5770*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname\endcsname{%
5771*8044SWilliam.Kucharski@Sun.COM         \bgroup\noexpand\macroargctxt
5772*8044SWilliam.Kucharski@Sun.COM         \noexpand\braceorline
5773*8044SWilliam.Kucharski@Sun.COM         \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5774*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5775*8044SWilliam.Kucharski@Sun.COM        \egroup
5776*8044SWilliam.Kucharski@Sun.COM        \noexpand\norecurse{\the\macname}%
5777*8044SWilliam.Kucharski@Sun.COM        \noexpand\scanmacro{\temp}\egroup}%
5778*8044SWilliam.Kucharski@Sun.COM    \else % many
5779*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname\endcsname{%
5780*8044SWilliam.Kucharski@Sun.COM         \bgroup\noexpand\macroargctxt
5781*8044SWilliam.Kucharski@Sun.COM         \expandafter\noexpand\csname\the\macname xx\endcsname}%
5782*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5783*8044SWilliam.Kucharski@Sun.COM          \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5784*8044SWilliam.Kucharski@Sun.COM      \expandafter\expandafter
5785*8044SWilliam.Kucharski@Sun.COM      \expandafter\xdef
5786*8044SWilliam.Kucharski@Sun.COM      \expandafter\expandafter
5787*8044SWilliam.Kucharski@Sun.COM      \csname\the\macname xxx\endcsname
5788*8044SWilliam.Kucharski@Sun.COM      \paramlist{%
5789*8044SWilliam.Kucharski@Sun.COM          \egroup
5790*8044SWilliam.Kucharski@Sun.COM          \noexpand\norecurse{\the\macname}%
5791*8044SWilliam.Kucharski@Sun.COM          \noexpand\scanmacro{\temp}\egroup}%
5792*8044SWilliam.Kucharski@Sun.COM    \fi
5793*8044SWilliam.Kucharski@Sun.COM  \fi}
5794*8044SWilliam.Kucharski@Sun.COM
5795*8044SWilliam.Kucharski@Sun.COM\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5796*8044SWilliam.Kucharski@Sun.COM
5797*8044SWilliam.Kucharski@Sun.COM% \braceorline decides whether the next nonwhitespace character is a
5798*8044SWilliam.Kucharski@Sun.COM% {.  If so it reads up to the closing }, if not, it reads the whole
5799*8044SWilliam.Kucharski@Sun.COM% line.  Whatever was read is then fed to the next control sequence
5800*8044SWilliam.Kucharski@Sun.COM% as an argument (by \parsebrace or \parsearg)
5801*8044SWilliam.Kucharski@Sun.COM\def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5802*8044SWilliam.Kucharski@Sun.COM\def\braceorlinexxx{%
5803*8044SWilliam.Kucharski@Sun.COM  \ifx\nchar\bgroup\else
5804*8044SWilliam.Kucharski@Sun.COM    \expandafter\parsearg
5805*8044SWilliam.Kucharski@Sun.COM  \fi \next}
5806*8044SWilliam.Kucharski@Sun.COM
5807*8044SWilliam.Kucharski@Sun.COM% We want to disable all macros during \shipout so that they are not
5808*8044SWilliam.Kucharski@Sun.COM% expanded by \write.
5809*8044SWilliam.Kucharski@Sun.COM\def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5810*8044SWilliam.Kucharski@Sun.COM  \edef\next{\macrolist}\expandafter\endgroup\next}
5811*8044SWilliam.Kucharski@Sun.COM
5812*8044SWilliam.Kucharski@Sun.COM% For \indexnofonts, we need to get rid of all macros, leaving only the
5813*8044SWilliam.Kucharski@Sun.COM% arguments (if present).  Of course this is not nearly correct, but it
5814*8044SWilliam.Kucharski@Sun.COM% is the best we can do for now.  makeinfo does not expand macros in the
5815*8044SWilliam.Kucharski@Sun.COM% argument to @deffn, which ends up writing an index entry, and texindex
5816*8044SWilliam.Kucharski@Sun.COM% isn't prepared for an index sort entry that starts with \.
5817*8044SWilliam.Kucharski@Sun.COM%
5818*8044SWilliam.Kucharski@Sun.COM% Since macro invocations are followed by braces, we can just redefine them
5819*8044SWilliam.Kucharski@Sun.COM% to take a single TeX argument.  The case of a macro invocation that
5820*8044SWilliam.Kucharski@Sun.COM% goes to end-of-line is not handled.
5821*8044SWilliam.Kucharski@Sun.COM%
5822*8044SWilliam.Kucharski@Sun.COM\def\emptyusermacros{\begingroup
5823*8044SWilliam.Kucharski@Sun.COM  \def\do##1{\let\noexpand##1=\noexpand\asis}%
5824*8044SWilliam.Kucharski@Sun.COM  \edef\next{\macrolist}\expandafter\endgroup\next}
5825*8044SWilliam.Kucharski@Sun.COM
5826*8044SWilliam.Kucharski@Sun.COM
5827*8044SWilliam.Kucharski@Sun.COM% @alias.
5828*8044SWilliam.Kucharski@Sun.COM% We need some trickery to remove the optional spaces around the equal
5829*8044SWilliam.Kucharski@Sun.COM% sign.  Just make them active and then expand them all to nothing.
5830*8044SWilliam.Kucharski@Sun.COM\def\alias{\parseargusing\obeyspaces\aliasxxx}
5831*8044SWilliam.Kucharski@Sun.COM\def\aliasxxx #1{\aliasyyy#1\relax}
5832*8044SWilliam.Kucharski@Sun.COM\def\aliasyyy #1=#2\relax{%
5833*8044SWilliam.Kucharski@Sun.COM  {%
5834*8044SWilliam.Kucharski@Sun.COM    \expandafter\let\obeyedspace=\empty
5835*8044SWilliam.Kucharski@Sun.COM    \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5836*8044SWilliam.Kucharski@Sun.COM  }%
5837*8044SWilliam.Kucharski@Sun.COM  \next
5838*8044SWilliam.Kucharski@Sun.COM}
5839*8044SWilliam.Kucharski@Sun.COM
5840*8044SWilliam.Kucharski@Sun.COM
5841*8044SWilliam.Kucharski@Sun.COM\message{cross references,}
5842*8044SWilliam.Kucharski@Sun.COM
5843*8044SWilliam.Kucharski@Sun.COM\newwrite\auxfile
5844*8044SWilliam.Kucharski@Sun.COM
5845*8044SWilliam.Kucharski@Sun.COM\newif\ifhavexrefs    % True if xref values are known.
5846*8044SWilliam.Kucharski@Sun.COM\newif\ifwarnedxrefs  % True if we warned once that they aren't known.
5847*8044SWilliam.Kucharski@Sun.COM
5848*8044SWilliam.Kucharski@Sun.COM% @inforef is relatively simple.
5849*8044SWilliam.Kucharski@Sun.COM\def\inforef #1{\inforefzzz #1,,,,**}
5850*8044SWilliam.Kucharski@Sun.COM\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5851*8044SWilliam.Kucharski@Sun.COM  node \samp{\ignorespaces#1{}}}
5852*8044SWilliam.Kucharski@Sun.COM
5853*8044SWilliam.Kucharski@Sun.COM% @node's only job in TeX is to define \lastnode, which is used in
5854*8044SWilliam.Kucharski@Sun.COM% cross-references.  The @node line might or might not have commas, and
5855*8044SWilliam.Kucharski@Sun.COM% might or might not have spaces before the first comma, like:
5856*8044SWilliam.Kucharski@Sun.COM% @node foo , bar , ...
5857*8044SWilliam.Kucharski@Sun.COM% We don't want such trailing spaces in the node name.
5858*8044SWilliam.Kucharski@Sun.COM%
5859*8044SWilliam.Kucharski@Sun.COM\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
5860*8044SWilliam.Kucharski@Sun.COM%
5861*8044SWilliam.Kucharski@Sun.COM% also remove a trailing comma, in case of something like this:
5862*8044SWilliam.Kucharski@Sun.COM% @node Help-Cross,  ,  , Cross-refs
5863*8044SWilliam.Kucharski@Sun.COM\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
5864*8044SWilliam.Kucharski@Sun.COM\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5865*8044SWilliam.Kucharski@Sun.COM
5866*8044SWilliam.Kucharski@Sun.COM\let\nwnode=\node
5867*8044SWilliam.Kucharski@Sun.COM\let\lastnode=\empty
5868*8044SWilliam.Kucharski@Sun.COM
5869*8044SWilliam.Kucharski@Sun.COM% Write a cross-reference definition for the current node.  #1 is the
5870*8044SWilliam.Kucharski@Sun.COM% type (Ynumbered, Yappendix, Ynothing).
5871*8044SWilliam.Kucharski@Sun.COM%
5872*8044SWilliam.Kucharski@Sun.COM\def\donoderef#1{%
5873*8044SWilliam.Kucharski@Sun.COM  \ifx\lastnode\empty\else
5874*8044SWilliam.Kucharski@Sun.COM    \setref{\lastnode}{#1}%
5875*8044SWilliam.Kucharski@Sun.COM    \global\let\lastnode=\empty
5876*8044SWilliam.Kucharski@Sun.COM  \fi
5877*8044SWilliam.Kucharski@Sun.COM}
5878*8044SWilliam.Kucharski@Sun.COM
5879*8044SWilliam.Kucharski@Sun.COM% @anchor{NAME} -- define xref target at arbitrary point.
5880*8044SWilliam.Kucharski@Sun.COM%
5881*8044SWilliam.Kucharski@Sun.COM\newcount\savesfregister
5882*8044SWilliam.Kucharski@Sun.COM%
5883*8044SWilliam.Kucharski@Sun.COM\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5884*8044SWilliam.Kucharski@Sun.COM\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5885*8044SWilliam.Kucharski@Sun.COM\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5886*8044SWilliam.Kucharski@Sun.COM
5887*8044SWilliam.Kucharski@Sun.COM% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5888*8044SWilliam.Kucharski@Sun.COM% anchor), which consists of three parts:
5889*8044SWilliam.Kucharski@Sun.COM% 1) NAME-title - the current sectioning name taken from \thissection,
5890*8044SWilliam.Kucharski@Sun.COM%                 or the anchor name.
5891*8044SWilliam.Kucharski@Sun.COM% 2) NAME-snt   - section number and type, passed as the SNT arg, or
5892*8044SWilliam.Kucharski@Sun.COM%                 empty for anchors.
5893*8044SWilliam.Kucharski@Sun.COM% 3) NAME-pg    - the page number.
5894*8044SWilliam.Kucharski@Sun.COM%
5895*8044SWilliam.Kucharski@Sun.COM% This is called from \donoderef, \anchor, and \dofloat.  In the case of
5896*8044SWilliam.Kucharski@Sun.COM% floats, there is an additional part, which is not written here:
5897*8044SWilliam.Kucharski@Sun.COM% 4) NAME-lof   - the text as it should appear in a @listoffloats.
5898*8044SWilliam.Kucharski@Sun.COM%
5899*8044SWilliam.Kucharski@Sun.COM\def\setref#1#2{%
5900*8044SWilliam.Kucharski@Sun.COM  \pdfmkdest{#1}%
5901*8044SWilliam.Kucharski@Sun.COM  \iflinks
5902*8044SWilliam.Kucharski@Sun.COM    {%
5903*8044SWilliam.Kucharski@Sun.COM      \atdummies  % preserve commands, but don't expand them
5904*8044SWilliam.Kucharski@Sun.COM      \turnoffactive
5905*8044SWilliam.Kucharski@Sun.COM      \otherbackslash
5906*8044SWilliam.Kucharski@Sun.COM      \edef\writexrdef##1##2{%
5907*8044SWilliam.Kucharski@Sun.COM	\write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
5908*8044SWilliam.Kucharski@Sun.COM	  ##1}{##2}}% these are parameters of \writexrdef
5909*8044SWilliam.Kucharski@Sun.COM      }%
5910*8044SWilliam.Kucharski@Sun.COM      \toks0 = \expandafter{\thissection}%
5911*8044SWilliam.Kucharski@Sun.COM      \immediate \writexrdef{title}{\the\toks0 }%
5912*8044SWilliam.Kucharski@Sun.COM      \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
5913*8044SWilliam.Kucharski@Sun.COM      \writexrdef{pg}{\folio}% will be written later, during \shipout
5914*8044SWilliam.Kucharski@Sun.COM    }%
5915*8044SWilliam.Kucharski@Sun.COM  \fi
5916*8044SWilliam.Kucharski@Sun.COM}
5917*8044SWilliam.Kucharski@Sun.COM
5918*8044SWilliam.Kucharski@Sun.COM% @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
5919*8044SWilliam.Kucharski@Sun.COM% the node name, #2 the name of the Info cross-reference, #3 the printed
5920*8044SWilliam.Kucharski@Sun.COM% node name, #4 the name of the Info file, #5 the name of the printed
5921*8044SWilliam.Kucharski@Sun.COM% manual.  All but the node name can be omitted.
5922*8044SWilliam.Kucharski@Sun.COM%
5923*8044SWilliam.Kucharski@Sun.COM\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5924*8044SWilliam.Kucharski@Sun.COM\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5925*8044SWilliam.Kucharski@Sun.COM\def\ref#1{\xrefX[#1,,,,,,,]}
5926*8044SWilliam.Kucharski@Sun.COM\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5927*8044SWilliam.Kucharski@Sun.COM  \unsepspaces
5928*8044SWilliam.Kucharski@Sun.COM  \def\printedmanual{\ignorespaces #5}%
5929*8044SWilliam.Kucharski@Sun.COM  \def\printedrefname{\ignorespaces #3}%
5930*8044SWilliam.Kucharski@Sun.COM  \setbox1=\hbox{\printedmanual\unskip}%
5931*8044SWilliam.Kucharski@Sun.COM  \setbox0=\hbox{\printedrefname\unskip}%
5932*8044SWilliam.Kucharski@Sun.COM  \ifdim \wd0 = 0pt
5933*8044SWilliam.Kucharski@Sun.COM    % No printed node name was explicitly given.
5934*8044SWilliam.Kucharski@Sun.COM    \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5935*8044SWilliam.Kucharski@Sun.COM      % Use the node name inside the square brackets.
5936*8044SWilliam.Kucharski@Sun.COM      \def\printedrefname{\ignorespaces #1}%
5937*8044SWilliam.Kucharski@Sun.COM    \else
5938*8044SWilliam.Kucharski@Sun.COM      % Use the actual chapter/section title appear inside
5939*8044SWilliam.Kucharski@Sun.COM      % the square brackets.  Use the real section title if we have it.
5940*8044SWilliam.Kucharski@Sun.COM      \ifdim \wd1 > 0pt
5941*8044SWilliam.Kucharski@Sun.COM        % It is in another manual, so we don't have it.
5942*8044SWilliam.Kucharski@Sun.COM        \def\printedrefname{\ignorespaces #1}%
5943*8044SWilliam.Kucharski@Sun.COM      \else
5944*8044SWilliam.Kucharski@Sun.COM        \ifhavexrefs
5945*8044SWilliam.Kucharski@Sun.COM          % We know the real title if we have the xref values.
5946*8044SWilliam.Kucharski@Sun.COM          \def\printedrefname{\refx{#1-title}{}}%
5947*8044SWilliam.Kucharski@Sun.COM        \else
5948*8044SWilliam.Kucharski@Sun.COM          % Otherwise just copy the Info node name.
5949*8044SWilliam.Kucharski@Sun.COM          \def\printedrefname{\ignorespaces #1}%
5950*8044SWilliam.Kucharski@Sun.COM        \fi%
5951*8044SWilliam.Kucharski@Sun.COM      \fi
5952*8044SWilliam.Kucharski@Sun.COM    \fi
5953*8044SWilliam.Kucharski@Sun.COM  \fi
5954*8044SWilliam.Kucharski@Sun.COM  %
5955*8044SWilliam.Kucharski@Sun.COM  % Make link in pdf output.
5956*8044SWilliam.Kucharski@Sun.COM  \ifpdf
5957*8044SWilliam.Kucharski@Sun.COM    \leavevmode
5958*8044SWilliam.Kucharski@Sun.COM    \getfilename{#4}%
5959*8044SWilliam.Kucharski@Sun.COM    {\turnoffactive \otherbackslash
5960*8044SWilliam.Kucharski@Sun.COM     \ifnum\filenamelength>0
5961*8044SWilliam.Kucharski@Sun.COM       \startlink attr{/Border [0 0 0]}%
5962*8044SWilliam.Kucharski@Sun.COM         goto file{\the\filename.pdf} name{#1}%
5963*8044SWilliam.Kucharski@Sun.COM     \else
5964*8044SWilliam.Kucharski@Sun.COM       \startlink attr{/Border [0 0 0]}%
5965*8044SWilliam.Kucharski@Sun.COM         goto name{\pdfmkpgn{#1}}%
5966*8044SWilliam.Kucharski@Sun.COM     \fi
5967*8044SWilliam.Kucharski@Sun.COM    }%
5968*8044SWilliam.Kucharski@Sun.COM    \linkcolor
5969*8044SWilliam.Kucharski@Sun.COM  \fi
5970*8044SWilliam.Kucharski@Sun.COM  %
5971*8044SWilliam.Kucharski@Sun.COM  % Float references are printed completely differently: "Figure 1.2"
5972*8044SWilliam.Kucharski@Sun.COM  % instead of "[somenode], p.3".  We distinguish them by the
5973*8044SWilliam.Kucharski@Sun.COM  % LABEL-title being set to a magic string.
5974*8044SWilliam.Kucharski@Sun.COM  {%
5975*8044SWilliam.Kucharski@Sun.COM    % Have to otherify everything special to allow the \csname to
5976*8044SWilliam.Kucharski@Sun.COM    % include an _ in the xref name, etc.
5977*8044SWilliam.Kucharski@Sun.COM    \indexnofonts
5978*8044SWilliam.Kucharski@Sun.COM    \turnoffactive
5979*8044SWilliam.Kucharski@Sun.COM    \otherbackslash
5980*8044SWilliam.Kucharski@Sun.COM    \expandafter\global\expandafter\let\expandafter\Xthisreftitle
5981*8044SWilliam.Kucharski@Sun.COM      \csname XR#1-title\endcsname
5982*8044SWilliam.Kucharski@Sun.COM  }%
5983*8044SWilliam.Kucharski@Sun.COM  \iffloat\Xthisreftitle
5984*8044SWilliam.Kucharski@Sun.COM    % If the user specified the print name (third arg) to the ref,
5985*8044SWilliam.Kucharski@Sun.COM    % print it instead of our usual "Figure 1.2".
5986*8044SWilliam.Kucharski@Sun.COM    \ifdim\wd0 = 0pt
5987*8044SWilliam.Kucharski@Sun.COM      \refx{#1-snt}%
5988*8044SWilliam.Kucharski@Sun.COM    \else
5989*8044SWilliam.Kucharski@Sun.COM      \printedrefname
5990*8044SWilliam.Kucharski@Sun.COM    \fi
5991*8044SWilliam.Kucharski@Sun.COM    %
5992*8044SWilliam.Kucharski@Sun.COM    % if the user also gave the printed manual name (fifth arg), append
5993*8044SWilliam.Kucharski@Sun.COM    % "in MANUALNAME".
5994*8044SWilliam.Kucharski@Sun.COM    \ifdim \wd1 > 0pt
5995*8044SWilliam.Kucharski@Sun.COM      \space \putwordin{} \cite{\printedmanual}%
5996*8044SWilliam.Kucharski@Sun.COM    \fi
5997*8044SWilliam.Kucharski@Sun.COM  \else
5998*8044SWilliam.Kucharski@Sun.COM    % node/anchor (non-float) references.
5999*8044SWilliam.Kucharski@Sun.COM    %
6000*8044SWilliam.Kucharski@Sun.COM    % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6001*8044SWilliam.Kucharski@Sun.COM    % insert empty discretionaries after hyphens, which means that it will
6002*8044SWilliam.Kucharski@Sun.COM    % not find a line break at a hyphen in a node names.  Since some manuals
6003*8044SWilliam.Kucharski@Sun.COM    % are best written with fairly long node names, containing hyphens, this
6004*8044SWilliam.Kucharski@Sun.COM    % is a loss.  Therefore, we give the text of the node name again, so it
6005*8044SWilliam.Kucharski@Sun.COM    % is as if TeX is seeing it for the first time.
6006*8044SWilliam.Kucharski@Sun.COM    \ifdim \wd1 > 0pt
6007*8044SWilliam.Kucharski@Sun.COM      \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6008*8044SWilliam.Kucharski@Sun.COM    \else
6009*8044SWilliam.Kucharski@Sun.COM      % _ (for example) has to be the character _ for the purposes of the
6010*8044SWilliam.Kucharski@Sun.COM      % control sequence corresponding to the node, but it has to expand
6011*8044SWilliam.Kucharski@Sun.COM      % into the usual \leavevmode...\vrule stuff for purposes of
6012*8044SWilliam.Kucharski@Sun.COM      % printing. So we \turnoffactive for the \refx-snt, back on for the
6013*8044SWilliam.Kucharski@Sun.COM      % printing, back off for the \refx-pg.
6014*8044SWilliam.Kucharski@Sun.COM      {\turnoffactive \otherbackslash
6015*8044SWilliam.Kucharski@Sun.COM       % Only output a following space if the -snt ref is nonempty; for
6016*8044SWilliam.Kucharski@Sun.COM       % @unnumbered and @anchor, it won't be.
6017*8044SWilliam.Kucharski@Sun.COM       \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6018*8044SWilliam.Kucharski@Sun.COM       \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6019*8044SWilliam.Kucharski@Sun.COM      }%
6020*8044SWilliam.Kucharski@Sun.COM      % output the `[mynode]' via a macro so it can be overridden.
6021*8044SWilliam.Kucharski@Sun.COM      \xrefprintnodename\printedrefname
6022*8044SWilliam.Kucharski@Sun.COM      %
6023*8044SWilliam.Kucharski@Sun.COM      % But we always want a comma and a space:
6024*8044SWilliam.Kucharski@Sun.COM      ,\space
6025*8044SWilliam.Kucharski@Sun.COM      %
6026*8044SWilliam.Kucharski@Sun.COM      % output the `page 3'.
6027*8044SWilliam.Kucharski@Sun.COM      \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
6028*8044SWilliam.Kucharski@Sun.COM    \fi
6029*8044SWilliam.Kucharski@Sun.COM  \fi
6030*8044SWilliam.Kucharski@Sun.COM  \endlink
6031*8044SWilliam.Kucharski@Sun.COM\endgroup}
6032*8044SWilliam.Kucharski@Sun.COM
6033*8044SWilliam.Kucharski@Sun.COM% This macro is called from \xrefX for the `[nodename]' part of xref
6034*8044SWilliam.Kucharski@Sun.COM% output.  It's a separate macro only so it can be changed more easily,
6035*8044SWilliam.Kucharski@Sun.COM% since square brackets don't work well in some documents.  Particularly
6036*8044SWilliam.Kucharski@Sun.COM% one that Bob is working on :).
6037*8044SWilliam.Kucharski@Sun.COM%
6038*8044SWilliam.Kucharski@Sun.COM\def\xrefprintnodename#1{[#1]}
6039*8044SWilliam.Kucharski@Sun.COM
6040*8044SWilliam.Kucharski@Sun.COM% Things referred to by \setref.
6041*8044SWilliam.Kucharski@Sun.COM%
6042*8044SWilliam.Kucharski@Sun.COM\def\Ynothing{}
6043*8044SWilliam.Kucharski@Sun.COM\def\Yomitfromtoc{}
6044*8044SWilliam.Kucharski@Sun.COM\def\Ynumbered{%
6045*8044SWilliam.Kucharski@Sun.COM  \ifnum\secno=0
6046*8044SWilliam.Kucharski@Sun.COM    \putwordChapter@tie \the\chapno
6047*8044SWilliam.Kucharski@Sun.COM  \else \ifnum\subsecno=0
6048*8044SWilliam.Kucharski@Sun.COM    \putwordSection@tie \the\chapno.\the\secno
6049*8044SWilliam.Kucharski@Sun.COM  \else \ifnum\subsubsecno=0
6050*8044SWilliam.Kucharski@Sun.COM    \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6051*8044SWilliam.Kucharski@Sun.COM  \else
6052*8044SWilliam.Kucharski@Sun.COM    \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6053*8044SWilliam.Kucharski@Sun.COM  \fi\fi\fi
6054*8044SWilliam.Kucharski@Sun.COM}
6055*8044SWilliam.Kucharski@Sun.COM\def\Yappendix{%
6056*8044SWilliam.Kucharski@Sun.COM  \ifnum\secno=0
6057*8044SWilliam.Kucharski@Sun.COM     \putwordAppendix@tie @char\the\appendixno{}%
6058*8044SWilliam.Kucharski@Sun.COM  \else \ifnum\subsecno=0
6059*8044SWilliam.Kucharski@Sun.COM     \putwordSection@tie @char\the\appendixno.\the\secno
6060*8044SWilliam.Kucharski@Sun.COM  \else \ifnum\subsubsecno=0
6061*8044SWilliam.Kucharski@Sun.COM    \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6062*8044SWilliam.Kucharski@Sun.COM  \else
6063*8044SWilliam.Kucharski@Sun.COM    \putwordSection@tie
6064*8044SWilliam.Kucharski@Sun.COM      @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6065*8044SWilliam.Kucharski@Sun.COM  \fi\fi\fi
6066*8044SWilliam.Kucharski@Sun.COM}
6067*8044SWilliam.Kucharski@Sun.COM
6068*8044SWilliam.Kucharski@Sun.COM% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6069*8044SWilliam.Kucharski@Sun.COM% If its value is nonempty, SUFFIX is output afterward.
6070*8044SWilliam.Kucharski@Sun.COM%
6071*8044SWilliam.Kucharski@Sun.COM\def\refx#1#2{%
6072*8044SWilliam.Kucharski@Sun.COM  {%
6073*8044SWilliam.Kucharski@Sun.COM    \indexnofonts
6074*8044SWilliam.Kucharski@Sun.COM    \otherbackslash
6075*8044SWilliam.Kucharski@Sun.COM    \expandafter\global\expandafter\let\expandafter\thisrefX
6076*8044SWilliam.Kucharski@Sun.COM      \csname XR#1\endcsname
6077*8044SWilliam.Kucharski@Sun.COM  }%
6078*8044SWilliam.Kucharski@Sun.COM  \ifx\thisrefX\relax
6079*8044SWilliam.Kucharski@Sun.COM    % If not defined, say something at least.
6080*8044SWilliam.Kucharski@Sun.COM    \angleleft un\-de\-fined\angleright
6081*8044SWilliam.Kucharski@Sun.COM    \iflinks
6082*8044SWilliam.Kucharski@Sun.COM      \ifhavexrefs
6083*8044SWilliam.Kucharski@Sun.COM        \message{\linenumber Undefined cross reference `#1'.}%
6084*8044SWilliam.Kucharski@Sun.COM      \else
6085*8044SWilliam.Kucharski@Sun.COM        \ifwarnedxrefs\else
6086*8044SWilliam.Kucharski@Sun.COM          \global\warnedxrefstrue
6087*8044SWilliam.Kucharski@Sun.COM          \message{Cross reference values unknown; you must run TeX again.}%
6088*8044SWilliam.Kucharski@Sun.COM        \fi
6089*8044SWilliam.Kucharski@Sun.COM      \fi
6090*8044SWilliam.Kucharski@Sun.COM    \fi
6091*8044SWilliam.Kucharski@Sun.COM  \else
6092*8044SWilliam.Kucharski@Sun.COM    % It's defined, so just use it.
6093*8044SWilliam.Kucharski@Sun.COM    \thisrefX
6094*8044SWilliam.Kucharski@Sun.COM  \fi
6095*8044SWilliam.Kucharski@Sun.COM  #2% Output the suffix in any case.
6096*8044SWilliam.Kucharski@Sun.COM}
6097*8044SWilliam.Kucharski@Sun.COM
6098*8044SWilliam.Kucharski@Sun.COM% This is the macro invoked by entries in the aux file.  Usually it's
6099*8044SWilliam.Kucharski@Sun.COM% just a \def (we prepend XR to the control sequence name to avoid
6100*8044SWilliam.Kucharski@Sun.COM% collisions).  But if this is a float type, we have more work to do.
6101*8044SWilliam.Kucharski@Sun.COM%
6102*8044SWilliam.Kucharski@Sun.COM\def\xrdef#1#2{%
6103*8044SWilliam.Kucharski@Sun.COM  \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6104*8044SWilliam.Kucharski@Sun.COM  %
6105*8044SWilliam.Kucharski@Sun.COM  % Was that xref control sequence that we just defined for a float?
6106*8044SWilliam.Kucharski@Sun.COM  \expandafter\iffloat\csname XR#1\endcsname
6107*8044SWilliam.Kucharski@Sun.COM    % it was a float, and we have the (safe) float type in \iffloattype.
6108*8044SWilliam.Kucharski@Sun.COM    \expandafter\let\expandafter\floatlist
6109*8044SWilliam.Kucharski@Sun.COM      \csname floatlist\iffloattype\endcsname
6110*8044SWilliam.Kucharski@Sun.COM    %
6111*8044SWilliam.Kucharski@Sun.COM    % Is this the first time we've seen this float type?
6112*8044SWilliam.Kucharski@Sun.COM    \expandafter\ifx\floatlist\relax
6113*8044SWilliam.Kucharski@Sun.COM      \toks0 = {\do}% yes, so just \do
6114*8044SWilliam.Kucharski@Sun.COM    \else
6115*8044SWilliam.Kucharski@Sun.COM      % had it before, so preserve previous elements in list.
6116*8044SWilliam.Kucharski@Sun.COM      \toks0 = \expandafter{\floatlist\do}%
6117*8044SWilliam.Kucharski@Sun.COM    \fi
6118*8044SWilliam.Kucharski@Sun.COM    %
6119*8044SWilliam.Kucharski@Sun.COM    % Remember this xref in the control sequence \floatlistFLOATTYPE,
6120*8044SWilliam.Kucharski@Sun.COM    % for later use in \listoffloats.
6121*8044SWilliam.Kucharski@Sun.COM    \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6122*8044SWilliam.Kucharski@Sun.COM  \fi
6123*8044SWilliam.Kucharski@Sun.COM}
6124*8044SWilliam.Kucharski@Sun.COM
6125*8044SWilliam.Kucharski@Sun.COM% Read the last existing aux file, if any.  No error if none exists.
6126*8044SWilliam.Kucharski@Sun.COM%
6127*8044SWilliam.Kucharski@Sun.COM\def\tryauxfile{%
6128*8044SWilliam.Kucharski@Sun.COM  \openin 1 \jobname.aux
6129*8044SWilliam.Kucharski@Sun.COM  \ifeof 1 \else
6130*8044SWilliam.Kucharski@Sun.COM    \readauxfile
6131*8044SWilliam.Kucharski@Sun.COM    \global\havexrefstrue
6132*8044SWilliam.Kucharski@Sun.COM  \fi
6133*8044SWilliam.Kucharski@Sun.COM  \closein 1
6134*8044SWilliam.Kucharski@Sun.COM}
6135*8044SWilliam.Kucharski@Sun.COM
6136*8044SWilliam.Kucharski@Sun.COM\def\readauxfile{\begingroup
6137*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^@=\other
6138*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^A=\other
6139*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^B=\other
6140*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^C=\other
6141*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^D=\other
6142*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^E=\other
6143*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^F=\other
6144*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^G=\other
6145*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^H=\other
6146*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^K=\other
6147*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^L=\other
6148*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^N=\other
6149*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^P=\other
6150*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^Q=\other
6151*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^R=\other
6152*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^S=\other
6153*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^T=\other
6154*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^U=\other
6155*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^V=\other
6156*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^W=\other
6157*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^X=\other
6158*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^Z=\other
6159*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^[=\other
6160*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^\=\other
6161*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^]=\other
6162*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^^=\other
6163*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^_=\other
6164*8044SWilliam.Kucharski@Sun.COM  % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6165*8044SWilliam.Kucharski@Sun.COM  % in xref tags, i.e., node names.  But since ^^e4 notation isn't
6166*8044SWilliam.Kucharski@Sun.COM  % supported in the main text, it doesn't seem desirable.  Furthermore,
6167*8044SWilliam.Kucharski@Sun.COM  % that is not enough: for node names that actually contain a ^
6168*8044SWilliam.Kucharski@Sun.COM  % character, we would end up writing a line like this: 'xrdef {'hat
6169*8044SWilliam.Kucharski@Sun.COM  % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6170*8044SWilliam.Kucharski@Sun.COM  % argument, and \hat is not an expandable control sequence.  It could
6171*8044SWilliam.Kucharski@Sun.COM  % all be worked out, but why?  Either we support ^^ or we don't.
6172*8044SWilliam.Kucharski@Sun.COM  %
6173*8044SWilliam.Kucharski@Sun.COM  % The other change necessary for this was to define \auxhat:
6174*8044SWilliam.Kucharski@Sun.COM  % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6175*8044SWilliam.Kucharski@Sun.COM  % and then to call \auxhat in \setq.
6176*8044SWilliam.Kucharski@Sun.COM  %
6177*8044SWilliam.Kucharski@Sun.COM  \catcode`\^=\other
6178*8044SWilliam.Kucharski@Sun.COM  %
6179*8044SWilliam.Kucharski@Sun.COM  % Special characters.  Should be turned off anyway, but...
6180*8044SWilliam.Kucharski@Sun.COM  \catcode`\~=\other
6181*8044SWilliam.Kucharski@Sun.COM  \catcode`\[=\other
6182*8044SWilliam.Kucharski@Sun.COM  \catcode`\]=\other
6183*8044SWilliam.Kucharski@Sun.COM  \catcode`\"=\other
6184*8044SWilliam.Kucharski@Sun.COM  \catcode`\_=\other
6185*8044SWilliam.Kucharski@Sun.COM  \catcode`\|=\other
6186*8044SWilliam.Kucharski@Sun.COM  \catcode`\<=\other
6187*8044SWilliam.Kucharski@Sun.COM  \catcode`\>=\other
6188*8044SWilliam.Kucharski@Sun.COM  \catcode`\$=\other
6189*8044SWilliam.Kucharski@Sun.COM  \catcode`\#=\other
6190*8044SWilliam.Kucharski@Sun.COM  \catcode`\&=\other
6191*8044SWilliam.Kucharski@Sun.COM  \catcode`\%=\other
6192*8044SWilliam.Kucharski@Sun.COM  \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6193*8044SWilliam.Kucharski@Sun.COM  %
6194*8044SWilliam.Kucharski@Sun.COM  % This is to support \ in node names and titles, since the \
6195*8044SWilliam.Kucharski@Sun.COM  % characters end up in a \csname.  It's easier than
6196*8044SWilliam.Kucharski@Sun.COM  % leaving it active and making its active definition an actual \
6197*8044SWilliam.Kucharski@Sun.COM  % character.  What I don't understand is why it works in the *value*
6198*8044SWilliam.Kucharski@Sun.COM  % of the xrdef.  Seems like it should be a catcode12 \, and that
6199*8044SWilliam.Kucharski@Sun.COM  % should not typeset properly.  But it works, so I'm moving on for
6200*8044SWilliam.Kucharski@Sun.COM  % now.  --karl, 15jan04.
6201*8044SWilliam.Kucharski@Sun.COM  \catcode`\\=\other
6202*8044SWilliam.Kucharski@Sun.COM  %
6203*8044SWilliam.Kucharski@Sun.COM  % Make the characters 128-255 be printing characters.
6204*8044SWilliam.Kucharski@Sun.COM  {%
6205*8044SWilliam.Kucharski@Sun.COM    \count 1=128
6206*8044SWilliam.Kucharski@Sun.COM    \def\loop{%
6207*8044SWilliam.Kucharski@Sun.COM      \catcode\count 1=\other
6208*8044SWilliam.Kucharski@Sun.COM      \advance\count 1 by 1
6209*8044SWilliam.Kucharski@Sun.COM      \ifnum \count 1<256 \loop \fi
6210*8044SWilliam.Kucharski@Sun.COM    }%
6211*8044SWilliam.Kucharski@Sun.COM  }%
6212*8044SWilliam.Kucharski@Sun.COM  %
6213*8044SWilliam.Kucharski@Sun.COM  % @ is our escape character in .aux files, and we need braces.
6214*8044SWilliam.Kucharski@Sun.COM  \catcode`\{=1
6215*8044SWilliam.Kucharski@Sun.COM  \catcode`\}=2
6216*8044SWilliam.Kucharski@Sun.COM  \catcode`\@=0
6217*8044SWilliam.Kucharski@Sun.COM  %
6218*8044SWilliam.Kucharski@Sun.COM  \input \jobname.aux
6219*8044SWilliam.Kucharski@Sun.COM\endgroup}
6220*8044SWilliam.Kucharski@Sun.COM
6221*8044SWilliam.Kucharski@Sun.COM
6222*8044SWilliam.Kucharski@Sun.COM\message{insertions,}
6223*8044SWilliam.Kucharski@Sun.COM% including footnotes.
6224*8044SWilliam.Kucharski@Sun.COM
6225*8044SWilliam.Kucharski@Sun.COM\newcount \footnoteno
6226*8044SWilliam.Kucharski@Sun.COM
6227*8044SWilliam.Kucharski@Sun.COM% The trailing space in the following definition for supereject is
6228*8044SWilliam.Kucharski@Sun.COM% vital for proper filling; pages come out unaligned when you do a
6229*8044SWilliam.Kucharski@Sun.COM% pagealignmacro call if that space before the closing brace is
6230*8044SWilliam.Kucharski@Sun.COM% removed. (Generally, numeric constants should always be followed by a
6231*8044SWilliam.Kucharski@Sun.COM% space to prevent strange expansion errors.)
6232*8044SWilliam.Kucharski@Sun.COM\def\supereject{\par\penalty -20000\footnoteno =0 }
6233*8044SWilliam.Kucharski@Sun.COM
6234*8044SWilliam.Kucharski@Sun.COM% @footnotestyle is meaningful for info output only.
6235*8044SWilliam.Kucharski@Sun.COM\let\footnotestyle=\comment
6236*8044SWilliam.Kucharski@Sun.COM
6237*8044SWilliam.Kucharski@Sun.COM{\catcode `\@=11
6238*8044SWilliam.Kucharski@Sun.COM%
6239*8044SWilliam.Kucharski@Sun.COM% Auto-number footnotes.  Otherwise like plain.
6240*8044SWilliam.Kucharski@Sun.COM\gdef\footnote{%
6241*8044SWilliam.Kucharski@Sun.COM  \let\indent=\ptexindent
6242*8044SWilliam.Kucharski@Sun.COM  \let\noindent=\ptexnoindent
6243*8044SWilliam.Kucharski@Sun.COM  \global\advance\footnoteno by \@ne
6244*8044SWilliam.Kucharski@Sun.COM  \edef\thisfootno{$^{\the\footnoteno}$}%
6245*8044SWilliam.Kucharski@Sun.COM  %
6246*8044SWilliam.Kucharski@Sun.COM  % In case the footnote comes at the end of a sentence, preserve the
6247*8044SWilliam.Kucharski@Sun.COM  % extra spacing after we do the footnote number.
6248*8044SWilliam.Kucharski@Sun.COM  \let\@sf\empty
6249*8044SWilliam.Kucharski@Sun.COM  \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6250*8044SWilliam.Kucharski@Sun.COM  %
6251*8044SWilliam.Kucharski@Sun.COM  % Remove inadvertent blank space before typesetting the footnote number.
6252*8044SWilliam.Kucharski@Sun.COM  \unskip
6253*8044SWilliam.Kucharski@Sun.COM  \thisfootno\@sf
6254*8044SWilliam.Kucharski@Sun.COM  \dofootnote
6255*8044SWilliam.Kucharski@Sun.COM}%
6256*8044SWilliam.Kucharski@Sun.COM
6257*8044SWilliam.Kucharski@Sun.COM% Don't bother with the trickery in plain.tex to not require the
6258*8044SWilliam.Kucharski@Sun.COM% footnote text as a parameter.  Our footnotes don't need to be so general.
6259*8044SWilliam.Kucharski@Sun.COM%
6260*8044SWilliam.Kucharski@Sun.COM% Oh yes, they do; otherwise, @ifset (and anything else that uses
6261*8044SWilliam.Kucharski@Sun.COM% \parseargline) fails inside footnotes because the tokens are fixed when
6262*8044SWilliam.Kucharski@Sun.COM% the footnote is read.  --karl, 16nov96.
6263*8044SWilliam.Kucharski@Sun.COM%
6264*8044SWilliam.Kucharski@Sun.COM\gdef\dofootnote{%
6265*8044SWilliam.Kucharski@Sun.COM  \insert\footins\bgroup
6266*8044SWilliam.Kucharski@Sun.COM  % We want to typeset this text as a normal paragraph, even if the
6267*8044SWilliam.Kucharski@Sun.COM  % footnote reference occurs in (for example) a display environment.
6268*8044SWilliam.Kucharski@Sun.COM  % So reset some parameters.
6269*8044SWilliam.Kucharski@Sun.COM  \hsize=\pagewidth
6270*8044SWilliam.Kucharski@Sun.COM  \interlinepenalty\interfootnotelinepenalty
6271*8044SWilliam.Kucharski@Sun.COM  \splittopskip\ht\strutbox % top baseline for broken footnotes
6272*8044SWilliam.Kucharski@Sun.COM  \splitmaxdepth\dp\strutbox
6273*8044SWilliam.Kucharski@Sun.COM  \floatingpenalty\@MM
6274*8044SWilliam.Kucharski@Sun.COM  \leftskip\z@skip
6275*8044SWilliam.Kucharski@Sun.COM  \rightskip\z@skip
6276*8044SWilliam.Kucharski@Sun.COM  \spaceskip\z@skip
6277*8044SWilliam.Kucharski@Sun.COM  \xspaceskip\z@skip
6278*8044SWilliam.Kucharski@Sun.COM  \parindent\defaultparindent
6279*8044SWilliam.Kucharski@Sun.COM  %
6280*8044SWilliam.Kucharski@Sun.COM  \smallfonts \rm
6281*8044SWilliam.Kucharski@Sun.COM  %
6282*8044SWilliam.Kucharski@Sun.COM  % Because we use hanging indentation in footnotes, a @noindent appears
6283*8044SWilliam.Kucharski@Sun.COM  % to exdent this text, so make it be a no-op.  makeinfo does not use
6284*8044SWilliam.Kucharski@Sun.COM  % hanging indentation so @noindent can still be needed within footnote
6285*8044SWilliam.Kucharski@Sun.COM  % text after an @example or the like (not that this is good style).
6286*8044SWilliam.Kucharski@Sun.COM  \let\noindent = \relax
6287*8044SWilliam.Kucharski@Sun.COM  %
6288*8044SWilliam.Kucharski@Sun.COM  % Hang the footnote text off the number.  Use \everypar in case the
6289*8044SWilliam.Kucharski@Sun.COM  % footnote extends for more than one paragraph.
6290*8044SWilliam.Kucharski@Sun.COM  \everypar = {\hang}%
6291*8044SWilliam.Kucharski@Sun.COM  \textindent{\thisfootno}%
6292*8044SWilliam.Kucharski@Sun.COM  %
6293*8044SWilliam.Kucharski@Sun.COM  % Don't crash into the line above the footnote text.  Since this
6294*8044SWilliam.Kucharski@Sun.COM  % expands into a box, it must come within the paragraph, lest it
6295*8044SWilliam.Kucharski@Sun.COM  % provide a place where TeX can split the footnote.
6296*8044SWilliam.Kucharski@Sun.COM  \footstrut
6297*8044SWilliam.Kucharski@Sun.COM  \futurelet\next\fo@t
6298*8044SWilliam.Kucharski@Sun.COM}
6299*8044SWilliam.Kucharski@Sun.COM}%end \catcode `\@=11
6300*8044SWilliam.Kucharski@Sun.COM
6301*8044SWilliam.Kucharski@Sun.COM% In case a @footnote appears in a vbox, save the footnote text and create
6302*8044SWilliam.Kucharski@Sun.COM% the real \insert just after the vbox finished.  Otherwise, the insertion
6303*8044SWilliam.Kucharski@Sun.COM% would be lost.
6304*8044SWilliam.Kucharski@Sun.COM% Similarily, if a @footnote appears inside an alignment, save the footnote
6305*8044SWilliam.Kucharski@Sun.COM% text to a box and make the \insert when a row of the table is finished.
6306*8044SWilliam.Kucharski@Sun.COM% And the same can be done for other insert classes.  --kasal, 16nov03.
6307*8044SWilliam.Kucharski@Sun.COM
6308*8044SWilliam.Kucharski@Sun.COM% Replace the \insert primitive by a cheating macro.
6309*8044SWilliam.Kucharski@Sun.COM% Deeper inside, just make sure that the saved insertions are not spilled
6310*8044SWilliam.Kucharski@Sun.COM% out prematurely.
6311*8044SWilliam.Kucharski@Sun.COM%
6312*8044SWilliam.Kucharski@Sun.COM\def\startsavinginserts{%
6313*8044SWilliam.Kucharski@Sun.COM  \ifx \insert\ptexinsert
6314*8044SWilliam.Kucharski@Sun.COM    \let\insert\saveinsert
6315*8044SWilliam.Kucharski@Sun.COM  \else
6316*8044SWilliam.Kucharski@Sun.COM    \let\checkinserts\relax
6317*8044SWilliam.Kucharski@Sun.COM  \fi
6318*8044SWilliam.Kucharski@Sun.COM}
6319*8044SWilliam.Kucharski@Sun.COM
6320*8044SWilliam.Kucharski@Sun.COM% This \insert replacement works for both \insert\footins{foo} and
6321*8044SWilliam.Kucharski@Sun.COM% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6322*8044SWilliam.Kucharski@Sun.COM%
6323*8044SWilliam.Kucharski@Sun.COM\def\saveinsert#1{%
6324*8044SWilliam.Kucharski@Sun.COM  \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6325*8044SWilliam.Kucharski@Sun.COM  \afterassignment\next
6326*8044SWilliam.Kucharski@Sun.COM  % swallow the left brace
6327*8044SWilliam.Kucharski@Sun.COM  \let\temp =
6328*8044SWilliam.Kucharski@Sun.COM}
6329*8044SWilliam.Kucharski@Sun.COM\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6330*8044SWilliam.Kucharski@Sun.COM\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6331*8044SWilliam.Kucharski@Sun.COM
6332*8044SWilliam.Kucharski@Sun.COM\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6333*8044SWilliam.Kucharski@Sun.COM
6334*8044SWilliam.Kucharski@Sun.COM\def\placesaveins#1{%
6335*8044SWilliam.Kucharski@Sun.COM  \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6336*8044SWilliam.Kucharski@Sun.COM    {\box#1}%
6337*8044SWilliam.Kucharski@Sun.COM}
6338*8044SWilliam.Kucharski@Sun.COM
6339*8044SWilliam.Kucharski@Sun.COM% eat @SAVE -- beware, all of them have catcode \other:
6340*8044SWilliam.Kucharski@Sun.COM{
6341*8044SWilliam.Kucharski@Sun.COM  \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
6342*8044SWilliam.Kucharski@Sun.COM  \gdef\gobblesave @SAVE{}
6343*8044SWilliam.Kucharski@Sun.COM}
6344*8044SWilliam.Kucharski@Sun.COM
6345*8044SWilliam.Kucharski@Sun.COM% initialization:
6346*8044SWilliam.Kucharski@Sun.COM\def\newsaveins #1{%
6347*8044SWilliam.Kucharski@Sun.COM  \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6348*8044SWilliam.Kucharski@Sun.COM  \next
6349*8044SWilliam.Kucharski@Sun.COM}
6350*8044SWilliam.Kucharski@Sun.COM\def\newsaveinsX #1{%
6351*8044SWilliam.Kucharski@Sun.COM  \csname newbox\endcsname #1%
6352*8044SWilliam.Kucharski@Sun.COM  \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6353*8044SWilliam.Kucharski@Sun.COM    \checksaveins #1}%
6354*8044SWilliam.Kucharski@Sun.COM}
6355*8044SWilliam.Kucharski@Sun.COM
6356*8044SWilliam.Kucharski@Sun.COM% initialize:
6357*8044SWilliam.Kucharski@Sun.COM\let\checkinserts\empty
6358*8044SWilliam.Kucharski@Sun.COM\newsaveins\footins
6359*8044SWilliam.Kucharski@Sun.COM\newsaveins\margin
6360*8044SWilliam.Kucharski@Sun.COM
6361*8044SWilliam.Kucharski@Sun.COM
6362*8044SWilliam.Kucharski@Sun.COM% @image.  We use the macros from epsf.tex to support this.
6363*8044SWilliam.Kucharski@Sun.COM% If epsf.tex is not installed and @image is used, we complain.
6364*8044SWilliam.Kucharski@Sun.COM%
6365*8044SWilliam.Kucharski@Sun.COM% Check for and read epsf.tex up front.  If we read it only at @image
6366*8044SWilliam.Kucharski@Sun.COM% time, we might be inside a group, and then its definitions would get
6367*8044SWilliam.Kucharski@Sun.COM% undone and the next image would fail.
6368*8044SWilliam.Kucharski@Sun.COM\openin 1 = epsf.tex
6369*8044SWilliam.Kucharski@Sun.COM\ifeof 1 \else
6370*8044SWilliam.Kucharski@Sun.COM  % Do not bother showing banner with epsf.tex v2.7k (available in
6371*8044SWilliam.Kucharski@Sun.COM  % doc/epsf.tex and on ctan).
6372*8044SWilliam.Kucharski@Sun.COM  \def\epsfannounce{\toks0 = }%
6373*8044SWilliam.Kucharski@Sun.COM  \input epsf.tex
6374*8044SWilliam.Kucharski@Sun.COM\fi
6375*8044SWilliam.Kucharski@Sun.COM\closein 1
6376*8044SWilliam.Kucharski@Sun.COM%
6377*8044SWilliam.Kucharski@Sun.COM% We will only complain once about lack of epsf.tex.
6378*8044SWilliam.Kucharski@Sun.COM\newif\ifwarnednoepsf
6379*8044SWilliam.Kucharski@Sun.COM\newhelp\noepsfhelp{epsf.tex must be installed for images to
6380*8044SWilliam.Kucharski@Sun.COM  work.  It is also included in the Texinfo distribution, or you can get
6381*8044SWilliam.Kucharski@Sun.COM  it from ftp://tug.org/tex/epsf.tex.}
6382*8044SWilliam.Kucharski@Sun.COM%
6383*8044SWilliam.Kucharski@Sun.COM\def\image#1{%
6384*8044SWilliam.Kucharski@Sun.COM  \ifx\epsfbox\undefined
6385*8044SWilliam.Kucharski@Sun.COM    \ifwarnednoepsf \else
6386*8044SWilliam.Kucharski@Sun.COM      \errhelp = \noepsfhelp
6387*8044SWilliam.Kucharski@Sun.COM      \errmessage{epsf.tex not found, images will be ignored}%
6388*8044SWilliam.Kucharski@Sun.COM      \global\warnednoepsftrue
6389*8044SWilliam.Kucharski@Sun.COM    \fi
6390*8044SWilliam.Kucharski@Sun.COM  \else
6391*8044SWilliam.Kucharski@Sun.COM    \imagexxx #1,,,,,\finish
6392*8044SWilliam.Kucharski@Sun.COM  \fi
6393*8044SWilliam.Kucharski@Sun.COM}
6394*8044SWilliam.Kucharski@Sun.COM%
6395*8044SWilliam.Kucharski@Sun.COM% Arguments to @image:
6396*8044SWilliam.Kucharski@Sun.COM% #1 is (mandatory) image filename; we tack on .eps extension.
6397*8044SWilliam.Kucharski@Sun.COM% #2 is (optional) width, #3 is (optional) height.
6398*8044SWilliam.Kucharski@Sun.COM% #4 is (ignored optional) html alt text.
6399*8044SWilliam.Kucharski@Sun.COM% #5 is (ignored optional) extension.
6400*8044SWilliam.Kucharski@Sun.COM% #6 is just the usual extra ignored arg for parsing this stuff.
6401*8044SWilliam.Kucharski@Sun.COM\newif\ifimagevmode
6402*8044SWilliam.Kucharski@Sun.COM\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6403*8044SWilliam.Kucharski@Sun.COM  \catcode`\^^M = 5     % in case we're inside an example
6404*8044SWilliam.Kucharski@Sun.COM  \normalturnoffactive  % allow _ et al. in names
6405*8044SWilliam.Kucharski@Sun.COM  % If the image is by itself, center it.
6406*8044SWilliam.Kucharski@Sun.COM  \ifvmode
6407*8044SWilliam.Kucharski@Sun.COM    \imagevmodetrue
6408*8044SWilliam.Kucharski@Sun.COM    \nobreak\bigskip
6409*8044SWilliam.Kucharski@Sun.COM    % Usually we'll have text after the image which will insert
6410*8044SWilliam.Kucharski@Sun.COM    % \parskip glue, so insert it here too to equalize the space
6411*8044SWilliam.Kucharski@Sun.COM    % above and below.
6412*8044SWilliam.Kucharski@Sun.COM    \nobreak\vskip\parskip
6413*8044SWilliam.Kucharski@Sun.COM    \nobreak
6414*8044SWilliam.Kucharski@Sun.COM    \line\bgroup\hss
6415*8044SWilliam.Kucharski@Sun.COM  \fi
6416*8044SWilliam.Kucharski@Sun.COM  %
6417*8044SWilliam.Kucharski@Sun.COM  % Output the image.
6418*8044SWilliam.Kucharski@Sun.COM  \ifpdf
6419*8044SWilliam.Kucharski@Sun.COM    \dopdfimage{#1}{#2}{#3}%
6420*8044SWilliam.Kucharski@Sun.COM  \else
6421*8044SWilliam.Kucharski@Sun.COM    % \epsfbox itself resets \epsf?size at each figure.
6422*8044SWilliam.Kucharski@Sun.COM    \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6423*8044SWilliam.Kucharski@Sun.COM    \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6424*8044SWilliam.Kucharski@Sun.COM    \epsfbox{#1.eps}%
6425*8044SWilliam.Kucharski@Sun.COM  \fi
6426*8044SWilliam.Kucharski@Sun.COM  %
6427*8044SWilliam.Kucharski@Sun.COM  \ifimagevmode \hss \egroup \bigbreak \fi  % space after the image
6428*8044SWilliam.Kucharski@Sun.COM\endgroup}
6429*8044SWilliam.Kucharski@Sun.COM
6430*8044SWilliam.Kucharski@Sun.COM
6431*8044SWilliam.Kucharski@Sun.COM% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6432*8044SWilliam.Kucharski@Sun.COM% etc.  We don't actually implement floating yet, we always include the
6433*8044SWilliam.Kucharski@Sun.COM% float "here".  But it seemed the best name for the future.
6434*8044SWilliam.Kucharski@Sun.COM%
6435*8044SWilliam.Kucharski@Sun.COM\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6436*8044SWilliam.Kucharski@Sun.COM
6437*8044SWilliam.Kucharski@Sun.COM% There may be a space before second and/or third parameter; delete it.
6438*8044SWilliam.Kucharski@Sun.COM\def\eatcommaspace#1, {#1,}
6439*8044SWilliam.Kucharski@Sun.COM
6440*8044SWilliam.Kucharski@Sun.COM% #1 is the optional FLOATTYPE, the text label for this float, typically
6441*8044SWilliam.Kucharski@Sun.COM% "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
6442*8044SWilliam.Kucharski@Sun.COM% this float will not be numbered and cannot be referred to.
6443*8044SWilliam.Kucharski@Sun.COM%
6444*8044SWilliam.Kucharski@Sun.COM% #2 is the optional xref label.  Also must be present for the float to
6445*8044SWilliam.Kucharski@Sun.COM% be referable.
6446*8044SWilliam.Kucharski@Sun.COM%
6447*8044SWilliam.Kucharski@Sun.COM% #3 is the optional positioning argument; for now, it is ignored.  It
6448*8044SWilliam.Kucharski@Sun.COM% will somehow specify the positions allowed to float to (here, top, bottom).
6449*8044SWilliam.Kucharski@Sun.COM%
6450*8044SWilliam.Kucharski@Sun.COM% We keep a separate counter for each FLOATTYPE, which we reset at each
6451*8044SWilliam.Kucharski@Sun.COM% chapter-level command.
6452*8044SWilliam.Kucharski@Sun.COM\let\resetallfloatnos=\empty
6453*8044SWilliam.Kucharski@Sun.COM%
6454*8044SWilliam.Kucharski@Sun.COM\def\dofloat#1,#2,#3,#4\finish{%
6455*8044SWilliam.Kucharski@Sun.COM  \let\thiscaption=\empty
6456*8044SWilliam.Kucharski@Sun.COM  \let\thisshortcaption=\empty
6457*8044SWilliam.Kucharski@Sun.COM  %
6458*8044SWilliam.Kucharski@Sun.COM  % don't lose footnotes inside @float.
6459*8044SWilliam.Kucharski@Sun.COM  %
6460*8044SWilliam.Kucharski@Sun.COM  % BEWARE: when the floats start float, we have to issue warning whenever an
6461*8044SWilliam.Kucharski@Sun.COM  % insert appears inside a float which could possibly float. --kasal, 26may04
6462*8044SWilliam.Kucharski@Sun.COM  %
6463*8044SWilliam.Kucharski@Sun.COM  \startsavinginserts
6464*8044SWilliam.Kucharski@Sun.COM  %
6465*8044SWilliam.Kucharski@Sun.COM  % We can't be used inside a paragraph.
6466*8044SWilliam.Kucharski@Sun.COM  \par
6467*8044SWilliam.Kucharski@Sun.COM  %
6468*8044SWilliam.Kucharski@Sun.COM  \vtop\bgroup
6469*8044SWilliam.Kucharski@Sun.COM    \def\floattype{#1}%
6470*8044SWilliam.Kucharski@Sun.COM    \def\floatlabel{#2}%
6471*8044SWilliam.Kucharski@Sun.COM    \def\floatloc{#3}% we do nothing with this yet.
6472*8044SWilliam.Kucharski@Sun.COM    %
6473*8044SWilliam.Kucharski@Sun.COM    \ifx\floattype\empty
6474*8044SWilliam.Kucharski@Sun.COM      \let\safefloattype=\empty
6475*8044SWilliam.Kucharski@Sun.COM    \else
6476*8044SWilliam.Kucharski@Sun.COM      {%
6477*8044SWilliam.Kucharski@Sun.COM        % the floattype might have accents or other special characters,
6478*8044SWilliam.Kucharski@Sun.COM        % but we need to use it in a control sequence name.
6479*8044SWilliam.Kucharski@Sun.COM        \indexnofonts
6480*8044SWilliam.Kucharski@Sun.COM        \turnoffactive
6481*8044SWilliam.Kucharski@Sun.COM        \xdef\safefloattype{\floattype}%
6482*8044SWilliam.Kucharski@Sun.COM      }%
6483*8044SWilliam.Kucharski@Sun.COM    \fi
6484*8044SWilliam.Kucharski@Sun.COM    %
6485*8044SWilliam.Kucharski@Sun.COM    % If label is given but no type, we handle that as the empty type.
6486*8044SWilliam.Kucharski@Sun.COM    \ifx\floatlabel\empty \else
6487*8044SWilliam.Kucharski@Sun.COM      % We want each FLOATTYPE to be numbered separately (Figure 1,
6488*8044SWilliam.Kucharski@Sun.COM      % Table 1, Figure 2, ...).  (And if no label, no number.)
6489*8044SWilliam.Kucharski@Sun.COM      %
6490*8044SWilliam.Kucharski@Sun.COM      \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6491*8044SWilliam.Kucharski@Sun.COM      \global\advance\floatno by 1
6492*8044SWilliam.Kucharski@Sun.COM      %
6493*8044SWilliam.Kucharski@Sun.COM      {%
6494*8044SWilliam.Kucharski@Sun.COM        % This magic value for \thissection is output by \setref as the
6495*8044SWilliam.Kucharski@Sun.COM        % XREFLABEL-title value.  \xrefX uses it to distinguish float
6496*8044SWilliam.Kucharski@Sun.COM        % labels (which have a completely different output format) from
6497*8044SWilliam.Kucharski@Sun.COM        % node and anchor labels.  And \xrdef uses it to construct the
6498*8044SWilliam.Kucharski@Sun.COM        % lists of floats.
6499*8044SWilliam.Kucharski@Sun.COM        %
6500*8044SWilliam.Kucharski@Sun.COM        \edef\thissection{\floatmagic=\safefloattype}%
6501*8044SWilliam.Kucharski@Sun.COM        \setref{\floatlabel}{Yfloat}%
6502*8044SWilliam.Kucharski@Sun.COM      }%
6503*8044SWilliam.Kucharski@Sun.COM    \fi
6504*8044SWilliam.Kucharski@Sun.COM    %
6505*8044SWilliam.Kucharski@Sun.COM    % start with \parskip glue, I guess.
6506*8044SWilliam.Kucharski@Sun.COM    \vskip\parskip
6507*8044SWilliam.Kucharski@Sun.COM    %
6508*8044SWilliam.Kucharski@Sun.COM    % Don't suppress indentation if a float happens to start a section.
6509*8044SWilliam.Kucharski@Sun.COM    \restorefirstparagraphindent
6510*8044SWilliam.Kucharski@Sun.COM}
6511*8044SWilliam.Kucharski@Sun.COM
6512*8044SWilliam.Kucharski@Sun.COM% we have these possibilities:
6513*8044SWilliam.Kucharski@Sun.COM% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6514*8044SWilliam.Kucharski@Sun.COM% @float Foo,lbl & no caption:    Foo 1.1
6515*8044SWilliam.Kucharski@Sun.COM% @float Foo & @caption{Cap}:     Foo: Cap
6516*8044SWilliam.Kucharski@Sun.COM% @float Foo & no caption:        Foo
6517*8044SWilliam.Kucharski@Sun.COM% @float ,lbl & Caption{Cap}:     1.1: Cap
6518*8044SWilliam.Kucharski@Sun.COM% @float ,lbl & no caption:       1.1
6519*8044SWilliam.Kucharski@Sun.COM% @float & @caption{Cap}:         Cap
6520*8044SWilliam.Kucharski@Sun.COM% @float & no caption:
6521*8044SWilliam.Kucharski@Sun.COM%
6522*8044SWilliam.Kucharski@Sun.COM\def\Efloat{%
6523*8044SWilliam.Kucharski@Sun.COM    \let\floatident = \empty
6524*8044SWilliam.Kucharski@Sun.COM    %
6525*8044SWilliam.Kucharski@Sun.COM    % In all cases, if we have a float type, it comes first.
6526*8044SWilliam.Kucharski@Sun.COM    \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6527*8044SWilliam.Kucharski@Sun.COM    %
6528*8044SWilliam.Kucharski@Sun.COM    % If we have an xref label, the number comes next.
6529*8044SWilliam.Kucharski@Sun.COM    \ifx\floatlabel\empty \else
6530*8044SWilliam.Kucharski@Sun.COM      \ifx\floattype\empty \else % if also had float type, need tie first.
6531*8044SWilliam.Kucharski@Sun.COM        \appendtomacro\floatident{\tie}%
6532*8044SWilliam.Kucharski@Sun.COM      \fi
6533*8044SWilliam.Kucharski@Sun.COM      % the number.
6534*8044SWilliam.Kucharski@Sun.COM      \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6535*8044SWilliam.Kucharski@Sun.COM    \fi
6536*8044SWilliam.Kucharski@Sun.COM    %
6537*8044SWilliam.Kucharski@Sun.COM    % Start the printed caption with what we've constructed in
6538*8044SWilliam.Kucharski@Sun.COM    % \floatident, but keep it separate; we need \floatident again.
6539*8044SWilliam.Kucharski@Sun.COM    \let\captionline = \floatident
6540*8044SWilliam.Kucharski@Sun.COM    %
6541*8044SWilliam.Kucharski@Sun.COM    \ifx\thiscaption\empty \else
6542*8044SWilliam.Kucharski@Sun.COM      \ifx\floatident\empty \else
6543*8044SWilliam.Kucharski@Sun.COM	\appendtomacro\captionline{: }% had ident, so need a colon between
6544*8044SWilliam.Kucharski@Sun.COM      \fi
6545*8044SWilliam.Kucharski@Sun.COM      %
6546*8044SWilliam.Kucharski@Sun.COM      % caption text.
6547*8044SWilliam.Kucharski@Sun.COM      \appendtomacro\captionline{\scanexp\thiscaption}%
6548*8044SWilliam.Kucharski@Sun.COM    \fi
6549*8044SWilliam.Kucharski@Sun.COM    %
6550*8044SWilliam.Kucharski@Sun.COM    % If we have anything to print, print it, with space before.
6551*8044SWilliam.Kucharski@Sun.COM    % Eventually this needs to become an \insert.
6552*8044SWilliam.Kucharski@Sun.COM    \ifx\captionline\empty \else
6553*8044SWilliam.Kucharski@Sun.COM      \vskip.5\parskip
6554*8044SWilliam.Kucharski@Sun.COM      \captionline
6555*8044SWilliam.Kucharski@Sun.COM      %
6556*8044SWilliam.Kucharski@Sun.COM      % Space below caption.
6557*8044SWilliam.Kucharski@Sun.COM      \vskip\parskip
6558*8044SWilliam.Kucharski@Sun.COM    \fi
6559*8044SWilliam.Kucharski@Sun.COM    %
6560*8044SWilliam.Kucharski@Sun.COM    % If have an xref label, write the list of floats info.  Do this
6561*8044SWilliam.Kucharski@Sun.COM    % after the caption, to avoid chance of it being a breakpoint.
6562*8044SWilliam.Kucharski@Sun.COM    \ifx\floatlabel\empty \else
6563*8044SWilliam.Kucharski@Sun.COM      % Write the text that goes in the lof to the aux file as
6564*8044SWilliam.Kucharski@Sun.COM      % \floatlabel-lof.  Besides \floatident, we include the short
6565*8044SWilliam.Kucharski@Sun.COM      % caption if specified, else the full caption if specified, else nothing.
6566*8044SWilliam.Kucharski@Sun.COM      {%
6567*8044SWilliam.Kucharski@Sun.COM        \atdummies \turnoffactive \otherbackslash
6568*8044SWilliam.Kucharski@Sun.COM        % since we read the caption text in the macro world, where ^^M
6569*8044SWilliam.Kucharski@Sun.COM        % is turned into a normal character, we have to scan it back, so
6570*8044SWilliam.Kucharski@Sun.COM        % we don't write the literal three characters "^^M" into the aux file.
6571*8044SWilliam.Kucharski@Sun.COM	\scanexp{%
6572*8044SWilliam.Kucharski@Sun.COM	  \xdef\noexpand\gtemp{%
6573*8044SWilliam.Kucharski@Sun.COM	    \ifx\thisshortcaption\empty
6574*8044SWilliam.Kucharski@Sun.COM	      \thiscaption
6575*8044SWilliam.Kucharski@Sun.COM	    \else
6576*8044SWilliam.Kucharski@Sun.COM	      \thisshortcaption
6577*8044SWilliam.Kucharski@Sun.COM	    \fi
6578*8044SWilliam.Kucharski@Sun.COM	  }%
6579*8044SWilliam.Kucharski@Sun.COM	}%
6580*8044SWilliam.Kucharski@Sun.COM        \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6581*8044SWilliam.Kucharski@Sun.COM	  \ifx\gtemp\empty \else : \gtemp \fi}}%
6582*8044SWilliam.Kucharski@Sun.COM      }%
6583*8044SWilliam.Kucharski@Sun.COM    \fi
6584*8044SWilliam.Kucharski@Sun.COM  \egroup  % end of \vtop
6585*8044SWilliam.Kucharski@Sun.COM  %
6586*8044SWilliam.Kucharski@Sun.COM  % place the captured inserts
6587*8044SWilliam.Kucharski@Sun.COM  %
6588*8044SWilliam.Kucharski@Sun.COM  % BEWARE: when the floats start float, we have to issue warning whenever an
6589*8044SWilliam.Kucharski@Sun.COM  % insert appears inside a float which could possibly float. --kasal, 26may04
6590*8044SWilliam.Kucharski@Sun.COM  %
6591*8044SWilliam.Kucharski@Sun.COM  \checkinserts
6592*8044SWilliam.Kucharski@Sun.COM}
6593*8044SWilliam.Kucharski@Sun.COM
6594*8044SWilliam.Kucharski@Sun.COM% Append the tokens #2 to the definition of macro #1, not expanding either.
6595*8044SWilliam.Kucharski@Sun.COM%
6596*8044SWilliam.Kucharski@Sun.COM\def\appendtomacro#1#2{%
6597*8044SWilliam.Kucharski@Sun.COM  \expandafter\def\expandafter#1\expandafter{#1#2}%
6598*8044SWilliam.Kucharski@Sun.COM}
6599*8044SWilliam.Kucharski@Sun.COM
6600*8044SWilliam.Kucharski@Sun.COM% @caption, @shortcaption
6601*8044SWilliam.Kucharski@Sun.COM%
6602*8044SWilliam.Kucharski@Sun.COM\def\caption{\docaption\thiscaption}
6603*8044SWilliam.Kucharski@Sun.COM\def\shortcaption{\docaption\thisshortcaption}
6604*8044SWilliam.Kucharski@Sun.COM\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6605*8044SWilliam.Kucharski@Sun.COM\def\defcaption#1#2{\egroup \def#1{#2}}
6606*8044SWilliam.Kucharski@Sun.COM
6607*8044SWilliam.Kucharski@Sun.COM% The parameter is the control sequence identifying the counter we are
6608*8044SWilliam.Kucharski@Sun.COM% going to use.  Create it if it doesn't exist and assign it to \floatno.
6609*8044SWilliam.Kucharski@Sun.COM\def\getfloatno#1{%
6610*8044SWilliam.Kucharski@Sun.COM  \ifx#1\relax
6611*8044SWilliam.Kucharski@Sun.COM      % Haven't seen this figure type before.
6612*8044SWilliam.Kucharski@Sun.COM      \csname newcount\endcsname #1%
6613*8044SWilliam.Kucharski@Sun.COM      %
6614*8044SWilliam.Kucharski@Sun.COM      % Remember to reset this floatno at the next chap.
6615*8044SWilliam.Kucharski@Sun.COM      \expandafter\gdef\expandafter\resetallfloatnos
6616*8044SWilliam.Kucharski@Sun.COM        \expandafter{\resetallfloatnos #1=0 }%
6617*8044SWilliam.Kucharski@Sun.COM  \fi
6618*8044SWilliam.Kucharski@Sun.COM  \let\floatno#1%
6619*8044SWilliam.Kucharski@Sun.COM}
6620*8044SWilliam.Kucharski@Sun.COM
6621*8044SWilliam.Kucharski@Sun.COM% \setref calls this to get the XREFLABEL-snt value.  We want an @xref
6622*8044SWilliam.Kucharski@Sun.COM% to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
6623*8044SWilliam.Kucharski@Sun.COM% first read the @float command.
6624*8044SWilliam.Kucharski@Sun.COM%
6625*8044SWilliam.Kucharski@Sun.COM\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6626*8044SWilliam.Kucharski@Sun.COM
6627*8044SWilliam.Kucharski@Sun.COM% Magic string used for the XREFLABEL-title value, so \xrefX can
6628*8044SWilliam.Kucharski@Sun.COM% distinguish floats from other xref types.
6629*8044SWilliam.Kucharski@Sun.COM\def\floatmagic{!!float!!}
6630*8044SWilliam.Kucharski@Sun.COM
6631*8044SWilliam.Kucharski@Sun.COM% #1 is the control sequence we are passed; we expand into a conditional
6632*8044SWilliam.Kucharski@Sun.COM% which is true if #1 represents a float ref.  That is, the magic
6633*8044SWilliam.Kucharski@Sun.COM% \thissection value which we \setref above.
6634*8044SWilliam.Kucharski@Sun.COM%
6635*8044SWilliam.Kucharski@Sun.COM\def\iffloat#1{\expandafter\doiffloat#1==\finish}
6636*8044SWilliam.Kucharski@Sun.COM%
6637*8044SWilliam.Kucharski@Sun.COM% #1 is (maybe) the \floatmagic string.  If so, #2 will be the
6638*8044SWilliam.Kucharski@Sun.COM% (safe) float type for this float.  We set \iffloattype to #2.
6639*8044SWilliam.Kucharski@Sun.COM%
6640*8044SWilliam.Kucharski@Sun.COM\def\doiffloat#1=#2=#3\finish{%
6641*8044SWilliam.Kucharski@Sun.COM  \def\temp{#1}%
6642*8044SWilliam.Kucharski@Sun.COM  \def\iffloattype{#2}%
6643*8044SWilliam.Kucharski@Sun.COM  \ifx\temp\floatmagic
6644*8044SWilliam.Kucharski@Sun.COM}
6645*8044SWilliam.Kucharski@Sun.COM
6646*8044SWilliam.Kucharski@Sun.COM% @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6647*8044SWilliam.Kucharski@Sun.COM%
6648*8044SWilliam.Kucharski@Sun.COM\parseargdef\listoffloats{%
6649*8044SWilliam.Kucharski@Sun.COM  \def\floattype{#1}% floattype
6650*8044SWilliam.Kucharski@Sun.COM  {%
6651*8044SWilliam.Kucharski@Sun.COM    % the floattype might have accents or other special characters,
6652*8044SWilliam.Kucharski@Sun.COM    % but we need to use it in a control sequence name.
6653*8044SWilliam.Kucharski@Sun.COM    \indexnofonts
6654*8044SWilliam.Kucharski@Sun.COM    \turnoffactive
6655*8044SWilliam.Kucharski@Sun.COM    \xdef\safefloattype{\floattype}%
6656*8044SWilliam.Kucharski@Sun.COM  }%
6657*8044SWilliam.Kucharski@Sun.COM  %
6658*8044SWilliam.Kucharski@Sun.COM  % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6659*8044SWilliam.Kucharski@Sun.COM  \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6660*8044SWilliam.Kucharski@Sun.COM    \ifhavexrefs
6661*8044SWilliam.Kucharski@Sun.COM      % if the user said @listoffloats foo but never @float foo.
6662*8044SWilliam.Kucharski@Sun.COM      \message{\linenumber No `\safefloattype' floats to list.}%
6663*8044SWilliam.Kucharski@Sun.COM    \fi
6664*8044SWilliam.Kucharski@Sun.COM  \else
6665*8044SWilliam.Kucharski@Sun.COM    \begingroup
6666*8044SWilliam.Kucharski@Sun.COM      \leftskip=\tocindent  % indent these entries like a toc
6667*8044SWilliam.Kucharski@Sun.COM      \let\do=\listoffloatsdo
6668*8044SWilliam.Kucharski@Sun.COM      \csname floatlist\safefloattype\endcsname
6669*8044SWilliam.Kucharski@Sun.COM    \endgroup
6670*8044SWilliam.Kucharski@Sun.COM  \fi
6671*8044SWilliam.Kucharski@Sun.COM}
6672*8044SWilliam.Kucharski@Sun.COM
6673*8044SWilliam.Kucharski@Sun.COM% This is called on each entry in a list of floats.  We're passed the
6674*8044SWilliam.Kucharski@Sun.COM% xref label, in the form LABEL-title, which is how we save it in the
6675*8044SWilliam.Kucharski@Sun.COM% aux file.  We strip off the -title and look up \XRLABEL-lof, which
6676*8044SWilliam.Kucharski@Sun.COM% has the text we're supposed to typeset here.
6677*8044SWilliam.Kucharski@Sun.COM%
6678*8044SWilliam.Kucharski@Sun.COM% Figures without xref labels will not be included in the list (since
6679*8044SWilliam.Kucharski@Sun.COM% they won't appear in the aux file).
6680*8044SWilliam.Kucharski@Sun.COM%
6681*8044SWilliam.Kucharski@Sun.COM\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6682*8044SWilliam.Kucharski@Sun.COM\def\listoffloatsdoentry#1-title\finish{{%
6683*8044SWilliam.Kucharski@Sun.COM  % Can't fully expand XR#1-lof because it can contain anything.  Just
6684*8044SWilliam.Kucharski@Sun.COM  % pass the control sequence.  On the other hand, XR#1-pg is just the
6685*8044SWilliam.Kucharski@Sun.COM  % page number, and we want to fully expand that so we can get a link
6686*8044SWilliam.Kucharski@Sun.COM  % in pdf output.
6687*8044SWilliam.Kucharski@Sun.COM  \toksA = \expandafter{\csname XR#1-lof\endcsname}%
6688*8044SWilliam.Kucharski@Sun.COM  %
6689*8044SWilliam.Kucharski@Sun.COM  % use the same \entry macro we use to generate the TOC and index.
6690*8044SWilliam.Kucharski@Sun.COM  \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
6691*8044SWilliam.Kucharski@Sun.COM  \writeentry
6692*8044SWilliam.Kucharski@Sun.COM}}
6693*8044SWilliam.Kucharski@Sun.COM
6694*8044SWilliam.Kucharski@Sun.COM\message{localization,}
6695*8044SWilliam.Kucharski@Sun.COM% and i18n.
6696*8044SWilliam.Kucharski@Sun.COM
6697*8044SWilliam.Kucharski@Sun.COM% @documentlanguage is usually given very early, just after
6698*8044SWilliam.Kucharski@Sun.COM% @setfilename.  If done too late, it may not override everything
6699*8044SWilliam.Kucharski@Sun.COM% properly.  Single argument is the language abbreviation.
6700*8044SWilliam.Kucharski@Sun.COM% It would be nice if we could set up a hyphenation file here.
6701*8044SWilliam.Kucharski@Sun.COM%
6702*8044SWilliam.Kucharski@Sun.COM\parseargdef\documentlanguage{%
6703*8044SWilliam.Kucharski@Sun.COM  \tex % read txi-??.tex file in plain TeX.
6704*8044SWilliam.Kucharski@Sun.COM    % Read the file if it exists.
6705*8044SWilliam.Kucharski@Sun.COM    \openin 1 txi-#1.tex
6706*8044SWilliam.Kucharski@Sun.COM    \ifeof 1
6707*8044SWilliam.Kucharski@Sun.COM      \errhelp = \nolanghelp
6708*8044SWilliam.Kucharski@Sun.COM      \errmessage{Cannot read language file txi-#1.tex}%
6709*8044SWilliam.Kucharski@Sun.COM    \else
6710*8044SWilliam.Kucharski@Sun.COM      \input txi-#1.tex
6711*8044SWilliam.Kucharski@Sun.COM    \fi
6712*8044SWilliam.Kucharski@Sun.COM    \closein 1
6713*8044SWilliam.Kucharski@Sun.COM  \endgroup
6714*8044SWilliam.Kucharski@Sun.COM}
6715*8044SWilliam.Kucharski@Sun.COM\newhelp\nolanghelp{The given language definition file cannot be found or
6716*8044SWilliam.Kucharski@Sun.COMis empty.  Maybe you need to install it?  In the current directory
6717*8044SWilliam.Kucharski@Sun.COMshould work if nowhere else does.}
6718*8044SWilliam.Kucharski@Sun.COM
6719*8044SWilliam.Kucharski@Sun.COM
6720*8044SWilliam.Kucharski@Sun.COM% @documentencoding should change something in TeX eventually, most
6721*8044SWilliam.Kucharski@Sun.COM% likely, but for now just recognize it.
6722*8044SWilliam.Kucharski@Sun.COM\let\documentencoding = \comment
6723*8044SWilliam.Kucharski@Sun.COM
6724*8044SWilliam.Kucharski@Sun.COM
6725*8044SWilliam.Kucharski@Sun.COM% Page size parameters.
6726*8044SWilliam.Kucharski@Sun.COM%
6727*8044SWilliam.Kucharski@Sun.COM\newdimen\defaultparindent \defaultparindent = 15pt
6728*8044SWilliam.Kucharski@Sun.COM
6729*8044SWilliam.Kucharski@Sun.COM\chapheadingskip = 15pt plus 4pt minus 2pt
6730*8044SWilliam.Kucharski@Sun.COM\secheadingskip = 12pt plus 3pt minus 2pt
6731*8044SWilliam.Kucharski@Sun.COM\subsecheadingskip = 9pt plus 2pt minus 2pt
6732*8044SWilliam.Kucharski@Sun.COM
6733*8044SWilliam.Kucharski@Sun.COM% Prevent underfull vbox error messages.
6734*8044SWilliam.Kucharski@Sun.COM\vbadness = 10000
6735*8044SWilliam.Kucharski@Sun.COM
6736*8044SWilliam.Kucharski@Sun.COM% Don't be so finicky about underfull hboxes, either.
6737*8044SWilliam.Kucharski@Sun.COM\hbadness = 2000
6738*8044SWilliam.Kucharski@Sun.COM
6739*8044SWilliam.Kucharski@Sun.COM% Following George Bush, just get rid of widows and orphans.
6740*8044SWilliam.Kucharski@Sun.COM\widowpenalty=10000
6741*8044SWilliam.Kucharski@Sun.COM\clubpenalty=10000
6742*8044SWilliam.Kucharski@Sun.COM
6743*8044SWilliam.Kucharski@Sun.COM% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6744*8044SWilliam.Kucharski@Sun.COM% using an old version of TeX, don't do anything.  We want the amount of
6745*8044SWilliam.Kucharski@Sun.COM% stretch added to depend on the line length, hence the dependence on
6746*8044SWilliam.Kucharski@Sun.COM% \hsize.  We call this whenever the paper size is set.
6747*8044SWilliam.Kucharski@Sun.COM%
6748*8044SWilliam.Kucharski@Sun.COM\def\setemergencystretch{%
6749*8044SWilliam.Kucharski@Sun.COM  \ifx\emergencystretch\thisisundefined
6750*8044SWilliam.Kucharski@Sun.COM    % Allow us to assign to \emergencystretch anyway.
6751*8044SWilliam.Kucharski@Sun.COM    \def\emergencystretch{\dimen0}%
6752*8044SWilliam.Kucharski@Sun.COM  \else
6753*8044SWilliam.Kucharski@Sun.COM    \emergencystretch = .15\hsize
6754*8044SWilliam.Kucharski@Sun.COM  \fi
6755*8044SWilliam.Kucharski@Sun.COM}
6756*8044SWilliam.Kucharski@Sun.COM
6757*8044SWilliam.Kucharski@Sun.COM% Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6758*8044SWilliam.Kucharski@Sun.COM% 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6759*8044SWilliam.Kucharski@Sun.COM% physical page width.
6760*8044SWilliam.Kucharski@Sun.COM%
6761*8044SWilliam.Kucharski@Sun.COM% We also call \setleading{\textleading}, so the caller should define
6762*8044SWilliam.Kucharski@Sun.COM% \textleading.  The caller should also set \parskip.
6763*8044SWilliam.Kucharski@Sun.COM%
6764*8044SWilliam.Kucharski@Sun.COM\def\internalpagesizes#1#2#3#4#5#6#7#8{%
6765*8044SWilliam.Kucharski@Sun.COM  \voffset = #3\relax
6766*8044SWilliam.Kucharski@Sun.COM  \topskip = #6\relax
6767*8044SWilliam.Kucharski@Sun.COM  \splittopskip = \topskip
6768*8044SWilliam.Kucharski@Sun.COM  %
6769*8044SWilliam.Kucharski@Sun.COM  \vsize = #1\relax
6770*8044SWilliam.Kucharski@Sun.COM  \advance\vsize by \topskip
6771*8044SWilliam.Kucharski@Sun.COM  \outervsize = \vsize
6772*8044SWilliam.Kucharski@Sun.COM  \advance\outervsize by 2\topandbottommargin
6773*8044SWilliam.Kucharski@Sun.COM  \pageheight = \vsize
6774*8044SWilliam.Kucharski@Sun.COM  %
6775*8044SWilliam.Kucharski@Sun.COM  \hsize = #2\relax
6776*8044SWilliam.Kucharski@Sun.COM  \outerhsize = \hsize
6777*8044SWilliam.Kucharski@Sun.COM  \advance\outerhsize by 0.5in
6778*8044SWilliam.Kucharski@Sun.COM  \pagewidth = \hsize
6779*8044SWilliam.Kucharski@Sun.COM  %
6780*8044SWilliam.Kucharski@Sun.COM  \normaloffset = #4\relax
6781*8044SWilliam.Kucharski@Sun.COM  \bindingoffset = #5\relax
6782*8044SWilliam.Kucharski@Sun.COM  %
6783*8044SWilliam.Kucharski@Sun.COM  \ifpdf
6784*8044SWilliam.Kucharski@Sun.COM    \pdfpageheight #7\relax
6785*8044SWilliam.Kucharski@Sun.COM    \pdfpagewidth #8\relax
6786*8044SWilliam.Kucharski@Sun.COM  \fi
6787*8044SWilliam.Kucharski@Sun.COM  %
6788*8044SWilliam.Kucharski@Sun.COM  \setleading{\textleading}
6789*8044SWilliam.Kucharski@Sun.COM  %
6790*8044SWilliam.Kucharski@Sun.COM  \parindent = \defaultparindent
6791*8044SWilliam.Kucharski@Sun.COM  \setemergencystretch
6792*8044SWilliam.Kucharski@Sun.COM}
6793*8044SWilliam.Kucharski@Sun.COM
6794*8044SWilliam.Kucharski@Sun.COM% @letterpaper (the default).
6795*8044SWilliam.Kucharski@Sun.COM\def\letterpaper{{\globaldefs = 1
6796*8044SWilliam.Kucharski@Sun.COM  \parskip = 3pt plus 2pt minus 1pt
6797*8044SWilliam.Kucharski@Sun.COM  \textleading = 13.2pt
6798*8044SWilliam.Kucharski@Sun.COM  %
6799*8044SWilliam.Kucharski@Sun.COM  % If page is nothing but text, make it come out even.
6800*8044SWilliam.Kucharski@Sun.COM  \internalpagesizes{46\baselineskip}{6in}%
6801*8044SWilliam.Kucharski@Sun.COM                    {\voffset}{.25in}%
6802*8044SWilliam.Kucharski@Sun.COM                    {\bindingoffset}{36pt}%
6803*8044SWilliam.Kucharski@Sun.COM                    {11in}{8.5in}%
6804*8044SWilliam.Kucharski@Sun.COM}}
6805*8044SWilliam.Kucharski@Sun.COM
6806*8044SWilliam.Kucharski@Sun.COM% Use @smallbook to reset parameters for 7x9.5 (or so) format.
6807*8044SWilliam.Kucharski@Sun.COM\def\smallbook{{\globaldefs = 1
6808*8044SWilliam.Kucharski@Sun.COM  \parskip = 2pt plus 1pt
6809*8044SWilliam.Kucharski@Sun.COM  \textleading = 12pt
6810*8044SWilliam.Kucharski@Sun.COM  %
6811*8044SWilliam.Kucharski@Sun.COM  \internalpagesizes{7.5in}{5in}%
6812*8044SWilliam.Kucharski@Sun.COM                    {\voffset}{.25in}%
6813*8044SWilliam.Kucharski@Sun.COM                    {\bindingoffset}{16pt}%
6814*8044SWilliam.Kucharski@Sun.COM                    {9.25in}{7in}%
6815*8044SWilliam.Kucharski@Sun.COM  %
6816*8044SWilliam.Kucharski@Sun.COM  \lispnarrowing = 0.3in
6817*8044SWilliam.Kucharski@Sun.COM  \tolerance = 700
6818*8044SWilliam.Kucharski@Sun.COM  \hfuzz = 1pt
6819*8044SWilliam.Kucharski@Sun.COM  \contentsrightmargin = 0pt
6820*8044SWilliam.Kucharski@Sun.COM  \defbodyindent = .5cm
6821*8044SWilliam.Kucharski@Sun.COM}}
6822*8044SWilliam.Kucharski@Sun.COM
6823*8044SWilliam.Kucharski@Sun.COM% Use @afourpaper to print on European A4 paper.
6824*8044SWilliam.Kucharski@Sun.COM\def\afourpaper{{\globaldefs = 1
6825*8044SWilliam.Kucharski@Sun.COM  \parskip = 3pt plus 2pt minus 1pt
6826*8044SWilliam.Kucharski@Sun.COM  \textleading = 13.2pt
6827*8044SWilliam.Kucharski@Sun.COM  %
6828*8044SWilliam.Kucharski@Sun.COM  % Double-side printing via postscript on Laserjet 4050
6829*8044SWilliam.Kucharski@Sun.COM  % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6830*8044SWilliam.Kucharski@Sun.COM  % To change the settings for a different printer or situation, adjust
6831*8044SWilliam.Kucharski@Sun.COM  % \normaloffset until the front-side and back-side texts align.  Then
6832*8044SWilliam.Kucharski@Sun.COM  % do the same for \bindingoffset.  You can set these for testing in
6833*8044SWilliam.Kucharski@Sun.COM  % your texinfo source file like this:
6834*8044SWilliam.Kucharski@Sun.COM  % @tex
6835*8044SWilliam.Kucharski@Sun.COM  % \global\normaloffset = -6mm
6836*8044SWilliam.Kucharski@Sun.COM  % \global\bindingoffset = 10mm
6837*8044SWilliam.Kucharski@Sun.COM  % @end tex
6838*8044SWilliam.Kucharski@Sun.COM  \internalpagesizes{51\baselineskip}{160mm}
6839*8044SWilliam.Kucharski@Sun.COM                    {\voffset}{\hoffset}%
6840*8044SWilliam.Kucharski@Sun.COM                    {\bindingoffset}{44pt}%
6841*8044SWilliam.Kucharski@Sun.COM                    {297mm}{210mm}%
6842*8044SWilliam.Kucharski@Sun.COM  %
6843*8044SWilliam.Kucharski@Sun.COM  \tolerance = 700
6844*8044SWilliam.Kucharski@Sun.COM  \hfuzz = 1pt
6845*8044SWilliam.Kucharski@Sun.COM  \contentsrightmargin = 0pt
6846*8044SWilliam.Kucharski@Sun.COM  \defbodyindent = 5mm
6847*8044SWilliam.Kucharski@Sun.COM}}
6848*8044SWilliam.Kucharski@Sun.COM
6849*8044SWilliam.Kucharski@Sun.COM% Use @afivepaper to print on European A5 paper.
6850*8044SWilliam.Kucharski@Sun.COM% From romildo@urano.iceb.ufop.br, 2 July 2000.
6851*8044SWilliam.Kucharski@Sun.COM% He also recommends making @example and @lisp be small.
6852*8044SWilliam.Kucharski@Sun.COM\def\afivepaper{{\globaldefs = 1
6853*8044SWilliam.Kucharski@Sun.COM  \parskip = 2pt plus 1pt minus 0.1pt
6854*8044SWilliam.Kucharski@Sun.COM  \textleading = 12.5pt
6855*8044SWilliam.Kucharski@Sun.COM  %
6856*8044SWilliam.Kucharski@Sun.COM  \internalpagesizes{160mm}{120mm}%
6857*8044SWilliam.Kucharski@Sun.COM                    {\voffset}{\hoffset}%
6858*8044SWilliam.Kucharski@Sun.COM                    {\bindingoffset}{8pt}%
6859*8044SWilliam.Kucharski@Sun.COM                    {210mm}{148mm}%
6860*8044SWilliam.Kucharski@Sun.COM  %
6861*8044SWilliam.Kucharski@Sun.COM  \lispnarrowing = 0.2in
6862*8044SWilliam.Kucharski@Sun.COM  \tolerance = 800
6863*8044SWilliam.Kucharski@Sun.COM  \hfuzz = 1.2pt
6864*8044SWilliam.Kucharski@Sun.COM  \contentsrightmargin = 0pt
6865*8044SWilliam.Kucharski@Sun.COM  \defbodyindent = 2mm
6866*8044SWilliam.Kucharski@Sun.COM  \tableindent = 12mm
6867*8044SWilliam.Kucharski@Sun.COM}}
6868*8044SWilliam.Kucharski@Sun.COM
6869*8044SWilliam.Kucharski@Sun.COM% A specific text layout, 24x15cm overall, intended for A4 paper.
6870*8044SWilliam.Kucharski@Sun.COM\def\afourlatex{{\globaldefs = 1
6871*8044SWilliam.Kucharski@Sun.COM  \afourpaper
6872*8044SWilliam.Kucharski@Sun.COM  \internalpagesizes{237mm}{150mm}%
6873*8044SWilliam.Kucharski@Sun.COM                    {\voffset}{4.6mm}%
6874*8044SWilliam.Kucharski@Sun.COM                    {\bindingoffset}{7mm}%
6875*8044SWilliam.Kucharski@Sun.COM                    {297mm}{210mm}%
6876*8044SWilliam.Kucharski@Sun.COM  %
6877*8044SWilliam.Kucharski@Sun.COM  % Must explicitly reset to 0 because we call \afourpaper.
6878*8044SWilliam.Kucharski@Sun.COM  \globaldefs = 0
6879*8044SWilliam.Kucharski@Sun.COM}}
6880*8044SWilliam.Kucharski@Sun.COM
6881*8044SWilliam.Kucharski@Sun.COM% Use @afourwide to print on A4 paper in landscape format.
6882*8044SWilliam.Kucharski@Sun.COM\def\afourwide{{\globaldefs = 1
6883*8044SWilliam.Kucharski@Sun.COM  \afourpaper
6884*8044SWilliam.Kucharski@Sun.COM  \internalpagesizes{241mm}{165mm}%
6885*8044SWilliam.Kucharski@Sun.COM                    {\voffset}{-2.95mm}%
6886*8044SWilliam.Kucharski@Sun.COM                    {\bindingoffset}{7mm}%
6887*8044SWilliam.Kucharski@Sun.COM                    {297mm}{210mm}%
6888*8044SWilliam.Kucharski@Sun.COM  \globaldefs = 0
6889*8044SWilliam.Kucharski@Sun.COM}}
6890*8044SWilliam.Kucharski@Sun.COM
6891*8044SWilliam.Kucharski@Sun.COM% @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6892*8044SWilliam.Kucharski@Sun.COM% Perhaps we should allow setting the margins, \topskip, \parskip,
6893*8044SWilliam.Kucharski@Sun.COM% and/or leading, also. Or perhaps we should compute them somehow.
6894*8044SWilliam.Kucharski@Sun.COM%
6895*8044SWilliam.Kucharski@Sun.COM\parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
6896*8044SWilliam.Kucharski@Sun.COM\def\pagesizesyyy#1,#2,#3\finish{{%
6897*8044SWilliam.Kucharski@Sun.COM  \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6898*8044SWilliam.Kucharski@Sun.COM  \globaldefs = 1
6899*8044SWilliam.Kucharski@Sun.COM  %
6900*8044SWilliam.Kucharski@Sun.COM  \parskip = 3pt plus 2pt minus 1pt
6901*8044SWilliam.Kucharski@Sun.COM  \setleading{\textleading}%
6902*8044SWilliam.Kucharski@Sun.COM  %
6903*8044SWilliam.Kucharski@Sun.COM  \dimen0 = #1
6904*8044SWilliam.Kucharski@Sun.COM  \advance\dimen0 by \voffset
6905*8044SWilliam.Kucharski@Sun.COM  %
6906*8044SWilliam.Kucharski@Sun.COM  \dimen2 = \hsize
6907*8044SWilliam.Kucharski@Sun.COM  \advance\dimen2 by \normaloffset
6908*8044SWilliam.Kucharski@Sun.COM  %
6909*8044SWilliam.Kucharski@Sun.COM  \internalpagesizes{#1}{\hsize}%
6910*8044SWilliam.Kucharski@Sun.COM                    {\voffset}{\normaloffset}%
6911*8044SWilliam.Kucharski@Sun.COM                    {\bindingoffset}{44pt}%
6912*8044SWilliam.Kucharski@Sun.COM                    {\dimen0}{\dimen2}%
6913*8044SWilliam.Kucharski@Sun.COM}}
6914*8044SWilliam.Kucharski@Sun.COM
6915*8044SWilliam.Kucharski@Sun.COM% Set default to letter.
6916*8044SWilliam.Kucharski@Sun.COM%
6917*8044SWilliam.Kucharski@Sun.COM\letterpaper
6918*8044SWilliam.Kucharski@Sun.COM
6919*8044SWilliam.Kucharski@Sun.COM
6920*8044SWilliam.Kucharski@Sun.COM\message{and turning on texinfo input format.}
6921*8044SWilliam.Kucharski@Sun.COM
6922*8044SWilliam.Kucharski@Sun.COM% Define macros to output various characters with catcode for normal text.
6923*8044SWilliam.Kucharski@Sun.COM\catcode`\"=\other
6924*8044SWilliam.Kucharski@Sun.COM\catcode`\~=\other
6925*8044SWilliam.Kucharski@Sun.COM\catcode`\^=\other
6926*8044SWilliam.Kucharski@Sun.COM\catcode`\_=\other
6927*8044SWilliam.Kucharski@Sun.COM\catcode`\|=\other
6928*8044SWilliam.Kucharski@Sun.COM\catcode`\<=\other
6929*8044SWilliam.Kucharski@Sun.COM\catcode`\>=\other
6930*8044SWilliam.Kucharski@Sun.COM\catcode`\+=\other
6931*8044SWilliam.Kucharski@Sun.COM\catcode`\$=\other
6932*8044SWilliam.Kucharski@Sun.COM\def\normaldoublequote{"}
6933*8044SWilliam.Kucharski@Sun.COM\def\normaltilde{~}
6934*8044SWilliam.Kucharski@Sun.COM\def\normalcaret{^}
6935*8044SWilliam.Kucharski@Sun.COM\def\normalunderscore{_}
6936*8044SWilliam.Kucharski@Sun.COM\def\normalverticalbar{|}
6937*8044SWilliam.Kucharski@Sun.COM\def\normalless{<}
6938*8044SWilliam.Kucharski@Sun.COM\def\normalgreater{>}
6939*8044SWilliam.Kucharski@Sun.COM\def\normalplus{+}
6940*8044SWilliam.Kucharski@Sun.COM\def\normaldollar{$}%$ font-lock fix
6941*8044SWilliam.Kucharski@Sun.COM
6942*8044SWilliam.Kucharski@Sun.COM% This macro is used to make a character print one way in \tt
6943*8044SWilliam.Kucharski@Sun.COM% (where it can probably be output as-is), and another way in other fonts,
6944*8044SWilliam.Kucharski@Sun.COM% where something hairier probably needs to be done.
6945*8044SWilliam.Kucharski@Sun.COM%
6946*8044SWilliam.Kucharski@Sun.COM% #1 is what to print if we are indeed using \tt; #2 is what to print
6947*8044SWilliam.Kucharski@Sun.COM% otherwise.  Since all the Computer Modern typewriter fonts have zero
6948*8044SWilliam.Kucharski@Sun.COM% interword stretch (and shrink), and it is reasonable to expect all
6949*8044SWilliam.Kucharski@Sun.COM% typewriter fonts to have this, we can check that font parameter.
6950*8044SWilliam.Kucharski@Sun.COM%
6951*8044SWilliam.Kucharski@Sun.COM\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6952*8044SWilliam.Kucharski@Sun.COM
6953*8044SWilliam.Kucharski@Sun.COM% Same as above, but check for italic font.  Actually this also catches
6954*8044SWilliam.Kucharski@Sun.COM% non-italic slanted fonts since it is impossible to distinguish them from
6955*8044SWilliam.Kucharski@Sun.COM% italic fonts.  But since this is only used by $ and it uses \sl anyway
6956*8044SWilliam.Kucharski@Sun.COM% this is not a problem.
6957*8044SWilliam.Kucharski@Sun.COM\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6958*8044SWilliam.Kucharski@Sun.COM
6959*8044SWilliam.Kucharski@Sun.COM% Turn off all special characters except @
6960*8044SWilliam.Kucharski@Sun.COM% (and those which the user can use as if they were ordinary).
6961*8044SWilliam.Kucharski@Sun.COM% Most of these we simply print from the \tt font, but for some, we can
6962*8044SWilliam.Kucharski@Sun.COM% use math or other variants that look better in normal text.
6963*8044SWilliam.Kucharski@Sun.COM
6964*8044SWilliam.Kucharski@Sun.COM\catcode`\"=\active
6965*8044SWilliam.Kucharski@Sun.COM\def\activedoublequote{{\tt\char34}}
6966*8044SWilliam.Kucharski@Sun.COM\let"=\activedoublequote
6967*8044SWilliam.Kucharski@Sun.COM\catcode`\~=\active
6968*8044SWilliam.Kucharski@Sun.COM\def~{{\tt\char126}}
6969*8044SWilliam.Kucharski@Sun.COM\chardef\hat=`\^
6970*8044SWilliam.Kucharski@Sun.COM\catcode`\^=\active
6971*8044SWilliam.Kucharski@Sun.COM\def^{{\tt \hat}}
6972*8044SWilliam.Kucharski@Sun.COM
6973*8044SWilliam.Kucharski@Sun.COM\catcode`\_=\active
6974*8044SWilliam.Kucharski@Sun.COM\def_{\ifusingtt\normalunderscore\_}
6975*8044SWilliam.Kucharski@Sun.COM% Subroutine for the previous macro.
6976*8044SWilliam.Kucharski@Sun.COM\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6977*8044SWilliam.Kucharski@Sun.COM
6978*8044SWilliam.Kucharski@Sun.COM\catcode`\|=\active
6979*8044SWilliam.Kucharski@Sun.COM\def|{{\tt\char124}}
6980*8044SWilliam.Kucharski@Sun.COM\chardef \less=`\<
6981*8044SWilliam.Kucharski@Sun.COM\catcode`\<=\active
6982*8044SWilliam.Kucharski@Sun.COM\def<{{\tt \less}}
6983*8044SWilliam.Kucharski@Sun.COM\chardef \gtr=`\>
6984*8044SWilliam.Kucharski@Sun.COM\catcode`\>=\active
6985*8044SWilliam.Kucharski@Sun.COM\def>{{\tt \gtr}}
6986*8044SWilliam.Kucharski@Sun.COM\catcode`\+=\active
6987*8044SWilliam.Kucharski@Sun.COM\def+{{\tt \char 43}}
6988*8044SWilliam.Kucharski@Sun.COM\catcode`\$=\active
6989*8044SWilliam.Kucharski@Sun.COM\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6990*8044SWilliam.Kucharski@Sun.COM
6991*8044SWilliam.Kucharski@Sun.COM% If a .fmt file is being used, characters that might appear in a file
6992*8044SWilliam.Kucharski@Sun.COM% name cannot be active until we have parsed the command line.
6993*8044SWilliam.Kucharski@Sun.COM% So turn them off again, and have \everyjob (or @setfilename) turn them on.
6994*8044SWilliam.Kucharski@Sun.COM% \otherifyactive is called near the end of this file.
6995*8044SWilliam.Kucharski@Sun.COM\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6996*8044SWilliam.Kucharski@Sun.COM
6997*8044SWilliam.Kucharski@Sun.COM\catcode`\@=0
6998*8044SWilliam.Kucharski@Sun.COM
6999*8044SWilliam.Kucharski@Sun.COM% \backslashcurfont outputs one backslash character in current font,
7000*8044SWilliam.Kucharski@Sun.COM% as in \char`\\.
7001*8044SWilliam.Kucharski@Sun.COM\global\chardef\backslashcurfont=`\\
7002*8044SWilliam.Kucharski@Sun.COM\global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
7003*8044SWilliam.Kucharski@Sun.COM
7004*8044SWilliam.Kucharski@Sun.COM% \rawbackslash defines an active \ to do \backslashcurfont.
7005*8044SWilliam.Kucharski@Sun.COM% \otherbackslash defines an active \ to be a literal `\' character with
7006*8044SWilliam.Kucharski@Sun.COM% catcode other.
7007*8044SWilliam.Kucharski@Sun.COM{\catcode`\\=\active
7008*8044SWilliam.Kucharski@Sun.COM @gdef@rawbackslash{@let\=@backslashcurfont}
7009*8044SWilliam.Kucharski@Sun.COM @gdef@otherbackslash{@let\=@realbackslash}
7010*8044SWilliam.Kucharski@Sun.COM}
7011*8044SWilliam.Kucharski@Sun.COM
7012*8044SWilliam.Kucharski@Sun.COM% \realbackslash is an actual character `\' with catcode other.
7013*8044SWilliam.Kucharski@Sun.COM{\catcode`\\=\other @gdef@realbackslash{\}}
7014*8044SWilliam.Kucharski@Sun.COM
7015*8044SWilliam.Kucharski@Sun.COM% \normalbackslash outputs one backslash in fixed width font.
7016*8044SWilliam.Kucharski@Sun.COM\def\normalbackslash{{\tt\backslashcurfont}}
7017*8044SWilliam.Kucharski@Sun.COM
7018*8044SWilliam.Kucharski@Sun.COM\catcode`\\=\active
7019*8044SWilliam.Kucharski@Sun.COM
7020*8044SWilliam.Kucharski@Sun.COM% Used sometimes to turn off (effectively) the active characters
7021*8044SWilliam.Kucharski@Sun.COM% even after parsing them.
7022*8044SWilliam.Kucharski@Sun.COM@def@turnoffactive{%
7023*8044SWilliam.Kucharski@Sun.COM  @let"=@normaldoublequote
7024*8044SWilliam.Kucharski@Sun.COM  @let\=@realbackslash
7025*8044SWilliam.Kucharski@Sun.COM  @let~=@normaltilde
7026*8044SWilliam.Kucharski@Sun.COM  @let^=@normalcaret
7027*8044SWilliam.Kucharski@Sun.COM  @let_=@normalunderscore
7028*8044SWilliam.Kucharski@Sun.COM  @let|=@normalverticalbar
7029*8044SWilliam.Kucharski@Sun.COM  @let<=@normalless
7030*8044SWilliam.Kucharski@Sun.COM  @let>=@normalgreater
7031*8044SWilliam.Kucharski@Sun.COM  @let+=@normalplus
7032*8044SWilliam.Kucharski@Sun.COM  @let$=@normaldollar %$ font-lock fix
7033*8044SWilliam.Kucharski@Sun.COM  @unsepspaces
7034*8044SWilliam.Kucharski@Sun.COM}
7035*8044SWilliam.Kucharski@Sun.COM
7036*8044SWilliam.Kucharski@Sun.COM% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7037*8044SWilliam.Kucharski@Sun.COM% the literal character `\'.  (Thus, \ is not expandable when this is in
7038*8044SWilliam.Kucharski@Sun.COM% effect.)
7039*8044SWilliam.Kucharski@Sun.COM%
7040*8044SWilliam.Kucharski@Sun.COM@def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
7041*8044SWilliam.Kucharski@Sun.COM
7042*8044SWilliam.Kucharski@Sun.COM% Make _ and + \other characters, temporarily.
7043*8044SWilliam.Kucharski@Sun.COM% This is canceled by @fixbackslash.
7044*8044SWilliam.Kucharski@Sun.COM@otherifyactive
7045*8044SWilliam.Kucharski@Sun.COM
7046*8044SWilliam.Kucharski@Sun.COM% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7047*8044SWilliam.Kucharski@Sun.COM% That is what \eatinput is for; after that, the `\' should revert to printing
7048*8044SWilliam.Kucharski@Sun.COM% a backslash.
7049*8044SWilliam.Kucharski@Sun.COM%
7050*8044SWilliam.Kucharski@Sun.COM@gdef@eatinput input texinfo{@fixbackslash}
7051*8044SWilliam.Kucharski@Sun.COM@global@let\ = @eatinput
7052*8044SWilliam.Kucharski@Sun.COM
7053*8044SWilliam.Kucharski@Sun.COM% On the other hand, perhaps the file did not have a `\input texinfo'. Then
7054*8044SWilliam.Kucharski@Sun.COM% the first `\{ in the file would cause an error. This macro tries to fix
7055*8044SWilliam.Kucharski@Sun.COM% that, assuming it is called before the first `\' could plausibly occur.
7056*8044SWilliam.Kucharski@Sun.COM% Also back turn on active characters that might appear in the input
7057*8044SWilliam.Kucharski@Sun.COM% file name, in case not using a pre-dumped format.
7058*8044SWilliam.Kucharski@Sun.COM%
7059*8044SWilliam.Kucharski@Sun.COM@gdef@fixbackslash{%
7060*8044SWilliam.Kucharski@Sun.COM  @ifx\@eatinput @let\ = @normalbackslash @fi
7061*8044SWilliam.Kucharski@Sun.COM  @catcode`+=@active
7062*8044SWilliam.Kucharski@Sun.COM  @catcode`@_=@active
7063*8044SWilliam.Kucharski@Sun.COM}
7064*8044SWilliam.Kucharski@Sun.COM
7065*8044SWilliam.Kucharski@Sun.COM% Say @foo, not \foo, in error messages.
7066*8044SWilliam.Kucharski@Sun.COM@escapechar = `@@
7067*8044SWilliam.Kucharski@Sun.COM
7068*8044SWilliam.Kucharski@Sun.COM% These look ok in all fonts, so just make them not special.
7069*8044SWilliam.Kucharski@Sun.COM@catcode`@& = @other
7070*8044SWilliam.Kucharski@Sun.COM@catcode`@# = @other
7071*8044SWilliam.Kucharski@Sun.COM@catcode`@% = @other
7072*8044SWilliam.Kucharski@Sun.COM
7073*8044SWilliam.Kucharski@Sun.COM
7074*8044SWilliam.Kucharski@Sun.COM@c Local variables:
7075*8044SWilliam.Kucharski@Sun.COM@c eval: (add-hook 'write-file-hooks 'time-stamp)
7076*8044SWilliam.Kucharski@Sun.COM@c page-delimiter: "^\\\\message"
7077*8044SWilliam.Kucharski@Sun.COM@c time-stamp-start: "def\\\\texinfoversion{"
7078*8044SWilliam.Kucharski@Sun.COM@c time-stamp-format: "%:y-%02m-%02d.%02H"
7079*8044SWilliam.Kucharski@Sun.COM@c time-stamp-end: "}"
7080*8044SWilliam.Kucharski@Sun.COM@c End:
7081*8044SWilliam.Kucharski@Sun.COM
7082*8044SWilliam.Kucharski@Sun.COM@c vim:sw=2:
7083*8044SWilliam.Kucharski@Sun.COM
7084*8044SWilliam.Kucharski@Sun.COM@ignore
7085*8044SWilliam.Kucharski@Sun.COM   arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
7086*8044SWilliam.Kucharski@Sun.COM@end ignore
7087