« back to all changes in this revision
Viewing changes to doc/texinfo.tex
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Julien Louis
- Date: 2006-09-25 01:22:08 UTC
- Revision ID: james.westby@ubuntu.com-20060925012208-fy8x31diroe47syg
Tags: upstream-1.0.3
Import upstream version 1.0.3
- files added:
- doc
- gnulib
- gnulib/m4
- po
- src
added
removed
doc/texinfo.tex
1
% texinfo.tex -- TeX macros to handle Texinfo files.
2
%
3
% Load plain if necessary, i.e., if running under initex.
4
\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5
%
6
\def\texinfoversion{2006-07-17.16}
7
%
8
% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9
% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free
10
% Software Foundation, Inc.
11
%
12
% This texinfo.tex file is free software; you can redistribute it and/or
13
% modify it under the terms of the GNU General Public License as
14
% published by the Free Software Foundation; either version 2, or (at
15
% your option) any later version.
16
%
17
% This texinfo.tex file is distributed in the hope that it will be
18
% useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19
% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20
% General Public License for more details.
21
%
22
% You should have received a copy of the GNU General Public License
23
% along with this texinfo.tex file; see the file COPYING. If not, write
24
% to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25
% Boston, MA 02110-1301, USA.
26
%
27
% As a special exception, when this file is read by TeX when processing
28
% a Texinfo source document, you may use the result without
29
% restriction. (This has been our intent since Texinfo was invented.)
30
%
31
% Please try the latest version of texinfo.tex before submitting bug
32
% reports; you can get the latest version from:
33
% http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34
% ftp://tug.org/tex/texinfo.tex
35
% (and all CTAN mirrors, see http://www.ctan.org).
36
% The texinfo.tex in any given distribution could well be out
37
% of date, so if that's what you're using, please check.
38
%
39
% Send bug reports to bug-texinfo@gnu.org. Please include including a
40
% complete document in each bug report with which we can reproduce the
41
% problem. Patches are, of course, greatly appreciated.
42
%
43
% To process a Texinfo manual with TeX, it's most reliable to use the
44
% texi2dvi shell script that comes with the distribution. For a simple
45
% manual foo.texi, however, you can get away with this:
46
% tex foo.texi
47
% texindex foo.??
48
% tex foo.texi
49
% tex foo.texi
50
% dvips foo.dvi -o # or whatever; this makes foo.ps.
51
% The extra TeX runs get the cross-reference information correct.
52
% Sometimes one run after texindex suffices, and sometimes you need more
53
% than two; texi2dvi does it as many times as necessary.
54
%
55
% It is possible to adapt texinfo.tex for other languages, to some
56
% extent. You can get the existing language-specific files from the
57
% full Texinfo distribution.
58
%
59
% The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60
61
62
\message{Loading texinfo [version \texinfoversion]:}
63
64
% If in a .fmt file, print the version number
65
% and turn on active characters that we couldn't do earlier because
66
% they might have appeared in the input file name.
67
\everyjob{\message{[Texinfo version \texinfoversion]}%
68
\catcode`+=\active \catcode`\_=\active}
69
70
\message{Basics,}
71
\chardef\other=12
72
73
% We never want plain's \outer definition of \+ in Texinfo.
74
% For @tex, we can use \tabalign.
75
\let\+ = \relax
76
77
% Save some plain tex macros whose names we will redefine.
78
\let\ptexb=\b
79
\let\ptexbullet=\bullet
80
\let\ptexc=\c
81
\let\ptexcomma=\,
82
\let\ptexdot=\.
83
\let\ptexdots=\dots
84
\let\ptexend=\end
85
\let\ptexequiv=\equiv
86
\let\ptexexclam=\!
87
\let\ptexfootnote=\footnote
88
\let\ptexgtr=>
89
\let\ptexhat=^
90
\let\ptexi=\i
91
\let\ptexindent=\indent
92
\let\ptexinsert=\insert
93
\let\ptexlbrace=\{
94
\let\ptexless=<
95
\let\ptexnewwrite\newwrite
96
\let\ptexnoindent=\noindent
97
\let\ptexplus=+
98
\let\ptexrbrace=\}
99
\let\ptexslash=\/
100
\let\ptexstar=\*
101
\let\ptext=\t
102
103
% If this character appears in an error message or help string, it
104
% starts a new line in the output.
105
\newlinechar = `^^J
106
107
% Use TeX 3.0's \inputlineno to get the line number, for better error
108
% messages, but if we're using an old version of TeX, don't do anything.
109
%
110
\ifx\inputlineno\thisisundefined
111
\let\linenumber = \empty % Pre-3.0.
112
\else
113
\def\linenumber{l.\the\inputlineno:\space}
114
\fi
115
116
% Set up fixed words for English if not already set.
117
\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118
\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119
\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120
\ifx\putwordin\undefined \gdef\putwordin{in}\fi
121
\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122
\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123
\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124
\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125
\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126
\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127
\ifx\putwordof\undefined \gdef\putwordof{of}\fi
128
\ifx\putwordon\undefined \gdef\putwordon{on}\fi
129
\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130
\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131
\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132
\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133
\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134
\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135
\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
136
%
137
\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138
\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139
\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140
\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141
\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142
\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143
\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144
\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145
\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146
\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147
\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148
\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149
%
150
\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151
\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152
\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153
\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154
\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
155
156
% Since the category of space is not known, we have to be careful.
157
\chardef\spacecat = 10
158
\def\spaceisspace{\catcode`\ =\spacecat}
159
160
% Ignore a token.
161
%
162
\def\gobble#1{}
163
164
% The following is used inside several \edef's.
165
\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
166
167
% Hyphenation fixes.
168
\hyphenation{
169
Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
170
ap-pen-dix bit-map bit-maps
171
data-base data-bases eshell fall-ing half-way long-est man-u-script
172
man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
173
par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
174
spell-ing spell-ings
175
stand-alone strong-est time-stamp time-stamps which-ever white-space
176
wide-spread wrap-around
177
}
178
179
% Margin to add to right of even pages, to left of odd pages.
180
\newdimen\bindingoffset
181
\newdimen\normaloffset
182
\newdimen\pagewidth \newdimen\pageheight
183
184
% For a final copy, take out the rectangles
185
% that mark overfull boxes (in case you have decided
186
% that the text looks ok even though it passes the margin).
187
%
188
\def\finalout{\overfullrule=0pt}
189
190
% @| inserts a changebar to the left of the current line. It should
191
% surround any changed text. This approach does *not* work if the
192
% change spans more than two lines of output. To handle that, we would
193
% have adopt a much more difficult approach (putting marks into the main
194
% vertical list for the beginning and end of each change).
195
%
196
\def\|{%
197
% \vadjust can only be used in horizontal mode.
198
\leavevmode
199
%
200
% Append this vertical mode material after the current line in the output.
201
\vadjust{%
202
% We want to insert a rule with the height and depth of the current
203
% leading; that is exactly what \strutbox is supposed to record.
204
\vskip-\baselineskip
205
%
206
% \vadjust-items are inserted at the left edge of the type. So
207
% the \llap here moves out into the left-hand margin.
208
\llap{%
209
%
210
% For a thicker or thinner bar, change the `1pt'.
211
\vrule height\baselineskip width1pt
212
%
213
% This is the space between the bar and the text.
214
\hskip 12pt
215
}%
216
}%
217
}
218
219
% Sometimes it is convenient to have everything in the transcript file
220
% and nothing on the terminal. We don't just call \tracingall here,
221
% since that produces some useless output on the terminal. We also make
222
% some effort to order the tracing commands to reduce output in the log
223
% file; cf. trace.sty in LaTeX.
224
%
225
\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
226
\def\loggingall{%
227
\tracingstats2
228
\tracingpages1
229
\tracinglostchars2 % 2 gives us more in etex
230
\tracingparagraphs1
231
\tracingoutput1
232
\tracingmacros2
233
\tracingrestores1
234
\showboxbreadth\maxdimen \showboxdepth\maxdimen
235
\ifx\eTeXversion\undefined\else % etex gives us more logging
236
\tracingscantokens1
237
\tracingifs1
238
\tracinggroups1
239
\tracingnesting2
240
\tracingassigns1
241
\fi
242
\tracingcommands3 % 3 gives us more in etex
243
\errorcontextlines16
244
}%
245
246
% add check for \lastpenalty to plain's definitions. If the last thing
247
% we did was a \nobreak, we don't want to insert more space.
248
%
249
\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
250
\removelastskip\penalty-50\smallskip\fi\fi}
251
\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
252
\removelastskip\penalty-100\medskip\fi\fi}
253
\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
254
\removelastskip\penalty-200\bigskip\fi\fi}
255
256
% For @cropmarks command.
257
% Do @cropmarks to get crop marks.
258
%
259
\newif\ifcropmarks
260
\let\cropmarks = \cropmarkstrue
261
%
262
% Dimensions to add cropmarks at corners.
263
% Added by P. A. MacKay, 12 Nov. 1986
264
%
265
\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
266
\newdimen\cornerlong \cornerlong=1pc
267
\newdimen\cornerthick \cornerthick=.3pt
268
\newdimen\topandbottommargin \topandbottommargin=.75in
269
270
% Main output routine.
271
\chardef\PAGE = 255
272
\output = {\onepageout{\pagecontents\PAGE}}
273
274
\newbox\headlinebox
275
\newbox\footlinebox
276
277
% \onepageout takes a vbox as an argument. Note that \pagecontents
278
% does insertions, but you have to call it yourself.
279
\def\onepageout#1{%
280
\ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
281
%
282
\ifodd\pageno \advance\hoffset by \bindingoffset
283
\else \advance\hoffset by -\bindingoffset\fi
284
%
285
% Do this outside of the \shipout so @code etc. will be expanded in
286
% the headline as they should be, not taken literally (outputting ''code).
287
\setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
288
\setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
289
%
290
{%
291
% Have to do this stuff outside the \shipout because we want it to
292
% take effect in \write's, yet the group defined by the \vbox ends
293
% before the \shipout runs.
294
%
295
\indexdummies % don't expand commands in the output.
296
\normalturnoffactive % \ in index entries must not stay \, e.g., if
297
% the page break happens to be in the middle of an example.
298
% We don't want .vr (or whatever) entries like this:
299
% \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
300
% "\acronym" won't work when it's read back in;
301
% it needs to be
302
% {\code {{\tt \backslashcurfont }acronym}
303
\shipout\vbox{%
304
% Do this early so pdf references go to the beginning of the page.
305
\ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
306
%
307
\ifcropmarks \vbox to \outervsize\bgroup
308
\hsize = \outerhsize
309
\vskip-\topandbottommargin
310
\vtop to0pt{%
311
\line{\ewtop\hfil\ewtop}%
312
\nointerlineskip
313
\line{%
314
\vbox{\moveleft\cornerthick\nstop}%
315
\hfill
316
\vbox{\moveright\cornerthick\nstop}%
317
}%
318
\vss}%
319
\vskip\topandbottommargin
320
\line\bgroup
321
\hfil % center the page within the outer (page) hsize.
322
\ifodd\pageno\hskip\bindingoffset\fi
323
\vbox\bgroup
324
\fi
325
%
326
\unvbox\headlinebox
327
\pagebody{#1}%
328
\ifdim\ht\footlinebox > 0pt
329
% Only leave this space if the footline is nonempty.
330
% (We lessened \vsize for it in \oddfootingyyy.)
331
% The \baselineskip=24pt in plain's \makefootline has no effect.
332
\vskip 24pt
333
\unvbox\footlinebox
334
\fi
335
%
336
\ifcropmarks
337
\egroup % end of \vbox\bgroup
338
\hfil\egroup % end of (centering) \line\bgroup
339
\vskip\topandbottommargin plus1fill minus1fill
340
\boxmaxdepth = \cornerthick
341
\vbox to0pt{\vss
342
\line{%
343
\vbox{\moveleft\cornerthick\nsbot}%
344
\hfill
345
\vbox{\moveright\cornerthick\nsbot}%
346
}%
347
\nointerlineskip
348
\line{\ewbot\hfil\ewbot}%
349
}%
350
\egroup % \vbox from first cropmarks clause
351
\fi
352
}% end of \shipout\vbox
353
}% end of group with \indexdummies
354
\advancepageno
355
\ifnum\outputpenalty>-20000 \else\dosupereject\fi
356
}
357
358
\newinsert\margin \dimen\margin=\maxdimen
359
360
\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
361
{\catcode`\@ =11
362
\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
363
% marginal hacks, juha@viisa.uucp (Juha Takala)
364
\ifvoid\margin\else % marginal info is present
365
\rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
366
\dimen@=\dp#1 \unvbox#1
367
\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
368
\ifr@ggedbottom \kern-\dimen@ \vfil \fi}
369
}
370
371
% Here are the rules for the cropmarks. Note that they are
372
% offset so that the space between them is truly \outerhsize or \outervsize
373
% (P. A. MacKay, 12 November, 1986)
374
%
375
\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
376
\def\nstop{\vbox
377
{\hrule height\cornerthick depth\cornerlong width\cornerthick}}
378
\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
379
\def\nsbot{\vbox
380
{\hrule height\cornerlong depth\cornerthick width\cornerthick}}
381
382
% Parse an argument, then pass it to #1. The argument is the rest of
383
% the input line (except we remove a trailing comment). #1 should be a
384
% macro which expects an ordinary undelimited TeX argument.
385
%
386
\def\parsearg{\parseargusing{}}
387
\def\parseargusing#1#2{%
388
\def\argtorun{#2}%
389
\begingroup
390
\obeylines
391
\spaceisspace
392
#1%
393
\parseargline\empty% Insert the \empty token, see \finishparsearg below.
394
}
395
396
{\obeylines %
397
\gdef\parseargline#1^^M{%
398
\endgroup % End of the group started in \parsearg.
399
\argremovecomment #1\comment\ArgTerm%
400
}%
401
}
402
403
% First remove any @comment, then any @c comment.
404
\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
405
\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
406
407
% Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
408
%
409
% \argremovec might leave us with trailing space, e.g.,
410
% @end itemize @c foo
411
% This space token undergoes the same procedure and is eventually removed
412
% by \finishparsearg.
413
%
414
\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
415
\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
416
\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
417
\def\temp{#3}%
418
\ifx\temp\empty
419
% Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
420
\let\temp\finishparsearg
421
\else
422
\let\temp\argcheckspaces
423
\fi
424
% Put the space token in:
425
\temp#1 #3\ArgTerm
426
}
427
428
% If a _delimited_ argument is enclosed in braces, they get stripped; so
429
% to get _exactly_ the rest of the line, we had to prevent such situation.
430
% We prepended an \empty token at the very beginning and we expand it now,
431
% just before passing the control to \argtorun.
432
% (Similarily, we have to think about #3 of \argcheckspacesY above: it is
433
% either the null string, or it ends with \^^M---thus there is no danger
434
% that a pair of braces would be stripped.
435
%
436
% But first, we have to remove the trailing space token.
437
%
438
\def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
439
440
% \parseargdef\foo{...}
441
% is roughly equivalent to
442
% \def\foo{\parsearg\Xfoo}
443
% \def\Xfoo#1{...}
444
%
445
% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
446
% favourite TeX trick. --kasal, 16nov03
447
448
\def\parseargdef#1{%
449
\expandafter \doparseargdef \csname\string#1\endcsname #1%
450
}
451
\def\doparseargdef#1#2{%
452
\def#2{\parsearg#1}%
453
\def#1##1%
454
}
455
456
% Several utility definitions with active space:
457
{
458
\obeyspaces
459
\gdef\obeyedspace{ }
460
461
% Make each space character in the input produce a normal interword
462
% space in the output. Don't allow a line break at this space, as this
463
% is used only in environments like @example, where each line of input
464
% should produce a line of output anyway.
465
%
466
\gdef\sepspaces{\obeyspaces\let =\tie}
467
468
% If an index command is used in an @example environment, any spaces
469
% therein should become regular spaces in the raw index file, not the
470
% expansion of \tie (\leavevmode \penalty \@M \ ).
471
\gdef\unsepspaces{\let =\space}
472
}
473
474
475
\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
476
477
% Define the framework for environments in texinfo.tex. It's used like this:
478
%
479
% \envdef\foo{...}
480
% \def\Efoo{...}
481
%
482
% It's the responsibility of \envdef to insert \begingroup before the
483
% actual body; @end closes the group after calling \Efoo. \envdef also
484
% defines \thisenv, so the current environment is known; @end checks
485
% whether the environment name matches. The \checkenv macro can also be
486
% used to check whether the current environment is the one expected.
487
%
488
% Non-false conditionals (@iftex, @ifset) don't fit into this, so they
489
% are not treated as enviroments; they don't open a group. (The
490
% implementation of @end takes care not to call \endgroup in this
491
% special case.)
492
493
494
% At runtime, environments start with this:
495
\def\startenvironment#1{\begingroup\def\thisenv{#1}}
496
% initialize
497
\let\thisenv\empty
498
499
% ... but they get defined via ``\envdef\foo{...}'':
500
\long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
501
\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
502
503
% Check whether we're in the right environment:
504
\def\checkenv#1{%
505
\def\temp{#1}%
506
\ifx\thisenv\temp
507
\else
508
\badenverr
509
\fi
510
}
511
512
% Evironment mismatch, #1 expected:
513
\def\badenverr{%
514
\errhelp = \EMsimple
515
\errmessage{This command can appear only \inenvironment\temp,
516
not \inenvironment\thisenv}%
517
}
518
\def\inenvironment#1{%
519
\ifx#1\empty
520
out of any environment%
521
\else
522
in environment \expandafter\string#1%
523
\fi
524
}
525
526
% @end foo executes the definition of \Efoo.
527
% But first, it executes a specialized version of \checkenv
528
%
529
\parseargdef\end{%
530
\if 1\csname iscond.#1\endcsname
531
\else
532
% The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
533
\expandafter\checkenv\csname#1\endcsname
534
\csname E#1\endcsname
535
\endgroup
536
\fi
537
}
538
539
\newhelp\EMsimple{Press RETURN to continue.}
540
541
542
%% Simple single-character @ commands
543
544
% @@ prints an @
545
% Kludge this until the fonts are right (grr).
546
\def\@{{\tt\char64}}
547
548
% This is turned off because it was never documented
549
% and you can use @w{...} around a quote to suppress ligatures.
550
%% Define @` and @' to be the same as ` and '
551
%% but suppressing ligatures.
552
%\def\`{{`}}
553
%\def\'{{'}}
554
555
% Used to generate quoted braces.
556
\def\mylbrace {{\tt\char123}}
557
\def\myrbrace {{\tt\char125}}
558
\let\{=\mylbrace
559
\let\}=\myrbrace
560
\begingroup
561
% Definitions to produce \{ and \} commands for indices,
562
% and @{ and @} for the aux/toc files.
563
\catcode`\{ = \other \catcode`\} = \other
564
\catcode`\[ = 1 \catcode`\] = 2
565
\catcode`\! = 0 \catcode`\\ = \other
566
!gdef!lbracecmd[\{]%
567
!gdef!rbracecmd[\}]%
568
!gdef!lbraceatcmd[@{]%
569
!gdef!rbraceatcmd[@}]%
570
!endgroup
571
572
% @comma{} to avoid , parsing problems.
573
\let\comma = ,
574
575
% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
576
% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
577
\let\, = \c
578
\let\dotaccent = \.
579
\def\ringaccent#1{{\accent23 #1}}
580
\let\tieaccent = \t
581
\let\ubaraccent = \b
582
\let\udotaccent = \d
583
584
% Other special characters: @questiondown @exclamdown @ordf @ordm
585
% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
586
\def\questiondown{?`}
587
\def\exclamdown{!`}
588
\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
589
\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
590
591
% Dotless i and dotless j, used for accents.
592
\def\imacro{i}
593
\def\jmacro{j}
594
\def\dotless#1{%
595
\def\temp{#1}%
596
\ifx\temp\imacro \ptexi
597
\else\ifx\temp\jmacro \j
598
\else \errmessage{@dotless can be used only with i or j}%
599
\fi\fi
600
}
601
602
% The \TeX{} logo, as in plain, but resetting the spacing so that a
603
% period following counts as ending a sentence. (Idea found in latex.)
604
%
605
\edef\TeX{\TeX \spacefactor=1000 }
606
607
% @LaTeX{} logo. Not quite the same results as the definition in
608
% latex.ltx, since we use a different font for the raised A; it's most
609
% convenient for us to use an explicitly smaller font, rather than using
610
% the \scriptstyle font (since we don't reset \scriptstyle and
611
% \scriptscriptstyle).
612
%
613
\def\LaTeX{%
614
L\kern-.36em
615
{\setbox0=\hbox{T}%
616
\vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
617
\kern-.15em
618
\TeX
619
}
620
621
% Be sure we're in horizontal mode when doing a tie, since we make space
622
% equivalent to this in @example-like environments. Otherwise, a space
623
% at the beginning of a line will start with \penalty -- and
624
% since \penalty is valid in vertical mode, we'd end up putting the
625
% penalty on the vertical list instead of in the new paragraph.
626
{\catcode`@ = 11
627
% Avoid using \@M directly, because that causes trouble
628
% if the definition is written into an index file.
629
\global\let\tiepenalty = \@M
630
\gdef\tie{\leavevmode\penalty\tiepenalty\ }
631
}
632
633
% @: forces normal size whitespace following.
634
\def\:{\spacefactor=1000 }
635
636
% @* forces a line break.
637
\def\*{\hfil\break\hbox{}\ignorespaces}
638
639
% @/ allows a line break.
640
\let\/=\allowbreak
641
642
% @. is an end-of-sentence period.
643
\def\.{.\spacefactor=\endofsentencespacefactor\space}
644
645
% @! is an end-of-sentence bang.
646
\def\!{!\spacefactor=\endofsentencespacefactor\space}
647
648
% @? is an end-of-sentence query.
649
\def\?{?\spacefactor=\endofsentencespacefactor\space}
650
651
% @frenchspacing on|off says whether to put extra space after punctuation.
652
%
653
\def\onword{on}
654
\def\offword{off}
655
%
656
\parseargdef\frenchspacing{%
657
\def\temp{#1}%
658
\ifx\temp\onword \plainfrenchspacing
659
\else\ifx\temp\offword \plainnonfrenchspacing
660
\else
661
\errhelp = \EMsimple
662
\errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
663
\fi\fi
664
}
665
666
% @w prevents a word break. Without the \leavevmode, @w at the
667
% beginning of a paragraph, when TeX is still in vertical mode, would
668
% produce a whole line of output instead of starting the paragraph.
669
\def\w#1{\leavevmode\hbox{#1}}
670
671
% @group ... @end group forces ... to be all on one page, by enclosing
672
% it in a TeX vbox. We use \vtop instead of \vbox to construct the box
673
% to keep its height that of a normal line. According to the rules for
674
% \topskip (p.114 of the TeXbook), the glue inserted is
675
% max (\topskip - \ht (first item), 0). If that height is large,
676
% therefore, no glue is inserted, and the space between the headline and
677
% the text is small, which looks bad.
678
%
679
% Another complication is that the group might be very large. This can
680
% cause the glue on the previous page to be unduly stretched, because it
681
% does not have much material. In this case, it's better to add an
682
% explicit \vfill so that the extra space is at the bottom. The
683
% threshold for doing this is if the group is more than \vfilllimit
684
% percent of a page (\vfilllimit can be changed inside of @tex).
685
%
686
\newbox\groupbox
687
\def\vfilllimit{0.7}
688
%
689
\envdef\group{%
690
\ifnum\catcode`\^^M=\active \else
691
\errhelp = \groupinvalidhelp
692
\errmessage{@group invalid in context where filling is enabled}%
693
\fi
694
\startsavinginserts
695
%
696
\setbox\groupbox = \vtop\bgroup
697
% Do @comment since we are called inside an environment such as
698
% @example, where each end-of-line in the input causes an
699
% end-of-line in the output. We don't want the end-of-line after
700
% the `@group' to put extra space in the output. Since @group
701
% should appear on a line by itself (according to the Texinfo
702
% manual), we don't worry about eating any user text.
703
\comment
704
}
705
%
706
% The \vtop produces a box with normal height and large depth; thus, TeX puts
707
% \baselineskip glue before it, and (when the next line of text is done)
708
% \lineskip glue after it. Thus, space below is not quite equal to space
709
% above. But it's pretty close.
710
\def\Egroup{%
711
% To get correct interline space between the last line of the group
712
% and the first line afterwards, we have to propagate \prevdepth.
713
\endgraf % Not \par, as it may have been set to \lisppar.
714
\global\dimen1 = \prevdepth
715
\egroup % End the \vtop.
716
% \dimen0 is the vertical size of the group's box.
717
\dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
718
% \dimen2 is how much space is left on the page (more or less).
719
\dimen2 = \pageheight \advance\dimen2 by -\pagetotal
720
% if the group doesn't fit on the current page, and it's a big big
721
% group, force a page break.
722
\ifdim \dimen0 > \dimen2
723
\ifdim \pagetotal < \vfilllimit\pageheight
724
\page
725
\fi
726
\fi
727
\box\groupbox
728
\prevdepth = \dimen1
729
\checkinserts
730
}
731
%
732
% TeX puts in an \escapechar (i.e., `@') at the beginning of the help
733
% message, so this ends up printing `@group can only ...'.
734
%
735
\newhelp\groupinvalidhelp{%
736
group can only be used in environments such as @example,^^J%
737
where each line of input produces a line of output.}
738
739
% @need space-in-mils
740
% forces a page break if there is not space-in-mils remaining.
741
742
\newdimen\mil \mil=0.001in
743
744
% Old definition--didn't work.
745
%\parseargdef\need{\par %
746
%% This method tries to make TeX break the page naturally
747
%% if the depth of the box does not fit.
748
%{\baselineskip=0pt%
749
%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
750
%\prevdepth=-1000pt
751
%}}
752
753
\parseargdef\need{%
754
% Ensure vertical mode, so we don't make a big box in the middle of a
755
% paragraph.
756
\par
757
%
758
% If the @need value is less than one line space, it's useless.
759
\dimen0 = #1\mil
760
\dimen2 = \ht\strutbox
761
\advance\dimen2 by \dp\strutbox
762
\ifdim\dimen0 > \dimen2
763
%
764
% Do a \strut just to make the height of this box be normal, so the
765
% normal leading is inserted relative to the preceding line.
766
% And a page break here is fine.
767
\vtop to #1\mil{\strut\vfil}%
768
%
769
% TeX does not even consider page breaks if a penalty added to the
770
% main vertical list is 10000 or more. But in order to see if the
771
% empty box we just added fits on the page, we must make it consider
772
% page breaks. On the other hand, we don't want to actually break the
773
% page after the empty box. So we use a penalty of 9999.
774
%
775
% There is an extremely small chance that TeX will actually break the
776
% page at this \penalty, if there are no other feasible breakpoints in
777
% sight. (If the user is using lots of big @group commands, which
778
% almost-but-not-quite fill up a page, TeX will have a hard time doing
779
% good page breaking, for example.) However, I could not construct an
780
% example where a page broke at this \penalty; if it happens in a real
781
% document, then we can reconsider our strategy.
782
\penalty9999
783
%
784
% Back up by the size of the box, whether we did a page break or not.
785
\kern -#1\mil
786
%
787
% Do not allow a page break right after this kern.
788
\nobreak
789
\fi
790
}
791
792
% @br forces paragraph break (and is undocumented).
793
794
\let\br = \par
795
796
% @page forces the start of a new page.
797
%
798
\def\page{\par\vfill\supereject}
799
800
% @exdent text....
801
% outputs text on separate line in roman font, starting at standard page margin
802
803
% This records the amount of indent in the innermost environment.
804
% That's how much \exdent should take out.
805
\newskip\exdentamount
806
807
% This defn is used inside fill environments such as @defun.
808
\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
809
810
% This defn is used inside nofill environments such as @example.
811
\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
812
\leftline{\hskip\leftskip{\rm#1}}}}
813
814
% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
815
% paragraph. For more general purposes, use the \margin insertion
816
% class. WHICH is `l' or `r'.
817
%
818
\newskip\inmarginspacing \inmarginspacing=1cm
819
\def\strutdepth{\dp\strutbox}
820
%
821
\def\doinmargin#1#2{\strut\vadjust{%
822
\nobreak
823
\kern-\strutdepth
824
\vtop to \strutdepth{%
825
\baselineskip=\strutdepth
826
\vss
827
% if you have multiple lines of stuff to put here, you'll need to
828
% make the vbox yourself of the appropriate size.
829
\ifx#1l%
830
\llap{\ignorespaces #2\hskip\inmarginspacing}%
831
\else
832
\rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
833
\fi
834
\null
835
}%
836
}}
837
\def\inleftmargin{\doinmargin l}
838
\def\inrightmargin{\doinmargin r}
839
%
840
% @inmargin{TEXT [, RIGHT-TEXT]}
841
% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
842
% else use TEXT for both).
843
%
844
\def\inmargin#1{\parseinmargin #1,,\finish}
845
\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
846
\setbox0 = \hbox{\ignorespaces #2}%
847
\ifdim\wd0 > 0pt
848
\def\lefttext{#1}% have both texts
849
\def\righttext{#2}%
850
\else
851
\def\lefttext{#1}% have only one text
852
\def\righttext{#1}%
853
\fi
854
%
855
\ifodd\pageno
856
\def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
857
\else
858
\def\temp{\inleftmargin\lefttext}%
859
\fi
860
\temp
861
}
862
863
% @include file insert text of that file as input.
864
%
865
\def\include{\parseargusing\filenamecatcodes\includezzz}
866
\def\includezzz#1{%
867
\pushthisfilestack
868
\def\thisfile{#1}%
869
{%
870
\makevalueexpandable
871
\def\temp{\input #1 }%
872
\expandafter
873
}\temp
874
\popthisfilestack
875
}
876
\def\filenamecatcodes{%
877
\catcode`\\=\other
878
\catcode`~=\other
879
\catcode`^=\other
880
\catcode`_=\other
881
\catcode`|=\other
882
\catcode`<=\other
883
\catcode`>=\other
884
\catcode`+=\other
885
\catcode`-=\other
886
}
887
888
\def\pushthisfilestack{%
889
\expandafter\pushthisfilestackX\popthisfilestack\StackTerm
890
}
891
\def\pushthisfilestackX{%
892
\expandafter\pushthisfilestackY\thisfile\StackTerm
893
}
894
\def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
895
\gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
896
}
897
898
\def\popthisfilestack{\errthisfilestackempty}
899
\def\errthisfilestackempty{\errmessage{Internal error:
900
the stack of filenames is empty.}}
901
902
\def\thisfile{}
903
904
% @center line
905
% outputs that line, centered.
906
%
907
\parseargdef\center{%
908
\ifhmode
909
\let\next\centerH
910
\else
911
\let\next\centerV
912
\fi
913
\next{\hfil \ignorespaces#1\unskip \hfil}%
914
}
915
\def\centerH#1{%
916
{%
917
\hfil\break
918
\advance\hsize by -\leftskip
919
\advance\hsize by -\rightskip
920
\line{#1}%
921
\break
922
}%
923
}
924
\def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
925
926
% @sp n outputs n lines of vertical space
927
928
\parseargdef\sp{\vskip #1\baselineskip}
929
930
% @comment ...line which is ignored...
931
% @c is the same as @comment
932
% @ignore ... @end ignore is another way to write a comment
933
934
\def\comment{\begingroup \catcode`\^^M=\other%
935
\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
936
\commentxxx}
937
{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
938
939
\let\c=\comment
940
941
% @paragraphindent NCHARS
942
% We'll use ems for NCHARS, close enough.
943
% NCHARS can also be the word `asis' or `none'.
944
% We cannot feasibly implement @paragraphindent asis, though.
945
%
946
\def\asisword{asis} % no translation, these are keywords
947
\def\noneword{none}
948
%
949
\parseargdef\paragraphindent{%
950
\def\temp{#1}%
951
\ifx\temp\asisword
952
\else
953
\ifx\temp\noneword
954
\defaultparindent = 0pt
955
\else
956
\defaultparindent = #1em
957
\fi
958
\fi
959
\parindent = \defaultparindent
960
}
961
962
% @exampleindent NCHARS
963
% We'll use ems for NCHARS like @paragraphindent.
964
% It seems @exampleindent asis isn't necessary, but
965
% I preserve it to make it similar to @paragraphindent.
966
\parseargdef\exampleindent{%
967
\def\temp{#1}%
968
\ifx\temp\asisword
969
\else
970
\ifx\temp\noneword
971
\lispnarrowing = 0pt
972
\else
973
\lispnarrowing = #1em
974
\fi
975
\fi
976
}
977
978
% @firstparagraphindent WORD
979
% If WORD is `none', then suppress indentation of the first paragraph
980
% after a section heading. If WORD is `insert', then do indent at such
981
% paragraphs.
982
%
983
% The paragraph indentation is suppressed or not by calling
984
% \suppressfirstparagraphindent, which the sectioning commands do.
985
% We switch the definition of this back and forth according to WORD.
986
% By default, we suppress indentation.
987
%
988
\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
989
\def\insertword{insert}
990
%
991
\parseargdef\firstparagraphindent{%
992
\def\temp{#1}%
993
\ifx\temp\noneword
994
\let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
995
\else\ifx\temp\insertword
996
\let\suppressfirstparagraphindent = \relax
997
\else
998
\errhelp = \EMsimple
999
\errmessage{Unknown @firstparagraphindent option `\temp'}%
1000
\fi\fi
1001
}
1002
1003
% Here is how we actually suppress indentation. Redefine \everypar to
1004
% \kern backwards by \parindent, and then reset itself to empty.
1005
%
1006
% We also make \indent itself not actually do anything until the next
1007
% paragraph.
1008
%
1009
\gdef\dosuppressfirstparagraphindent{%
1010
\gdef\indent{%
1011
\restorefirstparagraphindent
1012
\indent
1013
}%
1014
\gdef\noindent{%
1015
\restorefirstparagraphindent
1016
\noindent
1017
}%
1018
\global\everypar = {%
1019
\kern -\parindent
1020
\restorefirstparagraphindent
1021
}%
1022
}
1023
1024
\gdef\restorefirstparagraphindent{%
1025
\global \let \indent = \ptexindent
1026
\global \let \noindent = \ptexnoindent
1027
\global \everypar = {}%
1028
}
1029
1030
1031
% @asis just yields its argument. Used with @table, for example.
1032
%
1033
\def\asis#1{#1}
1034
1035
% @math outputs its argument in math mode.
1036
%
1037
% One complication: _ usually means subscripts, but it could also mean
1038
% an actual _ character, as in @math{@var{some_variable} + 1}. So make
1039
% _ active, and distinguish by seeing if the current family is \slfam,
1040
% which is what @var uses.
1041
{
1042
\catcode`\_ = \active
1043
\gdef\mathunderscore{%
1044
\catcode`\_=\active
1045
\def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1046
}
1047
}
1048
% Another complication: we want \\ (and @\) to output a \ character.
1049
% FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1050
% this is not advertised and we don't care. Texinfo does not
1051
% otherwise define @\.
1052
%
1053
% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1054
\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1055
%
1056
\def\math{%
1057
\tex
1058
\mathunderscore
1059
\let\\ = \mathbackslash
1060
\mathactive
1061
$\finishmath
1062
}
1063
\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1064
1065
% Some active characters (such as <) are spaced differently in math.
1066
% We have to reset their definitions in case the @math was an argument
1067
% to a command which sets the catcodes (such as @item or @section).
1068
%
1069
{
1070
\catcode`^ = \active
1071
\catcode`< = \active
1072
\catcode`> = \active
1073
\catcode`+ = \active
1074
\gdef\mathactive{%
1075
\let^ = \ptexhat
1076
\let< = \ptexless
1077
\let> = \ptexgtr
1078
\let+ = \ptexplus
1079
}
1080
}
1081
1082
% @bullet and @minus need the same treatment as @math, just above.
1083
\def\bullet{$\ptexbullet$}
1084
\def\minus{$-$}
1085
1086
% @dots{} outputs an ellipsis using the current font.
1087
% We do .5em per period so that it has the same spacing in the cm
1088
% typewriter fonts as three actual period characters; on the other hand,
1089
% in other typewriter fonts three periods are wider than 1.5em. So do
1090
% whichever is larger.
1091
%
1092
\def\dots{%
1093
\leavevmode
1094
\setbox0=\hbox{...}% get width of three periods
1095
\ifdim\wd0 > 1.5em
1096
\dimen0 = \wd0
1097
\else
1098
\dimen0 = 1.5em
1099
\fi
1100
\hbox to \dimen0{%
1101
\hskip 0pt plus.25fil
1102
.\hskip 0pt plus1fil
1103
.\hskip 0pt plus1fil
1104
.\hskip 0pt plus.5fil
1105
}%
1106
}
1107
1108
% @enddots{} is an end-of-sentence ellipsis.
1109
%
1110
\def\enddots{%
1111
\dots
1112
\spacefactor=\endofsentencespacefactor
1113
}
1114
1115
% @comma{} is so commas can be inserted into text without messing up
1116
% Texinfo's parsing.
1117
%
1118
\let\comma = ,
1119
1120
% @refill is a no-op.
1121
\let\refill=\relax
1122
1123
% If working on a large document in chapters, it is convenient to
1124
% be able to disable indexing, cross-referencing, and contents, for test runs.
1125
% This is done with @novalidate (before @setfilename).
1126
%
1127
\newif\iflinks \linkstrue % by default we want the aux files.
1128
\let\novalidate = \linksfalse
1129
1130
% @setfilename is done at the beginning of every texinfo file.
1131
% So open here the files we need to have open while reading the input.
1132
% This makes it possible to make a .fmt file for texinfo.
1133
\def\setfilename{%
1134
\fixbackslash % Turn off hack to swallow `\input texinfo'.
1135
\iflinks
1136
\tryauxfile
1137
% Open the new aux file. TeX will close it automatically at exit.
1138
\immediate\openout\auxfile=\jobname.aux
1139
\fi % \openindices needs to do some work in any case.
1140
\openindices
1141
\let\setfilename=\comment % Ignore extra @setfilename cmds.
1142
%
1143
% If texinfo.cnf is present on the system, read it.
1144
% Useful for site-wide @afourpaper, etc.
1145
\openin 1 texinfo.cnf
1146
\ifeof 1 \else \input texinfo.cnf \fi
1147
\closein 1
1148
%
1149
\comment % Ignore the actual filename.
1150
}
1151
1152
% Called from \setfilename.
1153
%
1154
\def\openindices{%
1155
\newindex{cp}%
1156
\newcodeindex{fn}%
1157
\newcodeindex{vr}%
1158
\newcodeindex{tp}%
1159
\newcodeindex{ky}%
1160
\newcodeindex{pg}%
1161
}
1162
1163
% @bye.
1164
\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1165
1166
1167
\message{pdf,}
1168
% adobe `portable' document format
1169
\newcount\tempnum
1170
\newcount\lnkcount
1171
\newtoks\filename
1172
\newcount\filenamelength
1173
\newcount\pgn
1174
\newtoks\toksA
1175
\newtoks\toksB
1176
\newtoks\toksC
1177
\newtoks\toksD
1178
\newbox\boxA
1179
\newcount\countA
1180
\newif\ifpdf
1181
\newif\ifpdfmakepagedest
1182
1183
% when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1184
% can be set). So we test for \relax and 0 as well as \undefined,
1185
% borrowed from ifpdf.sty.
1186
\ifx\pdfoutput\undefined
1187
\else
1188
\ifx\pdfoutput\relax
1189
\else
1190
\ifcase\pdfoutput
1191
\else
1192
\pdftrue
1193
\fi
1194
\fi
1195
\fi
1196
1197
% PDF uses PostScript string constants for the names of xref targets,
1198
% for display in the outlines, and in other places. Thus, we have to
1199
% double any backslashes. Otherwise, a name like "\node" will be
1200
% interpreted as a newline (\n), followed by o, d, e. Not good.
1201
% http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1202
% (and related messages, the final outcome is that it is up to the TeX
1203
% user to double the backslashes and otherwise make the string valid, so
1204
% that's what we do).
1205
1206
% double active backslashes.
1207
%
1208
{\catcode`\@=0 \catcode`\\=\active
1209
@gdef@activebackslashdouble{%
1210
@catcode`@\=@active
1211
@let\=@doublebackslash}
1212
}
1213
1214
% To handle parens, we must adopt a different approach, since parens are
1215
% not active characters. hyperref.dtx (which has the same problem as
1216
% us) handles it with this amazing macro to replace tokens. I've
1217
% tinkered with it a little for texinfo, but it's definitely from there.
1218
%
1219
% #1 is the tokens to replace.
1220
% #2 is the replacement.
1221
% #3 is the control sequence with the string.
1222
%
1223
\def\HyPsdSubst#1#2#3{%
1224
\def\HyPsdReplace##1#1##2\END{%
1225
##1%
1226
\ifx\\##2\\%
1227
\else
1228
#2%
1229
\HyReturnAfterFi{%
1230
\HyPsdReplace##2\END
1231
}%
1232
\fi
1233
}%
1234
\xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1235
}
1236
\long\def\HyReturnAfterFi#1\fi{\fi#1}
1237
1238
% #1 is a control sequence in which to do the replacements.
1239
\def\backslashparens#1{%
1240
\xdef#1{#1}% redefine it as its expansion; the definition is simply
1241
% \lastnode when called from \setref -> \pdfmkdest.
1242
\HyPsdSubst{(}{\realbackslash(}{#1}%
1243
\HyPsdSubst{)}{\realbackslash)}{#1}%
1244
}
1245
1246
\ifpdf
1247
\input pdfcolor
1248
\pdfcatalog{/PageMode /UseOutlines}%
1249
% #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1250
\def\dopdfimage#1#2#3{%
1251
\def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1252
\def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1253
% without \immediate, pdftex seg faults when the same image is
1254
% included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1255
\ifnum\pdftexversion < 14
1256
\immediate\pdfimage
1257
\else
1258
\immediate\pdfximage
1259
\fi
1260
\ifdim \wd0 >0pt width \imagewidth \fi
1261
\ifdim \wd2 >0pt height \imageheight \fi
1262
\ifnum\pdftexversion<13
1263
#1.pdf%
1264
\else
1265
{#1.pdf}%
1266
\fi
1267
\ifnum\pdftexversion < 14 \else
1268
\pdfrefximage \pdflastximage
1269
\fi}
1270
\def\pdfmkdest#1{{%
1271
% We have to set dummies so commands such as @code, and characters
1272
% such as \, aren't expanded when present in a section title.
1273
\atdummies
1274
\activebackslashdouble
1275
\def\pdfdestname{#1}%
1276
\backslashparens\pdfdestname
1277
\pdfdest name{\pdfdestname} xyz%
1278
}}%
1279
%
1280
% used to mark target names; must be expandable.
1281
\def\pdfmkpgn#1{#1}%
1282
%
1283
\let\linkcolor = \Blue % was Cyan, but that seems light?
1284
\def\endlink{\Black\pdfendlink}
1285
% Adding outlines to PDF; macros for calculating structure of outlines
1286
% come from Petr Olsak
1287
\def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1288
\else \csname#1\endcsname \fi}
1289
\def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1290
\advance\tempnum by 1
1291
\expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1292
%
1293
% #1 is the section text, which is what will be displayed in the
1294
% outline by the pdf viewer. #2 is the pdf expression for the number
1295
% of subentries (or empty, for subsubsections). #3 is the node text,
1296
% which might be empty if this toc entry had no corresponding node.
1297
% #4 is the page number
1298
%
1299
\def\dopdfoutline#1#2#3#4{%
1300
% Generate a link to the node text if that exists; else, use the
1301
% page number. We could generate a destination for the section
1302
% text in the case where a section has no node, but it doesn't
1303
% seem worth the trouble, since most documents are normally structured.
1304
\def\pdfoutlinedest{#3}%
1305
\ifx\pdfoutlinedest\empty
1306
\def\pdfoutlinedest{#4}%
1307
\else
1308
% Doubled backslashes in the name.
1309
{\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1310
\backslashparens\pdfoutlinedest}%
1311
\fi
1312
%
1313
% Also double the backslashes in the display string.
1314
{\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1315
\backslashparens\pdfoutlinetext}%
1316
%
1317
\pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1318
}
1319
%
1320
\def\pdfmakeoutlines{%
1321
\begingroup
1322
% Thanh's hack / proper braces in bookmarks
1323
\edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1324
\edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1325
%
1326
% Read toc silently, to get counts of subentries for \pdfoutline.
1327
\def\numchapentry##1##2##3##4{%
1328
\def\thischapnum{##2}%
1329
\def\thissecnum{0}%
1330
\def\thissubsecnum{0}%
1331
}%
1332
\def\numsecentry##1##2##3##4{%
1333
\advancenumber{chap\thischapnum}%
1334
\def\thissecnum{##2}%
1335
\def\thissubsecnum{0}%
1336
}%
1337
\def\numsubsecentry##1##2##3##4{%
1338
\advancenumber{sec\thissecnum}%
1339
\def\thissubsecnum{##2}%
1340
}%
1341
\def\numsubsubsecentry##1##2##3##4{%
1342
\advancenumber{subsec\thissubsecnum}%
1343
}%
1344
\def\thischapnum{0}%
1345
\def\thissecnum{0}%
1346
\def\thissubsecnum{0}%
1347
%
1348
% use \def rather than \let here because we redefine \chapentry et
1349
% al. a second time, below.
1350
\def\appentry{\numchapentry}%
1351
\def\appsecentry{\numsecentry}%
1352
\def\appsubsecentry{\numsubsecentry}%
1353
\def\appsubsubsecentry{\numsubsubsecentry}%
1354
\def\unnchapentry{\numchapentry}%
1355
\def\unnsecentry{\numsecentry}%
1356
\def\unnsubsecentry{\numsubsecentry}%
1357
\def\unnsubsubsecentry{\numsubsubsecentry}%
1358
\readdatafile{toc}%
1359
%
1360
% Read toc second time, this time actually producing the outlines.
1361
% The `-' means take the \expnumber as the absolute number of
1362
% subentries, which we calculated on our first read of the .toc above.
1363
%
1364
% We use the node names as the destinations.
1365
\def\numchapentry##1##2##3##4{%
1366
\dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1367
\def\numsecentry##1##2##3##4{%
1368
\dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1369
\def\numsubsecentry##1##2##3##4{%
1370
\dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1371
\def\numsubsubsecentry##1##2##3##4{% count is always zero
1372
\dopdfoutline{##1}{}{##3}{##4}}%
1373
%
1374
% PDF outlines are displayed using system fonts, instead of
1375
% document fonts. Therefore we cannot use special characters,
1376
% since the encoding is unknown. For example, the eogonek from
1377
% Latin 2 (0xea) gets translated to a | character. Info from
1378
% Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1379
%
1380
% xx to do this right, we have to translate 8-bit characters to
1381
% their "best" equivalent, based on the @documentencoding. Right
1382
% now, I guess we'll just let the pdf reader have its way.
1383
\indexnofonts
1384
\setupdatafile
1385
\catcode`\\=\active \otherbackslash
1386
\input \jobname.toc
1387
\endgroup
1388
}
1389
%
1390
\def\skipspaces#1{\def\PP{#1}\def\D{|}%
1391
\ifx\PP\D\let\nextsp\relax
1392
\else\let\nextsp\skipspaces
1393
\ifx\p\space\else\addtokens{\filename}{\PP}%
1394
\advance\filenamelength by 1
1395
\fi
1396
\fi
1397
\nextsp}
1398
\def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1399
\ifnum\pdftexversion < 14
1400
\let \startlink \pdfannotlink
1401
\else
1402
\let \startlink \pdfstartlink
1403
\fi
1404
% make a live url in pdf output.
1405
\def\pdfurl#1{%
1406
\begingroup
1407
% it seems we really need yet another set of dummies; have not
1408
% tried to figure out what each command should do in the context
1409
% of @url. for now, just make @/ a no-op, that's the only one
1410
% people have actually reported a problem with.
1411
%
1412
\normalturnoffactive
1413
\def\@{@}%
1414
\let\/=\empty
1415
\makevalueexpandable
1416
\leavevmode\Red
1417
\startlink attr{/Border [0 0 0]}%
1418
user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1419
\endgroup}
1420
\def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1421
\def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1422
\def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1423
\def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1424
\def\maketoks{%
1425
\expandafter\poptoks\the\toksA|ENDTOKS|\relax
1426
\ifx\first0\adn0
1427
\else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1428
\else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1429
\else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1430
\else
1431
\ifnum0=\countA\else\makelink\fi
1432
\ifx\first.\let\next=\done\else
1433
\let\next=\maketoks
1434
\addtokens{\toksB}{\the\toksD}
1435
\ifx\first,\addtokens{\toksB}{\space}\fi
1436
\fi
1437
\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1438
\next}
1439
\def\makelink{\addtokens{\toksB}%
1440
{\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1441
\def\pdflink#1{%
1442
\startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1443
\linkcolor #1\endlink}
1444
\def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1445
\else
1446
\let\pdfmkdest = \gobble
1447
\let\pdfurl = \gobble
1448
\let\endlink = \relax
1449
\let\linkcolor = \relax
1450
\let\pdfmakeoutlines = \relax
1451
\fi % \ifx\pdfoutput
1452
1453
1454
\message{fonts,}
1455
1456
% Change the current font style to #1, remembering it in \curfontstyle.
1457
% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1458
% italics, not bold italics.
1459
%
1460
\def\setfontstyle#1{%
1461
\def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1462
\csname ten#1\endcsname % change the current font
1463
}
1464
1465
% Select #1 fonts with the current style.
1466
%
1467
\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1468
1469
\def\rm{\fam=0 \setfontstyle{rm}}
1470
\def\it{\fam=\itfam \setfontstyle{it}}
1471
\def\sl{\fam=\slfam \setfontstyle{sl}}
1472
\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1473
\def\tt{\fam=\ttfam \setfontstyle{tt}}
1474
1475
% Texinfo sort of supports the sans serif font style, which plain TeX does not.
1476
% So we set up a \sf.
1477
\newfam\sffam
1478
\def\sf{\fam=\sffam \setfontstyle{sf}}
1479
\let\li = \sf % Sometimes we call it \li, not \sf.
1480
1481
% We don't need math for this font style.
1482
\def\ttsl{\setfontstyle{ttsl}}
1483
1484
1485
% Default leading.
1486
\newdimen\textleading \textleading = 13.2pt
1487
1488
% Set the baselineskip to #1, and the lineskip and strut size
1489
% correspondingly. There is no deep meaning behind these magic numbers
1490
% used as factors; they just match (closely enough) what Knuth defined.
1491
%
1492
\def\lineskipfactor{.08333}
1493
\def\strutheightpercent{.70833}
1494
\def\strutdepthpercent {.29167}
1495
%
1496
\def\setleading#1{%
1497
\normalbaselineskip = #1\relax
1498
\normallineskip = \lineskipfactor\normalbaselineskip
1499
\normalbaselines
1500
\setbox\strutbox =\hbox{%
1501
\vrule width0pt height\strutheightpercent\baselineskip
1502
depth \strutdepthpercent \baselineskip
1503
}%
1504
}
1505
1506
1507
% Set the font macro #1 to the font named #2, adding on the
1508
% specified font prefix (normally `cm').
1509
% #3 is the font's design size, #4 is a scale factor
1510
\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1511
1512
1513
% Use cm as the default font prefix.
1514
% To specify the font prefix, you must define \fontprefix
1515
% before you read in texinfo.tex.
1516
\ifx\fontprefix\undefined
1517
\def\fontprefix{cm}
1518
\fi
1519
% Support font families that don't use the same naming scheme as CM.
1520
\def\rmshape{r}
1521
\def\rmbshape{bx} %where the normal face is bold
1522
\def\bfshape{b}
1523
\def\bxshape{bx}
1524
\def\ttshape{tt}
1525
\def\ttbshape{tt}
1526
\def\ttslshape{sltt}
1527
\def\itshape{ti}
1528
\def\itbshape{bxti}
1529
\def\slshape{sl}
1530
\def\slbshape{bxsl}
1531
\def\sfshape{ss}
1532
\def\sfbshape{ss}
1533
\def\scshape{csc}
1534
\def\scbshape{csc}
1535
1536
% Definitions for a main text size of 11pt. This is the default in
1537
% Texinfo.
1538
%
1539
\def\definetextfontsizexi{
1540
% Text fonts (11.2pt, magstep1).
1541
\def\textnominalsize{11pt}
1542
\edef\mainmagstep{\magstephalf}
1543
\setfont\textrm\rmshape{10}{\mainmagstep}
1544
\setfont\texttt\ttshape{10}{\mainmagstep}
1545
\setfont\textbf\bfshape{10}{\mainmagstep}
1546
\setfont\textit\itshape{10}{\mainmagstep}
1547
\setfont\textsl\slshape{10}{\mainmagstep}
1548
\setfont\textsf\sfshape{10}{\mainmagstep}
1549
\setfont\textsc\scshape{10}{\mainmagstep}
1550
\setfont\textttsl\ttslshape{10}{\mainmagstep}
1551
\font\texti=cmmi10 scaled \mainmagstep
1552
\font\textsy=cmsy10 scaled \mainmagstep
1553
1554
% A few fonts for @defun names and args.
1555
\setfont\defbf\bfshape{10}{\magstep1}
1556
\setfont\deftt\ttshape{10}{\magstep1}
1557
\setfont\defttsl\ttslshape{10}{\magstep1}
1558
\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1559
1560
% Fonts for indices, footnotes, small examples (9pt).
1561
\def\smallnominalsize{9pt}
1562
\setfont\smallrm\rmshape{9}{1000}
1563
\setfont\smalltt\ttshape{9}{1000}
1564
\setfont\smallbf\bfshape{10}{900}
1565
\setfont\smallit\itshape{9}{1000}
1566
\setfont\smallsl\slshape{9}{1000}
1567
\setfont\smallsf\sfshape{9}{1000}
1568
\setfont\smallsc\scshape{10}{900}
1569
\setfont\smallttsl\ttslshape{10}{900}
1570
\font\smalli=cmmi9
1571
\font\smallsy=cmsy9
1572
1573
% Fonts for small examples (8pt).
1574
\def\smallernominalsize{8pt}
1575
\setfont\smallerrm\rmshape{8}{1000}
1576
\setfont\smallertt\ttshape{8}{1000}
1577
\setfont\smallerbf\bfshape{10}{800}
1578
\setfont\smallerit\itshape{8}{1000}
1579
\setfont\smallersl\slshape{8}{1000}
1580
\setfont\smallersf\sfshape{8}{1000}
1581
\setfont\smallersc\scshape{10}{800}
1582
\setfont\smallerttsl\ttslshape{10}{800}
1583
\font\smalleri=cmmi8
1584
\font\smallersy=cmsy8
1585
1586
% Fonts for title page (20.4pt):
1587
\def\titlenominalsize{20pt}
1588
\setfont\titlerm\rmbshape{12}{\magstep3}
1589
\setfont\titleit\itbshape{10}{\magstep4}
1590
\setfont\titlesl\slbshape{10}{\magstep4}
1591
\setfont\titlett\ttbshape{12}{\magstep3}
1592
\setfont\titlettsl\ttslshape{10}{\magstep4}
1593
\setfont\titlesf\sfbshape{17}{\magstep1}
1594
\let\titlebf=\titlerm
1595
\setfont\titlesc\scbshape{10}{\magstep4}
1596
\font\titlei=cmmi12 scaled \magstep3
1597
\font\titlesy=cmsy10 scaled \magstep4
1598
\def\authorrm{\secrm}
1599
\def\authortt{\sectt}
1600
1601
% Chapter (and unnumbered) fonts (17.28pt).
1602
\def\chapnominalsize{17pt}
1603
\setfont\chaprm\rmbshape{12}{\magstep2}
1604
\setfont\chapit\itbshape{10}{\magstep3}
1605
\setfont\chapsl\slbshape{10}{\magstep3}
1606
\setfont\chaptt\ttbshape{12}{\magstep2}
1607
\setfont\chapttsl\ttslshape{10}{\magstep3}
1608
\setfont\chapsf\sfbshape{17}{1000}
1609
\let\chapbf=\chaprm
1610
\setfont\chapsc\scbshape{10}{\magstep3}
1611
\font\chapi=cmmi12 scaled \magstep2
1612
\font\chapsy=cmsy10 scaled \magstep3
1613
1614
% Section fonts (14.4pt).
1615
\def\secnominalsize{14pt}
1616
\setfont\secrm\rmbshape{12}{\magstep1}
1617
\setfont\secit\itbshape{10}{\magstep2}
1618
\setfont\secsl\slbshape{10}{\magstep2}
1619
\setfont\sectt\ttbshape{12}{\magstep1}
1620
\setfont\secttsl\ttslshape{10}{\magstep2}
1621
\setfont\secsf\sfbshape{12}{\magstep1}
1622
\let\secbf\secrm
1623
\setfont\secsc\scbshape{10}{\magstep2}
1624
\font\seci=cmmi12 scaled \magstep1
1625
\font\secsy=cmsy10 scaled \magstep2
1626
1627
% Subsection fonts (13.15pt).
1628
\def\ssecnominalsize{13pt}
1629
\setfont\ssecrm\rmbshape{12}{\magstephalf}
1630
\setfont\ssecit\itbshape{10}{1315}
1631
\setfont\ssecsl\slbshape{10}{1315}
1632
\setfont\ssectt\ttbshape{12}{\magstephalf}
1633
\setfont\ssecttsl\ttslshape{10}{1315}
1634
\setfont\ssecsf\sfbshape{12}{\magstephalf}
1635
\let\ssecbf\ssecrm
1636
\setfont\ssecsc\scbshape{10}{1315}
1637
\font\sseci=cmmi12 scaled \magstephalf
1638
\font\ssecsy=cmsy10 scaled 1315
1639
1640
% Reduced fonts for @acro in text (10pt).
1641
\def\reducednominalsize{10pt}
1642
\setfont\reducedrm\rmshape{10}{1000}
1643
\setfont\reducedtt\ttshape{10}{1000}
1644
\setfont\reducedbf\bfshape{10}{1000}
1645
\setfont\reducedit\itshape{10}{1000}
1646
\setfont\reducedsl\slshape{10}{1000}
1647
\setfont\reducedsf\sfshape{10}{1000}
1648
\setfont\reducedsc\scshape{10}{1000}
1649
\setfont\reducedttsl\ttslshape{10}{1000}
1650
\font\reducedi=cmmi10
1651
\font\reducedsy=cmsy10
1652
1653
% reset the current fonts
1654
\textfonts
1655
\rm
1656
} % end of 11pt text font size definitions
1657
1658
1659
% Definitions to make the main text be 10pt Computer Modern, with
1660
% section, chapter, etc., sizes following suit. This is for the GNU
1661
% Press printing of the Emacs 22 manual. Maybe other manuals in the
1662
% future. Used with @smallbook, which sets the leading to 12pt.
1663
%
1664
\def\definetextfontsizex{%
1665
% Text fonts (10pt).
1666
\def\textnominalsize{10pt}
1667
\edef\mainmagstep{1000}
1668
\setfont\textrm\rmshape{10}{\mainmagstep}
1669
\setfont\texttt\ttshape{10}{\mainmagstep}
1670
\setfont\textbf\bfshape{10}{\mainmagstep}
1671
\setfont\textit\itshape{10}{\mainmagstep}
1672
\setfont\textsl\slshape{10}{\mainmagstep}
1673
\setfont\textsf\sfshape{10}{\mainmagstep}
1674
\setfont\textsc\scshape{10}{\mainmagstep}
1675
\setfont\textttsl\ttslshape{10}{\mainmagstep}
1676
\font\texti=cmmi10 scaled \mainmagstep
1677
\font\textsy=cmsy10 scaled \mainmagstep
1678
1679
% A few fonts for @defun names and args.
1680
\setfont\defbf\bfshape{10}{\magstephalf}
1681
\setfont\deftt\ttshape{10}{\magstephalf}
1682
\setfont\defttsl\ttslshape{10}{\magstephalf}
1683
\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1684
1685
% Fonts for indices, footnotes, small examples (9pt).
1686
\def\smallnominalsize{9pt}
1687
\setfont\smallrm\rmshape{9}{1000}
1688
\setfont\smalltt\ttshape{9}{1000}
1689
\setfont\smallbf\bfshape{10}{900}
1690
\setfont\smallit\itshape{9}{1000}
1691
\setfont\smallsl\slshape{9}{1000}
1692
\setfont\smallsf\sfshape{9}{1000}
1693
\setfont\smallsc\scshape{10}{900}
1694
\setfont\smallttsl\ttslshape{10}{900}
1695
\font\smalli=cmmi9
1696
\font\smallsy=cmsy9
1697
1698
% Fonts for small examples (8pt).
1699
\def\smallernominalsize{8pt}
1700
\setfont\smallerrm\rmshape{8}{1000}
1701
\setfont\smallertt\ttshape{8}{1000}
1702
\setfont\smallerbf\bfshape{10}{800}
1703
\setfont\smallerit\itshape{8}{1000}
1704
\setfont\smallersl\slshape{8}{1000}
1705
\setfont\smallersf\sfshape{8}{1000}
1706
\setfont\smallersc\scshape{10}{800}
1707
\setfont\smallerttsl\ttslshape{10}{800}
1708
\font\smalleri=cmmi8
1709
\font\smallersy=cmsy8
1710
1711
% Fonts for title page (20.4pt):
1712
\def\titlenominalsize{20pt}
1713
\setfont\titlerm\rmbshape{12}{\magstep3}
1714
\setfont\titleit\itbshape{10}{\magstep4}
1715
\setfont\titlesl\slbshape{10}{\magstep4}
1716
\setfont\titlett\ttbshape{12}{\magstep3}
1717
\setfont\titlettsl\ttslshape{10}{\magstep4}
1718
\setfont\titlesf\sfbshape{17}{\magstep1}
1719
\let\titlebf=\titlerm
1720
\setfont\titlesc\scbshape{10}{\magstep4}
1721
\font\titlei=cmmi12 scaled \magstep3
1722
\font\titlesy=cmsy10 scaled \magstep4
1723
\def\authorrm{\secrm}
1724
\def\authortt{\sectt}
1725
1726
% Chapter fonts (14.4pt).
1727
\def\chapnominalsize{14pt}
1728
\setfont\chaprm\rmbshape{12}{\magstep1}
1729
\setfont\chapit\itbshape{10}{\magstep2}
1730
\setfont\chapsl\slbshape{10}{\magstep2}
1731
\setfont\chaptt\ttbshape{12}{\magstep1}
1732
\setfont\chapttsl\ttslshape{10}{\magstep2}
1733
\setfont\chapsf\sfbshape{12}{\magstep1}
1734
\let\chapbf\chaprm
1735
\setfont\chapsc\scbshape{10}{\magstep2}
1736
\font\chapi=cmmi12 scaled \magstep1
1737
\font\chapsy=cmsy10 scaled \magstep2
1738
1739
% Section fonts (12pt).
1740
\def\secnominalsize{12pt}
1741
\setfont\secrm\rmbshape{12}{1000}
1742
\setfont\secit\itbshape{10}{\magstep1}
1743
\setfont\secsl\slbshape{10}{\magstep1}
1744
\setfont\sectt\ttbshape{12}{1000}
1745
\setfont\secttsl\ttslshape{10}{\magstep1}
1746
\setfont\secsf\sfbshape{12}{1000}
1747
\let\secbf\secrm
1748
\setfont\secsc\scbshape{10}{\magstep1}
1749
\font\seci=cmmi12
1750
\font\secsy=cmsy10 scaled \magstep1
1751
1752
% Subsection fonts (10pt).
1753
\def\ssecnominalsize{10pt}
1754
\setfont\ssecrm\rmbshape{10}{1000}
1755
\setfont\ssecit\itbshape{10}{1000}
1756
\setfont\ssecsl\slbshape{10}{1000}
1757
\setfont\ssectt\ttbshape{10}{1000}
1758
\setfont\ssecttsl\ttslshape{10}{1000}
1759
\setfont\ssecsf\sfbshape{10}{1000}
1760
\let\ssecbf\ssecrm
1761
\setfont\ssecsc\scbshape{10}{1000}
1762
\font\sseci=cmmi10
1763
\font\ssecsy=cmsy10
1764
1765
% Reduced fonts for @acro in text (9pt).
1766
\def\reducednominalsize{9pt}
1767
\setfont\reducedrm\rmshape{9}{1000}
1768
\setfont\reducedtt\ttshape{9}{1000}
1769
\setfont\reducedbf\bfshape{10}{900}
1770
\setfont\reducedit\itshape{9}{1000}
1771
\setfont\reducedsl\slshape{9}{1000}
1772
\setfont\reducedsf\sfshape{9}{1000}
1773
\setfont\reducedsc\scshape{10}{900}
1774
\setfont\reducedttsl\ttslshape{10}{900}
1775
\font\reducedi=cmmi9
1776
\font\reducedsy=cmsy9
1777
1778
% reduce space between paragraphs
1779
\divide\parskip by 2
1780
1781
% reset the current fonts
1782
\textfonts
1783
\rm
1784
} % end of 10pt text font size definitions
1785
1786
1787
% We provide the user-level command
1788
% @fonttextsize 10
1789
% (or 11) to redefine the text font size. pt is assumed.
1790
%
1791
\def\xword{10}
1792
\def\xiword{11}
1793
%
1794
\parseargdef\fonttextsize{%
1795
\def\textsizearg{#1}%
1796
\wlog{doing @fonttextsize \textsizearg}%
1797
%
1798
% Set \globaldefs so that documents can use this inside @tex, since
1799
% makeinfo 4.8 does not support it, but we need it nonetheless.
1800
%
1801
\begingroup \globaldefs=1
1802
\ifx\textsizearg\xword \definetextfontsizex
1803
\else \ifx\textsizearg\xiword \definetextfontsizexi
1804
\else
1805
\errhelp=\EMsimple
1806
\errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
1807
\fi\fi
1808
\endgroup
1809
}
1810
1811
1812
% In order for the font changes to affect most math symbols and letters,
1813
% we have to define the \textfont of the standard families. Since
1814
% texinfo doesn't allow for producing subscripts and superscripts except
1815
% in the main text, we don't bother to reset \scriptfont and
1816
% \scriptscriptfont (which would also require loading a lot more fonts).
1817
%
1818
\def\resetmathfonts{%
1819
\textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1820
\textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1821
\textfont\ttfam=\tentt \textfont\sffam=\tensf
1822
}
1823
1824
% The font-changing commands redefine the meanings of \tenSTYLE, instead
1825
% of just \STYLE. We do this because \STYLE needs to also set the
1826
% current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1827
% \tenSTYLE to set the current font.
1828
%
1829
% Each font-changing command also sets the names \lsize (one size lower)
1830
% and \lllsize (three sizes lower). These relative commands are used in
1831
% the LaTeX logo and acronyms.
1832
%
1833
% This all needs generalizing, badly.
1834
%
1835
\def\textfonts{%
1836
\let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1837
\let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1838
\let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1839
\let\tenttsl=\textttsl
1840
\def\curfontsize{text}%
1841
\def\lsize{reduced}\def\lllsize{smaller}%
1842
\resetmathfonts \setleading{\textleading}}
1843
\def\titlefonts{%
1844
\let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1845
\let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1846
\let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1847
\let\tenttsl=\titlettsl
1848
\def\curfontsize{title}%
1849
\def\lsize{chap}\def\lllsize{subsec}%
1850
\resetmathfonts \setleading{25pt}}
1851
\def\titlefont#1{{\titlefonts\rm #1}}
1852
\def\chapfonts{%
1853
\let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1854
\let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1855
\let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1856
\let\tenttsl=\chapttsl
1857
\def\curfontsize{chap}%
1858
\def\lsize{sec}\def\lllsize{text}%
1859
\resetmathfonts \setleading{19pt}}
1860
\def\secfonts{%
1861
\let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1862
\let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1863
\let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1864
\let\tenttsl=\secttsl
1865
\def\curfontsize{sec}%
1866
\def\lsize{subsec}\def\lllsize{reduced}%
1867
\resetmathfonts \setleading{16pt}}
1868
\def\subsecfonts{%
1869
\let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1870
\let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1871
\let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1872
\let\tenttsl=\ssecttsl
1873
\def\curfontsize{ssec}%
1874
\def\lsize{text}\def\lllsize{small}%
1875
\resetmathfonts \setleading{15pt}}
1876
\let\subsubsecfonts = \subsecfonts
1877
\def\reducedfonts{%
1878
\let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1879
\let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1880
\let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1881
\let\tenttsl=\reducedttsl
1882
\def\curfontsize{reduced}%
1883
\def\lsize{small}\def\lllsize{smaller}%
1884
\resetmathfonts \setleading{10.5pt}}
1885
\def\smallfonts{%
1886
\let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1887
\let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1888
\let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1889
\let\tenttsl=\smallttsl
1890
\def\curfontsize{small}%
1891
\def\lsize{smaller}\def\lllsize{smaller}%
1892
\resetmathfonts \setleading{10.5pt}}
1893
\def\smallerfonts{%
1894
\let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1895
\let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1896
\let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1897
\let\tenttsl=\smallerttsl
1898
\def\curfontsize{smaller}%
1899
\def\lsize{smaller}\def\lllsize{smaller}%
1900
\resetmathfonts \setleading{9.5pt}}
1901
1902
% Set the fonts to use with the @small... environments.
1903
\let\smallexamplefonts = \smallfonts
1904
1905
% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1906
% can fit this many characters:
1907
% 8.5x11=86 smallbook=72 a4=90 a5=69
1908
% If we use \scriptfonts (8pt), then we can fit this many characters:
1909
% 8.5x11=90+ smallbook=80 a4=90+ a5=77
1910
% For me, subjectively, the few extra characters that fit aren't worth
1911
% the additional smallness of 8pt. So I'm making the default 9pt.
1912
%
1913
% By the way, for comparison, here's what fits with @example (10pt):
1914
% 8.5x11=71 smallbook=60 a4=75 a5=58
1915
%
1916
% I wish the USA used A4 paper.
1917
% --karl, 24jan03.
1918
1919
1920
% Set up the default fonts, so we can use them for creating boxes.
1921
%
1922
\definetextfontsizexi
1923
1924
% Define these so they can be easily changed for other fonts.
1925
\def\angleleft{$\langle$}
1926
\def\angleright{$\rangle$}
1927
1928
% Count depth in font-changes, for error checks
1929
\newcount\fontdepth \fontdepth=0
1930
1931
% Fonts for short table of contents.
1932
\setfont\shortcontrm\rmshape{12}{1000}
1933
\setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1934
\setfont\shortcontsl\slshape{12}{1000}
1935
\setfont\shortconttt\ttshape{12}{1000}
1936
1937
%% Add scribe-like font environments, plus @l for inline lisp (usually sans
1938
%% serif) and @ii for TeX italic
1939
1940
% \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1941
% unless the following character is such as not to need one.
1942
\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1943
\ptexslash\fi\fi\fi}
1944
\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1945
\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1946
1947
% like \smartslanted except unconditionally uses \ttsl.
1948
% @var is set to this for defun arguments.
1949
\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1950
1951
% like \smartslanted except unconditionally use \sl. We never want
1952
% ttsl for book titles, do we?
1953
\def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1954
1955
\let\i=\smartitalic
1956
\let\slanted=\smartslanted
1957
\let\var=\smartslanted
1958
\let\dfn=\smartslanted
1959
\let\emph=\smartitalic
1960
1961
% @b, explicit bold.
1962
\def\b#1{{\bf #1}}
1963
\let\strong=\b
1964
1965
% @sansserif, explicit sans.
1966
\def\sansserif#1{{\sf #1}}
1967
1968
% We can't just use \exhyphenpenalty, because that only has effect at
1969
% the end of a paragraph. Restore normal hyphenation at the end of the
1970
% group within which \nohyphenation is presumably called.
1971
%
1972
\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1973
\def\restorehyphenation{\hyphenchar\font = `- }
1974
1975
% Set sfcode to normal for the chars that usually have another value.
1976
% Can't use plain's \frenchspacing because it uses the `\x notation, and
1977
% sometimes \x has an active definition that messes things up.
1978
%
1979
\chardef\colonChar = `\:
1980
\chardef\commaChar = `\,
1981
\chardef\dotChar = `\.
1982
\chardef\exclamChar= `\!
1983
\chardef\questChar = `\?
1984
\chardef\semiChar = `\;
1985
%
1986
\catcode`@=11
1987
\def\plainfrenchspacing{%
1988
\sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1989
\sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1990
\def\endofsentencespacefactor{1000}% for @. and friends
1991
}
1992
\def\plainnonfrenchspacing{%
1993
\sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1994
\sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
1995
\def\endofsentencespacefactor{3000}% for @. and friends
1996
}
1997
\catcode`@=\other
1998
\def\endofsentencespacefactor{3000}% default
1999
2000
\def\t#1{%
2001
{\tt \rawbackslash \plainfrenchspacing #1}%
2002
\null
2003
}
2004
\def\samp#1{`\tclose{#1}'\null}
2005
\setfont\keyrm\rmshape{8}{1000}
2006
\font\keysy=cmsy9
2007
\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2008
\raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2009
\vbox{\hrule\kern-0.4pt
2010
\hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2011
\kern-0.4pt\hrule}%
2012
\kern-.06em\raise0.4pt\hbox{\angleright}}}}
2013
% The old definition, with no lozenge:
2014
%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2015
\def\ctrl #1{{\tt \rawbackslash \hat}#1}
2016
2017
% @file, @option are the same as @samp.
2018
\let\file=\samp
2019
\let\option=\samp
2020
2021
% @code is a modification of @t,
2022
% which makes spaces the same size as normal in the surrounding text.
2023
\def\tclose#1{%
2024
{%
2025
% Change normal interword space to be same as for the current font.
2026
\spaceskip = \fontdimen2\font
2027
%
2028
% Switch to typewriter.
2029
\tt
2030
%
2031
% But `\ ' produces the large typewriter interword space.
2032
\def\ {{\spaceskip = 0pt{} }}%
2033
%
2034
% Turn off hyphenation.
2035
\nohyphenation
2036
%
2037
\rawbackslash
2038
\plainfrenchspacing
2039
#1%
2040
}%
2041
\null
2042
}
2043
2044
% We *must* turn on hyphenation at `-' and `_' in @code.
2045
% Otherwise, it is too hard to avoid overfull hboxes
2046
% in the Emacs manual, the Library manual, etc.
2047
2048
% Unfortunately, TeX uses one parameter (\hyphenchar) to control
2049
% both hyphenation at - and hyphenation within words.
2050
% We must therefore turn them both off (\tclose does that)
2051
% and arrange explicitly to hyphenate at a dash.
2052
% -- rms.
2053
{
2054
\catcode`\-=\active \catcode`\_=\active \catcode`\'=\active
2055
%
2056
\global\def\code{\begingroup
2057
\catcode`\-=\active \catcode`\_=\active \catcode`\'=\active
2058
\let'\singlequotechar
2059
\ifallowcodebreaks
2060
\let-\codedash
2061
\let_\codeunder
2062
\else
2063
\let-\realdash
2064
\let_\realunder
2065
\fi
2066
\codex
2067
}
2068
}
2069
2070
\def\realdash{-}
2071
\def\codedash{-\discretionary{}{}{}}
2072
\def\codeunder{%
2073
% this is all so @math{@code{var_name}+1} can work. In math mode, _
2074
% is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2075
% will therefore expand the active definition of _, which is us
2076
% (inside @code that is), therefore an endless loop.
2077
\ifusingtt{\ifmmode
2078
\mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2079
\else\normalunderscore \fi
2080
\discretionary{}{}{}}%
2081
{\_}%
2082
}
2083
\def\codex #1{\tclose{#1}\endgroup}
2084
2085
% An additional complication: the above will allow breaks after, e.g.,
2086
% each of the four underscores in __typeof__. This is undesirable in
2087
% some manuals, especially if they don't have long identifiers in
2088
% general. @allowcodebreaks provides a way to control this.
2089
%
2090
\newif\ifallowcodebreaks \allowcodebreakstrue
2091
2092
\def\keywordtrue{true}
2093
\def\keywordfalse{false}
2094
2095
\parseargdef\allowcodebreaks{%
2096
\def\txiarg{#1}%
2097
\ifx\txiarg\keywordtrue
2098
\allowcodebreakstrue
2099
\else\ifx\txiarg\keywordfalse
2100
\allowcodebreaksfalse
2101
\else
2102
\errhelp = \EMsimple
2103
\errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2104
\fi\fi
2105
}
2106
2107
% @kbd is like @code, except that if the argument is just one @key command,
2108
% then @kbd has no effect.
2109
2110
% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2111
% `example' (@kbd uses ttsl only inside of @example and friends),
2112
% or `code' (@kbd uses normal tty font always).
2113
\parseargdef\kbdinputstyle{%
2114
\def\txiarg{#1}%
2115
\ifx\txiarg\worddistinct
2116
\gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2117
\else\ifx\txiarg\wordexample
2118
\gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2119
\else\ifx\txiarg\wordcode
2120
\gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2121
\else
2122
\errhelp = \EMsimple
2123
\errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2124
\fi\fi\fi
2125
}
2126
\def\worddistinct{distinct}
2127
\def\wordexample{example}
2128
\def\wordcode{code}
2129
2130
% Default is `distinct.'
2131
\kbdinputstyle distinct
2132
2133
\def\xkey{\key}
2134
\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2135
\ifx\one\xkey\ifx\threex\three \key{#2}%
2136
\else{\tclose{\kbdfont\look}}\fi
2137
\else{\tclose{\kbdfont\look}}\fi}
2138
2139
% For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2140
\let\indicateurl=\code
2141
\let\env=\code
2142
\let\command=\code
2143
2144
% @uref (abbreviation for `urlref') takes an optional (comma-separated)
2145
% second argument specifying the text to display and an optional third
2146
% arg as text to display instead of (rather than in addition to) the url
2147
% itself. First (mandatory) arg is the url. Perhaps eventually put in
2148
% a hypertex \special here.
2149
%
2150
\def\uref#1{\douref #1,,,\finish}
2151
\def\douref#1,#2,#3,#4\finish{\begingroup
2152
\unsepspaces
2153
\pdfurl{#1}%
2154
\setbox0 = \hbox{\ignorespaces #3}%
2155
\ifdim\wd0 > 0pt
2156
\unhbox0 % third arg given, show only that
2157
\else
2158
\setbox0 = \hbox{\ignorespaces #2}%
2159
\ifdim\wd0 > 0pt
2160
\ifpdf
2161
\unhbox0 % PDF: 2nd arg given, show only it
2162
\else
2163
\unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2164
\fi
2165
\else
2166
\code{#1}% only url given, so show it
2167
\fi
2168
\fi
2169
\endlink
2170
\endgroup}
2171
2172
% @url synonym for @uref, since that's how everyone uses it.
2173
%
2174
\let\url=\uref
2175
2176
% rms does not like angle brackets --karl, 17may97.
2177
% So now @email is just like @uref, unless we are pdf.
2178
%
2179
%\def\email#1{\angleleft{\tt #1}\angleright}
2180
\ifpdf
2181
\def\email#1{\doemail#1,,\finish}
2182
\def\doemail#1,#2,#3\finish{\begingroup
2183
\unsepspaces
2184
\pdfurl{mailto:#1}%
2185
\setbox0 = \hbox{\ignorespaces #2}%
2186
\ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2187
\endlink
2188
\endgroup}
2189
\else
2190
\let\email=\uref
2191
\fi
2192
2193
% Check if we are currently using a typewriter font. Since all the
2194
% Computer Modern typewriter fonts have zero interword stretch (and
2195
% shrink), and it is reasonable to expect all typewriter fonts to have
2196
% this property, we can check that font parameter.
2197
%
2198
\def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2199
2200
% Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2201
% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2202
%
2203
\def\dmn#1{\thinspace #1}
2204
2205
\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2206
2207
% @l was never documented to mean ``switch to the Lisp font'',
2208
% and it is not used as such in any manual I can find. We need it for
2209
% Polish suppressed-l. --karl, 22sep96.
2210
%\def\l#1{{\li #1}\null}
2211
2212
% Explicit font changes: @r, @sc, undocumented @ii.
2213
\def\r#1{{\rm #1}} % roman font
2214
\def\sc#1{{\smallcaps#1}} % smallcaps font
2215
\def\ii#1{{\it #1}} % italic font
2216
2217
% @acronym for "FBI", "NATO", and the like.
2218
% We print this one point size smaller, since it's intended for
2219
% all-uppercase.
2220
%
2221
\def\acronym#1{\doacronym #1,,\finish}
2222
\def\doacronym#1,#2,#3\finish{%
2223
{\selectfonts\lsize #1}%
2224
\def\temp{#2}%
2225
\ifx\temp\empty \else
2226
\space ({\unsepspaces \ignorespaces \temp \unskip})%
2227
\fi
2228
}
2229
2230
% @abbr for "Comput. J." and the like.
2231
% No font change, but don't do end-of-sentence spacing.
2232
%
2233
\def\abbr#1{\doabbr #1,,\finish}
2234
\def\doabbr#1,#2,#3\finish{%
2235
{\plainfrenchspacing #1}%
2236
\def\temp{#2}%
2237
\ifx\temp\empty \else
2238
\space ({\unsepspaces \ignorespaces \temp \unskip})%
2239
\fi
2240
}
2241
2242
% @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2243
%
2244
\def\pounds{{\it\$}}
2245
2246
% @euro{} comes from a separate font, depending on the current style.
2247
% We use the free feym* fonts from the eurosym package by Henrik
2248
% Theiling, which support regular, slanted, bold and bold slanted (and
2249
% "outlined" (blackboard board, sort of) versions, which we don't need).
2250
% It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2251
%
2252
% Although only regular is the truly official Euro symbol, we ignore
2253
% that. The Euro is designed to be slightly taller than the regular
2254
% font height.
2255
%
2256
% feymr - regular
2257
% feymo - slanted
2258
% feybr - bold
2259
% feybo - bold slanted
2260
%
2261
% There is no good (free) typewriter version, to my knowledge.
2262
% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2263
% Hmm.
2264
%
2265
% Also doesn't work in math. Do we need to do math with euro symbols?
2266
% Hope not.
2267
%
2268
%
2269
\def\euro{{\eurofont e}}
2270
\def\eurofont{%
2271
% We set the font at each command, rather than predefining it in
2272
% \textfonts and the other font-switching commands, so that
2273
% installations which never need the symbol don't have to have the
2274
% font installed.
2275
%
2276
% There is only one designed size (nominal 10pt), so we always scale
2277
% that to the current nominal size.
2278
%
2279
% By the way, simply using "at 1em" works for cmr10 and the like, but
2280
% does not work for cmbx10 and other extended/shrunken fonts.
2281
%
2282
\def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2283
%
2284
\ifx\curfontstyle\bfstylename
2285
% bold:
2286
\font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2287
\else
2288
% regular:
2289
\font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2290
\fi
2291
\thiseurofont
2292
}
2293
2294
% @registeredsymbol - R in a circle. The font for the R should really
2295
% be smaller yet, but lllsize is the best we can do for now.
2296
% Adapted from the plain.tex definition of \copyright.
2297
%
2298
\def\registeredsymbol{%
2299
$^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2300
\hfil\crcr\Orb}}%
2301
}$%
2302
}
2303
2304
% Laurent Siebenmann reports \Orb undefined with:
2305
% Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2306
% so we'll define it if necessary.
2307
%
2308
\ifx\Orb\undefined
2309
\def\Orb{\mathhexbox20D}
2310
\fi
2311
2312
2313
\message{page headings,}
2314
2315
\newskip\titlepagetopglue \titlepagetopglue = 1.5in
2316
\newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2317
2318
% First the title page. Must do @settitle before @titlepage.
2319
\newif\ifseenauthor
2320
\newif\iffinishedtitlepage
2321
2322
% Do an implicit @contents or @shortcontents after @end titlepage if the
2323
% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2324
%
2325
\newif\ifsetcontentsaftertitlepage
2326
\let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2327
\newif\ifsetshortcontentsaftertitlepage
2328
\let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2329
2330
\parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2331
\endgroup\page\hbox{}\page}
2332
2333
\envdef\titlepage{%
2334
% Open one extra group, as we want to close it in the middle of \Etitlepage.
2335
\begingroup
2336
\parindent=0pt \textfonts
2337
% Leave some space at the very top of the page.
2338
\vglue\titlepagetopglue
2339
% No rule at page bottom unless we print one at the top with @title.
2340
\finishedtitlepagetrue
2341
%
2342
% Most title ``pages'' are actually two pages long, with space
2343
% at the top of the second. We don't want the ragged left on the second.
2344
\let\oldpage = \page
2345
\def\page{%
2346
\iffinishedtitlepage\else
2347
\finishtitlepage
2348
\fi
2349
\let\page = \oldpage
2350
\page
2351
\null
2352
}%
2353
}
2354
2355
\def\Etitlepage{%
2356
\iffinishedtitlepage\else
2357
\finishtitlepage
2358
\fi
2359
% It is important to do the page break before ending the group,
2360
% because the headline and footline are only empty inside the group.
2361
% If we use the new definition of \page, we always get a blank page
2362
% after the title page, which we certainly don't want.
2363
\oldpage
2364
\endgroup
2365
%
2366
% Need this before the \...aftertitlepage checks so that if they are
2367
% in effect the toc pages will come out with page numbers.
2368
\HEADINGSon
2369
%
2370
% If they want short, they certainly want long too.
2371
\ifsetshortcontentsaftertitlepage
2372
\shortcontents
2373
\contents
2374
\global\let\shortcontents = \relax
2375
\global\let\contents = \relax
2376
\fi
2377
%
2378
\ifsetcontentsaftertitlepage
2379
\contents
2380
\global\let\contents = \relax
2381
\global\let\shortcontents = \relax
2382
\fi
2383
}
2384
2385
\def\finishtitlepage{%
2386
\vskip4pt \hrule height 2pt width \hsize
2387
\vskip\titlepagebottomglue
2388
\finishedtitlepagetrue
2389
}
2390
2391
%%% Macros to be used within @titlepage:
2392
2393
\let\subtitlerm=\tenrm
2394
\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2395
2396
\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2397
\let\tt=\authortt}
2398
2399
\parseargdef\title{%
2400
\checkenv\titlepage
2401
\leftline{\titlefonts\rm #1}
2402
% print a rule at the page bottom also.
2403
\finishedtitlepagefalse
2404
\vskip4pt \hrule height 4pt width \hsize \vskip4pt
2405
}
2406
2407
\parseargdef\subtitle{%
2408
\checkenv\titlepage
2409
{\subtitlefont \rightline{#1}}%
2410
}
2411
2412
% @author should come last, but may come many times.
2413
% It can also be used inside @quotation.
2414
%
2415
\parseargdef\author{%
2416
\def\temp{\quotation}%
2417
\ifx\thisenv\temp
2418
\def\quotationauthor{#1}% printed in \Equotation.
2419
\else
2420
\checkenv\titlepage
2421
\ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2422
{\authorfont \leftline{#1}}%
2423
\fi
2424
}
2425
2426
2427
%%% Set up page headings and footings.
2428
2429
\let\thispage=\folio
2430
2431
\newtoks\evenheadline % headline on even pages
2432
\newtoks\oddheadline % headline on odd pages
2433
\newtoks\evenfootline % footline on even pages
2434
\newtoks\oddfootline % footline on odd pages
2435
2436
% Now make TeX use those variables
2437
\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2438
\else \the\evenheadline \fi}}
2439
\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2440
\else \the\evenfootline \fi}\HEADINGShook}
2441
\let\HEADINGShook=\relax
2442
2443
% Commands to set those variables.
2444
% For example, this is what @headings on does
2445
% @evenheading @thistitle|@thispage|@thischapter
2446
% @oddheading @thischapter|@thispage|@thistitle
2447
% @evenfooting @thisfile||
2448
% @oddfooting ||@thisfile
2449
2450
2451
\def\evenheading{\parsearg\evenheadingxxx}
2452
\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2453
\def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2454
\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2455
2456
\def\oddheading{\parsearg\oddheadingxxx}
2457
\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2458
\def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2459
\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2460
2461
\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2462
2463
\def\evenfooting{\parsearg\evenfootingxxx}
2464
\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2465
\def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2466
\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2467
2468
\def\oddfooting{\parsearg\oddfootingxxx}
2469
\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2470
\def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2471
\global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2472
%
2473
% Leave some space for the footline. Hopefully ok to assume
2474
% @evenfooting will not be used by itself.
2475
\global\advance\pageheight by -12pt
2476
\global\advance\vsize by -12pt
2477
}
2478
2479
\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2480
2481
2482
% @headings double turns headings on for double-sided printing.
2483
% @headings single turns headings on for single-sided printing.
2484
% @headings off turns them off.
2485
% @headings on same as @headings double, retained for compatibility.
2486
% @headings after turns on double-sided headings after this page.
2487
% @headings doubleafter turns on double-sided headings after this page.
2488
% @headings singleafter turns on single-sided headings after this page.
2489
% By default, they are off at the start of a document,
2490
% and turned `on' after @end titlepage.
2491
2492
\def\headings #1 {\csname HEADINGS#1\endcsname}
2493
2494
\def\HEADINGSoff{%
2495
\global\evenheadline={\hfil} \global\evenfootline={\hfil}
2496
\global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2497
\HEADINGSoff
2498
% When we turn headings on, set the page number to 1.
2499
% For double-sided printing, put current file name in lower left corner,
2500
% chapter name on inside top of right hand pages, document
2501
% title on inside top of left hand pages, and page numbers on outside top
2502
% edge of all pages.
2503
\def\HEADINGSdouble{%
2504
\global\pageno=1
2505
\global\evenfootline={\hfil}
2506
\global\oddfootline={\hfil}
2507
\global\evenheadline={\line{\folio\hfil\thistitle}}
2508
\global\oddheadline={\line{\thischapter\hfil\folio}}
2509
\global\let\contentsalignmacro = \chapoddpage
2510
}
2511
\let\contentsalignmacro = \chappager
2512
2513
% For single-sided printing, chapter title goes across top left of page,
2514
% page number on top right.
2515
\def\HEADINGSsingle{%
2516
\global\pageno=1
2517
\global\evenfootline={\hfil}
2518
\global\oddfootline={\hfil}
2519
\global\evenheadline={\line{\thischapter\hfil\folio}}
2520
\global\oddheadline={\line{\thischapter\hfil\folio}}
2521
\global\let\contentsalignmacro = \chappager
2522
}
2523
\def\HEADINGSon{\HEADINGSdouble}
2524
2525
\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2526
\let\HEADINGSdoubleafter=\HEADINGSafter
2527
\def\HEADINGSdoublex{%
2528
\global\evenfootline={\hfil}
2529
\global\oddfootline={\hfil}
2530
\global\evenheadline={\line{\folio\hfil\thistitle}}
2531
\global\oddheadline={\line{\thischapter\hfil\folio}}
2532
\global\let\contentsalignmacro = \chapoddpage
2533
}
2534
2535
\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2536
\def\HEADINGSsinglex{%
2537
\global\evenfootline={\hfil}
2538
\global\oddfootline={\hfil}
2539
\global\evenheadline={\line{\thischapter\hfil\folio}}
2540
\global\oddheadline={\line{\thischapter\hfil\folio}}
2541
\global\let\contentsalignmacro = \chappager
2542
}
2543
2544
% Subroutines used in generating headings
2545
% This produces Day Month Year style of output.
2546
% Only define if not already defined, in case a txi-??.tex file has set
2547
% up a different format (e.g., txi-cs.tex does this).
2548
\ifx\today\undefined
2549
\def\today{%
2550
\number\day\space
2551
\ifcase\month
2552
\or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2553
\or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2554
\or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2555
\fi
2556
\space\number\year}
2557
\fi
2558
2559
% @settitle line... specifies the title of the document, for headings.
2560
% It generates no output of its own.
2561
\def\thistitle{\putwordNoTitle}
2562
\def\settitle{\parsearg{\gdef\thistitle}}
2563
2564
2565
\message{tables,}
2566
% Tables -- @table, @ftable, @vtable, @item(x).
2567
2568
% default indentation of table text
2569
\newdimen\tableindent \tableindent=.8in
2570
% default indentation of @itemize and @enumerate text
2571
\newdimen\itemindent \itemindent=.3in
2572
% margin between end of table item and start of table text.
2573
\newdimen\itemmargin \itemmargin=.1in
2574
2575
% used internally for \itemindent minus \itemmargin
2576
\newdimen\itemmax
2577
2578
% Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2579
% these defs.
2580
% They also define \itemindex
2581
% to index the item name in whatever manner is desired (perhaps none).
2582
2583
\newif\ifitemxneedsnegativevskip
2584
2585
\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2586
2587
\def\internalBitem{\smallbreak \parsearg\itemzzz}
2588
\def\internalBitemx{\itemxpar \parsearg\itemzzz}
2589
2590
\def\itemzzz #1{\begingroup %
2591
\advance\hsize by -\rightskip
2592
\advance\hsize by -\tableindent
2593
\setbox0=\hbox{\itemindicate{#1}}%
2594
\itemindex{#1}%
2595
\nobreak % This prevents a break before @itemx.
2596
%
2597
% If the item text does not fit in the space we have, put it on a line
2598
% by itself, and do not allow a page break either before or after that
2599
% line. We do not start a paragraph here because then if the next
2600
% command is, e.g., @kindex, the whatsit would get put into the
2601
% horizontal list on a line by itself, resulting in extra blank space.
2602
\ifdim \wd0>\itemmax
2603
%
2604
% Make this a paragraph so we get the \parskip glue and wrapping,
2605
% but leave it ragged-right.
2606
\begingroup
2607
\advance\leftskip by-\tableindent
2608
\advance\hsize by\tableindent
2609
\advance\rightskip by0pt plus1fil
2610
\leavevmode\unhbox0\par
2611
\endgroup
2612
%
2613
% We're going to be starting a paragraph, but we don't want the
2614
% \parskip glue -- logically it's part of the @item we just started.
2615
\nobreak \vskip-\parskip
2616
%
2617
% Stop a page break at the \parskip glue coming up. However, if
2618
% what follows is an environment such as @example, there will be no
2619
% \parskip glue; then the negative vskip we just inserted would
2620
% cause the example and the item to crash together. So we use this
2621
% bizarre value of 10001 as a signal to \aboveenvbreak to insert
2622
% \parskip glue after all. Section titles are handled this way also.
2623
%
2624
\penalty 10001
2625
\endgroup
2626
\itemxneedsnegativevskipfalse
2627
\else
2628
% The item text fits into the space. Start a paragraph, so that the
2629
% following text (if any) will end up on the same line.
2630
\noindent
2631
% Do this with kerns and \unhbox so that if there is a footnote in
2632
% the item text, it can migrate to the main vertical list and
2633
% eventually be printed.
2634
\nobreak\kern-\tableindent
2635
\dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2636
\unhbox0
2637
\nobreak\kern\dimen0
2638
\endgroup
2639
\itemxneedsnegativevskiptrue
2640
\fi
2641
}
2642
2643
\def\item{\errmessage{@item while not in a list environment}}
2644
\def\itemx{\errmessage{@itemx while not in a list environment}}
2645
2646
% @table, @ftable, @vtable.
2647
\envdef\table{%
2648
\let\itemindex\gobble
2649
\tablecheck{table}%
2650
}
2651
\envdef\ftable{%
2652
\def\itemindex ##1{\doind {fn}{\code{##1}}}%
2653
\tablecheck{ftable}%
2654
}
2655
\envdef\vtable{%
2656
\def\itemindex ##1{\doind {vr}{\code{##1}}}%
2657
\tablecheck{vtable}%
2658
}
2659
\def\tablecheck#1{%
2660
\ifnum \the\catcode`\^^M=\active
2661
\endgroup
2662
\errmessage{This command won't work in this context; perhaps the problem is
2663
that we are \inenvironment\thisenv}%
2664
\def\next{\doignore{#1}}%
2665
\else
2666
\let\next\tablex
2667
\fi
2668
\next
2669
}
2670
\def\tablex#1{%
2671
\def\itemindicate{#1}%
2672
\parsearg\tabley
2673
}
2674
\def\tabley#1{%
2675
{%
2676
\makevalueexpandable
2677
\edef\temp{\noexpand\tablez #1\space\space\space}%
2678
\expandafter
2679
}\temp \endtablez
2680
}
2681
\def\tablez #1 #2 #3 #4\endtablez{%
2682
\aboveenvbreak
2683
\ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2684
\ifnum 0#2>0 \tableindent=#2\mil \fi
2685
\ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2686
\itemmax=\tableindent
2687
\advance \itemmax by -\itemmargin
2688
\advance \leftskip by \tableindent
2689
\exdentamount=\tableindent
2690
\parindent = 0pt
2691
\parskip = \smallskipamount
2692
\ifdim \parskip=0pt \parskip=2pt \fi
2693
\let\item = \internalBitem
2694
\let\itemx = \internalBitemx
2695
}
2696
\def\Etable{\endgraf\afterenvbreak}
2697
\let\Eftable\Etable
2698
\let\Evtable\Etable
2699
\let\Eitemize\Etable
2700
\let\Eenumerate\Etable
2701
2702
% This is the counter used by @enumerate, which is really @itemize
2703
2704
\newcount \itemno
2705
2706
\envdef\itemize{\parsearg\doitemize}
2707
2708
\def\doitemize#1{%
2709
\aboveenvbreak
2710
\itemmax=\itemindent
2711
\advance\itemmax by -\itemmargin
2712
\advance\leftskip by \itemindent
2713
\exdentamount=\itemindent
2714
\parindent=0pt
2715
\parskip=\smallskipamount
2716
\ifdim\parskip=0pt \parskip=2pt \fi
2717
\def\itemcontents{#1}%
2718
% @itemize with no arg is equivalent to @itemize @bullet.
2719
\ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2720
\let\item=\itemizeitem
2721
}
2722
2723
% Definition of @item while inside @itemize and @enumerate.
2724
%
2725
\def\itemizeitem{%
2726
\advance\itemno by 1 % for enumerations
2727
{\let\par=\endgraf \smallbreak}% reasonable place to break
2728
{%
2729
% If the document has an @itemize directly after a section title, a
2730
% \nobreak will be last on the list, and \sectionheading will have
2731
% done a \vskip-\parskip. In that case, we don't want to zero
2732
% parskip, or the item text will crash with the heading. On the
2733
% other hand, when there is normal text preceding the item (as there
2734
% usually is), we do want to zero parskip, or there would be too much
2735
% space. In that case, we won't have a \nobreak before. At least
2736
% that's the theory.
2737
\ifnum\lastpenalty<10000 \parskip=0in \fi
2738
\noindent
2739
\hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2740
\vadjust{\penalty 1200}}% not good to break after first line of item.
2741
\flushcr
2742
}
2743
2744
% \splitoff TOKENS\endmark defines \first to be the first token in
2745
% TOKENS, and \rest to be the remainder.
2746
%
2747
\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2748
2749
% Allow an optional argument of an uppercase letter, lowercase letter,
2750
% or number, to specify the first label in the enumerated list. No
2751
% argument is the same as `1'.
2752
%
2753
\envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2754
\def\enumeratey #1 #2\endenumeratey{%
2755
% If we were given no argument, pretend we were given `1'.
2756
\def\thearg{#1}%
2757
\ifx\thearg\empty \def\thearg{1}\fi
2758
%
2759
% Detect if the argument is a single token. If so, it might be a
2760
% letter. Otherwise, the only valid thing it can be is a number.
2761
% (We will always have one token, because of the test we just made.
2762
% This is a good thing, since \splitoff doesn't work given nothing at
2763
% all -- the first parameter is undelimited.)
2764
\expandafter\splitoff\thearg\endmark
2765
\ifx\rest\empty
2766
% Only one token in the argument. It could still be anything.
2767
% A ``lowercase letter'' is one whose \lccode is nonzero.
2768
% An ``uppercase letter'' is one whose \lccode is both nonzero, and
2769
% not equal to itself.
2770
% Otherwise, we assume it's a number.
2771
%
2772
% We need the \relax at the end of the \ifnum lines to stop TeX from
2773
% continuing to look for a <number>.
2774
%
2775
\ifnum\lccode\expandafter`\thearg=0\relax
2776
\numericenumerate % a number (we hope)
2777
\else
2778
% It's a letter.
2779
\ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2780
\lowercaseenumerate % lowercase letter
2781
\else
2782
\uppercaseenumerate % uppercase letter
2783
\fi
2784
\fi
2785
\else
2786
% Multiple tokens in the argument. We hope it's a number.
2787
\numericenumerate
2788
\fi
2789
}
2790
2791
% An @enumerate whose labels are integers. The starting integer is
2792
% given in \thearg.
2793
%
2794
\def\numericenumerate{%
2795
\itemno = \thearg
2796
\startenumeration{\the\itemno}%
2797
}
2798
2799
% The starting (lowercase) letter is in \thearg.
2800
\def\lowercaseenumerate{%
2801
\itemno = \expandafter`\thearg
2802
\startenumeration{%
2803
% Be sure we're not beyond the end of the alphabet.
2804
\ifnum\itemno=0
2805
\errmessage{No more lowercase letters in @enumerate; get a bigger
2806
alphabet}%
2807
\fi
2808
\char\lccode\itemno
2809
}%
2810
}
2811
2812
% The starting (uppercase) letter is in \thearg.
2813
\def\uppercaseenumerate{%
2814
\itemno = \expandafter`\thearg
2815
\startenumeration{%
2816
% Be sure we're not beyond the end of the alphabet.
2817
\ifnum\itemno=0
2818
\errmessage{No more uppercase letters in @enumerate; get a bigger
2819
alphabet}
2820
\fi
2821
\char\uccode\itemno
2822
}%
2823
}
2824
2825
% Call \doitemize, adding a period to the first argument and supplying the
2826
% common last two arguments. Also subtract one from the initial value in
2827
% \itemno, since @item increments \itemno.
2828
%
2829
\def\startenumeration#1{%
2830
\advance\itemno by -1
2831
\doitemize{#1.}\flushcr
2832
}
2833
2834
% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2835
% to @enumerate.
2836
%
2837
\def\alphaenumerate{\enumerate{a}}
2838
\def\capsenumerate{\enumerate{A}}
2839
\def\Ealphaenumerate{\Eenumerate}
2840
\def\Ecapsenumerate{\Eenumerate}
2841
2842
2843
% @multitable macros
2844
% Amy Hendrickson, 8/18/94, 3/6/96
2845
%
2846
% @multitable ... @end multitable will make as many columns as desired.
2847
% Contents of each column will wrap at width given in preamble. Width
2848
% can be specified either with sample text given in a template line,
2849
% or in percent of \hsize, the current width of text on page.
2850
2851
% Table can continue over pages but will only break between lines.
2852
2853
% To make preamble:
2854
%
2855
% Either define widths of columns in terms of percent of \hsize:
2856
% @multitable @columnfractions .25 .3 .45
2857
% @item ...
2858
%
2859
% Numbers following @columnfractions are the percent of the total
2860
% current hsize to be used for each column. You may use as many
2861
% columns as desired.
2862
2863
2864
% Or use a template:
2865
% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2866
% @item ...
2867
% using the widest term desired in each column.
2868
2869
% Each new table line starts with @item, each subsequent new column
2870
% starts with @tab. Empty columns may be produced by supplying @tab's
2871
% with nothing between them for as many times as empty columns are needed,
2872
% ie, @tab@tab@tab will produce two empty columns.
2873
2874
% @item, @tab do not need to be on their own lines, but it will not hurt
2875
% if they are.
2876
2877
% Sample multitable:
2878
2879
% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2880
% @item first col stuff @tab second col stuff @tab third col
2881
% @item
2882
% first col stuff
2883
% @tab
2884
% second col stuff
2885
% @tab
2886
% third col
2887
% @item first col stuff @tab second col stuff
2888
% @tab Many paragraphs of text may be used in any column.
2889
%
2890
% They will wrap at the width determined by the template.
2891
% @item@tab@tab This will be in third column.
2892
% @end multitable
2893
2894
% Default dimensions may be reset by user.
2895
% @multitableparskip is vertical space between paragraphs in table.
2896
% @multitableparindent is paragraph indent in table.
2897
% @multitablecolmargin is horizontal space to be left between columns.
2898
% @multitablelinespace is space to leave between table items, baseline
2899
% to baseline.
2900
% 0pt means it depends on current normal line spacing.
2901
%
2902
\newskip\multitableparskip
2903
\newskip\multitableparindent
2904
\newdimen\multitablecolspace
2905
\newskip\multitablelinespace
2906
\multitableparskip=0pt
2907
\multitableparindent=6pt
2908
\multitablecolspace=12pt
2909
\multitablelinespace=0pt
2910
2911
% Macros used to set up halign preamble:
2912
%
2913
\let\endsetuptable\relax
2914
\def\xendsetuptable{\endsetuptable}
2915
\let\columnfractions\relax
2916
\def\xcolumnfractions{\columnfractions}
2917
\newif\ifsetpercent
2918
2919
% #1 is the @columnfraction, usually a decimal number like .5, but might
2920
% be just 1. We just use it, whatever it is.
2921
%
2922
\def\pickupwholefraction#1 {%
2923
\global\advance\colcount by 1
2924
\expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2925
\setuptable
2926
}
2927
2928
\newcount\colcount
2929
\def\setuptable#1{%
2930
\def\firstarg{#1}%
2931
\ifx\firstarg\xendsetuptable
2932
\let\go = \relax
2933
\else
2934
\ifx\firstarg\xcolumnfractions
2935
\global\setpercenttrue
2936
\else
2937
\ifsetpercent
2938
\let\go\pickupwholefraction
2939
\else
2940
\global\advance\colcount by 1
2941
\setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2942
% separator; typically that is always in the input, anyway.
2943
\expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2944
\fi
2945
\fi
2946
\ifx\go\pickupwholefraction
2947
% Put the argument back for the \pickupwholefraction call, so
2948
% we'll always have a period there to be parsed.
2949
\def\go{\pickupwholefraction#1}%
2950
\else
2951
\let\go = \setuptable
2952
\fi%
2953
\fi
2954
\go
2955
}
2956
2957
% multitable-only commands.
2958
%
2959
% @headitem starts a heading row, which we typeset in bold.
2960
% Assignments have to be global since we are inside the implicit group
2961
% of an alignment entry. Note that \everycr resets \everytab.
2962
\def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2963
%
2964
% A \tab used to include \hskip1sp. But then the space in a template
2965
% line is not enough. That is bad. So let's go back to just `&' until
2966
% we encounter the problem it was intended to solve again.
2967
% --karl, nathan@acm.org, 20apr99.
2968
\def\tab{\checkenv\multitable &\the\everytab}%
2969
2970
% @multitable ... @end multitable definitions:
2971
%
2972
\newtoks\everytab % insert after every tab.
2973
%
2974
\envdef\multitable{%
2975
\vskip\parskip
2976
\startsavinginserts
2977
%
2978
% @item within a multitable starts a normal row.
2979
% We use \def instead of \let so that if one of the multitable entries
2980
% contains an @itemize, we don't choke on the \item (seen as \crcr aka
2981
% \endtemplate) expanding \doitemize.
2982
\def\item{\crcr}%
2983
%
2984
\tolerance=9500
2985
\hbadness=9500
2986
\setmultitablespacing
2987
\parskip=\multitableparskip
2988
\parindent=\multitableparindent
2989
\overfullrule=0pt
2990
\global\colcount=0
2991
%
2992
\everycr = {%
2993
\noalign{%
2994
\global\everytab={}%
2995
\global\colcount=0 % Reset the column counter.
2996
% Check for saved footnotes, etc.
2997
\checkinserts
2998
% Keeps underfull box messages off when table breaks over pages.
2999
%\filbreak
3000
% Maybe so, but it also creates really weird page breaks when the
3001
% table breaks over pages. Wouldn't \vfil be better? Wait until the
3002
% problem manifests itself, so it can be fixed for real --karl.
3003
}%
3004
}%
3005
%
3006
\parsearg\domultitable
3007
}
3008
\def\domultitable#1{%
3009
% To parse everything between @multitable and @item:
3010
\setuptable#1 \endsetuptable
3011
%
3012
% This preamble sets up a generic column definition, which will
3013
% be used as many times as user calls for columns.
3014
% \vtop will set a single line and will also let text wrap and
3015
% continue for many paragraphs if desired.
3016
\halign\bgroup &%
3017
\global\advance\colcount by 1
3018
\multistrut
3019
\vtop{%
3020
% Use the current \colcount to find the correct column width:
3021
\hsize=\expandafter\csname col\the\colcount\endcsname
3022
%
3023
% In order to keep entries from bumping into each other
3024
% we will add a \leftskip of \multitablecolspace to all columns after
3025
% the first one.
3026
%
3027
% If a template has been used, we will add \multitablecolspace
3028
% to the width of each template entry.
3029
%
3030
% If the user has set preamble in terms of percent of \hsize we will
3031
% use that dimension as the width of the column, and the \leftskip
3032
% will keep entries from bumping into each other. Table will start at
3033
% left margin and final column will justify at right margin.
3034
%
3035
% Make sure we don't inherit \rightskip from the outer environment.
3036
\rightskip=0pt
3037
\ifnum\colcount=1
3038
% The first column will be indented with the surrounding text.
3039
\advance\hsize by\leftskip
3040
\else
3041
\ifsetpercent \else
3042
% If user has not set preamble in terms of percent of \hsize
3043
% we will advance \hsize by \multitablecolspace.
3044
\advance\hsize by \multitablecolspace
3045
\fi
3046
% In either case we will make \leftskip=\multitablecolspace:
3047
\leftskip=\multitablecolspace
3048
\fi
3049
% Ignoring space at the beginning and end avoids an occasional spurious
3050
% blank line, when TeX decides to break the line at the space before the
3051
% box from the multistrut, so the strut ends up on a line by itself.
3052
% For example:
3053
% @multitable @columnfractions .11 .89
3054
% @item @code{#}
3055
% @tab Legal holiday which is valid in major parts of the whole country.
3056
% Is automatically provided with highlighting sequences respectively
3057
% marking characters.
3058
\noindent\ignorespaces##\unskip\multistrut
3059
}\cr
3060
}
3061
\def\Emultitable{%
3062
\crcr
3063
\egroup % end the \halign
3064
\global\setpercentfalse
3065
}
3066
3067
\def\setmultitablespacing{%
3068
\def\multistrut{\strut}% just use the standard line spacing
3069
%
3070
% Compute \multitablelinespace (if not defined by user) for use in
3071
% \multitableparskip calculation. We used define \multistrut based on
3072
% this, but (ironically) that caused the spacing to be off.
3073
% See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3074
\ifdim\multitablelinespace=0pt
3075
\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3076
\global\advance\multitablelinespace by-\ht0
3077
\fi
3078
%% Test to see if parskip is larger than space between lines of
3079
%% table. If not, do nothing.
3080
%% If so, set to same dimension as multitablelinespace.
3081
\ifdim\multitableparskip>\multitablelinespace
3082
\global\multitableparskip=\multitablelinespace
3083
\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3084
%% than skip between lines in the table.
3085
\fi%
3086
\ifdim\multitableparskip=0pt
3087
\global\multitableparskip=\multitablelinespace
3088
\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3089
%% than skip between lines in the table.
3090
\fi}
3091
3092
3093
\message{conditionals,}
3094
3095
% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3096
% @ifnotxml always succeed. They currently do nothing; we don't
3097
% attempt to check whether the conditionals are properly nested. But we
3098
% have to remember that they are conditionals, so that @end doesn't
3099
% attempt to close an environment group.
3100
%
3101
\def\makecond#1{%
3102
\expandafter\let\csname #1\endcsname = \relax
3103
\expandafter\let\csname iscond.#1\endcsname = 1
3104
}
3105
\makecond{iftex}
3106
\makecond{ifnotdocbook}
3107
\makecond{ifnothtml}
3108
\makecond{ifnotinfo}
3109
\makecond{ifnotplaintext}
3110
\makecond{ifnotxml}
3111
3112
% Ignore @ignore, @ifhtml, @ifinfo, and the like.
3113
%
3114
\def\direntry{\doignore{direntry}}
3115
\def\documentdescription{\doignore{documentdescription}}
3116
\def\docbook{\doignore{docbook}}
3117
\def\html{\doignore{html}}
3118
\def\ifdocbook{\doignore{ifdocbook}}
3119
\def\ifhtml{\doignore{ifhtml}}
3120
\def\ifinfo{\doignore{ifinfo}}
3121
\def\ifnottex{\doignore{ifnottex}}
3122
\def\ifplaintext{\doignore{ifplaintext}}
3123
\def\ifxml{\doignore{ifxml}}
3124
\def\ignore{\doignore{ignore}}
3125
\def\menu{\doignore{menu}}
3126
\def\xml{\doignore{xml}}
3127
3128
% Ignore text until a line `@end #1', keeping track of nested conditionals.
3129
%
3130
% A count to remember the depth of nesting.
3131
\newcount\doignorecount
3132
3133
\def\doignore#1{\begingroup
3134
% Scan in ``verbatim'' mode:
3135
\obeylines
3136
\catcode`\@ = \other
3137
\catcode`\{ = \other
3138
\catcode`\} = \other
3139
%
3140
% Make sure that spaces turn into tokens that match what \doignoretext wants.
3141
\spaceisspace
3142
%
3143
% Count number of #1's that we've seen.
3144
\doignorecount = 0
3145
%
3146
% Swallow text until we reach the matching `@end #1'.
3147
\dodoignore{#1}%
3148
}
3149
3150
{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3151
\obeylines %
3152
%
3153
\gdef\dodoignore#1{%
3154
% #1 contains the command name as a string, e.g., `ifinfo'.
3155
%
3156
% Define a command to find the next `@end #1'.
3157
\long\def\doignoretext##1^^M@end #1{%
3158
\doignoretextyyy##1^^M@#1\_STOP_}%
3159
%
3160
% And this command to find another #1 command, at the beginning of a
3161
% line. (Otherwise, we would consider a line `@c @ifset', for
3162
% example, to count as an @ifset for nesting.)
3163
\long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3164
%
3165
% And now expand that command.
3166
\doignoretext ^^M%
3167
}%
3168
}
3169
3170
\def\doignoreyyy#1{%
3171
\def\temp{#1}%
3172
\ifx\temp\empty % Nothing found.
3173
\let\next\doignoretextzzz
3174
\else % Found a nested condition, ...
3175
\advance\doignorecount by 1
3176
\let\next\doignoretextyyy % ..., look for another.
3177
% If we're here, #1 ends with ^^M\ifinfo (for example).
3178
\fi
3179
\next #1% the token \_STOP_ is present just after this macro.
3180
}
3181
3182
% We have to swallow the remaining "\_STOP_".
3183
%
3184
\def\doignoretextzzz#1{%
3185
\ifnum\doignorecount = 0 % We have just found the outermost @end.
3186
\let\next\enddoignore
3187
\else % Still inside a nested condition.
3188
\advance\doignorecount by -1
3189
\let\next\doignoretext % Look for the next @end.
3190
\fi
3191
\next
3192
}
3193
3194
% Finish off ignored text.
3195
{ \obeylines%
3196
% Ignore anything after the last `@end #1'; this matters in verbatim
3197
% environments, where otherwise the newline after an ignored conditional
3198
% would result in a blank line in the output.
3199
\gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3200
}
3201
3202
3203
% @set VAR sets the variable VAR to an empty value.
3204
% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3205
%
3206
% Since we want to separate VAR from REST-OF-LINE (which might be
3207
% empty), we can't just use \parsearg; we have to insert a space of our
3208
% own to delimit the rest of the line, and then take it out again if we
3209
% didn't need it.
3210
% We rely on the fact that \parsearg sets \catcode`\ =10.
3211
%
3212
\parseargdef\set{\setyyy#1 \endsetyyy}
3213
\def\setyyy#1 #2\endsetyyy{%
3214
{%
3215
\makevalueexpandable
3216
\def\temp{#2}%
3217
\edef\next{\gdef\makecsname{SET#1}}%
3218
\ifx\temp\empty
3219
\next{}%
3220
\else
3221
\setzzz#2\endsetzzz
3222
\fi
3223
}%
3224
}
3225
% Remove the trailing space \setxxx inserted.
3226
\def\setzzz#1 \endsetzzz{\next{#1}}
3227
3228
% @clear VAR clears (i.e., unsets) the variable VAR.
3229
%
3230
\parseargdef\clear{%
3231
{%
3232
\makevalueexpandable
3233
\global\expandafter\let\csname SET#1\endcsname=\relax
3234
}%
3235
}
3236
3237
% @value{foo} gets the text saved in variable foo.
3238
\def\value{\begingroup\makevalueexpandable\valuexxx}
3239
\def\valuexxx#1{\expandablevalue{#1}\endgroup}
3240
{
3241
\catcode`\- = \active \catcode`\_ = \active
3242
%
3243
\gdef\makevalueexpandable{%
3244
\let\value = \expandablevalue
3245
% We don't want these characters active, ...
3246
\catcode`\-=\other \catcode`\_=\other
3247
% ..., but we might end up with active ones in the argument if
3248
% we're called from @code, as @code{@value{foo-bar_}}, though.
3249
% So \let them to their normal equivalents.
3250
\let-\realdash \let_\normalunderscore
3251
}
3252
}
3253
3254
% We have this subroutine so that we can handle at least some @value's
3255
% properly in indexes (we call \makevalueexpandable in \indexdummies).
3256
% The command has to be fully expandable (if the variable is set), since
3257
% the result winds up in the index file. This means that if the
3258
% variable's value contains other Texinfo commands, it's almost certain
3259
% it will fail (although perhaps we could fix that with sufficient work
3260
% to do a one-level expansion on the result, instead of complete).
3261
%
3262
\def\expandablevalue#1{%
3263
\expandafter\ifx\csname SET#1\endcsname\relax
3264
{[No value for ``#1'']}%
3265
\message{Variable `#1', used in @value, is not set.}%
3266
\else
3267
\csname SET#1\endcsname
3268
\fi
3269
}
3270
3271
% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3272
% with @set.
3273
%
3274
% To get special treatment of `@end ifset,' call \makeond and the redefine.
3275
%
3276
\makecond{ifset}
3277
\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3278
\def\doifset#1#2{%
3279
{%
3280
\makevalueexpandable
3281
\let\next=\empty
3282
\expandafter\ifx\csname SET#2\endcsname\relax
3283
#1% If not set, redefine \next.
3284
\fi
3285
\expandafter
3286
}\next
3287
}
3288
\def\ifsetfail{\doignore{ifset}}
3289
3290
% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3291
% defined with @set, or has been undefined with @clear.
3292
%
3293
% The `\else' inside the `\doifset' parameter is a trick to reuse the
3294
% above code: if the variable is not set, do nothing, if it is set,
3295
% then redefine \next to \ifclearfail.
3296
%
3297
\makecond{ifclear}
3298
\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3299
\def\ifclearfail{\doignore{ifclear}}
3300
3301
% @dircategory CATEGORY -- specify a category of the dir file
3302
% which this file should belong to. Ignore this in TeX.
3303
\let\dircategory=\comment
3304
3305
% @defininfoenclose.
3306
\let\definfoenclose=\comment
3307
3308
3309
\message{indexing,}
3310
% Index generation facilities
3311
3312
% Define \newwrite to be identical to plain tex's \newwrite
3313
% except not \outer, so it can be used within macros and \if's.
3314
\edef\newwrite{\makecsname{ptexnewwrite}}
3315
3316
% \newindex {foo} defines an index named foo.
3317
% It automatically defines \fooindex such that
3318
% \fooindex ...rest of line... puts an entry in the index foo.
3319
% It also defines \fooindfile to be the number of the output channel for
3320
% the file that accumulates this index. The file's extension is foo.
3321
% The name of an index should be no more than 2 characters long
3322
% for the sake of vms.
3323
%
3324
\def\newindex#1{%
3325
\iflinks
3326
\expandafter\newwrite \csname#1indfile\endcsname
3327
\openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3328
\fi
3329
\expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3330
\noexpand\doindex{#1}}
3331
}
3332
3333
% @defindex foo == \newindex{foo}
3334
%
3335
\def\defindex{\parsearg\newindex}
3336
3337
% Define @defcodeindex, like @defindex except put all entries in @code.
3338
%
3339
\def\defcodeindex{\parsearg\newcodeindex}
3340
%
3341
\def\newcodeindex#1{%
3342
\iflinks
3343
\expandafter\newwrite \csname#1indfile\endcsname
3344
\openout \csname#1indfile\endcsname \jobname.#1
3345
\fi
3346
\expandafter\xdef\csname#1index\endcsname{%
3347
\noexpand\docodeindex{#1}}%
3348
}
3349
3350
3351
% @synindex foo bar makes index foo feed into index bar.
3352
% Do this instead of @defindex foo if you don't want it as a separate index.
3353
%
3354
% @syncodeindex foo bar similar, but put all entries made for index foo
3355
% inside @code.
3356
%
3357
\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3358
\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3359
3360
% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3361
% #3 the target index (bar).
3362
\def\dosynindex#1#2#3{%
3363
% Only do \closeout if we haven't already done it, else we'll end up
3364
% closing the target index.
3365
\expandafter \ifx\csname donesynindex#2\endcsname \undefined
3366
% The \closeout helps reduce unnecessary open files; the limit on the
3367
% Acorn RISC OS is a mere 16 files.
3368
\expandafter\closeout\csname#2indfile\endcsname
3369
\expandafter\let\csname\donesynindex#2\endcsname = 1
3370
\fi
3371
% redefine \fooindfile:
3372
\expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3373
\expandafter\let\csname#2indfile\endcsname=\temp
3374
% redefine \fooindex:
3375
\expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3376
}
3377
3378
% Define \doindex, the driver for all \fooindex macros.
3379
% Argument #1 is generated by the calling \fooindex macro,
3380
% and it is "foo", the name of the index.
3381
3382
% \doindex just uses \parsearg; it calls \doind for the actual work.
3383
% This is because \doind is more useful to call from other macros.
3384
3385
% There is also \dosubind {index}{topic}{subtopic}
3386
% which makes an entry in a two-level index such as the operation index.
3387
3388
\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3389
\def\singleindexer #1{\doind{\indexname}{#1}}
3390
3391
% like the previous two, but they put @code around the argument.
3392
\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3393
\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3394
3395
% Take care of Texinfo commands that can appear in an index entry.
3396
% Since there are some commands we want to expand, and others we don't,
3397
% we have to laboriously prevent expansion for those that we don't.
3398
%
3399
\def\indexdummies{%
3400
\escapechar = `\\ % use backslash in output files.
3401
\def\@{@}% change to @@ when we switch to @ as escape char in index files.
3402
\def\ {\realbackslash\space }%
3403
%
3404
% Need these in case \tex is in effect and \{ is a \delimiter again.
3405
% But can't use \lbracecmd and \rbracecmd because texindex assumes
3406
% braces and backslashes are used only as delimiters.
3407
\let\{ = \mylbrace
3408
\let\} = \myrbrace
3409
%
3410
% I don't entirely understand this, but when an index entry is
3411
% generated from a macro call, the \endinput which \scanmacro inserts
3412
% causes processing to be prematurely terminated. This is,
3413
% apparently, because \indexsorttmp is fully expanded, and \endinput
3414
% is an expandable command. The redefinition below makes \endinput
3415
% disappear altogether for that purpose -- although logging shows that
3416
% processing continues to some further point. On the other hand, it
3417
% seems \endinput does not hurt in the printed index arg, since that
3418
% is still getting written without apparent harm.
3419
%
3420
% Sample source (mac-idx3.tex, reported by Graham Percival to
3421
% help-texinfo, 22may06):
3422
% @macro funindex {WORD}
3423
% @findex xyz
3424
% @end macro
3425
% ...
3426
% @funindex commtest
3427
%
3428
% The above is not enough to reproduce the bug, but it gives the flavor.
3429
%
3430
% Sample whatsit resulting:
3431
% .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3432
%
3433
% So:
3434
\let\endinput = \empty
3435
%
3436
% Do the redefinitions.
3437
\commondummies
3438
}
3439
3440
% For the aux and toc files, @ is the escape character. So we want to
3441
% redefine everything using @ as the escape character (instead of
3442
% \realbackslash, still used for index files). When everything uses @,
3443
% this will be simpler.
3444
%
3445
\def\atdummies{%
3446
\def\@{@@}%
3447
\def\ {@ }%
3448
\let\{ = \lbraceatcmd
3449
\let\} = \rbraceatcmd
3450
%
3451
% Do the redefinitions.
3452
\commondummies
3453
\otherbackslash
3454
}
3455
3456
% Called from \indexdummies and \atdummies.
3457
%
3458
\def\commondummies{%
3459
%
3460
% \definedummyword defines \#1 as \string\#1\space, thus effectively
3461
% preventing its expansion. This is used only for control% words,
3462
% not control letters, because the \space would be incorrect for
3463
% control characters, but is needed to separate the control word
3464
% from whatever follows.
3465
%
3466
% For control letters, we have \definedummyletter, which omits the
3467
% space.
3468
%
3469
% These can be used both for control words that take an argument and
3470
% those that do not. If it is followed by {arg} in the input, then
3471
% that will dutifully get written to the index (or wherever).
3472
%
3473
\def\definedummyword ##1{\def##1{\string##1\space}}%
3474
\def\definedummyletter##1{\def##1{\string##1}}%
3475
\let\definedummyaccent\definedummyletter
3476
%
3477
\commondummiesnofonts
3478
%
3479
\definedummyletter\_%
3480
%
3481
% Non-English letters.
3482
\definedummyword\AA
3483
\definedummyword\AE
3484
\definedummyword\L
3485
\definedummyword\OE
3486
\definedummyword\O
3487
\definedummyword\aa
3488
\definedummyword\ae
3489
\definedummyword\l
3490
\definedummyword\oe
3491
\definedummyword\o
3492
\definedummyword\ss
3493
\definedummyword\exclamdown
3494
\definedummyword\questiondown
3495
\definedummyword\ordf
3496
\definedummyword\ordm
3497
%
3498
% Although these internal commands shouldn't show up, sometimes they do.
3499
\definedummyword\bf
3500
\definedummyword\gtr
3501
\definedummyword\hat
3502
\definedummyword\less
3503
\definedummyword\sf
3504
\definedummyword\sl
3505
\definedummyword\tclose
3506
\definedummyword\tt
3507
%
3508
\definedummyword\LaTeX
3509
\definedummyword\TeX
3510
%
3511
% Assorted special characters.
3512
\definedummyword\bullet
3513
\definedummyword\comma
3514
\definedummyword\copyright
3515
\definedummyword\registeredsymbol
3516
\definedummyword\dots
3517
\definedummyword\enddots
3518
\definedummyword\equiv
3519
\definedummyword\error
3520
\definedummyword\euro
3521
\definedummyword\expansion
3522
\definedummyword\minus
3523
\definedummyword\pounds
3524
\definedummyword\point
3525
\definedummyword\print
3526
\definedummyword\result
3527
%
3528
% We want to disable all macros so that they are not expanded by \write.
3529
\macrolist
3530
%
3531
\normalturnoffactive
3532
%
3533
% Handle some cases of @value -- where it does not contain any
3534
% (non-fully-expandable) commands.
3535
\makevalueexpandable
3536
}
3537
3538
% \commondummiesnofonts: common to \commondummies and \indexnofonts.
3539
%
3540
\def\commondummiesnofonts{%
3541
% Control letters and accents.
3542
\definedummyletter\!%
3543
\definedummyaccent\"%
3544
\definedummyaccent\'%
3545
\definedummyletter\*%
3546
\definedummyaccent\,%
3547
\definedummyletter\.%
3548
\definedummyletter\/%
3549
\definedummyletter\:%
3550
\definedummyaccent\=%
3551
\definedummyletter\?%
3552
\definedummyaccent\^%
3553
\definedummyaccent\`%
3554
\definedummyaccent\~%
3555
\definedummyword\u
3556
\definedummyword\v
3557
\definedummyword\H
3558
\definedummyword\dotaccent
3559
\definedummyword\ringaccent
3560
\definedummyword\tieaccent
3561
\definedummyword\ubaraccent
3562
\definedummyword\udotaccent
3563
\definedummyword\dotless
3564
%
3565
% Texinfo font commands.
3566
\definedummyword\b
3567
\definedummyword\i
3568
\definedummyword\r
3569
\definedummyword\sc
3570
\definedummyword\t
3571
%
3572
% Commands that take arguments.
3573
\definedummyword\acronym
3574
\definedummyword\cite
3575
\definedummyword\code
3576
\definedummyword\command
3577
\definedummyword\dfn
3578
\definedummyword\emph
3579
\definedummyword\env
3580
\definedummyword\file
3581
\definedummyword\kbd
3582
\definedummyword\key
3583
\definedummyword\math
3584
\definedummyword\option
3585
\definedummyword\pxref
3586
\definedummyword\ref
3587
\definedummyword\samp
3588
\definedummyword\strong
3589
\definedummyword\tie
3590
\definedummyword\uref
3591
\definedummyword\url
3592
\definedummyword\var
3593
\definedummyword\verb
3594
\definedummyword\w
3595
\definedummyword\xref
3596
}
3597
3598
% \indexnofonts is used when outputting the strings to sort the index
3599
% by, and when constructing control sequence names. It eliminates all
3600
% control sequences and just writes whatever the best ASCII sort string
3601
% would be for a given command (usually its argument).
3602
%
3603
\def\indexnofonts{%
3604
% Accent commands should become @asis.
3605
\def\definedummyaccent##1{\let##1\asis}%
3606
% We can just ignore other control letters.
3607
\def\definedummyletter##1{\let##1\empty}%
3608
% Hopefully, all control words can become @asis.
3609
\let\definedummyword\definedummyaccent
3610
%
3611
\commondummiesnofonts
3612
%
3613
% Don't no-op \tt, since it isn't a user-level command
3614
% and is used in the definitions of the active chars like <, >, |, etc.
3615
% Likewise with the other plain tex font commands.
3616
%\let\tt=\asis
3617
%
3618
\def\ { }%
3619
\def\@{@}%
3620
% how to handle braces?
3621
\def\_{\normalunderscore}%
3622
%
3623
% Non-English letters.
3624
\def\AA{AA}%
3625
\def\AE{AE}%
3626
\def\L{L}%
3627
\def\OE{OE}%
3628
\def\O{O}%
3629
\def\aa{aa}%
3630
\def\ae{ae}%
3631
\def\l{l}%
3632
\def\oe{oe}%
3633
\def\o{o}%
3634
\def\ss{ss}%
3635
\def\exclamdown{!}%
3636
\def\questiondown{?}%
3637
\def\ordf{a}%
3638
\def\ordm{o}%
3639
%
3640
\def\LaTeX{LaTeX}%
3641
\def\TeX{TeX}%
3642
%
3643
% Assorted special characters.
3644
% (The following {} will end up in the sort string, but that's ok.)
3645
\def\bullet{bullet}%
3646
\def\comma{,}%
3647
\def\copyright{copyright}%
3648
\def\registeredsymbol{R}%
3649
\def\dots{...}%
3650
\def\enddots{...}%
3651
\def\equiv{==}%
3652
\def\error{error}%
3653
\def\euro{euro}%
3654
\def\expansion{==>}%
3655
\def\minus{-}%
3656
\def\pounds{pounds}%
3657
\def\point{.}%
3658
\def\print{-|}%
3659
\def\result{=>}%
3660
%
3661
% We need to get rid of all macros, leaving only the arguments (if present).
3662
% Of course this is not nearly correct, but it is the best we can do for now.
3663
% makeinfo does not expand macros in the argument to @deffn, which ends up
3664
% writing an index entry, and texindex isn't prepared for an index sort entry
3665
% that starts with \.
3666
%
3667
% Since macro invocations are followed by braces, we can just redefine them
3668
% to take a single TeX argument. The case of a macro invocation that
3669
% goes to end-of-line is not handled.
3670
%
3671
\macrolist
3672
}
3673
3674
\let\indexbackslash=0 %overridden during \printindex.
3675
\let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3676
3677
% Most index entries go through here, but \dosubind is the general case.
3678
% #1 is the index name, #2 is the entry text.
3679
\def\doind#1#2{\dosubind{#1}{#2}{}}
3680
3681
% Workhorse for all \fooindexes.
3682
% #1 is name of index, #2 is stuff to put there, #3 is subentry --
3683
% empty if called from \doind, as we usually are (the main exception
3684
% is with most defuns, which call us directly).
3685
%
3686
\def\dosubind#1#2#3{%
3687
\iflinks
3688
{%
3689
% Store the main index entry text (including the third arg).
3690
\toks0 = {#2}%
3691
% If third arg is present, precede it with a space.
3692
\def\thirdarg{#3}%
3693
\ifx\thirdarg\empty \else
3694
\toks0 = \expandafter{\the\toks0 \space #3}%
3695
\fi
3696
%
3697
\edef\writeto{\csname#1indfile\endcsname}%
3698
%
3699
\ifvmode
3700
\dosubindsanitize
3701
\else
3702
\dosubindwrite
3703
\fi
3704
}%
3705
\fi
3706
}
3707
3708
% Write the entry in \toks0 to the index file:
3709
%
3710
\def\dosubindwrite{%
3711
% Put the index entry in the margin if desired.
3712
\ifx\SETmarginindex\relax\else
3713
\insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3714
\fi
3715
%
3716
% Remember, we are within a group.
3717
\indexdummies % Must do this here, since \bf, etc expand at this stage
3718
\def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3719
% so it will be output as is; and it will print as backslash.
3720
%
3721
% Process the index entry with all font commands turned off, to
3722
% get the string to sort by.
3723
{\indexnofonts
3724
\edef\temp{\the\toks0}% need full expansion
3725
\xdef\indexsorttmp{\temp}%
3726
}%
3727
%
3728
% Set up the complete index entry, with both the sort key and
3729
% the original text, including any font commands. We write
3730
% three arguments to \entry to the .?? file (four in the
3731
% subentry case), texindex reduces to two when writing the .??s
3732
% sorted result.
3733
\edef\temp{%
3734
\write\writeto{%
3735
\string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3736
}%
3737
\temp
3738
}
3739
3740
% Take care of unwanted page breaks:
3741
%
3742
% If a skip is the last thing on the list now, preserve it
3743
% by backing up by \lastskip, doing the \write, then inserting
3744
% the skip again. Otherwise, the whatsit generated by the
3745
% \write will make \lastskip zero. The result is that sequences
3746
% like this:
3747
% @end defun
3748
% @tindex whatever
3749
% @defun ...
3750
% will have extra space inserted, because the \medbreak in the
3751
% start of the @defun won't see the skip inserted by the @end of
3752
% the previous defun.
3753
%
3754
% But don't do any of this if we're not in vertical mode. We
3755
% don't want to do a \vskip and prematurely end a paragraph.
3756
%
3757
% Avoid page breaks due to these extra skips, too.
3758
%
3759
% But wait, there is a catch there:
3760
% We'll have to check whether \lastskip is zero skip. \ifdim is not
3761
% sufficient for this purpose, as it ignores stretch and shrink parts
3762
% of the skip. The only way seems to be to check the textual
3763
% representation of the skip.
3764
%
3765
% The following is almost like \def\zeroskipmacro{0.0pt} except that
3766
% the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3767
%
3768
\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3769
%
3770
% ..., ready, GO:
3771
%
3772
\def\dosubindsanitize{%
3773
% \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3774
\skip0 = \lastskip
3775
\edef\lastskipmacro{\the\lastskip}%
3776
\count255 = \lastpenalty
3777
%
3778
% If \lastskip is nonzero, that means the last item was a
3779
% skip. And since a skip is discardable, that means this
3780
% -\skip0 glue we're inserting is preceded by a
3781
% non-discardable item, therefore it is not a potential
3782
% breakpoint, therefore no \nobreak needed.
3783
\ifx\lastskipmacro\zeroskipmacro
3784
\else
3785
\vskip-\skip0
3786
\fi
3787
%
3788
\dosubindwrite
3789
%
3790
\ifx\lastskipmacro\zeroskipmacro
3791
% If \lastskip was zero, perhaps the last item was a penalty, and
3792
% perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3793
% to re-insert the same penalty (values >10000 are used for various
3794
% signals); since we just inserted a non-discardable item, any
3795
% following glue (such as a \parskip) would be a breakpoint. For example:
3796
%
3797
% @deffn deffn-whatever
3798
% @vindex index-whatever
3799
% Description.
3800
% would allow a break between the index-whatever whatsit
3801
% and the "Description." paragraph.
3802
\ifnum\count255>9999 \penalty\count255 \fi
3803
\else
3804
% On the other hand, if we had a nonzero \lastskip,
3805
% this make-up glue would be preceded by a non-discardable item
3806
% (the whatsit from the \write), so we must insert a \nobreak.
3807
\nobreak\vskip\skip0
3808
\fi
3809
}
3810
3811
% The index entry written in the file actually looks like
3812
% \entry {sortstring}{page}{topic}
3813
% or
3814
% \entry {sortstring}{page}{topic}{subtopic}
3815
% The texindex program reads in these files and writes files
3816
% containing these kinds of lines:
3817
% \initial {c}
3818
% before the first topic whose initial is c
3819
% \entry {topic}{pagelist}
3820
% for a topic that is used without subtopics
3821
% \primary {topic}
3822
% for the beginning of a topic that is used with subtopics
3823
% \secondary {subtopic}{pagelist}
3824
% for each subtopic.
3825
3826
% Define the user-accessible indexing commands
3827
% @findex, @vindex, @kindex, @cindex.
3828
3829
\def\findex {\fnindex}
3830
\def\kindex {\kyindex}
3831
\def\cindex {\cpindex}
3832
\def\vindex {\vrindex}
3833
\def\tindex {\tpindex}
3834
\def\pindex {\pgindex}
3835
3836
\def\cindexsub {\begingroup\obeylines\cindexsub}
3837
{\obeylines %
3838
\gdef\cindexsub "#1" #2^^M{\endgroup %
3839
\dosubind{cp}{#2}{#1}}}
3840
3841
% Define the macros used in formatting output of the sorted index material.
3842
3843
% @printindex causes a particular index (the ??s file) to get printed.
3844
% It does not print any chapter heading (usually an @unnumbered).
3845
%
3846
\parseargdef\printindex{\begingroup
3847
\dobreak \chapheadingskip{10000}%
3848
%
3849
\smallfonts \rm
3850
\tolerance = 9500
3851
\everypar = {}% don't want the \kern\-parindent from indentation suppression.
3852
%
3853
% See if the index file exists and is nonempty.
3854
% Change catcode of @ here so that if the index file contains
3855
% \initial {@}
3856
% as its first line, TeX doesn't complain about mismatched braces
3857
% (because it thinks @} is a control sequence).
3858
\catcode`\@ = 11
3859
\openin 1 \jobname.#1s
3860
\ifeof 1
3861
% \enddoublecolumns gets confused if there is no text in the index,
3862
% and it loses the chapter title and the aux file entries for the
3863
% index. The easiest way to prevent this problem is to make sure
3864
% there is some text.
3865
\putwordIndexNonexistent
3866
\else
3867
%
3868
% If the index file exists but is empty, then \openin leaves \ifeof
3869
% false. We have to make TeX try to read something from the file, so
3870
% it can discover if there is anything in it.
3871
\read 1 to \temp
3872
\ifeof 1
3873
\putwordIndexIsEmpty
3874
\else
3875
% Index files are almost Texinfo source, but we use \ as the escape
3876
% character. It would be better to use @, but that's too big a change
3877
% to make right now.
3878
\def\indexbackslash{\backslashcurfont}%
3879
\catcode`\\ = 0
3880
\escapechar = `\\
3881
\begindoublecolumns
3882
\input \jobname.#1s
3883
\enddoublecolumns
3884
\fi
3885
\fi
3886
\closein 1
3887
\endgroup}
3888
3889
% These macros are used by the sorted index file itself.
3890
% Change them to control the appearance of the index.
3891
3892
\def\initial#1{{%
3893
% Some minor font changes for the special characters.
3894
\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3895
%
3896
% Remove any glue we may have, we'll be inserting our own.
3897
\removelastskip
3898
%
3899
% We like breaks before the index initials, so insert a bonus.
3900
\nobreak
3901
\vskip 0pt plus 3\baselineskip
3902
\penalty 0
3903
\vskip 0pt plus -3\baselineskip
3904
%
3905
% Typeset the initial. Making this add up to a whole number of
3906
% baselineskips increases the chance of the dots lining up from column
3907
% to column. It still won't often be perfect, because of the stretch
3908
% we need before each entry, but it's better.
3909
%
3910
% No shrink because it confuses \balancecolumns.
3911
\vskip 1.67\baselineskip plus .5\baselineskip
3912
\leftline{\secbf #1}%
3913
% Do our best not to break after the initial.
3914
\nobreak
3915
\vskip .33\baselineskip plus .1\baselineskip
3916
}}
3917
3918
% \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3919
% then page number (#2) flushed to the right margin. It is used for index
3920
% and table of contents entries. The paragraph is indented by \leftskip.
3921
%
3922
% A straightforward implementation would start like this:
3923
% \def\entry#1#2{...
3924
% But this frozes the catcodes in the argument, and can cause problems to
3925
% @code, which sets - active. This problem was fixed by a kludge---
3926
% ``-'' was active throughout whole index, but this isn't really right.
3927
%
3928
% The right solution is to prevent \entry from swallowing the whole text.
3929
% --kasal, 21nov03
3930
\def\entry{%
3931
\begingroup
3932
%
3933
% Start a new paragraph if necessary, so our assignments below can't
3934
% affect previous text.
3935
\par
3936
%
3937
% Do not fill out the last line with white space.
3938
\parfillskip = 0in
3939
%
3940
% No extra space above this paragraph.
3941
\parskip = 0in
3942
%
3943
% Do not prefer a separate line ending with a hyphen to fewer lines.
3944
\finalhyphendemerits = 0
3945
%
3946
% \hangindent is only relevant when the entry text and page number
3947
% don't both fit on one line. In that case, bob suggests starting the
3948
% dots pretty far over on the line. Unfortunately, a large
3949
% indentation looks wrong when the entry text itself is broken across
3950
% lines. So we use a small indentation and put up with long leaders.
3951
%
3952
% \hangafter is reset to 1 (which is the value we want) at the start
3953
% of each paragraph, so we need not do anything with that.
3954
\hangindent = 2em
3955
%
3956
% When the entry text needs to be broken, just fill out the first line
3957
% with blank space.
3958
\rightskip = 0pt plus1fil
3959
%
3960
% A bit of stretch before each entry for the benefit of balancing
3961
% columns.
3962
\vskip 0pt plus1pt
3963
%
3964
% Swallow the left brace of the text (first parameter):
3965
\afterassignment\doentry
3966
\let\temp =
3967
}
3968
\def\doentry{%
3969
\bgroup % Instead of the swallowed brace.
3970
\noindent
3971
\aftergroup\finishentry
3972
% And now comes the text of the entry.
3973
}
3974
\def\finishentry#1{%
3975
% #1 is the page number.
3976
%
3977
% The following is kludged to not output a line of dots in the index if
3978
% there are no page numbers. The next person who breaks this will be
3979
% cursed by a Unix daemon.
3980
\def\tempa{{\rm }}%
3981
\def\tempb{#1}%
3982
\edef\tempc{\tempa}%
3983
\edef\tempd{\tempb}%
3984
\ifx\tempc\tempd
3985
\ %
3986
\else
3987
%
3988
% If we must, put the page number on a line of its own, and fill out
3989
% this line with blank space. (The \hfil is overwhelmed with the
3990
% fill leaders glue in \indexdotfill if the page number does fit.)
3991
\hfil\penalty50
3992
\null\nobreak\indexdotfill % Have leaders before the page number.
3993
%
3994
% The `\ ' here is removed by the implicit \unskip that TeX does as
3995
% part of (the primitive) \par. Without it, a spurious underfull
3996
% \hbox ensues.
3997
\ifpdf
3998
\pdfgettoks#1.%
3999
\ \the\toksA
4000
\else
4001
\ #1%
4002
\fi
4003
\fi
4004
\par
4005
\endgroup
4006
}
4007
4008
% Like plain.tex's \dotfill, except uses up at least 1 em.
4009
\def\indexdotfill{\cleaders
4010
\hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4011
4012
\def\primary #1{\line{#1\hfil}}
4013
4014
\newskip\secondaryindent \secondaryindent=0.5cm
4015
\def\secondary#1#2{{%
4016
\parfillskip=0in
4017
\parskip=0in
4018
\hangindent=1in
4019
\hangafter=1
4020
\noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4021
\ifpdf
4022
\pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4023
\else
4024
#2
4025
\fi
4026
\par
4027
}}
4028
4029
% Define two-column mode, which we use to typeset indexes.
4030
% Adapted from the TeXbook, page 416, which is to say,
4031
% the manmac.tex format used to print the TeXbook itself.
4032
\catcode`\@=11
4033
4034
\newbox\partialpage
4035
\newdimen\doublecolumnhsize
4036
4037
\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4038
% Grab any single-column material above us.
4039
\output = {%
4040
%
4041
% Here is a possibility not foreseen in manmac: if we accumulate a
4042
% whole lot of material, we might end up calling this \output
4043
% routine twice in a row (see the doublecol-lose test, which is
4044
% essentially a couple of indexes with @setchapternewpage off). In
4045
% that case we just ship out what is in \partialpage with the normal
4046
% output routine. Generally, \partialpage will be empty when this
4047
% runs and this will be a no-op. See the indexspread.tex test case.
4048
\ifvoid\partialpage \else
4049
\onepageout{\pagecontents\partialpage}%
4050
\fi
4051
%
4052
\global\setbox\partialpage = \vbox{%
4053
% Unvbox the main output page.
4054
\unvbox\PAGE
4055
\kern-\topskip \kern\baselineskip
4056
}%
4057
}%
4058
\eject % run that output routine to set \partialpage
4059
%
4060
% Use the double-column output routine for subsequent pages.
4061
\output = {\doublecolumnout}%
4062
%
4063
% Change the page size parameters. We could do this once outside this
4064
% routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4065
% format, but then we repeat the same computation. Repeating a couple
4066
% of assignments once per index is clearly meaningless for the
4067
% execution time, so we may as well do it in one place.
4068
%
4069
% First we halve the line length, less a little for the gutter between
4070
% the columns. We compute the gutter based on the line length, so it
4071
% changes automatically with the paper format. The magic constant
4072
% below is chosen so that the gutter has the same value (well, +-<1pt)
4073
% as it did when we hard-coded it.
4074
%
4075
% We put the result in a separate register, \doublecolumhsize, so we
4076
% can restore it in \pagesofar, after \hsize itself has (potentially)
4077
% been clobbered.
4078
%
4079
\doublecolumnhsize = \hsize
4080
\advance\doublecolumnhsize by -.04154\hsize
4081
\divide\doublecolumnhsize by 2
4082
\hsize = \doublecolumnhsize
4083
%
4084
% Double the \vsize as well. (We don't need a separate register here,
4085
% since nobody clobbers \vsize.)
4086
\vsize = 2\vsize
4087
}
4088
4089
% The double-column output routine for all double-column pages except
4090
% the last.
4091
%
4092
\def\doublecolumnout{%
4093
\splittopskip=\topskip \splitmaxdepth=\maxdepth
4094
% Get the available space for the double columns -- the normal
4095
% (undoubled) page height minus any material left over from the
4096
% previous page.
4097
\dimen@ = \vsize
4098
\divide\dimen@ by 2
4099
\advance\dimen@ by -\ht\partialpage
4100
%
4101
% box0 will be the left-hand column, box2 the right.
4102
\setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4103
\onepageout\pagesofar
4104
\unvbox255
4105
\penalty\outputpenalty
4106
}
4107
%
4108
% Re-output the contents of the output page -- any previous material,
4109
% followed by the two boxes we just split, in box0 and box2.
4110
\def\pagesofar{%
4111
\unvbox\partialpage
4112
%
4113
\hsize = \doublecolumnhsize
4114
\wd0=\hsize \wd2=\hsize
4115
\hbox to\pagewidth{\box0\hfil\box2}%
4116
}
4117
%
4118
% All done with double columns.
4119
\def\enddoublecolumns{%
4120
\output = {%
4121
% Split the last of the double-column material. Leave it on the
4122
% current page, no automatic page break.
4123
\balancecolumns
4124
%
4125
% If we end up splitting too much material for the current page,
4126
% though, there will be another page break right after this \output
4127
% invocation ends. Having called \balancecolumns once, we do not
4128
% want to call it again. Therefore, reset \output to its normal
4129
% definition right away. (We hope \balancecolumns will never be
4130
% called on to balance too much material, but if it is, this makes
4131
% the output somewhat more palatable.)
4132
\global\output = {\onepageout{\pagecontents\PAGE}}%
4133
}%
4134
\eject
4135
\endgroup % started in \begindoublecolumns
4136
%
4137
% \pagegoal was set to the doubled \vsize above, since we restarted
4138
% the current page. We're now back to normal single-column
4139
% typesetting, so reset \pagegoal to the normal \vsize (after the
4140
% \endgroup where \vsize got restored).
4141
\pagegoal = \vsize
4142
}
4143
%
4144
% Called at the end of the double column material.
4145
\def\balancecolumns{%
4146
\setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4147
\dimen@ = \ht0
4148
\advance\dimen@ by \topskip
4149
\advance\dimen@ by-\baselineskip
4150
\divide\dimen@ by 2 % target to split to
4151
%debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4152
\splittopskip = \topskip
4153
% Loop until we get a decent breakpoint.
4154
{%
4155
\vbadness = 10000
4156
\loop
4157
\global\setbox3 = \copy0
4158
\global\setbox1 = \vsplit3 to \dimen@
4159
\ifdim\ht3>\dimen@
4160
\global\advance\dimen@ by 1pt
4161
\repeat
4162
}%
4163
%debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4164
\setbox0=\vbox to\dimen@{\unvbox1}%
4165
\setbox2=\vbox to\dimen@{\unvbox3}%
4166
%
4167
\pagesofar
4168
}
4169
\catcode`\@ = \other
4170
4171
4172
\message{sectioning,}
4173
% Chapters, sections, etc.
4174
4175
% \unnumberedno is an oxymoron, of course. But we count the unnumbered
4176
% sections so that we can refer to them unambiguously in the pdf
4177
% outlines by their "section number". We avoid collisions with chapter
4178
% numbers by starting them at 10000. (If a document ever has 10000
4179
% chapters, we're in trouble anyway, I'm sure.)
4180
\newcount\unnumberedno \unnumberedno = 10000
4181
\newcount\chapno
4182
\newcount\secno \secno=0
4183
\newcount\subsecno \subsecno=0
4184
\newcount\subsubsecno \subsubsecno=0
4185
4186
% This counter is funny since it counts through charcodes of letters A, B, ...
4187
\newcount\appendixno \appendixno = `\@
4188
%
4189
% \def\appendixletter{\char\the\appendixno}
4190
% We do the following ugly conditional instead of the above simple
4191
% construct for the sake of pdftex, which needs the actual
4192
% letter in the expansion, not just typeset.
4193
%
4194
\def\appendixletter{%
4195
\ifnum\appendixno=`A A%
4196
\else\ifnum\appendixno=`B B%
4197
\else\ifnum\appendixno=`C C%
4198
\else\ifnum\appendixno=`D D%
4199
\else\ifnum\appendixno=`E E%
4200
\else\ifnum\appendixno=`F F%
4201
\else\ifnum\appendixno=`G G%
4202
\else\ifnum\appendixno=`H H%
4203
\else\ifnum\appendixno=`I I%
4204
\else\ifnum\appendixno=`J J%
4205
\else\ifnum\appendixno=`K K%
4206
\else\ifnum\appendixno=`L L%
4207
\else\ifnum\appendixno=`M M%
4208
\else\ifnum\appendixno=`N N%
4209
\else\ifnum\appendixno=`O O%
4210
\else\ifnum\appendixno=`P P%
4211
\else\ifnum\appendixno=`Q Q%
4212
\else\ifnum\appendixno=`R R%
4213
\else\ifnum\appendixno=`S S%
4214
\else\ifnum\appendixno=`T T%
4215
\else\ifnum\appendixno=`U U%
4216
\else\ifnum\appendixno=`V V%
4217
\else\ifnum\appendixno=`W W%
4218
\else\ifnum\appendixno=`X X%
4219
\else\ifnum\appendixno=`Y Y%
4220
\else\ifnum\appendixno=`Z Z%
4221
% The \the is necessary, despite appearances, because \appendixletter is
4222
% expanded while writing the .toc file. \char\appendixno is not
4223
% expandable, thus it is written literally, thus all appendixes come out
4224
% with the same letter (or @) in the toc without it.
4225
\else\char\the\appendixno
4226
\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4227
\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4228
4229
% Each @chapter defines this as the name of the chapter.
4230
% page headings and footings can use it. @section does likewise.
4231
% However, they are not reliable, because we don't use marks.
4232
\def\thischapter{}
4233
\def\thissection{}
4234
4235
\newcount\absseclevel % used to calculate proper heading level
4236
\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4237
4238
% @raisesections: treat @section as chapter, @subsection as section, etc.
4239
\def\raisesections{\global\advance\secbase by -1}
4240
\let\up=\raisesections % original BFox name
4241
4242
% @lowersections: treat @chapter as section, @section as subsection, etc.
4243
\def\lowersections{\global\advance\secbase by 1}
4244
\let\down=\lowersections % original BFox name
4245
4246
% we only have subsub.
4247
\chardef\maxseclevel = 3
4248
%
4249
% A numbered section within an unnumbered changes to unnumbered too.
4250
% To achive this, remember the "biggest" unnum. sec. we are currently in:
4251
\chardef\unmlevel = \maxseclevel
4252
%
4253
% Trace whether the current chapter is an appendix or not:
4254
% \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4255
\def\chapheadtype{N}
4256
4257
% Choose a heading macro
4258
% #1 is heading type
4259
% #2 is heading level
4260
% #3 is text for heading
4261
\def\genhead#1#2#3{%
4262
% Compute the abs. sec. level:
4263
\absseclevel=#2
4264
\advance\absseclevel by \secbase
4265
% Make sure \absseclevel doesn't fall outside the range:
4266
\ifnum \absseclevel < 0
4267
\absseclevel = 0
4268
\else
4269
\ifnum \absseclevel > 3
4270
\absseclevel = 3
4271
\fi
4272
\fi
4273
% The heading type:
4274
\def\headtype{#1}%
4275
\if \headtype U%
4276
\ifnum \absseclevel < \unmlevel
4277
\chardef\unmlevel = \absseclevel
4278
\fi
4279
\else
4280
% Check for appendix sections:
4281
\ifnum \absseclevel = 0
4282
\edef\chapheadtype{\headtype}%
4283
\else
4284
\if \headtype A\if \chapheadtype N%
4285
\errmessage{@appendix... within a non-appendix chapter}%
4286
\fi\fi
4287
\fi
4288
% Check for numbered within unnumbered:
4289
\ifnum \absseclevel > \unmlevel
4290
\def\headtype{U}%
4291
\else
4292
\chardef\unmlevel = 3
4293
\fi
4294
\fi
4295
% Now print the heading:
4296
\if \headtype U%
4297
\ifcase\absseclevel
4298
\unnumberedzzz{#3}%
4299
\or \unnumberedseczzz{#3}%
4300
\or \unnumberedsubseczzz{#3}%
4301
\or \unnumberedsubsubseczzz{#3}%
4302
\fi
4303
\else
4304
\if \headtype A%
4305
\ifcase\absseclevel
4306
\appendixzzz{#3}%
4307
\or \appendixsectionzzz{#3}%
4308
\or \appendixsubseczzz{#3}%
4309
\or \appendixsubsubseczzz{#3}%
4310
\fi
4311
\else
4312
\ifcase\absseclevel
4313
\chapterzzz{#3}%
4314
\or \seczzz{#3}%
4315
\or \numberedsubseczzz{#3}%
4316
\or \numberedsubsubseczzz{#3}%
4317
\fi
4318
\fi
4319
\fi
4320
\suppressfirstparagraphindent
4321
}
4322
4323
% an interface:
4324
\def\numhead{\genhead N}
4325
\def\apphead{\genhead A}
4326
\def\unnmhead{\genhead U}
4327
4328
% @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4329
% all lower-level sectioning counters to zero.
4330
%
4331
% Also set \chaplevelprefix, which we prepend to @float sequence numbers
4332
% (e.g., figures), q.v. By default (before any chapter), that is empty.
4333
\let\chaplevelprefix = \empty
4334
%
4335
\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4336
\def\chapterzzz#1{%
4337
% section resetting is \global in case the chapter is in a group, such
4338
% as an @include file.
4339
\global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4340
\global\advance\chapno by 1
4341
%
4342
% Used for \float.
4343
\gdef\chaplevelprefix{\the\chapno.}%
4344
\resetallfloatnos
4345
%
4346
\message{\putwordChapter\space \the\chapno}%
4347
%
4348
% Write the actual heading.
4349
\chapmacro{#1}{Ynumbered}{\the\chapno}%
4350
%
4351
% So @section and the like are numbered underneath this chapter.
4352
\global\let\section = \numberedsec
4353
\global\let\subsection = \numberedsubsec
4354
\global\let\subsubsection = \numberedsubsubsec
4355
}
4356
4357
\outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4358
\def\appendixzzz#1{%
4359
\global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4360
\global\advance\appendixno by 1
4361
\gdef\chaplevelprefix{\appendixletter.}%
4362
\resetallfloatnos
4363
%
4364
\def\appendixnum{\putwordAppendix\space \appendixletter}%
4365
\message{\appendixnum}%
4366
%
4367
\chapmacro{#1}{Yappendix}{\appendixletter}%
4368
%
4369
\global\let\section = \appendixsec
4370
\global\let\subsection = \appendixsubsec
4371
\global\let\subsubsection = \appendixsubsubsec
4372
}
4373
4374
\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4375
\def\unnumberedzzz#1{%
4376
\global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4377
\global\advance\unnumberedno by 1
4378
%
4379
% Since an unnumbered has no number, no prefix for figures.
4380
\global\let\chaplevelprefix = \empty
4381
\resetallfloatnos
4382
%
4383
% This used to be simply \message{#1}, but TeX fully expands the
4384
% argument to \message. Therefore, if #1 contained @-commands, TeX
4385
% expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4386
% expanded @cite (which turns out to cause errors because \cite is meant
4387
% to be executed, not expanded).
4388
%
4389
% Anyway, we don't want the fully-expanded definition of @cite to appear
4390
% as a result of the \message, we just want `@cite' itself. We use
4391
% \the<toks register> to achieve this: TeX expands \the<toks> only once,
4392
% simply yielding the contents of <toks register>. (We also do this for
4393
% the toc entries.)
4394
\toks0 = {#1}%
4395
\message{(\the\toks0)}%
4396
%
4397
\chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4398
%
4399
\global\let\section = \unnumberedsec
4400
\global\let\subsection = \unnumberedsubsec
4401
\global\let\subsubsection = \unnumberedsubsubsec
4402
}
4403
4404
% @centerchap is like @unnumbered, but the heading is centered.
4405
\outer\parseargdef\centerchap{%
4406
% Well, we could do the following in a group, but that would break
4407
% an assumption that \chapmacro is called at the outermost level.
4408
% Thus we are safer this way: --kasal, 24feb04
4409
\let\centerparametersmaybe = \centerparameters
4410
\unnmhead0{#1}%
4411
\let\centerparametersmaybe = \relax
4412
}
4413
4414
% @top is like @unnumbered.
4415
\let\top\unnumbered
4416
4417
% Sections.
4418
\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4419
\def\seczzz#1{%
4420
\global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4421
\sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4422
}
4423
4424
\outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4425
\def\appendixsectionzzz#1{%
4426
\global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4427
\sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4428
}
4429
\let\appendixsec\appendixsection
4430
4431
\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4432
\def\unnumberedseczzz#1{%
4433
\global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4434
\sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4435
}
4436
4437
% Subsections.
4438
\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4439
\def\numberedsubseczzz#1{%
4440
\global\subsubsecno=0 \global\advance\subsecno by 1
4441
\sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4442
}
4443
4444
\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4445
\def\appendixsubseczzz#1{%
4446
\global\subsubsecno=0 \global\advance\subsecno by 1
4447
\sectionheading{#1}{subsec}{Yappendix}%
4448
{\appendixletter.\the\secno.\the\subsecno}%
4449
}
4450
4451
\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4452
\def\unnumberedsubseczzz#1{%
4453
\global\subsubsecno=0 \global\advance\subsecno by 1
4454
\sectionheading{#1}{subsec}{Ynothing}%
4455
{\the\unnumberedno.\the\secno.\the\subsecno}%
4456
}
4457
4458
% Subsubsections.
4459
\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4460
\def\numberedsubsubseczzz#1{%
4461
\global\advance\subsubsecno by 1
4462
\sectionheading{#1}{subsubsec}{Ynumbered}%
4463
{\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4464
}
4465
4466
\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4467
\def\appendixsubsubseczzz#1{%
4468
\global\advance\subsubsecno by 1
4469
\sectionheading{#1}{subsubsec}{Yappendix}%
4470
{\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4471
}
4472
4473
\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4474
\def\unnumberedsubsubseczzz#1{%
4475
\global\advance\subsubsecno by 1
4476
\sectionheading{#1}{subsubsec}{Ynothing}%
4477
{\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4478
}
4479
4480
% These macros control what the section commands do, according
4481
% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4482
% Define them by default for a numbered chapter.
4483
\let\section = \numberedsec
4484
\let\subsection = \numberedsubsec
4485
\let\subsubsection = \numberedsubsubsec
4486
4487
% Define @majorheading, @heading and @subheading
4488
4489
% NOTE on use of \vbox for chapter headings, section headings, and such:
4490
% 1) We use \vbox rather than the earlier \line to permit
4491
% overlong headings to fold.
4492
% 2) \hyphenpenalty is set to 10000 because hyphenation in a
4493
% heading is obnoxious; this forbids it.
4494
% 3) Likewise, headings look best if no \parindent is used, and
4495
% if justification is not attempted. Hence \raggedright.
4496
4497
4498
\def\majorheading{%
4499
{\advance\chapheadingskip by 10pt \chapbreak }%
4500
\parsearg\chapheadingzzz
4501
}
4502
4503
\def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4504
\def\chapheadingzzz#1{%
4505
{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4506
\parindent=0pt\raggedright
4507
\rm #1\hfill}}%
4508
\bigskip \par\penalty 200\relax
4509
\suppressfirstparagraphindent
4510
}
4511
4512
% @heading, @subheading, @subsubheading.
4513
\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4514
\suppressfirstparagraphindent}
4515
\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4516
\suppressfirstparagraphindent}
4517
\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4518
\suppressfirstparagraphindent}
4519
4520
% These macros generate a chapter, section, etc. heading only
4521
% (including whitespace, linebreaking, etc. around it),
4522
% given all the information in convenient, parsed form.
4523
4524
%%% Args are the skip and penalty (usually negative)
4525
\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4526
4527
%%% Define plain chapter starts, and page on/off switching for it
4528
% Parameter controlling skip before chapter headings (if needed)
4529
4530
\newskip\chapheadingskip
4531
4532
\def\chapbreak{\dobreak \chapheadingskip {-4000}}
4533
\def\chappager{\par\vfill\supereject}
4534
\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4535
4536
\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4537
4538
\def\CHAPPAGoff{%
4539
\global\let\contentsalignmacro = \chappager
4540
\global\let\pchapsepmacro=\chapbreak
4541
\global\let\pagealignmacro=\chappager}
4542
4543
\def\CHAPPAGon{%
4544
\global\let\contentsalignmacro = \chappager
4545
\global\let\pchapsepmacro=\chappager
4546
\global\let\pagealignmacro=\chappager
4547
\global\def\HEADINGSon{\HEADINGSsingle}}
4548
4549
\def\CHAPPAGodd{%
4550
\global\let\contentsalignmacro = \chapoddpage
4551
\global\let\pchapsepmacro=\chapoddpage
4552
\global\let\pagealignmacro=\chapoddpage
4553
\global\def\HEADINGSon{\HEADINGSdouble}}
4554
4555
\CHAPPAGon
4556
4557
% Chapter opening.
4558
%
4559
% #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4560
% Yappendix, Yomitfromtoc), #3 the chapter number.
4561
%
4562
% To test against our argument.
4563
\def\Ynothingkeyword{Ynothing}
4564
\def\Yomitfromtockeyword{Yomitfromtoc}
4565
\def\Yappendixkeyword{Yappendix}
4566
%
4567
\def\chapmacro#1#2#3{%
4568
\pchapsepmacro
4569
{%
4570
\chapfonts \rm
4571
%
4572
% Have to define \thissection before calling \donoderef, because the
4573
% xref code eventually uses it. On the other hand, it has to be called
4574
% after \pchapsepmacro, or the headline will change too soon.
4575
\gdef\thissection{#1}%
4576
\gdef\thischaptername{#1}%
4577
%
4578
% Only insert the separating space if we have a chapter/appendix
4579
% number, and don't print the unnumbered ``number''.
4580
\def\temptype{#2}%
4581
\ifx\temptype\Ynothingkeyword
4582
\setbox0 = \hbox{}%
4583
\def\toctype{unnchap}%
4584
\gdef\thischapternum{}%
4585
\gdef\thischapter{#1}%
4586
\else\ifx\temptype\Yomitfromtockeyword
4587
\setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4588
\def\toctype{omit}%
4589
\gdef\thischapternum{}%
4590
\gdef\thischapter{}%
4591
\else\ifx\temptype\Yappendixkeyword
4592
\setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4593
\def\toctype{app}%
4594
\xdef\thischapternum{\appendixletter}%
4595
% We don't substitute the actual chapter name into \thischapter
4596
% because we don't want its macros evaluated now. And we don't
4597
% use \thissection because that changes with each section.
4598
%
4599
\xdef\thischapter{\putwordAppendix{} \appendixletter:
4600
\noexpand\thischaptername}%
4601
\else
4602
\setbox0 = \hbox{#3\enspace}%
4603
\def\toctype{numchap}%
4604
\xdef\thischapternum{\the\chapno}%
4605
\xdef\thischapter{\putwordChapter{} \the\chapno:
4606
\noexpand\thischaptername}%
4607
\fi\fi\fi
4608
%
4609
% Write the toc entry for this chapter. Must come before the
4610
% \donoderef, because we include the current node name in the toc
4611
% entry, and \donoderef resets it to empty.
4612
\writetocentry{\toctype}{#1}{#3}%
4613
%
4614
% For pdftex, we have to write out the node definition (aka, make
4615
% the pdfdest) after any page break, but before the actual text has
4616
% been typeset. If the destination for the pdf outline is after the
4617
% text, then jumping from the outline may wind up with the text not
4618
% being visible, for instance under high magnification.
4619
\donoderef{#2}%
4620
%
4621
% Typeset the actual heading.
4622
\vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4623
\hangindent=\wd0 \centerparametersmaybe
4624
\unhbox0 #1\par}%
4625
}%
4626
\nobreak\bigskip % no page break after a chapter title
4627
\nobreak
4628
}
4629
4630
% @centerchap -- centered and unnumbered.
4631
\let\centerparametersmaybe = \relax
4632
\def\centerparameters{%
4633
\advance\rightskip by 3\rightskip
4634
\leftskip = \rightskip
4635
\parfillskip = 0pt
4636
}
4637
4638
4639
% I don't think this chapter style is supported any more, so I'm not
4640
% updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4641
%
4642
\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4643
%
4644
\def\unnchfopen #1{%
4645
\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4646
\parindent=0pt\raggedright
4647
\rm #1\hfill}}\bigskip \par\nobreak
4648
}
4649
\def\chfopen #1#2{\chapoddpage {\chapfonts
4650
\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4651
\par\penalty 5000 %
4652
}
4653
\def\centerchfopen #1{%
4654
\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4655
\parindent=0pt
4656
\hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4657
}
4658
\def\CHAPFopen{%
4659
\global\let\chapmacro=\chfopen
4660
\global\let\centerchapmacro=\centerchfopen}
4661
4662
4663
% Section titles. These macros combine the section number parts and
4664
% call the generic \sectionheading to do the printing.
4665
%
4666
\newskip\secheadingskip
4667
\def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4668
4669
% Subsection titles.
4670
\newskip\subsecheadingskip
4671
\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4672
4673
% Subsubsection titles.
4674
\def\subsubsecheadingskip{\subsecheadingskip}
4675
\def\subsubsecheadingbreak{\subsecheadingbreak}
4676
4677
4678
% Print any size, any type, section title.
4679
%
4680
% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4681
% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4682
% section number.
4683
%
4684
\def\sectionheading#1#2#3#4{%
4685
{%
4686
% Switch to the right set of fonts.
4687
\csname #2fonts\endcsname \rm
4688
%
4689
% Insert space above the heading.
4690
\csname #2headingbreak\endcsname
4691
%
4692
% Only insert the space after the number if we have a section number.
4693
\def\sectionlevel{#2}%
4694
\def\temptype{#3}%
4695
%
4696
\ifx\temptype\Ynothingkeyword
4697
\setbox0 = \hbox{}%
4698
\def\toctype{unn}%
4699
\gdef\thissection{#1}%
4700
\else\ifx\temptype\Yomitfromtockeyword
4701
% for @headings -- no section number, don't include in toc,
4702
% and don't redefine \thissection.
4703
\setbox0 = \hbox{}%
4704
\def\toctype{omit}%
4705
\let\sectionlevel=\empty
4706
\else\ifx\temptype\Yappendixkeyword
4707
\setbox0 = \hbox{#4\enspace}%
4708
\def\toctype{app}%
4709
\gdef\thissection{#1}%
4710
\else
4711
\setbox0 = \hbox{#4\enspace}%
4712
\def\toctype{num}%
4713
\gdef\thissection{#1}%
4714
\fi\fi\fi
4715
%
4716
% Write the toc entry (before \donoderef). See comments in \chapmacro.
4717
\writetocentry{\toctype\sectionlevel}{#1}{#4}%
4718
%
4719
% Write the node reference (= pdf destination for pdftex).
4720
% Again, see comments in \chapmacro.
4721
\donoderef{#3}%
4722
%
4723
% Interline glue will be inserted when the vbox is completed.
4724
% That glue will be a valid breakpoint for the page, since it'll be
4725
% preceded by a whatsit (usually from the \donoderef, or from the
4726
% \writetocentry if there was no node). We don't want to allow that
4727
% break, since then the whatsits could end up on page n while the
4728
% section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
4729
\nobreak
4730
%
4731
% Output the actual section heading.
4732
\vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4733
\hangindent=\wd0 % zero if no section number
4734
\unhbox0 #1}%
4735
}%
4736
% Add extra space after the heading -- half of whatever came above it.
4737
% Don't allow stretch, though.
4738
\kern .5 \csname #2headingskip\endcsname
4739
%
4740
% Do not let the kern be a potential breakpoint, as it would be if it
4741
% was followed by glue.
4742
\nobreak
4743
%
4744
% We'll almost certainly start a paragraph next, so don't let that
4745
% glue accumulate. (Not a breakpoint because it's preceded by a
4746
% discardable item.)
4747
\vskip-\parskip
4748
%
4749
% This is purely so the last item on the list is a known \penalty >
4750
% 10000. This is so \startdefun can avoid allowing breakpoints after
4751
% section headings. Otherwise, it would insert a valid breakpoint between:
4752
%
4753
% @section sec-whatever
4754
% @deffn def-whatever
4755
\penalty 10001
4756
}
4757
4758
4759
\message{toc,}
4760
% Table of contents.
4761
\newwrite\tocfile
4762
4763
% Write an entry to the toc file, opening it if necessary.
4764
% Called from @chapter, etc.
4765
%
4766
% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4767
% We append the current node name (if any) and page number as additional
4768
% arguments for the \{chap,sec,...}entry macros which will eventually
4769
% read this. The node name is used in the pdf outlines as the
4770
% destination to jump to.
4771
%
4772
% We open the .toc file for writing here instead of at @setfilename (or
4773
% any other fixed time) so that @contents can be anywhere in the document.
4774
% But if #1 is `omit', then we don't do anything. This is used for the
4775
% table of contents chapter openings themselves.
4776
%
4777
\newif\iftocfileopened
4778
\def\omitkeyword{omit}%
4779
%
4780
\def\writetocentry#1#2#3{%
4781
\edef\writetoctype{#1}%
4782
\ifx\writetoctype\omitkeyword \else
4783
\iftocfileopened\else
4784
\immediate\openout\tocfile = \jobname.toc
4785
\global\tocfileopenedtrue
4786
\fi
4787
%
4788
\iflinks
4789
{\atdummies
4790
\edef\temp{%
4791
\write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4792
\temp
4793
}%
4794
\fi
4795
\fi
4796
%
4797
% Tell \shipout to create a pdf destination on each page, if we're
4798
% writing pdf. These are used in the table of contents. We can't
4799
% just write one on every page because the title pages are numbered
4800
% 1 and 2 (the page numbers aren't printed), and so are the first
4801
% two pages of the document. Thus, we'd have two destinations named
4802
% `1', and two named `2'.
4803
\ifpdf \global\pdfmakepagedesttrue \fi
4804
}
4805
4806
4807
% These characters do not print properly in the Computer Modern roman
4808
% fonts, so we must take special care. This is more or less redundant
4809
% with the Texinfo input format setup at the end of this file.
4810
%
4811
\def\activecatcodes{%
4812
\catcode`\"=\active
4813
\catcode`\$=\active
4814
\catcode`\<=\active
4815
\catcode`\>=\active
4816
\catcode`\\=\active
4817
\catcode`\^=\active
4818
\catcode`\_=\active
4819
\catcode`\|=\active
4820
\catcode`\~=\active
4821
}
4822
4823
4824
% Read the toc file, which is essentially Texinfo input.
4825
\def\readtocfile{%
4826
\setupdatafile
4827
\activecatcodes
4828
\input \jobname.toc
4829
}
4830
4831
\newskip\contentsrightmargin \contentsrightmargin=1in
4832
\newcount\savepageno
4833
\newcount\lastnegativepageno \lastnegativepageno = -1
4834
4835
% Prepare to read what we've written to \tocfile.
4836
%
4837
\def\startcontents#1{%
4838
% If @setchapternewpage on, and @headings double, the contents should
4839
% start on an odd page, unlike chapters. Thus, we maintain
4840
% \contentsalignmacro in parallel with \pagealignmacro.
4841
% From: Torbjorn Granlund <tege@matematik.su.se>
4842
\contentsalignmacro
4843
\immediate\closeout\tocfile
4844
%
4845
% Don't need to put `Contents' or `Short Contents' in the headline.
4846
% It is abundantly clear what they are.
4847
\def\thischapter{}%
4848
\chapmacro{#1}{Yomitfromtoc}{}%
4849
%
4850
\savepageno = \pageno
4851
\begingroup % Set up to handle contents files properly.
4852
\raggedbottom % Worry more about breakpoints than the bottom.
4853
\advance\hsize by -\contentsrightmargin % Don't use the full line length.
4854
%
4855
% Roman numerals for page numbers.
4856
\ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4857
}
4858
4859
4860
% Normal (long) toc.
4861
\def\contents{%
4862
\startcontents{\putwordTOC}%
4863
\openin 1 \jobname.toc
4864
\ifeof 1 \else
4865
\readtocfile
4866
\fi
4867
\vfill \eject
4868
\contentsalignmacro % in case @setchapternewpage odd is in effect
4869
\ifeof 1 \else
4870
\pdfmakeoutlines
4871
\fi
4872
\closein 1
4873
\endgroup
4874
\lastnegativepageno = \pageno
4875
\global\pageno = \savepageno
4876
}
4877
4878
% And just the chapters.
4879
\def\summarycontents{%
4880
\startcontents{\putwordShortTOC}%
4881
%
4882
\let\numchapentry = \shortchapentry
4883
\let\appentry = \shortchapentry
4884
\let\unnchapentry = \shortunnchapentry
4885
% We want a true roman here for the page numbers.
4886
\secfonts
4887
\let\rm=\shortcontrm \let\bf=\shortcontbf
4888
\let\sl=\shortcontsl \let\tt=\shortconttt
4889
\rm
4890
\hyphenpenalty = 10000
4891
\advance\baselineskip by 1pt % Open it up a little.
4892
\def\numsecentry##1##2##3##4{}
4893
\let\appsecentry = \numsecentry
4894
\let\unnsecentry = \numsecentry
4895
\let\numsubsecentry = \numsecentry
4896
\let\appsubsecentry = \numsecentry
4897
\let\unnsubsecentry = \numsecentry
4898
\let\numsubsubsecentry = \numsecentry
4899
\let\appsubsubsecentry = \numsecentry
4900
\let\unnsubsubsecentry = \numsecentry
4901
\openin 1 \jobname.toc
4902
\ifeof 1 \else
4903
\readtocfile
4904
\fi
4905
\closein 1
4906
\vfill \eject
4907
\contentsalignmacro % in case @setchapternewpage odd is in effect
4908
\endgroup
4909
\lastnegativepageno = \pageno
4910
\global\pageno = \savepageno
4911
}
4912
\let\shortcontents = \summarycontents
4913
4914
% Typeset the label for a chapter or appendix for the short contents.
4915
% The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4916
%
4917
\def\shortchaplabel#1{%
4918
% This space should be enough, since a single number is .5em, and the
4919
% widest letter (M) is 1em, at least in the Computer Modern fonts.
4920
% But use \hss just in case.
4921
% (This space doesn't include the extra space that gets added after
4922
% the label; that gets put in by \shortchapentry above.)
4923
%
4924
% We'd like to right-justify chapter numbers, but that looks strange
4925
% with appendix letters. And right-justifying numbers and
4926
% left-justifying letters looks strange when there is less than 10
4927
% chapters. Have to read the whole toc once to know how many chapters
4928
% there are before deciding ...
4929
\hbox to 1em{#1\hss}%
4930
}
4931
4932
% These macros generate individual entries in the table of contents.
4933
% The first argument is the chapter or section name.
4934
% The last argument is the page number.
4935
% The arguments in between are the chapter number, section number, ...
4936
4937
% Chapters, in the main contents.
4938
\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4939
%
4940
% Chapters, in the short toc.
4941
% See comments in \dochapentry re vbox and related settings.
4942
\def\shortchapentry#1#2#3#4{%
4943
\tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4944
}
4945
4946
% Appendices, in the main contents.
4947
% Need the word Appendix, and a fixed-size box.
4948
%
4949
\def\appendixbox#1{%
4950
% We use M since it's probably the widest letter.
4951
\setbox0 = \hbox{\putwordAppendix{} M}%
4952
\hbox to \wd0{\putwordAppendix{} #1\hss}}
4953
%
4954
\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4955
4956
% Unnumbered chapters.
4957
\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4958
\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4959
4960
% Sections.
4961
\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4962
\let\appsecentry=\numsecentry
4963
\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4964
4965
% Subsections.
4966
\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4967
\let\appsubsecentry=\numsubsecentry
4968
\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4969
4970
% And subsubsections.
4971
\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4972
\let\appsubsubsecentry=\numsubsubsecentry
4973
\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4974
4975
% This parameter controls the indentation of the various levels.
4976
% Same as \defaultparindent.
4977
\newdimen\tocindent \tocindent = 15pt
4978
4979
% Now for the actual typesetting. In all these, #1 is the text and #2 is the
4980
% page number.
4981
%
4982
% If the toc has to be broken over pages, we want it to be at chapters
4983
% if at all possible; hence the \penalty.
4984
\def\dochapentry#1#2{%
4985
\penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4986
\begingroup
4987
\chapentryfonts
4988
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
4989
\endgroup
4990
\nobreak\vskip .25\baselineskip plus.1\baselineskip
4991
}
4992
4993
\def\dosecentry#1#2{\begingroup
4994
\secentryfonts \leftskip=\tocindent
4995
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
4996
\endgroup}
4997
4998
\def\dosubsecentry#1#2{\begingroup
4999
\subsecentryfonts \leftskip=2\tocindent
5000
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
5001
\endgroup}
5002
5003
\def\dosubsubsecentry#1#2{\begingroup
5004
\subsubsecentryfonts \leftskip=3\tocindent
5005
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
5006
\endgroup}
5007
5008
% We use the same \entry macro as for the index entries.
5009
\let\tocentry = \entry
5010
5011
% Space between chapter (or whatever) number and the title.
5012
\def\labelspace{\hskip1em \relax}
5013
5014
\def\dopageno#1{{\rm #1}}
5015
\def\doshortpageno#1{{\rm #1}}
5016
5017
\def\chapentryfonts{\secfonts \rm}
5018
\def\secentryfonts{\textfonts}
5019
\def\subsecentryfonts{\textfonts}
5020
\def\subsubsecentryfonts{\textfonts}
5021
5022
5023
\message{environments,}
5024
% @foo ... @end foo.
5025
5026
% @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5027
%
5028
% Since these characters are used in examples, it should be an even number of
5029
% \tt widths. Each \tt character is 1en, so two makes it 1em.
5030
%
5031
\def\point{$\star$}
5032
\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5033
\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
5034
\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5035
\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5036
5037
% The @error{} command.
5038
% Adapted from the TeXbook's \boxit.
5039
%
5040
\newbox\errorbox
5041
%
5042
{\tentt \global\dimen0 = 3em}% Width of the box.
5043
\dimen2 = .55pt % Thickness of rules
5044
% The text. (`r' is open on the right, `e' somewhat less so on the left.)
5045
\setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5046
%
5047
\setbox\errorbox=\hbox to \dimen0{\hfil
5048
\hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5049
\advance\hsize by -2\dimen2 % Rules.
5050
\vbox{%
5051
\hrule height\dimen2
5052
\hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5053
\vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5054
\kern3pt\vrule width\dimen2}% Space to right.
5055
\hrule height\dimen2}
5056
\hfil}
5057
%
5058
\def\error{\leavevmode\lower.7ex\copy\errorbox}
5059
5060
% @tex ... @end tex escapes into raw Tex temporarily.
5061
% One exception: @ is still an escape character, so that @end tex works.
5062
% But \@ or @@ will get a plain tex @ character.
5063
5064
\envdef\tex{%
5065
\catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5066
\catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5067
\catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5068
\catcode `\%=14
5069
\catcode `\+=\other
5070
\catcode `\"=\other
5071
\catcode `\|=\other
5072
\catcode `\<=\other
5073
\catcode `\>=\other
5074
\escapechar=`\\
5075
%
5076
\let\b=\ptexb
5077
\let\bullet=\ptexbullet
5078
\let\c=\ptexc
5079
\let\,=\ptexcomma
5080
\let\.=\ptexdot
5081
\let\dots=\ptexdots
5082
\let\equiv=\ptexequiv
5083
\let\!=\ptexexclam
5084
\let\i=\ptexi
5085
\let\indent=\ptexindent
5086
\let\noindent=\ptexnoindent
5087
\let\{=\ptexlbrace
5088
\let\+=\tabalign
5089
\let\}=\ptexrbrace
5090
\let\/=\ptexslash
5091
\let\*=\ptexstar
5092
\let\t=\ptext
5093
\let\frenchspacing=\plainfrenchspacing
5094
%
5095
\def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5096
\def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5097
\def\@{@}%
5098
}
5099
% There is no need to define \Etex.
5100
5101
% Define @lisp ... @end lisp.
5102
% @lisp environment forms a group so it can rebind things,
5103
% including the definition of @end lisp (which normally is erroneous).
5104
5105
% Amount to narrow the margins by for @lisp.
5106
\newskip\lispnarrowing \lispnarrowing=0.4in
5107
5108
% This is the definition that ^^M gets inside @lisp, @example, and other
5109
% such environments. \null is better than a space, since it doesn't
5110
% have any width.
5111
\def\lisppar{\null\endgraf}
5112
5113
% This space is always present above and below environments.
5114
\newskip\envskipamount \envskipamount = 0pt
5115
5116
% Make spacing and below environment symmetrical. We use \parskip here
5117
% to help in doing that, since in @example-like environments \parskip
5118
% is reset to zero; thus the \afterenvbreak inserts no space -- but the
5119
% start of the next paragraph will insert \parskip.
5120
%
5121
\def\aboveenvbreak{{%
5122
% =10000 instead of <10000 because of a special case in \itemzzz and
5123
% \sectionheading, q.v.
5124
\ifnum \lastpenalty=10000 \else
5125
\advance\envskipamount by \parskip
5126
\endgraf
5127
\ifdim\lastskip<\envskipamount
5128
\removelastskip
5129
% it's not a good place to break if the last penalty was \nobreak
5130
% or better ...
5131
\ifnum\lastpenalty<10000 \penalty-50 \fi
5132
\vskip\envskipamount
5133
\fi
5134
\fi
5135
}}
5136
5137
\let\afterenvbreak = \aboveenvbreak
5138
5139
% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5140
% also clear it, so that its embedded environments do the narrowing again.
5141
\let\nonarrowing=\relax
5142
5143
% @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5144
% environment contents.
5145
\font\circle=lcircle10
5146
\newdimen\circthick
5147
\newdimen\cartouter\newdimen\cartinner
5148
\newskip\normbskip\newskip\normpskip\newskip\normlskip
5149
\circthick=\fontdimen8\circle
5150
%
5151
\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5152
\def\ctr{{\hskip 6pt\circle\char'010}}
5153
\def\cbl{{\circle\char'012\hskip -6pt}}
5154
\def\cbr{{\hskip 6pt\circle\char'011}}
5155
\def\carttop{\hbox to \cartouter{\hskip\lskip
5156
\ctl\leaders\hrule height\circthick\hfil\ctr
5157
\hskip\rskip}}
5158
\def\cartbot{\hbox to \cartouter{\hskip\lskip
5159
\cbl\leaders\hrule height\circthick\hfil\cbr
5160
\hskip\rskip}}
5161
%
5162
\newskip\lskip\newskip\rskip
5163
5164
\envdef\cartouche{%
5165
\ifhmode\par\fi % can't be in the midst of a paragraph.
5166
\startsavinginserts
5167
\lskip=\leftskip \rskip=\rightskip
5168
\leftskip=0pt\rightskip=0pt % we want these *outside*.
5169
\cartinner=\hsize \advance\cartinner by-\lskip
5170
\advance\cartinner by-\rskip
5171
\cartouter=\hsize
5172
\advance\cartouter by 18.4pt % allow for 3pt kerns on either
5173
% side, and for 6pt waste from
5174
% each corner char, and rule thickness
5175
\normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5176
% Flag to tell @lisp, etc., not to narrow margin.
5177
\let\nonarrowing = t%
5178
\vbox\bgroup
5179
\baselineskip=0pt\parskip=0pt\lineskip=0pt
5180
\carttop
5181
\hbox\bgroup
5182
\hskip\lskip
5183
\vrule\kern3pt
5184
\vbox\bgroup
5185
\kern3pt
5186
\hsize=\cartinner
5187
\baselineskip=\normbskip
5188
\lineskip=\normlskip
5189
\parskip=\normpskip
5190
\vskip -\parskip
5191
\comment % For explanation, see the end of \def\group.
5192
}
5193
\def\Ecartouche{%
5194
\ifhmode\par\fi
5195
\kern3pt
5196
\egroup
5197
\kern3pt\vrule
5198
\hskip\rskip
5199
\egroup
5200
\cartbot
5201
\egroup
5202
\checkinserts
5203
}
5204
5205
5206
% This macro is called at the beginning of all the @example variants,
5207
% inside a group.
5208
\def\nonfillstart{%
5209
\aboveenvbreak
5210
\hfuzz = 12pt % Don't be fussy
5211
\sepspaces % Make spaces be word-separators rather than space tokens.
5212
\let\par = \lisppar % don't ignore blank lines
5213
\obeylines % each line of input is a line of output
5214
\parskip = 0pt
5215
\parindent = 0pt
5216
\emergencystretch = 0pt % don't try to avoid overfull boxes
5217
\ifx\nonarrowing\relax
5218
\advance \leftskip by \lispnarrowing
5219
\exdentamount=\lispnarrowing
5220
\else
5221
\let\nonarrowing = \relax
5222
\fi
5223
\let\exdent=\nofillexdent
5224
}
5225
5226
% If you want all examples etc. small: @set dispenvsize small.
5227
% If you want even small examples the full size: @set dispenvsize nosmall.
5228
% This affects the following displayed environments:
5229
% @example, @display, @format, @lisp
5230
%
5231
\def\smallword{small}
5232
\def\nosmallword{nosmall}
5233
\let\SETdispenvsize\relax
5234
\def\setnormaldispenv{%
5235
\ifx\SETdispenvsize\smallword
5236
\smallexamplefonts \rm
5237
\fi
5238
}
5239
\def\setsmalldispenv{%
5240
\ifx\SETdispenvsize\nosmallword
5241
\else
5242
\smallexamplefonts \rm
5243
\fi
5244
}
5245
5246
% We often define two environments, @foo and @smallfoo.
5247
% Let's do it by one command:
5248
\def\makedispenv #1#2{
5249
\expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5250
\expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5251
\expandafter\let\csname E#1\endcsname \afterenvbreak
5252
\expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5253
}
5254
5255
% Define two synonyms:
5256
\def\maketwodispenvs #1#2#3{
5257
\makedispenv{#1}{#3}
5258
\makedispenv{#2}{#3}
5259
}
5260
5261
% @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5262
%
5263
% @smallexample and @smalllisp: use smaller fonts.
5264
% Originally contributed by Pavel@xerox.
5265
%
5266
\maketwodispenvs {lisp}{example}{%
5267
\nonfillstart
5268
\tt\quoteexpand
5269
\let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5270
\gobble % eat return
5271
}
5272
% @display/@smalldisplay: same as @lisp except keep current font.
5273
%
5274
\makedispenv {display}{%
5275
\nonfillstart
5276
\gobble
5277
}
5278
5279
% @format/@smallformat: same as @display except don't narrow margins.
5280
%
5281
\makedispenv{format}{%
5282
\let\nonarrowing = t%
5283
\nonfillstart
5284
\gobble
5285
}
5286
5287
% @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5288
\envdef\flushleft{%
5289
\let\nonarrowing = t%
5290
\nonfillstart
5291
\gobble
5292
}
5293
\let\Eflushleft = \afterenvbreak
5294
5295
% @flushright.
5296
%
5297
\envdef\flushright{%
5298
\let\nonarrowing = t%
5299
\nonfillstart
5300
\advance\leftskip by 0pt plus 1fill
5301
\gobble
5302
}
5303
\let\Eflushright = \afterenvbreak
5304
5305
5306
% @quotation does normal linebreaking (hence we can't use \nonfillstart)
5307
% and narrows the margins. We keep \parskip nonzero in general, since
5308
% we're doing normal filling. So, when using \aboveenvbreak and
5309
% \afterenvbreak, temporarily make \parskip 0.
5310
%
5311
\envdef\quotation{%
5312
{\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5313
\parindent=0pt
5314
%
5315
% @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5316
\ifx\nonarrowing\relax
5317
\advance\leftskip by \lispnarrowing
5318
\advance\rightskip by \lispnarrowing
5319
\exdentamount = \lispnarrowing
5320
\else
5321
\let\nonarrowing = \relax
5322
\fi
5323
\parsearg\quotationlabel
5324
}
5325
5326
% We have retained a nonzero parskip for the environment, since we're
5327
% doing normal filling.
5328
%
5329
\def\Equotation{%
5330
\par
5331
\ifx\quotationauthor\undefined\else
5332
% indent a bit.
5333
\leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5334
\fi
5335
{\parskip=0pt \afterenvbreak}%
5336
}
5337
5338
% If we're given an argument, typeset it in bold with a colon after.
5339
\def\quotationlabel#1{%
5340
\def\temp{#1}%
5341
\ifx\temp\empty \else
5342
{\bf #1: }%
5343
\fi
5344
}
5345
5346
5347
% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5348
% If we want to allow any <char> as delimiter,
5349
% we need the curly braces so that makeinfo sees the @verb command, eg:
5350
% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5351
%
5352
% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5353
%
5354
% [Knuth] p.344; only we need to do the other characters Texinfo sets
5355
% active too. Otherwise, they get lost as the first character on a
5356
% verbatim line.
5357
\def\dospecials{%
5358
\do\ \do\\\do\{\do\}\do\$\do\&%
5359
\do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5360
\do\<\do\>\do\|\do\@\do+\do\"%
5361
}
5362
%
5363
% [Knuth] p. 380
5364
\def\uncatcodespecials{%
5365
\def\do##1{\catcode`##1=\other}\dospecials}
5366
%
5367
% [Knuth] pp. 380,381,391
5368
% Disable Spanish ligatures ?` and !` of \tt font
5369
\begingroup
5370
\catcode`\`=\active\gdef`{\relax\lq}
5371
\endgroup
5372
%
5373
% Setup for the @verb command.
5374
%
5375
% Eight spaces for a tab
5376
\begingroup
5377
\catcode`\^^I=\active
5378
\gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5379
\endgroup
5380
%
5381
\def\setupverb{%
5382
\tt % easiest (and conventionally used) font for verbatim
5383
\def\par{\leavevmode\endgraf}%
5384
\catcode`\`=\active
5385
\tabeightspaces
5386
% Respect line breaks,
5387
% print special symbols as themselves, and
5388
% make each space count
5389
% must do in this order:
5390
\obeylines \uncatcodespecials \sepspaces
5391
}
5392
5393
% Setup for the @verbatim environment
5394
%
5395
% Real tab expansion
5396
\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5397
%
5398
\def\starttabbox{\setbox0=\hbox\bgroup}
5399
5400
% Allow an option to not replace quotes with a regular directed right
5401
% quote/apostrophe (char 0x27), but instead use the undirected quote
5402
% from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
5403
% the default, but it works for pasting with more pdf viewers (at least
5404
% evince), the lilypond developers report. xpdf does work with the
5405
% regular 0x27.
5406
%
5407
\def\singlequotechar{%
5408
\expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
5409
'%
5410
\else
5411
\char'15
5412
\fi
5413
}
5414
%
5415
\begingroup
5416
\catcode`\^^I=\active
5417
\gdef\tabexpand{%
5418
\catcode`\^^I=\active
5419
\def^^I{\leavevmode\egroup
5420
\dimen0=\wd0 % the width so far, or since the previous tab
5421
\divide\dimen0 by\tabw
5422
\multiply\dimen0 by\tabw % compute previous multiple of \tabw
5423
\advance\dimen0 by\tabw % advance to next multiple of \tabw
5424
\wd0=\dimen0 \box0 \starttabbox
5425
}%
5426
}
5427
\catcode`\'=\active
5428
\gdef\quoteexpand{%
5429
\catcode`\'=\active
5430
\def'{\singlequotechar}
5431
}%
5432
\endgroup
5433
%
5434
\def\setupverbatim{%
5435
\let\nonarrowing = t%
5436
\nonfillstart
5437
% Easiest (and conventionally used) font for verbatim
5438
\tt
5439
\def\par{\leavevmode\egroup\box0\endgraf}%
5440
\catcode`\`=\active
5441
\tabexpand
5442
\quoteexpand
5443
% Respect line breaks,
5444
% print special symbols as themselves, and
5445
% make each space count
5446
% must do in this order:
5447
\obeylines \uncatcodespecials \sepspaces
5448
\everypar{\starttabbox}%
5449
}
5450
5451
% Do the @verb magic: verbatim text is quoted by unique
5452
% delimiter characters. Before first delimiter expect a
5453
% right brace, after last delimiter expect closing brace:
5454
%
5455
% \def\doverb'{'<char>#1<char>'}'{#1}
5456
%
5457
% [Knuth] p. 382; only eat outer {}
5458
\begingroup
5459
\catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5460
\gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5461
\endgroup
5462
%
5463
\def\verb{\begingroup\setupverb\doverb}
5464
%
5465
%
5466
% Do the @verbatim magic: define the macro \doverbatim so that
5467
% the (first) argument ends when '@end verbatim' is reached, ie:
5468
%
5469
% \def\doverbatim#1@end verbatim{#1}
5470
%
5471
% For Texinfo it's a lot easier than for LaTeX,
5472
% because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5473
% we need not redefine '\', '{' and '}'.
5474
%
5475
% Inspired by LaTeX's verbatim command set [latex.ltx]
5476
%
5477
\begingroup
5478
\catcode`\ =\active
5479
\obeylines %
5480
% ignore everything up to the first ^^M, that's the newline at the end
5481
% of the @verbatim input line itself. Otherwise we get an extra blank
5482
% line in the output.
5483
\xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5484
% We really want {...\end verbatim} in the body of the macro, but
5485
% without the active space; thus we have to use \xdef and \gobble.
5486
\endgroup
5487
%
5488
\envdef\verbatim{%
5489
\setupverbatim\doverbatim
5490
}
5491
\let\Everbatim = \afterenvbreak
5492
5493
5494
% @verbatiminclude FILE - insert text of file in verbatim environment.
5495
%
5496
\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5497
%
5498
\def\doverbatiminclude#1{%
5499
{%
5500
\makevalueexpandable
5501
\setupverbatim
5502
\input #1
5503
\afterenvbreak
5504
}%
5505
}
5506
5507
% @copying ... @end copying.
5508
% Save the text away for @insertcopying later.
5509
%
5510
% We save the uninterpreted tokens, rather than creating a box.
5511
% Saving the text in a box would be much easier, but then all the
5512
% typesetting commands (@smallbook, font changes, etc.) have to be done
5513
% beforehand -- and a) we want @copying to be done first in the source
5514
% file; b) letting users define the frontmatter in as flexible order as
5515
% possible is very desirable.
5516
%
5517
\def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5518
\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5519
%
5520
\def\insertcopying{%
5521
\begingroup
5522
\parindent = 0pt % paragraph indentation looks wrong on title page
5523
\scanexp\copyingtext
5524
\endgroup
5525
}
5526
5527
\message{defuns,}
5528
% @defun etc.
5529
5530
\newskip\defbodyindent \defbodyindent=.4in
5531
\newskip\defargsindent \defargsindent=50pt
5532
\newskip\deflastargmargin \deflastargmargin=18pt
5533
5534
% Start the processing of @deffn:
5535
\def\startdefun{%
5536
\ifnum\lastpenalty<10000
5537
\medbreak
5538
\else
5539
% If there are two @def commands in a row, we'll have a \nobreak,
5540
% which is there to keep the function description together with its
5541
% header. But if there's nothing but headers, we need to allow a
5542
% break somewhere. Check specifically for penalty 10002, inserted
5543
% by \defargscommonending, instead of 10000, since the sectioning
5544
% commands also insert a nobreak penalty, and we don't want to allow
5545
% a break between a section heading and a defun.
5546
%
5547
\ifnum\lastpenalty=10002 \penalty2000 \fi
5548
%
5549
% Similarly, after a section heading, do not allow a break.
5550
% But do insert the glue.
5551
\medskip % preceded by discardable penalty, so not a breakpoint
5552
\fi
5553
%
5554
\parindent=0in
5555
\advance\leftskip by \defbodyindent
5556
\exdentamount=\defbodyindent
5557
}
5558
5559
\def\dodefunx#1{%
5560
% First, check whether we are in the right environment:
5561
\checkenv#1%
5562
%
5563
% As above, allow line break if we have multiple x headers in a row.
5564
% It's not a great place, though.
5565
\ifnum\lastpenalty=10002 \penalty3000 \fi
5566
%
5567
% And now, it's time to reuse the body of the original defun:
5568
\expandafter\gobbledefun#1%
5569
}
5570
\def\gobbledefun#1\startdefun{}
5571
5572
% \printdefunline \deffnheader{text}
5573
%
5574
\def\printdefunline#1#2{%
5575
\begingroup
5576
% call \deffnheader:
5577
#1#2 \endheader
5578
% common ending:
5579
\interlinepenalty = 10000
5580
\advance\rightskip by 0pt plus 1fil
5581
\endgraf
5582
\nobreak\vskip -\parskip
5583
\penalty 10002 % signal to \startdefun and \dodefunx
5584
% Some of the @defun-type tags do not enable magic parentheses,
5585
% rendering the following check redundant. But we don't optimize.
5586
\checkparencounts
5587
\endgroup
5588
}
5589
5590
\def\Edefun{\endgraf\medbreak}
5591
5592
% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5593
% the only thing remainnig is to define \deffnheader.
5594
%
5595
\def\makedefun#1{%
5596
\expandafter\let\csname E#1\endcsname = \Edefun
5597
\edef\temp{\noexpand\domakedefun
5598
\makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5599
\temp
5600
}
5601
5602
% \domakedefun \deffn \deffnx \deffnheader
5603
%
5604
% Define \deffn and \deffnx, without parameters.
5605
% \deffnheader has to be defined explicitly.
5606
%
5607
\def\domakedefun#1#2#3{%
5608
\envdef#1{%
5609
\startdefun
5610
\parseargusing\activeparens{\printdefunline#3}%
5611
}%
5612
\def#2{\dodefunx#1}%
5613
\def#3%
5614
}
5615
5616
%%% Untyped functions:
5617
5618
% @deffn category name args
5619
\makedefun{deffn}{\deffngeneral{}}
5620
5621
% @deffn category class name args
5622
\makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5623
5624
% \defopon {category on}class name args
5625
\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5626
5627
% \deffngeneral {subind}category name args
5628
%
5629
\def\deffngeneral#1#2 #3 #4\endheader{%
5630
% Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5631
\dosubind{fn}{\code{#3}}{#1}%
5632
\defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5633
}
5634
5635
%%% Typed functions:
5636
5637
% @deftypefn category type name args
5638
\makedefun{deftypefn}{\deftypefngeneral{}}
5639
5640
% @deftypeop category class type name args
5641
\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5642
5643
% \deftypeopon {category on}class type name args
5644
\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5645
5646
% \deftypefngeneral {subind}category type name args
5647
%
5648
\def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5649
\dosubind{fn}{\code{#4}}{#1}%
5650
\defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5651
}
5652
5653
%%% Typed variables:
5654
5655
% @deftypevr category type var args
5656
\makedefun{deftypevr}{\deftypecvgeneral{}}
5657
5658
% @deftypecv category class type var args
5659
\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5660
5661
% \deftypecvof {category of}class type var args
5662
\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5663
5664
% \deftypecvgeneral {subind}category type var args
5665
%
5666
\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5667
\dosubind{vr}{\code{#4}}{#1}%
5668
\defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5669
}
5670
5671
%%% Untyped variables:
5672
5673
% @defvr category var args
5674
\makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5675
5676
% @defcv category class var args
5677
\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5678
5679
% \defcvof {category of}class var args
5680
\def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5681
5682
%%% Type:
5683
% @deftp category name args
5684
\makedefun{deftp}#1 #2 #3\endheader{%
5685
\doind{tp}{\code{#2}}%
5686
\defname{#1}{}{#2}\defunargs{#3\unskip}%
5687
}
5688
5689
% Remaining @defun-like shortcuts:
5690
\makedefun{defun}{\deffnheader{\putwordDeffunc} }
5691
\makedefun{defmac}{\deffnheader{\putwordDefmac} }
5692
\makedefun{defspec}{\deffnheader{\putwordDefspec} }
5693
\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5694
\makedefun{defvar}{\defvrheader{\putwordDefvar} }
5695
\makedefun{defopt}{\defvrheader{\putwordDefopt} }
5696
\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5697
\makedefun{defmethod}{\defopon\putwordMethodon}
5698
\makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5699
\makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5700
\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5701
5702
% \defname, which formats the name of the @def (not the args).
5703
% #1 is the category, such as "Function".
5704
% #2 is the return type, if any.
5705
% #3 is the function name.
5706
%
5707
% We are followed by (but not passed) the arguments, if any.
5708
%
5709
\def\defname#1#2#3{%
5710
% Get the values of \leftskip and \rightskip as they were outside the @def...
5711
\advance\leftskip by -\defbodyindent
5712
%
5713
% How we'll format the type name. Putting it in brackets helps
5714
% distinguish it from the body text that may end up on the next line
5715
% just below it.
5716
\def\temp{#1}%
5717
\setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5718
%
5719
% Figure out line sizes for the paragraph shape.
5720
% The first line needs space for \box0; but if \rightskip is nonzero,
5721
% we need only space for the part of \box0 which exceeds it:
5722
\dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5723
% The continuations:
5724
\dimen2=\hsize \advance\dimen2 by -\defargsindent
5725
% (plain.tex says that \dimen1 should be used only as global.)
5726
\parshape 2 0in \dimen0 \defargsindent \dimen2
5727
%
5728
% Put the type name to the right margin.
5729
\noindent
5730
\hbox to 0pt{%
5731
\hfil\box0 \kern-\hsize
5732
% \hsize has to be shortened this way:
5733
\kern\leftskip
5734
% Intentionally do not respect \rightskip, since we need the space.
5735
}%
5736
%
5737
% Allow all lines to be underfull without complaint:
5738
\tolerance=10000 \hbadness=10000
5739
\exdentamount=\defbodyindent
5740
{%
5741
% defun fonts. We use typewriter by default (used to be bold) because:
5742
% . we're printing identifiers, they should be in tt in principle.
5743
% . in languages with many accents, such as Czech or French, it's
5744
% common to leave accents off identifiers. The result looks ok in
5745
% tt, but exceedingly strange in rm.
5746
% . we don't want -- and --- to be treated as ligatures.
5747
% . this still does not fix the ?` and !` ligatures, but so far no
5748
% one has made identifiers using them :).
5749
\df \tt
5750
\def\temp{#2}% return value type
5751
\ifx\temp\empty\else \tclose{\temp} \fi
5752
#3% output function name
5753
}%
5754
{\rm\enskip}% hskip 0.5 em of \tenrm
5755
%
5756
\boldbrax
5757
% arguments will be output next, if any.
5758
}
5759
5760
% Print arguments in slanted roman (not ttsl), inconsistently with using
5761
% tt for the name. This is because literal text is sometimes needed in
5762
% the argument list (groff manual), and ttsl and tt are not very
5763
% distinguishable. Prevent hyphenation at `-' chars.
5764
%
5765
\def\defunargs#1{%
5766
% use sl by default (not ttsl),
5767
% tt for the names.
5768
\df \sl \hyphenchar\font=0
5769
%
5770
% On the other hand, if an argument has two dashes (for instance), we
5771
% want a way to get ttsl. Let's try @var for that.
5772
\let\var=\ttslanted
5773
#1%
5774
\sl\hyphenchar\font=45
5775
}
5776
5777
% We want ()&[] to print specially on the defun line.
5778
%
5779
\def\activeparens{%
5780
\catcode`\(=\active \catcode`\)=\active
5781
\catcode`\[=\active \catcode`\]=\active
5782
\catcode`\&=\active
5783
}
5784
5785
% Make control sequences which act like normal parenthesis chars.
5786
\let\lparen = ( \let\rparen = )
5787
5788
% Be sure that we always have a definition for `(', etc. For example,
5789
% if the fn name has parens in it, \boldbrax will not be in effect yet,
5790
% so TeX would otherwise complain about undefined control sequence.
5791
{
5792
\activeparens
5793
\global\let(=\lparen \global\let)=\rparen
5794
\global\let[=\lbrack \global\let]=\rbrack
5795
\global\let& = \&
5796
5797
\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5798
\gdef\magicamp{\let&=\amprm}
5799
}
5800
5801
\newcount\parencount
5802
5803
% If we encounter &foo, then turn on ()-hacking afterwards
5804
\newif\ifampseen
5805
\def\amprm#1 {\ampseentrue{\bf\ }}
5806
5807
\def\parenfont{%
5808
\ifampseen
5809
% At the first level, print parens in roman,
5810
% otherwise use the default font.
5811
\ifnum \parencount=1 \rm \fi
5812
\else
5813
% The \sf parens (in \boldbrax) actually are a little bolder than
5814
% the contained text. This is especially needed for [ and ] .
5815
\sf
5816
\fi
5817
}
5818
\def\infirstlevel#1{%
5819
\ifampseen
5820
\ifnum\parencount=1
5821
#1%
5822
\fi
5823
\fi
5824
}
5825
\def\bfafterword#1 {#1 \bf}
5826
5827
\def\opnr{%
5828
\global\advance\parencount by 1
5829
{\parenfont(}%
5830
\infirstlevel \bfafterword
5831
}
5832
\def\clnr{%
5833
{\parenfont)}%
5834
\infirstlevel \sl
5835
\global\advance\parencount by -1
5836
}
5837
5838
\newcount\brackcount
5839
\def\lbrb{%
5840
\global\advance\brackcount by 1
5841
{\bf[}%
5842
}
5843
\def\rbrb{%
5844
{\bf]}%
5845
\global\advance\brackcount by -1
5846
}
5847
5848
\def\checkparencounts{%
5849
\ifnum\parencount=0 \else \badparencount \fi
5850
\ifnum\brackcount=0 \else \badbrackcount \fi
5851
}
5852
\def\badparencount{%
5853
\errmessage{Unbalanced parentheses in @def}%
5854
\global\parencount=0
5855
}
5856
\def\badbrackcount{%
5857
\errmessage{Unbalanced square braces in @def}%
5858
\global\brackcount=0
5859
}
5860
5861
5862
\message{macros,}
5863
% @macro.
5864
5865
% To do this right we need a feature of e-TeX, \scantokens,
5866
% which we arrange to emulate with a temporary file in ordinary TeX.
5867
\ifx\eTeXversion\undefined
5868
\newwrite\macscribble
5869
\def\scantokens#1{%
5870
\toks0={#1}%
5871
\immediate\openout\macscribble=\jobname.tmp
5872
\immediate\write\macscribble{\the\toks0}%
5873
\immediate\closeout\macscribble
5874
\input \jobname.tmp
5875
}
5876
\fi
5877
5878
\def\scanmacro#1{%
5879
\begingroup
5880
\newlinechar`\^^M
5881
\let\xeatspaces\eatspaces
5882
% Undo catcode changes of \startcontents and \doprintindex
5883
% When called from @insertcopying or (short)caption, we need active
5884
% backslash to get it printed correctly. Previously, we had
5885
% \catcode`\\=\other instead. We'll see whether a problem appears
5886
% with macro expansion. --kasal, 19aug04
5887
\catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5888
% ... and \example
5889
\spaceisspace
5890
%
5891
% Append \endinput to make sure that TeX does not see the ending newline.
5892
% I've verified that it is necessary both for e-TeX and for ordinary TeX
5893
% --kasal, 29nov03
5894
\scantokens{#1\endinput}%
5895
\endgroup
5896
}
5897
5898
\def\scanexp#1{%
5899
\edef\temp{\noexpand\scanmacro{#1}}%
5900
\temp
5901
}
5902
5903
\newcount\paramno % Count of parameters
5904
\newtoks\macname % Macro name
5905
\newif\ifrecursive % Is it recursive?
5906
5907
% List of all defined macros in the form
5908
% \definedummyword\macro1\definedummyword\macro2...
5909
% Currently is also contains all @aliases; the list can be split
5910
% if there is a need.
5911
\def\macrolist{}
5912
5913
% Add the macro to \macrolist
5914
\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5915
\def\addtomacrolistxxx#1{%
5916
\toks0 = \expandafter{\macrolist\definedummyword#1}%
5917
\xdef\macrolist{\the\toks0}%
5918
}
5919
5920
% Utility routines.
5921
% This does \let #1 = #2, with \csnames; that is,
5922
% \let \csname#1\endcsname = \csname#2\endcsname
5923
% (except of course we have to play expansion games).
5924
%
5925
\def\cslet#1#2{%
5926
\expandafter\let
5927
\csname#1\expandafter\endcsname
5928
\csname#2\endcsname
5929
}
5930
5931
% Trim leading and trailing spaces off a string.
5932
% Concepts from aro-bend problem 15 (see CTAN).
5933
{\catcode`\@=11
5934
\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5935
\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5936
\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5937
\def\unbrace#1{#1}
5938
\unbrace{\gdef\trim@@@ #1 } #2@{#1}
5939
}
5940
5941
% Trim a single trailing ^^M off a string.
5942
{\catcode`\^^M=\other \catcode`\Q=3%
5943
\gdef\eatcr #1{\eatcra #1Q^^MQ}%
5944
\gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5945
\gdef\eatcrb#1Q#2Q{#1}%
5946
}
5947
5948
% Macro bodies are absorbed as an argument in a context where
5949
% all characters are catcode 10, 11 or 12, except \ which is active
5950
% (as in normal texinfo). It is necessary to change the definition of \.
5951
5952
% It's necessary to have hard CRs when the macro is executed. This is
5953
% done by making ^^M (\endlinechar) catcode 12 when reading the macro
5954
% body, and then making it the \newlinechar in \scanmacro.
5955
5956
\def\scanctxt{%
5957
\catcode`\"=\other
5958
\catcode`\+=\other
5959
\catcode`\<=\other
5960
\catcode`\>=\other
5961
\catcode`\@=\other
5962
\catcode`\^=\other
5963
\catcode`\_=\other
5964
\catcode`\|=\other
5965
\catcode`\~=\other
5966
}
5967
5968
\def\scanargctxt{%
5969
\scanctxt
5970
\catcode`\\=\other
5971
\catcode`\^^M=\other
5972
}
5973
5974
\def\macrobodyctxt{%
5975
\scanctxt
5976
\catcode`\{=\other
5977
\catcode`\}=\other
5978
\catcode`\^^M=\other
5979
\usembodybackslash
5980
}
5981
5982
\def\macroargctxt{%
5983
\scanctxt
5984
\catcode`\\=\other
5985
}
5986
5987
% \mbodybackslash is the definition of \ in @macro bodies.
5988
% It maps \foo\ => \csname macarg.foo\endcsname => #N
5989
% where N is the macro parameter number.
5990
% We define \csname macarg.\endcsname to be \realbackslash, so
5991
% \\ in macro replacement text gets you a backslash.
5992
5993
{\catcode`@=0 @catcode`@\=@active
5994
@gdef@usembodybackslash{@let\=@mbodybackslash}
5995
@gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5996
}
5997
\expandafter\def\csname macarg.\endcsname{\realbackslash}
5998
5999
\def\macro{\recursivefalse\parsearg\macroxxx}
6000
\def\rmacro{\recursivetrue\parsearg\macroxxx}
6001
6002
\def\macroxxx#1{%
6003
\getargs{#1}% now \macname is the macname and \argl the arglist
6004
\ifx\argl\empty % no arguments
6005
\paramno=0%
6006
\else
6007
\expandafter\parsemargdef \argl;%
6008
\fi
6009
\if1\csname ismacro.\the\macname\endcsname
6010
\message{Warning: redefining \the\macname}%
6011
\else
6012
\expandafter\ifx\csname \the\macname\endcsname \relax
6013
\else \errmessage{Macro name \the\macname\space already defined}\fi
6014
\global\cslet{macsave.\the\macname}{\the\macname}%
6015
\global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6016
\addtomacrolist{\the\macname}%
6017
\fi
6018
\begingroup \macrobodyctxt
6019
\ifrecursive \expandafter\parsermacbody
6020
\else \expandafter\parsemacbody
6021
\fi}
6022
6023
\parseargdef\unmacro{%
6024
\if1\csname ismacro.#1\endcsname
6025
\global\cslet{#1}{macsave.#1}%
6026
\global\expandafter\let \csname ismacro.#1\endcsname=0%
6027
% Remove the macro name from \macrolist:
6028
\begingroup
6029
\expandafter\let\csname#1\endcsname \relax
6030
\let\definedummyword\unmacrodo
6031
\xdef\macrolist{\macrolist}%
6032
\endgroup
6033
\else
6034
\errmessage{Macro #1 not defined}%
6035
\fi
6036
}
6037
6038
% Called by \do from \dounmacro on each macro. The idea is to omit any
6039
% macro definitions that have been changed to \relax.
6040
%
6041
\def\unmacrodo#1{%
6042
\ifx #1\relax
6043
% remove this
6044
\else
6045
\noexpand\definedummyword \noexpand#1%
6046
\fi
6047
}
6048
6049
% This makes use of the obscure feature that if the last token of a
6050
% <parameter list> is #, then the preceding argument is delimited by
6051
% an opening brace, and that opening brace is not consumed.
6052
\def\getargs#1{\getargsxxx#1{}}
6053
\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6054
\def\getmacname #1 #2\relax{\macname={#1}}
6055
\def\getmacargs#1{\def\argl{#1}}
6056
6057
% Parse the optional {params} list. Set up \paramno and \paramlist
6058
% so \defmacro knows what to do. Define \macarg.blah for each blah
6059
% in the params list, to be ##N where N is the position in that list.
6060
% That gets used by \mbodybackslash (above).
6061
6062
% We need to get `macro parameter char #' into several definitions.
6063
% The technique used is stolen from LaTeX: let \hash be something
6064
% unexpandable, insert that wherever you need a #, and then redefine
6065
% it to # just before using the token list produced.
6066
%
6067
% The same technique is used to protect \eatspaces till just before
6068
% the macro is used.
6069
6070
\def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6071
\let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6072
\def\parsemargdefxxx#1,{%
6073
\if#1;\let\next=\relax
6074
\else \let\next=\parsemargdefxxx
6075
\advance\paramno by 1%
6076
\expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6077
{\xeatspaces{\hash\the\paramno}}%
6078
\edef\paramlist{\paramlist\hash\the\paramno,}%
6079
\fi\next}
6080
6081
% These two commands read recursive and nonrecursive macro bodies.
6082
% (They're different since rec and nonrec macros end differently.)
6083
6084
\long\def\parsemacbody#1@end macro%
6085
{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6086
\long\def\parsermacbody#1@end rmacro%
6087
{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6088
6089
% This defines the macro itself. There are six cases: recursive and
6090
% nonrecursive macros of zero, one, and many arguments.
6091
% Much magic with \expandafter here.
6092
% \xdef is used so that macro definitions will survive the file
6093
% they're defined in; @include reads the file inside a group.
6094
\def\defmacro{%
6095
\let\hash=##% convert placeholders to macro parameter chars
6096
\ifrecursive
6097
\ifcase\paramno
6098
% 0
6099
\expandafter\xdef\csname\the\macname\endcsname{%
6100
\noexpand\scanmacro{\temp}}%
6101
\or % 1
6102
\expandafter\xdef\csname\the\macname\endcsname{%
6103
\bgroup\noexpand\macroargctxt
6104
\noexpand\braceorline
6105
\expandafter\noexpand\csname\the\macname xxx\endcsname}%
6106
\expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6107
\egroup\noexpand\scanmacro{\temp}}%
6108
\else % many
6109
\expandafter\xdef\csname\the\macname\endcsname{%
6110
\bgroup\noexpand\macroargctxt
6111
\noexpand\csname\the\macname xx\endcsname}%
6112
\expandafter\xdef\csname\the\macname xx\endcsname##1{%
6113
\expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6114
\expandafter\expandafter
6115
\expandafter\xdef
6116
\expandafter\expandafter
6117
\csname\the\macname xxx\endcsname
6118
\paramlist{\egroup\noexpand\scanmacro{\temp}}%
6119
\fi
6120
\else
6121
\ifcase\paramno
6122
% 0
6123
\expandafter\xdef\csname\the\macname\endcsname{%
6124
\noexpand\norecurse{\the\macname}%
6125
\noexpand\scanmacro{\temp}\egroup}%
6126
\or % 1
6127
\expandafter\xdef\csname\the\macname\endcsname{%
6128
\bgroup\noexpand\macroargctxt
6129
\noexpand\braceorline
6130
\expandafter\noexpand\csname\the\macname xxx\endcsname}%
6131
\expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6132
\egroup
6133
\noexpand\norecurse{\the\macname}%
6134
\noexpand\scanmacro{\temp}\egroup}%
6135
\else % many
6136
\expandafter\xdef\csname\the\macname\endcsname{%
6137
\bgroup\noexpand\macroargctxt
6138
\expandafter\noexpand\csname\the\macname xx\endcsname}%
6139
\expandafter\xdef\csname\the\macname xx\endcsname##1{%
6140
\expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6141
\expandafter\expandafter
6142
\expandafter\xdef
6143
\expandafter\expandafter
6144
\csname\the\macname xxx\endcsname
6145
\paramlist{%
6146
\egroup
6147
\noexpand\norecurse{\the\macname}%
6148
\noexpand\scanmacro{\temp}\egroup}%
6149
\fi
6150
\fi}
6151
6152
\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6153
6154
% \braceorline decides whether the next nonwhitespace character is a
6155
% {. If so it reads up to the closing }, if not, it reads the whole
6156
% line. Whatever was read is then fed to the next control sequence
6157
% as an argument (by \parsebrace or \parsearg)
6158
\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6159
\def\braceorlinexxx{%
6160
\ifx\nchar\bgroup\else
6161
\expandafter\parsearg
6162
\fi \macnamexxx}
6163
6164
6165
% @alias.
6166
% We need some trickery to remove the optional spaces around the equal
6167
% sign. Just make them active and then expand them all to nothing.
6168
\def\alias{\parseargusing\obeyspaces\aliasxxx}
6169
\def\aliasxxx #1{\aliasyyy#1\relax}
6170
\def\aliasyyy #1=#2\relax{%
6171
{%
6172
\expandafter\let\obeyedspace=\empty
6173
\addtomacrolist{#1}%
6174
\xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6175
}%
6176
\next
6177
}
6178
6179
6180
\message{cross references,}
6181
6182
\newwrite\auxfile
6183
6184
\newif\ifhavexrefs % True if xref values are known.
6185
\newif\ifwarnedxrefs % True if we warned once that they aren't known.
6186
6187
% @inforef is relatively simple.
6188
\def\inforef #1{\inforefzzz #1,,,,**}
6189
\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6190
node \samp{\ignorespaces#1{}}}
6191
6192
% @node's only job in TeX is to define \lastnode, which is used in
6193
% cross-references. The @node line might or might not have commas, and
6194
% might or might not have spaces before the first comma, like:
6195
% @node foo , bar , ...
6196
% We don't want such trailing spaces in the node name.
6197
%
6198
\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6199
%
6200
% also remove a trailing comma, in case of something like this:
6201
% @node Help-Cross, , , Cross-refs
6202
\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6203
\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6204
6205
\let\nwnode=\node
6206
\let\lastnode=\empty
6207
6208
% Write a cross-reference definition for the current node. #1 is the
6209
% type (Ynumbered, Yappendix, Ynothing).
6210
%
6211
\def\donoderef#1{%
6212
\ifx\lastnode\empty\else
6213
\setref{\lastnode}{#1}%
6214
\global\let\lastnode=\empty
6215
\fi
6216
}
6217
6218
% @anchor{NAME} -- define xref target at arbitrary point.
6219
%
6220
\newcount\savesfregister
6221
%
6222
\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6223
\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6224
\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6225
6226
% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6227
% anchor), which consists of three parts:
6228
% 1) NAME-title - the current sectioning name taken from \thissection,
6229
% or the anchor name.
6230
% 2) NAME-snt - section number and type, passed as the SNT arg, or
6231
% empty for anchors.
6232
% 3) NAME-pg - the page number.
6233
%
6234
% This is called from \donoderef, \anchor, and \dofloat. In the case of
6235
% floats, there is an additional part, which is not written here:
6236
% 4) NAME-lof - the text as it should appear in a @listoffloats.
6237
%
6238
\def\setref#1#2{%
6239
\pdfmkdest{#1}%
6240
\iflinks
6241
{%
6242
\atdummies % preserve commands, but don't expand them
6243
\edef\writexrdef##1##2{%
6244
\write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6245
##1}{##2}}% these are parameters of \writexrdef
6246
}%
6247
\toks0 = \expandafter{\thissection}%
6248
\immediate \writexrdef{title}{\the\toks0 }%
6249
\immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6250
\writexrdef{pg}{\folio}% will be written later, during \shipout
6251
}%
6252
\fi
6253
}
6254
6255
% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6256
% the node name, #2 the name of the Info cross-reference, #3 the printed
6257
% node name, #4 the name of the Info file, #5 the name of the printed
6258
% manual. All but the node name can be omitted.
6259
%
6260
\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6261
\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6262
\def\ref#1{\xrefX[#1,,,,,,,]}
6263
\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6264
\unsepspaces
6265
\def\printedmanual{\ignorespaces #5}%
6266
\def\printedrefname{\ignorespaces #3}%
6267
\setbox1=\hbox{\printedmanual\unskip}%
6268
\setbox0=\hbox{\printedrefname\unskip}%
6269
\ifdim \wd0 = 0pt
6270
% No printed node name was explicitly given.
6271
\expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6272
% Use the node name inside the square brackets.
6273
\def\printedrefname{\ignorespaces #1}%
6274
\else
6275
% Use the actual chapter/section title appear inside
6276
% the square brackets. Use the real section title if we have it.
6277
\ifdim \wd1 > 0pt
6278
% It is in another manual, so we don't have it.
6279
\def\printedrefname{\ignorespaces #1}%
6280
\else
6281
\ifhavexrefs
6282
% We know the real title if we have the xref values.
6283
\def\printedrefname{\refx{#1-title}{}}%
6284
\else
6285
% Otherwise just copy the Info node name.
6286
\def\printedrefname{\ignorespaces #1}%
6287
\fi%
6288
\fi
6289
\fi
6290
\fi
6291
%
6292
% Make link in pdf output.
6293
\ifpdf
6294
\leavevmode
6295
\getfilename{#4}%
6296
{\turnoffactive
6297
% See comments at \activebackslashdouble.
6298
{\activebackslashdouble \xdef\pdfxrefdest{#1}%
6299
\backslashparens\pdfxrefdest}%
6300
%
6301
\ifnum\filenamelength>0
6302
\startlink attr{/Border [0 0 0]}%
6303
goto file{\the\filename.pdf} name{\pdfxrefdest}%
6304
\else
6305
\startlink attr{/Border [0 0 0]}%
6306
goto name{\pdfmkpgn{\pdfxrefdest}}%
6307
\fi
6308
}%
6309
\linkcolor
6310
\fi
6311
%
6312
% Float references are printed completely differently: "Figure 1.2"
6313
% instead of "[somenode], p.3". We distinguish them by the
6314
% LABEL-title being set to a magic string.
6315
{%
6316
% Have to otherify everything special to allow the \csname to
6317
% include an _ in the xref name, etc.
6318
\indexnofonts
6319
\turnoffactive
6320
\expandafter\global\expandafter\let\expandafter\Xthisreftitle
6321
\csname XR#1-title\endcsname
6322
}%
6323
\iffloat\Xthisreftitle
6324
% If the user specified the print name (third arg) to the ref,
6325
% print it instead of our usual "Figure 1.2".
6326
\ifdim\wd0 = 0pt
6327
\refx{#1-snt}{}%
6328
\else
6329
\printedrefname
6330
\fi
6331
%
6332
% if the user also gave the printed manual name (fifth arg), append
6333
% "in MANUALNAME".
6334
\ifdim \wd1 > 0pt
6335
\space \putwordin{} \cite{\printedmanual}%
6336
\fi
6337
\else
6338
% node/anchor (non-float) references.
6339
%
6340
% If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6341
% insert empty discretionaries after hyphens, which means that it will
6342
% not find a line break at a hyphen in a node names. Since some manuals
6343
% are best written with fairly long node names, containing hyphens, this
6344
% is a loss. Therefore, we give the text of the node name again, so it
6345
% is as if TeX is seeing it for the first time.
6346
\ifdim \wd1 > 0pt
6347
\putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6348
\else
6349
% _ (for example) has to be the character _ for the purposes of the
6350
% control sequence corresponding to the node, but it has to expand
6351
% into the usual \leavevmode...\vrule stuff for purposes of
6352
% printing. So we \turnoffactive for the \refx-snt, back on for the
6353
% printing, back off for the \refx-pg.
6354
{\turnoffactive
6355
% Only output a following space if the -snt ref is nonempty; for
6356
% @unnumbered and @anchor, it won't be.
6357
\setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6358
\ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6359
}%
6360
% output the `[mynode]' via a macro so it can be overridden.
6361
\xrefprintnodename\printedrefname
6362
%
6363
% But we always want a comma and a space:
6364
,\space
6365
%
6366
% output the `page 3'.
6367
\turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6368
\fi
6369
\fi
6370
\endlink
6371
\endgroup}
6372
6373
% This macro is called from \xrefX for the `[nodename]' part of xref
6374
% output. It's a separate macro only so it can be changed more easily,
6375
% since square brackets don't work well in some documents. Particularly
6376
% one that Bob is working on :).
6377
%
6378
\def\xrefprintnodename#1{[#1]}
6379
6380
% Things referred to by \setref.
6381
%
6382
\def\Ynothing{}
6383
\def\Yomitfromtoc{}
6384
\def\Ynumbered{%
6385
\ifnum\secno=0
6386
\putwordChapter@tie \the\chapno
6387
\else \ifnum\subsecno=0
6388
\putwordSection@tie \the\chapno.\the\secno
6389
\else \ifnum\subsubsecno=0
6390
\putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6391
\else
6392
\putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6393
\fi\fi\fi
6394
}
6395
\def\Yappendix{%
6396
\ifnum\secno=0
6397
\putwordAppendix@tie @char\the\appendixno{}%
6398
\else \ifnum\subsecno=0
6399
\putwordSection@tie @char\the\appendixno.\the\secno
6400
\else \ifnum\subsubsecno=0
6401
\putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6402
\else
6403
\putwordSection@tie
6404
@char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6405
\fi\fi\fi
6406
}
6407
6408
% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6409
% If its value is nonempty, SUFFIX is output afterward.
6410
%
6411
\def\refx#1#2{%
6412
{%
6413
\indexnofonts
6414
\otherbackslash
6415
\expandafter\global\expandafter\let\expandafter\thisrefX
6416
\csname XR#1\endcsname
6417
}%
6418
\ifx\thisrefX\relax
6419
% If not defined, say something at least.
6420
\angleleft un\-de\-fined\angleright
6421
\iflinks
6422
\ifhavexrefs
6423
\message{\linenumber Undefined cross reference `#1'.}%
6424
\else
6425
\ifwarnedxrefs\else
6426
\global\warnedxrefstrue
6427
\message{Cross reference values unknown; you must run TeX again.}%
6428
\fi
6429
\fi
6430
\fi
6431
\else
6432
% It's defined, so just use it.
6433
\thisrefX
6434
\fi
6435
#2% Output the suffix in any case.
6436
}
6437
6438
% This is the macro invoked by entries in the aux file. Usually it's
6439
% just a \def (we prepend XR to the control sequence name to avoid
6440
% collisions). But if this is a float type, we have more work to do.
6441
%
6442
\def\xrdef#1#2{%
6443
\expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6444
%
6445
% Was that xref control sequence that we just defined for a float?
6446
\expandafter\iffloat\csname XR#1\endcsname
6447
% it was a float, and we have the (safe) float type in \iffloattype.
6448
\expandafter\let\expandafter\floatlist
6449
\csname floatlist\iffloattype\endcsname
6450
%
6451
% Is this the first time we've seen this float type?
6452
\expandafter\ifx\floatlist\relax
6453
\toks0 = {\do}% yes, so just \do
6454
\else
6455
% had it before, so preserve previous elements in list.
6456
\toks0 = \expandafter{\floatlist\do}%
6457
\fi
6458
%
6459
% Remember this xref in the control sequence \floatlistFLOATTYPE,
6460
% for later use in \listoffloats.
6461
\expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6462
\fi
6463
}
6464
6465
% Read the last existing aux file, if any. No error if none exists.
6466
%
6467
\def\tryauxfile{%
6468
\openin 1 \jobname.aux
6469
\ifeof 1 \else
6470
\readdatafile{aux}%
6471
\global\havexrefstrue
6472
\fi
6473
\closein 1
6474
}
6475
6476
\def\setupdatafile{%
6477
\catcode`\^^@=\other
6478
\catcode`\^^A=\other
6479
\catcode`\^^B=\other
6480
\catcode`\^^C=\other
6481
\catcode`\^^D=\other
6482
\catcode`\^^E=\other
6483
\catcode`\^^F=\other
6484
\catcode`\^^G=\other
6485
\catcode`\^^H=\other
6486
\catcode`\^^K=\other
6487
\catcode`\^^L=\other
6488
\catcode`\^^N=\other
6489
\catcode`\^^P=\other
6490
\catcode`\^^Q=\other
6491
\catcode`\^^R=\other
6492
\catcode`\^^S=\other
6493
\catcode`\^^T=\other
6494
\catcode`\^^U=\other
6495
\catcode`\^^V=\other
6496
\catcode`\^^W=\other
6497
\catcode`\^^X=\other
6498
\catcode`\^^Z=\other
6499
\catcode`\^^[=\other
6500
\catcode`\^^\=\other
6501
\catcode`\^^]=\other
6502
\catcode`\^^^=\other
6503
\catcode`\^^_=\other
6504
% It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6505
% in xref tags, i.e., node names. But since ^^e4 notation isn't
6506
% supported in the main text, it doesn't seem desirable. Furthermore,
6507
% that is not enough: for node names that actually contain a ^
6508
% character, we would end up writing a line like this: 'xrdef {'hat
6509
% b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6510
% argument, and \hat is not an expandable control sequence. It could
6511
% all be worked out, but why? Either we support ^^ or we don't.
6512
%
6513
% The other change necessary for this was to define \auxhat:
6514
% \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6515
% and then to call \auxhat in \setq.
6516
%
6517
\catcode`\^=\other
6518
%
6519
% Special characters. Should be turned off anyway, but...
6520
\catcode`\~=\other
6521
\catcode`\[=\other
6522
\catcode`\]=\other
6523
\catcode`\"=\other
6524
\catcode`\_=\other
6525
\catcode`\|=\other
6526
\catcode`\<=\other
6527
\catcode`\>=\other
6528
\catcode`\$=\other
6529
\catcode`\#=\other
6530
\catcode`\&=\other
6531
\catcode`\%=\other
6532
\catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6533
%
6534
% This is to support \ in node names and titles, since the \
6535
% characters end up in a \csname. It's easier than
6536
% leaving it active and making its active definition an actual \
6537
% character. What I don't understand is why it works in the *value*
6538
% of the xrdef. Seems like it should be a catcode12 \, and that
6539
% should not typeset properly. But it works, so I'm moving on for
6540
% now. --karl, 15jan04.
6541
\catcode`\\=\other
6542
%
6543
% Make the characters 128-255 be printing characters.
6544
{%
6545
\count1=128
6546
\def\loop{%
6547
\catcode\count1=\other
6548
\advance\count1 by 1
6549
\ifnum \count1<256 \loop \fi
6550
}%
6551
}%
6552
%
6553
% @ is our escape character in .aux files, and we need braces.
6554
\catcode`\{=1
6555
\catcode`\}=2
6556
\catcode`\@=0
6557
}
6558
6559
\def\readdatafile#1{%
6560
\begingroup
6561
\setupdatafile
6562
\input\jobname.#1
6563
\endgroup}
6564
6565
\message{insertions,}
6566
% including footnotes.
6567
6568
\newcount \footnoteno
6569
6570
% The trailing space in the following definition for supereject is
6571
% vital for proper filling; pages come out unaligned when you do a
6572
% pagealignmacro call if that space before the closing brace is
6573
% removed. (Generally, numeric constants should always be followed by a
6574
% space to prevent strange expansion errors.)
6575
\def\supereject{\par\penalty -20000\footnoteno =0 }
6576
6577
% @footnotestyle is meaningful for info output only.
6578
\let\footnotestyle=\comment
6579
6580
{\catcode `\@=11
6581
%
6582
% Auto-number footnotes. Otherwise like plain.
6583
\gdef\footnote{%
6584
\let\indent=\ptexindent
6585
\let\noindent=\ptexnoindent
6586
\global\advance\footnoteno by \@ne
6587
\edef\thisfootno{$^{\the\footnoteno}$}%
6588
%
6589
% In case the footnote comes at the end of a sentence, preserve the
6590
% extra spacing after we do the footnote number.
6591
\let\@sf\empty
6592
\ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6593
%
6594
% Remove inadvertent blank space before typesetting the footnote number.
6595
\unskip
6596
\thisfootno\@sf
6597
\dofootnote
6598
}%
6599
6600
% Don't bother with the trickery in plain.tex to not require the
6601
% footnote text as a parameter. Our footnotes don't need to be so general.
6602
%
6603
% Oh yes, they do; otherwise, @ifset (and anything else that uses
6604
% \parseargline) fails inside footnotes because the tokens are fixed when
6605
% the footnote is read. --karl, 16nov96.
6606
%
6607
\gdef\dofootnote{%
6608
\insert\footins\bgroup
6609
% We want to typeset this text as a normal paragraph, even if the
6610
% footnote reference occurs in (for example) a display environment.
6611
% So reset some parameters.
6612
\hsize=\pagewidth
6613
\interlinepenalty\interfootnotelinepenalty
6614
\splittopskip\ht\strutbox % top baseline for broken footnotes
6615
\splitmaxdepth\dp\strutbox
6616
\floatingpenalty\@MM
6617
\leftskip\z@skip
6618
\rightskip\z@skip
6619
\spaceskip\z@skip
6620
\xspaceskip\z@skip
6621
\parindent\defaultparindent
6622
%
6623
\smallfonts \rm
6624
%
6625
% Because we use hanging indentation in footnotes, a @noindent appears
6626
% to exdent this text, so make it be a no-op. makeinfo does not use
6627
% hanging indentation so @noindent can still be needed within footnote
6628
% text after an @example or the like (not that this is good style).
6629
\let\noindent = \relax
6630
%
6631
% Hang the footnote text off the number. Use \everypar in case the
6632
% footnote extends for more than one paragraph.
6633
\everypar = {\hang}%
6634
\textindent{\thisfootno}%
6635
%
6636
% Don't crash into the line above the footnote text. Since this
6637
% expands into a box, it must come within the paragraph, lest it
6638
% provide a place where TeX can split the footnote.
6639
\footstrut
6640
\futurelet\next\fo@t
6641
}
6642
}%end \catcode `\@=11
6643
6644
% In case a @footnote appears in a vbox, save the footnote text and create
6645
% the real \insert just after the vbox finished. Otherwise, the insertion
6646
% would be lost.
6647
% Similarily, if a @footnote appears inside an alignment, save the footnote
6648
% text to a box and make the \insert when a row of the table is finished.
6649
% And the same can be done for other insert classes. --kasal, 16nov03.
6650
6651
% Replace the \insert primitive by a cheating macro.
6652
% Deeper inside, just make sure that the saved insertions are not spilled
6653
% out prematurely.
6654
%
6655
\def\startsavinginserts{%
6656
\ifx \insert\ptexinsert
6657
\let\insert\saveinsert
6658
\else
6659
\let\checkinserts\relax
6660
\fi
6661
}
6662
6663
% This \insert replacement works for both \insert\footins{foo} and
6664
% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6665
%
6666
\def\saveinsert#1{%
6667
\edef\next{\noexpand\savetobox \makeSAVEname#1}%
6668
\afterassignment\next
6669
% swallow the left brace
6670
\let\temp =
6671
}
6672
\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6673
\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6674
6675
\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6676
6677
\def\placesaveins#1{%
6678
\ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6679
{\box#1}%
6680
}
6681
6682
% eat @SAVE -- beware, all of them have catcode \other:
6683
{
6684
\def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6685
\gdef\gobblesave @SAVE{}
6686
}
6687
6688
% initialization:
6689
\def\newsaveins #1{%
6690
\edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6691
\next
6692
}
6693
\def\newsaveinsX #1{%
6694
\csname newbox\endcsname #1%
6695
\expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6696
\checksaveins #1}%
6697
}
6698
6699
% initialize:
6700
\let\checkinserts\empty
6701
\newsaveins\footins
6702
\newsaveins\margin
6703
6704
6705
% @image. We use the macros from epsf.tex to support this.
6706
% If epsf.tex is not installed and @image is used, we complain.
6707
%
6708
% Check for and read epsf.tex up front. If we read it only at @image
6709
% time, we might be inside a group, and then its definitions would get
6710
% undone and the next image would fail.
6711
\openin 1 = epsf.tex
6712
\ifeof 1 \else
6713
% Do not bother showing banner with epsf.tex v2.7k (available in
6714
% doc/epsf.tex and on ctan).
6715
\def\epsfannounce{\toks0 = }%
6716
\input epsf.tex
6717
\fi
6718
\closein 1
6719
%
6720
% We will only complain once about lack of epsf.tex.
6721
\newif\ifwarnednoepsf
6722
\newhelp\noepsfhelp{epsf.tex must be installed for images to
6723
work. It is also included in the Texinfo distribution, or you can get
6724
it from ftp://tug.org/tex/epsf.tex.}
6725
%
6726
\def\image#1{%
6727
\ifx\epsfbox\undefined
6728
\ifwarnednoepsf \else
6729
\errhelp = \noepsfhelp
6730
\errmessage{epsf.tex not found, images will be ignored}%
6731
\global\warnednoepsftrue
6732
\fi
6733
\else
6734
\imagexxx #1,,,,,\finish
6735
\fi
6736
}
6737
%
6738
% Arguments to @image:
6739
% #1 is (mandatory) image filename; we tack on .eps extension.
6740
% #2 is (optional) width, #3 is (optional) height.
6741
% #4 is (ignored optional) html alt text.
6742
% #5 is (ignored optional) extension.
6743
% #6 is just the usual extra ignored arg for parsing this stuff.
6744
\newif\ifimagevmode
6745
\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6746
\catcode`\^^M = 5 % in case we're inside an example
6747
\normalturnoffactive % allow _ et al. in names
6748
% If the image is by itself, center it.
6749
\ifvmode
6750
\imagevmodetrue
6751
\nobreak\bigskip
6752
% Usually we'll have text after the image which will insert
6753
% \parskip glue, so insert it here too to equalize the space
6754
% above and below.
6755
\nobreak\vskip\parskip
6756
\nobreak
6757
\line\bgroup
6758
\fi
6759
%
6760
% Output the image.
6761
\ifpdf
6762
\dopdfimage{#1}{#2}{#3}%
6763
\else
6764
% \epsfbox itself resets \epsf?size at each figure.
6765
\setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6766
\setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6767
\epsfbox{#1.eps}%
6768
\fi
6769
%
6770
\ifimagevmode \egroup \bigbreak \fi % space after the image
6771
\endgroup}
6772
6773
6774
% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6775
% etc. We don't actually implement floating yet, we always include the
6776
% float "here". But it seemed the best name for the future.
6777
%
6778
\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6779
6780
% There may be a space before second and/or third parameter; delete it.
6781
\def\eatcommaspace#1, {#1,}
6782
6783
% #1 is the optional FLOATTYPE, the text label for this float, typically
6784
% "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6785
% this float will not be numbered and cannot be referred to.
6786
%
6787
% #2 is the optional xref label. Also must be present for the float to
6788
% be referable.
6789
%
6790
% #3 is the optional positioning argument; for now, it is ignored. It
6791
% will somehow specify the positions allowed to float to (here, top, bottom).
6792
%
6793
% We keep a separate counter for each FLOATTYPE, which we reset at each
6794
% chapter-level command.
6795
\let\resetallfloatnos=\empty
6796
%
6797
\def\dofloat#1,#2,#3,#4\finish{%
6798
\let\thiscaption=\empty
6799
\let\thisshortcaption=\empty
6800
%
6801
% don't lose footnotes inside @float.
6802
%
6803
% BEWARE: when the floats start float, we have to issue warning whenever an
6804
% insert appears inside a float which could possibly float. --kasal, 26may04
6805
%
6806
\startsavinginserts
6807
%
6808
% We can't be used inside a paragraph.
6809
\par
6810
%
6811
\vtop\bgroup
6812
\def\floattype{#1}%
6813
\def\floatlabel{#2}%
6814
\def\floatloc{#3}% we do nothing with this yet.
6815
%
6816
\ifx\floattype\empty
6817
\let\safefloattype=\empty
6818
\else
6819
{%
6820
% the floattype might have accents or other special characters,
6821
% but we need to use it in a control sequence name.
6822
\indexnofonts
6823
\turnoffactive
6824
\xdef\safefloattype{\floattype}%
6825
}%
6826
\fi
6827
%
6828
% If label is given but no type, we handle that as the empty type.
6829
\ifx\floatlabel\empty \else
6830
% We want each FLOATTYPE to be numbered separately (Figure 1,
6831
% Table 1, Figure 2, ...). (And if no label, no number.)
6832
%
6833
\expandafter\getfloatno\csname\safefloattype floatno\endcsname
6834
\global\advance\floatno by 1
6835
%
6836
{%
6837
% This magic value for \thissection is output by \setref as the
6838
% XREFLABEL-title value. \xrefX uses it to distinguish float
6839
% labels (which have a completely different output format) from
6840
% node and anchor labels. And \xrdef uses it to construct the
6841
% lists of floats.
6842
%
6843
\edef\thissection{\floatmagic=\safefloattype}%
6844
\setref{\floatlabel}{Yfloat}%
6845
}%
6846
\fi
6847
%
6848
% start with \parskip glue, I guess.
6849
\vskip\parskip
6850
%
6851
% Don't suppress indentation if a float happens to start a section.
6852
\restorefirstparagraphindent
6853
}
6854
6855
% we have these possibilities:
6856
% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6857
% @float Foo,lbl & no caption: Foo 1.1
6858
% @float Foo & @caption{Cap}: Foo: Cap
6859
% @float Foo & no caption: Foo
6860
% @float ,lbl & Caption{Cap}: 1.1: Cap
6861
% @float ,lbl & no caption: 1.1
6862
% @float & @caption{Cap}: Cap
6863
% @float & no caption:
6864
%
6865
\def\Efloat{%
6866
\let\floatident = \empty
6867
%
6868
% In all cases, if we have a float type, it comes first.
6869
\ifx\floattype\empty \else \def\floatident{\floattype}\fi
6870
%
6871
% If we have an xref label, the number comes next.
6872
\ifx\floatlabel\empty \else
6873
\ifx\floattype\empty \else % if also had float type, need tie first.
6874
\appendtomacro\floatident{\tie}%
6875
\fi
6876
% the number.
6877
\appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6878
\fi
6879
%
6880
% Start the printed caption with what we've constructed in
6881
% \floatident, but keep it separate; we need \floatident again.
6882
\let\captionline = \floatident
6883
%
6884
\ifx\thiscaption\empty \else
6885
\ifx\floatident\empty \else
6886
\appendtomacro\captionline{: }% had ident, so need a colon between
6887
\fi
6888
%
6889
% caption text.
6890
\appendtomacro\captionline{\scanexp\thiscaption}%
6891
\fi
6892
%
6893
% If we have anything to print, print it, with space before.
6894
% Eventually this needs to become an \insert.
6895
\ifx\captionline\empty \else
6896
\vskip.5\parskip
6897
\captionline
6898
%
6899
% Space below caption.
6900
\vskip\parskip
6901
\fi
6902
%
6903
% If have an xref label, write the list of floats info. Do this
6904
% after the caption, to avoid chance of it being a breakpoint.
6905
\ifx\floatlabel\empty \else
6906
% Write the text that goes in the lof to the aux file as
6907
% \floatlabel-lof. Besides \floatident, we include the short
6908
% caption if specified, else the full caption if specified, else nothing.
6909
{%
6910
\atdummies
6911
%
6912
% since we read the caption text in the macro world, where ^^M
6913
% is turned into a normal character, we have to scan it back, so
6914
% we don't write the literal three characters "^^M" into the aux file.
6915
\scanexp{%
6916
\xdef\noexpand\gtemp{%
6917
\ifx\thisshortcaption\empty
6918
\thiscaption
6919
\else
6920
\thisshortcaption
6921
\fi
6922
}%
6923
}%
6924
\immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6925
\ifx\gtemp\empty \else : \gtemp \fi}}%
6926
}%
6927
\fi
6928
\egroup % end of \vtop
6929
%
6930
% place the captured inserts
6931
%
6932
% BEWARE: when the floats start floating, we have to issue warning
6933
% whenever an insert appears inside a float which could possibly
6934
% float. --kasal, 26may04
6935
%
6936
\checkinserts
6937
}
6938
6939
% Append the tokens #2 to the definition of macro #1, not expanding either.
6940
%
6941
\def\appendtomacro#1#2{%
6942
\expandafter\def\expandafter#1\expandafter{#1#2}%
6943
}
6944
6945
% @caption, @shortcaption
6946
%
6947
\def\caption{\docaption\thiscaption}
6948
\def\shortcaption{\docaption\thisshortcaption}
6949
\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6950
\def\defcaption#1#2{\egroup \def#1{#2}}
6951
6952
% The parameter is the control sequence identifying the counter we are
6953
% going to use. Create it if it doesn't exist and assign it to \floatno.
6954
\def\getfloatno#1{%
6955
\ifx#1\relax
6956
% Haven't seen this figure type before.
6957
\csname newcount\endcsname #1%
6958
%
6959
% Remember to reset this floatno at the next chap.
6960
\expandafter\gdef\expandafter\resetallfloatnos
6961
\expandafter{\resetallfloatnos #1=0 }%
6962
\fi
6963
\let\floatno#1%
6964
}
6965
6966
% \setref calls this to get the XREFLABEL-snt value. We want an @xref
6967
% to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6968
% first read the @float command.
6969
%
6970
\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6971
6972
% Magic string used for the XREFLABEL-title value, so \xrefX can
6973
% distinguish floats from other xref types.
6974
\def\floatmagic{!!float!!}
6975
6976
% #1 is the control sequence we are passed; we expand into a conditional
6977
% which is true if #1 represents a float ref. That is, the magic
6978
% \thissection value which we \setref above.
6979
%
6980
\def\iffloat#1{\expandafter\doiffloat#1==\finish}
6981
%
6982
% #1 is (maybe) the \floatmagic string. If so, #2 will be the
6983
% (safe) float type for this float. We set \iffloattype to #2.
6984
%
6985
\def\doiffloat#1=#2=#3\finish{%
6986
\def\temp{#1}%
6987
\def\iffloattype{#2}%
6988
\ifx\temp\floatmagic
6989
}
6990
6991
% @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6992
%
6993
\parseargdef\listoffloats{%
6994
\def\floattype{#1}% floattype
6995
{%
6996
% the floattype might have accents or other special characters,
6997
% but we need to use it in a control sequence name.
6998
\indexnofonts
6999
\turnoffactive
7000
\xdef\safefloattype{\floattype}%
7001
}%
7002
%
7003
% \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7004
\expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7005
\ifhavexrefs
7006
% if the user said @listoffloats foo but never @float foo.
7007
\message{\linenumber No `\safefloattype' floats to list.}%
7008
\fi
7009
\else
7010
\begingroup
7011
\leftskip=\tocindent % indent these entries like a toc
7012
\let\do=\listoffloatsdo
7013
\csname floatlist\safefloattype\endcsname
7014
\endgroup
7015
\fi
7016
}
7017
7018
% This is called on each entry in a list of floats. We're passed the
7019
% xref label, in the form LABEL-title, which is how we save it in the
7020
% aux file. We strip off the -title and look up \XRLABEL-lof, which
7021
% has the text we're supposed to typeset here.
7022
%
7023
% Figures without xref labels will not be included in the list (since
7024
% they won't appear in the aux file).
7025
%
7026
\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7027
\def\listoffloatsdoentry#1-title\finish{{%
7028
% Can't fully expand XR#1-lof because it can contain anything. Just
7029
% pass the control sequence. On the other hand, XR#1-pg is just the
7030
% page number, and we want to fully expand that so we can get a link
7031
% in pdf output.
7032
\toksA = \expandafter{\csname XR#1-lof\endcsname}%
7033
%
7034
% use the same \entry macro we use to generate the TOC and index.
7035
\edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7036
\writeentry
7037
}}
7038
7039
\message{localization,}
7040
% and i18n.
7041
7042
% @documentlanguage is usually given very early, just after
7043
% @setfilename. If done too late, it may not override everything
7044
% properly. Single argument is the language abbreviation.
7045
% It would be nice if we could set up a hyphenation file here.
7046
%
7047
\parseargdef\documentlanguage{%
7048
\tex % read txi-??.tex file in plain TeX.
7049
% Read the file if it exists.
7050
\openin 1 txi-#1.tex
7051
\ifeof 1
7052
\errhelp = \nolanghelp
7053
\errmessage{Cannot read language file txi-#1.tex}%
7054
\else
7055
\input txi-#1.tex
7056
\fi
7057
\closein 1
7058
\endgroup
7059
}
7060
\newhelp\nolanghelp{The given language definition file cannot be found or
7061
is empty. Maybe you need to install it? In the current directory
7062
should work if nowhere else does.}
7063
7064
7065
% @documentencoding should change something in TeX eventually, most
7066
% likely, but for now just recognize it.
7067
\let\documentencoding = \comment
7068
7069
7070
% Page size parameters.
7071
%
7072
\newdimen\defaultparindent \defaultparindent = 15pt
7073
7074
\chapheadingskip = 15pt plus 4pt minus 2pt
7075
\secheadingskip = 12pt plus 3pt minus 2pt
7076
\subsecheadingskip = 9pt plus 2pt minus 2pt
7077
7078
% Prevent underfull vbox error messages.
7079
\vbadness = 10000
7080
7081
% Don't be so finicky about underfull hboxes, either.
7082
\hbadness = 2000
7083
7084
% Following George Bush, just get rid of widows and orphans.
7085
\widowpenalty=10000
7086
\clubpenalty=10000
7087
7088
% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
7089
% using an old version of TeX, don't do anything. We want the amount of
7090
% stretch added to depend on the line length, hence the dependence on
7091
% \hsize. We call this whenever the paper size is set.
7092
%
7093
\def\setemergencystretch{%
7094
\ifx\emergencystretch\thisisundefined
7095
% Allow us to assign to \emergencystretch anyway.
7096
\def\emergencystretch{\dimen0}%
7097
\else
7098
\emergencystretch = .15\hsize
7099
\fi
7100
}
7101
7102
% Parameters in order: 1) textheight; 2) textwidth;
7103
% 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
7104
% 7) physical page height; 8) physical page width.
7105
%
7106
% We also call \setleading{\textleading}, so the caller should define
7107
% \textleading. The caller should also set \parskip.
7108
%
7109
\def\internalpagesizes#1#2#3#4#5#6#7#8{%
7110
\voffset = #3\relax
7111
\topskip = #6\relax
7112
\splittopskip = \topskip
7113
%
7114
\vsize = #1\relax
7115
\advance\vsize by \topskip
7116
\outervsize = \vsize
7117
\advance\outervsize by 2\topandbottommargin
7118
\pageheight = \vsize
7119
%
7120
\hsize = #2\relax
7121
\outerhsize = \hsize
7122
\advance\outerhsize by 0.5in
7123
\pagewidth = \hsize
7124
%
7125
\normaloffset = #4\relax
7126
\bindingoffset = #5\relax
7127
%
7128
\ifpdf
7129
\pdfpageheight #7\relax
7130
\pdfpagewidth #8\relax
7131
\fi
7132
%
7133
\setleading{\textleading}
7134
%
7135
\parindent = \defaultparindent
7136
\setemergencystretch
7137
}
7138
7139
% @letterpaper (the default).
7140
\def\letterpaper{{\globaldefs = 1
7141
\parskip = 3pt plus 2pt minus 1pt
7142
\textleading = 13.2pt
7143
%
7144
% If page is nothing but text, make it come out even.
7145
\internalpagesizes{46\baselineskip}{6in}%
7146
{\voffset}{.25in}%
7147
{\bindingoffset}{36pt}%
7148
{11in}{8.5in}%
7149
}}
7150
7151
% Use @smallbook to reset parameters for 7x9.25 trim size.
7152
\def\smallbook{{\globaldefs = 1
7153
\parskip = 2pt plus 1pt
7154
\textleading = 12pt
7155
%
7156
\internalpagesizes{7.5in}{5in}%
7157
{\voffset}{.25in}%
7158
{\bindingoffset}{16pt}%
7159
{9.25in}{7in}%
7160
%
7161
\lispnarrowing = 0.3in
7162
\tolerance = 700
7163
\hfuzz = 1pt
7164
\contentsrightmargin = 0pt
7165
\defbodyindent = .5cm
7166
}}
7167
7168
% Use @smallerbook to reset parameters for 6x9 trim size.
7169
% (Just testing, parameters still in flux.)
7170
\def\smallerbook{{\globaldefs = 1
7171
\parskip = 1.5pt plus 1pt
7172
\textleading = 12pt
7173
%
7174
\internalpagesizes{7.4in}{4.8in}%
7175
{-.2in}{-.4in}%
7176
{0pt}{14pt}%
7177
{9in}{6in}%
7178
%
7179
\lispnarrowing = 0.25in
7180
\tolerance = 700
7181
\hfuzz = 1pt
7182
\contentsrightmargin = 0pt
7183
\defbodyindent = .4cm
7184
}}
7185
7186
% Use @afourpaper to print on European A4 paper.
7187
\def\afourpaper{{\globaldefs = 1
7188
\parskip = 3pt plus 2pt minus 1pt
7189
\textleading = 13.2pt
7190
%
7191
% Double-side printing via postscript on Laserjet 4050
7192
% prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
7193
% To change the settings for a different printer or situation, adjust
7194
% \normaloffset until the front-side and back-side texts align. Then
7195
% do the same for \bindingoffset. You can set these for testing in
7196
% your texinfo source file like this:
7197
% @tex
7198
% \global\normaloffset = -6mm
7199
% \global\bindingoffset = 10mm
7200
% @end tex
7201
\internalpagesizes{51\baselineskip}{160mm}
7202
{\voffset}{\hoffset}%
7203
{\bindingoffset}{44pt}%
7204
{297mm}{210mm}%
7205
%
7206
\tolerance = 700
7207
\hfuzz = 1pt
7208
\contentsrightmargin = 0pt
7209
\defbodyindent = 5mm
7210
}}
7211
7212
% Use @afivepaper to print on European A5 paper.
7213
% From romildo@urano.iceb.ufop.br, 2 July 2000.
7214
% He also recommends making @example and @lisp be small.
7215
\def\afivepaper{{\globaldefs = 1
7216
\parskip = 2pt plus 1pt minus 0.1pt
7217
\textleading = 12.5pt
7218
%
7219
\internalpagesizes{160mm}{120mm}%
7220
{\voffset}{\hoffset}%
7221
{\bindingoffset}{8pt}%
7222
{210mm}{148mm}%
7223
%
7224
\lispnarrowing = 0.2in
7225
\tolerance = 800
7226
\hfuzz = 1.2pt
7227
\contentsrightmargin = 0pt
7228
\defbodyindent = 2mm
7229
\tableindent = 12mm
7230
}}
7231
7232
% A specific text layout, 24x15cm overall, intended for A4 paper.
7233
\def\afourlatex{{\globaldefs = 1
7234
\afourpaper
7235
\internalpagesizes{237mm}{150mm}%
7236
{\voffset}{4.6mm}%
7237
{\bindingoffset}{7mm}%
7238
{297mm}{210mm}%
7239
%
7240
% Must explicitly reset to 0 because we call \afourpaper.
7241
\globaldefs = 0
7242
}}
7243
7244
% Use @afourwide to print on A4 paper in landscape format.
7245
\def\afourwide{{\globaldefs = 1
7246
\afourpaper
7247
\internalpagesizes{241mm}{165mm}%
7248
{\voffset}{-2.95mm}%
7249
{\bindingoffset}{7mm}%
7250
{297mm}{210mm}%
7251
\globaldefs = 0
7252
}}
7253
7254
% @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7255
% Perhaps we should allow setting the margins, \topskip, \parskip,
7256
% and/or leading, also. Or perhaps we should compute them somehow.
7257
%
7258
\parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7259
\def\pagesizesyyy#1,#2,#3\finish{{%
7260
\setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7261
\globaldefs = 1
7262
%
7263
\parskip = 3pt plus 2pt minus 1pt
7264
\setleading{\textleading}%
7265
%
7266
\dimen0 = #1
7267
\advance\dimen0 by \voffset
7268
%
7269
\dimen2 = \hsize
7270
\advance\dimen2 by \normaloffset
7271
%
7272
\internalpagesizes{#1}{\hsize}%
7273
{\voffset}{\normaloffset}%
7274
{\bindingoffset}{44pt}%
7275
{\dimen0}{\dimen2}%
7276
}}
7277
7278
% Set default to letter.
7279
%
7280
\letterpaper
7281
7282
7283
\message{and turning on texinfo input format.}
7284
7285
% Define macros to output various characters with catcode for normal text.
7286
\catcode`\"=\other
7287
\catcode`\~=\other
7288
\catcode`\^=\other
7289
\catcode`\_=\other
7290
\catcode`\|=\other
7291
\catcode`\<=\other
7292
\catcode`\>=\other
7293
\catcode`\+=\other
7294
\catcode`\$=\other
7295
\def\normaldoublequote{"}
7296
\def\normaltilde{~}
7297
\def\normalcaret{^}
7298
\def\normalunderscore{_}
7299
\def\normalverticalbar{|}
7300
\def\normalless{<}
7301
\def\normalgreater{>}
7302
\def\normalplus{+}
7303
\def\normaldollar{$}%$ font-lock fix
7304
7305
% This macro is used to make a character print one way in \tt
7306
% (where it can probably be output as-is), and another way in other fonts,
7307
% where something hairier probably needs to be done.
7308
%
7309
% #1 is what to print if we are indeed using \tt; #2 is what to print
7310
% otherwise. Since all the Computer Modern typewriter fonts have zero
7311
% interword stretch (and shrink), and it is reasonable to expect all
7312
% typewriter fonts to have this, we can check that font parameter.
7313
%
7314
\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7315
7316
% Same as above, but check for italic font. Actually this also catches
7317
% non-italic slanted fonts since it is impossible to distinguish them from
7318
% italic fonts. But since this is only used by $ and it uses \sl anyway
7319
% this is not a problem.
7320
\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7321
7322
% Turn off all special characters except @
7323
% (and those which the user can use as if they were ordinary).
7324
% Most of these we simply print from the \tt font, but for some, we can
7325
% use math or other variants that look better in normal text.
7326
7327
\catcode`\"=\active
7328
\def\activedoublequote{{\tt\char34}}
7329
\let"=\activedoublequote
7330
\catcode`\~=\active
7331
\def~{{\tt\char126}}
7332
\chardef\hat=`\^
7333
\catcode`\^=\active
7334
\def^{{\tt \hat}}
7335
7336
\catcode`\_=\active
7337
\def_{\ifusingtt\normalunderscore\_}
7338
\let\realunder=_
7339
% Subroutine for the previous macro.
7340
\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7341
7342
\catcode`\|=\active
7343
\def|{{\tt\char124}}
7344
\chardef \less=`\<
7345
\catcode`\<=\active
7346
\def<{{\tt \less}}
7347
\chardef \gtr=`\>
7348
\catcode`\>=\active
7349
\def>{{\tt \gtr}}
7350
\catcode`\+=\active
7351
\def+{{\tt \char 43}}
7352
\catcode`\$=\active
7353
\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7354
7355
% If a .fmt file is being used, characters that might appear in a file
7356
% name cannot be active until we have parsed the command line.
7357
% So turn them off again, and have \everyjob (or @setfilename) turn them on.
7358
% \otherifyactive is called near the end of this file.
7359
\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7360
7361
% Used sometimes to turn off (effectively) the active characters even after
7362
% parsing them.
7363
\def\turnoffactive{%
7364
\normalturnoffactive
7365
\otherbackslash
7366
}
7367
7368
\catcode`\@=0
7369
7370
% \backslashcurfont outputs one backslash character in current font,
7371
% as in \char`\\.
7372
\global\chardef\backslashcurfont=`\\
7373
\global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7374
7375
% \realbackslash is an actual character `\' with catcode other, and
7376
% \doublebackslash is two of them (for the pdf outlines).
7377
{\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7378
7379
% In texinfo, backslash is an active character; it prints the backslash
7380
% in fixed width font.
7381
\catcode`\\=\active
7382
@def@normalbackslash{{@tt@backslashcurfont}}
7383
% On startup, @fixbackslash assigns:
7384
% @let \ = @normalbackslash
7385
7386
% \rawbackslash defines an active \ to do \backslashcurfont.
7387
% \otherbackslash defines an active \ to be a literal `\' character with
7388
% catcode other.
7389
@gdef@rawbackslash{@let\=@backslashcurfont}
7390
@gdef@otherbackslash{@let\=@realbackslash}
7391
7392
% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7393
% the literal character `\'.
7394
%
7395
@def@normalturnoffactive{%
7396
@let\=@normalbackslash
7397
@let"=@normaldoublequote
7398
@let~=@normaltilde
7399
@let^=@normalcaret
7400
@let_=@normalunderscore
7401
@let|=@normalverticalbar
7402
@let<=@normalless
7403
@let>=@normalgreater
7404
@let+=@normalplus
7405
@let$=@normaldollar %$ font-lock fix
7406
@unsepspaces
7407
}
7408
7409
% Make _ and + \other characters, temporarily.
7410
% This is canceled by @fixbackslash.
7411
@otherifyactive
7412
7413
% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7414
% That is what \eatinput is for; after that, the `\' should revert to printing
7415
% a backslash.
7416
%
7417
@gdef@eatinput input texinfo{@fixbackslash}
7418
@global@let\ = @eatinput
7419
7420
% On the other hand, perhaps the file did not have a `\input texinfo'. Then
7421
% the first `\' in the file would cause an error. This macro tries to fix
7422
% that, assuming it is called before the first `\' could plausibly occur.
7423
% Also turn back on active characters that might appear in the input
7424
% file name, in case not using a pre-dumped format.
7425
%
7426
@gdef@fixbackslash{%
7427
@ifx\@eatinput @let\ = @normalbackslash @fi
7428
@catcode`+=@active
7429
@catcode`@_=@active
7430
}
7431
7432
% Say @foo, not \foo, in error messages.
7433
@escapechar = `@@
7434
7435
% These look ok in all fonts, so just make them not special.
7436
@catcode`@& = @other
7437
@catcode`@# = @other
7438
@catcode`@% = @other
7439
7440
7441
@c Local variables:
7442
@c eval: (add-hook 'write-file-hooks 'time-stamp)
7443
@c page-delimiter: "^\\\\message"
7444
@c time-stamp-start: "def\\\\texinfoversion{"
7445
@c time-stamp-format: "%:y-%02m-%02d.%02H"
7446
@c time-stamp-end: "}"
7447
@c End:
7448
7449
@c vim:sw=2:
7450
7451
@ignore
7452
arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
7453
@end ignore
Loggerhead is a web-based interface for Breezy
Version: 2.0.1