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