|
2670
|
1 %% TeX macros to handle Texinfo files. |
|
2689
|
2 %% $Id: texinfo.tex,v 1.4 1997-02-18 09:08:50 jwe Exp $ |
|
2333
|
3 |
|
2483
|
4 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93, |
|
2670
|
5 % 94, 95, 96, 97 Free Software Foundation, Inc. |
|
2333
|
6 |
|
|
7 %This texinfo.tex file is free software; you can redistribute it and/or |
|
|
8 %modify it under the terms of the GNU General Public License as |
|
|
9 %published by the Free Software Foundation; either version 2, or (at |
|
|
10 %your option) any later version. |
|
|
11 |
|
|
12 %This texinfo.tex file is distributed in the hope that it will be |
|
|
13 %useful, but WITHOUT ANY WARRANTY; without even the implied warranty |
|
|
14 %of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
15 %General Public License for more details. |
|
|
16 |
|
|
17 %You should have received a copy of the GNU General Public License |
|
|
18 %along with this texinfo.tex file; see the file COPYING. If not, write |
|
2483
|
19 %to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
|
|
20 %Boston, MA 02111-1307, USA. |
|
2333
|
21 |
|
|
22 |
|
|
23 %In other words, you are welcome to use, share and improve this program. |
|
|
24 %You are forbidden to forbid anyone else to use, share and improve |
|
|
25 %what you give them. Help stamp out software-hoarding! |
|
|
26 |
|
|
27 |
|
|
28 % Send bug reports to bug-texinfo@prep.ai.mit.edu. |
|
|
29 % Please include a *precise* test case in each bug report. |
|
|
30 |
|
|
31 |
|
|
32 % Make it possible to create a .fmt file just by loading this file: |
|
|
33 % if the underlying format is not loaded, start by loading it now. |
|
|
34 % Added by gildea November 1993. |
|
|
35 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi |
|
|
36 |
|
|
37 % This automatically updates the version number based on RCS. |
|
2483
|
38 \def\deftexinfoversion$#1: #2 ${\def\texinfoversion{#2}} |
|
2689
|
39 \deftexinfoversion$Revision: 1.4 $ |
|
2333
|
40 \message{Loading texinfo package [Version \texinfoversion]:} |
|
|
41 |
|
|
42 % If in a .fmt file, print the version number |
|
|
43 % and turn on active characters that we couldn't do earlier because |
|
|
44 % they might have appeared in the input file name. |
|
|
45 \everyjob{\message{[Texinfo version \texinfoversion]}\message{} |
|
2483
|
46 \catcode`+=\active \catcode`\_=\active} |
|
2333
|
47 |
|
|
48 % Save some parts of plain tex whose names we will redefine. |
|
|
49 |
|
2483
|
50 \let\ptexb=\b |
|
|
51 \let\ptexbullet=\bullet |
|
|
52 \let\ptexc=\c |
|
|
53 \let\ptexcomma=\, |
|
|
54 \let\ptexdot=\. |
|
|
55 \let\ptexdots=\dots |
|
|
56 \let\ptexend=\end |
|
|
57 \let\ptexequiv = \equiv |
|
|
58 \let\ptexi=\i |
|
2333
|
59 \let\ptexlbrace=\{ |
|
|
60 \let\ptexrbrace=\} |
|
|
61 \let\ptexstar=\* |
|
|
62 \let\ptext=\t |
|
|
63 |
|
|
64 % Be sure we're in horizontal mode when doing a tie, since we make space |
|
|
65 % equivalent to this in @example-like environments. Otherwise, a space |
|
|
66 % at the beginning of a line will start with \penalty -- and |
|
|
67 % since \penalty is valid in vertical mode, we'd end up putting the |
|
|
68 % penalty on the vertical list instead of in the new paragraph. |
|
|
69 {\catcode`@ = 11 |
|
2483
|
70 % Avoid using \@M directly, because that causes trouble |
|
|
71 % if the definition is written into an index file. |
|
|
72 \global\let\tiepenalty = \@M |
|
|
73 \gdef\tie{\leavevmode\penalty\tiepenalty\ } |
|
2333
|
74 } |
|
|
75 |
|
2483
|
76 |
|
2333
|
77 \message{Basics,} |
|
|
78 \chardef\other=12 |
|
|
79 |
|
|
80 % If this character appears in an error message or help string, it |
|
|
81 % starts a new line in the output. |
|
|
82 \newlinechar = `^^J |
|
|
83 |
|
|
84 % Set up fixed words for English. |
|
|
85 \ifx\putwordChapter\undefined{\gdef\putwordChapter{Chapter}}\fi% |
|
|
86 \def\putwordInfo{Info}% |
|
|
87 \ifx\putwordSee\undefined{\gdef\putwordSee{See}}\fi% |
|
|
88 \ifx\putwordsee\undefined{\gdef\putwordsee{see}}\fi% |
|
|
89 \ifx\putwordfile\undefined{\gdef\putwordfile{file}}\fi% |
|
|
90 \ifx\putwordpage\undefined{\gdef\putwordpage{page}}\fi% |
|
|
91 \ifx\putwordsection\undefined{\gdef\putwordsection{section}}\fi% |
|
|
92 \ifx\putwordSection\undefined{\gdef\putwordSection{Section}}\fi% |
|
|
93 \ifx\putwordTableofContents\undefined{\gdef\putwordTableofContents{Table of Contents}}\fi% |
|
|
94 \ifx\putwordShortContents\undefined{\gdef\putwordShortContents{Short Contents}}\fi% |
|
|
95 \ifx\putwordAppendix\undefined{\gdef\putwordAppendix{Appendix}}\fi% |
|
|
96 |
|
|
97 % Ignore a token. |
|
|
98 % |
|
|
99 \def\gobble#1{} |
|
|
100 |
|
|
101 \hyphenation{ap-pen-dix} |
|
|
102 \hyphenation{mini-buf-fer mini-buf-fers} |
|
|
103 \hyphenation{eshell} |
|
|
104 |
|
|
105 % Margin to add to right of even pages, to left of odd pages. |
|
2670
|
106 \newdimen \bindingoffset |
|
|
107 \newdimen \normaloffset |
|
2333
|
108 \newdimen\pagewidth \newdimen\pageheight |
|
|
109 |
|
|
110 % Sometimes it is convenient to have everything in the transcript file |
|
|
111 % and nothing on the terminal. We don't just call \tracingall here, |
|
|
112 % since that produces some useless output on the terminal. |
|
|
113 % |
|
|
114 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% |
|
|
115 \def\loggingall{\tracingcommands2 \tracingstats2 |
|
|
116 \tracingpages1 \tracingoutput1 \tracinglostchars1 |
|
|
117 \tracingmacros2 \tracingparagraphs1 \tracingrestores1 |
|
|
118 \showboxbreadth\maxdimen\showboxdepth\maxdimen |
|
|
119 }% |
|
|
120 |
|
|
121 %---------------------Begin change----------------------- |
|
|
122 % |
|
|
123 %%%% For @cropmarks command. |
|
|
124 % Dimensions to add cropmarks at corners Added by P. A. MacKay, 12 Nov. 1986 |
|
|
125 % |
|
|
126 \newdimen\cornerlong \newdimen\cornerthick |
|
|
127 \newdimen \topandbottommargin |
|
|
128 \newdimen \outerhsize \newdimen \outervsize |
|
|
129 \cornerlong=1pc\cornerthick=.3pt % These set size of cropmarks |
|
|
130 \outerhsize=7in |
|
|
131 %\outervsize=9.5in |
|
|
132 % Alternative @smallbook page size is 9.25in |
|
|
133 \outervsize=9.25in |
|
|
134 \topandbottommargin=.75in |
|
|
135 % |
|
|
136 %---------------------End change----------------------- |
|
|
137 |
|
2670
|
138 % Main output routine. |
|
|
139 \chardef\PAGE = 255 |
|
|
140 \output = {\onepageout{\pagecontents\PAGE}} |
|
|
141 |
|
|
142 \newbox\headlinebox \newbox\footlinebox |
|
|
143 |
|
2333
|
144 % \onepageout takes a vbox as an argument. Note that \pagecontents |
|
2483
|
145 % does insertions, but you have to call it yourself. |
|
|
146 \def\onepageout#1{% |
|
|
147 \hoffset=\normaloffset |
|
|
148 \ifodd\pageno \advance\hoffset by \bindingoffset |
|
|
149 \else \advance\hoffset by -\bindingoffset\fi |
|
2670
|
150 % |
|
|
151 % Do this outside of the \shipout so @code etc. will be expanded in |
|
|
152 % the headline as they should be, not taken literally (outputting ''code). |
|
|
153 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% |
|
|
154 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% |
|
|
155 % |
|
2483
|
156 {% |
|
2670
|
157 % Have to do this stuff outside the \shipout because we want it to |
|
|
158 % take effect in \write's, yet the group defined by the \vbox ends |
|
|
159 % before the \shipout runs. |
|
|
160 % |
|
|
161 \escapechar = `\\ % use backslash in output files. |
|
|
162 \indexdummies % don't expand commands in the output. |
|
|
163 \normalturnoffactive % \ in index entries must not stay \, e.g., if |
|
|
164 % the page break happens to be in the middle of an example. |
|
2483
|
165 \shipout\vbox{% |
|
2670
|
166 \unvbox\headlinebox |
|
2483
|
167 \pagebody{#1}% |
|
2670
|
168 \unvbox\footlinebox |
|
2483
|
169 }% |
|
2670
|
170 }% |
|
2483
|
171 \advancepageno |
|
|
172 \ifnum\outputpenalty>-20000 \else\dosupereject\fi |
|
|
173 } |
|
2333
|
174 |
|
|
175 %%%% For @cropmarks command %%%% |
|
|
176 |
|
|
177 % Here is a modification of the main output routine for Near East Publications |
|
|
178 % This provides right-angle cropmarks at all four corners. |
|
|
179 % The contents of the page are centerlined into the cropmarks, |
|
|
180 % and any desired binding offset is added as an \hskip on either |
|
|
181 % site of the centerlined box. (P. A. MacKay, 12 November, 1986) |
|
|
182 % |
|
|
183 \def\croppageout#1{\hoffset=0pt % make sure this doesn't mess things up |
|
|
184 {\escapechar=`\\\relax % makes sure backslash is used in output files. |
|
|
185 \shipout |
|
|
186 \vbox to \outervsize{\hsize=\outerhsize |
|
|
187 \vbox{\line{\ewtop\hfill\ewtop}} |
|
|
188 \nointerlineskip |
|
|
189 \line{\vbox{\moveleft\cornerthick\nstop} |
|
|
190 \hfill |
|
|
191 \vbox{\moveright\cornerthick\nstop}} |
|
|
192 \vskip \topandbottommargin |
|
|
193 \centerline{\ifodd\pageno\hskip\bindingoffset\fi |
|
|
194 \vbox{ |
|
|
195 {\let\hsize=\pagewidth \makeheadline} |
|
|
196 \pagebody{#1} |
|
|
197 {\let\hsize=\pagewidth \makefootline}} |
|
|
198 \ifodd\pageno\else\hskip\bindingoffset\fi} |
|
|
199 \vskip \topandbottommargin plus1fill minus1fill |
|
|
200 \boxmaxdepth\cornerthick |
|
|
201 \line{\vbox{\moveleft\cornerthick\nsbot} |
|
|
202 \hfill |
|
|
203 \vbox{\moveright\cornerthick\nsbot}} |
|
|
204 \nointerlineskip |
|
|
205 \vbox{\line{\ewbot\hfill\ewbot}} |
|
|
206 }} |
|
|
207 \advancepageno |
|
|
208 \ifnum\outputpenalty>-20000 \else\dosupereject\fi} |
|
|
209 % |
|
|
210 % Do @cropmarks to get crop marks |
|
|
211 \def\cropmarks{\let\onepageout=\croppageout } |
|
|
212 |
|
|
213 \newinsert\margin \dimen\margin=\maxdimen |
|
|
214 |
|
|
215 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} |
|
|
216 {\catcode`\@ =11 |
|
|
217 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi |
|
|
218 % marginal hacks, juha@viisa.uucp (Juha Takala) |
|
|
219 \ifvoid\margin\else % marginal info is present |
|
|
220 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi |
|
|
221 \dimen@=\dp#1 \unvbox#1 |
|
|
222 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi |
|
|
223 \ifr@ggedbottom \kern-\dimen@ \vfil \fi} |
|
|
224 } |
|
|
225 |
|
|
226 % |
|
|
227 % Here are the rules for the cropmarks. Note that they are |
|
|
228 % offset so that the space between them is truly \outerhsize or \outervsize |
|
|
229 % (P. A. MacKay, 12 November, 1986) |
|
|
230 % |
|
|
231 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} |
|
|
232 \def\nstop{\vbox |
|
|
233 {\hrule height\cornerthick depth\cornerlong width\cornerthick}} |
|
|
234 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} |
|
|
235 \def\nsbot{\vbox |
|
|
236 {\hrule height\cornerlong depth\cornerthick width\cornerthick}} |
|
|
237 |
|
|
238 % Parse an argument, then pass it to #1. The argument is the rest of |
|
|
239 % the input line (except we remove a trailing comment). #1 should be a |
|
|
240 % macro which expects an ordinary undelimited TeX argument. |
|
|
241 % |
|
|
242 \def\parsearg#1{% |
|
|
243 \let\next = #1% |
|
|
244 \begingroup |
|
|
245 \obeylines |
|
|
246 \futurelet\temp\parseargx |
|
|
247 } |
|
|
248 |
|
|
249 % If the next token is an obeyed space (from an @example environment or |
|
|
250 % the like), remove it and recurse. Otherwise, we're done. |
|
|
251 \def\parseargx{% |
|
|
252 % \obeyedspace is defined far below, after the definition of \sepspaces. |
|
|
253 \ifx\obeyedspace\temp |
|
|
254 \expandafter\parseargdiscardspace |
|
|
255 \else |
|
|
256 \expandafter\parseargline |
|
|
257 \fi |
|
|
258 } |
|
|
259 |
|
|
260 % Remove a single space (as the delimiter token to the macro call). |
|
|
261 {\obeyspaces % |
|
|
262 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}} |
|
|
263 |
|
|
264 {\obeylines % |
|
|
265 \gdef\parseargline#1^^M{% |
|
|
266 \endgroup % End of the group started in \parsearg. |
|
|
267 % |
|
|
268 % First remove any @c comment, then any @comment. |
|
|
269 % Result of each macro is put in \toks0. |
|
|
270 \argremovec #1\c\relax % |
|
|
271 \expandafter\argremovecomment \the\toks0 \comment\relax % |
|
|
272 % |
|
|
273 % Call the caller's macro, saved as \next in \parsearg. |
|
|
274 \expandafter\next\expandafter{\the\toks0}% |
|
|
275 }% |
|
|
276 } |
|
|
277 |
|
|
278 % Since all \c{,omment} does is throw away the argument, we can let TeX |
|
|
279 % do that for us. The \relax here is matched by the \relax in the call |
|
|
280 % in \parseargline; it could be more or less anything, its purpose is |
|
|
281 % just to delimit the argument to the \c. |
|
|
282 \def\argremovec#1\c#2\relax{\toks0 = {#1}} |
|
|
283 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}} |
|
|
284 |
|
|
285 % \argremovec{,omment} might leave us with trailing spaces, though; e.g., |
|
|
286 % @end itemize @c foo |
|
|
287 % will have two active spaces as part of the argument with the |
|
|
288 % `itemize'. Here we remove all active spaces from #1, and assign the |
|
|
289 % result to \toks0. |
|
|
290 % |
|
|
291 % This loses if there are any *other* active characters besides spaces |
|
|
292 % in the argument -- _ ^ +, for example -- since they get expanded. |
|
|
293 % Fortunately, Texinfo does not define any such commands. (If it ever |
|
|
294 % does, the catcode of the characters in questionwill have to be changed |
|
|
295 % here.) But this means we cannot call \removeactivespaces as part of |
|
|
296 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument |
|
|
297 % that \parsearg gets might well have any character at all in it. |
|
|
298 % |
|
|
299 \def\removeactivespaces#1{% |
|
|
300 \begingroup |
|
|
301 \ignoreactivespaces |
|
|
302 \edef\temp{#1}% |
|
|
303 \global\toks0 = \expandafter{\temp}% |
|
|
304 \endgroup |
|
|
305 } |
|
|
306 |
|
|
307 % Change the active space to expand to nothing. |
|
|
308 % |
|
|
309 \begingroup |
|
|
310 \obeyspaces |
|
|
311 \gdef\ignoreactivespaces{\obeyspaces\let =\empty} |
|
|
312 \endgroup |
|
|
313 |
|
|
314 |
|
|
315 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} |
|
|
316 |
|
|
317 %% These are used to keep @begin/@end levels from running away |
|
|
318 %% Call \inENV within environments (after a \begingroup) |
|
|
319 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi} |
|
|
320 \def\ENVcheck{% |
|
|
321 \ifENV\errmessage{Still within an environment. Type Return to continue.} |
|
|
322 \endgroup\fi} % This is not perfect, but it should reduce lossage |
|
|
323 |
|
|
324 % @begin foo is the same as @foo, for now. |
|
|
325 \newhelp\EMsimple{Type <Return> to continue.} |
|
|
326 |
|
|
327 \outer\def\begin{\parsearg\beginxxx} |
|
|
328 |
|
|
329 \def\beginxxx #1{% |
|
|
330 \expandafter\ifx\csname #1\endcsname\relax |
|
|
331 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else |
|
|
332 \csname #1\endcsname\fi} |
|
|
333 |
|
|
334 % @end foo executes the definition of \Efoo. |
|
|
335 % |
|
|
336 \def\end{\parsearg\endxxx} |
|
|
337 \def\endxxx #1{% |
|
|
338 \removeactivespaces{#1}% |
|
|
339 \edef\endthing{\the\toks0}% |
|
|
340 % |
|
|
341 \expandafter\ifx\csname E\endthing\endcsname\relax |
|
|
342 \expandafter\ifx\csname \endthing\endcsname\relax |
|
|
343 % There's no \foo, i.e., no ``environment'' foo. |
|
|
344 \errhelp = \EMsimple |
|
|
345 \errmessage{Undefined command `@end \endthing'}% |
|
|
346 \else |
|
|
347 \unmatchedenderror\endthing |
|
|
348 \fi |
|
|
349 \else |
|
|
350 % Everything's ok; the right environment has been started. |
|
|
351 \csname E\endthing\endcsname |
|
|
352 \fi |
|
|
353 } |
|
|
354 |
|
|
355 % There is an environment #1, but it hasn't been started. Give an error. |
|
|
356 % |
|
|
357 \def\unmatchedenderror#1{% |
|
|
358 \errhelp = \EMsimple |
|
|
359 \errmessage{This `@end #1' doesn't have a matching `@#1'}% |
|
|
360 } |
|
|
361 |
|
|
362 % Define the control sequence \E#1 to give an unmatched @end error. |
|
|
363 % |
|
|
364 \def\defineunmatchedend#1{% |
|
|
365 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}% |
|
|
366 } |
|
|
367 |
|
|
368 |
|
|
369 % Single-spacing is done by various environments (specifically, in |
|
|
370 % \nonfillstart and \quotations). |
|
|
371 \newskip\singlespaceskip \singlespaceskip = 12.5pt |
|
|
372 \def\singlespace{% |
|
|
373 % Why was this kern here? It messes up equalizing space above and below |
|
|
374 % environments. --karl, 6may93 |
|
|
375 %{\advance \baselineskip by -\singlespaceskip |
|
|
376 %\kern \baselineskip}% |
|
|
377 \setleading \singlespaceskip |
|
|
378 } |
|
|
379 |
|
|
380 %% Simple single-character @ commands |
|
|
381 |
|
|
382 % @@ prints an @ |
|
|
383 % Kludge this until the fonts are right (grr). |
|
|
384 \def\@{{\tt \char '100}} |
|
|
385 |
|
|
386 % This is turned off because it was never documented |
|
|
387 % and you can use @w{...} around a quote to suppress ligatures. |
|
|
388 %% Define @` and @' to be the same as ` and ' |
|
|
389 %% but suppressing ligatures. |
|
|
390 %\def\`{{`}} |
|
|
391 %\def\'{{'}} |
|
|
392 |
|
|
393 % Used to generate quoted braces. |
|
|
394 \def\mylbrace {{\tt \char '173}} |
|
|
395 \def\myrbrace {{\tt \char '175}} |
|
|
396 \let\{=\mylbrace |
|
|
397 \let\}=\myrbrace |
|
2483
|
398 \begingroup |
|
|
399 % Definitions to produce actual \{ & \} command in an index. |
|
|
400 \catcode`\{ = 12 \catcode`\} = 12 |
|
|
401 \catcode`\[ = 1 \catcode`\] = 2 |
|
|
402 \catcode`\@ = 0 \catcode`\\ = 12 |
|
|
403 @gdef@lbracecmd[\{]% |
|
|
404 @gdef@rbracecmd[\}]% |
|
|
405 @endgroup |
|
|
406 |
|
|
407 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent |
|
|
408 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H. |
|
|
409 \let\, = \c |
|
|
410 \let\dotaccent = \. |
|
|
411 \def\ringaccent#1{{\accent23 #1}} |
|
|
412 \let\tieaccent = \t |
|
|
413 \let\ubaraccent = \b |
|
|
414 \let\udotaccent = \d |
|
|
415 |
|
|
416 % Other special characters: @questiondown @exclamdown |
|
|
417 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss. |
|
|
418 \def\questiondown{?`} |
|
|
419 \def\exclamdown{!`} |
|
|
420 |
|
|
421 % Dotless i and dotless j, used for accents. |
|
|
422 \def\imacro{i} |
|
|
423 \def\jmacro{j} |
|
|
424 \def\dotless#1{% |
|
|
425 \def\temp{#1}% |
|
|
426 \ifx\temp\imacro \ptexi |
|
|
427 \else\ifx\temp\jmacro \j |
|
|
428 \else \errmessage{@dotless can be used only with i or j}% |
|
|
429 \fi\fi |
|
|
430 } |
|
2333
|
431 |
|
|
432 % @: forces normal size whitespace following. |
|
|
433 \def\:{\spacefactor=1000 } |
|
|
434 |
|
|
435 % @* forces a line break. |
|
|
436 \def\*{\hfil\break\hbox{}\ignorespaces} |
|
|
437 |
|
|
438 % @. is an end-of-sentence period. |
|
|
439 \def\.{.\spacefactor=3000 } |
|
|
440 |
|
|
441 % @enddots{} is an end-of-sentence ellipsis. |
|
|
442 \gdef\enddots{$\mathinner{\ldotp\ldotp\ldotp\ldotp}$\spacefactor=3000} |
|
|
443 |
|
|
444 % @! is an end-of-sentence bang. |
|
|
445 \gdef\!{!\spacefactor=3000 } |
|
|
446 |
|
|
447 % @? is an end-of-sentence query. |
|
|
448 \gdef\?{?\spacefactor=3000 } |
|
|
449 |
|
|
450 % @w prevents a word break. Without the \leavevmode, @w at the |
|
|
451 % beginning of a paragraph, when TeX is still in vertical mode, would |
|
|
452 % produce a whole line of output instead of starting the paragraph. |
|
|
453 \def\w#1{\leavevmode\hbox{#1}} |
|
|
454 |
|
|
455 % @group ... @end group forces ... to be all on one page, by enclosing |
|
|
456 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box |
|
|
457 % to keep its height that of a normal line. According to the rules for |
|
|
458 % \topskip (p.114 of the TeXbook), the glue inserted is |
|
|
459 % max (\topskip - \ht (first item), 0). If that height is large, |
|
|
460 % therefore, no glue is inserted, and the space between the headline and |
|
|
461 % the text is small, which looks bad. |
|
|
462 % |
|
|
463 \def\group{\begingroup |
|
|
464 \ifnum\catcode13=\active \else |
|
|
465 \errhelp = \groupinvalidhelp |
|
|
466 \errmessage{@group invalid in context where filling is enabled}% |
|
|
467 \fi |
|
|
468 % |
|
|
469 % The \vtop we start below produces a box with normal height and large |
|
|
470 % depth; thus, TeX puts \baselineskip glue before it, and (when the |
|
|
471 % next line of text is done) \lineskip glue after it. (See p.82 of |
|
|
472 % the TeXbook.) Thus, space below is not quite equal to space |
|
|
473 % above. But it's pretty close. |
|
|
474 \def\Egroup{% |
|
|
475 \egroup % End the \vtop. |
|
|
476 \endgroup % End the \group. |
|
|
477 }% |
|
|
478 % |
|
|
479 \vtop\bgroup |
|
|
480 % We have to put a strut on the last line in case the @group is in |
|
|
481 % the midst of an example, rather than completely enclosing it. |
|
|
482 % Otherwise, the interline space between the last line of the group |
|
|
483 % and the first line afterwards is too small. But we can't put the |
|
|
484 % strut in \Egroup, since there it would be on a line by itself. |
|
|
485 % Hence this just inserts a strut at the beginning of each line. |
|
|
486 \everypar = {\strut}% |
|
|
487 % |
|
|
488 % Since we have a strut on every line, we don't need any of TeX's |
|
|
489 % normal interline spacing. |
|
|
490 \offinterlineskip |
|
|
491 % |
|
|
492 % OK, but now we have to do something about blank |
|
|
493 % lines in the input in @example-like environments, which normally |
|
|
494 % just turn into \lisppar, which will insert no space now that we've |
|
|
495 % turned off the interline space. Simplest is to make them be an |
|
|
496 % empty paragraph. |
|
|
497 \ifx\par\lisppar |
|
|
498 \edef\par{\leavevmode \par}% |
|
|
499 % |
|
|
500 % Reset ^^M's definition to new definition of \par. |
|
|
501 \obeylines |
|
|
502 \fi |
|
|
503 % |
|
|
504 % Do @comment since we are called inside an environment such as |
|
|
505 % @example, where each end-of-line in the input causes an |
|
|
506 % end-of-line in the output. We don't want the end-of-line after |
|
|
507 % the `@group' to put extra space in the output. Since @group |
|
|
508 % should appear on a line by itself (according to the Texinfo |
|
|
509 % manual), we don't worry about eating any user text. |
|
|
510 \comment |
|
|
511 } |
|
|
512 % |
|
|
513 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help |
|
|
514 % message, so this ends up printing `@group can only ...'. |
|
|
515 % |
|
|
516 \newhelp\groupinvalidhelp{% |
|
|
517 group can only be used in environments such as @example,^^J% |
|
|
518 where each line of input produces a line of output.} |
|
|
519 |
|
|
520 % @need space-in-mils |
|
|
521 % forces a page break if there is not space-in-mils remaining. |
|
|
522 |
|
|
523 \newdimen\mil \mil=0.001in |
|
|
524 |
|
|
525 \def\need{\parsearg\needx} |
|
|
526 |
|
|
527 % Old definition--didn't work. |
|
|
528 %\def\needx #1{\par % |
|
|
529 %% This method tries to make TeX break the page naturally |
|
|
530 %% if the depth of the box does not fit. |
|
|
531 %{\baselineskip=0pt% |
|
|
532 %\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000 |
|
|
533 %\prevdepth=-1000pt |
|
|
534 %}} |
|
|
535 |
|
|
536 \def\needx#1{% |
|
|
537 % Go into vertical mode, so we don't make a big box in the middle of a |
|
|
538 % paragraph. |
|
|
539 \par |
|
|
540 % |
|
|
541 % Don't add any leading before our big empty box, but allow a page |
|
|
542 % break, since the best break might be right here. |
|
|
543 \allowbreak |
|
|
544 \nointerlineskip |
|
|
545 \vtop to #1\mil{\vfil}% |
|
|
546 % |
|
|
547 % TeX does not even consider page breaks if a penalty added to the |
|
|
548 % main vertical list is 10000 or more. But in order to see if the |
|
|
549 % empty box we just added fits on the page, we must make it consider |
|
|
550 % page breaks. On the other hand, we don't want to actually break the |
|
|
551 % page after the empty box. So we use a penalty of 9999. |
|
|
552 % |
|
|
553 % There is an extremely small chance that TeX will actually break the |
|
|
554 % page at this \penalty, if there are no other feasible breakpoints in |
|
|
555 % sight. (If the user is using lots of big @group commands, which |
|
|
556 % almost-but-not-quite fill up a page, TeX will have a hard time doing |
|
|
557 % good page breaking, for example.) However, I could not construct an |
|
|
558 % example where a page broke at this \penalty; if it happens in a real |
|
|
559 % document, then we can reconsider our strategy. |
|
|
560 \penalty9999 |
|
|
561 % |
|
|
562 % Back up by the size of the box, whether we did a page break or not. |
|
|
563 \kern -#1\mil |
|
|
564 % |
|
|
565 % Do not allow a page break right after this kern. |
|
|
566 \nobreak |
|
|
567 } |
|
|
568 |
|
|
569 % @br forces paragraph break |
|
|
570 |
|
|
571 \let\br = \par |
|
|
572 |
|
|
573 % @dots{} output some dots |
|
|
574 |
|
|
575 \def\dots{$\ldots$} |
|
|
576 |
|
|
577 % @page forces the start of a new page |
|
|
578 |
|
|
579 \def\page{\par\vfill\supereject} |
|
|
580 |
|
|
581 % @exdent text.... |
|
|
582 % outputs text on separate line in roman font, starting at standard page margin |
|
|
583 |
|
|
584 % This records the amount of indent in the innermost environment. |
|
|
585 % That's how much \exdent should take out. |
|
|
586 \newskip\exdentamount |
|
|
587 |
|
|
588 % This defn is used inside fill environments such as @defun. |
|
|
589 \def\exdent{\parsearg\exdentyyy} |
|
|
590 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}} |
|
|
591 |
|
|
592 % This defn is used inside nofill environments such as @example. |
|
|
593 \def\nofillexdent{\parsearg\nofillexdentyyy} |
|
|
594 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount |
|
|
595 \leftline{\hskip\leftskip{\rm#1}}}} |
|
|
596 |
|
2483
|
597 % @inmargin{TEXT} puts TEXT in the margin next to the current paragraph. |
|
|
598 |
|
|
599 \def\inmargin#1{% |
|
|
600 \strut\vadjust{\nobreak\kern-\strutdepth |
|
|
601 \vtop to \strutdepth{\baselineskip\strutdepth\vss |
|
|
602 \llap{\rightskip=\inmarginspacing \vbox{\noindent #1}}\null}}} |
|
|
603 \newskip\inmarginspacing \inmarginspacing=1cm |
|
|
604 \def\strutdepth{\dp\strutbox} |
|
|
605 |
|
2333
|
606 %\hbox{{\rm#1}}\hfil\break}} |
|
|
607 |
|
|
608 % @include file insert text of that file as input. |
|
2483
|
609 % Allow normal characters that we make active in the argument (a file name). |
|
|
610 \def\include{\begingroup |
|
|
611 \catcode`\\=12 |
|
|
612 \catcode`~=12 |
|
|
613 \catcode`^=12 |
|
|
614 \catcode`_=12 |
|
|
615 \catcode`|=12 |
|
|
616 \catcode`<=12 |
|
|
617 \catcode`>=12 |
|
|
618 \catcode`+=12 |
|
|
619 \parsearg\includezzz} |
|
|
620 % Restore active chars for included file. |
|
|
621 \def\includezzz#1{\endgroup\begingroup |
|
|
622 % Read the included file in a group so nested @include's work. |
|
|
623 \def\thisfile{#1}% |
|
|
624 \input\thisfile |
|
2333
|
625 \endgroup} |
|
|
626 |
|
|
627 \def\thisfile{} |
|
|
628 |
|
|
629 % @center line outputs that line, centered |
|
|
630 |
|
|
631 \def\center{\parsearg\centerzzz} |
|
|
632 \def\centerzzz #1{{\advance\hsize by -\leftskip |
|
|
633 \advance\hsize by -\rightskip |
|
|
634 \centerline{#1}}} |
|
|
635 |
|
|
636 % @sp n outputs n lines of vertical space |
|
|
637 |
|
|
638 \def\sp{\parsearg\spxxx} |
|
2483
|
639 \def\spxxx #1{\vskip #1\baselineskip} |
|
2333
|
640 |
|
|
641 % @comment ...line which is ignored... |
|
|
642 % @c is the same as @comment |
|
|
643 % @ignore ... @end ignore is another way to write a comment |
|
|
644 |
|
|
645 \def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other% |
|
|
646 \parsearg \commentxxx} |
|
|
647 |
|
|
648 \def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 } |
|
|
649 |
|
|
650 \let\c=\comment |
|
|
651 |
|
2483
|
652 % @paragraphindent is defined for the Info formatting commands only. |
|
|
653 \let\paragraphindent=\comment |
|
|
654 |
|
2333
|
655 % Prevent errors for section commands. |
|
|
656 % Used in @ignore and in failing conditionals. |
|
|
657 \def\ignoresections{% |
|
|
658 \let\chapter=\relax |
|
|
659 \let\unnumbered=\relax |
|
|
660 \let\top=\relax |
|
|
661 \let\unnumberedsec=\relax |
|
|
662 \let\unnumberedsection=\relax |
|
|
663 \let\unnumberedsubsec=\relax |
|
|
664 \let\unnumberedsubsection=\relax |
|
|
665 \let\unnumberedsubsubsec=\relax |
|
|
666 \let\unnumberedsubsubsection=\relax |
|
|
667 \let\section=\relax |
|
|
668 \let\subsec=\relax |
|
|
669 \let\subsubsec=\relax |
|
|
670 \let\subsection=\relax |
|
|
671 \let\subsubsection=\relax |
|
|
672 \let\appendix=\relax |
|
|
673 \let\appendixsec=\relax |
|
|
674 \let\appendixsection=\relax |
|
|
675 \let\appendixsubsec=\relax |
|
|
676 \let\appendixsubsection=\relax |
|
|
677 \let\appendixsubsubsec=\relax |
|
|
678 \let\appendixsubsubsection=\relax |
|
|
679 \let\contents=\relax |
|
|
680 \let\smallbook=\relax |
|
|
681 \let\titlepage=\relax |
|
|
682 } |
|
|
683 |
|
|
684 % Used in nested conditionals, where we have to parse the Texinfo source |
|
|
685 % and so want to turn off most commands, in case they are used |
|
|
686 % incorrectly. |
|
|
687 % |
|
|
688 \def\ignoremorecommands{% |
|
2483
|
689 \let\defcodeindex = \relax |
|
2333
|
690 \let\defcv = \relax |
|
|
691 \let\deffn = \relax |
|
|
692 \let\deffnx = \relax |
|
|
693 \let\defindex = \relax |
|
|
694 \let\defivar = \relax |
|
|
695 \let\defmac = \relax |
|
|
696 \let\defmethod = \relax |
|
|
697 \let\defop = \relax |
|
|
698 \let\defopt = \relax |
|
|
699 \let\defspec = \relax |
|
|
700 \let\deftp = \relax |
|
|
701 \let\deftypefn = \relax |
|
|
702 \let\deftypefun = \relax |
|
|
703 \let\deftypevar = \relax |
|
|
704 \let\deftypevr = \relax |
|
|
705 \let\defun = \relax |
|
|
706 \let\defvar = \relax |
|
|
707 \let\defvr = \relax |
|
|
708 \let\ref = \relax |
|
|
709 \let\xref = \relax |
|
|
710 \let\printindex = \relax |
|
|
711 \let\pxref = \relax |
|
|
712 \let\settitle = \relax |
|
2483
|
713 \let\setchapternewpage = \relax |
|
|
714 \let\setchapterstyle = \relax |
|
|
715 \let\everyheading = \relax |
|
|
716 \let\evenheading = \relax |
|
|
717 \let\oddheading = \relax |
|
|
718 \let\everyfooting = \relax |
|
|
719 \let\evenfooting = \relax |
|
|
720 \let\oddfooting = \relax |
|
|
721 \let\headings = \relax |
|
2333
|
722 \let\include = \relax |
|
|
723 \let\lowersections = \relax |
|
|
724 \let\down = \relax |
|
|
725 \let\raisesections = \relax |
|
|
726 \let\up = \relax |
|
|
727 \let\set = \relax |
|
|
728 \let\clear = \relax |
|
|
729 \let\item = \relax |
|
|
730 } |
|
|
731 |
|
|
732 % Ignore @ignore ... @end ignore. |
|
|
733 % |
|
|
734 \def\ignore{\doignore{ignore}} |
|
|
735 |
|
|
736 % Also ignore @ifinfo, @ifhtml, @html, @menu, and @direntry text. |
|
|
737 % |
|
|
738 \def\ifinfo{\doignore{ifinfo}} |
|
|
739 \def\ifhtml{\doignore{ifhtml}} |
|
|
740 \def\html{\doignore{html}} |
|
|
741 \def\menu{\doignore{menu}} |
|
|
742 \def\direntry{\doignore{direntry}} |
|
|
743 |
|
2483
|
744 % Also ignore @macro ... @end macro. The user must run texi2dvi, |
|
|
745 % which runs makeinfo to do macro expansion. Ignore @unmacro, too. |
|
|
746 \def\macro{\doignore{macro}} |
|
|
747 \let\unmacro = \comment |
|
|
748 |
|
|
749 |
|
|
750 % @dircategory CATEGORY -- specify a category of the dir file |
|
|
751 % which this file should belong to. Ignore this in TeX. |
|
|
752 \let\dircategory = \comment |
|
|
753 |
|
2333
|
754 % Ignore text until a line `@end #1'. |
|
|
755 % |
|
|
756 \def\doignore#1{\begingroup |
|
|
757 % Don't complain about control sequences we have declared \outer. |
|
|
758 \ignoresections |
|
|
759 % |
|
|
760 % Define a command to swallow text until we reach `@end #1'. |
|
|
761 \long\def\doignoretext##1\end #1{\enddoignore}% |
|
|
762 % |
|
|
763 % Make sure that spaces turn into tokens that match what \doignoretext wants. |
|
|
764 \catcode32 = 10 |
|
|
765 % |
|
|
766 % And now expand that command. |
|
|
767 \doignoretext |
|
|
768 } |
|
|
769 |
|
|
770 % What we do to finish off ignored text. |
|
|
771 % |
|
|
772 \def\enddoignore{\endgroup\ignorespaces}% |
|
|
773 |
|
|
774 \newif\ifwarnedobs\warnedobsfalse |
|
|
775 \def\obstexwarn{% |
|
|
776 \ifwarnedobs\relax\else |
|
|
777 % We need to warn folks that they may have trouble with TeX 3.0. |
|
|
778 % This uses \immediate\write16 rather than \message to get newlines. |
|
|
779 \immediate\write16{} |
|
|
780 \immediate\write16{***WARNING*** for users of Unix TeX 3.0!} |
|
|
781 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).} |
|
|
782 \immediate\write16{If you are running another version of TeX, relax.} |
|
|
783 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.} |
|
|
784 \immediate\write16{ Then upgrade your TeX installation if you can.} |
|
2483
|
785 \immediate\write16{ (See ftp://ftp.gnu.ai.mit.edu/pub/gnu/TeX.README.)} |
|
2333
|
786 \immediate\write16{If you are stuck with version 3.0, run the} |
|
|
787 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution} |
|
|
788 \immediate\write16{ to use a workaround.} |
|
|
789 \immediate\write16{} |
|
2483
|
790 \global\warnedobstrue |
|
2333
|
791 \fi |
|
|
792 } |
|
|
793 |
|
|
794 % **In TeX 3.0, setting text in \nullfont hangs tex. For a |
|
|
795 % workaround (which requires the file ``dummy.tfm'' to be installed), |
|
|
796 % uncomment the following line: |
|
|
797 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax |
|
|
798 |
|
|
799 % Ignore text, except that we keep track of conditional commands for |
|
|
800 % purposes of nesting, up to an `@end #1' command. |
|
|
801 % |
|
|
802 \def\nestedignore#1{% |
|
|
803 \obstexwarn |
|
|
804 % We must actually expand the ignored text to look for the @end |
|
|
805 % command, so that nested ignore constructs work. Thus, we put the |
|
|
806 % text into a \vbox and then do nothing with the result. To minimize |
|
|
807 % the change of memory overflow, we follow the approach outlined on |
|
|
808 % page 401 of the TeXbook: make the current font be a dummy font. |
|
|
809 % |
|
|
810 \setbox0 = \vbox\bgroup |
|
|
811 % Don't complain about control sequences we have declared \outer. |
|
|
812 \ignoresections |
|
|
813 % |
|
|
814 % Define `@end #1' to end the box, which will in turn undefine the |
|
|
815 % @end command again. |
|
|
816 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}% |
|
|
817 % |
|
|
818 % We are going to be parsing Texinfo commands. Most cause no |
|
|
819 % trouble when they are used incorrectly, but some commands do |
|
|
820 % complicated argument parsing or otherwise get confused, so we |
|
|
821 % undefine them. |
|
|
822 % |
|
|
823 % We can't do anything about stray @-signs, unfortunately; |
|
|
824 % they'll produce `undefined control sequence' errors. |
|
|
825 \ignoremorecommands |
|
|
826 % |
|
|
827 % Set the current font to be \nullfont, a TeX primitive, and define |
|
|
828 % all the font commands to also use \nullfont. We don't use |
|
|
829 % dummy.tfm, as suggested in the TeXbook, because not all sites |
|
|
830 % might have that installed. Therefore, math mode will still |
|
|
831 % produce output, but that should be an extremely small amount of |
|
|
832 % stuff compared to the main input. |
|
|
833 % |
|
|
834 \nullfont |
|
|
835 \let\tenrm = \nullfont \let\tenit = \nullfont \let\tensl = \nullfont |
|
|
836 \let\tenbf = \nullfont \let\tentt = \nullfont \let\smallcaps = \nullfont |
|
|
837 \let\tensf = \nullfont |
|
|
838 % Similarly for index fonts (mostly for their use in |
|
|
839 % smallexample) |
|
|
840 \let\indrm = \nullfont \let\indit = \nullfont \let\indsl = \nullfont |
|
|
841 \let\indbf = \nullfont \let\indtt = \nullfont \let\indsc = \nullfont |
|
|
842 \let\indsf = \nullfont |
|
|
843 % |
|
|
844 % Don't complain when characters are missing from the fonts. |
|
|
845 \tracinglostchars = 0 |
|
|
846 % |
|
|
847 % Don't bother to do space factor calculations. |
|
|
848 \frenchspacing |
|
|
849 % |
|
|
850 % Don't report underfull hboxes. |
|
|
851 \hbadness = 10000 |
|
|
852 % |
|
|
853 % Do minimal line-breaking. |
|
|
854 \pretolerance = 10000 |
|
|
855 % |
|
|
856 % Do not execute instructions in @tex |
|
|
857 \def\tex{\doignore{tex}} |
|
|
858 } |
|
|
859 |
|
|
860 % @set VAR sets the variable VAR to an empty value. |
|
|
861 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. |
|
|
862 % |
|
|
863 % Since we want to separate VAR from REST-OF-LINE (which might be |
|
|
864 % empty), we can't just use \parsearg; we have to insert a space of our |
|
|
865 % own to delimit the rest of the line, and then take it out again if we |
|
2483
|
866 % didn't need it. Make sure the catcode of space is correct to avoid |
|
|
867 % losing inside @example, for instance. |
|
2333
|
868 % |
|
2670
|
869 \def\set{\begingroup\catcode` =10 |
|
|
870 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR. |
|
|
871 \parsearg\setxxx} |
|
2333
|
872 \def\setxxx#1{\setyyy#1 \endsetyyy} |
|
|
873 \def\setyyy#1 #2\endsetyyy{% |
|
|
874 \def\temp{#2}% |
|
|
875 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty |
|
|
876 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted. |
|
|
877 \fi |
|
2483
|
878 \endgroup |
|
2333
|
879 } |
|
2483
|
880 % Can't use \xdef to pre-expand #2 and save some time, since \temp or |
|
|
881 % \next or other control sequences that we've defined might get us into |
|
|
882 % an infinite loop. Consider `@set foo @cite{bar}'. |
|
|
883 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}} |
|
2333
|
884 |
|
|
885 % @clear VAR clears (i.e., unsets) the variable VAR. |
|
|
886 % |
|
|
887 \def\clear{\parsearg\clearxxx} |
|
|
888 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax} |
|
|
889 |
|
|
890 % @value{foo} gets the text saved in variable foo. |
|
|
891 % |
|
2670
|
892 \def\value{\begingroup |
|
|
893 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR. |
|
|
894 \valuexxx} |
|
|
895 \def\valuexxx#1{% |
|
|
896 \expandafter\ifx\csname SET#1\endcsname\relax |
|
|
897 {\{No value for ``#1''\}}% |
|
|
898 \else |
|
|
899 \csname SET#1\endcsname |
|
|
900 \fi |
|
|
901 \endgroup} |
|
2333
|
902 |
|
|
903 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined |
|
|
904 % with @set. |
|
|
905 % |
|
|
906 \def\ifset{\parsearg\ifsetxxx} |
|
|
907 \def\ifsetxxx #1{% |
|
|
908 \expandafter\ifx\csname SET#1\endcsname\relax |
|
|
909 \expandafter\ifsetfail |
|
|
910 \else |
|
|
911 \expandafter\ifsetsucceed |
|
|
912 \fi |
|
|
913 } |
|
|
914 \def\ifsetsucceed{\conditionalsucceed{ifset}} |
|
|
915 \def\ifsetfail{\nestedignore{ifset}} |
|
|
916 \defineunmatchedend{ifset} |
|
|
917 |
|
|
918 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been |
|
|
919 % defined with @set, or has been undefined with @clear. |
|
|
920 % |
|
|
921 \def\ifclear{\parsearg\ifclearxxx} |
|
|
922 \def\ifclearxxx #1{% |
|
|
923 \expandafter\ifx\csname SET#1\endcsname\relax |
|
|
924 \expandafter\ifclearsucceed |
|
|
925 \else |
|
|
926 \expandafter\ifclearfail |
|
|
927 \fi |
|
|
928 } |
|
|
929 \def\ifclearsucceed{\conditionalsucceed{ifclear}} |
|
|
930 \def\ifclearfail{\nestedignore{ifclear}} |
|
|
931 \defineunmatchedend{ifclear} |
|
|
932 |
|
|
933 % @iftex always succeeds; we read the text following, through @end |
|
|
934 % iftex). But `@end iftex' should be valid only after an @iftex. |
|
|
935 % |
|
|
936 \def\iftex{\conditionalsucceed{iftex}} |
|
|
937 \defineunmatchedend{iftex} |
|
|
938 |
|
|
939 % We can't just want to start a group at @iftex (for example) and end it |
|
|
940 % at @end iftex, since then @set commands inside the conditional have no |
|
|
941 % effect (they'd get reverted at the end of the group). So we must |
|
|
942 % define \Eiftex to redefine itself to be its previous value. (We can't |
|
|
943 % just define it to fail again with an ``unmatched end'' error, since |
|
|
944 % the @ifset might be nested.) |
|
|
945 % |
|
|
946 \def\conditionalsucceed#1{% |
|
|
947 \edef\temp{% |
|
|
948 % Remember the current value of \E#1. |
|
|
949 \let\nece{prevE#1} = \nece{E#1}% |
|
|
950 % |
|
|
951 % At the `@end #1', redefine \E#1 to be its previous value. |
|
|
952 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}% |
|
|
953 }% |
|
2689
|
954 \temp} |
|
2333
|
955 |
|
|
956 % We need to expand lots of \csname's, but we don't want to expand the |
|
|
957 % control sequences after we've constructed them. |
|
|
958 % |
|
|
959 \def\nece#1{\expandafter\noexpand\csname#1\endcsname} |
|
|
960 |
|
|
961 % @asis just yields its argument. Used with @table, for example. |
|
|
962 % |
|
|
963 \def\asis#1{#1} |
|
|
964 |
|
|
965 % @math means output in math mode. |
|
|
966 % We don't use $'s directly in the definition of \math because control |
|
|
967 % sequences like \math are expanded when the toc file is written. Then, |
|
|
968 % we read the toc file back, the $'s will be normal characters (as they |
|
|
969 % should be, according to the definition of Texinfo). So we must use a |
|
|
970 % control sequence to switch into and out of math mode. |
|
|
971 % |
|
|
972 % This isn't quite enough for @math to work properly in indices, but it |
|
|
973 % seems unlikely it will ever be needed there. |
|
|
974 % |
|
|
975 \let\implicitmath = $ |
|
|
976 \def\math#1{\implicitmath #1\implicitmath} |
|
|
977 |
|
|
978 % @bullet and @minus need the same treatment as @math, just above. |
|
|
979 \def\bullet{\implicitmath\ptexbullet\implicitmath} |
|
|
980 \def\minus{\implicitmath-\implicitmath} |
|
|
981 |
|
|
982 \def\node{\ENVcheck\parsearg\nodezzz} |
|
|
983 \def\nodezzz#1{\nodexxx [#1,]} |
|
|
984 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}} |
|
|
985 \let\nwnode=\node |
|
|
986 \let\lastnode=\relax |
|
|
987 |
|
|
988 \def\donoderef{\ifx\lastnode\relax\else |
|
|
989 \expandafter\expandafter\expandafter\setref{\lastnode}\fi |
|
|
990 \global\let\lastnode=\relax} |
|
|
991 |
|
|
992 \def\unnumbnoderef{\ifx\lastnode\relax\else |
|
|
993 \expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi |
|
|
994 \global\let\lastnode=\relax} |
|
|
995 |
|
|
996 \def\appendixnoderef{\ifx\lastnode\relax\else |
|
|
997 \expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi |
|
|
998 \global\let\lastnode=\relax} |
|
|
999 |
|
2483
|
1000 % @refill is a no-op. |
|
2333
|
1001 \let\refill=\relax |
|
|
1002 |
|
|
1003 % @setfilename is done at the beginning of every texinfo file. |
|
|
1004 % So open here the files we need to have open while reading the input. |
|
|
1005 % This makes it possible to make a .fmt file for texinfo. |
|
|
1006 \def\setfilename{% |
|
|
1007 \readauxfile |
|
|
1008 \opencontents |
|
|
1009 \openindices |
|
|
1010 \fixbackslash % Turn off hack to swallow `\input texinfo'. |
|
|
1011 \global\let\setfilename=\comment % Ignore extra @setfilename cmds. |
|
|
1012 \comment % Ignore the actual filename. |
|
|
1013 } |
|
|
1014 |
|
2483
|
1015 % @bye. |
|
2333
|
1016 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} |
|
|
1017 |
|
2483
|
1018 % \def\macro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\macroxxx} |
|
|
1019 % \def\macroxxx#1#2 \end macro{% |
|
|
1020 % \expandafter\gdef\macrotemp#1{#2}% |
|
|
1021 % \endgroup} |
|
|
1022 |
|
|
1023 %\def\linemacro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\linemacroxxx} |
|
|
1024 %\def\linemacroxxx#1#2 \end linemacro{% |
|
|
1025 %\let\parsearg=\relax |
|
|
1026 %\edef\macrotempx{\csname M\butfirst\expandafter\string\macrotemp\endcsname}% |
|
|
1027 %\expandafter\xdef\macrotemp{\parsearg\macrotempx}% |
|
|
1028 %\expandafter\gdef\macrotempx#1{#2}% |
|
|
1029 %\endgroup} |
|
|
1030 |
|
|
1031 %\def\butfirst#1{} |
|
|
1032 |
|
2333
|
1033 |
|
|
1034 \message{fonts,} |
|
|
1035 |
|
|
1036 % Font-change commands. |
|
|
1037 |
|
|
1038 % Texinfo supports the sans serif font style, which plain TeX does not. |
|
|
1039 % So we set up a \sf analogous to plain's \rm, etc. |
|
|
1040 \newfam\sffam |
|
|
1041 \def\sf{\fam=\sffam \tensf} |
|
|
1042 \let\li = \sf % Sometimes we call it \li, not \sf. |
|
|
1043 |
|
2483
|
1044 % We don't need math for this one. |
|
|
1045 \def\ttsl{\tenttsl} |
|
|
1046 |
|
2333
|
1047 %% Try out Computer Modern fonts at \magstephalf |
|
|
1048 \let\mainmagstep=\magstephalf |
|
|
1049 |
|
|
1050 % Set the font macro #1 to the font named #2, adding on the |
|
|
1051 % specified font prefix (normally `cm'). |
|
2483
|
1052 % #3 is the font's design size, #4 is a scale factor |
|
|
1053 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} |
|
2333
|
1054 |
|
|
1055 % Use cm as the default font prefix. |
|
|
1056 % To specify the font prefix, you must define \fontprefix |
|
|
1057 % before you read in texinfo.tex. |
|
|
1058 \ifx\fontprefix\undefined |
|
|
1059 \def\fontprefix{cm} |
|
|
1060 \fi |
|
2483
|
1061 % Support font families that don't use the same naming scheme as CM. |
|
|
1062 \def\rmshape{r} |
|
|
1063 \def\rmbshape{bx} %where the normal face is bold |
|
|
1064 \def\bfshape{b} |
|
|
1065 \def\bxshape{bx} |
|
|
1066 \def\ttshape{tt} |
|
|
1067 \def\ttbshape{tt} |
|
|
1068 \def\ttslshape{sltt} |
|
|
1069 \def\itshape{ti} |
|
|
1070 \def\itbshape{bxti} |
|
|
1071 \def\slshape{sl} |
|
|
1072 \def\slbshape{bxsl} |
|
|
1073 \def\sfshape{ss} |
|
|
1074 \def\sfbshape{ss} |
|
|
1075 \def\scshape{csc} |
|
|
1076 \def\scbshape{csc} |
|
2333
|
1077 |
|
|
1078 \ifx\bigger\relax |
|
|
1079 \let\mainmagstep=\magstep1 |
|
2483
|
1080 \setfont\textrm\rmshape{12}{1000} |
|
|
1081 \setfont\texttt\ttshape{12}{1000} |
|
2333
|
1082 \else |
|
2483
|
1083 \setfont\textrm\rmshape{10}{\mainmagstep} |
|
|
1084 \setfont\texttt\ttshape{10}{\mainmagstep} |
|
2333
|
1085 \fi |
|
|
1086 % Instead of cmb10, you many want to use cmbx10. |
|
|
1087 % cmbx10 is a prettier font on its own, but cmb10 |
|
|
1088 % looks better when embedded in a line with cmr10. |
|
2483
|
1089 \setfont\textbf\bfshape{10}{\mainmagstep} |
|
|
1090 \setfont\textit\itshape{10}{\mainmagstep} |
|
|
1091 \setfont\textsl\slshape{10}{\mainmagstep} |
|
|
1092 \setfont\textsf\sfshape{10}{\mainmagstep} |
|
|
1093 \setfont\textsc\scshape{10}{\mainmagstep} |
|
|
1094 \setfont\textttsl\ttslshape{10}{\mainmagstep} |
|
2333
|
1095 \font\texti=cmmi10 scaled \mainmagstep |
|
|
1096 \font\textsy=cmsy10 scaled \mainmagstep |
|
|
1097 |
|
|
1098 % A few fonts for @defun, etc. |
|
2483
|
1099 \setfont\defbf\bxshape{10}{\magstep1} %was 1314 |
|
|
1100 \setfont\deftt\ttshape{10}{\magstep1} |
|
2333
|
1101 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf} |
|
|
1102 |
|
2483
|
1103 % Fonts for indices and small examples (9pt). |
|
2333
|
1104 % We actually use the slanted font rather than the italic, |
|
|
1105 % because texinfo normally uses the slanted fonts for that. |
|
|
1106 % Do not make many font distinctions in general in the index, since they |
|
|
1107 % aren't very useful. |
|
2483
|
1108 \setfont\ninett\ttshape{9}{1000} |
|
|
1109 \setfont\indrm\rmshape{9}{1000} |
|
|
1110 \setfont\indit\slshape{9}{1000} |
|
2333
|
1111 \let\indsl=\indit |
|
|
1112 \let\indtt=\ninett |
|
2483
|
1113 \let\indttsl=\ninett |
|
2333
|
1114 \let\indsf=\indrm |
|
|
1115 \let\indbf=\indrm |
|
2483
|
1116 \setfont\indsc\scshape{10}{900} |
|
2333
|
1117 \font\indi=cmmi9 |
|
|
1118 \font\indsy=cmsy9 |
|
|
1119 |
|
2483
|
1120 % Chapter (and unnumbered) fonts (17.28pt). |
|
|
1121 \setfont\chaprm\rmbshape{12}{\magstep2} |
|
|
1122 \setfont\chapit\itbshape{10}{\magstep3} |
|
|
1123 \setfont\chapsl\slbshape{10}{\magstep3} |
|
|
1124 \setfont\chaptt\ttbshape{12}{\magstep2} |
|
|
1125 \setfont\chapttsl\ttslshape{10}{\magstep3} |
|
|
1126 \setfont\chapsf\sfbshape{12}{\magstep2} |
|
2333
|
1127 \let\chapbf=\chaprm |
|
2483
|
1128 \setfont\chapsc\scbshape{10}{\magstep3} |
|
2333
|
1129 \font\chapi=cmmi12 scaled \magstep2 |
|
|
1130 \font\chapsy=cmsy10 scaled \magstep3 |
|
|
1131 |
|
2483
|
1132 % Section fonts (14.4pt). |
|
|
1133 \setfont\secrm\rmbshape{12}{\magstep1} |
|
|
1134 \setfont\secit\itbshape{10}{\magstep2} |
|
|
1135 \setfont\secsl\slbshape{10}{\magstep2} |
|
|
1136 \setfont\sectt\ttbshape{12}{\magstep1} |
|
|
1137 \setfont\secttsl\ttslshape{10}{\magstep2} |
|
|
1138 \setfont\secsf\sfbshape{12}{\magstep1} |
|
|
1139 \let\secbf\secrm |
|
|
1140 \setfont\secsc\scbshape{10}{\magstep2} |
|
2333
|
1141 \font\seci=cmmi12 scaled \magstep1 |
|
|
1142 \font\secsy=cmsy10 scaled \magstep2 |
|
|
1143 |
|
2483
|
1144 % \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad. |
|
|
1145 % \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded. |
|
|
1146 % \setfont\ssecsl\slshape{10}{\magstep1} |
|
|
1147 % \setfont\ssectt\ttshape{10}{\magstep1} |
|
|
1148 % \setfont\ssecsf\sfshape{10}{\magstep1} |
|
|
1149 |
|
|
1150 %\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx. |
|
|
1151 %\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than |
|
|
1152 %\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1. |
|
|
1153 %\setfont\ssectt\ttshape{10}{1315} |
|
|
1154 %\setfont\ssecsf\sfshape{10}{1315} |
|
2333
|
1155 |
|
|
1156 %\let\ssecbf=\ssecrm |
|
|
1157 |
|
2483
|
1158 % Subsection fonts (13.15pt). |
|
|
1159 \setfont\ssecrm\rmbshape{12}{\magstephalf} |
|
|
1160 \setfont\ssecit\itbshape{10}{1315} |
|
|
1161 \setfont\ssecsl\slbshape{10}{1315} |
|
|
1162 \setfont\ssectt\ttbshape{12}{\magstephalf} |
|
|
1163 \setfont\ssecttsl\ttslshape{10}{\magstep1} |
|
|
1164 \setfont\ssecsf\sfbshape{12}{\magstephalf} |
|
|
1165 \let\ssecbf\ssecrm |
|
|
1166 \setfont\ssecsc\scbshape{10}{\magstep1} |
|
2333
|
1167 \font\sseci=cmmi12 scaled \magstephalf |
|
|
1168 \font\ssecsy=cmsy10 scaled \magstep1 |
|
|
1169 % The smallcaps and symbol fonts should actually be scaled \magstep1.5, |
|
|
1170 % but that is not a standard magnification. |
|
|
1171 |
|
|
1172 % Fonts for title page: |
|
2483
|
1173 \setfont\titlerm\rmbshape{12}{\magstep3} |
|
2333
|
1174 \let\authorrm = \secrm |
|
|
1175 |
|
|
1176 % In order for the font changes to affect most math symbols and letters, |
|
|
1177 % we have to define the \textfont of the standard families. Since |
|
|
1178 % texinfo doesn't allow for producing subscripts and superscripts, we |
|
|
1179 % don't bother to reset \scriptfont and \scriptscriptfont (which would |
|
|
1180 % also require loading a lot more fonts). |
|
|
1181 % |
|
|
1182 \def\resetmathfonts{% |
|
|
1183 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy |
|
|
1184 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf |
|
|
1185 \textfont\ttfam = \tentt \textfont\sffam = \tensf |
|
|
1186 } |
|
|
1187 |
|
|
1188 |
|
|
1189 % The font-changing commands redefine the meanings of \tenSTYLE, instead |
|
|
1190 % of just \STYLE. We do this so that font changes will continue to work |
|
|
1191 % in math mode, where it is the current \fam that is relevant in most |
|
2483
|
1192 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam |
|
|
1193 % \tenbf}, for example. By redefining \tenbf, we obviate the need to |
|
|
1194 % redefine \bf itself. |
|
2333
|
1195 \def\textfonts{% |
|
|
1196 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl |
|
|
1197 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc |
|
2483
|
1198 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl |
|
2333
|
1199 \resetmathfonts} |
|
|
1200 \def\chapfonts{% |
|
|
1201 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl |
|
|
1202 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc |
|
2483
|
1203 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl |
|
|
1204 \resetmathfonts \setleading{19pt}} |
|
2333
|
1205 \def\secfonts{% |
|
|
1206 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl |
|
|
1207 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc |
|
2483
|
1208 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl |
|
|
1209 \resetmathfonts \setleading{16pt}} |
|
2333
|
1210 \def\subsecfonts{% |
|
|
1211 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl |
|
|
1212 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc |
|
2483
|
1213 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl |
|
|
1214 \resetmathfonts \setleading{15pt}} |
|
|
1215 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf? |
|
2333
|
1216 \def\indexfonts{% |
|
|
1217 \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl |
|
|
1218 \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc |
|
2483
|
1219 \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy \let\tenttsl=\indttsl |
|
|
1220 \resetmathfonts \setleading{12pt}} |
|
2333
|
1221 |
|
|
1222 % Set up the default fonts, so we can use them for creating boxes. |
|
|
1223 % |
|
|
1224 \textfonts |
|
|
1225 |
|
|
1226 % Count depth in font-changes, for error checks |
|
|
1227 \newcount\fontdepth \fontdepth=0 |
|
|
1228 |
|
|
1229 % Fonts for short table of contents. |
|
2483
|
1230 \setfont\shortcontrm\rmshape{12}{1000} |
|
|
1231 \setfont\shortcontbf\bxshape{12}{1000} |
|
|
1232 \setfont\shortcontsl\slshape{12}{1000} |
|
2333
|
1233 |
|
|
1234 %% Add scribe-like font environments, plus @l for inline lisp (usually sans |
|
|
1235 %% serif) and @ii for TeX italic |
|
|
1236 |
|
|
1237 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction |
|
|
1238 % unless the following character is such as not to need one. |
|
|
1239 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi} |
|
|
1240 \def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx} |
|
|
1241 |
|
|
1242 \let\i=\smartitalic |
|
|
1243 \let\var=\smartitalic |
|
|
1244 \let\dfn=\smartitalic |
|
|
1245 \let\emph=\smartitalic |
|
|
1246 \let\cite=\smartitalic |
|
|
1247 |
|
|
1248 \def\b#1{{\bf #1}} |
|
|
1249 \let\strong=\b |
|
|
1250 |
|
|
1251 % We can't just use \exhyphenpenalty, because that only has effect at |
|
|
1252 % the end of a paragraph. Restore normal hyphenation at the end of the |
|
|
1253 % group within which \nohyphenation is presumably called. |
|
|
1254 % |
|
|
1255 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} |
|
|
1256 \def\restorehyphenation{\hyphenchar\font = `- } |
|
|
1257 |
|
|
1258 \def\t#1{% |
|
2483
|
1259 {\tt \rawbackslash \frenchspacing #1}% |
|
2333
|
1260 \null |
|
|
1261 } |
|
2483
|
1262 \let\ttfont=\t |
|
2333
|
1263 \def\samp #1{`\tclose{#1}'\null} |
|
2483
|
1264 \setfont\smallrm\rmshape{8}{1000} |
|
|
1265 \font\smallsy=cmsy9 |
|
|
1266 \def\key#1{{\smallrm\textfont2=\smallsy \leavevmode\hbox{% |
|
|
1267 \raise0.4pt\hbox{$\langle$}\kern-.08em\vtop{% |
|
|
1268 \vbox{\hrule\kern-0.4pt |
|
|
1269 \hbox{\raise0.4pt\hbox{\vphantom{$\langle$}}#1}}% |
|
|
1270 \kern-0.4pt\hrule}% |
|
|
1271 \kern-.06em\raise0.4pt\hbox{$\rangle$}}}} |
|
|
1272 % The old definition, with no lozenge: |
|
|
1273 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} |
|
2333
|
1274 \def\ctrl #1{{\tt \rawbackslash \hat}#1} |
|
|
1275 |
|
|
1276 \let\file=\samp |
|
2483
|
1277 \let\url=\samp % perhaps include a hypertex \special eventually |
|
|
1278 \def\email#1{$\langle${\tt #1}$\rangle$} |
|
2333
|
1279 |
|
|
1280 % @code is a modification of @t, |
|
|
1281 % which makes spaces the same size as normal in the surrounding text. |
|
|
1282 \def\tclose#1{% |
|
|
1283 {% |
|
|
1284 % Change normal interword space to be same as for the current font. |
|
|
1285 \spaceskip = \fontdimen2\font |
|
|
1286 % |
|
|
1287 % Switch to typewriter. |
|
|
1288 \tt |
|
|
1289 % |
|
|
1290 % But `\ ' produces the large typewriter interword space. |
|
|
1291 \def\ {{\spaceskip = 0pt{} }}% |
|
|
1292 % |
|
|
1293 % Turn off hyphenation. |
|
|
1294 \nohyphenation |
|
|
1295 % |
|
|
1296 \rawbackslash |
|
|
1297 \frenchspacing |
|
|
1298 #1% |
|
|
1299 }% |
|
|
1300 \null |
|
|
1301 } |
|
|
1302 |
|
|
1303 % We *must* turn on hyphenation at `-' and `_' in \code. |
|
2483
|
1304 % Otherwise, it is too hard to avoid overfull hboxes |
|
2333
|
1305 % in the Emacs manual, the Library manual, etc. |
|
|
1306 |
|
|
1307 % Unfortunately, TeX uses one parameter (\hyphenchar) to control |
|
|
1308 % both hyphenation at - and hyphenation within words. |
|
|
1309 % We must therefore turn them both off (\tclose does that) |
|
2483
|
1310 % and arrange explicitly to hyphenate at a dash. |
|
2333
|
1311 % -- rms. |
|
|
1312 { |
|
|
1313 \catcode`\-=\active |
|
|
1314 \catcode`\_=\active |
|
2670
|
1315 \catcode`\|=\active |
|
2333
|
1316 \global\def\code{\begingroup \catcode`\-=\active \let-\codedash \catcode`\_=\active \let_\codeunder \codex} |
|
|
1317 % The following is used by \doprintindex to insure that long function names |
|
|
1318 % wrap around. It is necessary for - and _ to be active before the index is |
|
|
1319 % read from the file, as \entry parses the arguments long before \code is |
|
|
1320 % ever called. -- mycroft |
|
2670
|
1321 % _ is always active; and it shouldn't be \let = to an _ that is a |
|
|
1322 % subscript character anyway. Then, @cindex @samp{_} (for example) |
|
|
1323 % fails. --karl |
|
|
1324 \global\def\indexbreaks{% |
|
|
1325 \catcode`\-=\active \let-\realdash |
|
|
1326 } |
|
2333
|
1327 } |
|
2483
|
1328 |
|
2333
|
1329 \def\realdash{-} |
|
|
1330 \def\codedash{-\discretionary{}{}{}} |
|
|
1331 \def\codeunder{\normalunderscore\discretionary{}{}{}} |
|
|
1332 \def\codex #1{\tclose{#1}\endgroup} |
|
|
1333 |
|
|
1334 %\let\exp=\tclose %Was temporary |
|
|
1335 |
|
|
1336 % @kbd is like @code, except that if the argument is just one @key command, |
|
|
1337 % then @kbd has no effect. |
|
2483
|
1338 % |
|
2333
|
1339 \def\xkey{\key} |
|
|
1340 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% |
|
|
1341 \ifx\one\xkey\ifx\threex\three \key{#2}% |
|
2483
|
1342 \else{\tclose{\ttsl\look}}\fi |
|
|
1343 \else{\tclose{\ttsl\look}}\fi} |
|
|
1344 |
|
|
1345 % Check if we are currently using a typewriter font. Since all the |
|
|
1346 % Computer Modern typewriter fonts have zero interword stretch (and |
|
|
1347 % shrink), and it is reasonable to expect all typewriter fonts to have |
|
|
1348 % this property, we can check that font parameter. |
|
2670
|
1349 % |
|
2483
|
1350 \def\ifmonospace{\ifdim\fontdimen3\font=0pt } |
|
2333
|
1351 |
|
|
1352 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the |
|
|
1353 % argument is to make the input look right: @dmn{pt} instead of |
|
|
1354 % @dmn{}pt. |
|
|
1355 % |
|
|
1356 \def\dmn#1{\thinspace #1} |
|
|
1357 |
|
|
1358 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} |
|
|
1359 |
|
2483
|
1360 % @l was never documented to mean ``switch to the Lisp font'', |
|
|
1361 % and it is not used as such in any manual I can find. We need it for |
|
|
1362 % Polish suppressed-l. --karl, 22sep96. |
|
|
1363 %\def\l#1{{\li #1}\null} |
|
2333
|
1364 |
|
|
1365 \def\r#1{{\rm #1}} % roman font |
|
|
1366 % Use of \lowercase was suggested. |
|
|
1367 \def\sc#1{{\smallcaps#1}} % smallcaps font |
|
|
1368 \def\ii#1{{\it #1}} % italic font |
|
|
1369 |
|
2483
|
1370 % @pounds{} is a sterling sign. |
|
|
1371 \def\pounds{{\it\$}} |
|
|
1372 |
|
|
1373 |
|
2333
|
1374 \message{page headings,} |
|
|
1375 |
|
|
1376 \newskip\titlepagetopglue \titlepagetopglue = 1.5in |
|
|
1377 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc |
|
|
1378 |
|
|
1379 % First the title page. Must do @settitle before @titlepage. |
|
|
1380 \def\titlefont#1{{\titlerm #1}} |
|
|
1381 |
|
|
1382 \newif\ifseenauthor |
|
|
1383 \newif\iffinishedtitlepage |
|
|
1384 |
|
|
1385 \def\shorttitlepage{\parsearg\shorttitlepagezzz} |
|
|
1386 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% |
|
|
1387 \endgroup\page\hbox{}\page} |
|
|
1388 |
|
|
1389 \def\titlepage{\begingroup \parindent=0pt \textfonts |
|
|
1390 \let\subtitlerm=\tenrm |
|
|
1391 % I deinstalled the following change because \cmr12 is undefined. |
|
|
1392 % This change was not in the ChangeLog anyway. --rms. |
|
|
1393 % \let\subtitlerm=\cmr12 |
|
|
1394 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}% |
|
|
1395 % |
|
|
1396 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}% |
|
|
1397 % |
|
|
1398 % Leave some space at the very top of the page. |
|
|
1399 \vglue\titlepagetopglue |
|
|
1400 % |
|
|
1401 % Now you can print the title using @title. |
|
|
1402 \def\title{\parsearg\titlezzz}% |
|
|
1403 \def\titlezzz##1{\leftline{\titlefont{##1}} |
|
|
1404 % print a rule at the page bottom also. |
|
|
1405 \finishedtitlepagefalse |
|
|
1406 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}% |
|
|
1407 % No rule at page bottom unless we print one at the top with @title. |
|
|
1408 \finishedtitlepagetrue |
|
|
1409 % |
|
|
1410 % Now you can put text using @subtitle. |
|
|
1411 \def\subtitle{\parsearg\subtitlezzz}% |
|
|
1412 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}% |
|
|
1413 % |
|
|
1414 % @author should come last, but may come many times. |
|
|
1415 \def\author{\parsearg\authorzzz}% |
|
|
1416 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi |
|
|
1417 {\authorfont \leftline{##1}}}% |
|
|
1418 % |
|
|
1419 % Most title ``pages'' are actually two pages long, with space |
|
|
1420 % at the top of the second. We don't want the ragged left on the second. |
|
|
1421 \let\oldpage = \page |
|
|
1422 \def\page{% |
|
|
1423 \iffinishedtitlepage\else |
|
|
1424 \finishtitlepage |
|
|
1425 \fi |
|
|
1426 \oldpage |
|
|
1427 \let\page = \oldpage |
|
|
1428 \hbox{}}% |
|
|
1429 % \def\page{\oldpage \hbox{}} |
|
|
1430 } |
|
|
1431 |
|
|
1432 \def\Etitlepage{% |
|
|
1433 \iffinishedtitlepage\else |
|
|
1434 \finishtitlepage |
|
|
1435 \fi |
|
|
1436 % It is important to do the page break before ending the group, |
|
|
1437 % because the headline and footline are only empty inside the group. |
|
|
1438 % If we use the new definition of \page, we always get a blank page |
|
|
1439 % after the title page, which we certainly don't want. |
|
|
1440 \oldpage |
|
|
1441 \endgroup |
|
|
1442 \HEADINGSon |
|
|
1443 } |
|
|
1444 |
|
|
1445 \def\finishtitlepage{% |
|
|
1446 \vskip4pt \hrule height 2pt width \hsize |
|
|
1447 \vskip\titlepagebottomglue |
|
|
1448 \finishedtitlepagetrue |
|
|
1449 } |
|
|
1450 |
|
|
1451 %%% Set up page headings and footings. |
|
|
1452 |
|
|
1453 \let\thispage=\folio |
|
|
1454 |
|
|
1455 \newtoks \evenheadline % Token sequence for heading line of even pages |
|
|
1456 \newtoks \oddheadline % Token sequence for heading line of odd pages |
|
|
1457 \newtoks \evenfootline % Token sequence for footing line of even pages |
|
|
1458 \newtoks \oddfootline % Token sequence for footing line of odd pages |
|
|
1459 |
|
|
1460 % Now make Tex use those variables |
|
|
1461 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline |
|
|
1462 \else \the\evenheadline \fi}} |
|
|
1463 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline |
|
|
1464 \else \the\evenfootline \fi}\HEADINGShook} |
|
|
1465 \let\HEADINGShook=\relax |
|
|
1466 |
|
|
1467 % Commands to set those variables. |
|
|
1468 % For example, this is what @headings on does |
|
|
1469 % @evenheading @thistitle|@thispage|@thischapter |
|
|
1470 % @oddheading @thischapter|@thispage|@thistitle |
|
|
1471 % @evenfooting @thisfile|| |
|
|
1472 % @oddfooting ||@thisfile |
|
|
1473 |
|
|
1474 \def\evenheading{\parsearg\evenheadingxxx} |
|
|
1475 \def\oddheading{\parsearg\oddheadingxxx} |
|
|
1476 \def\everyheading{\parsearg\everyheadingxxx} |
|
|
1477 |
|
|
1478 \def\evenfooting{\parsearg\evenfootingxxx} |
|
|
1479 \def\oddfooting{\parsearg\oddfootingxxx} |
|
|
1480 \def\everyfooting{\parsearg\everyfootingxxx} |
|
|
1481 |
|
|
1482 {\catcode`\@=0 % |
|
|
1483 |
|
|
1484 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish} |
|
|
1485 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{% |
|
|
1486 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
|
|
1487 |
|
|
1488 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish} |
|
|
1489 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{% |
|
|
1490 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
|
|
1491 |
|
|
1492 \gdef\everyheadingxxx #1{\everyheadingyyy #1@|@|@|@|\finish} |
|
|
1493 \gdef\everyheadingyyy #1@|#2@|#3@|#4\finish{% |
|
|
1494 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}} |
|
|
1495 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
|
|
1496 |
|
|
1497 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish} |
|
|
1498 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{% |
|
|
1499 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
|
|
1500 |
|
|
1501 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish} |
|
|
1502 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{% |
|
|
1503 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
|
|
1504 |
|
|
1505 \gdef\everyfootingxxx #1{\everyfootingyyy #1@|@|@|@|\finish} |
|
|
1506 \gdef\everyfootingyyy #1@|#2@|#3@|#4\finish{% |
|
|
1507 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}} |
|
|
1508 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
|
|
1509 % |
|
|
1510 }% unbind the catcode of @. |
|
|
1511 |
|
|
1512 % @headings double turns headings on for double-sided printing. |
|
|
1513 % @headings single turns headings on for single-sided printing. |
|
|
1514 % @headings off turns them off. |
|
|
1515 % @headings on same as @headings double, retained for compatibility. |
|
|
1516 % @headings after turns on double-sided headings after this page. |
|
|
1517 % @headings doubleafter turns on double-sided headings after this page. |
|
|
1518 % @headings singleafter turns on single-sided headings after this page. |
|
2483
|
1519 % By default, they are off at the start of a document, |
|
|
1520 % and turned `on' after @end titlepage. |
|
2333
|
1521 |
|
|
1522 \def\headings #1 {\csname HEADINGS#1\endcsname} |
|
|
1523 |
|
|
1524 \def\HEADINGSoff{ |
|
|
1525 \global\evenheadline={\hfil} \global\evenfootline={\hfil} |
|
|
1526 \global\oddheadline={\hfil} \global\oddfootline={\hfil}} |
|
|
1527 \HEADINGSoff |
|
|
1528 % When we turn headings on, set the page number to 1. |
|
|
1529 % For double-sided printing, put current file name in lower left corner, |
|
|
1530 % chapter name on inside top of right hand pages, document |
|
|
1531 % title on inside top of left hand pages, and page numbers on outside top |
|
|
1532 % edge of all pages. |
|
|
1533 \def\HEADINGSdouble{ |
|
|
1534 \global\pageno=1 |
|
|
1535 \global\evenfootline={\hfil} |
|
|
1536 \global\oddfootline={\hfil} |
|
|
1537 \global\evenheadline={\line{\folio\hfil\thistitle}} |
|
|
1538 \global\oddheadline={\line{\thischapter\hfil\folio}} |
|
2483
|
1539 \global\let\contentsalignmacro = \chapoddpage |
|
2333
|
1540 } |
|
2483
|
1541 \let\contentsalignmacro = \chappager |
|
|
1542 |
|
2333
|
1543 % For single-sided printing, chapter title goes across top left of page, |
|
|
1544 % page number on top right. |
|
|
1545 \def\HEADINGSsingle{ |
|
|
1546 \global\pageno=1 |
|
|
1547 \global\evenfootline={\hfil} |
|
|
1548 \global\oddfootline={\hfil} |
|
|
1549 \global\evenheadline={\line{\thischapter\hfil\folio}} |
|
|
1550 \global\oddheadline={\line{\thischapter\hfil\folio}} |
|
2483
|
1551 \global\let\contentsalignmacro = \chappager |
|
2333
|
1552 } |
|
|
1553 \def\HEADINGSon{\HEADINGSdouble} |
|
|
1554 |
|
|
1555 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} |
|
|
1556 \let\HEADINGSdoubleafter=\HEADINGSafter |
|
|
1557 \def\HEADINGSdoublex{% |
|
|
1558 \global\evenfootline={\hfil} |
|
|
1559 \global\oddfootline={\hfil} |
|
|
1560 \global\evenheadline={\line{\folio\hfil\thistitle}} |
|
|
1561 \global\oddheadline={\line{\thischapter\hfil\folio}} |
|
2483
|
1562 \global\let\contentsalignmacro = \chapoddpage |
|
2333
|
1563 } |
|
|
1564 |
|
|
1565 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} |
|
|
1566 \def\HEADINGSsinglex{% |
|
|
1567 \global\evenfootline={\hfil} |
|
|
1568 \global\oddfootline={\hfil} |
|
|
1569 \global\evenheadline={\line{\thischapter\hfil\folio}} |
|
|
1570 \global\oddheadline={\line{\thischapter\hfil\folio}} |
|
2483
|
1571 \global\let\contentsalignmacro = \chappager |
|
2333
|
1572 } |
|
|
1573 |
|
|
1574 % Subroutines used in generating headings |
|
|
1575 % Produces Day Month Year style of output. |
|
|
1576 \def\today{\number\day\space |
|
|
1577 \ifcase\month\or |
|
|
1578 January\or February\or March\or April\or May\or June\or |
|
|
1579 July\or August\or September\or October\or November\or December\fi |
|
|
1580 \space\number\year} |
|
|
1581 |
|
|
1582 % Use this if you want the Month Day, Year style of output. |
|
|
1583 %\def\today{\ifcase\month\or |
|
|
1584 %January\or February\or March\or April\or May\or June\or |
|
|
1585 %July\or August\or September\or October\or November\or December\fi |
|
|
1586 %\space\number\day, \number\year} |
|
|
1587 |
|
|
1588 % @settitle line... specifies the title of the document, for headings |
|
|
1589 % It generates no output of its own |
|
|
1590 |
|
|
1591 \def\thistitle{No Title} |
|
|
1592 \def\settitle{\parsearg\settitlezzz} |
|
|
1593 \def\settitlezzz #1{\gdef\thistitle{#1}} |
|
|
1594 |
|
2483
|
1595 |
|
2333
|
1596 \message{tables,} |
|
|
1597 |
|
|
1598 % @tabs -- simple alignment |
|
|
1599 |
|
|
1600 % These don't work. For one thing, \+ is defined as outer. |
|
|
1601 % So these macros cannot even be defined. |
|
|
1602 |
|
|
1603 %\def\tabs{\parsearg\tabszzz} |
|
|
1604 %\def\tabszzz #1{\settabs\+#1\cr} |
|
|
1605 %\def\tabline{\parsearg\tablinezzz} |
|
|
1606 %\def\tablinezzz #1{\+#1\cr} |
|
|
1607 %\def\&{&} |
|
|
1608 |
|
|
1609 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x). |
|
|
1610 |
|
|
1611 % default indentation of table text |
|
|
1612 \newdimen\tableindent \tableindent=.8in |
|
|
1613 % default indentation of @itemize and @enumerate text |
|
|
1614 \newdimen\itemindent \itemindent=.3in |
|
|
1615 % margin between end of table item and start of table text. |
|
|
1616 \newdimen\itemmargin \itemmargin=.1in |
|
|
1617 |
|
|
1618 % used internally for \itemindent minus \itemmargin |
|
|
1619 \newdimen\itemmax |
|
|
1620 |
|
|
1621 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with |
|
|
1622 % these defs. |
|
|
1623 % They also define \itemindex |
|
|
1624 % to index the item name in whatever manner is desired (perhaps none). |
|
|
1625 |
|
|
1626 \newif\ifitemxneedsnegativevskip |
|
|
1627 |
|
2483
|
1628 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} |
|
2333
|
1629 |
|
|
1630 \def\internalBitem{\smallbreak \parsearg\itemzzz} |
|
|
1631 \def\internalBitemx{\itemxpar \parsearg\itemzzz} |
|
|
1632 |
|
|
1633 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz} |
|
|
1634 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz} |
|
|
1635 |
|
|
1636 \def\internalBkitem{\smallbreak \parsearg\kitemzzz} |
|
|
1637 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz} |
|
|
1638 |
|
|
1639 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}% |
|
|
1640 \itemzzz {#1}} |
|
|
1641 |
|
|
1642 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}% |
|
|
1643 \itemzzz {#1}} |
|
|
1644 |
|
|
1645 \def\itemzzz #1{\begingroup % |
|
|
1646 \advance\hsize by -\rightskip |
|
|
1647 \advance\hsize by -\tableindent |
|
|
1648 \setbox0=\hbox{\itemfont{#1}}% |
|
|
1649 \itemindex{#1}% |
|
|
1650 \nobreak % This prevents a break before @itemx. |
|
|
1651 % |
|
|
1652 % Be sure we are not still in the middle of a paragraph. |
|
|
1653 %{\parskip = 0in |
|
|
1654 %\par |
|
|
1655 %}% |
|
|
1656 % |
|
|
1657 % If the item text does not fit in the space we have, put it on a line |
|
|
1658 % by itself, and do not allow a page break either before or after that |
|
|
1659 % line. We do not start a paragraph here because then if the next |
|
|
1660 % command is, e.g., @kindex, the whatsit would get put into the |
|
|
1661 % horizontal list on a line by itself, resulting in extra blank space. |
|
|
1662 \ifdim \wd0>\itemmax |
|
|
1663 % |
|
|
1664 % Make this a paragraph so we get the \parskip glue and wrapping, |
|
|
1665 % but leave it ragged-right. |
|
|
1666 \begingroup |
|
|
1667 \advance\leftskip by-\tableindent |
|
|
1668 \advance\hsize by\tableindent |
|
|
1669 \advance\rightskip by0pt plus1fil |
|
|
1670 \leavevmode\unhbox0\par |
|
|
1671 \endgroup |
|
|
1672 % |
|
|
1673 % We're going to be starting a paragraph, but we don't want the |
|
|
1674 % \parskip glue -- logically it's part of the @item we just started. |
|
|
1675 \nobreak \vskip-\parskip |
|
|
1676 % |
|
|
1677 % Stop a page break at the \parskip glue coming up. Unfortunately |
|
|
1678 % we can't prevent a possible page break at the following |
|
|
1679 % \baselineskip glue. |
|
|
1680 \nobreak |
|
|
1681 \endgroup |
|
|
1682 \itemxneedsnegativevskipfalse |
|
|
1683 \else |
|
|
1684 % The item text fits into the space. Start a paragraph, so that the |
|
|
1685 % following text (if any) will end up on the same line. Since that |
|
|
1686 % text will be indented by \tableindent, we make the item text be in |
|
|
1687 % a zero-width box. |
|
|
1688 \noindent |
|
|
1689 \rlap{\hskip -\tableindent\box0}\ignorespaces% |
|
|
1690 \endgroup% |
|
|
1691 \itemxneedsnegativevskiptrue% |
|
|
1692 \fi |
|
|
1693 } |
|
|
1694 |
|
|
1695 \def\item{\errmessage{@item while not in a table}} |
|
|
1696 \def\itemx{\errmessage{@itemx while not in a table}} |
|
|
1697 \def\kitem{\errmessage{@kitem while not in a table}} |
|
|
1698 \def\kitemx{\errmessage{@kitemx while not in a table}} |
|
|
1699 \def\xitem{\errmessage{@xitem while not in a table}} |
|
|
1700 \def\xitemx{\errmessage{@xitemx while not in a table}} |
|
|
1701 |
|
|
1702 %% Contains a kludge to get @end[description] to work |
|
|
1703 \def\description{\tablez{\dontindex}{1}{}{}{}{}} |
|
|
1704 |
|
|
1705 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex} |
|
|
1706 {\obeylines\obeyspaces% |
|
|
1707 \gdef\tablex #1^^M{% |
|
|
1708 \tabley\dontindex#1 \endtabley}} |
|
|
1709 |
|
|
1710 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex} |
|
|
1711 {\obeylines\obeyspaces% |
|
|
1712 \gdef\ftablex #1^^M{% |
|
|
1713 \tabley\fnitemindex#1 \endtabley |
|
|
1714 \def\Eftable{\endgraf\afterenvbreak\endgroup}% |
|
|
1715 \let\Etable=\relax}} |
|
|
1716 |
|
|
1717 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex} |
|
|
1718 {\obeylines\obeyspaces% |
|
|
1719 \gdef\vtablex #1^^M{% |
|
|
1720 \tabley\vritemindex#1 \endtabley |
|
|
1721 \def\Evtable{\endgraf\afterenvbreak\endgroup}% |
|
|
1722 \let\Etable=\relax}} |
|
|
1723 |
|
|
1724 \def\dontindex #1{} |
|
|
1725 \def\fnitemindex #1{\doind {fn}{\code{#1}}}% |
|
|
1726 \def\vritemindex #1{\doind {vr}{\code{#1}}}% |
|
|
1727 |
|
|
1728 {\obeyspaces % |
|
|
1729 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup% |
|
|
1730 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}} |
|
|
1731 |
|
|
1732 \def\tablez #1#2#3#4#5#6{% |
|
|
1733 \aboveenvbreak % |
|
|
1734 \begingroup % |
|
2483
|
1735 \def\Edescription{\Etable}% Necessary kludge. |
|
2333
|
1736 \let\itemindex=#1% |
|
|
1737 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi % |
|
|
1738 \ifnum 0#4>0 \tableindent=#4\mil \fi % |
|
|
1739 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi % |
|
|
1740 \def\itemfont{#2}% |
|
|
1741 \itemmax=\tableindent % |
|
|
1742 \advance \itemmax by -\itemmargin % |
|
|
1743 \advance \leftskip by \tableindent % |
|
|
1744 \exdentamount=\tableindent |
|
|
1745 \parindent = 0pt |
|
|
1746 \parskip = \smallskipamount |
|
|
1747 \ifdim \parskip=0pt \parskip=2pt \fi% |
|
|
1748 \def\Etable{\endgraf\afterenvbreak\endgroup}% |
|
|
1749 \let\item = \internalBitem % |
|
|
1750 \let\itemx = \internalBitemx % |
|
|
1751 \let\kitem = \internalBkitem % |
|
|
1752 \let\kitemx = \internalBkitemx % |
|
|
1753 \let\xitem = \internalBxitem % |
|
|
1754 \let\xitemx = \internalBxitemx % |
|
|
1755 } |
|
|
1756 |
|
|
1757 % This is the counter used by @enumerate, which is really @itemize |
|
|
1758 |
|
|
1759 \newcount \itemno |
|
|
1760 |
|
|
1761 \def\itemize{\parsearg\itemizezzz} |
|
|
1762 |
|
|
1763 \def\itemizezzz #1{% |
|
|
1764 \begingroup % ended by the @end itemsize |
|
|
1765 \itemizey {#1}{\Eitemize} |
|
|
1766 } |
|
|
1767 |
|
|
1768 \def\itemizey #1#2{% |
|
|
1769 \aboveenvbreak % |
|
|
1770 \itemmax=\itemindent % |
|
|
1771 \advance \itemmax by -\itemmargin % |
|
|
1772 \advance \leftskip by \itemindent % |
|
|
1773 \exdentamount=\itemindent |
|
|
1774 \parindent = 0pt % |
|
|
1775 \parskip = \smallskipamount % |
|
|
1776 \ifdim \parskip=0pt \parskip=2pt \fi% |
|
|
1777 \def#2{\endgraf\afterenvbreak\endgroup}% |
|
|
1778 \def\itemcontents{#1}% |
|
|
1779 \let\item=\itemizeitem} |
|
|
1780 |
|
|
1781 % Set sfcode to normal for the chars that usually have another value. |
|
|
1782 % These are `.?!:;,' |
|
|
1783 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000 |
|
|
1784 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 } |
|
|
1785 |
|
|
1786 % \splitoff TOKENS\endmark defines \first to be the first token in |
|
|
1787 % TOKENS, and \rest to be the remainder. |
|
|
1788 % |
|
|
1789 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% |
|
|
1790 |
|
|
1791 % Allow an optional argument of an uppercase letter, lowercase letter, |
|
|
1792 % or number, to specify the first label in the enumerated list. No |
|
|
1793 % argument is the same as `1'. |
|
|
1794 % |
|
|
1795 \def\enumerate{\parsearg\enumeratezzz} |
|
|
1796 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey} |
|
|
1797 \def\enumeratey #1 #2\endenumeratey{% |
|
|
1798 \begingroup % ended by the @end enumerate |
|
|
1799 % |
|
|
1800 % If we were given no argument, pretend we were given `1'. |
|
|
1801 \def\thearg{#1}% |
|
|
1802 \ifx\thearg\empty \def\thearg{1}\fi |
|
|
1803 % |
|
|
1804 % Detect if the argument is a single token. If so, it might be a |
|
|
1805 % letter. Otherwise, the only valid thing it can be is a number. |
|
|
1806 % (We will always have one token, because of the test we just made. |
|
|
1807 % This is a good thing, since \splitoff doesn't work given nothing at |
|
|
1808 % all -- the first parameter is undelimited.) |
|
|
1809 \expandafter\splitoff\thearg\endmark |
|
|
1810 \ifx\rest\empty |
|
|
1811 % Only one token in the argument. It could still be anything. |
|
|
1812 % A ``lowercase letter'' is one whose \lccode is nonzero. |
|
|
1813 % An ``uppercase letter'' is one whose \lccode is both nonzero, and |
|
|
1814 % not equal to itself. |
|
|
1815 % Otherwise, we assume it's a number. |
|
|
1816 % |
|
|
1817 % We need the \relax at the end of the \ifnum lines to stop TeX from |
|
|
1818 % continuing to look for a <number>. |
|
|
1819 % |
|
|
1820 \ifnum\lccode\expandafter`\thearg=0\relax |
|
|
1821 \numericenumerate % a number (we hope) |
|
|
1822 \else |
|
|
1823 % It's a letter. |
|
|
1824 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax |
|
|
1825 \lowercaseenumerate % lowercase letter |
|
|
1826 \else |
|
|
1827 \uppercaseenumerate % uppercase letter |
|
|
1828 \fi |
|
|
1829 \fi |
|
|
1830 \else |
|
|
1831 % Multiple tokens in the argument. We hope it's a number. |
|
|
1832 \numericenumerate |
|
|
1833 \fi |
|
|
1834 } |
|
|
1835 |
|
|
1836 % An @enumerate whose labels are integers. The starting integer is |
|
|
1837 % given in \thearg. |
|
|
1838 % |
|
|
1839 \def\numericenumerate{% |
|
|
1840 \itemno = \thearg |
|
|
1841 \startenumeration{\the\itemno}% |
|
|
1842 } |
|
|
1843 |
|
|
1844 % The starting (lowercase) letter is in \thearg. |
|
|
1845 \def\lowercaseenumerate{% |
|
|
1846 \itemno = \expandafter`\thearg |
|
|
1847 \startenumeration{% |
|
|
1848 % Be sure we're not beyond the end of the alphabet. |
|
|
1849 \ifnum\itemno=0 |
|
|
1850 \errmessage{No more lowercase letters in @enumerate; get a bigger |
|
|
1851 alphabet}% |
|
|
1852 \fi |
|
|
1853 \char\lccode\itemno |
|
|
1854 }% |
|
|
1855 } |
|
|
1856 |
|
|
1857 % The starting (uppercase) letter is in \thearg. |
|
|
1858 \def\uppercaseenumerate{% |
|
|
1859 \itemno = \expandafter`\thearg |
|
|
1860 \startenumeration{% |
|
|
1861 % Be sure we're not beyond the end of the alphabet. |
|
|
1862 \ifnum\itemno=0 |
|
|
1863 \errmessage{No more uppercase letters in @enumerate; get a bigger |
|
|
1864 alphabet} |
|
|
1865 \fi |
|
|
1866 \char\uccode\itemno |
|
|
1867 }% |
|
|
1868 } |
|
|
1869 |
|
|
1870 % Call itemizey, adding a period to the first argument and supplying the |
|
|
1871 % common last two arguments. Also subtract one from the initial value in |
|
|
1872 % \itemno, since @item increments \itemno. |
|
|
1873 % |
|
|
1874 \def\startenumeration#1{% |
|
|
1875 \advance\itemno by -1 |
|
|
1876 \itemizey{#1.}\Eenumerate\flushcr |
|
|
1877 } |
|
|
1878 |
|
|
1879 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg |
|
|
1880 % to @enumerate. |
|
|
1881 % |
|
|
1882 \def\alphaenumerate{\enumerate{a}} |
|
|
1883 \def\capsenumerate{\enumerate{A}} |
|
|
1884 \def\Ealphaenumerate{\Eenumerate} |
|
|
1885 \def\Ecapsenumerate{\Eenumerate} |
|
|
1886 |
|
|
1887 % Definition of @item while inside @itemize. |
|
|
1888 |
|
|
1889 \def\itemizeitem{% |
|
|
1890 \advance\itemno by 1 |
|
|
1891 {\let\par=\endgraf \smallbreak}% |
|
|
1892 \ifhmode \errmessage{\in hmode at itemizeitem}\fi |
|
|
1893 {\parskip=0in \hskip 0pt |
|
|
1894 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}% |
|
|
1895 \vadjust{\penalty 1200}}% |
|
|
1896 \flushcr} |
|
|
1897 |
|
|
1898 % @multitable macros |
|
2483
|
1899 % Amy Hendrickson, 8/18/94, 3/6/96 |
|
2333
|
1900 % |
|
2483
|
1901 % @multitable ... @end multitable will make as many columns as desired. |
|
|
1902 % Contents of each column will wrap at width given in preamble. Width |
|
2333
|
1903 % can be specified either with sample text given in a template line, |
|
|
1904 % or in percent of \hsize, the current width of text on page. |
|
|
1905 |
|
|
1906 % Table can continue over pages but will only break between lines. |
|
|
1907 |
|
|
1908 % To make preamble: |
|
|
1909 % |
|
2670
|
1910 % Either define widths of columns in terms of percent of \hsize: |
|
2483
|
1911 % @multitable @columnfractions .25 .3 .45 |
|
2333
|
1912 % @item ... |
|
|
1913 % |
|
2483
|
1914 % Numbers following @columnfractions are the percent of the total |
|
2333
|
1915 % current hsize to be used for each column. You may use as many |
|
|
1916 % columns as desired. |
|
|
1917 |
|
2483
|
1918 |
|
2333
|
1919 % Or use a template: |
|
|
1920 % @multitable {Column 1 template} {Column 2 template} {Column 3 template} |
|
|
1921 % @item ... |
|
|
1922 % using the widest term desired in each column. |
|
2483
|
1923 % |
|
|
1924 % For those who want to use more than one line's worth of words in |
|
|
1925 % the preamble, break the line within one argument and it |
|
|
1926 % will parse correctly, i.e., |
|
|
1927 % |
|
2670
|
1928 % @multitable {Column 1 template} {Column 2 template} {Column 3 |
|
2483
|
1929 % template} |
|
|
1930 % Not: |
|
2670
|
1931 % @multitable {Column 1 template} {Column 2 template} |
|
2483
|
1932 % {Column 3 template} |
|
2333
|
1933 |
|
2670
|
1934 % Each new table line starts with @item, each subsequent new column |
|
2333
|
1935 % starts with @tab. Empty columns may be produced by supplying @tab's |
|
|
1936 % with nothing between them for as many times as empty columns are needed, |
|
|
1937 % ie, @tab@tab@tab will produce two empty columns. |
|
|
1938 |
|
2483
|
1939 % @item, @tab, @multitable or @end multitable do not need to be on their |
|
2333
|
1940 % own lines, but it will not hurt if they are. |
|
|
1941 |
|
|
1942 % Sample multitable: |
|
|
1943 |
|
|
1944 % @multitable {Column 1 template} {Column 2 template} {Column 3 template} |
|
|
1945 % @item first col stuff @tab second col stuff @tab third col |
|
2670
|
1946 % @item |
|
|
1947 % first col stuff |
|
|
1948 % @tab |
|
|
1949 % second col stuff |
|
|
1950 % @tab |
|
|
1951 % third col |
|
|
1952 % @item first col stuff @tab second col stuff |
|
2333
|
1953 % @tab Many paragraphs of text may be used in any column. |
|
2670
|
1954 % |
|
2333
|
1955 % They will wrap at the width determined by the template. |
|
|
1956 % @item@tab@tab This will be in third column. |
|
2483
|
1957 % @end multitable |
|
2333
|
1958 |
|
|
1959 % Default dimensions may be reset by user. |
|
2483
|
1960 % @multitableparskip is vertical space between paragraphs in table. |
|
|
1961 % @multitableparindent is paragraph indent in table. |
|
|
1962 % @multitablecolmargin is horizontal space to be left between columns. |
|
|
1963 % @multitablelinespace is space to leave between table items, baseline |
|
|
1964 % to baseline. |
|
|
1965 % 0pt means it depends on current normal line spacing. |
|
2333
|
1966 |
|
|
1967 %%%% |
|
2670
|
1968 % Dimensions |
|
2333
|
1969 |
|
2483
|
1970 \newskip\multitableparskip |
|
|
1971 \newskip\multitableparindent |
|
|
1972 \newdimen\multitablecolspace |
|
|
1973 \newskip\multitablelinespace |
|
|
1974 \multitableparskip=0pt |
|
|
1975 \multitableparindent=6pt |
|
|
1976 \multitablecolspace=12pt |
|
|
1977 \multitablelinespace=0pt |
|
2333
|
1978 |
|
|
1979 %%%% |
|
|
1980 % Macros used to set up halign preamble: |
|
|
1981 \let\endsetuptable\relax |
|
|
1982 \def\xendsetuptable{\endsetuptable} |
|
2483
|
1983 \let\columnfractions\relax |
|
|
1984 \def\xcolumnfractions{\columnfractions} |
|
2333
|
1985 \newif\ifsetpercent |
|
|
1986 |
|
2483
|
1987 %% 2/1/96, to allow fractions to be given with more than one digit. |
|
|
1988 \def\pickupwholefraction#1 {\global\advance\colcount by1 % |
|
|
1989 \expandafter\xdef\csname col\the\colcount\endcsname{.#1\hsize}% |
|
|
1990 \setuptable} |
|
|
1991 |
|
2333
|
1992 \newcount\colcount |
|
|
1993 \def\setuptable#1{\def\firstarg{#1}% |
|
|
1994 \ifx\firstarg\xendsetuptable\let\go\relax% |
|
|
1995 \else |
|
2483
|
1996 \ifx\firstarg\xcolumnfractions\global\setpercenttrue% |
|
2333
|
1997 \else |
|
|
1998 \ifsetpercent |
|
2483
|
1999 \let\go\pickupwholefraction % In this case arg of setuptable |
|
|
2000 % is the decimal point before the |
|
|
2001 % number given in percent of hsize. |
|
|
2002 % We don't need this so we don't use it. |
|
2333
|
2003 \else |
|
|
2004 \global\advance\colcount by1 |
|
2483
|
2005 \setbox0=\hbox{#1 }% Add a normal word space as a separator; |
|
|
2006 % typically that is always in the input, anyway. |
|
2333
|
2007 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% |
|
|
2008 \fi% |
|
|
2009 \fi% |
|
2483
|
2010 \ifx\go\pickupwholefraction\else\let\go\setuptable\fi% |
|
2333
|
2011 \fi\go} |
|
2483
|
2012 |
|
2333
|
2013 %%%% |
|
|
2014 % multitable syntax |
|
2483
|
2015 \def\tab{&\hskip1sp\relax} % 2/2/96 |
|
|
2016 % tiny skip here makes sure this column space is |
|
|
2017 % maintained, even if it is never used. |
|
|
2018 |
|
2333
|
2019 |
|
|
2020 %%%% |
|
2483
|
2021 % @multitable ... @end multitable definitions: |
|
|
2022 |
|
|
2023 \def\multitable{\parsearg\dotable} |
|
|
2024 |
|
|
2025 \def\dotable#1{\bgroup |
|
2333
|
2026 \let\item\cr |
|
|
2027 \tolerance=9500 |
|
|
2028 \hbadness=9500 |
|
2483
|
2029 \setmultitablespacing |
|
|
2030 \parskip=\multitableparskip |
|
|
2031 \parindent=\multitableparindent |
|
2333
|
2032 \overfullrule=0pt |
|
|
2033 \global\colcount=0\relax% |
|
|
2034 \def\Emultitable{\global\setpercentfalse\global\everycr{}\cr\egroup\egroup}% |
|
|
2035 % To parse everything between @multitable and @item : |
|
2483
|
2036 \setuptable#1 \endsetuptable |
|
2333
|
2037 % Need to reset this to 0 after \setuptable. |
|
2670
|
2038 \global\colcount=0\relax% |
|
2333
|
2039 % |
|
|
2040 % This preamble sets up a generic column definition, which will |
|
|
2041 % be used as many times as user calls for columns. |
|
2670
|
2042 % \vtop will set a single line and will also let text wrap and |
|
2333
|
2043 % continue for many paragraphs if desired. |
|
|
2044 \halign\bgroup&\global\advance\colcount by 1\relax% |
|
2483
|
2045 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname |
|
2333
|
2046 % In order to keep entries from bumping into each other |
|
2483
|
2047 % we will add a \leftskip of \multitablecolspace to all columns after |
|
2333
|
2048 % the first one. |
|
2670
|
2049 % If a template has been used, we will add \multitablecolspace |
|
2333
|
2050 % to the width of each template entry. |
|
|
2051 % If user has set preamble in terms of percent of \hsize |
|
|
2052 % we will use that dimension as the width of the column, and |
|
|
2053 % the \leftskip will keep entries from bumping into each other. |
|
|
2054 % Table will start at left margin and final column will justify at |
|
|
2055 % right margin. |
|
|
2056 \ifnum\colcount=1 |
|
|
2057 \else |
|
|
2058 \ifsetpercent |
|
|
2059 \else |
|
|
2060 % If user has <not> set preamble in terms of percent of \hsize |
|
2670
|
2061 % we will advance \hsize by \multitablecolspace |
|
2483
|
2062 \advance\hsize by \multitablecolspace |
|
2333
|
2063 \fi |
|
2483
|
2064 % In either case we will make \leftskip=\multitablecolspace: |
|
|
2065 \leftskip=\multitablecolspace |
|
2333
|
2066 \fi |
|
2670
|
2067 % Ignoring space at the beginning and end avoids an occasional spurious |
|
|
2068 % blank line, when TeX decides to break the line at the space before the |
|
|
2069 % box from the multistrut, so the strut ends up on a line by itself. |
|
|
2070 % For example: |
|
|
2071 % @multitable @columnfractions .11 .89 |
|
|
2072 % @item @code{#} |
|
|
2073 % @tab Legal holiday which is valid in major parts of the whole country. |
|
|
2074 % Is automatically provided with highlighting sequences respectively marking |
|
|
2075 % characters. |
|
|
2076 \noindent\ignorespaces##\unskip\multistrut}\cr |
|
2333
|
2077 % \everycr will reset column counter, \colcount, at the end of |
|
2670
|
2078 % each line. Every column entry will cause \colcount to advance by one. |
|
2333
|
2079 % The table preamble |
|
|
2080 % looks at the current \colcount to find the correct column width. |
|
2483
|
2081 \global\everycr{\noalign{% |
|
2670
|
2082 % \filbreak%% keeps underfull box messages off when table breaks over pages. |
|
|
2083 % Maybe so, but it also creates really weird page breaks when the table |
|
|
2084 % breaks over pages Wouldn't \vfil be better? Wait until the problem |
|
|
2085 % manifests itself, so it can be fixed for real --karl. |
|
2483
|
2086 \global\colcount=0\relax}} |
|
|
2087 } |
|
|
2088 |
|
|
2089 \def\setmultitablespacing{% test to see if user has set \multitablelinespace. |
|
|
2090 % If so, do nothing. If not, give it an appropriate dimension based on |
|
|
2091 % current baselineskip. |
|
|
2092 \ifdim\multitablelinespace=0pt |
|
|
2093 %% strut to put in table in case some entry doesn't have descenders, |
|
|
2094 %% to keep lines equally spaced |
|
|
2095 \let\multistrut = \strut |
|
|
2096 %% Test to see if parskip is larger than space between lines of |
|
2670
|
2097 %% table. If not, do nothing. |
|
2483
|
2098 %% If so, set to same dimension as multitablelinespace. |
|
|
2099 \else |
|
|
2100 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0 |
|
|
2101 width0pt\relax} \fi |
|
|
2102 \ifdim\multitableparskip>\multitablelinespace |
|
|
2103 \global\multitableparskip=\multitablelinespace |
|
|
2104 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller |
|
|
2105 %% than skip between lines in the table. |
|
|
2106 \fi% |
|
|
2107 \ifdim\multitableparskip=0pt |
|
|
2108 \global\multitableparskip=\multitablelinespace |
|
|
2109 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller |
|
|
2110 %% than skip between lines in the table. |
|
|
2111 \fi} |
|
|
2112 |
|
2333
|
2113 |
|
|
2114 \message{indexing,} |
|
|
2115 % Index generation facilities |
|
|
2116 |
|
|
2117 % Define \newwrite to be identical to plain tex's \newwrite |
|
|
2118 % except not \outer, so it can be used within \newindex. |
|
|
2119 {\catcode`\@=11 |
|
|
2120 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}} |
|
|
2121 |
|
|
2122 % \newindex {foo} defines an index named foo. |
|
|
2123 % It automatically defines \fooindex such that |
|
|
2124 % \fooindex ...rest of line... puts an entry in the index foo. |
|
|
2125 % It also defines \fooindfile to be the number of the output channel for |
|
|
2126 % the file that accumulates this index. The file's extension is foo. |
|
|
2127 % The name of an index should be no more than 2 characters long |
|
|
2128 % for the sake of vms. |
|
|
2129 |
|
|
2130 \def\newindex #1{ |
|
|
2131 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file |
|
|
2132 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file |
|
|
2133 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex |
|
|
2134 \noexpand\doindex {#1}} |
|
|
2135 } |
|
|
2136 |
|
|
2137 % @defindex foo == \newindex{foo} |
|
|
2138 |
|
|
2139 \def\defindex{\parsearg\newindex} |
|
|
2140 |
|
|
2141 % Define @defcodeindex, like @defindex except put all entries in @code. |
|
|
2142 |
|
|
2143 \def\newcodeindex #1{ |
|
|
2144 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file |
|
|
2145 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file |
|
|
2146 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex |
|
|
2147 \noexpand\docodeindex {#1}} |
|
|
2148 } |
|
|
2149 |
|
|
2150 \def\defcodeindex{\parsearg\newcodeindex} |
|
|
2151 |
|
|
2152 % @synindex foo bar makes index foo feed into index bar. |
|
|
2153 % Do this instead of @defindex foo if you don't want it as a separate index. |
|
|
2154 \def\synindex #1 #2 {% |
|
|
2155 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname |
|
|
2156 \expandafter\let\csname#1indfile\endcsname=\synindexfoo |
|
|
2157 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex |
|
|
2158 \noexpand\doindex {#2}}% |
|
|
2159 } |
|
|
2160 |
|
|
2161 % @syncodeindex foo bar similar, but put all entries made for index foo |
|
|
2162 % inside @code. |
|
|
2163 \def\syncodeindex #1 #2 {% |
|
|
2164 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname |
|
|
2165 \expandafter\let\csname#1indfile\endcsname=\synindexfoo |
|
|
2166 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex |
|
|
2167 \noexpand\docodeindex {#2}}% |
|
|
2168 } |
|
|
2169 |
|
|
2170 % Define \doindex, the driver for all \fooindex macros. |
|
|
2171 % Argument #1 is generated by the calling \fooindex macro, |
|
|
2172 % and it is "foo", the name of the index. |
|
|
2173 |
|
|
2174 % \doindex just uses \parsearg; it calls \doind for the actual work. |
|
|
2175 % This is because \doind is more useful to call from other macros. |
|
|
2176 |
|
|
2177 % There is also \dosubind {index}{topic}{subtopic} |
|
|
2178 % which makes an entry in a two-level index such as the operation index. |
|
|
2179 |
|
|
2180 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} |
|
|
2181 \def\singleindexer #1{\doind{\indexname}{#1}} |
|
|
2182 |
|
|
2183 % like the previous two, but they put @code around the argument. |
|
|
2184 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} |
|
|
2185 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} |
|
|
2186 |
|
|
2187 \def\indexdummies{% |
|
|
2188 % Take care of the plain tex accent commands. |
|
|
2189 \def\"{\realbackslash "}% |
|
|
2190 \def\`{\realbackslash `}% |
|
|
2191 \def\'{\realbackslash '}% |
|
|
2192 \def\^{\realbackslash ^}% |
|
|
2193 \def\~{\realbackslash ~}% |
|
|
2194 \def\={\realbackslash =}% |
|
|
2195 \def\b{\realbackslash b}% |
|
|
2196 \def\c{\realbackslash c}% |
|
|
2197 \def\d{\realbackslash d}% |
|
|
2198 \def\u{\realbackslash u}% |
|
|
2199 \def\v{\realbackslash v}% |
|
|
2200 \def\H{\realbackslash H}% |
|
|
2201 % Take care of the plain tex special European modified letters. |
|
|
2202 \def\oe{\realbackslash oe}% |
|
|
2203 \def\ae{\realbackslash ae}% |
|
|
2204 \def\aa{\realbackslash aa}% |
|
|
2205 \def\OE{\realbackslash OE}% |
|
|
2206 \def\AE{\realbackslash AE}% |
|
|
2207 \def\AA{\realbackslash AA}% |
|
|
2208 \def\o{\realbackslash o}% |
|
|
2209 \def\O{\realbackslash O}% |
|
|
2210 \def\l{\realbackslash l}% |
|
|
2211 \def\L{\realbackslash L}% |
|
|
2212 \def\ss{\realbackslash ss}% |
|
|
2213 % Take care of texinfo commands likely to appear in an index entry. |
|
2483
|
2214 % (Must be a way to avoid doing expansion at all, and thus not have to |
|
|
2215 % laboriously list every single command here.) |
|
|
2216 \def\@{@}% will be @@ when we switch to @ as escape char. |
|
|
2217 %\let\{ = \lbracecmd |
|
|
2218 %\let\} = \rbracecmd |
|
2333
|
2219 \def\_{{\realbackslash _}}% |
|
|
2220 \def\w{\realbackslash w }% |
|
|
2221 \def\bf{\realbackslash bf }% |
|
2483
|
2222 %\def\rm{\realbackslash rm }% |
|
2333
|
2223 \def\sl{\realbackslash sl }% |
|
|
2224 \def\sf{\realbackslash sf}% |
|
|
2225 \def\tt{\realbackslash tt}% |
|
|
2226 \def\gtr{\realbackslash gtr}% |
|
|
2227 \def\less{\realbackslash less}% |
|
|
2228 \def\hat{\realbackslash hat}% |
|
2483
|
2229 %\def\char{\realbackslash char}% |
|
2333
|
2230 \def\TeX{\realbackslash TeX}% |
|
|
2231 \def\dots{\realbackslash dots }% |
|
|
2232 \def\copyright{\realbackslash copyright }% |
|
|
2233 \def\tclose##1{\realbackslash tclose {##1}}% |
|
|
2234 \def\code##1{\realbackslash code {##1}}% |
|
2483
|
2235 \def\dotless##1{\realbackslash dotless {##1}}% |
|
2333
|
2236 \def\samp##1{\realbackslash samp {##1}}% |
|
2483
|
2237 \def\,##1{\realbackslash ,{##1}}% |
|
|
2238 \def\t##1{\realbackslash t {##1}}% |
|
2333
|
2239 \def\r##1{\realbackslash r {##1}}% |
|
|
2240 \def\i##1{\realbackslash i {##1}}% |
|
|
2241 \def\b##1{\realbackslash b {##1}}% |
|
|
2242 \def\cite##1{\realbackslash cite {##1}}% |
|
|
2243 \def\key##1{\realbackslash key {##1}}% |
|
|
2244 \def\file##1{\realbackslash file {##1}}% |
|
|
2245 \def\var##1{\realbackslash var {##1}}% |
|
|
2246 \def\kbd##1{\realbackslash kbd {##1}}% |
|
|
2247 \def\dfn##1{\realbackslash dfn {##1}}% |
|
|
2248 \def\emph##1{\realbackslash emph {##1}}% |
|
2483
|
2249 \unsepspaces |
|
2333
|
2250 } |
|
|
2251 |
|
2483
|
2252 % If an index command is used in an @example environment, any spaces |
|
|
2253 % therein should become regular spaces in the raw index file, not the |
|
|
2254 % expansion of \tie (\\leavevmode \penalty \@M \ ). |
|
|
2255 {\obeyspaces |
|
|
2256 \gdef\unsepspaces{\obeyspaces\let =\space}} |
|
|
2257 |
|
2333
|
2258 % \indexnofonts no-ops all font-change commands. |
|
|
2259 % This is used when outputting the strings to sort the index by. |
|
|
2260 \def\indexdummyfont#1{#1} |
|
|
2261 \def\indexdummytex{TeX} |
|
|
2262 \def\indexdummydots{...} |
|
|
2263 |
|
|
2264 \def\indexnofonts{% |
|
|
2265 % Just ignore accents. |
|
2483
|
2266 \let\,=\indexdummyfont |
|
2333
|
2267 \let\"=\indexdummyfont |
|
|
2268 \let\`=\indexdummyfont |
|
|
2269 \let\'=\indexdummyfont |
|
|
2270 \let\^=\indexdummyfont |
|
|
2271 \let\~=\indexdummyfont |
|
|
2272 \let\==\indexdummyfont |
|
|
2273 \let\b=\indexdummyfont |
|
|
2274 \let\c=\indexdummyfont |
|
|
2275 \let\d=\indexdummyfont |
|
|
2276 \let\u=\indexdummyfont |
|
|
2277 \let\v=\indexdummyfont |
|
|
2278 \let\H=\indexdummyfont |
|
2483
|
2279 \let\dotless=\indexdummyfont |
|
2333
|
2280 % Take care of the plain tex special European modified letters. |
|
|
2281 \def\oe{oe}% |
|
|
2282 \def\ae{ae}% |
|
|
2283 \def\aa{aa}% |
|
|
2284 \def\OE{OE}% |
|
|
2285 \def\AE{AE}% |
|
|
2286 \def\AA{AA}% |
|
|
2287 \def\o{o}% |
|
|
2288 \def\O{O}% |
|
|
2289 \def\l{l}% |
|
|
2290 \def\L{L}% |
|
|
2291 \def\ss{ss}% |
|
|
2292 \let\w=\indexdummyfont |
|
|
2293 \let\t=\indexdummyfont |
|
|
2294 \let\r=\indexdummyfont |
|
|
2295 \let\i=\indexdummyfont |
|
|
2296 \let\b=\indexdummyfont |
|
|
2297 \let\emph=\indexdummyfont |
|
|
2298 \let\strong=\indexdummyfont |
|
|
2299 \let\cite=\indexdummyfont |
|
|
2300 \let\sc=\indexdummyfont |
|
|
2301 %Don't no-op \tt, since it isn't a user-level command |
|
|
2302 % and is used in the definitions of the active chars like <, >, |... |
|
|
2303 %\let\tt=\indexdummyfont |
|
|
2304 \let\tclose=\indexdummyfont |
|
|
2305 \let\code=\indexdummyfont |
|
|
2306 \let\file=\indexdummyfont |
|
|
2307 \let\samp=\indexdummyfont |
|
|
2308 \let\kbd=\indexdummyfont |
|
|
2309 \let\key=\indexdummyfont |
|
|
2310 \let\var=\indexdummyfont |
|
|
2311 \let\TeX=\indexdummytex |
|
|
2312 \let\dots=\indexdummydots |
|
2483
|
2313 \def\@{@}% |
|
2333
|
2314 } |
|
|
2315 |
|
|
2316 % To define \realbackslash, we must make \ not be an escape. |
|
|
2317 % We must first make another character (@) an escape |
|
|
2318 % so we do not become unable to do a definition. |
|
|
2319 |
|
|
2320 {\catcode`\@=0 \catcode`\\=\other |
|
|
2321 @gdef@realbackslash{\}} |
|
|
2322 |
|
|
2323 \let\indexbackslash=0 %overridden during \printindex. |
|
|
2324 |
|
|
2325 \let\SETmarginindex=\relax %initialize! |
|
|
2326 % workhorse for all \fooindexes |
|
|
2327 % #1 is name of index, #2 is stuff to put there |
|
|
2328 \def\doind #1#2{% |
|
2483
|
2329 % Put the index entry in the margin if desired. |
|
|
2330 \ifx\SETmarginindex\relax\else |
|
|
2331 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}% |
|
|
2332 \fi |
|
|
2333 {% |
|
|
2334 \count255=\lastpenalty |
|
|
2335 {% |
|
|
2336 \indexdummies % Must do this here, since \bf, etc expand at this stage |
|
|
2337 \escapechar=`\\ |
|
|
2338 {% |
|
2670
|
2339 \let\folio=0% We will expand all macros now EXCEPT \folio. |
|
2483
|
2340 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now |
|
|
2341 % so it will be output as is; and it will print as backslash. |
|
|
2342 % |
|
|
2343 % First process the index-string with all font commands turned off |
|
|
2344 % to get the string to sort by. |
|
|
2345 {\indexnofonts \xdef\indexsorttmp{#2}}% |
|
|
2346 % |
|
|
2347 % Now produce the complete index entry, with both the sort key and the |
|
|
2348 % original text, including any font commands. |
|
|
2349 \toks0 = {#2}% |
|
|
2350 \edef\temp{% |
|
|
2351 \write\csname#1indfile\endcsname{% |
|
|
2352 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}% |
|
|
2353 }% |
|
|
2354 \temp |
|
|
2355 }% |
|
|
2356 }% |
|
|
2357 \penalty\count255 |
|
|
2358 }% |
|
|
2359 } |
|
2333
|
2360 |
|
|
2361 \def\dosubind #1#2#3{% |
|
|
2362 {\count10=\lastpenalty % |
|
|
2363 {\indexdummies % Must do this here, since \bf, etc expand at this stage |
|
|
2364 \escapechar=`\\% |
|
|
2365 {\let\folio=0% |
|
|
2366 \def\rawbackslashxx{\indexbackslash}% |
|
|
2367 % |
|
|
2368 % Now process the index-string once, with all font commands turned off, |
|
|
2369 % to get the string to sort the index by. |
|
|
2370 {\indexnofonts |
|
|
2371 \xdef\temp1{#2 #3}% |
|
|
2372 }% |
|
|
2373 % Now produce the complete index entry. We process the index-string again, |
|
|
2374 % this time with font commands expanded, to get what to print in the index. |
|
|
2375 \edef\temp{% |
|
|
2376 \write \csname#1indfile\endcsname{% |
|
|
2377 \realbackslash entry {\temp1}{\folio}{#2}{#3}}}% |
|
|
2378 \temp }% |
|
|
2379 }\penalty\count10}} |
|
|
2380 |
|
|
2381 % The index entry written in the file actually looks like |
|
|
2382 % \entry {sortstring}{page}{topic} |
|
|
2383 % or |
|
|
2384 % \entry {sortstring}{page}{topic}{subtopic} |
|
|
2385 % The texindex program reads in these files and writes files |
|
|
2386 % containing these kinds of lines: |
|
|
2387 % \initial {c} |
|
|
2388 % before the first topic whose initial is c |
|
|
2389 % \entry {topic}{pagelist} |
|
|
2390 % for a topic that is used without subtopics |
|
|
2391 % \primary {topic} |
|
|
2392 % for the beginning of a topic that is used with subtopics |
|
|
2393 % \secondary {subtopic}{pagelist} |
|
|
2394 % for each subtopic. |
|
|
2395 |
|
|
2396 % Define the user-accessible indexing commands |
|
|
2397 % @findex, @vindex, @kindex, @cindex. |
|
|
2398 |
|
|
2399 \def\findex {\fnindex} |
|
|
2400 \def\kindex {\kyindex} |
|
|
2401 \def\cindex {\cpindex} |
|
|
2402 \def\vindex {\vrindex} |
|
|
2403 \def\tindex {\tpindex} |
|
|
2404 \def\pindex {\pgindex} |
|
|
2405 |
|
|
2406 \def\cindexsub {\begingroup\obeylines\cindexsub} |
|
|
2407 {\obeylines % |
|
|
2408 \gdef\cindexsub "#1" #2^^M{\endgroup % |
|
|
2409 \dosubind{cp}{#2}{#1}}} |
|
|
2410 |
|
|
2411 % Define the macros used in formatting output of the sorted index material. |
|
|
2412 |
|
|
2413 % This is what you call to cause a particular index to get printed. |
|
|
2414 % Write |
|
|
2415 % @unnumbered Function Index |
|
|
2416 % @printindex fn |
|
|
2417 |
|
|
2418 \def\printindex{\parsearg\doprintindex} |
|
|
2419 |
|
2483
|
2420 \def\doprintindex#1{\begingroup |
|
|
2421 \dobreak \chapheadingskip{10000}% |
|
2333
|
2422 % |
|
2483
|
2423 \indexfonts \rm |
|
|
2424 \tolerance = 9500 |
|
|
2425 \indexbreaks |
|
|
2426 \def\indexbackslash{\rawbackslashxx}% |
|
|
2427 % Index files are almost Texinfo source, but we use \ as the escape |
|
|
2428 % character. It would be better to use @, but that's too big a change |
|
|
2429 % to make right now. |
|
|
2430 \catcode`\\ = 0 |
|
|
2431 \catcode`\@ = 11 |
|
|
2432 \escapechar = `\\ |
|
2333
|
2433 \begindoublecolumns |
|
|
2434 % |
|
|
2435 % See if the index file exists and is nonempty. |
|
|
2436 \openin 1 \jobname.#1s |
|
|
2437 \ifeof 1 |
|
|
2438 % \enddoublecolumns gets confused if there is no text in the index, |
|
|
2439 % and it loses the chapter title and the aux file entries for the |
|
|
2440 % index. The easiest way to prevent this problem is to make sure |
|
|
2441 % there is some text. |
|
|
2442 (Index is nonexistent) |
|
2483
|
2443 \else |
|
2333
|
2444 % |
|
|
2445 % If the index file exists but is empty, then \openin leaves \ifeof |
|
|
2446 % false. We have to make TeX try to read something from the file, so |
|
|
2447 % it can discover if there is anything in it. |
|
|
2448 \read 1 to \temp |
|
|
2449 \ifeof 1 |
|
|
2450 (Index is empty) |
|
|
2451 \else |
|
|
2452 \input \jobname.#1s |
|
|
2453 \fi |
|
|
2454 \fi |
|
|
2455 \closein 1 |
|
|
2456 \enddoublecolumns |
|
2483
|
2457 \endgroup} |
|
2333
|
2458 |
|
|
2459 % These macros are used by the sorted index file itself. |
|
|
2460 % Change them to control the appearance of the index. |
|
|
2461 |
|
|
2462 % Same as \bigskipamount except no shrink. |
|
|
2463 % \balancecolumns gets confused if there is any shrink. |
|
|
2464 \newskip\initialskipamount \initialskipamount 12pt plus4pt |
|
|
2465 |
|
|
2466 \def\initial #1{% |
|
|
2467 {\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt |
|
|
2468 \ifdim\lastskip<\initialskipamount |
|
|
2469 \removelastskip \penalty-200 \vskip \initialskipamount\fi |
|
|
2470 \line{\secbf#1\hfill}\kern 2pt\penalty10000}} |
|
|
2471 |
|
|
2472 % This typesets a paragraph consisting of #1, dot leaders, and then #2 |
|
|
2473 % flush to the right margin. It is used for index and table of contents |
|
|
2474 % entries. The paragraph is indented by \leftskip. |
|
|
2475 % |
|
|
2476 \def\entry #1#2{\begingroup |
|
|
2477 % |
|
|
2478 % Start a new paragraph if necessary, so our assignments below can't |
|
|
2479 % affect previous text. |
|
|
2480 \par |
|
|
2481 % |
|
|
2482 % Do not fill out the last line with white space. |
|
|
2483 \parfillskip = 0in |
|
|
2484 % |
|
|
2485 % No extra space above this paragraph. |
|
|
2486 \parskip = 0in |
|
|
2487 % |
|
|
2488 % Do not prefer a separate line ending with a hyphen to fewer lines. |
|
|
2489 \finalhyphendemerits = 0 |
|
|
2490 % |
|
|
2491 % \hangindent is only relevant when the entry text and page number |
|
|
2492 % don't both fit on one line. In that case, bob suggests starting the |
|
|
2493 % dots pretty far over on the line. Unfortunately, a large |
|
|
2494 % indentation looks wrong when the entry text itself is broken across |
|
|
2495 % lines. So we use a small indentation and put up with long leaders. |
|
|
2496 % |
|
|
2497 % \hangafter is reset to 1 (which is the value we want) at the start |
|
|
2498 % of each paragraph, so we need not do anything with that. |
|
|
2499 \hangindent=2em |
|
|
2500 % |
|
|
2501 % When the entry text needs to be broken, just fill out the first line |
|
|
2502 % with blank space. |
|
|
2503 \rightskip = 0pt plus1fil |
|
|
2504 % |
|
|
2505 % Start a ``paragraph'' for the index entry so the line breaking |
|
|
2506 % parameters we've set above will have an effect. |
|
|
2507 \noindent |
|
|
2508 % |
|
|
2509 % Insert the text of the index entry. TeX will do line-breaking on it. |
|
|
2510 #1% |
|
2483
|
2511 % The following is kludged to not output a line of dots in the index if |
|
2333
|
2512 % there are no page numbers. The next person who breaks this will be |
|
|
2513 % cursed by a Unix daemon. |
|
|
2514 \def\tempa{{\rm }}% |
|
|
2515 \def\tempb{#2}% |
|
|
2516 \edef\tempc{\tempa}% |
|
|
2517 \edef\tempd{\tempb}% |
|
|
2518 \ifx\tempc\tempd\ \else% |
|
|
2519 % |
|
|
2520 % If we must, put the page number on a line of its own, and fill out |
|
|
2521 % this line with blank space. (The \hfil is overwhelmed with the |
|
|
2522 % fill leaders glue in \indexdotfill if the page number does fit.) |
|
|
2523 \hfil\penalty50 |
|
|
2524 \null\nobreak\indexdotfill % Have leaders before the page number. |
|
|
2525 % |
|
|
2526 % The `\ ' here is removed by the implicit \unskip that TeX does as |
|
|
2527 % part of (the primitive) \par. Without it, a spurious underfull |
|
|
2528 % \hbox ensues. |
|
|
2529 \ #2% The page number ends the paragraph. |
|
|
2530 \fi% |
|
|
2531 \par |
|
|
2532 \endgroup} |
|
|
2533 |
|
|
2534 % Like \dotfill except takes at least 1 em. |
|
|
2535 \def\indexdotfill{\cleaders |
|
|
2536 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill} |
|
|
2537 |
|
|
2538 \def\primary #1{\line{#1\hfil}} |
|
|
2539 |
|
|
2540 \newskip\secondaryindent \secondaryindent=0.5cm |
|
|
2541 |
|
|
2542 \def\secondary #1#2{ |
|
|
2543 {\parfillskip=0in \parskip=0in |
|
|
2544 \hangindent =1in \hangafter=1 |
|
|
2545 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par |
|
|
2546 }} |
|
|
2547 |
|
2483
|
2548 % Define two-column mode, which we use to typeset indexes. |
|
|
2549 % Adapted from the TeXbook, page 416, which is to say, |
|
|
2550 % the manmac.tex format used to print the TeXbook itself. |
|
|
2551 \catcode`\@=11 |
|
2333
|
2552 |
|
|
2553 \newbox\partialpage |
|
|
2554 \newdimen\doublecolumnhsize |
|
|
2555 |
|
2483
|
2556 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns |
|
2333
|
2557 % Grab any single-column material above us. |
|
|
2558 \output = {\global\setbox\partialpage |
|
|
2559 =\vbox{\unvbox255\kern -\topskip \kern \baselineskip}}% |
|
|
2560 \eject |
|
|
2561 % |
|
|
2562 % Now switch to the double-column output routine. |
|
|
2563 \output={\doublecolumnout}% |
|
|
2564 % |
|
|
2565 % Change the page size parameters. We could do this once outside this |
|
|
2566 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 |
|
|
2567 % format, but then we repeat the same computation. Repeating a couple |
|
|
2568 % of assignments once per index is clearly meaningless for the |
|
|
2569 % execution time, so we may as well do it once. |
|
|
2570 % |
|
|
2571 % First we halve the line length, less a little for the gutter between |
|
|
2572 % the columns. We compute the gutter based on the line length, so it |
|
|
2573 % changes automatically with the paper format. The magic constant |
|
|
2574 % below is chosen so that the gutter has the same value (well, +- < |
|
|
2575 % 1pt) as it did when we hard-coded it. |
|
|
2576 % |
|
|
2577 % We put the result in a separate register, \doublecolumhsize, so we |
|
|
2578 % can restore it in \pagesofar, after \hsize itself has (potentially) |
|
|
2579 % been clobbered. |
|
|
2580 % |
|
|
2581 \doublecolumnhsize = \hsize |
|
|
2582 \advance\doublecolumnhsize by -.04154\hsize |
|
|
2583 \divide\doublecolumnhsize by 2 |
|
|
2584 \hsize = \doublecolumnhsize |
|
|
2585 % |
|
|
2586 % Double the \vsize as well. (We don't need a separate register here, |
|
|
2587 % since nobody clobbers \vsize.) |
|
|
2588 \vsize = 2\vsize |
|
|
2589 } |
|
|
2590 \def\doublecolumnout{% |
|
2483
|
2591 \splittopskip=\topskip \splitmaxdepth=\maxdepth |
|
|
2592 % Get the available space for the double columns -- the normal |
|
|
2593 % (undoubled) page height minus any material left over from the |
|
|
2594 % previous page. |
|
|
2595 \dimen@=\pageheight \advance\dimen@ by-\ht\partialpage |
|
|
2596 % box0 will be the left-hand column, box1 the right. |
|
|
2597 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ |
|
|
2598 \onepageout\pagesofar |
|
|
2599 \unvbox255 \penalty\outputpenalty |
|
|
2600 } |
|
|
2601 \def\pagesofar{% |
|
|
2602 % The contents of the output page -- any previous material, |
|
|
2603 % followed by the two boxes we just split. |
|
|
2604 \unvbox\partialpage |
|
|
2605 \hsize = \doublecolumnhsize |
|
|
2606 \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}% |
|
2333
|
2607 } |
|
2483
|
2608 \def\enddoublecolumns{% |
|
|
2609 \output={\balancecolumns}\eject % split what we have |
|
|
2610 \endgroup |
|
|
2611 % Back to normal single-column typesetting, but take account of the |
|
|
2612 % fact that we just accumulated some stuff on the output page. |
|
2670
|
2613 \pagegoal=\vsize |
|
2483
|
2614 } |
|
|
2615 \def\balancecolumns{% |
|
|
2616 % Called on the last page of the double column material. |
|
|
2617 \setbox0=\vbox{\unvbox255}% |
|
|
2618 \dimen@ = \ht0 |
|
|
2619 \advance\dimen@ by \topskip |
|
|
2620 \advance\dimen@ by-\baselineskip |
|
|
2621 \divide\dimen@ by 2 |
|
|
2622 \splittopskip = \topskip |
|
|
2623 % Loop until we get a decent breakpoint. |
|
|
2624 {\vbadness=10000 \loop \global\setbox3=\copy0 |
|
|
2625 \global\setbox1=\vsplit3 to\dimen@ |
|
|
2626 \ifdim\ht3>\dimen@ \global\advance\dimen@ by1pt \repeat}% |
|
|
2627 \setbox0=\vbox to\dimen@{\unvbox1}% |
|
|
2628 \setbox2=\vbox to\dimen@{\unvbox3}% |
|
|
2629 \pagesofar |
|
|
2630 } |
|
2333
|
2631 \catcode `\@=\other |
|
2483
|
2632 |
|
|
2633 |
|
2333
|
2634 \message{sectioning,} |
|
|
2635 % Define chapters, sections, etc. |
|
|
2636 |
|
|
2637 \newcount \chapno |
|
|
2638 \newcount \secno \secno=0 |
|
|
2639 \newcount \subsecno \subsecno=0 |
|
|
2640 \newcount \subsubsecno \subsubsecno=0 |
|
|
2641 |
|
|
2642 % This counter is funny since it counts through charcodes of letters A, B, ... |
|
|
2643 \newcount \appendixno \appendixno = `\@ |
|
|
2644 \def\appendixletter{\char\the\appendixno} |
|
|
2645 |
|
|
2646 \newwrite \contentsfile |
|
|
2647 % This is called from \setfilename. |
|
|
2648 \def\opencontents{\openout \contentsfile = \jobname.toc} |
|
|
2649 |
|
|
2650 % Each @chapter defines this as the name of the chapter. |
|
|
2651 % page headings and footings can use it. @section does likewise |
|
|
2652 |
|
|
2653 \def\thischapter{} \def\thissection{} |
|
|
2654 \def\seccheck#1{\if \pageno<0 % |
|
|
2655 \errmessage{@#1 not allowed after generating table of contents}\fi |
|
|
2656 % |
|
|
2657 } |
|
|
2658 |
|
|
2659 \def\chapternofonts{% |
|
|
2660 \let\rawbackslash=\relax% |
|
|
2661 \let\frenchspacing=\relax% |
|
|
2662 \def\result{\realbackslash result} |
|
|
2663 \def\equiv{\realbackslash equiv} |
|
|
2664 \def\expansion{\realbackslash expansion} |
|
|
2665 \def\print{\realbackslash print} |
|
|
2666 \def\TeX{\realbackslash TeX} |
|
|
2667 \def\dots{\realbackslash dots} |
|
|
2668 \def\copyright{\realbackslash copyright} |
|
|
2669 \def\tt{\realbackslash tt} |
|
|
2670 \def\bf{\realbackslash bf } |
|
|
2671 \def\w{\realbackslash w} |
|
|
2672 \def\less{\realbackslash less} |
|
|
2673 \def\gtr{\realbackslash gtr} |
|
|
2674 \def\hat{\realbackslash hat} |
|
|
2675 \def\char{\realbackslash char} |
|
|
2676 \def\tclose##1{\realbackslash tclose {##1}} |
|
|
2677 \def\code##1{\realbackslash code {##1}} |
|
|
2678 \def\samp##1{\realbackslash samp {##1}} |
|
|
2679 \def\r##1{\realbackslash r {##1}} |
|
|
2680 \def\b##1{\realbackslash b {##1}} |
|
|
2681 \def\key##1{\realbackslash key {##1}} |
|
|
2682 \def\file##1{\realbackslash file {##1}} |
|
|
2683 \def\kbd##1{\realbackslash kbd {##1}} |
|
|
2684 % These are redefined because @smartitalic wouldn't work inside xdef. |
|
|
2685 \def\i##1{\realbackslash i {##1}} |
|
|
2686 \def\cite##1{\realbackslash cite {##1}} |
|
|
2687 \def\var##1{\realbackslash var {##1}} |
|
|
2688 \def\emph##1{\realbackslash emph {##1}} |
|
|
2689 \def\dfn##1{\realbackslash dfn {##1}} |
|
|
2690 } |
|
|
2691 |
|
|
2692 \newcount\absseclevel % used to calculate proper heading level |
|
|
2693 \newcount\secbase\secbase=0 % @raise/lowersections modify this count |
|
|
2694 |
|
|
2695 % @raisesections: treat @section as chapter, @subsection as section, etc. |
|
|
2696 \def\raisesections{\global\advance\secbase by -1} |
|
|
2697 \let\up=\raisesections % original BFox name |
|
|
2698 |
|
|
2699 % @lowersections: treat @chapter as section, @section as subsection, etc. |
|
|
2700 \def\lowersections{\global\advance\secbase by 1} |
|
|
2701 \let\down=\lowersections % original BFox name |
|
|
2702 |
|
|
2703 % Choose a numbered-heading macro |
|
|
2704 % #1 is heading level if unmodified by @raisesections or @lowersections |
|
|
2705 % #2 is text for heading |
|
|
2706 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 |
|
|
2707 \ifcase\absseclevel |
|
|
2708 \chapterzzz{#2} |
|
|
2709 \or |
|
|
2710 \seczzz{#2} |
|
|
2711 \or |
|
|
2712 \numberedsubseczzz{#2} |
|
|
2713 \or |
|
|
2714 \numberedsubsubseczzz{#2} |
|
|
2715 \else |
|
|
2716 \ifnum \absseclevel<0 |
|
|
2717 \chapterzzz{#2} |
|
|
2718 \else |
|
|
2719 \numberedsubsubseczzz{#2} |
|
|
2720 \fi |
|
|
2721 \fi |
|
|
2722 } |
|
|
2723 |
|
|
2724 % like \numhead, but chooses appendix heading levels |
|
|
2725 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 |
|
|
2726 \ifcase\absseclevel |
|
|
2727 \appendixzzz{#2} |
|
|
2728 \or |
|
|
2729 \appendixsectionzzz{#2} |
|
|
2730 \or |
|
|
2731 \appendixsubseczzz{#2} |
|
|
2732 \or |
|
|
2733 \appendixsubsubseczzz{#2} |
|
|
2734 \else |
|
|
2735 \ifnum \absseclevel<0 |
|
|
2736 \appendixzzz{#2} |
|
|
2737 \else |
|
|
2738 \appendixsubsubseczzz{#2} |
|
|
2739 \fi |
|
|
2740 \fi |
|
|
2741 } |
|
|
2742 |
|
|
2743 % like \numhead, but chooses numberless heading levels |
|
|
2744 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 |
|
|
2745 \ifcase\absseclevel |
|
|
2746 \unnumberedzzz{#2} |
|
|
2747 \or |
|
|
2748 \unnumberedseczzz{#2} |
|
|
2749 \or |
|
|
2750 \unnumberedsubseczzz{#2} |
|
|
2751 \or |
|
|
2752 \unnumberedsubsubseczzz{#2} |
|
|
2753 \else |
|
|
2754 \ifnum \absseclevel<0 |
|
|
2755 \unnumberedzzz{#2} |
|
|
2756 \else |
|
|
2757 \unnumberedsubsubseczzz{#2} |
|
|
2758 \fi |
|
|
2759 \fi |
|
|
2760 } |
|
|
2761 |
|
|
2762 |
|
|
2763 \def\thischaptername{No Chapter Title} |
|
|
2764 \outer\def\chapter{\parsearg\chapteryyy} |
|
|
2765 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz |
|
|
2766 \def\chapterzzz #1{\seccheck{chapter}% |
|
|
2767 \secno=0 \subsecno=0 \subsubsecno=0 |
|
|
2768 \global\advance \chapno by 1 \message{\putwordChapter \the\chapno}% |
|
|
2769 \chapmacro {#1}{\the\chapno}% |
|
|
2770 \gdef\thissection{#1}% |
|
|
2771 \gdef\thischaptername{#1}% |
|
|
2772 % We don't substitute the actual chapter name into \thischapter |
|
|
2773 % because we don't want its macros evaluated now. |
|
|
2774 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}% |
|
|
2775 {\chapternofonts% |
|
|
2776 \edef\temp{{\realbackslash chapentry {#1}{\the\chapno}{\noexpand\folio}}}% |
|
|
2777 \escapechar=`\\% |
|
|
2778 \write \contentsfile \temp % |
|
|
2779 \donoderef % |
|
|
2780 \global\let\section = \numberedsec |
|
|
2781 \global\let\subsection = \numberedsubsec |
|
|
2782 \global\let\subsubsection = \numberedsubsubsec |
|
|
2783 }} |
|
|
2784 |
|
|
2785 \outer\def\appendix{\parsearg\appendixyyy} |
|
|
2786 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz |
|
|
2787 \def\appendixzzz #1{\seccheck{appendix}% |
|
|
2788 \secno=0 \subsecno=0 \subsubsecno=0 |
|
|
2789 \global\advance \appendixno by 1 \message{Appendix \appendixletter}% |
|
|
2790 \chapmacro {#1}{\putwordAppendix{} \appendixletter}% |
|
|
2791 \gdef\thissection{#1}% |
|
|
2792 \gdef\thischaptername{#1}% |
|
|
2793 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}% |
|
|
2794 {\chapternofonts% |
|
|
2795 \edef\temp{{\realbackslash chapentry |
|
|
2796 {#1}{\putwordAppendix{} \appendixletter}{\noexpand\folio}}}% |
|
|
2797 \escapechar=`\\% |
|
|
2798 \write \contentsfile \temp % |
|
|
2799 \appendixnoderef % |
|
|
2800 \global\let\section = \appendixsec |
|
|
2801 \global\let\subsection = \appendixsubsec |
|
|
2802 \global\let\subsubsection = \appendixsubsubsec |
|
|
2803 }} |
|
|
2804 |
|
2483
|
2805 % @centerchap is like @unnumbered, but the heading is centered. |
|
|
2806 \outer\def\centerchap{\parsearg\centerchapyyy} |
|
|
2807 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}} |
|
|
2808 |
|
2333
|
2809 \outer\def\top{\parsearg\unnumberedyyy} |
|
|
2810 \outer\def\unnumbered{\parsearg\unnumberedyyy} |
|
|
2811 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz |
|
|
2812 \def\unnumberedzzz #1{\seccheck{unnumbered}% |
|
|
2813 \secno=0 \subsecno=0 \subsubsecno=0 |
|
|
2814 % |
|
|
2815 % This used to be simply \message{#1}, but TeX fully expands the |
|
|
2816 % argument to \message. Therefore, if #1 contained @-commands, TeX |
|
|
2817 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX |
|
|
2818 % expanded @cite (which turns out to cause errors because \cite is meant |
|
|
2819 % to be executed, not expanded). |
|
|
2820 % |
|
|
2821 % Anyway, we don't want the fully-expanded definition of @cite to appear |
|
|
2822 % as a result of the \message, we just want `@cite' itself. We use |
|
|
2823 % \the<toks register> to achieve this: TeX expands \the<toks> only once, |
|
|
2824 % simply yielding the contents of the <toks register>. |
|
|
2825 \toks0 = {#1}\message{(\the\toks0)}% |
|
|
2826 % |
|
|
2827 \unnumbchapmacro {#1}% |
|
|
2828 \gdef\thischapter{#1}\gdef\thissection{#1}% |
|
|
2829 {\chapternofonts% |
|
|
2830 \edef\temp{{\realbackslash unnumbchapentry {#1}{\noexpand\folio}}}% |
|
|
2831 \escapechar=`\\% |
|
|
2832 \write \contentsfile \temp % |
|
|
2833 \unnumbnoderef % |
|
|
2834 \global\let\section = \unnumberedsec |
|
|
2835 \global\let\subsection = \unnumberedsubsec |
|
|
2836 \global\let\subsubsection = \unnumberedsubsubsec |
|
|
2837 }} |
|
|
2838 |
|
|
2839 \outer\def\numberedsec{\parsearg\secyyy} |
|
|
2840 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz |
|
|
2841 \def\seczzz #1{\seccheck{section}% |
|
|
2842 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 % |
|
|
2843 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}% |
|
|
2844 {\chapternofonts% |
|
|
2845 \edef\temp{{\realbackslash secentry % |
|
|
2846 {#1}{\the\chapno}{\the\secno}{\noexpand\folio}}}% |
|
|
2847 \escapechar=`\\% |
|
|
2848 \write \contentsfile \temp % |
|
|
2849 \donoderef % |
|
|
2850 \penalty 10000 % |
|
|
2851 }} |
|
|
2852 |
|
2483
|
2853 \outer\def\appendixsection{\parsearg\appendixsecyyy} |
|
2333
|
2854 \outer\def\appendixsec{\parsearg\appendixsecyyy} |
|
|
2855 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz |
|
|
2856 \def\appendixsectionzzz #1{\seccheck{appendixsection}% |
|
|
2857 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 % |
|
|
2858 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}% |
|
|
2859 {\chapternofonts% |
|
|
2860 \edef\temp{{\realbackslash secentry % |
|
|
2861 {#1}{\appendixletter}{\the\secno}{\noexpand\folio}}}% |
|
|
2862 \escapechar=`\\% |
|
|
2863 \write \contentsfile \temp % |
|
|
2864 \appendixnoderef % |
|
|
2865 \penalty 10000 % |
|
|
2866 }} |
|
|
2867 |
|
|
2868 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy} |
|
|
2869 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz |
|
|
2870 \def\unnumberedseczzz #1{\seccheck{unnumberedsec}% |
|
|
2871 \plainsecheading {#1}\gdef\thissection{#1}% |
|
|
2872 {\chapternofonts% |
|
|
2873 \edef\temp{{\realbackslash unnumbsecentry{#1}{\noexpand\folio}}}% |
|
|
2874 \escapechar=`\\% |
|
|
2875 \write \contentsfile \temp % |
|
|
2876 \unnumbnoderef % |
|
|
2877 \penalty 10000 % |
|
|
2878 }} |
|
|
2879 |
|
|
2880 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy} |
|
|
2881 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz |
|
|
2882 \def\numberedsubseczzz #1{\seccheck{subsection}% |
|
|
2883 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % |
|
|
2884 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}% |
|
|
2885 {\chapternofonts% |
|
|
2886 \edef\temp{{\realbackslash subsecentry % |
|
|
2887 {#1}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}% |
|
|
2888 \escapechar=`\\% |
|
|
2889 \write \contentsfile \temp % |
|
|
2890 \donoderef % |
|
|
2891 \penalty 10000 % |
|
|
2892 }} |
|
|
2893 |
|
|
2894 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy} |
|
|
2895 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz |
|
|
2896 \def\appendixsubseczzz #1{\seccheck{appendixsubsec}% |
|
|
2897 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % |
|
|
2898 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}% |
|
|
2899 {\chapternofonts% |
|
|
2900 \edef\temp{{\realbackslash subsecentry % |
|
|
2901 {#1}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}% |
|
|
2902 \escapechar=`\\% |
|
|
2903 \write \contentsfile \temp % |
|
|
2904 \appendixnoderef % |
|
|
2905 \penalty 10000 % |
|
|
2906 }} |
|
|
2907 |
|
|
2908 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy} |
|
|
2909 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz |
|
|
2910 \def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}% |
|
2483
|
2911 \plainsubsecheading {#1}\gdef\thissection{#1}% |
|
2333
|
2912 {\chapternofonts% |
|
|
2913 \edef\temp{{\realbackslash unnumbsubsecentry{#1}{\noexpand\folio}}}% |
|
|
2914 \escapechar=`\\% |
|
|
2915 \write \contentsfile \temp % |
|
|
2916 \unnumbnoderef % |
|
|
2917 \penalty 10000 % |
|
|
2918 }} |
|
|
2919 |
|
|
2920 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy} |
|
|
2921 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz |
|
|
2922 \def\numberedsubsubseczzz #1{\seccheck{subsubsection}% |
|
|
2923 \gdef\thissection{#1}\global\advance \subsubsecno by 1 % |
|
|
2924 \subsubsecheading {#1} |
|
|
2925 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}% |
|
|
2926 {\chapternofonts% |
|
|
2927 \edef\temp{{\realbackslash subsubsecentry % |
|
|
2928 {#1} |
|
|
2929 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno} |
|
|
2930 {\noexpand\folio}}}% |
|
|
2931 \escapechar=`\\% |
|
|
2932 \write \contentsfile \temp % |
|
|
2933 \donoderef % |
|
|
2934 \penalty 10000 % |
|
|
2935 }} |
|
|
2936 |
|
|
2937 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy} |
|
|
2938 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz |
|
|
2939 \def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}% |
|
|
2940 \gdef\thissection{#1}\global\advance \subsubsecno by 1 % |
|
|
2941 \subsubsecheading {#1} |
|
|
2942 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}% |
|
|
2943 {\chapternofonts% |
|
|
2944 \edef\temp{{\realbackslash subsubsecentry{#1}% |
|
|
2945 {\appendixletter} |
|
|
2946 {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}% |
|
|
2947 \escapechar=`\\% |
|
|
2948 \write \contentsfile \temp % |
|
|
2949 \appendixnoderef % |
|
|
2950 \penalty 10000 % |
|
|
2951 }} |
|
|
2952 |
|
|
2953 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy} |
|
|
2954 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz |
|
|
2955 \def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}% |
|
2483
|
2956 \plainsubsubsecheading {#1}\gdef\thissection{#1}% |
|
2333
|
2957 {\chapternofonts% |
|
|
2958 \edef\temp{{\realbackslash unnumbsubsubsecentry{#1}{\noexpand\folio}}}% |
|
|
2959 \escapechar=`\\% |
|
|
2960 \write \contentsfile \temp % |
|
|
2961 \unnumbnoderef % |
|
|
2962 \penalty 10000 % |
|
|
2963 }} |
|
|
2964 |
|
|
2965 % These are variants which are not "outer", so they can appear in @ifinfo. |
|
|
2966 % Actually, they should now be obsolete; ordinary section commands should work. |
|
|
2967 \def\infotop{\parsearg\unnumberedzzz} |
|
|
2968 \def\infounnumbered{\parsearg\unnumberedzzz} |
|
|
2969 \def\infounnumberedsec{\parsearg\unnumberedseczzz} |
|
|
2970 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz} |
|
|
2971 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz} |
|
|
2972 |
|
|
2973 \def\infoappendix{\parsearg\appendixzzz} |
|
|
2974 \def\infoappendixsec{\parsearg\appendixseczzz} |
|
|
2975 \def\infoappendixsubsec{\parsearg\appendixsubseczzz} |
|
|
2976 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz} |
|
|
2977 |
|
|
2978 \def\infochapter{\parsearg\chapterzzz} |
|
|
2979 \def\infosection{\parsearg\sectionzzz} |
|
|
2980 \def\infosubsection{\parsearg\subsectionzzz} |
|
|
2981 \def\infosubsubsection{\parsearg\subsubsectionzzz} |
|
|
2982 |
|
|
2983 % These macros control what the section commands do, according |
|
|
2984 % to what kind of chapter we are in (ordinary, appendix, or unnumbered). |
|
|
2985 % Define them by default for a numbered chapter. |
|
|
2986 \global\let\section = \numberedsec |
|
|
2987 \global\let\subsection = \numberedsubsec |
|
|
2988 \global\let\subsubsection = \numberedsubsubsec |
|
|
2989 |
|
|
2990 % Define @majorheading, @heading and @subheading |
|
|
2991 |
|
|
2992 % NOTE on use of \vbox for chapter headings, section headings, and |
|
|
2993 % such: |
|
|
2994 % 1) We use \vbox rather than the earlier \line to permit |
|
|
2995 % overlong headings to fold. |
|
|
2996 % 2) \hyphenpenalty is set to 10000 because hyphenation in a |
|
|
2997 % heading is obnoxious; this forbids it. |
|
|
2998 % 3) Likewise, headings look best if no \parindent is used, and |
|
|
2999 % if justification is not attempted. Hence \raggedright. |
|
|
3000 |
|
|
3001 |
|
|
3002 \def\majorheading{\parsearg\majorheadingzzz} |
|
|
3003 \def\majorheadingzzz #1{% |
|
|
3004 {\advance\chapheadingskip by 10pt \chapbreak }% |
|
|
3005 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 |
|
|
3006 \parindent=0pt\raggedright |
|
|
3007 \rm #1\hfill}}\bigskip \par\penalty 200} |
|
|
3008 |
|
|
3009 \def\chapheading{\parsearg\chapheadingzzz} |
|
|
3010 \def\chapheadingzzz #1{\chapbreak % |
|
|
3011 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 |
|
|
3012 \parindent=0pt\raggedright |
|
|
3013 \rm #1\hfill}}\bigskip \par\penalty 200} |
|
|
3014 |
|
2483
|
3015 % @heading, @subheading, @subsubheading. |
|
|
3016 \def\heading{\parsearg\plainsecheading} |
|
|
3017 \def\subheading{\parsearg\plainsubsecheading} |
|
|
3018 \def\subsubheading{\parsearg\plainsubsubsecheading} |
|
2333
|
3019 |
|
|
3020 % These macros generate a chapter, section, etc. heading only |
|
|
3021 % (including whitespace, linebreaking, etc. around it), |
|
|
3022 % given all the information in convenient, parsed form. |
|
|
3023 |
|
|
3024 %%% Args are the skip and penalty (usually negative) |
|
|
3025 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} |
|
|
3026 |
|
|
3027 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname} |
|
|
3028 |
|
|
3029 %%% Define plain chapter starts, and page on/off switching for it |
|
|
3030 % Parameter controlling skip before chapter headings (if needed) |
|
|
3031 |
|
2483
|
3032 \newskip\chapheadingskip |
|
2333
|
3033 |
|
|
3034 \def\chapbreak{\dobreak \chapheadingskip {-4000}} |
|
|
3035 \def\chappager{\par\vfill\supereject} |
|
|
3036 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} |
|
|
3037 |
|
|
3038 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} |
|
|
3039 |
|
|
3040 \def\CHAPPAGoff{ |
|
2483
|
3041 \global\let\contentsalignmacro = \chappager |
|
2333
|
3042 \global\let\pchapsepmacro=\chapbreak |
|
|
3043 \global\let\pagealignmacro=\chappager} |
|
|
3044 |
|
|
3045 \def\CHAPPAGon{ |
|
2483
|
3046 \global\let\contentsalignmacro = \chappager |
|
2333
|
3047 \global\let\pchapsepmacro=\chappager |
|
|
3048 \global\let\pagealignmacro=\chappager |
|
|
3049 \global\def\HEADINGSon{\HEADINGSsingle}} |
|
|
3050 |
|
|
3051 \def\CHAPPAGodd{ |
|
2483
|
3052 \global\let\contentsalignmacro = \chapoddpage |
|
2333
|
3053 \global\let\pchapsepmacro=\chapoddpage |
|
|
3054 \global\let\pagealignmacro=\chapoddpage |
|
|
3055 \global\def\HEADINGSon{\HEADINGSdouble}} |
|
|
3056 |
|
|
3057 \CHAPPAGon |
|
|
3058 |
|
|
3059 \def\CHAPFplain{ |
|
|
3060 \global\let\chapmacro=\chfplain |
|
2483
|
3061 \global\let\unnumbchapmacro=\unnchfplain |
|
|
3062 \global\let\centerchapmacro=\centerchfplain} |
|
|
3063 |
|
|
3064 % Plain chapter opening. |
|
|
3065 % #1 is the text, #2 the chapter number or empty if unnumbered. |
|
|
3066 \def\chfplain#1#2{% |
|
2333
|
3067 \pchapsepmacro |
|
|
3068 {% |
|
2483
|
3069 \chapfonts \rm |
|
|
3070 \def\chapnum{#2}% |
|
|
3071 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}% |
|
|
3072 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright |
|
|
3073 \hangindent = \wd0 \centerparametersmaybe |
|
|
3074 \unhbox0 #1\par}% |
|
2333
|
3075 }% |
|
2483
|
3076 \nobreak\bigskip % no page break after a chapter title |
|
|
3077 \nobreak |
|
2333
|
3078 } |
|
|
3079 |
|
2483
|
3080 % Plain opening for unnumbered. |
|
|
3081 \def\unnchfplain#1{\chfplain{#1}{}} |
|
|
3082 |
|
|
3083 % @centerchap -- centered and unnumbered. |
|
|
3084 \let\centerparametersmaybe = \relax |
|
|
3085 \def\centerchfplain#1{{% |
|
|
3086 \def\centerparametersmaybe{% |
|
|
3087 \advance\rightskip by 3\rightskip |
|
|
3088 \leftskip = \rightskip |
|
|
3089 \parfillskip = 0pt |
|
|
3090 }% |
|
|
3091 \chfplain{#1}{}% |
|
|
3092 }} |
|
|
3093 |
|
2333
|
3094 \CHAPFplain % The default |
|
|
3095 |
|
|
3096 \def\unnchfopen #1{% |
|
|
3097 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 |
|
|
3098 \parindent=0pt\raggedright |
|
|
3099 \rm #1\hfill}}\bigskip \par\penalty 10000 % |
|
|
3100 } |
|
|
3101 |
|
|
3102 \def\chfopen #1#2{\chapoddpage {\chapfonts |
|
|
3103 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% |
|
|
3104 \par\penalty 5000 % |
|
|
3105 } |
|
|
3106 |
|
2483
|
3107 \def\centerchfopen #1{% |
|
|
3108 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 |
|
|
3109 \parindent=0pt |
|
|
3110 \hfill {\rm #1}\hfill}}\bigskip \par\penalty 10000 % |
|
|
3111 } |
|
|
3112 |
|
2333
|
3113 \def\CHAPFopen{ |
|
|
3114 \global\let\chapmacro=\chfopen |
|
2483
|
3115 \global\let\unnumbchapmacro=\unnchfopen |
|
|
3116 \global\let\centerchapmacro=\centerchfopen} |
|
|
3117 |
|
|
3118 |
|
|
3119 % Section titles. |
|
|
3120 \newskip\secheadingskip |
|
2333
|
3121 \def\secheadingbreak{\dobreak \secheadingskip {-1000}} |
|
2483
|
3122 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}} |
|
|
3123 \def\plainsecheading#1{\sectionheading{sec}{}{#1}} |
|
|
3124 |
|
|
3125 % Subsection titles. |
|
|
3126 \newskip \subsecheadingskip |
|
|
3127 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}} |
|
|
3128 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}} |
|
|
3129 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}} |
|
|
3130 |
|
|
3131 % Subsubsection titles. |
|
|
3132 \let\subsubsecheadingskip = \subsecheadingskip |
|
|
3133 \let\subsubsecheadingbreak = \subsecheadingbreak |
|
|
3134 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}} |
|
|
3135 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}} |
|
|
3136 |
|
|
3137 |
|
|
3138 % Print any size section title. |
|
2670
|
3139 % |
|
2483
|
3140 % #1 is the section type (sec/subsec/subsubsec), #2 is the section |
|
|
3141 % number (maybe empty), #3 the text. |
|
|
3142 \def\sectionheading#1#2#3{% |
|
|
3143 {% |
|
|
3144 \expandafter\advance\csname #1headingskip\endcsname by \parskip |
|
|
3145 \csname #1headingbreak\endcsname |
|
|
3146 }% |
|
|
3147 {% |
|
|
3148 % Switch to the right set of fonts. |
|
|
3149 \csname #1fonts\endcsname \rm |
|
|
3150 % |
|
|
3151 % Only insert the separating space if we have a section number. |
|
|
3152 \def\secnum{#2}% |
|
|
3153 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}% |
|
|
3154 % |
|
|
3155 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright |
|
|
3156 \hangindent = \wd0 % zero if no section number |
|
|
3157 \unhbox0 #3}% |
|
|
3158 }% |
|
|
3159 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak |
|
|
3160 } |
|
2333
|
3161 |
|
|
3162 |
|
|
3163 \message{toc printing,} |
|
|
3164 % Finish up the main text and prepare to read what we've written |
|
|
3165 % to \contentsfile. |
|
|
3166 |
|
|
3167 \newskip\contentsrightmargin \contentsrightmargin=1in |
|
|
3168 \def\startcontents#1{% |
|
2483
|
3169 % If @setchapternewpage on, and @headings double, the contents should |
|
|
3170 % start on an odd page, unlike chapters. Thus, we maintain |
|
|
3171 % \contentsalignmacro in parallel with \pagealignmacro. |
|
|
3172 % From: Torbjorn Granlund <tege@matematik.su.se> |
|
|
3173 \contentsalignmacro |
|
2333
|
3174 \immediate\closeout \contentsfile |
|
|
3175 \ifnum \pageno>0 |
|
|
3176 \pageno = -1 % Request roman numbered pages. |
|
|
3177 \fi |
|
|
3178 % Don't need to put `Contents' or `Short Contents' in the headline. |
|
|
3179 % It is abundantly clear what they are. |
|
|
3180 \unnumbchapmacro{#1}\def\thischapter{}% |
|
|
3181 \begingroup % Set up to handle contents files properly. |
|
|
3182 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11 |
|
|
3183 \catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi |
|
|
3184 \raggedbottom % Worry more about breakpoints than the bottom. |
|
|
3185 \advance\hsize by -\contentsrightmargin % Don't use the full line length. |
|
|
3186 } |
|
|
3187 |
|
|
3188 |
|
|
3189 % Normal (long) toc. |
|
|
3190 \outer\def\contents{% |
|
|
3191 \startcontents{\putwordTableofContents}% |
|
|
3192 \input \jobname.toc |
|
|
3193 \endgroup |
|
|
3194 \vfill \eject |
|
|
3195 } |
|
|
3196 |
|
|
3197 % And just the chapters. |
|
|
3198 \outer\def\summarycontents{% |
|
|
3199 \startcontents{\putwordShortContents}% |
|
|
3200 % |
|
|
3201 \let\chapentry = \shortchapentry |
|
|
3202 \let\unnumbchapentry = \shortunnumberedentry |
|
|
3203 % We want a true roman here for the page numbers. |
|
|
3204 \secfonts |
|
|
3205 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl |
|
|
3206 \rm |
|
2483
|
3207 \hyphenpenalty = 10000 |
|
2333
|
3208 \advance\baselineskip by 1pt % Open it up a little. |
|
|
3209 \def\secentry ##1##2##3##4{} |
|
|
3210 \def\unnumbsecentry ##1##2{} |
|
|
3211 \def\subsecentry ##1##2##3##4##5{} |
|
|
3212 \def\unnumbsubsecentry ##1##2{} |
|
|
3213 \def\subsubsecentry ##1##2##3##4##5##6{} |
|
|
3214 \def\unnumbsubsubsecentry ##1##2{} |
|
|
3215 \input \jobname.toc |
|
|
3216 \endgroup |
|
|
3217 \vfill \eject |
|
|
3218 } |
|
|
3219 \let\shortcontents = \summarycontents |
|
|
3220 |
|
|
3221 % These macros generate individual entries in the table of contents. |
|
|
3222 % The first argument is the chapter or section name. |
|
|
3223 % The last argument is the page number. |
|
|
3224 % The arguments in between are the chapter number, section number, ... |
|
|
3225 |
|
|
3226 % Chapter-level things, for both the long and short contents. |
|
|
3227 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}} |
|
|
3228 |
|
|
3229 % See comments in \dochapentry re vbox and related settings |
|
|
3230 \def\shortchapentry#1#2#3{% |
|
|
3231 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}% |
|
|
3232 } |
|
|
3233 |
|
|
3234 % Typeset the label for a chapter or appendix for the short contents. |
|
|
3235 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter. |
|
|
3236 % We could simplify the code here by writing out an \appendixentry |
|
|
3237 % command in the toc file for appendices, instead of using \chapentry |
|
|
3238 % for both, but it doesn't seem worth it. |
|
|
3239 \setbox0 = \hbox{\shortcontrm \putwordAppendix } |
|
|
3240 \newdimen\shortappendixwidth \shortappendixwidth = \wd0 |
|
|
3241 |
|
|
3242 \def\shortchaplabel#1{% |
|
|
3243 % We typeset #1 in a box of constant width, regardless of the text of |
|
|
3244 % #1, so the chapter titles will come out aligned. |
|
|
3245 \setbox0 = \hbox{#1}% |
|
|
3246 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi |
|
|
3247 % |
|
|
3248 % This space should be plenty, since a single number is .5em, and the |
|
|
3249 % widest letter (M) is 1em, at least in the Computer Modern fonts. |
|
|
3250 % (This space doesn't include the extra space that gets added after |
|
2483
|
3251 % the label; that gets put in by \shortchapentry above.) |
|
2333
|
3252 \advance\dimen0 by 1.1em |
|
|
3253 \hbox to \dimen0{#1\hfil}% |
|
|
3254 } |
|
|
3255 |
|
|
3256 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}} |
|
|
3257 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}} |
|
|
3258 |
|
|
3259 % Sections. |
|
|
3260 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}} |
|
|
3261 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}} |
|
|
3262 |
|
|
3263 % Subsections. |
|
|
3264 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}} |
|
|
3265 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}} |
|
|
3266 |
|
|
3267 % And subsubsections. |
|
|
3268 \def\subsubsecentry#1#2#3#4#5#6{% |
|
|
3269 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}} |
|
|
3270 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}} |
|
|
3271 |
|
|
3272 % This parameter controls the indentation of the various levels. |
|
|
3273 \newdimen\tocindent \tocindent = 3pc |
|
|
3274 |
|
|
3275 % Now for the actual typesetting. In all these, #1 is the text and #2 is the |
|
|
3276 % page number. |
|
|
3277 % |
|
2483
|
3278 % If the toc has to be broken over pages, we want it to be at chapters |
|
2333
|
3279 % if at all possible; hence the \penalty. |
|
|
3280 \def\dochapentry#1#2{% |
|
2483
|
3281 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip |
|
2333
|
3282 \begingroup |
|
|
3283 \chapentryfonts |
|
|
3284 \tocentry{#1}{\dopageno{#2}}% |
|
|
3285 \endgroup |
|
2483
|
3286 \nobreak\vskip .25\baselineskip plus.1\baselineskip |
|
2333
|
3287 } |
|
|
3288 |
|
|
3289 \def\dosecentry#1#2{\begingroup |
|
|
3290 \secentryfonts \leftskip=\tocindent |
|
|
3291 \tocentry{#1}{\dopageno{#2}}% |
|
|
3292 \endgroup} |
|
|
3293 |
|
|
3294 \def\dosubsecentry#1#2{\begingroup |
|
|
3295 \subsecentryfonts \leftskip=2\tocindent |
|
|
3296 \tocentry{#1}{\dopageno{#2}}% |
|
|
3297 \endgroup} |
|
|
3298 |
|
|
3299 \def\dosubsubsecentry#1#2{\begingroup |
|
|
3300 \subsubsecentryfonts \leftskip=3\tocindent |
|
|
3301 \tocentry{#1}{\dopageno{#2}}% |
|
|
3302 \endgroup} |
|
|
3303 |
|
|
3304 % Final typesetting of a toc entry; we use the same \entry macro as for |
|
|
3305 % the index entries, but we want to suppress hyphenation here. (We |
|
|
3306 % can't do that in the \entry macro, since index entries might consist |
|
|
3307 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.) |
|
|
3308 % |
|
2483
|
3309 % \turnoffactive is for the sake of @" used for umlauts. |
|
2333
|
3310 \def\tocentry#1#2{\begingroup |
|
2483
|
3311 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks |
|
|
3312 \entry{\turnoffactive #1}{\turnoffactive #2}% |
|
2333
|
3313 \endgroup} |
|
|
3314 |
|
|
3315 % Space between chapter (or whatever) number and the title. |
|
|
3316 \def\labelspace{\hskip1em \relax} |
|
|
3317 |
|
|
3318 \def\dopageno#1{{\rm #1}} |
|
|
3319 \def\doshortpageno#1{{\rm #1}} |
|
|
3320 |
|
|
3321 \def\chapentryfonts{\secfonts \rm} |
|
|
3322 \def\secentryfonts{\textfonts} |
|
|
3323 \let\subsecentryfonts = \textfonts |
|
|
3324 \let\subsubsecentryfonts = \textfonts |
|
|
3325 |
|
|
3326 |
|
|
3327 \message{environments,} |
|
|
3328 |
|
|
3329 % Since these characters are used in examples, it should be an even number of |
|
|
3330 % \tt widths. Each \tt character is 1en, so two makes it 1em. |
|
|
3331 % Furthermore, these definitions must come after we define our fonts. |
|
|
3332 \newbox\dblarrowbox \newbox\longdblarrowbox |
|
|
3333 \newbox\pushcharbox \newbox\bullbox |
|
|
3334 \newbox\equivbox \newbox\errorbox |
|
|
3335 |
|
|
3336 %{\tentt |
|
|
3337 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil} |
|
|
3338 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil} |
|
|
3339 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil} |
|
|
3340 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil} |
|
|
3341 % Adapted from the manmac format (p.420 of TeXbook) |
|
|
3342 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex |
|
|
3343 % depth .1ex\hfil} |
|
|
3344 %} |
|
|
3345 |
|
2483
|
3346 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}. |
|
2333
|
3347 \def\point{$\star$} |
|
|
3348 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} |
|
|
3349 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} |
|
|
3350 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} |
|
|
3351 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} |
|
|
3352 |
|
|
3353 % Adapted from the TeXbook's \boxit. |
|
|
3354 {\tentt \global\dimen0 = 3em}% Width of the box. |
|
|
3355 \dimen2 = .55pt % Thickness of rules |
|
|
3356 % The text. (`r' is open on the right, `e' somewhat less so on the left.) |
|
|
3357 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} |
|
|
3358 |
|
|
3359 \global\setbox\errorbox=\hbox to \dimen0{\hfil |
|
|
3360 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. |
|
|
3361 \advance\hsize by -2\dimen2 % Rules. |
|
|
3362 \vbox{ |
|
|
3363 \hrule height\dimen2 |
|
|
3364 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. |
|
|
3365 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. |
|
|
3366 \kern3pt\vrule width\dimen2}% Space to right. |
|
|
3367 \hrule height\dimen2} |
|
|
3368 \hfil} |
|
|
3369 |
|
|
3370 % The @error{} command. |
|
|
3371 \def\error{\leavevmode\lower.7ex\copy\errorbox} |
|
|
3372 |
|
|
3373 % @tex ... @end tex escapes into raw Tex temporarily. |
|
|
3374 % One exception: @ is still an escape character, so that @end tex works. |
|
|
3375 % But \@ or @@ will get a plain tex @ character. |
|
|
3376 |
|
|
3377 \def\tex{\begingroup |
|
|
3378 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 |
|
|
3379 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 |
|
|
3380 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie |
|
|
3381 \catcode `\%=14 |
|
2483
|
3382 \catcode 43=12 % plus |
|
2333
|
3383 \catcode`\"=12 |
|
|
3384 \catcode`\==12 |
|
|
3385 \catcode`\|=12 |
|
|
3386 \catcode`\<=12 |
|
|
3387 \catcode`\>=12 |
|
|
3388 \escapechar=`\\ |
|
|
3389 % |
|
2483
|
3390 \let\,=\ptexcomma |
|
2333
|
3391 \let\{=\ptexlbrace |
|
|
3392 \let\}=\ptexrbrace |
|
|
3393 \let\.=\ptexdot |
|
|
3394 \let\*=\ptexstar |
|
2689
|
3395 \let\dots=\ptexdots% |
|
|
3396 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% |
|
|
3397 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% |
|
2333
|
3398 \def\@{@}% |
|
|
3399 \let\bullet=\ptexbullet |
|
2483
|
3400 \let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext |
|
2333
|
3401 % |
|
|
3402 \let\Etex=\endgroup} |
|
|
3403 |
|
|
3404 % Define @lisp ... @endlisp. |
|
|
3405 % @lisp does a \begingroup so it can rebind things, |
|
|
3406 % including the definition of @endlisp (which normally is erroneous). |
|
|
3407 |
|
|
3408 % Amount to narrow the margins by for @lisp. |
|
|
3409 \newskip\lispnarrowing \lispnarrowing=0.4in |
|
|
3410 |
|
|
3411 % This is the definition that ^^M gets inside @lisp, @example, and other |
|
|
3412 % such environments. \null is better than a space, since it doesn't |
|
|
3413 % have any width. |
|
|
3414 \def\lisppar{\null\endgraf} |
|
|
3415 |
|
|
3416 % Make each space character in the input produce a normal interword |
|
|
3417 % space in the output. Don't allow a line break at this space, as this |
|
|
3418 % is used only in environments like @example, where each line of input |
|
|
3419 % should produce a line of output anyway. |
|
|
3420 % |
|
|
3421 {\obeyspaces % |
|
|
3422 \gdef\sepspaces{\obeyspaces\let =\tie}} |
|
|
3423 |
|
|
3424 % Define \obeyedspace to be our active space, whatever it is. This is |
|
|
3425 % for use in \parsearg. |
|
|
3426 {\sepspaces% |
|
|
3427 \global\let\obeyedspace= } |
|
|
3428 |
|
|
3429 % This space is always present above and below environments. |
|
|
3430 \newskip\envskipamount \envskipamount = 0pt |
|
|
3431 |
|
|
3432 % Make spacing and below environment symmetrical. We use \parskip here |
|
|
3433 % to help in doing that, since in @example-like environments \parskip |
|
|
3434 % is reset to zero; thus the \afterenvbreak inserts no space -- but the |
|
|
3435 % start of the next paragraph will insert \parskip |
|
|
3436 % |
|
|
3437 \def\aboveenvbreak{{\advance\envskipamount by \parskip |
|
|
3438 \endgraf \ifdim\lastskip<\envskipamount |
|
|
3439 \removelastskip \penalty-50 \vskip\envskipamount \fi}} |
|
|
3440 |
|
|
3441 \let\afterenvbreak = \aboveenvbreak |
|
|
3442 |
|
|
3443 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins. |
|
|
3444 \let\nonarrowing=\relax |
|
|
3445 |
|
|
3446 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
|
|
3447 % \cartouche: draw rectangle w/rounded corners around argument |
|
|
3448 \font\circle=lcircle10 |
|
|
3449 \newdimen\circthick |
|
|
3450 \newdimen\cartouter\newdimen\cartinner |
|
|
3451 \newskip\normbskip\newskip\normpskip\newskip\normlskip |
|
|
3452 \circthick=\fontdimen8\circle |
|
|
3453 % |
|
|
3454 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth |
|
|
3455 \def\ctr{{\hskip 6pt\circle\char'010}} |
|
|
3456 \def\cbl{{\circle\char'012\hskip -6pt}} |
|
|
3457 \def\cbr{{\hskip 6pt\circle\char'011}} |
|
|
3458 \def\carttop{\hbox to \cartouter{\hskip\lskip |
|
|
3459 \ctl\leaders\hrule height\circthick\hfil\ctr |
|
|
3460 \hskip\rskip}} |
|
|
3461 \def\cartbot{\hbox to \cartouter{\hskip\lskip |
|
|
3462 \cbl\leaders\hrule height\circthick\hfil\cbr |
|
|
3463 \hskip\rskip}} |
|
|
3464 % |
|
|
3465 \newskip\lskip\newskip\rskip |
|
|
3466 |
|
|
3467 \long\def\cartouche{% |
|
|
3468 \begingroup |
|
|
3469 \lskip=\leftskip \rskip=\rightskip |
|
|
3470 \leftskip=0pt\rightskip=0pt %we want these *outside*. |
|
|
3471 \cartinner=\hsize \advance\cartinner by-\lskip |
|
|
3472 \advance\cartinner by-\rskip |
|
|
3473 \cartouter=\hsize |
|
|
3474 \advance\cartouter by 18pt % allow for 3pt kerns on either |
|
|
3475 % side, and for 6pt waste from |
|
|
3476 % each corner char |
|
|
3477 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip |
|
|
3478 % Flag to tell @lisp, etc., not to narrow margin. |
|
|
3479 \let\nonarrowing=\comment |
|
|
3480 \vbox\bgroup |
|
|
3481 \baselineskip=0pt\parskip=0pt\lineskip=0pt |
|
|
3482 \carttop |
|
|
3483 \hbox\bgroup |
|
|
3484 \hskip\lskip |
|
|
3485 \vrule\kern3pt |
|
|
3486 \vbox\bgroup |
|
|
3487 \hsize=\cartinner |
|
|
3488 \kern3pt |
|
|
3489 \begingroup |
|
|
3490 \baselineskip=\normbskip |
|
|
3491 \lineskip=\normlskip |
|
|
3492 \parskip=\normpskip |
|
|
3493 \vskip -\parskip |
|
|
3494 \def\Ecartouche{% |
|
|
3495 \endgroup |
|
|
3496 \kern3pt |
|
|
3497 \egroup |
|
|
3498 \kern3pt\vrule |
|
|
3499 \hskip\rskip |
|
|
3500 \egroup |
|
|
3501 \cartbot |
|
|
3502 \egroup |
|
|
3503 \endgroup |
|
|
3504 }} |
|
|
3505 |
|
|
3506 |
|
|
3507 % This macro is called at the beginning of all the @example variants, |
|
|
3508 % inside a group. |
|
|
3509 \def\nonfillstart{% |
|
|
3510 \aboveenvbreak |
|
|
3511 \inENV % This group ends at the end of the body |
|
|
3512 \hfuzz = 12pt % Don't be fussy |
|
|
3513 \sepspaces % Make spaces be word-separators rather than space tokens. |
|
|
3514 \singlespace |
|
|
3515 \let\par = \lisppar % don't ignore blank lines |
|
|
3516 \obeylines % each line of input is a line of output |
|
|
3517 \parskip = 0pt |
|
|
3518 \parindent = 0pt |
|
|
3519 \emergencystretch = 0pt % don't try to avoid overfull boxes |
|
|
3520 % @cartouche defines \nonarrowing to inhibit narrowing |
|
|
3521 % at next level down. |
|
|
3522 \ifx\nonarrowing\relax |
|
|
3523 \advance \leftskip by \lispnarrowing |
|
|
3524 \exdentamount=\lispnarrowing |
|
|
3525 \let\exdent=\nofillexdent |
|
|
3526 \let\nonarrowing=\relax |
|
|
3527 \fi |
|
|
3528 } |
|
|
3529 |
|
|
3530 % To ending an @example-like environment, we first end the paragraph |
|
|
3531 % (via \afterenvbreak's vertical glue), and then the group. That way we |
|
|
3532 % keep the zero \parskip that the environments set -- \parskip glue |
|
|
3533 % will be inserted at the beginning of the next paragraph in the |
|
|
3534 % document, after the environment. |
|
|
3535 % |
|
|
3536 \def\nonfillfinish{\afterenvbreak\endgroup}% |
|
|
3537 |
|
|
3538 % This macro is |
|
|
3539 \def\lisp{\begingroup |
|
|
3540 \nonfillstart |
|
|
3541 \let\Elisp = \nonfillfinish |
|
|
3542 \tt |
|
|
3543 \rawbackslash % have \ input char produce \ char from current font |
|
|
3544 \gobble |
|
|
3545 } |
|
|
3546 |
|
|
3547 % Define the \E... control sequence only if we are inside the |
|
|
3548 % environment, so the error checking in \end will work. |
|
|
3549 % |
|
|
3550 % We must call \lisp last in the definition, since it reads the |
|
|
3551 % return following the @example (or whatever) command. |
|
|
3552 % |
|
|
3553 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp} |
|
|
3554 \def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp} |
|
|
3555 \def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp} |
|
|
3556 |
|
|
3557 % @smallexample and @smalllisp. This is not used unless the @smallbook |
|
|
3558 % command is given. Originally contributed by Pavel@xerox. |
|
|
3559 % |
|
|
3560 \def\smalllispx{\begingroup |
|
|
3561 \nonfillstart |
|
|
3562 \let\Esmalllisp = \nonfillfinish |
|
|
3563 \let\Esmallexample = \nonfillfinish |
|
|
3564 % |
|
2483
|
3565 % Smaller fonts for small examples. |
|
2333
|
3566 \indexfonts \tt |
|
|
3567 \rawbackslash % make \ output the \ character from the current font (tt) |
|
|
3568 \gobble |
|
|
3569 } |
|
|
3570 |
|
|
3571 % This is @display; same as @lisp except use roman font. |
|
|
3572 % |
|
|
3573 \def\display{\begingroup |
|
|
3574 \nonfillstart |
|
|
3575 \let\Edisplay = \nonfillfinish |
|
|
3576 \gobble |
|
|
3577 } |
|
|
3578 |
|
|
3579 % This is @format; same as @display except don't narrow margins. |
|
|
3580 % |
|
|
3581 \def\format{\begingroup |
|
|
3582 \let\nonarrowing = t |
|
|
3583 \nonfillstart |
|
|
3584 \let\Eformat = \nonfillfinish |
|
|
3585 \gobble |
|
|
3586 } |
|
|
3587 |
|
|
3588 % @flushleft (same as @format) and @flushright. |
|
|
3589 % |
|
|
3590 \def\flushleft{\begingroup |
|
|
3591 \let\nonarrowing = t |
|
|
3592 \nonfillstart |
|
|
3593 \let\Eflushleft = \nonfillfinish |
|
|
3594 \gobble |
|
|
3595 } |
|
|
3596 \def\flushright{\begingroup |
|
|
3597 \let\nonarrowing = t |
|
|
3598 \nonfillstart |
|
|
3599 \let\Eflushright = \nonfillfinish |
|
|
3600 \advance\leftskip by 0pt plus 1fill |
|
|
3601 \gobble} |
|
|
3602 |
|
|
3603 % @quotation does normal linebreaking (hence we can't use \nonfillstart) |
|
|
3604 % and narrows the margins. |
|
|
3605 % |
|
|
3606 \def\quotation{% |
|
|
3607 \begingroup\inENV %This group ends at the end of the @quotation body |
|
|
3608 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip |
|
|
3609 \singlespace |
|
|
3610 \parindent=0pt |
|
|
3611 % We have retained a nonzero parskip for the environment, since we're |
|
|
3612 % doing normal filling. So to avoid extra space below the environment... |
|
|
3613 \def\Equotation{\parskip = 0pt \nonfillfinish}% |
|
|
3614 % |
|
|
3615 % @cartouche defines \nonarrowing to inhibit narrowing at next level down. |
|
|
3616 \ifx\nonarrowing\relax |
|
|
3617 \advance\leftskip by \lispnarrowing |
|
|
3618 \advance\rightskip by \lispnarrowing |
|
|
3619 \exdentamount = \lispnarrowing |
|
|
3620 \let\nonarrowing = \relax |
|
|
3621 \fi |
|
|
3622 } |
|
|
3623 |
|
|
3624 \message{defuns,} |
|
|
3625 % Define formatter for defuns |
|
|
3626 % First, allow user to change definition object font (\df) internally |
|
|
3627 \def\setdeffont #1 {\csname DEF#1\endcsname} |
|
|
3628 |
|
|
3629 \newskip\defbodyindent \defbodyindent=.4in |
|
|
3630 \newskip\defargsindent \defargsindent=50pt |
|
|
3631 \newskip\deftypemargin \deftypemargin=12pt |
|
|
3632 \newskip\deflastargmargin \deflastargmargin=18pt |
|
|
3633 |
|
|
3634 \newcount\parencount |
|
|
3635 % define \functionparens, which makes ( and ) and & do special things. |
|
|
3636 % \functionparens affects the group it is contained in. |
|
|
3637 \def\activeparens{% |
|
|
3638 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active |
|
|
3639 \catcode`\[=\active \catcode`\]=\active} |
|
|
3640 |
|
|
3641 % Make control sequences which act like normal parenthesis chars. |
|
|
3642 \let\lparen = ( \let\rparen = ) |
|
|
3643 |
|
|
3644 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm) |
|
|
3645 |
|
|
3646 % Be sure that we always have a definition for `(', etc. For example, |
|
|
3647 % if the fn name has parens in it, \boldbrax will not be in effect yet, |
|
|
3648 % so TeX would otherwise complain about undefined control sequence. |
|
|
3649 \global\let(=\lparen \global\let)=\rparen |
|
|
3650 \global\let[=\lbrack \global\let]=\rbrack |
|
|
3651 |
|
|
3652 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 } |
|
|
3653 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} |
|
2483
|
3654 % This is used to turn on special parens |
|
|
3655 % but make & act ordinary (given that it's active). |
|
|
3656 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr} |
|
2333
|
3657 |
|
|
3658 % Definitions of (, ) and & used in args for functions. |
|
|
3659 % This is the definition of ( outside of all parentheses. |
|
|
3660 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested % |
|
|
3661 \global\advance\parencount by 1 } |
|
|
3662 % |
|
|
3663 % This is the definition of ( when already inside a level of parens. |
|
|
3664 \gdef\opnested{\char`\(\global\advance\parencount by 1 } |
|
|
3665 % |
|
|
3666 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0. |
|
|
3667 % also in that case restore the outer-level definition of (. |
|
|
3668 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi |
|
|
3669 \global\advance \parencount by -1 } |
|
|
3670 % If we encounter &foo, then turn on ()-hacking afterwards |
|
|
3671 \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ } |
|
|
3672 % |
|
|
3673 \gdef\normalparens{\boldbrax\let&=\ampnr} |
|
|
3674 } % End of definition inside \activeparens |
|
|
3675 %% These parens (in \boldbrax) actually are a little bolder than the |
|
|
3676 %% contained text. This is especially needed for [ and ] |
|
|
3677 \def\opnr{{\sf\char`\(}} \def\clnr{{\sf\char`\)}} \def\ampnr{\&} |
|
|
3678 \def\lbrb{{\bf\char`\[}} \def\rbrb{{\bf\char`\]}} |
|
|
3679 |
|
|
3680 % First, defname, which formats the header line itself. |
|
|
3681 % #1 should be the function name. |
|
|
3682 % #2 should be the type of definition, such as "Function". |
|
|
3683 |
|
|
3684 \def\defname #1#2{% |
|
|
3685 % Get the values of \leftskip and \rightskip as they were |
|
|
3686 % outside the @def... |
|
|
3687 \dimen2=\leftskip |
|
|
3688 \advance\dimen2 by -\defbodyindent |
|
|
3689 \dimen3=\rightskip |
|
|
3690 \advance\dimen3 by -\defbodyindent |
|
|
3691 \noindent % |
|
|
3692 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}% |
|
|
3693 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line |
|
|
3694 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations |
|
|
3695 \parshape 2 0in \dimen0 \defargsindent \dimen1 % |
|
|
3696 % Now output arg 2 ("Function" or some such) |
|
|
3697 % ending at \deftypemargin from the right margin, |
|
|
3698 % but stuck inside a box of width 0 so it does not interfere with linebreaking |
|
|
3699 {% Adjust \hsize to exclude the ambient margins, |
|
|
3700 % so that \rightline will obey them. |
|
|
3701 \advance \hsize by -\dimen2 \advance \hsize by -\dimen3 |
|
|
3702 \rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}% |
|
|
3703 % Make all lines underfull and no complaints: |
|
|
3704 \tolerance=10000 \hbadness=10000 |
|
|
3705 \advance\leftskip by -\defbodyindent |
|
|
3706 \exdentamount=\defbodyindent |
|
|
3707 {\df #1}\enskip % Generate function name |
|
|
3708 } |
|
|
3709 |
|
|
3710 % Actually process the body of a definition |
|
|
3711 % #1 should be the terminating control sequence, such as \Edefun. |
|
|
3712 % #2 should be the "another name" control sequence, such as \defunx. |
|
|
3713 % #3 should be the control sequence that actually processes the header, |
|
|
3714 % such as \defunheader. |
|
|
3715 |
|
|
3716 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody |
|
|
3717 \medbreak % |
|
|
3718 % Define the end token that this defining construct specifies |
|
|
3719 % so that it will exit this group. |
|
|
3720 \def#1{\endgraf\endgroup\medbreak}% |
|
|
3721 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}% |
|
|
3722 \parindent=0in |
|
|
3723 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent |
|
|
3724 \exdentamount=\defbodyindent |
|
|
3725 \begingroup % |
|
|
3726 \catcode 61=\active % 61 is `=' |
|
|
3727 \obeylines\activeparens\spacesplit#3} |
|
|
3728 |
|
|
3729 \def\defmethparsebody #1#2#3#4 {\begingroup\inENV % |
|
|
3730 \medbreak % |
|
|
3731 % Define the end token that this defining construct specifies |
|
|
3732 % so that it will exit this group. |
|
|
3733 \def#1{\endgraf\endgroup\medbreak}% |
|
|
3734 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}% |
|
|
3735 \parindent=0in |
|
|
3736 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent |
|
|
3737 \exdentamount=\defbodyindent |
|
|
3738 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}} |
|
|
3739 |
|
|
3740 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV % |
|
|
3741 \medbreak % |
|
|
3742 % Define the end token that this defining construct specifies |
|
|
3743 % so that it will exit this group. |
|
|
3744 \def#1{\endgraf\endgroup\medbreak}% |
|
|
3745 \def#2##1 ##2 {\def#4{##1}% |
|
|
3746 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}% |
|
|
3747 \parindent=0in |
|
|
3748 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent |
|
|
3749 \exdentamount=\defbodyindent |
|
|
3750 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}} |
|
|
3751 |
|
|
3752 % These parsing functions are similar to the preceding ones |
|
|
3753 % except that they do not make parens into active characters. |
|
|
3754 % These are used for "variables" since they have no arguments. |
|
|
3755 |
|
|
3756 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody |
|
|
3757 \medbreak % |
|
|
3758 % Define the end token that this defining construct specifies |
|
|
3759 % so that it will exit this group. |
|
|
3760 \def#1{\endgraf\endgroup\medbreak}% |
|
|
3761 \def#2{\begingroup\obeylines\spacesplit#3}% |
|
|
3762 \parindent=0in |
|
|
3763 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent |
|
|
3764 \exdentamount=\defbodyindent |
|
|
3765 \begingroup % |
|
|
3766 \catcode 61=\active % |
|
|
3767 \obeylines\spacesplit#3} |
|
|
3768 |
|
|
3769 % This is used for \def{tp,vr}parsebody. It could probably be used for |
|
|
3770 % some of the others, too, with some judicious conditionals. |
|
2670
|
3771 % |
|
2333
|
3772 \def\parsebodycommon#1#2#3{% |
|
|
3773 \begingroup\inENV % |
|
|
3774 \medbreak % |
|
|
3775 % Define the end token that this defining construct specifies |
|
|
3776 % so that it will exit this group. |
|
|
3777 \def#1{\endgraf\endgroup\medbreak}% |
|
|
3778 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}% |
|
|
3779 \parindent=0in |
|
|
3780 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent |
|
|
3781 \exdentamount=\defbodyindent |
|
|
3782 \begingroup\obeylines |
|
|
3783 } |
|
|
3784 |
|
|
3785 \def\defvrparsebody#1#2#3#4 {% |
|
|
3786 \parsebodycommon{#1}{#2}{#3}% |
|
|
3787 \spacesplit{#3{#4}}% |
|
|
3788 } |
|
|
3789 |
|
|
3790 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the |
|
|
3791 % type is just `struct', because we lose the braces in `{struct |
|
|
3792 % termios}' when \spacesplit reads its undelimited argument. Sigh. |
|
|
3793 % \let\deftpparsebody=\defvrparsebody |
|
|
3794 % |
|
|
3795 % So, to get around this, we put \empty in with the type name. That |
|
|
3796 % way, TeX won't find exactly `{...}' as an undelimited argument, and |
|
|
3797 % won't strip off the braces. |
|
|
3798 % |
|
|
3799 \def\deftpparsebody #1#2#3#4 {% |
|
|
3800 \parsebodycommon{#1}{#2}{#3}% |
|
|
3801 \spacesplit{\parsetpheaderline{#3{#4}}}\empty |
|
|
3802 } |
|
|
3803 |
|
|
3804 % Fine, but then we have to eventually remove the \empty *and* the |
|
2670
|
3805 % braces (if any). That's what this does. |
|
|
3806 % |
|
|
3807 \def\removeemptybraces\empty#1\relax{#1} |
|
2333
|
3808 |
|
|
3809 % After \spacesplit has done its work, this is called -- #1 is the final |
|
|
3810 % thing to call, #2 the type name (which starts with \empty), and #3 |
|
|
3811 % (which might be empty) the arguments. |
|
2670
|
3812 % |
|
2333
|
3813 \def\parsetpheaderline#1#2#3{% |
|
2670
|
3814 #1{\removeemptybraces#2\relax}{#3}% |
|
2333
|
3815 }% |
|
|
3816 |
|
|
3817 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV % |
|
|
3818 \medbreak % |
|
|
3819 % Define the end token that this defining construct specifies |
|
|
3820 % so that it will exit this group. |
|
|
3821 \def#1{\endgraf\endgroup\medbreak}% |
|
|
3822 \def#2##1 ##2 {\def#4{##1}% |
|
|
3823 \begingroup\obeylines\spacesplit{#3{##2}}}% |
|
|
3824 \parindent=0in |
|
|
3825 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent |
|
|
3826 \exdentamount=\defbodyindent |
|
|
3827 \begingroup\obeylines\spacesplit{#3{#5}}} |
|
|
3828 |
|
|
3829 % Split up #2 at the first space token. |
|
|
3830 % call #1 with two arguments: |
|
|
3831 % the first is all of #2 before the space token, |
|
|
3832 % the second is all of #2 after that space token. |
|
|
3833 % If #2 contains no space token, all of it is passed as the first arg |
|
|
3834 % and the second is passed as empty. |
|
|
3835 |
|
|
3836 {\obeylines |
|
|
3837 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}% |
|
|
3838 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{% |
|
|
3839 \ifx\relax #3% |
|
|
3840 #1{#2}{}\else #1{#2}{#3#4}\fi}} |
|
|
3841 |
|
|
3842 % So much for the things common to all kinds of definitions. |
|
|
3843 |
|
|
3844 % Define @defun. |
|
|
3845 |
|
|
3846 % First, define the processing that is wanted for arguments of \defun |
|
|
3847 % Use this to expand the args and terminate the paragraph they make up |
|
|
3848 |
|
|
3849 \def\defunargs #1{\functionparens \sl |
|
|
3850 % Expand, preventing hyphenation at `-' chars. |
|
|
3851 % Note that groups don't affect changes in \hyphenchar. |
|
|
3852 \hyphenchar\tensl=0 |
|
|
3853 #1% |
|
|
3854 \hyphenchar\tensl=45 |
|
|
3855 \ifnum\parencount=0 \else \errmessage{unbalanced parens in @def arguments}\fi% |
|
|
3856 \interlinepenalty=10000 |
|
|
3857 \advance\rightskip by 0pt plus 1fil |
|
|
3858 \endgraf\penalty 10000\vskip -\parskip\penalty 10000% |
|
|
3859 } |
|
|
3860 |
|
|
3861 \def\deftypefunargs #1{% |
|
|
3862 % Expand, preventing hyphenation at `-' chars. |
|
|
3863 % Note that groups don't affect changes in \hyphenchar. |
|
2483
|
3864 % Use \boldbraxnoamp, not \functionparens, so that & is not special. |
|
|
3865 \boldbraxnoamp |
|
2333
|
3866 \tclose{#1}% avoid \code because of side effects on active chars |
|
|
3867 \interlinepenalty=10000 |
|
|
3868 \advance\rightskip by 0pt plus 1fil |
|
|
3869 \endgraf\penalty 10000\vskip -\parskip\penalty 10000% |
|
|
3870 } |
|
|
3871 |
|
|
3872 % Do complete processing of one @defun or @defunx line already parsed. |
|
|
3873 |
|
|
3874 % @deffn Command forward-char nchars |
|
|
3875 |
|
|
3876 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader} |
|
|
3877 |
|
|
3878 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}% |
|
|
3879 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup % |
|
|
3880 \catcode 61=\other % Turn off change made in \defparsebody |
|
|
3881 } |
|
|
3882 |
|
|
3883 % @defun == @deffn Function |
|
|
3884 |
|
|
3885 \def\defun{\defparsebody\Edefun\defunx\defunheader} |
|
|
3886 |
|
|
3887 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index |
|
|
3888 \begingroup\defname {#1}{Function}% |
|
|
3889 \defunargs {#2}\endgroup % |
|
|
3890 \catcode 61=\other % Turn off change made in \defparsebody |
|
|
3891 } |
|
|
3892 |
|
|
3893 % @deftypefun int foobar (int @var{foo}, float @var{bar}) |
|
|
3894 |
|
|
3895 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader} |
|
|
3896 |
|
|
3897 % #1 is the data type. #2 is the name and args. |
|
|
3898 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax} |
|
|
3899 % #1 is the data type, #2 the name, #3 the args. |
|
|
3900 \def\deftypefunheaderx #1#2 #3\relax{% |
|
|
3901 \doind {fn}{\code{#2}}% Make entry in function index |
|
|
3902 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Function}% |
|
|
3903 \deftypefunargs {#3}\endgroup % |
|
|
3904 \catcode 61=\other % Turn off change made in \defparsebody |
|
|
3905 } |
|
|
3906 |
|
|
3907 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar}) |
|
|
3908 |
|
|
3909 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader} |
|
|
3910 |
|
|
3911 % \defheaderxcond#1\relax$$$ |
|
|
3912 % puts #1 in @code, followed by a space, but does nothing if #1 is null. |
|
|
3913 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi} |
|
|
3914 |
|
|
3915 % #1 is the classification. #2 is the data type. #3 is the name and args. |
|
|
3916 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax} |
|
|
3917 % #1 is the classification, #2 the data type, #3 the name, #4 the args. |
|
|
3918 \def\deftypefnheaderx #1#2#3 #4\relax{% |
|
|
3919 \doind {fn}{\code{#3}}% Make entry in function index |
|
|
3920 \begingroup |
|
|
3921 \normalparens % notably, turn off `&' magic, which prevents |
|
|
3922 % at least some C++ text from working |
|
|
3923 \defname {\defheaderxcond#2\relax$$$#3}{#1}% |
|
|
3924 \deftypefunargs {#4}\endgroup % |
|
|
3925 \catcode 61=\other % Turn off change made in \defparsebody |
|
|
3926 } |
|
|
3927 |
|
|
3928 % @defmac == @deffn Macro |
|
|
3929 |
|
|
3930 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader} |
|
|
3931 |
|
|
3932 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index |
|
|
3933 \begingroup\defname {#1}{Macro}% |
|
|
3934 \defunargs {#2}\endgroup % |
|
|
3935 \catcode 61=\other % Turn off change made in \defparsebody |
|
|
3936 } |
|
|
3937 |
|
|
3938 % @defspec == @deffn Special Form |
|
|
3939 |
|
|
3940 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader} |
|
|
3941 |
|
|
3942 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index |
|
|
3943 \begingroup\defname {#1}{Special Form}% |
|
|
3944 \defunargs {#2}\endgroup % |
|
|
3945 \catcode 61=\other % Turn off change made in \defparsebody |
|
|
3946 } |
|
|
3947 |
|
|
3948 % This definition is run if you use @defunx |
|
|
3949 % anywhere other than immediately after a @defun or @defunx. |
|
|
3950 |
|
|
3951 \def\deffnx #1 {\errmessage{@deffnx in invalid context}} |
|
|
3952 \def\defunx #1 {\errmessage{@defunx in invalid context}} |
|
|
3953 \def\defmacx #1 {\errmessage{@defmacx in invalid context}} |
|
|
3954 \def\defspecx #1 {\errmessage{@defspecx in invalid context}} |
|
|
3955 \def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}} |
|
|
3956 \def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}} |
|
|
3957 |
|
|
3958 % @defmethod, and so on |
|
|
3959 |
|
|
3960 % @defop {Funny Method} foo-class frobnicate argument |
|
|
3961 |
|
|
3962 \def\defop #1 {\def\defoptype{#1}% |
|
|
3963 \defopparsebody\Edefop\defopx\defopheader\defoptype} |
|
|
3964 |
|
|
3965 \def\defopheader #1#2#3{% |
|
|
3966 \dosubind {fn}{\code{#2}}{on #1}% Make entry in function index |
|
|
3967 \begingroup\defname {#2}{\defoptype{} on #1}% |
|
|
3968 \defunargs {#3}\endgroup % |
|
|
3969 } |
|
|
3970 |
|
|
3971 % @defmethod == @defop Method |
|
|
3972 |
|
|
3973 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader} |
|
|
3974 |
|
|
3975 \def\defmethodheader #1#2#3{% |
|
|
3976 \dosubind {fn}{\code{#2}}{on #1}% entry in function index |
|
|
3977 \begingroup\defname {#2}{Method on #1}% |
|
|
3978 \defunargs {#3}\endgroup % |
|
|
3979 } |
|
|
3980 |
|
|
3981 % @defcv {Class Option} foo-class foo-flag |
|
|
3982 |
|
|
3983 \def\defcv #1 {\def\defcvtype{#1}% |
|
|
3984 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype} |
|
|
3985 |
|
|
3986 \def\defcvarheader #1#2#3{% |
|
|
3987 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index |
|
|
3988 \begingroup\defname {#2}{\defcvtype{} of #1}% |
|
|
3989 \defvarargs {#3}\endgroup % |
|
|
3990 } |
|
|
3991 |
|
|
3992 % @defivar == @defcv {Instance Variable} |
|
|
3993 |
|
|
3994 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader} |
|
|
3995 |
|
|
3996 \def\defivarheader #1#2#3{% |
|
|
3997 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index |
|
|
3998 \begingroup\defname {#2}{Instance Variable of #1}% |
|
|
3999 \defvarargs {#3}\endgroup % |
|
|
4000 } |
|
|
4001 |
|
|
4002 % These definitions are run if you use @defmethodx, etc., |
|
|
4003 % anywhere other than immediately after a @defmethod, etc. |
|
|
4004 |
|
|
4005 \def\defopx #1 {\errmessage{@defopx in invalid context}} |
|
|
4006 \def\defmethodx #1 {\errmessage{@defmethodx in invalid context}} |
|
|
4007 \def\defcvx #1 {\errmessage{@defcvx in invalid context}} |
|
|
4008 \def\defivarx #1 {\errmessage{@defivarx in invalid context}} |
|
|
4009 |
|
|
4010 % Now @defvar |
|
|
4011 |
|
|
4012 % First, define the processing that is wanted for arguments of @defvar. |
|
|
4013 % This is actually simple: just print them in roman. |
|
|
4014 % This must expand the args and terminate the paragraph they make up |
|
|
4015 \def\defvarargs #1{\normalparens #1% |
|
|
4016 \interlinepenalty=10000 |
|
|
4017 \endgraf\penalty 10000\vskip -\parskip\penalty 10000} |
|
|
4018 |
|
|
4019 % @defvr Counter foo-count |
|
|
4020 |
|
|
4021 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader} |
|
|
4022 |
|
|
4023 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}% |
|
|
4024 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup} |
|
|
4025 |
|
|
4026 % @defvar == @defvr Variable |
|
|
4027 |
|
|
4028 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader} |
|
|
4029 |
|
|
4030 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index |
|
|
4031 \begingroup\defname {#1}{Variable}% |
|
|
4032 \defvarargs {#2}\endgroup % |
|
|
4033 } |
|
|
4034 |
|
|
4035 % @defopt == @defvr {User Option} |
|
|
4036 |
|
|
4037 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader} |
|
|
4038 |
|
|
4039 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index |
|
|
4040 \begingroup\defname {#1}{User Option}% |
|
|
4041 \defvarargs {#2}\endgroup % |
|
|
4042 } |
|
|
4043 |
|
|
4044 % @deftypevar int foobar |
|
|
4045 |
|
|
4046 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader} |
|
|
4047 |
|
2670
|
4048 % #1 is the data type. #2 is the name, perhaps followed by text that |
|
|
4049 % is actually part of the data type, which should not be put into the index. |
|
2333
|
4050 \def\deftypevarheader #1#2{% |
|
2670
|
4051 \dovarind#2 \relax% Make entry in variables index |
|
2333
|
4052 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Variable}% |
|
|
4053 \interlinepenalty=10000 |
|
|
4054 \endgraf\penalty 10000\vskip -\parskip\penalty 10000 |
|
|
4055 \endgroup} |
|
2670
|
4056 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}} |
|
2333
|
4057 |
|
|
4058 % @deftypevr {Global Flag} int enable |
|
|
4059 |
|
|
4060 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader} |
|
|
4061 |
|
2670
|
4062 \def\deftypevrheader #1#2#3{\dovarind#3 \relax% |
|
2333
|
4063 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1} |
|
|
4064 \interlinepenalty=10000 |
|
|
4065 \endgraf\penalty 10000\vskip -\parskip\penalty 10000 |
|
|
4066 \endgroup} |
|
|
4067 |
|
|
4068 % This definition is run if you use @defvarx |
|
|
4069 % anywhere other than immediately after a @defvar or @defvarx. |
|
|
4070 |
|
|
4071 \def\defvrx #1 {\errmessage{@defvrx in invalid context}} |
|
|
4072 \def\defvarx #1 {\errmessage{@defvarx in invalid context}} |
|
|
4073 \def\defoptx #1 {\errmessage{@defoptx in invalid context}} |
|
|
4074 \def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}} |
|
|
4075 \def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}} |
|
|
4076 |
|
|
4077 % Now define @deftp |
|
|
4078 % Args are printed in bold, a slight difference from @defvar. |
|
|
4079 |
|
|
4080 \def\deftpargs #1{\bf \defvarargs{#1}} |
|
|
4081 |
|
|
4082 % @deftp Class window height width ... |
|
|
4083 |
|
|
4084 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader} |
|
|
4085 |
|
|
4086 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}% |
|
|
4087 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup} |
|
|
4088 |
|
|
4089 % This definition is run if you use @deftpx, etc |
|
|
4090 % anywhere other than immediately after a @deftp, etc. |
|
|
4091 |
|
|
4092 \def\deftpx #1 {\errmessage{@deftpx in invalid context}} |
|
|
4093 |
|
2483
|
4094 |
|
2333
|
4095 \message{cross reference,} |
|
|
4096 % Define cross-reference macros |
|
|
4097 \newwrite \auxfile |
|
|
4098 |
|
|
4099 \newif\ifhavexrefs % True if xref values are known. |
|
|
4100 \newif\ifwarnedxrefs % True if we warned once that they aren't known. |
|
|
4101 |
|
2483
|
4102 % @inforef is simple. |
|
|
4103 \def\inforef #1{\inforefzzz #1,,,,**} |
|
|
4104 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, |
|
|
4105 node \samp{\ignorespaces#1{}}} |
|
|
4106 |
|
2333
|
4107 % \setref{foo} defines a cross-reference point named foo. |
|
|
4108 |
|
|
4109 \def\setref#1{% |
|
|
4110 \dosetq{#1-title}{Ytitle}% |
|
|
4111 \dosetq{#1-pg}{Ypagenumber}% |
|
|
4112 \dosetq{#1-snt}{Ysectionnumberandtype}} |
|
|
4113 |
|
|
4114 \def\unnumbsetref#1{% |
|
|
4115 \dosetq{#1-title}{Ytitle}% |
|
|
4116 \dosetq{#1-pg}{Ypagenumber}% |
|
|
4117 \dosetq{#1-snt}{Ynothing}} |
|
|
4118 |
|
|
4119 \def\appendixsetref#1{% |
|
|
4120 \dosetq{#1-title}{Ytitle}% |
|
|
4121 \dosetq{#1-pg}{Ypagenumber}% |
|
|
4122 \dosetq{#1-snt}{Yappendixletterandtype}} |
|
|
4123 |
|
|
4124 % \xref, \pxref, and \ref generate cross-references to specified points. |
|
|
4125 % For \xrefX, #1 is the node name, #2 the name of the Info |
|
|
4126 % cross-reference, #3 the printed node name, #4 the name of the Info |
|
|
4127 % file, #5 the name of the printed manual. All but the node name can be |
|
|
4128 % omitted. |
|
|
4129 % |
|
|
4130 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} |
|
|
4131 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} |
|
|
4132 \def\ref#1{\xrefX[#1,,,,,,,]} |
|
|
4133 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup |
|
|
4134 \def\printedmanual{\ignorespaces #5}% |
|
|
4135 \def\printednodename{\ignorespaces #3}% |
|
|
4136 \setbox1=\hbox{\printedmanual}% |
|
|
4137 \setbox0=\hbox{\printednodename}% |
|
|
4138 \ifdim \wd0 = 0pt |
|
|
4139 % No printed node name was explicitly given. |
|
2483
|
4140 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax |
|
|
4141 % Use the node name inside the square brackets. |
|
|
4142 \def\printednodename{\ignorespaces #1}% |
|
|
4143 \else |
|
2333
|
4144 % Use the actual chapter/section title appear inside |
|
|
4145 % the square brackets. Use the real section title if we have it. |
|
|
4146 \ifdim \wd1>0pt% |
|
|
4147 % It is in another manual, so we don't have it. |
|
|
4148 \def\printednodename{\ignorespaces #1}% |
|
|
4149 \else |
|
|
4150 \ifhavexrefs |
|
|
4151 % We know the real title if we have the xref values. |
|
2483
|
4152 \def\printednodename{\refx{#1-title}{}}% |
|
2333
|
4153 \else |
|
|
4154 % Otherwise just copy the Info node name. |
|
|
4155 \def\printednodename{\ignorespaces #1}% |
|
|
4156 \fi% |
|
|
4157 \fi |
|
|
4158 \fi |
|
|
4159 \fi |
|
|
4160 % |
|
|
4161 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not |
|
|
4162 % insert empty discretionaries after hyphens, which means that it will |
|
|
4163 % not find a line break at a hyphen in a node names. Since some manuals |
|
|
4164 % are best written with fairly long node names, containing hyphens, this |
|
|
4165 % is a loss. Therefore, we give the text of the node name again, so it |
|
|
4166 % is as if TeX is seeing it for the first time. |
|
|
4167 \ifdim \wd1 > 0pt |
|
|
4168 \putwordsection{} ``\printednodename'' in \cite{\printedmanual}% |
|
|
4169 \else |
|
|
4170 % _ (for example) has to be the character _ for the purposes of the |
|
|
4171 % control sequence corresponding to the node, but it has to expand |
|
|
4172 % into the usual \leavevmode...\vrule stuff for purposes of |
|
|
4173 % printing. So we \turnoffactive for the \refx-snt, back on for the |
|
|
4174 % printing, back off for the \refx-pg. |
|
|
4175 {\turnoffactive \refx{#1-snt}{}}% |
|
|
4176 \space [\printednodename],\space |
|
|
4177 \turnoffactive \putwordpage\tie\refx{#1-pg}{}% |
|
|
4178 \fi |
|
|
4179 \endgroup} |
|
|
4180 |
|
|
4181 % \dosetq is the interface for calls from other macros |
|
|
4182 |
|
|
4183 % Use \turnoffactive so that punctuation chars such as underscore |
|
|
4184 % work in node names. |
|
2670
|
4185 \def\dosetq #1#2{{\let\folio=0 \turnoffactive |
|
2333
|
4186 \edef\next{\write\auxfile{\internalsetq {#1}{#2}}}% |
|
|
4187 \next}} |
|
|
4188 |
|
|
4189 % \internalsetq {foo}{page} expands into |
|
|
4190 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...} |
|
|
4191 % When the aux file is read, ' is the escape character |
|
|
4192 |
|
|
4193 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}} |
|
|
4194 |
|
|
4195 % Things to be expanded by \internalsetq |
|
|
4196 |
|
|
4197 \def\Ypagenumber{\folio} |
|
|
4198 |
|
|
4199 \def\Ytitle{\thissection} |
|
|
4200 |
|
|
4201 \def\Ynothing{} |
|
|
4202 |
|
|
4203 \def\Ysectionnumberandtype{% |
|
|
4204 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno % |
|
|
4205 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno % |
|
|
4206 \else \ifnum \subsubsecno=0 % |
|
|
4207 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno % |
|
|
4208 \else % |
|
|
4209 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno % |
|
|
4210 \fi \fi \fi } |
|
|
4211 |
|
|
4212 \def\Yappendixletterandtype{% |
|
|
4213 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}% |
|
|
4214 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno % |
|
|
4215 \else \ifnum \subsubsecno=0 % |
|
|
4216 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno % |
|
|
4217 \else % |
|
|
4218 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno % |
|
|
4219 \fi \fi \fi } |
|
|
4220 |
|
|
4221 \gdef\xreftie{'tie} |
|
|
4222 |
|
|
4223 % Use TeX 3.0's \inputlineno to get the line number, for better error |
|
|
4224 % messages, but if we're using an old version of TeX, don't do anything. |
|
|
4225 % |
|
|
4226 \ifx\inputlineno\thisisundefined |
|
|
4227 \let\linenumber = \empty % Non-3.0. |
|
|
4228 \else |
|
|
4229 \def\linenumber{\the\inputlineno:\space} |
|
|
4230 \fi |
|
|
4231 |
|
|
4232 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. |
|
|
4233 % If its value is nonempty, SUFFIX is output afterward. |
|
|
4234 |
|
|
4235 \def\refx#1#2{% |
|
|
4236 \expandafter\ifx\csname X#1\endcsname\relax |
|
|
4237 % If not defined, say something at least. |
|
|
4238 $\langle$un\-de\-fined$\rangle$% |
|
|
4239 \ifhavexrefs |
|
|
4240 \message{\linenumber Undefined cross reference `#1'.}% |
|
|
4241 \else |
|
|
4242 \ifwarnedxrefs\else |
|
|
4243 \global\warnedxrefstrue |
|
|
4244 \message{Cross reference values unknown; you must run TeX again.}% |
|
|
4245 \fi |
|
|
4246 \fi |
|
|
4247 \else |
|
|
4248 % It's defined, so just use it. |
|
|
4249 \csname X#1\endcsname |
|
|
4250 \fi |
|
|
4251 #2% Output the suffix in any case. |
|
|
4252 } |
|
|
4253 |
|
2670
|
4254 % This is the macro invoked by entries in the aux file. |
|
|
4255 \def\xrdef #1#2{{% |
|
|
4256 \catcode`\'=\other |
|
|
4257 \expandafter\gdef\csname X#1\endcsname{#2}% |
|
|
4258 }} |
|
|
4259 |
|
2333
|
4260 % Read the last existing aux file, if any. No error if none exists. |
|
2670
|
4261 \def\readauxfile{\begingroup |
|
|
4262 \catcode`\^^@=\other |
|
|
4263 \catcode`\=\other |
|
|
4264 \catcode`\=\other |
|
|
4265 \catcode`\^^C=\other |
|
|
4266 \catcode`\^^D=\other |
|
|
4267 \catcode`\^^E=\other |
|
|
4268 \catcode`\^^F=\other |
|
|
4269 \catcode`\^^G=\other |
|
|
4270 \catcode`\^^H=\other |
|
|
4271 \catcode`\ |
|
|
4272 =\other |
|
|
4273 \catcode`\^^L=\other |
|
|
4274 \catcode`\=\other |
|
|
4275 \catcode`\=\other |
|
|
4276 \catcode`\=\other |
|
|
4277 \catcode`\=\other |
|
|
4278 \catcode`\=\other |
|
|
4279 \catcode`\=\other |
|
|
4280 \catcode`\=\other |
|
|
4281 \catcode`\=\other |
|
|
4282 \catcode`\=\other |
|
|
4283 \catcode`\=\other |
|
|
4284 \catcode`\=\other |
|
|
4285 \catcode`\=\other |
|
|
4286 \catcode26=\other |
|
|
4287 \catcode`\^^[=\other |
|
|
4288 \catcode`\^^\=\other |
|
|
4289 \catcode`\^^]=\other |
|
|
4290 \catcode`\^^^=\other |
|
|
4291 \catcode`\^^_=\other |
|
|
4292 \catcode`\@=\other |
|
|
4293 \catcode`\^=\other |
|
|
4294 % It was suggested to define this as 7, which would allow ^^e4 etc. |
|
|
4295 % in xref tags, i.e., node names. But since ^^e4 notation isn't |
|
|
4296 % supported in the main text, it doesn't seem desirable. Furthermore, |
|
|
4297 % that is not enough: for node names that actually contain a ^ |
|
|
4298 % character, we would end up writing a line like this: 'xrdef {'hat |
|
|
4299 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first |
|
|
4300 % argument, and \hat is not an expandable control sequence. It could |
|
|
4301 % all be worked out, but why? Either we support ^^ or we don't. |
|
|
4302 % |
|
|
4303 % The other change necessary for this was to define \auxhat: |
|
|
4304 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter |
|
|
4305 % and then to call \auxhat in \setq. |
|
|
4306 % |
|
|
4307 \catcode`\~=\other |
|
|
4308 \catcode`\[=\other |
|
|
4309 \catcode`\]=\other |
|
|
4310 \catcode`\"=\other |
|
|
4311 \catcode`\_=\other |
|
|
4312 \catcode`\|=\other |
|
|
4313 \catcode`\<=\other |
|
|
4314 \catcode`\>=\other |
|
|
4315 \catcode`\$=\other |
|
|
4316 \catcode`\#=\other |
|
|
4317 \catcode`\&=\other |
|
|
4318 % `\+ does not work, so use 43. |
|
|
4319 \catcode43=\other |
|
|
4320 % Make the characters 128-255 be printing characters |
|
|
4321 {% |
|
|
4322 \count 1=128 |
|
|
4323 \def\loop{% |
|
|
4324 \catcode\count 1=\other |
|
|
4325 \advance\count 1 by 1 |
|
|
4326 \ifnum \count 1<256 \loop \fi |
|
2333
|
4327 }% |
|
2670
|
4328 }% |
|
|
4329 % The aux file uses ' as the escape (for now). |
|
|
4330 % Turn off \ as an escape so we do not lose on |
|
|
4331 % entries which were dumped with control sequences in their names. |
|
|
4332 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^ |
|
|
4333 % Reference to such entries still does not work the way one would wish, |
|
|
4334 % but at least they do not bomb out when the aux file is read in. |
|
|
4335 \catcode`\{=1 |
|
|
4336 \catcode`\}=2 |
|
|
4337 \catcode`\%=\other |
|
|
4338 \catcode`\'=0 |
|
|
4339 \catcode`\\=\other |
|
|
4340 % |
|
|
4341 \openin 1 \jobname.aux |
|
|
4342 \ifeof 1 \else |
|
|
4343 \closein 1 |
|
|
4344 \input \jobname.aux |
|
|
4345 \global\havexrefstrue |
|
|
4346 \global\warnedobstrue |
|
|
4347 \fi |
|
|
4348 % Open the new aux file. TeX will close it automatically at exit. |
|
2333
|
4349 \openout\auxfile=\jobname.aux |
|
|
4350 \endgroup} |
|
|
4351 |
|
|
4352 |
|
|
4353 % Footnotes. |
|
|
4354 |
|
|
4355 \newcount \footnoteno |
|
|
4356 |
|
|
4357 % The trailing space in the following definition for supereject is |
|
|
4358 % vital for proper filling; pages come out unaligned when you do a |
|
2483
|
4359 % pagealignmacro call if that space before the closing brace is |
|
|
4360 % removed. (Generally, numeric constants should always be followed by a |
|
2333
|
4361 % space to prevent strange expansion errors.) |
|
|
4362 \def\supereject{\par\penalty -20000\footnoteno =0 } |
|
|
4363 |
|
|
4364 % @footnotestyle is meaningful for info output only.. |
|
|
4365 \let\footnotestyle=\comment |
|
|
4366 |
|
|
4367 \let\ptexfootnote=\footnote |
|
|
4368 |
|
|
4369 {\catcode `\@=11 |
|
|
4370 % |
|
|
4371 % Auto-number footnotes. Otherwise like plain. |
|
|
4372 \gdef\footnote{% |
|
|
4373 \global\advance\footnoteno by \@ne |
|
|
4374 \edef\thisfootno{$^{\the\footnoteno}$}% |
|
|
4375 % |
|
|
4376 % In case the footnote comes at the end of a sentence, preserve the |
|
|
4377 % extra spacing after we do the footnote number. |
|
|
4378 \let\@sf\empty |
|
|
4379 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi |
|
|
4380 % |
|
|
4381 % Remove inadvertent blank space before typesetting the footnote number. |
|
|
4382 \unskip |
|
|
4383 \thisfootno\@sf |
|
|
4384 \footnotezzz |
|
|
4385 }% |
|
|
4386 |
|
|
4387 % Don't bother with the trickery in plain.tex to not require the |
|
|
4388 % footnote text as a parameter. Our footnotes don't need to be so general. |
|
2670
|
4389 % |
|
|
4390 % Oh yes, they do; otherwise, @ifset and anything else that uses |
|
|
4391 % \parseargline fail inside footnotes because the tokens are fixed when |
|
|
4392 % the footnote is read. --karl, 16nov96. |
|
|
4393 % |
|
2333
|
4394 \long\gdef\footnotezzz{\insert\footins\bgroup |
|
|
4395 % We want to typeset this text as a normal paragraph, even if the |
|
|
4396 % footnote reference occurs in (for example) a display environment. |
|
|
4397 % So reset some parameters. |
|
|
4398 \interlinepenalty\interfootnotelinepenalty |
|
|
4399 \splittopskip\ht\strutbox % top baseline for broken footnotes |
|
|
4400 \splitmaxdepth\dp\strutbox |
|
|
4401 \floatingpenalty\@MM |
|
|
4402 \leftskip\z@skip |
|
|
4403 \rightskip\z@skip |
|
|
4404 \spaceskip\z@skip |
|
|
4405 \xspaceskip\z@skip |
|
|
4406 \parindent\defaultparindent |
|
|
4407 % |
|
|
4408 % Hang the footnote text off the number. |
|
|
4409 \hang |
|
|
4410 \textindent{\thisfootno}% |
|
|
4411 % |
|
|
4412 % Don't crash into the line above the footnote text. Since this |
|
|
4413 % expands into a box, it must come within the paragraph, lest it |
|
|
4414 % provide a place where TeX can split the footnote. |
|
2670
|
4415 \footstrut |
|
2333
|
4416 \futurelet\next\fo@t |
|
2670
|
4417 } |
|
|
4418 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t |
|
|
4419 \else\let\next\f@t\fi \next} |
|
|
4420 \def\f@@t{\bgroup\aftergroup\@foot\let\next} |
|
|
4421 \def\f@t#1{#1\@foot} |
|
2333
|
4422 \def\@foot{\strut\egroup} |
|
|
4423 |
|
|
4424 }%end \catcode `\@=11 |
|
|
4425 |
|
|
4426 % Set the baselineskip to #1, and the lineskip and strut size |
|
|
4427 % correspondingly. There is no deep meaning behind these magic numbers |
|
|
4428 % used as factors; they just match (closely enough) what Knuth defined. |
|
|
4429 % |
|
|
4430 \def\lineskipfactor{.08333} |
|
|
4431 \def\strutheightpercent{.70833} |
|
|
4432 \def\strutdepthpercent {.29167} |
|
|
4433 % |
|
|
4434 \def\setleading#1{% |
|
|
4435 \normalbaselineskip = #1\relax |
|
|
4436 \normallineskip = \lineskipfactor\normalbaselineskip |
|
|
4437 \normalbaselines |
|
|
4438 \setbox\strutbox =\hbox{% |
|
|
4439 \vrule width0pt height\strutheightpercent\baselineskip |
|
|
4440 depth \strutdepthpercent \baselineskip |
|
|
4441 }% |
|
|
4442 } |
|
|
4443 |
|
|
4444 % @| inserts a changebar to the left of the current line. It should |
|
|
4445 % surround any changed text. This approach does *not* work if the |
|
|
4446 % change spans more than two lines of output. To handle that, we would |
|
|
4447 % have adopt a much more difficult approach (putting marks into the main |
|
|
4448 % vertical list for the beginning and end of each change). |
|
|
4449 % |
|
|
4450 \def\|{% |
|
|
4451 % \vadjust can only be used in horizontal mode. |
|
|
4452 \leavevmode |
|
|
4453 % |
|
|
4454 % Append this vertical mode material after the current line in the output. |
|
|
4455 \vadjust{% |
|
|
4456 % We want to insert a rule with the height and depth of the current |
|
|
4457 % leading; that is exactly what \strutbox is supposed to record. |
|
|
4458 \vskip-\baselineskip |
|
|
4459 % |
|
|
4460 % \vadjust-items are inserted at the left edge of the type. So |
|
|
4461 % the \llap here moves out into the left-hand margin. |
|
|
4462 \llap{% |
|
|
4463 % |
|
|
4464 % For a thicker or thinner bar, change the `1pt'. |
|
|
4465 \vrule height\baselineskip width1pt |
|
|
4466 % |
|
|
4467 % This is the space between the bar and the text. |
|
|
4468 \hskip 12pt |
|
|
4469 }% |
|
|
4470 }% |
|
|
4471 } |
|
|
4472 |
|
|
4473 % For a final copy, take out the rectangles |
|
|
4474 % that mark overfull boxes (in case you have decided |
|
|
4475 % that the text looks ok even though it passes the margin). |
|
|
4476 % |
|
|
4477 \def\finalout{\overfullrule=0pt} |
|
|
4478 |
|
|
4479 |
|
|
4480 % End of control word definitions. |
|
|
4481 |
|
|
4482 \message{and turning on texinfo input format.} |
|
|
4483 |
|
|
4484 \def\openindices{% |
|
|
4485 \newindex{cp}% |
|
|
4486 \newcodeindex{fn}% |
|
|
4487 \newcodeindex{vr}% |
|
|
4488 \newcodeindex{tp}% |
|
|
4489 \newcodeindex{ky}% |
|
|
4490 \newcodeindex{pg}% |
|
|
4491 } |
|
|
4492 |
|
|
4493 % Set some numeric style parameters, for 8.5 x 11 format. |
|
2483
|
4494 |
|
|
4495 \hsize = 6in |
|
2333
|
4496 \hoffset = .25in |
|
|
4497 \newdimen\defaultparindent \defaultparindent = 15pt |
|
2483
|
4498 \parindent = \defaultparindent |
|
|
4499 \parskip 3pt plus 2pt minus 1pt |
|
2333
|
4500 \setleading{13.2pt} |
|
|
4501 \advance\topskip by 1.2cm |
|
2483
|
4502 |
|
|
4503 \chapheadingskip = 15pt plus 4pt minus 2pt |
|
|
4504 \secheadingskip = 12pt plus 3pt minus 2pt |
|
|
4505 \subsecheadingskip = 9pt plus 2pt minus 2pt |
|
2333
|
4506 |
|
|
4507 % Prevent underfull vbox error messages. |
|
|
4508 \vbadness=10000 |
|
|
4509 |
|
|
4510 % Following George Bush, just get rid of widows and orphans. |
|
|
4511 \widowpenalty=10000 |
|
|
4512 \clubpenalty=10000 |
|
|
4513 |
|
|
4514 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're |
|
|
4515 % using an old version of TeX, don't do anything. We want the amount of |
|
|
4516 % stretch added to depend on the line length, hence the dependence on |
|
|
4517 % \hsize. This makes it come to about 9pt for the 8.5x11 format. |
|
|
4518 % |
|
|
4519 \ifx\emergencystretch\thisisundefined |
|
|
4520 % Allow us to assign to \emergencystretch anyway. |
|
|
4521 \def\emergencystretch{\dimen0}% |
|
|
4522 \else |
|
|
4523 \emergencystretch = \hsize |
|
|
4524 \divide\emergencystretch by 45 |
|
|
4525 \fi |
|
|
4526 |
|
|
4527 % Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25) |
|
2483
|
4528 \def\smallbook{ |
|
|
4529 \global\chapheadingskip = 15pt plus 4pt minus 2pt |
|
|
4530 \global\secheadingskip = 12pt plus 3pt minus 2pt |
|
|
4531 \global\subsecheadingskip = 9pt plus 2pt minus 2pt |
|
|
4532 % |
|
|
4533 \global\lispnarrowing = 0.3in |
|
|
4534 \setleading{12pt} |
|
|
4535 \advance\topskip by -1cm |
|
|
4536 \global\parskip 2pt plus 1pt |
|
|
4537 \global\hsize = 5in |
|
|
4538 \global\vsize=7.5in |
|
|
4539 \global\tolerance=700 |
|
|
4540 \global\hfuzz=1pt |
|
|
4541 \global\contentsrightmargin=0pt |
|
|
4542 \global\deftypemargin=0pt |
|
|
4543 \global\defbodyindent=.5cm |
|
|
4544 % |
|
|
4545 \global\pagewidth=\hsize |
|
|
4546 \global\pageheight=\vsize |
|
|
4547 % |
|
|
4548 \global\let\smalllisp=\smalllispx |
|
|
4549 \global\let\smallexample=\smalllispx |
|
2333
|
4550 \global\def\Esmallexample{\Esmalllisp} |
|
|
4551 } |
|
|
4552 |
|
|
4553 % Use @afourpaper to print on European A4 paper. |
|
|
4554 \def\afourpaper{ |
|
|
4555 \global\tolerance=700 |
|
|
4556 \global\hfuzz=1pt |
|
|
4557 \setleading{12pt} |
|
|
4558 \global\parskip 15pt plus 1pt |
|
|
4559 |
|
|
4560 \global\vsize= 53\baselineskip |
|
|
4561 \advance\vsize by \topskip |
|
|
4562 %\global\hsize= 5.85in % A4 wide 10pt |
|
|
4563 \global\hsize= 6.5in |
|
|
4564 \global\outerhsize=\hsize |
|
|
4565 \global\advance\outerhsize by 0.5in |
|
|
4566 \global\outervsize=\vsize |
|
|
4567 \global\advance\outervsize by 0.6in |
|
|
4568 |
|
|
4569 \global\pagewidth=\hsize |
|
|
4570 \global\pageheight=\vsize |
|
|
4571 } |
|
2483
|
4572 |
|
|
4573 \bindingoffset=0pt |
|
|
4574 \normaloffset=\hoffset |
|
|
4575 \pagewidth=\hsize |
|
|
4576 \pageheight=\vsize |
|
2333
|
4577 |
|
2483
|
4578 % Allow control of the text dimensions. Parameters in order: textheight; |
|
|
4579 % textwidth; voffset; hoffset; binding offset; topskip. |
|
2333
|
4580 % All require a dimension; |
|
|
4581 % header is additional; added length extends the bottom of the page. |
|
2483
|
4582 |
|
2333
|
4583 \def\changepagesizes#1#2#3#4#5#6{ |
|
2483
|
4584 \global\vsize= #1 |
|
2333
|
4585 \global\topskip= #6 |
|
|
4586 \advance\vsize by \topskip |
|
|
4587 \global\voffset= #3 |
|
|
4588 \global\hsize= #2 |
|
|
4589 \global\outerhsize=\hsize |
|
|
4590 \global\advance\outerhsize by 0.5in |
|
|
4591 \global\outervsize=\vsize |
|
|
4592 \global\advance\outervsize by 0.6in |
|
|
4593 \global\pagewidth=\hsize |
|
|
4594 \global\pageheight=\vsize |
|
|
4595 \global\normaloffset= #4 |
|
|
4596 \global\bindingoffset= #5} |
|
2483
|
4597 |
|
|
4598 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin |
|
|
4599 % 29mm, hence bottom margin 28mm, nominal side margin 3cm. |
|
|
4600 \def\afourlatex |
|
|
4601 {\global\tolerance=700 |
|
|
4602 \global\hfuzz=1pt |
|
|
4603 \setleading{12pt} |
|
|
4604 \global\parskip 15pt plus 1pt |
|
|
4605 \advance\baselineskip by 1.6pt |
|
|
4606 \changepagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm} |
|
2333
|
4607 } |
|
|
4608 |
|
|
4609 % Use @afourwide to print on European A4 paper in wide format. |
|
2483
|
4610 \def\afourwide{\afourpaper |
|
2333
|
4611 \changepagesizes{9.5in}{6.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}} |
|
|
4612 |
|
|
4613 % Define macros to output various characters with catcode for normal text. |
|
|
4614 \catcode`\"=\other |
|
|
4615 \catcode`\~=\other |
|
|
4616 \catcode`\^=\other |
|
|
4617 \catcode`\_=\other |
|
|
4618 \catcode`\|=\other |
|
|
4619 \catcode`\<=\other |
|
|
4620 \catcode`\>=\other |
|
|
4621 \catcode`\+=\other |
|
|
4622 \def\normaldoublequote{"} |
|
|
4623 \def\normaltilde{~} |
|
|
4624 \def\normalcaret{^} |
|
|
4625 \def\normalunderscore{_} |
|
|
4626 \def\normalverticalbar{|} |
|
|
4627 \def\normalless{<} |
|
|
4628 \def\normalgreater{>} |
|
|
4629 \def\normalplus{+} |
|
|
4630 |
|
|
4631 % This macro is used to make a character print one way in ttfont |
|
|
4632 % where it can probably just be output, and another way in other fonts, |
|
|
4633 % where something hairier probably needs to be done. |
|
|
4634 % |
|
|
4635 % #1 is what to print if we are indeed using \tt; #2 is what to print |
|
|
4636 % otherwise. Since all the Computer Modern typewriter fonts have zero |
|
|
4637 % interword stretch (and shrink), and it is reasonable to expect all |
|
|
4638 % typewriter fonts to have this, we can check that font parameter. |
|
|
4639 % |
|
|
4640 \def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi} |
|
|
4641 |
|
|
4642 % Turn off all special characters except @ |
|
|
4643 % (and those which the user can use as if they were ordinary). |
|
|
4644 % Most of these we simply print from the \tt font, but for some, we can |
|
|
4645 % use math or other variants that look better in normal text. |
|
|
4646 |
|
|
4647 \catcode`\"=\active |
|
|
4648 \def\activedoublequote{{\tt \char '042}} |
|
|
4649 \let"=\activedoublequote |
|
|
4650 \catcode`\~=\active |
|
|
4651 \def~{{\tt \char '176}} |
|
|
4652 \chardef\hat=`\^ |
|
|
4653 \catcode`\^=\active |
|
|
4654 \def^{{\tt \hat}} |
|
|
4655 |
|
|
4656 \catcode`\_=\active |
|
|
4657 \def_{\ifusingtt\normalunderscore\_} |
|
2483
|
4658 % Subroutine for the previous macro. |
|
2333
|
4659 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}} |
|
|
4660 |
|
|
4661 \catcode`\|=\active |
|
|
4662 \def|{{\tt \char '174}} |
|
|
4663 \chardef \less=`\< |
|
|
4664 \catcode`\<=\active |
|
|
4665 \def<{{\tt \less}} |
|
|
4666 \chardef \gtr=`\> |
|
|
4667 \catcode`\>=\active |
|
|
4668 \def>{{\tt \gtr}} |
|
|
4669 \catcode`\+=\active |
|
|
4670 \def+{{\tt \char 43}} |
|
|
4671 %\catcode 27=\active |
|
|
4672 %\def^^[{$\diamondsuit$} |
|
|
4673 |
|
|
4674 % Set up an active definition for =, but don't enable it most of the time. |
|
|
4675 {\catcode`\==\active |
|
|
4676 \global\def={{\tt \char 61}}} |
|
2483
|
4677 |
|
|
4678 \catcode`+=\active |
|
|
4679 \catcode`\_=\active |
|
2333
|
4680 |
|
|
4681 % If a .fmt file is being used, characters that might appear in a file |
|
|
4682 % name cannot be active until we have parsed the command line. |
|
|
4683 % So turn them off again, and have \everyjob (or @setfilename) turn them on. |
|
|
4684 % \otherifyactive is called near the end of this file. |
|
|
4685 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other} |
|
|
4686 |
|
|
4687 \catcode`\@=0 |
|
|
4688 |
|
|
4689 % \rawbackslashxx output one backslash character in current font |
|
|
4690 \global\chardef\rawbackslashxx=`\\ |
|
|
4691 %{\catcode`\\=\other |
|
|
4692 %@gdef@rawbackslashxx{\}} |
|
|
4693 |
|
|
4694 % \rawbackslash redefines \ as input to do \rawbackslashxx. |
|
|
4695 {\catcode`\\=\active |
|
|
4696 @gdef@rawbackslash{@let\=@rawbackslashxx }} |
|
|
4697 |
|
|
4698 % \normalbackslash outputs one backslash in fixed width font. |
|
|
4699 \def\normalbackslash{{\tt\rawbackslashxx}} |
|
|
4700 |
|
|
4701 % Say @foo, not \foo, in error messages. |
|
|
4702 \escapechar=`\@ |
|
|
4703 |
|
|
4704 % \catcode 17=0 % Define control-q |
|
|
4705 \catcode`\\=\active |
|
|
4706 |
|
|
4707 % Used sometimes to turn off (effectively) the active characters |
|
|
4708 % even after parsing them. |
|
|
4709 @def@turnoffactive{@let"=@normaldoublequote |
|
|
4710 @let\=@realbackslash |
|
|
4711 @let~=@normaltilde |
|
|
4712 @let^=@normalcaret |
|
|
4713 @let_=@normalunderscore |
|
|
4714 @let|=@normalverticalbar |
|
|
4715 @let<=@normalless |
|
|
4716 @let>=@normalgreater |
|
|
4717 @let+=@normalplus} |
|
|
4718 |
|
|
4719 @def@normalturnoffactive{@let"=@normaldoublequote |
|
|
4720 @let\=@normalbackslash |
|
|
4721 @let~=@normaltilde |
|
|
4722 @let^=@normalcaret |
|
|
4723 @let_=@normalunderscore |
|
|
4724 @let|=@normalverticalbar |
|
|
4725 @let<=@normalless |
|
|
4726 @let>=@normalgreater |
|
|
4727 @let+=@normalplus} |
|
|
4728 |
|
|
4729 % Make _ and + \other characters, temporarily. |
|
|
4730 % This is canceled by @fixbackslash. |
|
|
4731 @otherifyactive |
|
|
4732 |
|
|
4733 % If a .fmt file is being used, we don't want the `\input texinfo' to show up. |
|
|
4734 % That is what \eatinput is for; after that, the `\' should revert to printing |
|
|
4735 % a backslash. |
|
|
4736 % |
|
|
4737 @gdef@eatinput input texinfo{@fixbackslash} |
|
|
4738 @global@let\ = @eatinput |
|
|
4739 |
|
|
4740 % On the other hand, perhaps the file did not have a `\input texinfo'. Then |
|
|
4741 % the first `\{ in the file would cause an error. This macro tries to fix |
|
|
4742 % that, assuming it is called before the first `\' could plausibly occur. |
|
|
4743 % Also back turn on active characters that might appear in the input |
|
|
4744 % file name, in case not using a pre-dumped format. |
|
|
4745 % |
|
|
4746 @gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi |
|
|
4747 @catcode`+=@active @catcode`@_=@active} |
|
|
4748 |
|
|
4749 %% These look ok in all fonts, so just make them not special. The @rm below |
|
|
4750 %% makes sure that the current font starts out as the newly loaded cmr10 |
|
|
4751 @catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other |
|
|
4752 |
|
|
4753 @textfonts |
|
|
4754 @rm |
|
|
4755 |
|
|
4756 @c Local variables: |
|
|
4757 @c page-delimiter: "^\\\\message" |
