Commit | Line | Data |
---|---|---|
2c825956 GM |
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 | % | |
5ac8d2e8 | 6 | \def\texinfoversion{2007-04-08.09} |
2c825956 | 7 | % |
0f9c1975 | 8 | % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, |
98bf69dc KB |
9 | % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, |
10 | % 2007 Free Software Foundation, Inc. | |
2c825956 GM |
11 | % |
12 | % This texinfo.tex file is free software; you can redistribute it and/or | |
13 | % modify it under the terms of the GNU General Public License as | |
14 | % published by the Free Software Foundation; either version 2, or (at | |
15 | % your option) any later version. | |
16 | % | |
17 | % This texinfo.tex file is distributed in the hope that it will be | |
18 | % useful, but WITHOUT ANY WARRANTY; without even the implied warranty | |
19 | % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
20 | % General Public License for more details. | |
21 | % | |
22 | % You should have received a copy of the GNU General Public License | |
23 | % along with this texinfo.tex file; see the file COPYING. If not, write | |
364c38d3 LK |
24 | % to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 | % Boston, MA 02110-1301, USA. | |
2c825956 | 26 | % |
0f9c1975 KB |
27 | % As a special exception, when this file is read by TeX when processing |
28 | % a Texinfo source document, you may use the result without | |
29 | % restriction. (This has been our intent since Texinfo was invented.) | |
2c825956 GM |
30 | % |
31 | % Please try the latest version of texinfo.tex before submitting bug | |
32 | % reports; you can get the latest version from: | |
0f9c1975 | 33 | % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or |
08b16a02 | 34 | % ftp://tug.org/tex/texinfo.tex |
0f9c1975 KB |
35 | % (and all CTAN mirrors, see http://www.ctan.org). |
36 | % The texinfo.tex in any given distribution could well be out | |
2c825956 | 37 | % of date, so if that's what you're using, please check. |
177c0ea7 | 38 | % |
2c825956 GM |
39 | % Send bug reports to bug-texinfo@gnu.org. Please include including a |
40 | % complete document in each bug report with which we can reproduce the | |
41 | % problem. Patches are, of course, greatly appreciated. | |
42 | % | |
43 | % To process a Texinfo manual with TeX, it's most reliable to use the | |
44 | % texi2dvi shell script that comes with the distribution. For a simple | |
45 | % manual foo.texi, however, you can get away with this: | |
46 | % tex foo.texi | |
47 | % texindex foo.?? | |
48 | % tex foo.texi | |
49 | % tex foo.texi | |
08b16a02 PJ |
50 | % dvips foo.dvi -o # or whatever; this makes foo.ps. |
51 | % The extra TeX runs get the cross-reference information correct. | |
2c825956 GM |
52 | % Sometimes one run after texindex suffices, and sometimes you need more |
53 | % than two; texi2dvi does it as many times as necessary. | |
54 | % | |
0f9c1975 KB |
55 | % It is possible to adapt texinfo.tex for other languages, to some |
56 | % extent. You can get the existing language-specific files from the | |
57 | % full Texinfo distribution. | |
58 | % | |
59 | % The GNU Texinfo home page is http://www.gnu.org/software/texinfo. | |
60 | ||
2c825956 GM |
61 | |
62 | \message{Loading texinfo [version \texinfoversion]:} | |
63 | ||
64 | % If in a .fmt file, print the version number | |
65 | % and turn on active characters that we couldn't do earlier because | |
66 | % they might have appeared in the input file name. | |
67 | \everyjob{\message{[Texinfo version \texinfoversion]}% | |
68 | \catcode`+=\active \catcode`\_=\active} | |
69 | ||
98bf69dc | 70 | |
0f9c1975 KB |
71 | \chardef\other=12 |
72 | ||
73 | % We never want plain's \outer definition of \+ in Texinfo. | |
74 | % For @tex, we can use \tabalign. | |
75 | \let\+ = \relax | |
76 | ||
77 | % Save some plain tex macros whose names we will redefine. | |
2c825956 GM |
78 | \let\ptexb=\b |
79 | \let\ptexbullet=\bullet | |
80 | \let\ptexc=\c | |
81 | \let\ptexcomma=\, | |
82 | \let\ptexdot=\. | |
83 | \let\ptexdots=\dots | |
84 | \let\ptexend=\end | |
85 | \let\ptexequiv=\equiv | |
86 | \let\ptexexclam=\! | |
0f9c1975 KB |
87 | \let\ptexfootnote=\footnote |
88 | \let\ptexgtr=> | |
89 | \let\ptexhat=^ | |
2c825956 | 90 | \let\ptexi=\i |
0f9c1975 KB |
91 | \let\ptexindent=\indent |
92 | \let\ptexinsert=\insert | |
2c825956 | 93 | \let\ptexlbrace=\{ |
0f9c1975 KB |
94 | \let\ptexless=< |
95 | \let\ptexnewwrite\newwrite | |
96 | \let\ptexnoindent=\noindent | |
97 | \let\ptexplus=+ | |
2c825956 | 98 | \let\ptexrbrace=\} |
0f9c1975 | 99 | \let\ptexslash=\/ |
2c825956 GM |
100 | \let\ptexstar=\* |
101 | \let\ptext=\t | |
102 | ||
2c825956 GM |
103 | % If this character appears in an error message or help string, it |
104 | % starts a new line in the output. | |
105 | \newlinechar = `^^J | |
106 | ||
0f9c1975 KB |
107 | % Use TeX 3.0's \inputlineno to get the line number, for better error |
108 | % messages, but if we're using an old version of TeX, don't do anything. | |
109 | % | |
110 | \ifx\inputlineno\thisisundefined | |
111 | \let\linenumber = \empty % Pre-3.0. | |
112 | \else | |
113 | \def\linenumber{l.\the\inputlineno:\space} | |
114 | \fi | |
115 | ||
2c825956 GM |
116 | % Set up fixed words for English if not already set. |
117 | \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi | |
118 | \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi | |
119 | \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi | |
120 | \ifx\putwordin\undefined \gdef\putwordin{in}\fi | |
121 | \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi | |
122 | \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi | |
123 | \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi | |
124 | \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi | |
125 | \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi | |
126 | \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi | |
127 | \ifx\putwordof\undefined \gdef\putwordof{of}\fi | |
128 | \ifx\putwordon\undefined \gdef\putwordon{on}\fi | |
129 | \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi | |
130 | \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi | |
131 | \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi | |
132 | \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi | |
133 | \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi | |
134 | \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi | |
135 | \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi | |
136 | % | |
137 | \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi | |
138 | \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi | |
139 | \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi | |
140 | \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi | |
141 | \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi | |
142 | \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi | |
143 | \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi | |
144 | \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi | |
145 | \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi | |
146 | \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi | |
147 | \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi | |
148 | \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi | |
149 | % | |
150 | \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi | |
151 | \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi | |
152 | \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi | |
153 | \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi | |
2c825956 | 154 | \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi |
0f9c1975 KB |
155 | |
156 | % Since the category of space is not known, we have to be careful. | |
157 | \chardef\spacecat = 10 | |
158 | \def\spaceisspace{\catcode`\ =\spacecat} | |
2c825956 | 159 | |
74acc6cb KB |
160 | % sometimes characters are active, so we need control sequences. |
161 | \chardef\colonChar = `\: | |
162 | \chardef\commaChar = `\, | |
163 | \chardef\dashChar = `\- | |
164 | \chardef\dotChar = `\. | |
165 | \chardef\exclamChar= `\! | |
166 | \chardef\lquoteChar= `\` | |
167 | \chardef\questChar = `\? | |
168 | \chardef\rquoteChar= `\' | |
169 | \chardef\semiChar = `\; | |
170 | \chardef\underChar = `\_ | |
171 | ||
2c825956 GM |
172 | % Ignore a token. |
173 | % | |
174 | \def\gobble#1{} | |
175 | ||
0f9c1975 KB |
176 | % The following is used inside several \edef's. |
177 | \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} | |
178 | ||
179 | % Hyphenation fixes. | |
180 | \hyphenation{ | |
181 | Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script | |
182 | ap-pen-dix bit-map bit-maps | |
183 | data-base data-bases eshell fall-ing half-way long-est man-u-script | |
184 | man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm | |
185 | par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces | |
186 | spell-ing spell-ings | |
187 | stand-alone strong-est time-stamp time-stamps which-ever white-space | |
188 | wide-spread wrap-around | |
189 | } | |
2c825956 GM |
190 | |
191 | % Margin to add to right of even pages, to left of odd pages. | |
0f9c1975 KB |
192 | \newdimen\bindingoffset |
193 | \newdimen\normaloffset | |
2c825956 GM |
194 | \newdimen\pagewidth \newdimen\pageheight |
195 | ||
0f9c1975 KB |
196 | % For a final copy, take out the rectangles |
197 | % that mark overfull boxes (in case you have decided | |
198 | % that the text looks ok even though it passes the margin). | |
199 | % | |
200 | \def\finalout{\overfullrule=0pt} | |
201 | ||
202 | % @| inserts a changebar to the left of the current line. It should | |
203 | % surround any changed text. This approach does *not* work if the | |
204 | % change spans more than two lines of output. To handle that, we would | |
205 | % have adopt a much more difficult approach (putting marks into the main | |
206 | % vertical list for the beginning and end of each change). | |
207 | % | |
208 | \def\|{% | |
209 | % \vadjust can only be used in horizontal mode. | |
210 | \leavevmode | |
211 | % | |
212 | % Append this vertical mode material after the current line in the output. | |
213 | \vadjust{% | |
214 | % We want to insert a rule with the height and depth of the current | |
215 | % leading; that is exactly what \strutbox is supposed to record. | |
216 | \vskip-\baselineskip | |
217 | % | |
218 | % \vadjust-items are inserted at the left edge of the type. So | |
219 | % the \llap here moves out into the left-hand margin. | |
220 | \llap{% | |
221 | % | |
222 | % For a thicker or thinner bar, change the `1pt'. | |
223 | \vrule height\baselineskip width1pt | |
224 | % | |
225 | % This is the space between the bar and the text. | |
226 | \hskip 12pt | |
227 | }% | |
228 | }% | |
229 | } | |
230 | ||
2c825956 GM |
231 | % Sometimes it is convenient to have everything in the transcript file |
232 | % and nothing on the terminal. We don't just call \tracingall here, | |
0f9c1975 KB |
233 | % since that produces some useless output on the terminal. We also make |
234 | % some effort to order the tracing commands to reduce output in the log | |
235 | % file; cf. trace.sty in LaTeX. | |
2c825956 GM |
236 | % |
237 | \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% | |
0f9c1975 KB |
238 | \def\loggingall{% |
239 | \tracingstats2 | |
240 | \tracingpages1 | |
241 | \tracinglostchars2 % 2 gives us more in etex | |
242 | \tracingparagraphs1 | |
243 | \tracingoutput1 | |
244 | \tracingmacros2 | |
245 | \tracingrestores1 | |
246 | \showboxbreadth\maxdimen \showboxdepth\maxdimen | |
247 | \ifx\eTeXversion\undefined\else % etex gives us more logging | |
248 | \tracingscantokens1 | |
249 | \tracingifs1 | |
250 | \tracinggroups1 | |
251 | \tracingnesting2 | |
252 | \tracingassigns1 | |
253 | \fi | |
254 | \tracingcommands3 % 3 gives us more in etex | |
255 | \errorcontextlines16 | |
2c825956 | 256 | }% |
2c825956 | 257 | |
08b16a02 PJ |
258 | % add check for \lastpenalty to plain's definitions. If the last thing |
259 | % we did was a \nobreak, we don't want to insert more space. | |
177c0ea7 | 260 | % |
08b16a02 PJ |
261 | \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount |
262 | \removelastskip\penalty-50\smallskip\fi\fi} | |
263 | \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount | |
264 | \removelastskip\penalty-100\medskip\fi\fi} | |
265 | \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount | |
266 | \removelastskip\penalty-200\bigskip\fi\fi} | |
267 | ||
2c825956 GM |
268 | % For @cropmarks command. |
269 | % Do @cropmarks to get crop marks. | |
270 | % | |
271 | \newif\ifcropmarks | |
272 | \let\cropmarks = \cropmarkstrue | |
273 | % | |
274 | % Dimensions to add cropmarks at corners. | |
275 | % Added by P. A. MacKay, 12 Nov. 1986 | |
276 | % | |
277 | \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines | |
278 | \newdimen\cornerlong \cornerlong=1pc | |
279 | \newdimen\cornerthick \cornerthick=.3pt | |
280 | \newdimen\topandbottommargin \topandbottommargin=.75in | |
281 | ||
282 | % Main output routine. | |
283 | \chardef\PAGE = 255 | |
284 | \output = {\onepageout{\pagecontents\PAGE}} | |
285 | ||
286 | \newbox\headlinebox | |
287 | \newbox\footlinebox | |
288 | ||
289 | % \onepageout takes a vbox as an argument. Note that \pagecontents | |
290 | % does insertions, but you have to call it yourself. | |
291 | \def\onepageout#1{% | |
292 | \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi | |
293 | % | |
294 | \ifodd\pageno \advance\hoffset by \bindingoffset | |
295 | \else \advance\hoffset by -\bindingoffset\fi | |
296 | % | |
297 | % Do this outside of the \shipout so @code etc. will be expanded in | |
298 | % the headline as they should be, not taken literally (outputting ''code). | |
299 | \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% | |
300 | \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% | |
301 | % | |
302 | {% | |
303 | % Have to do this stuff outside the \shipout because we want it to | |
304 | % take effect in \write's, yet the group defined by the \vbox ends | |
305 | % before the \shipout runs. | |
306 | % | |
2c825956 GM |
307 | \indexdummies % don't expand commands in the output. |
308 | \normalturnoffactive % \ in index entries must not stay \, e.g., if | |
0f9c1975 KB |
309 | % the page break happens to be in the middle of an example. |
310 | % We don't want .vr (or whatever) entries like this: | |
311 | % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} | |
312 | % "\acronym" won't work when it's read back in; | |
313 | % it needs to be | |
314 | % {\code {{\tt \backslashcurfont }acronym} | |
2c825956 GM |
315 | \shipout\vbox{% |
316 | % Do this early so pdf references go to the beginning of the page. | |
0f9c1975 | 317 | \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi |
2c825956 GM |
318 | % |
319 | \ifcropmarks \vbox to \outervsize\bgroup | |
320 | \hsize = \outerhsize | |
321 | \vskip-\topandbottommargin | |
322 | \vtop to0pt{% | |
323 | \line{\ewtop\hfil\ewtop}% | |
324 | \nointerlineskip | |
325 | \line{% | |
326 | \vbox{\moveleft\cornerthick\nstop}% | |
327 | \hfill | |
328 | \vbox{\moveright\cornerthick\nstop}% | |
329 | }% | |
330 | \vss}% | |
331 | \vskip\topandbottommargin | |
332 | \line\bgroup | |
333 | \hfil % center the page within the outer (page) hsize. | |
334 | \ifodd\pageno\hskip\bindingoffset\fi | |
335 | \vbox\bgroup | |
336 | \fi | |
337 | % | |
338 | \unvbox\headlinebox | |
339 | \pagebody{#1}% | |
340 | \ifdim\ht\footlinebox > 0pt | |
341 | % Only leave this space if the footline is nonempty. | |
08e5fcf1 | 342 | % (We lessened \vsize for it in \oddfootingyyy.) |
2c825956 | 343 | % The \baselineskip=24pt in plain's \makefootline has no effect. |
08e5fcf1 | 344 | \vskip 24pt |
2c825956 GM |
345 | \unvbox\footlinebox |
346 | \fi | |
347 | % | |
348 | \ifcropmarks | |
349 | \egroup % end of \vbox\bgroup | |
350 | \hfil\egroup % end of (centering) \line\bgroup | |
351 | \vskip\topandbottommargin plus1fill minus1fill | |
352 | \boxmaxdepth = \cornerthick | |
353 | \vbox to0pt{\vss | |
354 | \line{% | |
355 | \vbox{\moveleft\cornerthick\nsbot}% | |
356 | \hfill | |
357 | \vbox{\moveright\cornerthick\nsbot}% | |
358 | }% | |
359 | \nointerlineskip | |
360 | \line{\ewbot\hfil\ewbot}% | |
361 | }% | |
362 | \egroup % \vbox from first cropmarks clause | |
363 | \fi | |
364 | }% end of \shipout\vbox | |
0f9c1975 | 365 | }% end of group with \indexdummies |
2c825956 GM |
366 | \advancepageno |
367 | \ifnum\outputpenalty>-20000 \else\dosupereject\fi | |
368 | } | |
369 | ||
370 | \newinsert\margin \dimen\margin=\maxdimen | |
371 | ||
372 | \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} | |
373 | {\catcode`\@ =11 | |
374 | \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi | |
375 | % marginal hacks, juha@viisa.uucp (Juha Takala) | |
376 | \ifvoid\margin\else % marginal info is present | |
377 | \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi | |
378 | \dimen@=\dp#1 \unvbox#1 | |
379 | \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi | |
380 | \ifr@ggedbottom \kern-\dimen@ \vfil \fi} | |
381 | } | |
382 | ||
383 | % Here are the rules for the cropmarks. Note that they are | |
384 | % offset so that the space between them is truly \outerhsize or \outervsize | |
385 | % (P. A. MacKay, 12 November, 1986) | |
386 | % | |
387 | \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} | |
388 | \def\nstop{\vbox | |
389 | {\hrule height\cornerthick depth\cornerlong width\cornerthick}} | |
390 | \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} | |
391 | \def\nsbot{\vbox | |
392 | {\hrule height\cornerlong depth\cornerthick width\cornerthick}} | |
393 | ||
394 | % Parse an argument, then pass it to #1. The argument is the rest of | |
395 | % the input line (except we remove a trailing comment). #1 should be a | |
396 | % macro which expects an ordinary undelimited TeX argument. | |
397 | % | |
0f9c1975 KB |
398 | \def\parsearg{\parseargusing{}} |
399 | \def\parseargusing#1#2{% | |
400 | \def\argtorun{#2}% | |
2c825956 GM |
401 | \begingroup |
402 | \obeylines | |
0f9c1975 KB |
403 | \spaceisspace |
404 | #1% | |
405 | \parseargline\empty% Insert the \empty token, see \finishparsearg below. | |
2c825956 GM |
406 | } |
407 | ||
2c825956 GM |
408 | {\obeylines % |
409 | \gdef\parseargline#1^^M{% | |
410 | \endgroup % End of the group started in \parsearg. | |
0f9c1975 | 411 | \argremovecomment #1\comment\ArgTerm% |
2c825956 GM |
412 | }% |
413 | } | |
414 | ||
0f9c1975 KB |
415 | % First remove any @comment, then any @c comment. |
416 | \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} | |
417 | \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} | |
2c825956 | 418 | |
0f9c1975 KB |
419 | % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space. |
420 | % | |
421 | % \argremovec might leave us with trailing space, e.g., | |
2c825956 | 422 | % @end itemize @c foo |
0f9c1975 KB |
423 | % This space token undergoes the same procedure and is eventually removed |
424 | % by \finishparsearg. | |
425 | % | |
426 | \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} | |
427 | \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} | |
428 | \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% | |
429 | \def\temp{#3}% | |
430 | \ifx\temp\empty | |
431 | % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp: | |
432 | \let\temp\finishparsearg | |
433 | \else | |
434 | \let\temp\argcheckspaces | |
435 | \fi | |
436 | % Put the space token in: | |
437 | \temp#1 #3\ArgTerm | |
2c825956 GM |
438 | } |
439 | ||
0f9c1975 KB |
440 | % If a _delimited_ argument is enclosed in braces, they get stripped; so |
441 | % to get _exactly_ the rest of the line, we had to prevent such situation. | |
442 | % We prepended an \empty token at the very beginning and we expand it now, | |
443 | % just before passing the control to \argtorun. | |
444 | % (Similarily, we have to think about #3 of \argcheckspacesY above: it is | |
445 | % either the null string, or it ends with \^^M---thus there is no danger | |
446 | % that a pair of braces would be stripped. | |
2c825956 | 447 | % |
0f9c1975 KB |
448 | % But first, we have to remove the trailing space token. |
449 | % | |
450 | \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}} | |
451 | ||
452 | % \parseargdef\foo{...} | |
453 | % is roughly equivalent to | |
454 | % \def\foo{\parsearg\Xfoo} | |
455 | % \def\Xfoo#1{...} | |
456 | % | |
457 | % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my | |
458 | % favourite TeX trick. --kasal, 16nov03 | |
459 | ||
460 | \def\parseargdef#1{% | |
461 | \expandafter \doparseargdef \csname\string#1\endcsname #1% | |
462 | } | |
463 | \def\doparseargdef#1#2{% | |
464 | \def#2{\parsearg#1}% | |
465 | \def#1##1% | |
466 | } | |
467 | ||
468 | % Several utility definitions with active space: | |
469 | { | |
2c825956 | 470 | \obeyspaces |
0f9c1975 KB |
471 | \gdef\obeyedspace{ } |
472 | ||
473 | % Make each space character in the input produce a normal interword | |
474 | % space in the output. Don't allow a line break at this space, as this | |
475 | % is used only in environments like @example, where each line of input | |
476 | % should produce a line of output anyway. | |
477 | % | |
478 | \gdef\sepspaces{\obeyspaces\let =\tie} | |
479 | ||
480 | % If an index command is used in an @example environment, any spaces | |
481 | % therein should become regular spaces in the raw index file, not the | |
482 | % expansion of \tie (\leavevmode \penalty \@M \ ). | |
483 | \gdef\unsepspaces{\let =\space} | |
484 | } | |
2c825956 GM |
485 | |
486 | ||
487 | \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} | |
488 | ||
0f9c1975 KB |
489 | % Define the framework for environments in texinfo.tex. It's used like this: |
490 | % | |
491 | % \envdef\foo{...} | |
492 | % \def\Efoo{...} | |
493 | % | |
494 | % It's the responsibility of \envdef to insert \begingroup before the | |
495 | % actual body; @end closes the group after calling \Efoo. \envdef also | |
496 | % defines \thisenv, so the current environment is known; @end checks | |
497 | % whether the environment name matches. The \checkenv macro can also be | |
498 | % used to check whether the current environment is the one expected. | |
499 | % | |
500 | % Non-false conditionals (@iftex, @ifset) don't fit into this, so they | |
501 | % are not treated as enviroments; they don't open a group. (The | |
502 | % implementation of @end takes care not to call \endgroup in this | |
503 | % special case.) | |
2c825956 | 504 | |
2c825956 | 505 | |
0f9c1975 KB |
506 | % At runtime, environments start with this: |
507 | \def\startenvironment#1{\begingroup\def\thisenv{#1}} | |
508 | % initialize | |
509 | \let\thisenv\empty | |
2c825956 | 510 | |
0f9c1975 KB |
511 | % ... but they get defined via ``\envdef\foo{...}'': |
512 | \long\def\envdef#1#2{\def#1{\startenvironment#1#2}} | |
513 | \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} | |
2c825956 | 514 | |
0f9c1975 KB |
515 | % Check whether we're in the right environment: |
516 | \def\checkenv#1{% | |
517 | \def\temp{#1}% | |
518 | \ifx\thisenv\temp | |
2c825956 | 519 | \else |
0f9c1975 | 520 | \badenverr |
2c825956 GM |
521 | \fi |
522 | } | |
523 | ||
0f9c1975 KB |
524 | % Evironment mismatch, #1 expected: |
525 | \def\badenverr{% | |
2c825956 | 526 | \errhelp = \EMsimple |
0f9c1975 KB |
527 | \errmessage{This command can appear only \inenvironment\temp, |
528 | not \inenvironment\thisenv}% | |
529 | } | |
530 | \def\inenvironment#1{% | |
531 | \ifx#1\empty | |
532 | out of any environment% | |
533 | \else | |
534 | in environment \expandafter\string#1% | |
535 | \fi | |
2c825956 GM |
536 | } |
537 | ||
0f9c1975 KB |
538 | % @end foo executes the definition of \Efoo. |
539 | % But first, it executes a specialized version of \checkenv | |
2c825956 | 540 | % |
0f9c1975 KB |
541 | \parseargdef\end{% |
542 | \if 1\csname iscond.#1\endcsname | |
543 | \else | |
544 | % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 | |
545 | \expandafter\checkenv\csname#1\endcsname | |
546 | \csname E#1\endcsname | |
547 | \endgroup | |
548 | \fi | |
2c825956 GM |
549 | } |
550 | ||
0f9c1975 | 551 | \newhelp\EMsimple{Press RETURN to continue.} |
2c825956 | 552 | |
2c825956 GM |
553 | |
554 | %% Simple single-character @ commands | |
555 | ||
556 | % @@ prints an @ | |
557 | % Kludge this until the fonts are right (grr). | |
558 | \def\@{{\tt\char64}} | |
559 | ||
560 | % This is turned off because it was never documented | |
561 | % and you can use @w{...} around a quote to suppress ligatures. | |
562 | %% Define @` and @' to be the same as ` and ' | |
563 | %% but suppressing ligatures. | |
564 | %\def\`{{`}} | |
565 | %\def\'{{'}} | |
566 | ||
567 | % Used to generate quoted braces. | |
568 | \def\mylbrace {{\tt\char123}} | |
569 | \def\myrbrace {{\tt\char125}} | |
570 | \let\{=\mylbrace | |
571 | \let\}=\myrbrace | |
572 | \begingroup | |
0f9c1975 KB |
573 | % Definitions to produce \{ and \} commands for indices, |
574 | % and @{ and @} for the aux/toc files. | |
575 | \catcode`\{ = \other \catcode`\} = \other | |
2c825956 | 576 | \catcode`\[ = 1 \catcode`\] = 2 |
0f9c1975 KB |
577 | \catcode`\! = 0 \catcode`\\ = \other |
578 | !gdef!lbracecmd[\{]% | |
579 | !gdef!rbracecmd[\}]% | |
580 | !gdef!lbraceatcmd[@{]% | |
581 | !gdef!rbraceatcmd[@}]% | |
582 | !endgroup | |
583 | ||
584 | % @comma{} to avoid , parsing problems. | |
585 | \let\comma = , | |
2c825956 GM |
586 | |
587 | % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent | |
0f9c1975 | 588 | % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. |
2c825956 GM |
589 | \let\, = \c |
590 | \let\dotaccent = \. | |
591 | \def\ringaccent#1{{\accent23 #1}} | |
592 | \let\tieaccent = \t | |
593 | \let\ubaraccent = \b | |
594 | \let\udotaccent = \d | |
595 | ||
0f9c1975 KB |
596 | % Other special characters: @questiondown @exclamdown @ordf @ordm |
597 | % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. | |
2c825956 GM |
598 | \def\questiondown{?`} |
599 | \def\exclamdown{!`} | |
0f9c1975 KB |
600 | \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} |
601 | \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} | |
2c825956 GM |
602 | |
603 | % Dotless i and dotless j, used for accents. | |
604 | \def\imacro{i} | |
605 | \def\jmacro{j} | |
606 | \def\dotless#1{% | |
607 | \def\temp{#1}% | |
608 | \ifx\temp\imacro \ptexi | |
609 | \else\ifx\temp\jmacro \j | |
610 | \else \errmessage{@dotless can be used only with i or j}% | |
611 | \fi\fi | |
612 | } | |
613 | ||
0f9c1975 KB |
614 | % The \TeX{} logo, as in plain, but resetting the spacing so that a |
615 | % period following counts as ending a sentence. (Idea found in latex.) | |
616 | % | |
617 | \edef\TeX{\TeX \spacefactor=1000 } | |
618 | ||
619 | % @LaTeX{} logo. Not quite the same results as the definition in | |
620 | % latex.ltx, since we use a different font for the raised A; it's most | |
621 | % convenient for us to use an explicitly smaller font, rather than using | |
622 | % the \scriptstyle font (since we don't reset \scriptstyle and | |
623 | % \scriptscriptstyle). | |
624 | % | |
625 | \def\LaTeX{% | |
626 | L\kern-.36em | |
627 | {\setbox0=\hbox{T}% | |
628 | \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}% | |
629 | \kern-.15em | |
630 | \TeX | |
631 | } | |
632 | ||
2c825956 GM |
633 | % Be sure we're in horizontal mode when doing a tie, since we make space |
634 | % equivalent to this in @example-like environments. Otherwise, a space | |
635 | % at the beginning of a line will start with \penalty -- and | |
636 | % since \penalty is valid in vertical mode, we'd end up putting the | |
637 | % penalty on the vertical list instead of in the new paragraph. | |
638 | {\catcode`@ = 11 | |
639 | % Avoid using \@M directly, because that causes trouble | |
640 | % if the definition is written into an index file. | |
641 | \global\let\tiepenalty = \@M | |
642 | \gdef\tie{\leavevmode\penalty\tiepenalty\ } | |
643 | } | |
644 | ||
645 | % @: forces normal size whitespace following. | |
646 | \def\:{\spacefactor=1000 } | |
647 | ||
648 | % @* forces a line break. | |
649 | \def\*{\hfil\break\hbox{}\ignorespaces} | |
650 | ||
0f9c1975 KB |
651 | % @/ allows a line break. |
652 | \let\/=\allowbreak | |
653 | ||
2c825956 | 654 | % @. is an end-of-sentence period. |
0f9c1975 | 655 | \def\.{.\spacefactor=\endofsentencespacefactor\space} |
2c825956 GM |
656 | |
657 | % @! is an end-of-sentence bang. | |
0f9c1975 | 658 | \def\!{!\spacefactor=\endofsentencespacefactor\space} |
2c825956 GM |
659 | |
660 | % @? is an end-of-sentence query. | |
0f9c1975 KB |
661 | \def\?{?\spacefactor=\endofsentencespacefactor\space} |
662 | ||
663 | % @frenchspacing on|off says whether to put extra space after punctuation. | |
664 | % | |
665 | \def\onword{on} | |
666 | \def\offword{off} | |
667 | % | |
668 | \parseargdef\frenchspacing{% | |
669 | \def\temp{#1}% | |
670 | \ifx\temp\onword \plainfrenchspacing | |
671 | \else\ifx\temp\offword \plainnonfrenchspacing | |
672 | \else | |
673 | \errhelp = \EMsimple | |
674 | \errmessage{Unknown @frenchspacing option `\temp', must be on/off}% | |
675 | \fi\fi | |
676 | } | |
2c825956 GM |
677 | |
678 | % @w prevents a word break. Without the \leavevmode, @w at the | |
679 | % beginning of a paragraph, when TeX is still in vertical mode, would | |
680 | % produce a whole line of output instead of starting the paragraph. | |
681 | \def\w#1{\leavevmode\hbox{#1}} | |
682 | ||
683 | % @group ... @end group forces ... to be all on one page, by enclosing | |
684 | % it in a TeX vbox. We use \vtop instead of \vbox to construct the box | |
685 | % to keep its height that of a normal line. According to the rules for | |
686 | % \topskip (p.114 of the TeXbook), the glue inserted is | |
687 | % max (\topskip - \ht (first item), 0). If that height is large, | |
688 | % therefore, no glue is inserted, and the space between the headline and | |
689 | % the text is small, which looks bad. | |
690 | % | |
0f9c1975 KB |
691 | % Another complication is that the group might be very large. This can |
692 | % cause the glue on the previous page to be unduly stretched, because it | |
693 | % does not have much material. In this case, it's better to add an | |
694 | % explicit \vfill so that the extra space is at the bottom. The | |
695 | % threshold for doing this is if the group is more than \vfilllimit | |
696 | % percent of a page (\vfilllimit can be changed inside of @tex). | |
697 | % | |
698 | \newbox\groupbox | |
699 | \def\vfilllimit{0.7} | |
700 | % | |
701 | \envdef\group{% | |
702 | \ifnum\catcode`\^^M=\active \else | |
2c825956 GM |
703 | \errhelp = \groupinvalidhelp |
704 | \errmessage{@group invalid in context where filling is enabled}% | |
705 | \fi | |
0f9c1975 | 706 | \startsavinginserts |
2c825956 | 707 | % |
0f9c1975 | 708 | \setbox\groupbox = \vtop\bgroup |
2c825956 GM |
709 | % Do @comment since we are called inside an environment such as |
710 | % @example, where each end-of-line in the input causes an | |
711 | % end-of-line in the output. We don't want the end-of-line after | |
712 | % the `@group' to put extra space in the output. Since @group | |
713 | % should appear on a line by itself (according to the Texinfo | |
714 | % manual), we don't worry about eating any user text. | |
715 | \comment | |
716 | } | |
717 | % | |
0f9c1975 KB |
718 | % The \vtop produces a box with normal height and large depth; thus, TeX puts |
719 | % \baselineskip glue before it, and (when the next line of text is done) | |
720 | % \lineskip glue after it. Thus, space below is not quite equal to space | |
721 | % above. But it's pretty close. | |
722 | \def\Egroup{% | |
723 | % To get correct interline space between the last line of the group | |
724 | % and the first line afterwards, we have to propagate \prevdepth. | |
725 | \endgraf % Not \par, as it may have been set to \lisppar. | |
726 | \global\dimen1 = \prevdepth | |
727 | \egroup % End the \vtop. | |
728 | % \dimen0 is the vertical size of the group's box. | |
729 | \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox | |
730 | % \dimen2 is how much space is left on the page (more or less). | |
731 | \dimen2 = \pageheight \advance\dimen2 by -\pagetotal | |
732 | % if the group doesn't fit on the current page, and it's a big big | |
733 | % group, force a page break. | |
734 | \ifdim \dimen0 > \dimen2 | |
735 | \ifdim \pagetotal < \vfilllimit\pageheight | |
736 | \page | |
737 | \fi | |
738 | \fi | |
739 | \box\groupbox | |
740 | \prevdepth = \dimen1 | |
741 | \checkinserts | |
742 | } | |
743 | % | |
2c825956 GM |
744 | % TeX puts in an \escapechar (i.e., `@') at the beginning of the help |
745 | % message, so this ends up printing `@group can only ...'. | |
746 | % | |
747 | \newhelp\groupinvalidhelp{% | |
748 | group can only be used in environments such as @example,^^J% | |
749 | where each line of input produces a line of output.} | |
750 | ||
751 | % @need space-in-mils | |
752 | % forces a page break if there is not space-in-mils remaining. | |
753 | ||
754 | \newdimen\mil \mil=0.001in | |
755 | ||
2c825956 | 756 | % Old definition--didn't work. |
0f9c1975 | 757 | %\parseargdef\need{\par % |
2c825956 GM |
758 | %% This method tries to make TeX break the page naturally |
759 | %% if the depth of the box does not fit. | |
760 | %{\baselineskip=0pt% | |
761 | %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak | |
762 | %\prevdepth=-1000pt | |
763 | %}} | |
764 | ||
0f9c1975 | 765 | \parseargdef\need{% |
2c825956 GM |
766 | % Ensure vertical mode, so we don't make a big box in the middle of a |
767 | % paragraph. | |
768 | \par | |
769 | % | |
770 | % If the @need value is less than one line space, it's useless. | |
771 | \dimen0 = #1\mil | |
772 | \dimen2 = \ht\strutbox | |
773 | \advance\dimen2 by \dp\strutbox | |
774 | \ifdim\dimen0 > \dimen2 | |
775 | % | |
776 | % Do a \strut just to make the height of this box be normal, so the | |
777 | % normal leading is inserted relative to the preceding line. | |
778 | % And a page break here is fine. | |
779 | \vtop to #1\mil{\strut\vfil}% | |
780 | % | |
781 | % TeX does not even consider page breaks if a penalty added to the | |
782 | % main vertical list is 10000 or more. But in order to see if the | |
783 | % empty box we just added fits on the page, we must make it consider | |
784 | % page breaks. On the other hand, we don't want to actually break the | |
785 | % page after the empty box. So we use a penalty of 9999. | |
786 | % | |
787 | % There is an extremely small chance that TeX will actually break the | |
788 | % page at this \penalty, if there are no other feasible breakpoints in | |
789 | % sight. (If the user is using lots of big @group commands, which | |
790 | % almost-but-not-quite fill up a page, TeX will have a hard time doing | |
791 | % good page breaking, for example.) However, I could not construct an | |
792 | % example where a page broke at this \penalty; if it happens in a real | |
793 | % document, then we can reconsider our strategy. | |
794 | \penalty9999 | |
795 | % | |
796 | % Back up by the size of the box, whether we did a page break or not. | |
797 | \kern -#1\mil | |
798 | % | |
799 | % Do not allow a page break right after this kern. | |
800 | \nobreak | |
801 | \fi | |
802 | } | |
803 | ||
0f9c1975 | 804 | % @br forces paragraph break (and is undocumented). |
2c825956 GM |
805 | |
806 | \let\br = \par | |
807 | ||
0f9c1975 | 808 | % @page forces the start of a new page. |
2c825956 GM |
809 | % |
810 | \def\page{\par\vfill\supereject} | |
811 | ||
812 | % @exdent text.... | |
813 | % outputs text on separate line in roman font, starting at standard page margin | |
814 | ||
815 | % This records the amount of indent in the innermost environment. | |
816 | % That's how much \exdent should take out. | |
817 | \newskip\exdentamount | |
818 | ||
819 | % This defn is used inside fill environments such as @defun. | |
0f9c1975 | 820 | \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} |
2c825956 GM |
821 | |
822 | % This defn is used inside nofill environments such as @example. | |
0f9c1975 KB |
823 | \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount |
824 | \leftline{\hskip\leftskip{\rm#1}}}} | |
2c825956 GM |
825 | |
826 | % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current | |
827 | % paragraph. For more general purposes, use the \margin insertion | |
828 | % class. WHICH is `l' or `r'. | |
829 | % | |
830 | \newskip\inmarginspacing \inmarginspacing=1cm | |
831 | \def\strutdepth{\dp\strutbox} | |
832 | % | |
833 | \def\doinmargin#1#2{\strut\vadjust{% | |
834 | \nobreak | |
835 | \kern-\strutdepth | |
836 | \vtop to \strutdepth{% | |
837 | \baselineskip=\strutdepth | |
838 | \vss | |
839 | % if you have multiple lines of stuff to put here, you'll need to | |
840 | % make the vbox yourself of the appropriate size. | |
841 | \ifx#1l% | |
842 | \llap{\ignorespaces #2\hskip\inmarginspacing}% | |
843 | \else | |
844 | \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% | |
845 | \fi | |
846 | \null | |
847 | }% | |
848 | }} | |
849 | \def\inleftmargin{\doinmargin l} | |
850 | \def\inrightmargin{\doinmargin r} | |
851 | % | |
852 | % @inmargin{TEXT [, RIGHT-TEXT]} | |
853 | % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; | |
854 | % else use TEXT for both). | |
177c0ea7 | 855 | % |
2c825956 GM |
856 | \def\inmargin#1{\parseinmargin #1,,\finish} |
857 | \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. | |
177c0ea7 | 858 | \setbox0 = \hbox{\ignorespaces #2}% |
2c825956 GM |
859 | \ifdim\wd0 > 0pt |
860 | \def\lefttext{#1}% have both texts | |
861 | \def\righttext{#2}% | |
862 | \else | |
863 | \def\lefttext{#1}% have only one text | |
864 | \def\righttext{#1}% | |
865 | \fi | |
866 | % | |
867 | \ifodd\pageno | |
868 | \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin | |
869 | \else | |
870 | \def\temp{\inleftmargin\lefttext}% | |
871 | \fi | |
872 | \temp | |
873 | } | |
874 | ||
875 | % @include file insert text of that file as input. | |
0f9c1975 KB |
876 | % |
877 | \def\include{\parseargusing\filenamecatcodes\includezzz} | |
878 | \def\includezzz#1{% | |
879 | \pushthisfilestack | |
2c825956 | 880 | \def\thisfile{#1}% |
0f9c1975 KB |
881 | {% |
882 | \makevalueexpandable | |
883 | \def\temp{\input #1 }% | |
884 | \expandafter | |
885 | }\temp | |
886 | \popthisfilestack | |
887 | } | |
888 | \def\filenamecatcodes{% | |
889 | \catcode`\\=\other | |
890 | \catcode`~=\other | |
891 | \catcode`^=\other | |
892 | \catcode`_=\other | |
893 | \catcode`|=\other | |
894 | \catcode`<=\other | |
895 | \catcode`>=\other | |
896 | \catcode`+=\other | |
897 | \catcode`-=\other | |
898 | } | |
2c825956 | 899 | |
0f9c1975 KB |
900 | \def\pushthisfilestack{% |
901 | \expandafter\pushthisfilestackX\popthisfilestack\StackTerm | |
902 | } | |
903 | \def\pushthisfilestackX{% | |
904 | \expandafter\pushthisfilestackY\thisfile\StackTerm | |
905 | } | |
906 | \def\pushthisfilestackY #1\StackTerm #2\StackTerm {% | |
907 | \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% | |
908 | } | |
909 | ||
910 | \def\popthisfilestack{\errthisfilestackempty} | |
911 | \def\errthisfilestackempty{\errmessage{Internal error: | |
912 | the stack of filenames is empty.}} | |
2c825956 | 913 | |
0f9c1975 | 914 | \def\thisfile{} |
2c825956 | 915 | |
0f9c1975 KB |
916 | % @center line |
917 | % outputs that line, centered. | |
918 | % | |
919 | \parseargdef\center{% | |
920 | \ifhmode | |
921 | \let\next\centerH | |
922 | \else | |
923 | \let\next\centerV | |
924 | \fi | |
925 | \next{\hfil \ignorespaces#1\unskip \hfil}% | |
926 | } | |
927 | \def\centerH#1{% | |
928 | {% | |
929 | \hfil\break | |
930 | \advance\hsize by -\leftskip | |
931 | \advance\hsize by -\rightskip | |
932 | \line{#1}% | |
933 | \break | |
934 | }% | |
935 | } | |
936 | \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}} | |
2c825956 GM |
937 | |
938 | % @sp n outputs n lines of vertical space | |
939 | ||
0f9c1975 | 940 | \parseargdef\sp{\vskip #1\baselineskip} |
2c825956 GM |
941 | |
942 | % @comment ...line which is ignored... | |
943 | % @c is the same as @comment | |
944 | % @ignore ... @end ignore is another way to write a comment | |
945 | ||
946 | \def\comment{\begingroup \catcode`\^^M=\other% | |
947 | \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% | |
948 | \commentxxx} | |
949 | {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} | |
950 | ||
951 | \let\c=\comment | |
952 | ||
953 | % @paragraphindent NCHARS | |
954 | % We'll use ems for NCHARS, close enough. | |
0f9c1975 KB |
955 | % NCHARS can also be the word `asis' or `none'. |
956 | % We cannot feasibly implement @paragraphindent asis, though. | |
177c0ea7 | 957 | % |
2c825956 GM |
958 | \def\asisword{asis} % no translation, these are keywords |
959 | \def\noneword{none} | |
960 | % | |
0f9c1975 | 961 | \parseargdef\paragraphindent{% |
2c825956 GM |
962 | \def\temp{#1}% |
963 | \ifx\temp\asisword | |
964 | \else | |
965 | \ifx\temp\noneword | |
966 | \defaultparindent = 0pt | |
967 | \else | |
968 | \defaultparindent = #1em | |
969 | \fi | |
970 | \fi | |
971 | \parindent = \defaultparindent | |
972 | } | |
973 | ||
974 | % @exampleindent NCHARS | |
975 | % We'll use ems for NCHARS like @paragraphindent. | |
976 | % It seems @exampleindent asis isn't necessary, but | |
977 | % I preserve it to make it similar to @paragraphindent. | |
0f9c1975 | 978 | \parseargdef\exampleindent{% |
2c825956 GM |
979 | \def\temp{#1}% |
980 | \ifx\temp\asisword | |
981 | \else | |
982 | \ifx\temp\noneword | |
983 | \lispnarrowing = 0pt | |
984 | \else | |
985 | \lispnarrowing = #1em | |
986 | \fi | |
987 | \fi | |
988 | } | |
989 | ||
0f9c1975 KB |
990 | % @firstparagraphindent WORD |
991 | % If WORD is `none', then suppress indentation of the first paragraph | |
992 | % after a section heading. If WORD is `insert', then do indent at such | |
993 | % paragraphs. | |
994 | % | |
995 | % The paragraph indentation is suppressed or not by calling | |
996 | % \suppressfirstparagraphindent, which the sectioning commands do. | |
997 | % We switch the definition of this back and forth according to WORD. | |
998 | % By default, we suppress indentation. | |
999 | % | |
1000 | \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} | |
1001 | \def\insertword{insert} | |
1002 | % | |
1003 | \parseargdef\firstparagraphindent{% | |
1004 | \def\temp{#1}% | |
1005 | \ifx\temp\noneword | |
1006 | \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent | |
1007 | \else\ifx\temp\insertword | |
1008 | \let\suppressfirstparagraphindent = \relax | |
1009 | \else | |
1010 | \errhelp = \EMsimple | |
1011 | \errmessage{Unknown @firstparagraphindent option `\temp'}% | |
1012 | \fi\fi | |
1013 | } | |
1014 | ||
1015 | % Here is how we actually suppress indentation. Redefine \everypar to | |
1016 | % \kern backwards by \parindent, and then reset itself to empty. | |
1017 | % | |
1018 | % We also make \indent itself not actually do anything until the next | |
1019 | % paragraph. | |
1020 | % | |
1021 | \gdef\dosuppressfirstparagraphindent{% | |
1022 | \gdef\indent{% | |
1023 | \restorefirstparagraphindent | |
1024 | \indent | |
1025 | }% | |
1026 | \gdef\noindent{% | |
1027 | \restorefirstparagraphindent | |
1028 | \noindent | |
1029 | }% | |
1030 | \global\everypar = {% | |
1031 | \kern -\parindent | |
1032 | \restorefirstparagraphindent | |
1033 | }% | |
1034 | } | |
1035 | ||
1036 | \gdef\restorefirstparagraphindent{% | |
1037 | \global \let \indent = \ptexindent | |
1038 | \global \let \noindent = \ptexnoindent | |
1039 | \global \everypar = {}% | |
1040 | } | |
1041 | ||
1042 | ||
2c825956 GM |
1043 | % @asis just yields its argument. Used with @table, for example. |
1044 | % | |
1045 | \def\asis#1{#1} | |
1046 | ||
08b16a02 | 1047 | % @math outputs its argument in math mode. |
2c825956 | 1048 | % |
08b16a02 PJ |
1049 | % One complication: _ usually means subscripts, but it could also mean |
1050 | % an actual _ character, as in @math{@var{some_variable} + 1}. So make | |
0f9c1975 KB |
1051 | % _ active, and distinguish by seeing if the current family is \slfam, |
1052 | % which is what @var uses. | |
1053 | { | |
1054 | \catcode`\_ = \active | |
1055 | \gdef\mathunderscore{% | |
1056 | \catcode`\_=\active | |
1057 | \def_{\ifnum\fam=\slfam \_\else\sb\fi}% | |
1058 | } | |
1059 | } | |
08b16a02 PJ |
1060 | % Another complication: we want \\ (and @\) to output a \ character. |
1061 | % FYI, plain.tex uses \\ as a temporary control sequence (why?), but | |
1062 | % this is not advertised and we don't care. Texinfo does not | |
1063 | % otherwise define @\. | |
177c0ea7 | 1064 | % |
08b16a02 PJ |
1065 | % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. |
1066 | \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} | |
1067 | % | |
1068 | \def\math{% | |
1069 | \tex | |
0f9c1975 | 1070 | \mathunderscore |
08b16a02 | 1071 | \let\\ = \mathbackslash |
0f9c1975 KB |
1072 | \mathactive |
1073 | $\finishmath | |
1074 | } | |
1075 | \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. | |
1076 | ||
1077 | % Some active characters (such as <) are spaced differently in math. | |
1078 | % We have to reset their definitions in case the @math was an argument | |
1079 | % to a command which sets the catcodes (such as @item or @section). | |
1080 | % | |
1081 | { | |
1082 | \catcode`^ = \active | |
1083 | \catcode`< = \active | |
1084 | \catcode`> = \active | |
1085 | \catcode`+ = \active | |
1086 | \gdef\mathactive{% | |
1087 | \let^ = \ptexhat | |
1088 | \let< = \ptexless | |
1089 | \let> = \ptexgtr | |
1090 | \let+ = \ptexplus | |
1091 | } | |
1092 | } | |
2c825956 GM |
1093 | |
1094 | % @bullet and @minus need the same treatment as @math, just above. | |
0f9c1975 KB |
1095 | \def\bullet{$\ptexbullet$} |
1096 | \def\minus{$-$} | |
1097 | ||
1098 | % @dots{} outputs an ellipsis using the current font. | |
fe23e770 KB |
1099 | % We do .5em per period so that it has the same spacing in the cm |
1100 | % typewriter fonts as three actual period characters; on the other hand, | |
1101 | % in other typewriter fonts three periods are wider than 1.5em. So do | |
1102 | % whichever is larger. | |
0f9c1975 KB |
1103 | % |
1104 | \def\dots{% | |
1105 | \leavevmode | |
fe23e770 KB |
1106 | \setbox0=\hbox{...}% get width of three periods |
1107 | \ifdim\wd0 > 1.5em | |
1108 | \dimen0 = \wd0 | |
1109 | \else | |
1110 | \dimen0 = 1.5em | |
1111 | \fi | |
1112 | \hbox to \dimen0{% | |
1113 | \hskip 0pt plus.25fil | |
1114 | .\hskip 0pt plus1fil | |
1115 | .\hskip 0pt plus1fil | |
1116 | .\hskip 0pt plus.5fil | |
0f9c1975 KB |
1117 | }% |
1118 | } | |
1119 | ||
1120 | % @enddots{} is an end-of-sentence ellipsis. | |
1121 | % | |
1122 | \def\enddots{% | |
1123 | \dots | |
1124 | \spacefactor=\endofsentencespacefactor | |
1125 | } | |
1126 | ||
1127 | % @comma{} is so commas can be inserted into text without messing up | |
1128 | % Texinfo's parsing. | |
1129 | % | |
1130 | \let\comma = , | |
2c825956 GM |
1131 | |
1132 | % @refill is a no-op. | |
1133 | \let\refill=\relax | |
1134 | ||
1135 | % If working on a large document in chapters, it is convenient to | |
1136 | % be able to disable indexing, cross-referencing, and contents, for test runs. | |
1137 | % This is done with @novalidate (before @setfilename). | |
1138 | % | |
1139 | \newif\iflinks \linkstrue % by default we want the aux files. | |
1140 | \let\novalidate = \linksfalse | |
1141 | ||
1142 | % @setfilename is done at the beginning of every texinfo file. | |
1143 | % So open here the files we need to have open while reading the input. | |
1144 | % This makes it possible to make a .fmt file for texinfo. | |
1145 | \def\setfilename{% | |
0f9c1975 | 1146 | \fixbackslash % Turn off hack to swallow `\input texinfo'. |
2c825956 | 1147 | \iflinks |
0f9c1975 KB |
1148 | \tryauxfile |
1149 | % Open the new aux file. TeX will close it automatically at exit. | |
1150 | \immediate\openout\auxfile=\jobname.aux | |
2c825956 GM |
1151 | \fi % \openindices needs to do some work in any case. |
1152 | \openindices | |
0f9c1975 | 1153 | \let\setfilename=\comment % Ignore extra @setfilename cmds. |
2c825956 GM |
1154 | % |
1155 | % If texinfo.cnf is present on the system, read it. | |
1156 | % Useful for site-wide @afourpaper, etc. | |
2c825956 | 1157 | \openin 1 texinfo.cnf |
0f9c1975 KB |
1158 | \ifeof 1 \else \input texinfo.cnf \fi |
1159 | \closein 1 | |
2c825956 GM |
1160 | % |
1161 | \comment % Ignore the actual filename. | |
1162 | } | |
1163 | ||
1164 | % Called from \setfilename. | |
1165 | % | |
1166 | \def\openindices{% | |
1167 | \newindex{cp}% | |
1168 | \newcodeindex{fn}% | |
1169 | \newcodeindex{vr}% | |
1170 | \newcodeindex{tp}% | |
1171 | \newcodeindex{ky}% | |
1172 | \newcodeindex{pg}% | |
1173 | } | |
1174 | ||
1175 | % @bye. | |
1176 | \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} | |
1177 | ||
1178 | ||
1179 | \message{pdf,} | |
1180 | % adobe `portable' document format | |
1181 | \newcount\tempnum | |
1182 | \newcount\lnkcount | |
1183 | \newtoks\filename | |
1184 | \newcount\filenamelength | |
1185 | \newcount\pgn | |
1186 | \newtoks\toksA | |
1187 | \newtoks\toksB | |
1188 | \newtoks\toksC | |
1189 | \newtoks\toksD | |
1190 | \newbox\boxA | |
1191 | \newcount\countA | |
1192 | \newif\ifpdf | |
1193 | \newif\ifpdfmakepagedest | |
1194 | ||
0f9c1975 KB |
1195 | % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 |
1196 | % can be set). So we test for \relax and 0 as well as \undefined, | |
1197 | % borrowed from ifpdf.sty. | |
2c825956 | 1198 | \ifx\pdfoutput\undefined |
2c825956 | 1199 | \else |
0f9c1975 KB |
1200 | \ifx\pdfoutput\relax |
1201 | \else | |
1202 | \ifcase\pdfoutput | |
1203 | \else | |
1204 | \pdftrue | |
1205 | \fi | |
1206 | \fi | |
1207 | \fi | |
1208 | ||
1209 | % PDF uses PostScript string constants for the names of xref targets, | |
1210 | % for display in the outlines, and in other places. Thus, we have to | |
1211 | % double any backslashes. Otherwise, a name like "\node" will be | |
1212 | % interpreted as a newline (\n), followed by o, d, e. Not good. | |
1213 | % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html | |
1214 | % (and related messages, the final outcome is that it is up to the TeX | |
1215 | % user to double the backslashes and otherwise make the string valid, so | |
1216 | % that's what we do). | |
1217 | ||
1218 | % double active backslashes. | |
1219 | % | |
1220 | {\catcode`\@=0 \catcode`\\=\active | |
1221 | @gdef@activebackslashdouble{% | |
1222 | @catcode`@\=@active | |
1223 | @let\=@doublebackslash} | |
1224 | } | |
1225 | ||
1226 | % To handle parens, we must adopt a different approach, since parens are | |
1227 | % not active characters. hyperref.dtx (which has the same problem as | |
98bf69dc KB |
1228 | % us) handles it with this amazing macro to replace tokens, with minor |
1229 | % changes for Texinfo. It is included here under the GPL by permission | |
1230 | % from the author, Heiko Oberdiek. | |
0f9c1975 KB |
1231 | % |
1232 | % #1 is the tokens to replace. | |
1233 | % #2 is the replacement. | |
1234 | % #3 is the control sequence with the string. | |
1235 | % | |
1236 | \def\HyPsdSubst#1#2#3{% | |
1237 | \def\HyPsdReplace##1#1##2\END{% | |
1238 | ##1% | |
1239 | \ifx\\##2\\% | |
1240 | \else | |
1241 | #2% | |
1242 | \HyReturnAfterFi{% | |
1243 | \HyPsdReplace##2\END | |
1244 | }% | |
1245 | \fi | |
1246 | }% | |
1247 | \xdef#3{\expandafter\HyPsdReplace#3#1\END}% | |
1248 | } | |
1249 | \long\def\HyReturnAfterFi#1\fi{\fi#1} | |
1250 | ||
1251 | % #1 is a control sequence in which to do the replacements. | |
1252 | \def\backslashparens#1{% | |
1253 | \xdef#1{#1}% redefine it as its expansion; the definition is simply | |
1254 | % \lastnode when called from \setref -> \pdfmkdest. | |
1255 | \HyPsdSubst{(}{\realbackslash(}{#1}% | |
1256 | \HyPsdSubst{)}{\realbackslash)}{#1}% | |
1257 | } | |
1258 | ||
74acc6cb KB |
1259 | \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images |
1260 | with PDF output, and none of those formats could be found. (.eps cannot | |
1261 | be supported due to the design of the PDF format; use regular TeX (DVI | |
1262 | output) for that.)} | |
1263 | ||
0f9c1975 | 1264 | \ifpdf |
2c825956 | 1265 | \input pdfcolor |
98bf69dc KB |
1266 | \pdfcatalog{/PageMode /UseOutlines} |
1267 | % | |
abbf811f | 1268 | % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto). |
2c825956 | 1269 | \def\dopdfimage#1#2#3{% |
abbf811f KB |
1270 | \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% |
1271 | \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% | |
74acc6cb KB |
1272 | % |
1273 | % pdftex (and the PDF format) support .png, .jpg, .pdf (among | |
1274 | % others). Let's try in that order. | |
1275 | \let\pdfimgext=\empty | |
1276 | \begingroup | |
1277 | \openin 1 #1.png \ifeof 1 | |
1278 | \openin 1 #1.jpg \ifeof 1 | |
1279 | \openin 1 #1.jpeg \ifeof 1 | |
1280 | \openin 1 #1.JPG \ifeof 1 | |
1281 | \openin 1 #1.pdf \ifeof 1 | |
1282 | \errhelp = \nopdfimagehelp | |
1283 | \errmessage{Could not find image file #1 for pdf}% | |
98bf69dc | 1284 | \else \gdef\pdfimgext{pdf}% |
74acc6cb | 1285 | \fi |
98bf69dc | 1286 | \else \gdef\pdfimgext{JPG}% |
74acc6cb | 1287 | \fi |
98bf69dc | 1288 | \else \gdef\pdfimgext{jpeg}% |
74acc6cb | 1289 | \fi |
98bf69dc | 1290 | \else \gdef\pdfimgext{jpg}% |
74acc6cb | 1291 | \fi |
98bf69dc | 1292 | \else \gdef\pdfimgext{png}% |
74acc6cb KB |
1293 | \fi |
1294 | \closein 1 | |
1295 | \endgroup | |
1296 | % | |
08b16a02 PJ |
1297 | % without \immediate, pdftex seg faults when the same image is |
1298 | % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) | |
2c825956 | 1299 | \ifnum\pdftexversion < 14 |
08b16a02 | 1300 | \immediate\pdfimage |
2c825956 | 1301 | \else |
08b16a02 | 1302 | \immediate\pdfximage |
2c825956 | 1303 | \fi |
abbf811f KB |
1304 | \ifdim \wd0 >0pt width \imagewidth \fi |
1305 | \ifdim \wd2 >0pt height \imageheight \fi | |
2c825956 | 1306 | \ifnum\pdftexversion<13 |
74acc6cb | 1307 | #1.\pdfimgext |
2c825956 | 1308 | \else |
74acc6cb | 1309 | {#1.\pdfimgext}% |
2c825956 GM |
1310 | \fi |
1311 | \ifnum\pdftexversion < 14 \else | |
1312 | \pdfrefximage \pdflastximage | |
1313 | \fi} | |
98bf69dc | 1314 | % |
0f9c1975 KB |
1315 | \def\pdfmkdest#1{{% |
1316 | % We have to set dummies so commands such as @code, and characters | |
1317 | % such as \, aren't expanded when present in a section title. | |
98bf69dc KB |
1318 | \indexnofonts |
1319 | \turnoffactive | |
0f9c1975 | 1320 | \activebackslashdouble |
98bf69dc | 1321 | \makevalueexpandable |
0f9c1975 KB |
1322 | \def\pdfdestname{#1}% |
1323 | \backslashparens\pdfdestname | |
98bf69dc KB |
1324 | \safewhatsit{\pdfdest name{\pdfdestname} xyz}% |
1325 | }} | |
0f9c1975 KB |
1326 | % |
1327 | % used to mark target names; must be expandable. | |
98bf69dc | 1328 | \def\pdfmkpgn#1{#1} |
0f9c1975 | 1329 | % |
2c825956 GM |
1330 | \let\linkcolor = \Blue % was Cyan, but that seems light? |
1331 | \def\endlink{\Black\pdfendlink} | |
98bf69dc | 1332 | % |
2c825956 GM |
1333 | % Adding outlines to PDF; macros for calculating structure of outlines |
1334 | % come from Petr Olsak | |
1335 | \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% | |
1336 | \else \csname#1\endcsname \fi} | |
1337 | \def\advancenumber#1{\tempnum=\expnumber{#1}\relax | |
0f9c1975 | 1338 | \advance\tempnum by 1 |
2c825956 | 1339 | \expandafter\xdef\csname#1\endcsname{\the\tempnum}} |
0f9c1975 KB |
1340 | % |
1341 | % #1 is the section text, which is what will be displayed in the | |
1342 | % outline by the pdf viewer. #2 is the pdf expression for the number | |
1343 | % of subentries (or empty, for subsubsections). #3 is the node text, | |
1344 | % which might be empty if this toc entry had no corresponding node. | |
1345 | % #4 is the page number | |
1346 | % | |
1347 | \def\dopdfoutline#1#2#3#4{% | |
1348 | % Generate a link to the node text if that exists; else, use the | |
1349 | % page number. We could generate a destination for the section | |
1350 | % text in the case where a section has no node, but it doesn't | |
1351 | % seem worth the trouble, since most documents are normally structured. | |
1352 | \def\pdfoutlinedest{#3}% | |
1353 | \ifx\pdfoutlinedest\empty | |
1354 | \def\pdfoutlinedest{#4}% | |
1355 | \else | |
1356 | % Doubled backslashes in the name. | |
1357 | {\activebackslashdouble \xdef\pdfoutlinedest{#3}% | |
1358 | \backslashparens\pdfoutlinedest}% | |
1359 | \fi | |
1360 | % | |
1361 | % Also double the backslashes in the display string. | |
1362 | {\activebackslashdouble \xdef\pdfoutlinetext{#1}% | |
1363 | \backslashparens\pdfoutlinetext}% | |
1364 | % | |
1365 | \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}% | |
1366 | } | |
1367 | % | |
1368 | \def\pdfmakeoutlines{% | |
1369 | \begingroup | |
1370 | % Thanh's hack / proper braces in bookmarks | |
2c825956 GM |
1371 | \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace |
1372 | \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace | |
1373 | % | |
0f9c1975 KB |
1374 | % Read toc silently, to get counts of subentries for \pdfoutline. |
1375 | \def\numchapentry##1##2##3##4{% | |
1376 | \def\thischapnum{##2}% | |
1377 | \def\thissecnum{0}% | |
1378 | \def\thissubsecnum{0}% | |
1379 | }% | |
1380 | \def\numsecentry##1##2##3##4{% | |
1381 | \advancenumber{chap\thischapnum}% | |
1382 | \def\thissecnum{##2}% | |
1383 | \def\thissubsecnum{0}% | |
1384 | }% | |
1385 | \def\numsubsecentry##1##2##3##4{% | |
1386 | \advancenumber{sec\thissecnum}% | |
1387 | \def\thissubsecnum{##2}% | |
1388 | }% | |
1389 | \def\numsubsubsecentry##1##2##3##4{% | |
1390 | \advancenumber{subsec\thissubsecnum}% | |
1391 | }% | |
1392 | \def\thischapnum{0}% | |
1393 | \def\thissecnum{0}% | |
1394 | \def\thissubsecnum{0}% | |
1395 | % | |
1396 | % use \def rather than \let here because we redefine \chapentry et | |
1397 | % al. a second time, below. | |
1398 | \def\appentry{\numchapentry}% | |
1399 | \def\appsecentry{\numsecentry}% | |
1400 | \def\appsubsecentry{\numsubsecentry}% | |
1401 | \def\appsubsubsecentry{\numsubsubsecentry}% | |
1402 | \def\unnchapentry{\numchapentry}% | |
1403 | \def\unnsecentry{\numsecentry}% | |
1404 | \def\unnsubsecentry{\numsubsecentry}% | |
1405 | \def\unnsubsubsecentry{\numsubsubsecentry}% | |
1406 | \readdatafile{toc}% | |
1407 | % | |
1408 | % Read toc second time, this time actually producing the outlines. | |
1409 | % The `-' means take the \expnumber as the absolute number of | |
1410 | % subentries, which we calculated on our first read of the .toc above. | |
1411 | % | |
1412 | % We use the node names as the destinations. | |
1413 | \def\numchapentry##1##2##3##4{% | |
1414 | \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% | |
1415 | \def\numsecentry##1##2##3##4{% | |
1416 | \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% | |
1417 | \def\numsubsecentry##1##2##3##4{% | |
1418 | \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% | |
1419 | \def\numsubsubsecentry##1##2##3##4{% count is always zero | |
1420 | \dopdfoutline{##1}{}{##3}{##4}}% | |
1421 | % | |
1422 | % PDF outlines are displayed using system fonts, instead of | |
1423 | % document fonts. Therefore we cannot use special characters, | |
1424 | % since the encoding is unknown. For example, the eogonek from | |
1425 | % Latin 2 (0xea) gets translated to a | character. Info from | |
1426 | % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. | |
1427 | % | |
1428 | % xx to do this right, we have to translate 8-bit characters to | |
1429 | % their "best" equivalent, based on the @documentencoding. Right | |
1430 | % now, I guess we'll just let the pdf reader have its way. | |
1431 | \indexnofonts | |
1432 | \setupdatafile | |
1433 | \catcode`\\=\active \otherbackslash | |
2c825956 | 1434 | \input \jobname.toc |
0f9c1975 | 1435 | \endgroup |
2c825956 | 1436 | } |
0f9c1975 | 1437 | % |
2c825956 GM |
1438 | \def\skipspaces#1{\def\PP{#1}\def\D{|}% |
1439 | \ifx\PP\D\let\nextsp\relax | |
1440 | \else\let\nextsp\skipspaces | |
1441 | \ifx\p\space\else\addtokens{\filename}{\PP}% | |
1442 | \advance\filenamelength by 1 | |
1443 | \fi | |
1444 | \fi | |
1445 | \nextsp} | |
1446 | \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} | |
1447 | \ifnum\pdftexversion < 14 | |
1448 | \let \startlink \pdfannotlink | |
1449 | \else | |
1450 | \let \startlink \pdfstartlink | |
1451 | \fi | |
0f9c1975 | 1452 | % make a live url in pdf output. |
2c825956 GM |
1453 | \def\pdfurl#1{% |
1454 | \begingroup | |
0f9c1975 KB |
1455 | % it seems we really need yet another set of dummies; have not |
1456 | % tried to figure out what each command should do in the context | |
1457 | % of @url. for now, just make @/ a no-op, that's the only one | |
1458 | % people have actually reported a problem with. | |
1459 | % | |
1460 | \normalturnoffactive | |
1461 | \def\@{@}% | |
1462 | \let\/=\empty | |
1463 | \makevalueexpandable | |
2c825956 GM |
1464 | \leavevmode\Red |
1465 | \startlink attr{/Border [0 0 0]}% | |
1466 | user{/Subtype /Link /A << /S /URI /URI (#1) >>}% | |
2c825956 GM |
1467 | \endgroup} |
1468 | \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} | |
1469 | \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} | |
1470 | \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} | |
1471 | \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} | |
1472 | \def\maketoks{% | |
0f9c1975 | 1473 | \expandafter\poptoks\the\toksA|ENDTOKS|\relax |
2c825956 GM |
1474 | \ifx\first0\adn0 |
1475 | \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 | |
1476 | \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 | |
177c0ea7 | 1477 | \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 |
2c825956 GM |
1478 | \else |
1479 | \ifnum0=\countA\else\makelink\fi | |
1480 | \ifx\first.\let\next=\done\else | |
1481 | \let\next=\maketoks | |
1482 | \addtokens{\toksB}{\the\toksD} | |
1483 | \ifx\first,\addtokens{\toksB}{\space}\fi | |
1484 | \fi | |
1485 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi | |
1486 | \next} | |
1487 | \def\makelink{\addtokens{\toksB}% | |
1488 | {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} | |
1489 | \def\pdflink#1{% | |
08b16a02 | 1490 | \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} |
2c825956 | 1491 | \linkcolor #1\endlink} |
2c825956 | 1492 | \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} |
0f9c1975 KB |
1493 | \else |
1494 | \let\pdfmkdest = \gobble | |
1495 | \let\pdfurl = \gobble | |
1496 | \let\endlink = \relax | |
1497 | \let\linkcolor = \relax | |
1498 | \let\pdfmakeoutlines = \relax | |
1499 | \fi % \ifx\pdfoutput | |
2c825956 GM |
1500 | |
1501 | ||
1502 | \message{fonts,} | |
0f9c1975 KB |
1503 | |
1504 | % Change the current font style to #1, remembering it in \curfontstyle. | |
1505 | % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in | |
1506 | % italics, not bold italics. | |
1507 | % | |
1508 | \def\setfontstyle#1{% | |
1509 | \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. | |
1510 | \csname ten#1\endcsname % change the current font | |
1511 | } | |
1512 | ||
1513 | % Select #1 fonts with the current style. | |
1514 | % | |
1515 | \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} | |
1516 | ||
1517 | \def\rm{\fam=0 \setfontstyle{rm}} | |
1518 | \def\it{\fam=\itfam \setfontstyle{it}} | |
1519 | \def\sl{\fam=\slfam \setfontstyle{sl}} | |
1520 | \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} | |
1521 | \def\tt{\fam=\ttfam \setfontstyle{tt}} | |
2c825956 GM |
1522 | |
1523 | % Texinfo sort of supports the sans serif font style, which plain TeX does not. | |
0f9c1975 | 1524 | % So we set up a \sf. |
2c825956 | 1525 | \newfam\sffam |
0f9c1975 | 1526 | \def\sf{\fam=\sffam \setfontstyle{sf}} |
2c825956 GM |
1527 | \let\li = \sf % Sometimes we call it \li, not \sf. |
1528 | ||
0f9c1975 KB |
1529 | % We don't need math for this font style. |
1530 | \def\ttsl{\setfontstyle{ttsl}} | |
2c825956 | 1531 | |
dfe1fb06 | 1532 | |
08b16a02 PJ |
1533 | % Default leading. |
1534 | \newdimen\textleading \textleading = 13.2pt | |
1535 | ||
1536 | % Set the baselineskip to #1, and the lineskip and strut size | |
1537 | % correspondingly. There is no deep meaning behind these magic numbers | |
1538 | % used as factors; they just match (closely enough) what Knuth defined. | |
1539 | % | |
1540 | \def\lineskipfactor{.08333} | |
1541 | \def\strutheightpercent{.70833} | |
1542 | \def\strutdepthpercent {.29167} | |
1543 | % | |
1544 | \def\setleading#1{% | |
1545 | \normalbaselineskip = #1\relax | |
1546 | \normallineskip = \lineskipfactor\normalbaselineskip | |
1547 | \normalbaselines | |
1548 | \setbox\strutbox =\hbox{% | |
1549 | \vrule width0pt height\strutheightpercent\baselineskip | |
1550 | depth \strutdepthpercent \baselineskip | |
1551 | }% | |
1552 | } | |
2c825956 | 1553 | |
dfe1fb06 | 1554 | |
2c825956 GM |
1555 | % Set the font macro #1 to the font named #2, adding on the |
1556 | % specified font prefix (normally `cm'). | |
1557 | % #3 is the font's design size, #4 is a scale factor | |
1558 | \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} | |
1559 | ||
dfe1fb06 | 1560 | |
2c825956 GM |
1561 | % Use cm as the default font prefix. |
1562 | % To specify the font prefix, you must define \fontprefix | |
1563 | % before you read in texinfo.tex. | |
1564 | \ifx\fontprefix\undefined | |
1565 | \def\fontprefix{cm} | |
1566 | \fi | |
1567 | % Support font families that don't use the same naming scheme as CM. | |
1568 | \def\rmshape{r} | |
1569 | \def\rmbshape{bx} %where the normal face is bold | |
1570 | \def\bfshape{b} | |
1571 | \def\bxshape{bx} | |
1572 | \def\ttshape{tt} | |
1573 | \def\ttbshape{tt} | |
1574 | \def\ttslshape{sltt} | |
1575 | \def\itshape{ti} | |
1576 | \def\itbshape{bxti} | |
1577 | \def\slshape{sl} | |
1578 | \def\slbshape{bxsl} | |
1579 | \def\sfshape{ss} | |
1580 | \def\sfbshape{ss} | |
1581 | \def\scshape{csc} | |
1582 | \def\scbshape{csc} | |
1583 | ||
dfe1fb06 KB |
1584 | % Definitions for a main text size of 11pt. This is the default in |
1585 | % Texinfo. | |
1586 | % | |
98bf69dc | 1587 | \def\definetextfontsizexi{% |
0f9c1975 KB |
1588 | % Text fonts (11.2pt, magstep1). |
1589 | \def\textnominalsize{11pt} | |
1590 | \edef\mainmagstep{\magstephalf} | |
1591 | \setfont\textrm\rmshape{10}{\mainmagstep} | |
1592 | \setfont\texttt\ttshape{10}{\mainmagstep} | |
2c825956 GM |
1593 | \setfont\textbf\bfshape{10}{\mainmagstep} |
1594 | \setfont\textit\itshape{10}{\mainmagstep} | |
1595 | \setfont\textsl\slshape{10}{\mainmagstep} | |
1596 | \setfont\textsf\sfshape{10}{\mainmagstep} | |
1597 | \setfont\textsc\scshape{10}{\mainmagstep} | |
1598 | \setfont\textttsl\ttslshape{10}{\mainmagstep} | |
1599 | \font\texti=cmmi10 scaled \mainmagstep | |
1600 | \font\textsy=cmsy10 scaled \mainmagstep | |
1601 | ||
0f9c1975 KB |
1602 | % A few fonts for @defun names and args. |
1603 | \setfont\defbf\bfshape{10}{\magstep1} | |
2c825956 | 1604 | \setfont\deftt\ttshape{10}{\magstep1} |
0f9c1975 KB |
1605 | \setfont\defttsl\ttslshape{10}{\magstep1} |
1606 | \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} | |
2c825956 GM |
1607 | |
1608 | % Fonts for indices, footnotes, small examples (9pt). | |
0f9c1975 | 1609 | \def\smallnominalsize{9pt} |
2c825956 GM |
1610 | \setfont\smallrm\rmshape{9}{1000} |
1611 | \setfont\smalltt\ttshape{9}{1000} | |
1612 | \setfont\smallbf\bfshape{10}{900} | |
1613 | \setfont\smallit\itshape{9}{1000} | |
1614 | \setfont\smallsl\slshape{9}{1000} | |
1615 | \setfont\smallsf\sfshape{9}{1000} | |
1616 | \setfont\smallsc\scshape{10}{900} | |
1617 | \setfont\smallttsl\ttslshape{10}{900} | |
1618 | \font\smalli=cmmi9 | |
1619 | \font\smallsy=cmsy9 | |
1620 | ||
08b16a02 | 1621 | % Fonts for small examples (8pt). |
0f9c1975 | 1622 | \def\smallernominalsize{8pt} |
08b16a02 PJ |
1623 | \setfont\smallerrm\rmshape{8}{1000} |
1624 | \setfont\smallertt\ttshape{8}{1000} | |
1625 | \setfont\smallerbf\bfshape{10}{800} | |
1626 | \setfont\smallerit\itshape{8}{1000} | |
1627 | \setfont\smallersl\slshape{8}{1000} | |
1628 | \setfont\smallersf\sfshape{8}{1000} | |
1629 | \setfont\smallersc\scshape{10}{800} | |
1630 | \setfont\smallerttsl\ttslshape{10}{800} | |
1631 | \font\smalleri=cmmi8 | |
1632 | \font\smallersy=cmsy8 | |
1633 | ||
0f9c1975 KB |
1634 | % Fonts for title page (20.4pt): |
1635 | \def\titlenominalsize{20pt} | |
2c825956 GM |
1636 | \setfont\titlerm\rmbshape{12}{\magstep3} |
1637 | \setfont\titleit\itbshape{10}{\magstep4} | |
1638 | \setfont\titlesl\slbshape{10}{\magstep4} | |
1639 | \setfont\titlett\ttbshape{12}{\magstep3} | |
1640 | \setfont\titlettsl\ttslshape{10}{\magstep4} | |
1641 | \setfont\titlesf\sfbshape{17}{\magstep1} | |
1642 | \let\titlebf=\titlerm | |
1643 | \setfont\titlesc\scbshape{10}{\magstep4} | |
1644 | \font\titlei=cmmi12 scaled \magstep3 | |
1645 | \font\titlesy=cmsy10 scaled \magstep4 | |
1646 | \def\authorrm{\secrm} | |
0f9c1975 | 1647 | \def\authortt{\sectt} |
2c825956 GM |
1648 | |
1649 | % Chapter (and unnumbered) fonts (17.28pt). | |
0f9c1975 | 1650 | \def\chapnominalsize{17pt} |
2c825956 GM |
1651 | \setfont\chaprm\rmbshape{12}{\magstep2} |
1652 | \setfont\chapit\itbshape{10}{\magstep3} | |
1653 | \setfont\chapsl\slbshape{10}{\magstep3} | |
1654 | \setfont\chaptt\ttbshape{12}{\magstep2} | |
1655 | \setfont\chapttsl\ttslshape{10}{\magstep3} | |
1656 | \setfont\chapsf\sfbshape{17}{1000} | |
1657 | \let\chapbf=\chaprm | |
1658 | \setfont\chapsc\scbshape{10}{\magstep3} | |
1659 | \font\chapi=cmmi12 scaled \magstep2 | |
1660 | \font\chapsy=cmsy10 scaled \magstep3 | |
1661 | ||
1662 | % Section fonts (14.4pt). | |
0f9c1975 | 1663 | \def\secnominalsize{14pt} |
2c825956 GM |
1664 | \setfont\secrm\rmbshape{12}{\magstep1} |
1665 | \setfont\secit\itbshape{10}{\magstep2} | |
1666 | \setfont\secsl\slbshape{10}{\magstep2} | |
1667 | \setfont\sectt\ttbshape{12}{\magstep1} | |
1668 | \setfont\secttsl\ttslshape{10}{\magstep2} | |
1669 | \setfont\secsf\sfbshape{12}{\magstep1} | |
1670 | \let\secbf\secrm | |
1671 | \setfont\secsc\scbshape{10}{\magstep2} | |
1672 | \font\seci=cmmi12 scaled \magstep1 | |
1673 | \font\secsy=cmsy10 scaled \magstep2 | |
1674 | ||
2c825956 | 1675 | % Subsection fonts (13.15pt). |
0f9c1975 | 1676 | \def\ssecnominalsize{13pt} |
2c825956 GM |
1677 | \setfont\ssecrm\rmbshape{12}{\magstephalf} |
1678 | \setfont\ssecit\itbshape{10}{1315} | |
1679 | \setfont\ssecsl\slbshape{10}{1315} | |
1680 | \setfont\ssectt\ttbshape{12}{\magstephalf} | |
1681 | \setfont\ssecttsl\ttslshape{10}{1315} | |
1682 | \setfont\ssecsf\sfbshape{12}{\magstephalf} | |
1683 | \let\ssecbf\ssecrm | |
0f9c1975 | 1684 | \setfont\ssecsc\scbshape{10}{1315} |
2c825956 GM |
1685 | \font\sseci=cmmi12 scaled \magstephalf |
1686 | \font\ssecsy=cmsy10 scaled 1315 | |
0f9c1975 KB |
1687 | |
1688 | % Reduced fonts for @acro in text (10pt). | |
1689 | \def\reducednominalsize{10pt} | |
1690 | \setfont\reducedrm\rmshape{10}{1000} | |
1691 | \setfont\reducedtt\ttshape{10}{1000} | |
1692 | \setfont\reducedbf\bfshape{10}{1000} | |
1693 | \setfont\reducedit\itshape{10}{1000} | |
1694 | \setfont\reducedsl\slshape{10}{1000} | |
1695 | \setfont\reducedsf\sfshape{10}{1000} | |
1696 | \setfont\reducedsc\scshape{10}{1000} | |
1697 | \setfont\reducedttsl\ttslshape{10}{1000} | |
1698 | \font\reducedi=cmmi10 | |
1699 | \font\reducedsy=cmsy10 | |
2c825956 | 1700 | |
dfe1fb06 KB |
1701 | % reset the current fonts |
1702 | \textfonts | |
1703 | \rm | |
1704 | } % end of 11pt text font size definitions | |
1705 | ||
1706 | ||
1707 | % Definitions to make the main text be 10pt Computer Modern, with | |
1708 | % section, chapter, etc., sizes following suit. This is for the GNU | |
1709 | % Press printing of the Emacs 22 manual. Maybe other manuals in the | |
1710 | % future. Used with @smallbook, which sets the leading to 12pt. | |
1711 | % | |
1712 | \def\definetextfontsizex{% | |
1713 | % Text fonts (10pt). | |
1714 | \def\textnominalsize{10pt} | |
1715 | \edef\mainmagstep{1000} | |
1716 | \setfont\textrm\rmshape{10}{\mainmagstep} | |
1717 | \setfont\texttt\ttshape{10}{\mainmagstep} | |
1718 | \setfont\textbf\bfshape{10}{\mainmagstep} | |
1719 | \setfont\textit\itshape{10}{\mainmagstep} | |
1720 | \setfont\textsl\slshape{10}{\mainmagstep} | |
1721 | \setfont\textsf\sfshape{10}{\mainmagstep} | |
1722 | \setfont\textsc\scshape{10}{\mainmagstep} | |
1723 | \setfont\textttsl\ttslshape{10}{\mainmagstep} | |
1724 | \font\texti=cmmi10 scaled \mainmagstep | |
1725 | \font\textsy=cmsy10 scaled \mainmagstep | |
1726 | ||
1727 | % A few fonts for @defun names and args. | |
1728 | \setfont\defbf\bfshape{10}{\magstephalf} | |
1729 | \setfont\deftt\ttshape{10}{\magstephalf} | |
1730 | \setfont\defttsl\ttslshape{10}{\magstephalf} | |
1731 | \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} | |
1732 | ||
1733 | % Fonts for indices, footnotes, small examples (9pt). | |
1734 | \def\smallnominalsize{9pt} | |
1735 | \setfont\smallrm\rmshape{9}{1000} | |
1736 | \setfont\smalltt\ttshape{9}{1000} | |
1737 | \setfont\smallbf\bfshape{10}{900} | |
1738 | \setfont\smallit\itshape{9}{1000} | |
1739 | \setfont\smallsl\slshape{9}{1000} | |
1740 | \setfont\smallsf\sfshape{9}{1000} | |
1741 | \setfont\smallsc\scshape{10}{900} | |
1742 | \setfont\smallttsl\ttslshape{10}{900} | |
1743 | \font\smalli=cmmi9 | |
1744 | \font\smallsy=cmsy9 | |
1745 | ||
1746 | % Fonts for small examples (8pt). | |
1747 | \def\smallernominalsize{8pt} | |
1748 | \setfont\smallerrm\rmshape{8}{1000} | |
1749 | \setfont\smallertt\ttshape{8}{1000} | |
1750 | \setfont\smallerbf\bfshape{10}{800} | |
1751 | \setfont\smallerit\itshape{8}{1000} | |
1752 | \setfont\smallersl\slshape{8}{1000} | |
1753 | \setfont\smallersf\sfshape{8}{1000} | |
1754 | \setfont\smallersc\scshape{10}{800} | |
1755 | \setfont\smallerttsl\ttslshape{10}{800} | |
1756 | \font\smalleri=cmmi8 | |
1757 | \font\smallersy=cmsy8 | |
1758 | ||
1759 | % Fonts for title page (20.4pt): | |
1760 | \def\titlenominalsize{20pt} | |
1761 | \setfont\titlerm\rmbshape{12}{\magstep3} | |
1762 | \setfont\titleit\itbshape{10}{\magstep4} | |
1763 | \setfont\titlesl\slbshape{10}{\magstep4} | |
1764 | \setfont\titlett\ttbshape{12}{\magstep3} | |
1765 | \setfont\titlettsl\ttslshape{10}{\magstep4} | |
1766 | \setfont\titlesf\sfbshape{17}{\magstep1} | |
1767 | \let\titlebf=\titlerm | |
1768 | \setfont\titlesc\scbshape{10}{\magstep4} | |
1769 | \font\titlei=cmmi12 scaled \magstep3 | |
1770 | \font\titlesy=cmsy10 scaled \magstep4 | |
1771 | \def\authorrm{\secrm} | |
1772 | \def\authortt{\sectt} | |
1773 | ||
1774 | % Chapter fonts (14.4pt). | |
1775 | \def\chapnominalsize{14pt} | |
1776 | \setfont\chaprm\rmbshape{12}{\magstep1} | |
1777 | \setfont\chapit\itbshape{10}{\magstep2} | |
1778 | \setfont\chapsl\slbshape{10}{\magstep2} | |
1779 | \setfont\chaptt\ttbshape{12}{\magstep1} | |
1780 | \setfont\chapttsl\ttslshape{10}{\magstep2} | |
1781 | \setfont\chapsf\sfbshape{12}{\magstep1} | |
1782 | \let\chapbf\chaprm | |
1783 | \setfont\chapsc\scbshape{10}{\magstep2} | |
1784 | \font\chapi=cmmi12 scaled \magstep1 | |
1785 | \font\chapsy=cmsy10 scaled \magstep2 | |
1786 | ||
1787 | % Section fonts (12pt). | |
1788 | \def\secnominalsize{12pt} | |
1789 | \setfont\secrm\rmbshape{12}{1000} | |
1790 | \setfont\secit\itbshape{10}{\magstep1} | |
1791 | \setfont\secsl\slbshape{10}{\magstep1} | |
1792 | \setfont\sectt\ttbshape{12}{1000} | |
1793 | \setfont\secttsl\ttslshape{10}{\magstep1} | |
1794 | \setfont\secsf\sfbshape{12}{1000} | |
1795 | \let\secbf\secrm | |
1796 | \setfont\secsc\scbshape{10}{\magstep1} | |
1797 | \font\seci=cmmi12 | |
1798 | \font\secsy=cmsy10 scaled \magstep1 | |
1799 | ||
1800 | % Subsection fonts (10pt). | |
1801 | \def\ssecnominalsize{10pt} | |
1802 | \setfont\ssecrm\rmbshape{10}{1000} | |
1803 | \setfont\ssecit\itbshape{10}{1000} | |
1804 | \setfont\ssecsl\slbshape{10}{1000} | |
1805 | \setfont\ssectt\ttbshape{10}{1000} | |
1806 | \setfont\ssecttsl\ttslshape{10}{1000} | |
1807 | \setfont\ssecsf\sfbshape{10}{1000} | |
1808 | \let\ssecbf\ssecrm | |
1809 | \setfont\ssecsc\scbshape{10}{1000} | |
1810 | \font\sseci=cmmi10 | |
1811 | \font\ssecsy=cmsy10 | |
1812 | ||
1813 | % Reduced fonts for @acro in text (9pt). | |
1814 | \def\reducednominalsize{9pt} | |
1815 | \setfont\reducedrm\rmshape{9}{1000} | |
1816 | \setfont\reducedtt\ttshape{9}{1000} | |
1817 | \setfont\reducedbf\bfshape{10}{900} | |
1818 | \setfont\reducedit\itshape{9}{1000} | |
1819 | \setfont\reducedsl\slshape{9}{1000} | |
1820 | \setfont\reducedsf\sfshape{9}{1000} | |
1821 | \setfont\reducedsc\scshape{10}{900} | |
1822 | \setfont\reducedttsl\ttslshape{10}{900} | |
1823 | \font\reducedi=cmmi9 | |
1824 | \font\reducedsy=cmsy9 | |
1825 | ||
1826 | % reduce space between paragraphs | |
1827 | \divide\parskip by 2 | |
1828 | ||
1829 | % reset the current fonts | |
1830 | \textfonts | |
1831 | \rm | |
1832 | } % end of 10pt text font size definitions | |
1833 | ||
1834 | ||
1835 | % We provide the user-level command | |
1836 | % @fonttextsize 10 | |
1837 | % (or 11) to redefine the text font size. pt is assumed. | |
1838 | % | |
1839 | \def\xword{10} | |
1840 | \def\xiword{11} | |
1841 | % | |
1842 | \parseargdef\fonttextsize{% | |
1843 | \def\textsizearg{#1}% | |
1844 | \wlog{doing @fonttextsize \textsizearg}% | |
1845 | % | |
1846 | % Set \globaldefs so that documents can use this inside @tex, since | |
1847 | % makeinfo 4.8 does not support it, but we need it nonetheless. | |
1848 | % | |
1849 | \begingroup \globaldefs=1 | |
1850 | \ifx\textsizearg\xword \definetextfontsizex | |
1851 | \else \ifx\textsizearg\xiword \definetextfontsizexi | |
1852 | \else | |
1853 | \errhelp=\EMsimple | |
1854 | \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'} | |
1855 | \fi\fi | |
1856 | \endgroup | |
1857 | } | |
1858 | ||
1859 | ||
2c825956 GM |
1860 | % In order for the font changes to affect most math symbols and letters, |
1861 | % we have to define the \textfont of the standard families. Since | |
08b16a02 PJ |
1862 | % texinfo doesn't allow for producing subscripts and superscripts except |
1863 | % in the main text, we don't bother to reset \scriptfont and | |
1864 | % \scriptscriptfont (which would also require loading a lot more fonts). | |
2c825956 GM |
1865 | % |
1866 | \def\resetmathfonts{% | |
08b16a02 PJ |
1867 | \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy |
1868 | \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf | |
1869 | \textfont\ttfam=\tentt \textfont\sffam=\tensf | |
2c825956 GM |
1870 | } |
1871 | ||
2c825956 | 1872 | % The font-changing commands redefine the meanings of \tenSTYLE, instead |
0f9c1975 KB |
1873 | % of just \STYLE. We do this because \STYLE needs to also set the |
1874 | % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire | |
1875 | % \tenSTYLE to set the current font. | |
1876 | % | |
1877 | % Each font-changing command also sets the names \lsize (one size lower) | |
1878 | % and \lllsize (three sizes lower). These relative commands are used in | |
1879 | % the LaTeX logo and acronyms. | |
1880 | % | |
1881 | % This all needs generalizing, badly. | |
1882 | % | |
2c825956 GM |
1883 | \def\textfonts{% |
1884 | \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl | |
1885 | \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc | |
0f9c1975 KB |
1886 | \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy |
1887 | \let\tenttsl=\textttsl | |
1888 | \def\curfontsize{text}% | |
1889 | \def\lsize{reduced}\def\lllsize{smaller}% | |
08b16a02 | 1890 | \resetmathfonts \setleading{\textleading}} |
2c825956 GM |
1891 | \def\titlefonts{% |
1892 | \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl | |
1893 | \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc | |
1894 | \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy | |
1895 | \let\tenttsl=\titlettsl | |
0f9c1975 KB |
1896 | \def\curfontsize{title}% |
1897 | \def\lsize{chap}\def\lllsize{subsec}% | |
2c825956 GM |
1898 | \resetmathfonts \setleading{25pt}} |
1899 | \def\titlefont#1{{\titlefonts\rm #1}} | |
1900 | \def\chapfonts{% | |
1901 | \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl | |
1902 | \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc | |
0f9c1975 KB |
1903 | \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy |
1904 | \let\tenttsl=\chapttsl | |
1905 | \def\curfontsize{chap}% | |
1906 | \def\lsize{sec}\def\lllsize{text}% | |
2c825956 GM |
1907 | \resetmathfonts \setleading{19pt}} |
1908 | \def\secfonts{% | |
1909 | \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl | |
1910 | \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc | |
0f9c1975 KB |
1911 | \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy |
1912 | \let\tenttsl=\secttsl | |
1913 | \def\curfontsize{sec}% | |
1914 | \def\lsize{subsec}\def\lllsize{reduced}% | |
2c825956 GM |
1915 | \resetmathfonts \setleading{16pt}} |
1916 | \def\subsecfonts{% | |
1917 | \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl | |
1918 | \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc | |
0f9c1975 KB |
1919 | \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy |
1920 | \let\tenttsl=\ssecttsl | |
1921 | \def\curfontsize{ssec}% | |
1922 | \def\lsize{text}\def\lllsize{small}% | |
2c825956 | 1923 | \resetmathfonts \setleading{15pt}} |
0f9c1975 KB |
1924 | \let\subsubsecfonts = \subsecfonts |
1925 | \def\reducedfonts{% | |
1926 | \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl | |
1927 | \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc | |
1928 | \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy | |
1929 | \let\tenttsl=\reducedttsl | |
1930 | \def\curfontsize{reduced}% | |
1931 | \def\lsize{small}\def\lllsize{smaller}% | |
1932 | \resetmathfonts \setleading{10.5pt}} | |
2c825956 GM |
1933 | \def\smallfonts{% |
1934 | \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl | |
1935 | \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc | |
1936 | \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy | |
1937 | \let\tenttsl=\smallttsl | |
0f9c1975 KB |
1938 | \def\curfontsize{small}% |
1939 | \def\lsize{smaller}\def\lllsize{smaller}% | |
08b16a02 PJ |
1940 | \resetmathfonts \setleading{10.5pt}} |
1941 | \def\smallerfonts{% | |
1942 | \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl | |
1943 | \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc | |
1944 | \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy | |
1945 | \let\tenttsl=\smallerttsl | |
0f9c1975 KB |
1946 | \def\curfontsize{smaller}% |
1947 | \def\lsize{smaller}\def\lllsize{smaller}% | |
08b16a02 | 1948 | \resetmathfonts \setleading{9.5pt}} |
0f9c1975 KB |
1949 | |
1950 | % Set the fonts to use with the @small... environments. | |
1951 | \let\smallexamplefonts = \smallfonts | |
1952 | ||
1953 | % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample | |
1954 | % can fit this many characters: | |
1955 | % 8.5x11=86 smallbook=72 a4=90 a5=69 | |
1956 | % If we use \scriptfonts (8pt), then we can fit this many characters: | |
1957 | % 8.5x11=90+ smallbook=80 a4=90+ a5=77 | |
1958 | % For me, subjectively, the few extra characters that fit aren't worth | |
1959 | % the additional smallness of 8pt. So I'm making the default 9pt. | |
1960 | % | |
1961 | % By the way, for comparison, here's what fits with @example (10pt): | |
1962 | % 8.5x11=71 smallbook=60 a4=75 a5=58 | |
1963 | % | |
1964 | % I wish the USA used A4 paper. | |
1965 | % --karl, 24jan03. | |
1966 | ||
2c825956 GM |
1967 | |
1968 | % Set up the default fonts, so we can use them for creating boxes. | |
1969 | % | |
dfe1fb06 | 1970 | \definetextfontsizexi |
2c825956 GM |
1971 | |
1972 | % Define these so they can be easily changed for other fonts. | |
1973 | \def\angleleft{$\langle$} | |
1974 | \def\angleright{$\rangle$} | |
1975 | ||
1976 | % Count depth in font-changes, for error checks | |
1977 | \newcount\fontdepth \fontdepth=0 | |
1978 | ||
1979 | % Fonts for short table of contents. | |
1980 | \setfont\shortcontrm\rmshape{12}{1000} | |
0f9c1975 | 1981 | \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12 |
2c825956 | 1982 | \setfont\shortcontsl\slshape{12}{1000} |
0f9c1975 | 1983 | \setfont\shortconttt\ttshape{12}{1000} |
2c825956 GM |
1984 | |
1985 | %% Add scribe-like font environments, plus @l for inline lisp (usually sans | |
1986 | %% serif) and @ii for TeX italic | |
1987 | ||
1988 | % \smartitalic{ARG} outputs arg in italics, followed by an italic correction | |
1989 | % unless the following character is such as not to need one. | |
0f9c1975 KB |
1990 | \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else |
1991 | \ptexslash\fi\fi\fi} | |
1992 | \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} | |
1993 | \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} | |
1994 | ||
1995 | % like \smartslanted except unconditionally uses \ttsl. | |
1996 | % @var is set to this for defun arguments. | |
1997 | \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} | |
1998 | ||
1999 | % like \smartslanted except unconditionally use \sl. We never want | |
2000 | % ttsl for book titles, do we? | |
2001 | \def\cite#1{{\sl #1}\futurelet\next\smartitalicx} | |
2c825956 GM |
2002 | |
2003 | \let\i=\smartitalic | |
0f9c1975 | 2004 | \let\slanted=\smartslanted |
2c825956 GM |
2005 | \let\var=\smartslanted |
2006 | \let\dfn=\smartslanted | |
2007 | \let\emph=\smartitalic | |
2c825956 | 2008 | |
0f9c1975 | 2009 | % @b, explicit bold. |
2c825956 GM |
2010 | \def\b#1{{\bf #1}} |
2011 | \let\strong=\b | |
2012 | ||
0f9c1975 KB |
2013 | % @sansserif, explicit sans. |
2014 | \def\sansserif#1{{\sf #1}} | |
2015 | ||
2c825956 GM |
2016 | % We can't just use \exhyphenpenalty, because that only has effect at |
2017 | % the end of a paragraph. Restore normal hyphenation at the end of the | |
2018 | % group within which \nohyphenation is presumably called. | |
2019 | % | |
2020 | \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} | |
2021 | \def\restorehyphenation{\hyphenchar\font = `- } | |
2022 | ||
0f9c1975 KB |
2023 | % Set sfcode to normal for the chars that usually have another value. |
2024 | % Can't use plain's \frenchspacing because it uses the `\x notation, and | |
2025 | % sometimes \x has an active definition that messes things up. | |
2026 | % | |
0f9c1975 KB |
2027 | \catcode`@=11 |
2028 | \def\plainfrenchspacing{% | |
2029 | \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m | |
2030 | \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m | |
2031 | \def\endofsentencespacefactor{1000}% for @. and friends | |
2032 | } | |
2033 | \def\plainnonfrenchspacing{% | |
2034 | \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000 | |
2035 | \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250 | |
2036 | \def\endofsentencespacefactor{3000}% for @. and friends | |
2037 | } | |
2038 | \catcode`@=\other | |
2039 | \def\endofsentencespacefactor{3000}% default | |
2040 | ||
2c825956 | 2041 | \def\t#1{% |
0f9c1975 | 2042 | {\tt \rawbackslash \plainfrenchspacing #1}% |
2c825956 GM |
2043 | \null |
2044 | } | |
2c825956 GM |
2045 | \def\samp#1{`\tclose{#1}'\null} |
2046 | \setfont\keyrm\rmshape{8}{1000} | |
2047 | \font\keysy=cmsy9 | |
2048 | \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% | |
2049 | \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% | |
2050 | \vbox{\hrule\kern-0.4pt | |
2051 | \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% | |
2052 | \kern-0.4pt\hrule}% | |
2053 | \kern-.06em\raise0.4pt\hbox{\angleright}}}} | |
74acc6cb | 2054 | \def\key #1{{\nohyphenation \uppercase{#1}}\null} |
2c825956 GM |
2055 | % The old definition, with no lozenge: |
2056 | %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} | |
2057 | \def\ctrl #1{{\tt \rawbackslash \hat}#1} | |
2058 | ||
2059 | % @file, @option are the same as @samp. | |
2060 | \let\file=\samp | |
2061 | \let\option=\samp | |
2062 | ||
2063 | % @code is a modification of @t, | |
2064 | % which makes spaces the same size as normal in the surrounding text. | |
2065 | \def\tclose#1{% | |
2066 | {% | |
2067 | % Change normal interword space to be same as for the current font. | |
2068 | \spaceskip = \fontdimen2\font | |
2069 | % | |
2070 | % Switch to typewriter. | |
2071 | \tt | |
2072 | % | |
2073 | % But `\ ' produces the large typewriter interword space. | |
2074 | \def\ {{\spaceskip = 0pt{} }}% | |
2075 | % | |
2076 | % Turn off hyphenation. | |
2077 | \nohyphenation | |
2078 | % | |
2079 | \rawbackslash | |
0f9c1975 | 2080 | \plainfrenchspacing |
2c825956 GM |
2081 | #1% |
2082 | }% | |
2083 | \null | |
2084 | } | |
2085 | ||
0f9c1975 | 2086 | % We *must* turn on hyphenation at `-' and `_' in @code. |
2c825956 GM |
2087 | % Otherwise, it is too hard to avoid overfull hboxes |
2088 | % in the Emacs manual, the Library manual, etc. | |
2089 | ||
2090 | % Unfortunately, TeX uses one parameter (\hyphenchar) to control | |
2091 | % both hyphenation at - and hyphenation within words. | |
2092 | % We must therefore turn them both off (\tclose does that) | |
2093 | % and arrange explicitly to hyphenate at a dash. | |
2094 | % -- rms. | |
2095 | { | |
74acc6cb KB |
2096 | \catcode`\-=\active \catcode`\_=\active |
2097 | \catcode`\'=\active \catcode`\`=\active | |
2c825956 GM |
2098 | % |
2099 | \global\def\code{\begingroup | |
74acc6cb KB |
2100 | \catcode\rquoteChar=\active \catcode\lquoteChar=\active |
2101 | \let'\codequoteright \let`\codequoteleft | |
2102 | % | |
2103 | \catcode\dashChar=\active \catcode\underChar=\active | |
0f9c1975 KB |
2104 | \ifallowcodebreaks |
2105 | \let-\codedash | |
2106 | \let_\codeunder | |
2107 | \else | |
2108 | \let-\realdash | |
2109 | \let_\realunder | |
2110 | \fi | |
2c825956 GM |
2111 | \codex |
2112 | } | |
2c825956 GM |
2113 | } |
2114 | ||
2115 | \def\realdash{-} | |
2116 | \def\codedash{-\discretionary{}{}{}} | |
08b16a02 PJ |
2117 | \def\codeunder{% |
2118 | % this is all so @math{@code{var_name}+1} can work. In math mode, _ | |
2119 | % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) | |
2120 | % will therefore expand the active definition of _, which is us | |
2121 | % (inside @code that is), therefore an endless loop. | |
2122 | \ifusingtt{\ifmmode | |
2123 | \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. | |
2124 | \else\normalunderscore \fi | |
2125 | \discretionary{}{}{}}% | |
2126 | {\_}% | |
2127 | } | |
2c825956 GM |
2128 | \def\codex #1{\tclose{#1}\endgroup} |
2129 | ||
0f9c1975 KB |
2130 | % An additional complication: the above will allow breaks after, e.g., |
2131 | % each of the four underscores in __typeof__. This is undesirable in | |
2132 | % some manuals, especially if they don't have long identifiers in | |
2133 | % general. @allowcodebreaks provides a way to control this. | |
2134 | % | |
2135 | \newif\ifallowcodebreaks \allowcodebreakstrue | |
2136 | ||
2137 | \def\keywordtrue{true} | |
2138 | \def\keywordfalse{false} | |
2139 | ||
2140 | \parseargdef\allowcodebreaks{% | |
2141 | \def\txiarg{#1}% | |
2142 | \ifx\txiarg\keywordtrue | |
2143 | \allowcodebreakstrue | |
2144 | \else\ifx\txiarg\keywordfalse | |
2145 | \allowcodebreaksfalse | |
2146 | \else | |
2147 | \errhelp = \EMsimple | |
2148 | \errmessage{Unknown @allowcodebreaks option `\txiarg'}% | |
2149 | \fi\fi | |
2150 | } | |
2151 | ||
2c825956 GM |
2152 | % @kbd is like @code, except that if the argument is just one @key command, |
2153 | % then @kbd has no effect. | |
2154 | ||
2155 | % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), | |
2156 | % `example' (@kbd uses ttsl only inside of @example and friends), | |
2157 | % or `code' (@kbd uses normal tty font always). | |
0f9c1975 KB |
2158 | \parseargdef\kbdinputstyle{% |
2159 | \def\txiarg{#1}% | |
2160 | \ifx\txiarg\worddistinct | |
2c825956 | 2161 | \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% |
0f9c1975 | 2162 | \else\ifx\txiarg\wordexample |
2c825956 | 2163 | \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% |
0f9c1975 | 2164 | \else\ifx\txiarg\wordcode |
2c825956 | 2165 | \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% |
0f9c1975 KB |
2166 | \else |
2167 | \errhelp = \EMsimple | |
2168 | \errmessage{Unknown @kbdinputstyle option `\txiarg'}% | |
2c825956 GM |
2169 | \fi\fi\fi |
2170 | } | |
2171 | \def\worddistinct{distinct} | |
2172 | \def\wordexample{example} | |
2173 | \def\wordcode{code} | |
2174 | ||
0f9c1975 KB |
2175 | % Default is `distinct.' |
2176 | \kbdinputstyle distinct | |
2c825956 GM |
2177 | |
2178 | \def\xkey{\key} | |
2179 | \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% | |
2180 | \ifx\one\xkey\ifx\threex\three \key{#2}% | |
2181 | \else{\tclose{\kbdfont\look}}\fi | |
2182 | \else{\tclose{\kbdfont\look}}\fi} | |
2183 | ||
0f9c1975 KB |
2184 | % For @indicateurl, @env, @command quotes seem unnecessary, so use \code. |
2185 | \let\indicateurl=\code | |
2c825956 GM |
2186 | \let\env=\code |
2187 | \let\command=\code | |
2188 | ||
2189 | % @uref (abbreviation for `urlref') takes an optional (comma-separated) | |
2190 | % second argument specifying the text to display and an optional third | |
2191 | % arg as text to display instead of (rather than in addition to) the url | |
2192 | % itself. First (mandatory) arg is the url. Perhaps eventually put in | |
2193 | % a hypertex \special here. | |
2194 | % | |
2195 | \def\uref#1{\douref #1,,,\finish} | |
2196 | \def\douref#1,#2,#3,#4\finish{\begingroup | |
2197 | \unsepspaces | |
2198 | \pdfurl{#1}% | |
2199 | \setbox0 = \hbox{\ignorespaces #3}% | |
2200 | \ifdim\wd0 > 0pt | |
2201 | \unhbox0 % third arg given, show only that | |
2202 | \else | |
2203 | \setbox0 = \hbox{\ignorespaces #2}% | |
2204 | \ifdim\wd0 > 0pt | |
2205 | \ifpdf | |
2206 | \unhbox0 % PDF: 2nd arg given, show only it | |
2207 | \else | |
2208 | \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url | |
2209 | \fi | |
2210 | \else | |
2211 | \code{#1}% only url given, so show it | |
2212 | \fi | |
2213 | \fi | |
2214 | \endlink | |
2215 | \endgroup} | |
2216 | ||
0f9c1975 KB |
2217 | % @url synonym for @uref, since that's how everyone uses it. |
2218 | % | |
2219 | \let\url=\uref | |
2220 | ||
2c825956 GM |
2221 | % rms does not like angle brackets --karl, 17may97. |
2222 | % So now @email is just like @uref, unless we are pdf. | |
177c0ea7 | 2223 | % |
2c825956 GM |
2224 | %\def\email#1{\angleleft{\tt #1}\angleright} |
2225 | \ifpdf | |
2226 | \def\email#1{\doemail#1,,\finish} | |
2227 | \def\doemail#1,#2,#3\finish{\begingroup | |
2228 | \unsepspaces | |
2229 | \pdfurl{mailto:#1}% | |
2230 | \setbox0 = \hbox{\ignorespaces #2}% | |
2231 | \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi | |
2232 | \endlink | |
2233 | \endgroup} | |
2234 | \else | |
2235 | \let\email=\uref | |
2236 | \fi | |
2237 | ||
2238 | % Check if we are currently using a typewriter font. Since all the | |
2239 | % Computer Modern typewriter fonts have zero interword stretch (and | |
2240 | % shrink), and it is reasonable to expect all typewriter fonts to have | |
2241 | % this property, we can check that font parameter. | |
2242 | % | |
2243 | \def\ifmonospace{\ifdim\fontdimen3\font=0pt } | |
2244 | ||
2245 | % Typeset a dimension, e.g., `in' or `pt'. The only reason for the | |
2246 | % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. | |
2247 | % | |
2248 | \def\dmn#1{\thinspace #1} | |
2249 | ||
2250 | \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} | |
2251 | ||
2252 | % @l was never documented to mean ``switch to the Lisp font'', | |
2253 | % and it is not used as such in any manual I can find. We need it for | |
2254 | % Polish suppressed-l. --karl, 22sep96. | |
2255 | %\def\l#1{{\li #1}\null} | |
2256 | ||
2257 | % Explicit font changes: @r, @sc, undocumented @ii. | |
2258 | \def\r#1{{\rm #1}} % roman font | |
2259 | \def\sc#1{{\smallcaps#1}} % smallcaps font | |
2260 | \def\ii#1{{\it #1}} % italic font | |
2261 | ||
0f9c1975 KB |
2262 | % @acronym for "FBI", "NATO", and the like. |
2263 | % We print this one point size smaller, since it's intended for | |
2264 | % all-uppercase. | |
2265 | % | |
2266 | \def\acronym#1{\doacronym #1,,\finish} | |
2267 | \def\doacronym#1,#2,#3\finish{% | |
2268 | {\selectfonts\lsize #1}% | |
2269 | \def\temp{#2}% | |
2270 | \ifx\temp\empty \else | |
2271 | \space ({\unsepspaces \ignorespaces \temp \unskip})% | |
2272 | \fi | |
2273 | } | |
2274 | ||
2275 | % @abbr for "Comput. J." and the like. | |
2276 | % No font change, but don't do end-of-sentence spacing. | |
2277 | % | |
2278 | \def\abbr#1{\doabbr #1,,\finish} | |
2279 | \def\doabbr#1,#2,#3\finish{% | |
2280 | {\plainfrenchspacing #1}% | |
2281 | \def\temp{#2}% | |
2282 | \ifx\temp\empty \else | |
2283 | \space ({\unsepspaces \ignorespaces \temp \unskip})% | |
2284 | \fi | |
2285 | } | |
2c825956 | 2286 | |
0f9c1975 KB |
2287 | % @pounds{} is a sterling sign, which Knuth put in the CM italic font. |
2288 | % | |
2c825956 GM |
2289 | \def\pounds{{\it\$}} |
2290 | ||
0f9c1975 KB |
2291 | % @euro{} comes from a separate font, depending on the current style. |
2292 | % We use the free feym* fonts from the eurosym package by Henrik | |
2293 | % Theiling, which support regular, slanted, bold and bold slanted (and | |
2294 | % "outlined" (blackboard board, sort of) versions, which we don't need). | |
2295 | % It is available from http://www.ctan.org/tex-archive/fonts/eurosym. | |
2296 | % | |
2297 | % Although only regular is the truly official Euro symbol, we ignore | |
2298 | % that. The Euro is designed to be slightly taller than the regular | |
2299 | % font height. | |
2300 | % | |
2301 | % feymr - regular | |
2302 | % feymo - slanted | |
2303 | % feybr - bold | |
2304 | % feybo - bold slanted | |
2305 | % | |
2306 | % There is no good (free) typewriter version, to my knowledge. | |
2307 | % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide. | |
2308 | % Hmm. | |
2309 | % | |
2310 | % Also doesn't work in math. Do we need to do math with euro symbols? | |
2311 | % Hope not. | |
2312 | % | |
2313 | % | |
2314 | \def\euro{{\eurofont e}} | |
2315 | \def\eurofont{% | |
2316 | % We set the font at each command, rather than predefining it in | |
2317 | % \textfonts and the other font-switching commands, so that | |
2318 | % installations which never need the symbol don't have to have the | |
2319 | % font installed. | |
2320 | % | |
2321 | % There is only one designed size (nominal 10pt), so we always scale | |
2322 | % that to the current nominal size. | |
2323 | % | |
2324 | % By the way, simply using "at 1em" works for cmr10 and the like, but | |
2325 | % does not work for cmbx10 and other extended/shrunken fonts. | |
2326 | % | |
2327 | \def\eurosize{\csname\curfontsize nominalsize\endcsname}% | |
2328 | % | |
2329 | \ifx\curfontstyle\bfstylename | |
2330 | % bold: | |
2331 | \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize | |
2332 | \else | |
2333 | % regular: | |
2334 | \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize | |
2335 | \fi | |
2336 | \thiseurofont | |
2337 | } | |
2338 | ||
2339 | % @registeredsymbol - R in a circle. The font for the R should really | |
2340 | % be smaller yet, but lllsize is the best we can do for now. | |
2341 | % Adapted from the plain.tex definition of \copyright. | |
2342 | % | |
2343 | \def\registeredsymbol{% | |
2344 | $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% | |
2345 | \hfil\crcr\Orb}}% | |
2346 | }$% | |
2347 | } | |
2348 | ||
3abebd3b KB |
2349 | % @textdegree - the normal degrees sign. |
2350 | % | |
2351 | \def\textdegree{$^\circ$} | |
2352 | ||
0f9c1975 KB |
2353 | % Laurent Siebenmann reports \Orb undefined with: |
2354 | % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38 | |
2355 | % so we'll define it if necessary. | |
2356 | % | |
2357 | \ifx\Orb\undefined | |
2358 | \def\Orb{\mathhexbox20D} | |
2359 | \fi | |
2360 | ||
2c825956 GM |
2361 | |
2362 | \message{page headings,} | |
2363 | ||
2364 | \newskip\titlepagetopglue \titlepagetopglue = 1.5in | |
2365 | \newskip\titlepagebottomglue \titlepagebottomglue = 2pc | |
2366 | ||
2367 | % First the title page. Must do @settitle before @titlepage. | |
2368 | \newif\ifseenauthor | |
2369 | \newif\iffinishedtitlepage | |
2370 | ||
2371 | % Do an implicit @contents or @shortcontents after @end titlepage if the | |
2372 | % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. | |
2373 | % | |
2374 | \newif\ifsetcontentsaftertitlepage | |
2375 | \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue | |
2376 | \newif\ifsetshortcontentsaftertitlepage | |
2377 | \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue | |
2378 | ||
0f9c1975 | 2379 | \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% |
2c825956 GM |
2380 | \endgroup\page\hbox{}\page} |
2381 | ||
0f9c1975 KB |
2382 | \envdef\titlepage{% |
2383 | % Open one extra group, as we want to close it in the middle of \Etitlepage. | |
2384 | \begingroup | |
2385 | \parindent=0pt \textfonts | |
2386 | % Leave some space at the very top of the page. | |
2387 | \vglue\titlepagetopglue | |
2388 | % No rule at page bottom unless we print one at the top with @title. | |
2389 | \finishedtitlepagetrue | |
2390 | % | |
2391 | % Most title ``pages'' are actually two pages long, with space | |
2392 | % at the top of the second. We don't want the ragged left on the second. | |
2393 | \let\oldpage = \page | |
2394 | \def\page{% | |
2c825956 | 2395 | \iffinishedtitlepage\else |
0f9c1975 | 2396 | \finishtitlepage |
2c825956 | 2397 | \fi |
2c825956 | 2398 | \let\page = \oldpage |
0f9c1975 KB |
2399 | \page |
2400 | \null | |
2401 | }% | |
2c825956 GM |
2402 | } |
2403 | ||
2404 | \def\Etitlepage{% | |
0f9c1975 KB |
2405 | \iffinishedtitlepage\else |
2406 | \finishtitlepage | |
2407 | \fi | |
2408 | % It is important to do the page break before ending the group, | |
2409 | % because the headline and footline are only empty inside the group. | |
2410 | % If we use the new definition of \page, we always get a blank page | |
2411 | % after the title page, which we certainly don't want. | |
2412 | \oldpage | |
2413 | \endgroup | |
2414 | % | |
2415 | % Need this before the \...aftertitlepage checks so that if they are | |
2416 | % in effect the toc pages will come out with page numbers. | |
2417 | \HEADINGSon | |
2418 | % | |
2419 | % If they want short, they certainly want long too. | |
2420 | \ifsetshortcontentsaftertitlepage | |
2421 | \shortcontents | |
2422 | \contents | |
2423 | \global\let\shortcontents = \relax | |
2424 | \global\let\contents = \relax | |
2425 | \fi | |
2426 | % | |
2427 | \ifsetcontentsaftertitlepage | |
2428 | \contents | |
2429 | \global\let\contents = \relax | |
2430 | \global\let\shortcontents = \relax | |
2431 | \fi | |
2c825956 GM |
2432 | } |
2433 | ||
2434 | \def\finishtitlepage{% | |
0f9c1975 KB |
2435 | \vskip4pt \hrule height 2pt width \hsize |
2436 | \vskip\titlepagebottomglue | |
2437 | \finishedtitlepagetrue | |
2438 | } | |
2439 | ||
2440 | %%% Macros to be used within @titlepage: | |
2441 | ||
2442 | \let\subtitlerm=\tenrm | |
2443 | \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} | |
2444 | ||
2445 | \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines | |
2446 | \let\tt=\authortt} | |
2447 | ||
2448 | \parseargdef\title{% | |
2449 | \checkenv\titlepage | |
2450 | \leftline{\titlefonts\rm #1} | |
2451 | % print a rule at the page bottom also. | |
2452 | \finishedtitlepagefalse | |
2453 | \vskip4pt \hrule height 4pt width \hsize \vskip4pt | |
2c825956 GM |
2454 | } |
2455 | ||
0f9c1975 KB |
2456 | \parseargdef\subtitle{% |
2457 | \checkenv\titlepage | |
2458 | {\subtitlefont \rightline{#1}}% | |
2459 | } | |
2460 | ||
2461 | % @author should come last, but may come many times. | |
2462 | % It can also be used inside @quotation. | |
2463 | % | |
2464 | \parseargdef\author{% | |
2465 | \def\temp{\quotation}% | |
2466 | \ifx\thisenv\temp | |
2467 | \def\quotationauthor{#1}% printed in \Equotation. | |
2468 | \else | |
2469 | \checkenv\titlepage | |
2470 | \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi | |
2471 | {\authorfont \leftline{#1}}% | |
2472 | \fi | |
2473 | } | |
2474 | ||
2475 | ||
2c825956 GM |
2476 | %%% Set up page headings and footings. |
2477 | ||
2478 | \let\thispage=\folio | |
2479 | ||
2480 | \newtoks\evenheadline % headline on even pages | |
2481 | \newtoks\oddheadline % headline on odd pages | |
2482 | \newtoks\evenfootline % footline on even pages | |
2483 | \newtoks\oddfootline % footline on odd pages | |
2484 | ||
0f9c1975 | 2485 | % Now make TeX use those variables |
2c825956 GM |
2486 | \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline |
2487 | \else \the\evenheadline \fi}} | |
2488 | \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline | |
2489 | \else \the\evenfootline \fi}\HEADINGShook} | |
2490 | \let\HEADINGShook=\relax | |
2491 | ||
2492 | % Commands to set those variables. | |
2493 | % For example, this is what @headings on does | |
2494 | % @evenheading @thistitle|@thispage|@thischapter | |
2495 | % @oddheading @thischapter|@thispage|@thistitle | |
2496 | % @evenfooting @thisfile|| | |
2497 | % @oddfooting ||@thisfile | |
2498 | ||
2c825956 | 2499 | |
0f9c1975 KB |
2500 | \def\evenheading{\parsearg\evenheadingxxx} |
2501 | \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} | |
2502 | \def\evenheadingyyy #1\|#2\|#3\|#4\finish{% | |
2c825956 GM |
2503 | \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
2504 | ||
0f9c1975 KB |
2505 | \def\oddheading{\parsearg\oddheadingxxx} |
2506 | \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} | |
2507 | \def\oddheadingyyy #1\|#2\|#3\|#4\finish{% | |
2c825956 GM |
2508 | \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
2509 | ||
0f9c1975 | 2510 | \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% |
2c825956 | 2511 | |
0f9c1975 KB |
2512 | \def\evenfooting{\parsearg\evenfootingxxx} |
2513 | \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} | |
2514 | \def\evenfootingyyy #1\|#2\|#3\|#4\finish{% | |
2c825956 GM |
2515 | \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} |
2516 | ||
0f9c1975 KB |
2517 | \def\oddfooting{\parsearg\oddfootingxxx} |
2518 | \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} | |
2519 | \def\oddfootingyyy #1\|#2\|#3\|#4\finish{% | |
2c825956 GM |
2520 | \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% |
2521 | % | |
2522 | % Leave some space for the footline. Hopefully ok to assume | |
2523 | % @evenfooting will not be used by itself. | |
08e5fcf1 KB |
2524 | \global\advance\pageheight by -12pt |
2525 | \global\advance\vsize by -12pt | |
2c825956 GM |
2526 | } |
2527 | ||
0f9c1975 KB |
2528 | \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} |
2529 | ||
2c825956 GM |
2530 | |
2531 | % @headings double turns headings on for double-sided printing. | |
2532 | % @headings single turns headings on for single-sided printing. | |
2533 | % @headings off turns them off. | |
2534 | % @headings on same as @headings double, retained for compatibility. | |
2535 | % @headings after turns on double-sided headings after this page. | |
2536 | % @headings doubleafter turns on double-sided headings after this page. | |
2537 | % @headings singleafter turns on single-sided headings after this page. | |
2538 | % By default, they are off at the start of a document, | |
2539 | % and turned `on' after @end titlepage. | |
2540 | ||
2541 | \def\headings #1 {\csname HEADINGS#1\endcsname} | |
2542 | ||
0f9c1975 | 2543 | \def\HEADINGSoff{% |
2c825956 GM |
2544 | \global\evenheadline={\hfil} \global\evenfootline={\hfil} |
2545 | \global\oddheadline={\hfil} \global\oddfootline={\hfil}} | |
2546 | \HEADINGSoff | |
2547 | % When we turn headings on, set the page number to 1. | |
2548 | % For double-sided printing, put current file name in lower left corner, | |
2549 | % chapter name on inside top of right hand pages, document | |
2550 | % title on inside top of left hand pages, and page numbers on outside top | |
2551 | % edge of all pages. | |
0f9c1975 | 2552 | \def\HEADINGSdouble{% |
2c825956 GM |
2553 | \global\pageno=1 |
2554 | \global\evenfootline={\hfil} | |
2555 | \global\oddfootline={\hfil} | |
2556 | \global\evenheadline={\line{\folio\hfil\thistitle}} | |
2557 | \global\oddheadline={\line{\thischapter\hfil\folio}} | |
2558 | \global\let\contentsalignmacro = \chapoddpage | |
2559 | } | |
2560 | \let\contentsalignmacro = \chappager | |
2561 | ||
2562 | % For single-sided printing, chapter title goes across top left of page, | |
2563 | % page number on top right. | |
0f9c1975 | 2564 | \def\HEADINGSsingle{% |
2c825956 GM |
2565 | \global\pageno=1 |
2566 | \global\evenfootline={\hfil} | |
2567 | \global\oddfootline={\hfil} | |
2568 | \global\evenheadline={\line{\thischapter\hfil\folio}} | |
2569 | \global\oddheadline={\line{\thischapter\hfil\folio}} | |
2570 | \global\let\contentsalignmacro = \chappager | |
2571 | } | |
2572 | \def\HEADINGSon{\HEADINGSdouble} | |
2573 | ||
2574 | \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} | |
2575 | \let\HEADINGSdoubleafter=\HEADINGSafter | |
2576 | \def\HEADINGSdoublex{% | |
2577 | \global\evenfootline={\hfil} | |
2578 | \global\oddfootline={\hfil} | |
2579 | \global\evenheadline={\line{\folio\hfil\thistitle}} | |
2580 | \global\oddheadline={\line{\thischapter\hfil\folio}} | |
2581 | \global\let\contentsalignmacro = \chapoddpage | |
2582 | } | |
2583 | ||
2584 | \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} | |
2585 | \def\HEADINGSsinglex{% | |
2586 | \global\evenfootline={\hfil} | |
2587 | \global\oddfootline={\hfil} | |
2588 | \global\evenheadline={\line{\thischapter\hfil\folio}} | |
2589 | \global\oddheadline={\line{\thischapter\hfil\folio}} | |
2590 | \global\let\contentsalignmacro = \chappager | |
2591 | } | |
2592 | ||
2593 | % Subroutines used in generating headings | |
2594 | % This produces Day Month Year style of output. | |
2595 | % Only define if not already defined, in case a txi-??.tex file has set | |
2596 | % up a different format (e.g., txi-cs.tex does this). | |
2597 | \ifx\today\undefined | |
2598 | \def\today{% | |
2599 | \number\day\space | |
2600 | \ifcase\month | |
2601 | \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr | |
2602 | \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug | |
2603 | \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec | |
2604 | \fi | |
2605 | \space\number\year} | |
2606 | \fi | |
2607 | ||
2608 | % @settitle line... specifies the title of the document, for headings. | |
2609 | % It generates no output of its own. | |
2610 | \def\thistitle{\putwordNoTitle} | |
0f9c1975 | 2611 | \def\settitle{\parsearg{\gdef\thistitle}} |
2c825956 GM |
2612 | |
2613 | ||
2614 | \message{tables,} | |
0f9c1975 | 2615 | % Tables -- @table, @ftable, @vtable, @item(x). |
2c825956 GM |
2616 | |
2617 | % default indentation of table text | |
2618 | \newdimen\tableindent \tableindent=.8in | |
2619 | % default indentation of @itemize and @enumerate text | |
2620 | \newdimen\itemindent \itemindent=.3in | |
2621 | % margin between end of table item and start of table text. | |
2622 | \newdimen\itemmargin \itemmargin=.1in | |
2623 | ||
2624 | % used internally for \itemindent minus \itemmargin | |
2625 | \newdimen\itemmax | |
2626 | ||
0f9c1975 | 2627 | % Note @table, @ftable, and @vtable define @item, @itemx, etc., with |
2c825956 GM |
2628 | % these defs. |
2629 | % They also define \itemindex | |
2630 | % to index the item name in whatever manner is desired (perhaps none). | |
2631 | ||
2632 | \newif\ifitemxneedsnegativevskip | |
2633 | ||
2634 | \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} | |
2635 | ||
2636 | \def\internalBitem{\smallbreak \parsearg\itemzzz} | |
2637 | \def\internalBitemx{\itemxpar \parsearg\itemzzz} | |
2638 | ||
2c825956 GM |
2639 | \def\itemzzz #1{\begingroup % |
2640 | \advance\hsize by -\rightskip | |
2641 | \advance\hsize by -\tableindent | |
0f9c1975 | 2642 | \setbox0=\hbox{\itemindicate{#1}}% |
2c825956 GM |
2643 | \itemindex{#1}% |
2644 | \nobreak % This prevents a break before @itemx. | |
2645 | % | |
2646 | % If the item text does not fit in the space we have, put it on a line | |
2647 | % by itself, and do not allow a page break either before or after that | |
2648 | % line. We do not start a paragraph here because then if the next | |
2649 | % command is, e.g., @kindex, the whatsit would get put into the | |
2650 | % horizontal list on a line by itself, resulting in extra blank space. | |
2651 | \ifdim \wd0>\itemmax | |
2652 | % | |
2653 | % Make this a paragraph so we get the \parskip glue and wrapping, | |
2654 | % but leave it ragged-right. | |
2655 | \begingroup | |
2656 | \advance\leftskip by-\tableindent | |
2657 | \advance\hsize by\tableindent | |
2658 | \advance\rightskip by0pt plus1fil | |
2659 | \leavevmode\unhbox0\par | |
2660 | \endgroup | |
2661 | % | |
2662 | % We're going to be starting a paragraph, but we don't want the | |
2663 | % \parskip glue -- logically it's part of the @item we just started. | |
2664 | \nobreak \vskip-\parskip | |
2665 | % | |
0f9c1975 KB |
2666 | % Stop a page break at the \parskip glue coming up. However, if |
2667 | % what follows is an environment such as @example, there will be no | |
2668 | % \parskip glue; then the negative vskip we just inserted would | |
2669 | % cause the example and the item to crash together. So we use this | |
2670 | % bizarre value of 10001 as a signal to \aboveenvbreak to insert | |
2671 | % \parskip glue after all. Section titles are handled this way also. | |
2672 | % | |
2673 | \penalty 10001 | |
2c825956 GM |
2674 | \endgroup |
2675 | \itemxneedsnegativevskipfalse | |
2676 | \else | |
2677 | % The item text fits into the space. Start a paragraph, so that the | |
2678 | % following text (if any) will end up on the same line. | |
2679 | \noindent | |
2680 | % Do this with kerns and \unhbox so that if there is a footnote in | |
2681 | % the item text, it can migrate to the main vertical list and | |
2682 | % eventually be printed. | |
2683 | \nobreak\kern-\tableindent | |
2684 | \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 | |
2685 | \unhbox0 | |
2686 | \nobreak\kern\dimen0 | |
2687 | \endgroup | |
2688 | \itemxneedsnegativevskiptrue | |
2689 | \fi | |
2690 | } | |
2691 | ||
0f9c1975 KB |
2692 | \def\item{\errmessage{@item while not in a list environment}} |
2693 | \def\itemx{\errmessage{@itemx while not in a list environment}} | |
2c825956 GM |
2694 | |
2695 | % @table, @ftable, @vtable. | |
0f9c1975 KB |
2696 | \envdef\table{% |
2697 | \let\itemindex\gobble | |
2698 | \tablecheck{table}% | |
2699 | } | |
2700 | \envdef\ftable{% | |
2701 | \def\itemindex ##1{\doind {fn}{\code{##1}}}% | |
2702 | \tablecheck{ftable}% | |
2703 | } | |
2704 | \envdef\vtable{% | |
2705 | \def\itemindex ##1{\doind {vr}{\code{##1}}}% | |
2706 | \tablecheck{vtable}% | |
2707 | } | |
2708 | \def\tablecheck#1{% | |
2709 | \ifnum \the\catcode`\^^M=\active | |
2710 | \endgroup | |
2711 | \errmessage{This command won't work in this context; perhaps the problem is | |
2712 | that we are \inenvironment\thisenv}% | |
2713 | \def\next{\doignore{#1}}% | |
2714 | \else | |
2715 | \let\next\tablex | |
2716 | \fi | |
2717 | \next | |
2c825956 | 2718 | } |
0f9c1975 KB |
2719 | \def\tablex#1{% |
2720 | \def\itemindicate{#1}% | |
2721 | \parsearg\tabley | |
2722 | } | |
2723 | \def\tabley#1{% | |
2724 | {% | |
2725 | \makevalueexpandable | |
2726 | \edef\temp{\noexpand\tablez #1\space\space\space}% | |
2727 | \expandafter | |
2728 | }\temp \endtablez | |
2729 | } | |
2730 | \def\tablez #1 #2 #3 #4\endtablez{% | |
2731 | \aboveenvbreak | |
2732 | \ifnum 0#1>0 \advance \leftskip by #1\mil \fi | |
2733 | \ifnum 0#2>0 \tableindent=#2\mil \fi | |
2734 | \ifnum 0#3>0 \advance \rightskip by #3\mil \fi | |
2735 | \itemmax=\tableindent | |
2736 | \advance \itemmax by -\itemmargin | |
2737 | \advance \leftskip by \tableindent | |
2738 | \exdentamount=\tableindent | |
2739 | \parindent = 0pt | |
2740 | \parskip = \smallskipamount | |
2741 | \ifdim \parskip=0pt \parskip=2pt \fi | |
2742 | \let\item = \internalBitem | |
2743 | \let\itemx = \internalBitemx | |
2744 | } | |
2745 | \def\Etable{\endgraf\afterenvbreak} | |
2746 | \let\Eftable\Etable | |
2747 | \let\Evtable\Etable | |
2748 | \let\Eitemize\Etable | |
2749 | \let\Eenumerate\Etable | |
2c825956 GM |
2750 | |
2751 | % This is the counter used by @enumerate, which is really @itemize | |
2752 | ||
2753 | \newcount \itemno | |
2754 | ||
0f9c1975 | 2755 | \envdef\itemize{\parsearg\doitemize} |
2c825956 | 2756 | |
0f9c1975 KB |
2757 | \def\doitemize#1{% |
2758 | \aboveenvbreak | |
2759 | \itemmax=\itemindent | |
2760 | \advance\itemmax by -\itemmargin | |
2761 | \advance\leftskip by \itemindent | |
2762 | \exdentamount=\itemindent | |
2763 | \parindent=0pt | |
2764 | \parskip=\smallskipamount | |
2765 | \ifdim\parskip=0pt \parskip=2pt \fi | |
2766 | \def\itemcontents{#1}% | |
2767 | % @itemize with no arg is equivalent to @itemize @bullet. | |
2768 | \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi | |
2769 | \let\item=\itemizeitem | |
2c825956 GM |
2770 | } |
2771 | ||
0f9c1975 KB |
2772 | % Definition of @item while inside @itemize and @enumerate. |
2773 | % | |
2774 | \def\itemizeitem{% | |
2775 | \advance\itemno by 1 % for enumerations | |
2776 | {\let\par=\endgraf \smallbreak}% reasonable place to break | |
2777 | {% | |
2778 | % If the document has an @itemize directly after a section title, a | |
2779 | % \nobreak will be last on the list, and \sectionheading will have | |
2780 | % done a \vskip-\parskip. In that case, we don't want to zero | |
2781 | % parskip, or the item text will crash with the heading. On the | |
2782 | % other hand, when there is normal text preceding the item (as there | |
2783 | % usually is), we do want to zero parskip, or there would be too much | |
2784 | % space. In that case, we won't have a \nobreak before. At least | |
2785 | % that's the theory. | |
2786 | \ifnum\lastpenalty<10000 \parskip=0in \fi | |
2787 | \noindent | |
2788 | \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% | |
2789 | \vadjust{\penalty 1200}}% not good to break after first line of item. | |
2790 | \flushcr | |
2791 | } | |
2c825956 GM |
2792 | |
2793 | % \splitoff TOKENS\endmark defines \first to be the first token in | |
2794 | % TOKENS, and \rest to be the remainder. | |
2795 | % | |
2796 | \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% | |
2797 | ||
2798 | % Allow an optional argument of an uppercase letter, lowercase letter, | |
2799 | % or number, to specify the first label in the enumerated list. No | |
2800 | % argument is the same as `1'. | |
2801 | % | |
0f9c1975 | 2802 | \envparseargdef\enumerate{\enumeratey #1 \endenumeratey} |
2c825956 | 2803 | \def\enumeratey #1 #2\endenumeratey{% |
2c825956 GM |
2804 | % If we were given no argument, pretend we were given `1'. |
2805 | \def\thearg{#1}% | |
2806 | \ifx\thearg\empty \def\thearg{1}\fi | |
2807 | % | |
2808 | % Detect if the argument is a single token. If so, it might be a | |
2809 | % letter. Otherwise, the only valid thing it can be is a number. | |
2810 | % (We will always have one token, because of the test we just made. | |
2811 | % This is a good thing, since \splitoff doesn't work given nothing at | |
2812 | % all -- the first parameter is undelimited.) | |
2813 | \expandafter\splitoff\thearg\endmark | |
2814 | \ifx\rest\empty | |
2815 | % Only one token in the argument. It could still be anything. | |
2816 | % A ``lowercase letter'' is one whose \lccode is nonzero. | |
2817 | % An ``uppercase letter'' is one whose \lccode is both nonzero, and | |
2818 | % not equal to itself. | |
2819 | % Otherwise, we assume it's a number. | |
2820 | % | |
2821 | % We need the \relax at the end of the \ifnum lines to stop TeX from | |
2822 | % continuing to look for a <number>. | |
2823 | % | |
2824 | \ifnum\lccode\expandafter`\thearg=0\relax | |
2825 | \numericenumerate % a number (we hope) | |
2826 | \else | |
2827 | % It's a letter. | |
2828 | \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax | |
2829 | \lowercaseenumerate % lowercase letter | |
2830 | \else | |
2831 | \uppercaseenumerate % uppercase letter | |
2832 | \fi | |
2833 | \fi | |
2834 | \else | |
2835 | % Multiple tokens in the argument. We hope it's a number. | |
2836 | \numericenumerate | |
2837 | \fi | |
2838 | } | |
2839 | ||
2840 | % An @enumerate whose labels are integers. The starting integer is | |
2841 | % given in \thearg. | |
2842 | % | |
2843 | \def\numericenumerate{% | |
2844 | \itemno = \thearg | |
2845 | \startenumeration{\the\itemno}% | |
2846 | } | |
2847 | ||
2848 | % The starting (lowercase) letter is in \thearg. | |
2849 | \def\lowercaseenumerate{% | |
2850 | \itemno = \expandafter`\thearg | |
2851 | \startenumeration{% | |
2852 | % Be sure we're not beyond the end of the alphabet. | |
2853 | \ifnum\itemno=0 | |
2854 | \errmessage{No more lowercase letters in @enumerate; get a bigger | |
2855 | alphabet}% | |
2856 | \fi | |
2857 | \char\lccode\itemno | |
2858 | }% | |
2859 | } | |
2860 | ||
2861 | % The starting (uppercase) letter is in \thearg. | |
2862 | \def\uppercaseenumerate{% | |
2863 | \itemno = \expandafter`\thearg | |
2864 | \startenumeration{% | |
2865 | % Be sure we're not beyond the end of the alphabet. | |
2866 | \ifnum\itemno=0 | |
2867 | \errmessage{No more uppercase letters in @enumerate; get a bigger | |
2868 | alphabet} | |
2869 | \fi | |
2870 | \char\uccode\itemno | |
2871 | }% | |
2872 | } | |
2873 | ||
0f9c1975 | 2874 | % Call \doitemize, adding a period to the first argument and supplying the |
2c825956 GM |
2875 | % common last two arguments. Also subtract one from the initial value in |
2876 | % \itemno, since @item increments \itemno. | |
2877 | % | |
2878 | \def\startenumeration#1{% | |
2879 | \advance\itemno by -1 | |
0f9c1975 | 2880 | \doitemize{#1.}\flushcr |
2c825956 GM |
2881 | } |
2882 | ||
2883 | % @alphaenumerate and @capsenumerate are abbreviations for giving an arg | |
2884 | % to @enumerate. | |
2885 | % | |
2886 | \def\alphaenumerate{\enumerate{a}} | |
2887 | \def\capsenumerate{\enumerate{A}} | |
2888 | \def\Ealphaenumerate{\Eenumerate} | |
2889 | \def\Ecapsenumerate{\Eenumerate} | |
2890 | ||
2c825956 GM |
2891 | |
2892 | % @multitable macros | |
2893 | % Amy Hendrickson, 8/18/94, 3/6/96 | |
2894 | % | |
2895 | % @multitable ... @end multitable will make as many columns as desired. | |
2896 | % Contents of each column will wrap at width given in preamble. Width | |
2897 | % can be specified either with sample text given in a template line, | |
2898 | % or in percent of \hsize, the current width of text on page. | |
2899 | ||
2900 | % Table can continue over pages but will only break between lines. | |
2901 | ||
2902 | % To make preamble: | |
2903 | % | |
2904 | % Either define widths of columns in terms of percent of \hsize: | |
2905 | % @multitable @columnfractions .25 .3 .45 | |
2906 | % @item ... | |
2907 | % | |
2908 | % Numbers following @columnfractions are the percent of the total | |
2909 | % current hsize to be used for each column. You may use as many | |
2910 | % columns as desired. | |
2911 | ||
2912 | ||
2913 | % Or use a template: | |
2914 | % @multitable {Column 1 template} {Column 2 template} {Column 3 template} | |
2915 | % @item ... | |
2916 | % using the widest term desired in each column. | |
2c825956 GM |
2917 | |
2918 | % Each new table line starts with @item, each subsequent new column | |
2919 | % starts with @tab. Empty columns may be produced by supplying @tab's | |
2920 | % with nothing between them for as many times as empty columns are needed, | |
2921 | % ie, @tab@tab@tab will produce two empty columns. | |
2922 | ||
0f9c1975 KB |
2923 | % @item, @tab do not need to be on their own lines, but it will not hurt |
2924 | % if they are. | |
2c825956 GM |
2925 | |
2926 | % Sample multitable: | |
2927 | ||
2928 | % @multitable {Column 1 template} {Column 2 template} {Column 3 template} | |
2929 | % @item first col stuff @tab second col stuff @tab third col | |
2930 | % @item | |
2931 | % first col stuff | |
2932 | % @tab | |
2933 | % second col stuff | |
2934 | % @tab | |
2935 | % third col | |
2936 | % @item first col stuff @tab second col stuff | |
2937 | % @tab Many paragraphs of text may be used in any column. | |
2938 | % | |
2939 | % They will wrap at the width determined by the template. | |
2940 | % @item@tab@tab This will be in third column. | |
2941 | % @end multitable | |
2942 | ||
2943 | % Default dimensions may be reset by user. | |
2944 | % @multitableparskip is vertical space between paragraphs in table. | |
2945 | % @multitableparindent is paragraph indent in table. | |
2946 | % @multitablecolmargin is horizontal space to be left between columns. | |
2947 | % @multitablelinespace is space to leave between table items, baseline | |
2948 | % to baseline. | |
2949 | % 0pt means it depends on current normal line spacing. | |
2950 | % | |
2951 | \newskip\multitableparskip | |
2952 | \newskip\multitableparindent | |
2953 | \newdimen\multitablecolspace | |
2954 | \newskip\multitablelinespace | |
2955 | \multitableparskip=0pt | |
2956 | \multitableparindent=6pt | |
2957 | \multitablecolspace=12pt | |
2958 | \multitablelinespace=0pt | |
2959 | ||
2960 | % Macros used to set up halign preamble: | |
2961 | % | |
2962 | \let\endsetuptable\relax | |
2963 | \def\xendsetuptable{\endsetuptable} | |
2964 | \let\columnfractions\relax | |
2965 | \def\xcolumnfractions{\columnfractions} | |
2966 | \newif\ifsetpercent | |
2967 | ||
0f9c1975 KB |
2968 | % #1 is the @columnfraction, usually a decimal number like .5, but might |
2969 | % be just 1. We just use it, whatever it is. | |
2970 | % | |
2971 | \def\pickupwholefraction#1 {% | |
2c825956 | 2972 | \global\advance\colcount by 1 |
0f9c1975 | 2973 | \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% |
2c825956 GM |
2974 | \setuptable |
2975 | } | |
2976 | ||
2977 | \newcount\colcount | |
2978 | \def\setuptable#1{% | |
2979 | \def\firstarg{#1}% | |
2980 | \ifx\firstarg\xendsetuptable | |
2981 | \let\go = \relax | |
2982 | \else | |
2983 | \ifx\firstarg\xcolumnfractions | |
2984 | \global\setpercenttrue | |
2985 | \else | |
2986 | \ifsetpercent | |
2987 | \let\go\pickupwholefraction | |
2988 | \else | |
2989 | \global\advance\colcount by 1 | |
0f9c1975 KB |
2990 | \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a |
2991 | % separator; typically that is always in the input, anyway. | |
2c825956 GM |
2992 | \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% |
2993 | \fi | |
2994 | \fi | |
2995 | \ifx\go\pickupwholefraction | |
2996 | % Put the argument back for the \pickupwholefraction call, so | |
2997 | % we'll always have a period there to be parsed. | |
2998 | \def\go{\pickupwholefraction#1}% | |
2999 | \else | |
3000 | \let\go = \setuptable | |
3001 | \fi% | |
3002 | \fi | |
3003 | \go | |
3004 | } | |
3005 | ||
0f9c1975 KB |
3006 | % multitable-only commands. |
3007 | % | |
3008 | % @headitem starts a heading row, which we typeset in bold. | |
3009 | % Assignments have to be global since we are inside the implicit group | |
3010 | % of an alignment entry. Note that \everycr resets \everytab. | |
3011 | \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}% | |
3012 | % | |
3013 | % A \tab used to include \hskip1sp. But then the space in a template | |
3014 | % line is not enough. That is bad. So let's go back to just `&' until | |
3015 | % we encounter the problem it was intended to solve again. | |
3016 | % --karl, nathan@acm.org, 20apr99. | |
3017 | \def\tab{\checkenv\multitable &\the\everytab}% | |
2c825956 GM |
3018 | |
3019 | % @multitable ... @end multitable definitions: | |
3020 | % | |
0f9c1975 KB |
3021 | \newtoks\everytab % insert after every tab. |
3022 | % | |
3023 | \envdef\multitable{% | |
2c825956 | 3024 | \vskip\parskip |
0f9c1975 KB |
3025 | \startsavinginserts |
3026 | % | |
3027 | % @item within a multitable starts a normal row. | |
3028 | % We use \def instead of \let so that if one of the multitable entries | |
3029 | % contains an @itemize, we don't choke on the \item (seen as \crcr aka | |
3030 | % \endtemplate) expanding \doitemize. | |
3031 | \def\item{\crcr}% | |
3032 | % | |
2c825956 GM |
3033 | \tolerance=9500 |
3034 | \hbadness=9500 | |
3035 | \setmultitablespacing | |
3036 | \parskip=\multitableparskip | |
3037 | \parindent=\multitableparindent | |
3038 | \overfullrule=0pt | |
3039 | \global\colcount=0 | |
2c825956 | 3040 | % |
0f9c1975 KB |
3041 | \everycr = {% |
3042 | \noalign{% | |
3043 | \global\everytab={}% | |
3044 | \global\colcount=0 % Reset the column counter. | |
3045 | % Check for saved footnotes, etc. | |
3046 | \checkinserts | |
3047 | % Keeps underfull box messages off when table breaks over pages. | |
3048 | %\filbreak | |
3049 | % Maybe so, but it also creates really weird page breaks when the | |
3050 | % table breaks over pages. Wouldn't \vfil be better? Wait until the | |
3051 | % problem manifests itself, so it can be fixed for real --karl. | |
3052 | }% | |
3053 | }% | |
3054 | % | |
3055 | \parsearg\domultitable | |
3056 | } | |
3057 | \def\domultitable#1{% | |
2c825956 GM |
3058 | % To parse everything between @multitable and @item: |
3059 | \setuptable#1 \endsetuptable | |
3060 | % | |
2c825956 GM |
3061 | % This preamble sets up a generic column definition, which will |
3062 | % be used as many times as user calls for columns. | |
3063 | % \vtop will set a single line and will also let text wrap and | |
3064 | % continue for many paragraphs if desired. | |
0f9c1975 KB |
3065 | \halign\bgroup &% |
3066 | \global\advance\colcount by 1 | |
3067 | \multistrut | |
3068 | \vtop{% | |
3069 | % Use the current \colcount to find the correct column width: | |
3070 | \hsize=\expandafter\csname col\the\colcount\endcsname | |
3071 | % | |
3072 | % In order to keep entries from bumping into each other | |
3073 | % we will add a \leftskip of \multitablecolspace to all columns after | |
3074 | % the first one. | |
3075 | % | |
3076 | % If a template has been used, we will add \multitablecolspace | |
3077 | % to the width of each template entry. | |
3078 | % | |
3079 | % If the user has set preamble in terms of percent of \hsize we will | |
3080 | % use that dimension as the width of the column, and the \leftskip | |
3081 | % will keep entries from bumping into each other. Table will start at | |
3082 | % left margin and final column will justify at right margin. | |
3083 | % | |
3084 | % Make sure we don't inherit \rightskip from the outer environment. | |
3085 | \rightskip=0pt | |
3086 | \ifnum\colcount=1 | |
3087 | % The first column will be indented with the surrounding text. | |
3088 | \advance\hsize by\leftskip | |
3089 | \else | |
3090 | \ifsetpercent \else | |
3091 | % If user has not set preamble in terms of percent of \hsize | |
3092 | % we will advance \hsize by \multitablecolspace. | |
3093 | \advance\hsize by \multitablecolspace | |
3094 | \fi | |
3095 | % In either case we will make \leftskip=\multitablecolspace: | |
3096 | \leftskip=\multitablecolspace | |
3097 | \fi | |
3098 | % Ignoring space at the beginning and end avoids an occasional spurious | |
3099 | % blank line, when TeX decides to break the line at the space before the | |
3100 | % box from the multistrut, so the strut ends up on a line by itself. | |
3101 | % For example: | |
3102 | % @multitable @columnfractions .11 .89 | |
3103 | % @item @code{#} | |
3104 | % @tab Legal holiday which is valid in major parts of the whole country. | |
3105 | % Is automatically provided with highlighting sequences respectively | |
3106 | % marking characters. | |
3107 | \noindent\ignorespaces##\unskip\multistrut | |
3108 | }\cr | |
3109 | } | |
3110 | \def\Emultitable{% | |
3111 | \crcr | |
3112 | \egroup % end the \halign | |
3113 | \global\setpercentfalse | |
3114 | } | |
3115 | ||
3116 | \def\setmultitablespacing{% | |
3117 | \def\multistrut{\strut}% just use the standard line spacing | |
3118 | % | |
3119 | % Compute \multitablelinespace (if not defined by user) for use in | |
3120 | % \multitableparskip calculation. We used define \multistrut based on | |
3121 | % this, but (ironically) that caused the spacing to be off. | |
3122 | % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100. | |
2c825956 GM |
3123 | \ifdim\multitablelinespace=0pt |
3124 | \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip | |
3125 | \global\advance\multitablelinespace by-\ht0 | |
0f9c1975 | 3126 | \fi |
2c825956 GM |
3127 | %% Test to see if parskip is larger than space between lines of |
3128 | %% table. If not, do nothing. | |
3129 | %% If so, set to same dimension as multitablelinespace. | |
3130 | \ifdim\multitableparskip>\multitablelinespace | |
3131 | \global\multitableparskip=\multitablelinespace | |
3132 | \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller | |
3133 | %% than skip between lines in the table. | |
3134 | \fi% | |
3135 | \ifdim\multitableparskip=0pt | |
3136 | \global\multitableparskip=\multitablelinespace | |
3137 | \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller | |
3138 | %% than skip between lines in the table. | |
3139 | \fi} | |
3140 | ||
3141 | ||
3142 | \message{conditionals,} | |
0f9c1975 KB |
3143 | |
3144 | % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, | |
3145 | % @ifnotxml always succeed. They currently do nothing; we don't | |
3146 | % attempt to check whether the conditionals are properly nested. But we | |
3147 | % have to remember that they are conditionals, so that @end doesn't | |
3148 | % attempt to close an environment group. | |
2c825956 | 3149 | % |
0f9c1975 KB |
3150 | \def\makecond#1{% |
3151 | \expandafter\let\csname #1\endcsname = \relax | |
3152 | \expandafter\let\csname iscond.#1\endcsname = 1 | |
3153 | } | |
3154 | \makecond{iftex} | |
3155 | \makecond{ifnotdocbook} | |
3156 | \makecond{ifnothtml} | |
3157 | \makecond{ifnotinfo} | |
3158 | \makecond{ifnotplaintext} | |
3159 | \makecond{ifnotxml} | |
3160 | ||
3161 | % Ignore @ignore, @ifhtml, @ifinfo, and the like. | |
3162 | % | |
3163 | \def\direntry{\doignore{direntry}} | |
3164 | \def\documentdescription{\doignore{documentdescription}} | |
3165 | \def\docbook{\doignore{docbook}} | |
3166 | \def\html{\doignore{html}} | |
3167 | \def\ifdocbook{\doignore{ifdocbook}} | |
2c825956 | 3168 | \def\ifhtml{\doignore{ifhtml}} |
08b16a02 | 3169 | \def\ifinfo{\doignore{ifinfo}} |
2c825956 | 3170 | \def\ifnottex{\doignore{ifnottex}} |
0f9c1975 KB |
3171 | \def\ifplaintext{\doignore{ifplaintext}} |
3172 | \def\ifxml{\doignore{ifxml}} | |
3173 | \def\ignore{\doignore{ignore}} | |
2c825956 | 3174 | \def\menu{\doignore{menu}} |
0f9c1975 | 3175 | \def\xml{\doignore{xml}} |
2c825956 | 3176 | |
0f9c1975 | 3177 | % Ignore text until a line `@end #1', keeping track of nested conditionals. |
2c825956 | 3178 | % |
0f9c1975 KB |
3179 | % A count to remember the depth of nesting. |
3180 | \newcount\doignorecount | |
3181 | ||
2c825956 | 3182 | \def\doignore#1{\begingroup |
0f9c1975 KB |
3183 | % Scan in ``verbatim'' mode: |
3184 | \obeylines | |
3185 | \catcode`\@ = \other | |
3186 | \catcode`\{ = \other | |
3187 | \catcode`\} = \other | |
2c825956 GM |
3188 | % |
3189 | % Make sure that spaces turn into tokens that match what \doignoretext wants. | |
0f9c1975 | 3190 | \spaceisspace |
2c825956 | 3191 | % |
0f9c1975 KB |
3192 | % Count number of #1's that we've seen. |
3193 | \doignorecount = 0 | |
2c825956 | 3194 | % |
0f9c1975 KB |
3195 | % Swallow text until we reach the matching `@end #1'. |
3196 | \dodoignore{#1}% | |
2c825956 GM |
3197 | } |
3198 | ||
0f9c1975 KB |
3199 | { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. |
3200 | \obeylines % | |
2c825956 | 3201 | % |
0f9c1975 KB |
3202 | \gdef\dodoignore#1{% |
3203 | % #1 contains the command name as a string, e.g., `ifinfo'. | |
2c825956 | 3204 | % |
0f9c1975 KB |
3205 | % Define a command to find the next `@end #1'. |
3206 | \long\def\doignoretext##1^^M@end #1{% | |
3207 | \doignoretextyyy##1^^M@#1\_STOP_}% | |
2c825956 | 3208 | % |
0f9c1975 KB |
3209 | % And this command to find another #1 command, at the beginning of a |
3210 | % line. (Otherwise, we would consider a line `@c @ifset', for | |
3211 | % example, to count as an @ifset for nesting.) | |
3212 | \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% | |
2c825956 | 3213 | % |
0f9c1975 KB |
3214 | % And now expand that command. |
3215 | \doignoretext ^^M% | |
3216 | }% | |
3217 | } | |
3218 | ||
3219 | \def\doignoreyyy#1{% | |
3220 | \def\temp{#1}% | |
3221 | \ifx\temp\empty % Nothing found. | |
3222 | \let\next\doignoretextzzz | |
3223 | \else % Found a nested condition, ... | |
3224 | \advance\doignorecount by 1 | |
3225 | \let\next\doignoretextyyy % ..., look for another. | |
3226 | % If we're here, #1 ends with ^^M\ifinfo (for example). | |
3227 | \fi | |
3228 | \next #1% the token \_STOP_ is present just after this macro. | |
3229 | } | |
3230 | ||
3231 | % We have to swallow the remaining "\_STOP_". | |
3232 | % | |
3233 | \def\doignoretextzzz#1{% | |
3234 | \ifnum\doignorecount = 0 % We have just found the outermost @end. | |
3235 | \let\next\enddoignore | |
3236 | \else % Still inside a nested condition. | |
3237 | \advance\doignorecount by -1 | |
3238 | \let\next\doignoretext % Look for the next @end. | |
3239 | \fi | |
3240 | \next | |
3241 | } | |
3242 | ||
3243 | % Finish off ignored text. | |
3244 | { \obeylines% | |
3245 | % Ignore anything after the last `@end #1'; this matters in verbatim | |
3246 | % environments, where otherwise the newline after an ignored conditional | |
3247 | % would result in a blank line in the output. | |
3248 | \gdef\enddoignore#1^^M{\endgroup\ignorespaces}% | |
2c825956 GM |
3249 | } |
3250 | ||
0f9c1975 | 3251 | |
2c825956 GM |
3252 | % @set VAR sets the variable VAR to an empty value. |
3253 | % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. | |
3254 | % | |
3255 | % Since we want to separate VAR from REST-OF-LINE (which might be | |
3256 | % empty), we can't just use \parsearg; we have to insert a space of our | |
3257 | % own to delimit the rest of the line, and then take it out again if we | |
0f9c1975 KB |
3258 | % didn't need it. |
3259 | % We rely on the fact that \parsearg sets \catcode`\ =10. | |
2c825956 | 3260 | % |
0f9c1975 | 3261 | \parseargdef\set{\setyyy#1 \endsetyyy} |
2c825956 | 3262 | \def\setyyy#1 #2\endsetyyy{% |
0f9c1975 KB |
3263 | {% |
3264 | \makevalueexpandable | |
3265 | \def\temp{#2}% | |
3266 | \edef\next{\gdef\makecsname{SET#1}}% | |
3267 | \ifx\temp\empty | |
3268 | \next{}% | |
3269 | \else | |
3270 | \setzzz#2\endsetzzz | |
3271 | \fi | |
3272 | }% | |
2c825956 | 3273 | } |
0f9c1975 KB |
3274 | % Remove the trailing space \setxxx inserted. |
3275 | \def\setzzz#1 \endsetzzz{\next{#1}} | |
2c825956 GM |
3276 | |
3277 | % @clear VAR clears (i.e., unsets) the variable VAR. | |
3278 | % | |
0f9c1975 KB |
3279 | \parseargdef\clear{% |
3280 | {% | |
3281 | \makevalueexpandable | |
3282 | \global\expandafter\let\csname SET#1\endcsname=\relax | |
3283 | }% | |
3284 | } | |
2c825956 GM |
3285 | |
3286 | % @value{foo} gets the text saved in variable foo. | |
0f9c1975 KB |
3287 | \def\value{\begingroup\makevalueexpandable\valuexxx} |
3288 | \def\valuexxx#1{\expandablevalue{#1}\endgroup} | |
2c825956 | 3289 | { |
0f9c1975 | 3290 | \catcode`\- = \active \catcode`\_ = \active |
2c825956 | 3291 | % |
0f9c1975 KB |
3292 | \gdef\makevalueexpandable{% |
3293 | \let\value = \expandablevalue | |
3294 | % We don't want these characters active, ... | |
3295 | \catcode`\-=\other \catcode`\_=\other | |
3296 | % ..., but we might end up with active ones in the argument if | |
3297 | % we're called from @code, as @code{@value{foo-bar_}}, though. | |
3298 | % So \let them to their normal equivalents. | |
3299 | \let-\realdash \let_\normalunderscore | |
3300 | } | |
2c825956 | 3301 | } |
2c825956 GM |
3302 | |
3303 | % We have this subroutine so that we can handle at least some @value's | |
0f9c1975 KB |
3304 | % properly in indexes (we call \makevalueexpandable in \indexdummies). |
3305 | % The command has to be fully expandable (if the variable is set), since | |
3306 | % the result winds up in the index file. This means that if the | |
3307 | % variable's value contains other Texinfo commands, it's almost certain | |
3308 | % it will fail (although perhaps we could fix that with sufficient work | |
3309 | % to do a one-level expansion on the result, instead of complete). | |
2c825956 GM |
3310 | % |
3311 | \def\expandablevalue#1{% | |
3312 | \expandafter\ifx\csname SET#1\endcsname\relax | |
3313 | {[No value for ``#1'']}% | |
0f9c1975 | 3314 | \message{Variable `#1', used in @value, is not set.}% |
2c825956 GM |
3315 | \else |
3316 | \csname SET#1\endcsname | |
3317 | \fi | |
3318 | } | |
3319 | ||
3320 | % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined | |
3321 | % with @set. | |
3322 | % | |
0f9c1975 KB |
3323 | % To get special treatment of `@end ifset,' call \makeond and the redefine. |
3324 | % | |
3325 | \makecond{ifset} | |
3326 | \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} | |
3327 | \def\doifset#1#2{% | |
3328 | {% | |
3329 | \makevalueexpandable | |
3330 | \let\next=\empty | |
3331 | \expandafter\ifx\csname SET#2\endcsname\relax | |
3332 | #1% If not set, redefine \next. | |
3333 | \fi | |
3334 | \expandafter | |
3335 | }\next | |
2c825956 | 3336 | } |
0f9c1975 | 3337 | \def\ifsetfail{\doignore{ifset}} |
2c825956 GM |
3338 | |
3339 | % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been | |
3340 | % defined with @set, or has been undefined with @clear. | |
3341 | % | |
0f9c1975 KB |
3342 | % The `\else' inside the `\doifset' parameter is a trick to reuse the |
3343 | % above code: if the variable is not set, do nothing, if it is set, | |
3344 | % then redefine \next to \ifclearfail. | |
2c825956 | 3345 | % |
0f9c1975 KB |
3346 | \makecond{ifclear} |
3347 | \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} | |
3348 | \def\ifclearfail{\doignore{ifclear}} | |
3349 | ||
3350 | % @dircategory CATEGORY -- specify a category of the dir file | |
3351 | % which this file should belong to. Ignore this in TeX. | |
3352 | \let\dircategory=\comment | |
2c825956 GM |
3353 | |
3354 | % @defininfoenclose. | |
3355 | \let\definfoenclose=\comment | |
3356 | ||
3357 | ||
3358 | \message{indexing,} | |
3359 | % Index generation facilities | |
3360 | ||
3361 | % Define \newwrite to be identical to plain tex's \newwrite | |
0f9c1975 KB |
3362 | % except not \outer, so it can be used within macros and \if's. |
3363 | \edef\newwrite{\makecsname{ptexnewwrite}} | |
2c825956 GM |
3364 | |
3365 | % \newindex {foo} defines an index named foo. | |
3366 | % It automatically defines \fooindex such that | |
3367 | % \fooindex ...rest of line... puts an entry in the index foo. | |
3368 | % It also defines \fooindfile to be the number of the output channel for | |
3369 | % the file that accumulates this index. The file's extension is foo. | |
3370 | % The name of an index should be no more than 2 characters long | |
3371 | % for the sake of vms. | |
3372 | % | |
3373 | \def\newindex#1{% | |
3374 | \iflinks | |
3375 | \expandafter\newwrite \csname#1indfile\endcsname | |
3376 | \openout \csname#1indfile\endcsname \jobname.#1 % Open the file | |
3377 | \fi | |
3378 | \expandafter\xdef\csname#1index\endcsname{% % Define @#1index | |
3379 | \noexpand\doindex{#1}} | |
3380 | } | |
3381 | ||
3382 | % @defindex foo == \newindex{foo} | |
3383 | % | |
3384 | \def\defindex{\parsearg\newindex} | |
3385 | ||
3386 | % Define @defcodeindex, like @defindex except put all entries in @code. | |
3387 | % | |
3388 | \def\defcodeindex{\parsearg\newcodeindex} | |
3389 | % | |
3390 | \def\newcodeindex#1{% | |
3391 | \iflinks | |
3392 | \expandafter\newwrite \csname#1indfile\endcsname | |
3393 | \openout \csname#1indfile\endcsname \jobname.#1 | |
3394 | \fi | |
3395 | \expandafter\xdef\csname#1index\endcsname{% | |
3396 | \noexpand\docodeindex{#1}}% | |
3397 | } | |
3398 | ||
3399 | ||
3400 | % @synindex foo bar makes index foo feed into index bar. | |
3401 | % Do this instead of @defindex foo if you don't want it as a separate index. | |
177c0ea7 | 3402 | % |
2c825956 GM |
3403 | % @syncodeindex foo bar similar, but put all entries made for index foo |
3404 | % inside @code. | |
177c0ea7 | 3405 | % |
2c825956 GM |
3406 | \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} |
3407 | \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} | |
3408 | ||
3409 | % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), | |
3410 | % #3 the target index (bar). | |
3411 | \def\dosynindex#1#2#3{% | |
3412 | % Only do \closeout if we haven't already done it, else we'll end up | |
3413 | % closing the target index. | |
3414 | \expandafter \ifx\csname donesynindex#2\endcsname \undefined | |
3415 | % The \closeout helps reduce unnecessary open files; the limit on the | |
3416 | % Acorn RISC OS is a mere 16 files. | |
3417 | \expandafter\closeout\csname#2indfile\endcsname | |
3418 | \expandafter\let\csname\donesynindex#2\endcsname = 1 | |
3419 | \fi | |
3420 | % redefine \fooindfile: | |
3421 | \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname | |
3422 | \expandafter\let\csname#2indfile\endcsname=\temp | |
3423 | % redefine \fooindex: | |
3424 | \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% | |
3425 | } | |
3426 | ||
3427 | % Define \doindex, the driver for all \fooindex macros. | |
3428 | % Argument #1 is generated by the calling \fooindex macro, | |
3429 | % and it is "foo", the name of the index. | |
3430 | ||
3431 | % \doindex just uses \parsearg; it calls \doind for the actual work. | |
3432 | % This is because \doind is more useful to call from other macros. | |
3433 | ||
3434 | % There is also \dosubind {index}{topic}{subtopic} | |
3435 | % which makes an entry in a two-level index such as the operation index. | |
3436 | ||
3437 | \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} | |
3438 | \def\singleindexer #1{\doind{\indexname}{#1}} | |
3439 | ||
3440 | % like the previous two, but they put @code around the argument. | |
3441 | \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} | |
3442 | \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} | |
3443 | ||
0f9c1975 KB |
3444 | % Take care of Texinfo commands that can appear in an index entry. |
3445 | % Since there are some commands we want to expand, and others we don't, | |
3446 | % we have to laboriously prevent expansion for those that we don't. | |
177c0ea7 | 3447 | % |
2c825956 | 3448 | \def\indexdummies{% |
0f9c1975 KB |
3449 | \escapechar = `\\ % use backslash in output files. |
3450 | \def\@{@}% change to @@ when we switch to @ as escape char in index files. | |
3451 | \def\ {\realbackslash\space }% | |
fe23e770 | 3452 | % |
0f9c1975 KB |
3453 | % Need these in case \tex is in effect and \{ is a \delimiter again. |
3454 | % But can't use \lbracecmd and \rbracecmd because texindex assumes | |
3455 | % braces and backslashes are used only as delimiters. | |
3456 | \let\{ = \mylbrace | |
3457 | \let\} = \myrbrace | |
3458 | % | |
fe23e770 KB |
3459 | % I don't entirely understand this, but when an index entry is |
3460 | % generated from a macro call, the \endinput which \scanmacro inserts | |
3461 | % causes processing to be prematurely terminated. This is, | |
3462 | % apparently, because \indexsorttmp is fully expanded, and \endinput | |
3463 | % is an expandable command. The redefinition below makes \endinput | |
3464 | % disappear altogether for that purpose -- although logging shows that | |
3465 | % processing continues to some further point. On the other hand, it | |
3466 | % seems \endinput does not hurt in the printed index arg, since that | |
3467 | % is still getting written without apparent harm. | |
3468 | % | |
3469 | % Sample source (mac-idx3.tex, reported by Graham Percival to | |
3470 | % help-texinfo, 22may06): | |
3471 | % @macro funindex {WORD} | |
3472 | % @findex xyz | |
3473 | % @end macro | |
3474 | % ... | |
3475 | % @funindex commtest | |
3476 | % | |
3477 | % The above is not enough to reproduce the bug, but it gives the flavor. | |
3478 | % | |
3479 | % Sample whatsit resulting: | |
3480 | % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}} | |
3481 | % | |
3482 | % So: | |
3483 | \let\endinput = \empty | |
3484 | % | |
0f9c1975 KB |
3485 | % Do the redefinitions. |
3486 | \commondummies | |
3487 | } | |
3488 | ||
3489 | % For the aux and toc files, @ is the escape character. So we want to | |
3490 | % redefine everything using @ as the escape character (instead of | |
3491 | % \realbackslash, still used for index files). When everything uses @, | |
3492 | % this will be simpler. | |
3493 | % | |
3494 | \def\atdummies{% | |
3495 | \def\@{@@}% | |
3496 | \def\ {@ }% | |
3497 | \let\{ = \lbraceatcmd | |
3498 | \let\} = \rbraceatcmd | |
3499 | % | |
3500 | % Do the redefinitions. | |
3501 | \commondummies | |
3502 | \otherbackslash | |
3503 | } | |
2c825956 | 3504 | |
0f9c1975 KB |
3505 | % Called from \indexdummies and \atdummies. |
3506 | % | |
3507 | \def\commondummies{% | |
3508 | % | |
3509 | % \definedummyword defines \#1 as \string\#1\space, thus effectively | |
3510 | % preventing its expansion. This is used only for control% words, | |
3511 | % not control letters, because the \space would be incorrect for | |
3512 | % control characters, but is needed to separate the control word | |
3513 | % from whatever follows. | |
3514 | % | |
3515 | % For control letters, we have \definedummyletter, which omits the | |
3516 | % space. | |
3517 | % | |
3518 | % These can be used both for control words that take an argument and | |
3519 | % those that do not. If it is followed by {arg} in the input, then | |
3520 | % that will dutifully get written to the index (or wherever). | |
3521 | % | |
3522 | \def\definedummyword ##1{\def##1{\string##1\space}}% | |
3523 | \def\definedummyletter##1{\def##1{\string##1}}% | |
3524 | \let\definedummyaccent\definedummyletter | |
3525 | % | |
3526 | \commondummiesnofonts | |
3527 | % | |
3528 | \definedummyletter\_% | |
3529 | % | |
3530 | % Non-English letters. | |
3531 | \definedummyword\AA | |
3532 | \definedummyword\AE | |
3533 | \definedummyword\L | |
3534 | \definedummyword\OE | |
3535 | \definedummyword\O | |
3536 | \definedummyword\aa | |
3537 | \definedummyword\ae | |
3538 | \definedummyword\l | |
3539 | \definedummyword\oe | |
3540 | \definedummyword\o | |
3541 | \definedummyword\ss | |
3542 | \definedummyword\exclamdown | |
3543 | \definedummyword\questiondown | |
3544 | \definedummyword\ordf | |
3545 | \definedummyword\ordm | |
3546 | % | |
3547 | % Although these internal commands shouldn't show up, sometimes they do. | |
3548 | \definedummyword\bf | |
3549 | \definedummyword\gtr | |
3550 | \definedummyword\hat | |
3551 | \definedummyword\less | |
3552 | \definedummyword\sf | |
3553 | \definedummyword\sl | |
3554 | \definedummyword\tclose | |
3555 | \definedummyword\tt | |
3556 | % | |
3557 | \definedummyword\LaTeX | |
3558 | \definedummyword\TeX | |
3559 | % | |
3560 | % Assorted special characters. | |
3561 | \definedummyword\bullet | |
3562 | \definedummyword\comma | |
3563 | \definedummyword\copyright | |
3564 | \definedummyword\registeredsymbol | |
3565 | \definedummyword\dots | |
3566 | \definedummyword\enddots | |
3567 | \definedummyword\equiv | |
3568 | \definedummyword\error | |
3569 | \definedummyword\euro | |
3570 | \definedummyword\expansion | |
3571 | \definedummyword\minus | |
3572 | \definedummyword\pounds | |
3573 | \definedummyword\point | |
3574 | \definedummyword\print | |
3575 | \definedummyword\result | |
3abebd3b | 3576 | \definedummyword\textdegree |
0f9c1975 KB |
3577 | % |
3578 | % We want to disable all macros so that they are not expanded by \write. | |
3579 | \macrolist | |
3580 | % | |
3581 | \normalturnoffactive | |
3582 | % | |
3583 | % Handle some cases of @value -- where it does not contain any | |
3584 | % (non-fully-expandable) commands. | |
3585 | \makevalueexpandable | |
3586 | } | |
3587 | ||
3588 | % \commondummiesnofonts: common to \commondummies and \indexnofonts. | |
3589 | % | |
3590 | \def\commondummiesnofonts{% | |
3591 | % Control letters and accents. | |
3592 | \definedummyletter\!% | |
3593 | \definedummyaccent\"% | |
3594 | \definedummyaccent\'% | |
3595 | \definedummyletter\*% | |
3596 | \definedummyaccent\,% | |
3597 | \definedummyletter\.% | |
3598 | \definedummyletter\/% | |
3599 | \definedummyletter\:% | |
3600 | \definedummyaccent\=% | |
3601 | \definedummyletter\?% | |
3602 | \definedummyaccent\^% | |
3603 | \definedummyaccent\`% | |
3604 | \definedummyaccent\~% | |
3605 | \definedummyword\u | |
3606 | \definedummyword\v | |
3607 | \definedummyword\H | |
3608 | \definedummyword\dotaccent | |
3609 | \definedummyword\ringaccent | |
3610 | \definedummyword\tieaccent | |
3611 | \definedummyword\ubaraccent | |
3612 | \definedummyword\udotaccent | |
3613 | \definedummyword\dotless | |
3614 | % | |
3615 | % Texinfo font commands. | |
3616 | \definedummyword\b | |
3617 | \definedummyword\i | |
3618 | \definedummyword\r | |
3619 | \definedummyword\sc | |
3620 | \definedummyword\t | |
3621 | % | |
3622 | % Commands that take arguments. | |
3623 | \definedummyword\acronym | |
3624 | \definedummyword\cite | |
3625 | \definedummyword\code | |
3626 | \definedummyword\command | |
3627 | \definedummyword\dfn | |
3628 | \definedummyword\emph | |
3629 | \definedummyword\env | |
3630 | \definedummyword\file | |
3631 | \definedummyword\kbd | |
3632 | \definedummyword\key | |
3633 | \definedummyword\math | |
3634 | \definedummyword\option | |
3635 | \definedummyword\pxref | |
3636 | \definedummyword\ref | |
3637 | \definedummyword\samp | |
3638 | \definedummyword\strong | |
3639 | \definedummyword\tie | |
3640 | \definedummyword\uref | |
3641 | \definedummyword\url | |
3642 | \definedummyword\var | |
3643 | \definedummyword\verb | |
3644 | \definedummyword\w | |
3645 | \definedummyword\xref | |
3646 | } | |
3647 | ||
3648 | % \indexnofonts is used when outputting the strings to sort the index | |
3649 | % by, and when constructing control sequence names. It eliminates all | |
3650 | % control sequences and just writes whatever the best ASCII sort string | |
3651 | % would be for a given command (usually its argument). | |
3652 | % | |
2c825956 | 3653 | \def\indexnofonts{% |
0f9c1975 KB |
3654 | % Accent commands should become @asis. |
3655 | \def\definedummyaccent##1{\let##1\asis}% | |
3656 | % We can just ignore other control letters. | |
3657 | \def\definedummyletter##1{\let##1\empty}% | |
3658 | % Hopefully, all control words can become @asis. | |
3659 | \let\definedummyword\definedummyaccent | |
3660 | % | |
3661 | \commondummiesnofonts | |
3662 | % | |
3663 | % Don't no-op \tt, since it isn't a user-level command | |
3664 | % and is used in the definitions of the active chars like <, >, |, etc. | |
3665 | % Likewise with the other plain tex font commands. | |
3666 | %\let\tt=\asis | |
3667 | % | |
3668 | \def\ { }% | |
3669 | \def\@{@}% | |
3670 | % how to handle braces? | |
3671 | \def\_{\normalunderscore}% | |
3672 | % | |
3673 | % Non-English letters. | |
3674 | \def\AA{AA}% | |
3675 | \def\AE{AE}% | |
3676 | \def\L{L}% | |
3677 | \def\OE{OE}% | |
3678 | \def\O{O}% | |
3679 | \def\aa{aa}% | |
3680 | \def\ae{ae}% | |
3681 | \def\l{l}% | |
3682 | \def\oe{oe}% | |
3683 | \def\o{o}% | |
3684 | \def\ss{ss}% | |
3685 | \def\exclamdown{!}% | |
3686 | \def\questiondown{?}% | |
3687 | \def\ordf{a}% | |
3688 | \def\ordm{o}% | |
3689 | % | |
3690 | \def\LaTeX{LaTeX}% | |
3691 | \def\TeX{TeX}% | |
3692 | % | |
3693 | % Assorted special characters. | |
3694 | % (The following {} will end up in the sort string, but that's ok.) | |
3695 | \def\bullet{bullet}% | |
3696 | \def\comma{,}% | |
3697 | \def\copyright{copyright}% | |
3698 | \def\registeredsymbol{R}% | |
3699 | \def\dots{...}% | |
3700 | \def\enddots{...}% | |
3701 | \def\equiv{==}% | |
3702 | \def\error{error}% | |
3703 | \def\euro{euro}% | |
3704 | \def\expansion{==>}% | |
3705 | \def\minus{-}% | |
3706 | \def\pounds{pounds}% | |
3707 | \def\point{.}% | |
3708 | \def\print{-|}% | |
3709 | \def\result{=>}% | |
3abebd3b | 3710 | \def\textdegree{degrees}% |
0f9c1975 KB |
3711 | % |
3712 | % We need to get rid of all macros, leaving only the arguments (if present). | |
3713 | % Of course this is not nearly correct, but it is the best we can do for now. | |
3714 | % makeinfo does not expand macros in the argument to @deffn, which ends up | |
3715 | % writing an index entry, and texindex isn't prepared for an index sort entry | |
3716 | % that starts with \. | |
3717 | % | |
3718 | % Since macro invocations are followed by braces, we can just redefine them | |
3719 | % to take a single TeX argument. The case of a macro invocation that | |
3720 | % goes to end-of-line is not handled. | |
3721 | % | |
3722 | \macrolist | |
3723 | } | |
2c825956 GM |
3724 | |
3725 | \let\indexbackslash=0 %overridden during \printindex. | |
3726 | \let\SETmarginindex=\relax % put index entries in margin (undocumented)? | |
3727 | ||
2c825956 | 3728 | % Most index entries go through here, but \dosubind is the general case. |
0f9c1975 KB |
3729 | % #1 is the index name, #2 is the entry text. |
3730 | \def\doind#1#2{\dosubind{#1}{#2}{}} | |
2c825956 GM |
3731 | |
3732 | % Workhorse for all \fooindexes. | |
3733 | % #1 is name of index, #2 is stuff to put there, #3 is subentry -- | |
0f9c1975 KB |
3734 | % empty if called from \doind, as we usually are (the main exception |
3735 | % is with most defuns, which call us directly). | |
2c825956 GM |
3736 | % |
3737 | \def\dosubind#1#2#3{% | |
0f9c1975 KB |
3738 | \iflinks |
3739 | {% | |
3740 | % Store the main index entry text (including the third arg). | |
3741 | \toks0 = {#2}% | |
3742 | % If third arg is present, precede it with a space. | |
3743 | \def\thirdarg{#3}% | |
3744 | \ifx\thirdarg\empty \else | |
3745 | \toks0 = \expandafter{\the\toks0 \space #3}% | |
3746 | \fi | |
3747 | % | |
3748 | \edef\writeto{\csname#1indfile\endcsname}% | |
3749 | % | |
98bf69dc | 3750 | \safewhatsit\dosubindwrite |
0f9c1975 KB |
3751 | }% |
3752 | \fi | |
3753 | } | |
3754 | ||
3755 | % Write the entry in \toks0 to the index file: | |
3756 | % | |
3757 | \def\dosubindwrite{% | |
2c825956 GM |
3758 | % Put the index entry in the margin if desired. |
3759 | \ifx\SETmarginindex\relax\else | |
0f9c1975 | 3760 | \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% |
2c825956 | 3761 | \fi |
0f9c1975 KB |
3762 | % |
3763 | % Remember, we are within a group. | |
3764 | \indexdummies % Must do this here, since \bf, etc expand at this stage | |
3765 | \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now | |
3766 | % so it will be output as is; and it will print as backslash. | |
3767 | % | |
3768 | % Process the index entry with all font commands turned off, to | |
3769 | % get the string to sort by. | |
3770 | {\indexnofonts | |
3771 | \edef\temp{\the\toks0}% need full expansion | |
3772 | \xdef\indexsorttmp{\temp}% | |
3773 | }% | |
3774 | % | |
3775 | % Set up the complete index entry, with both the sort key and | |
3776 | % the original text, including any font commands. We write | |
3777 | % three arguments to \entry to the .?? file (four in the | |
3778 | % subentry case), texindex reduces to two when writing the .??s | |
3779 | % sorted result. | |
3780 | \edef\temp{% | |
3781 | \write\writeto{% | |
3782 | \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% | |
2c825956 | 3783 | }% |
0f9c1975 KB |
3784 | \temp |
3785 | } | |
3786 | ||
98bf69dc | 3787 | % Take care of unwanted page breaks/skips around a whatsit: |
0f9c1975 KB |
3788 | % |
3789 | % If a skip is the last thing on the list now, preserve it | |
3790 | % by backing up by \lastskip, doing the \write, then inserting | |
3791 | % the skip again. Otherwise, the whatsit generated by the | |
98bf69dc KB |
3792 | % \write or \pdfdest will make \lastskip zero. The result is that |
3793 | % sequences like this: | |
0f9c1975 KB |
3794 | % @end defun |
3795 | % @tindex whatever | |
3796 | % @defun ... | |
3797 | % will have extra space inserted, because the \medbreak in the | |
3798 | % start of the @defun won't see the skip inserted by the @end of | |
3799 | % the previous defun. | |
3800 | % | |
3801 | % But don't do any of this if we're not in vertical mode. We | |
3802 | % don't want to do a \vskip and prematurely end a paragraph. | |
3803 | % | |
3804 | % Avoid page breaks due to these extra skips, too. | |
3805 | % | |
3806 | % But wait, there is a catch there: | |
3807 | % We'll have to check whether \lastskip is zero skip. \ifdim is not | |
3808 | % sufficient for this purpose, as it ignores stretch and shrink parts | |
3809 | % of the skip. The only way seems to be to check the textual | |
3810 | % representation of the skip. | |
3811 | % | |
3812 | % The following is almost like \def\zeroskipmacro{0.0pt} except that | |
3813 | % the ``p'' and ``t'' characters have catcode \other, not 11 (letter). | |
3814 | % | |
3815 | \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} | |
3816 | % | |
98bf69dc KB |
3817 | \newskip\whatsitskip |
3818 | \newcount\whatsitpenalty | |
3819 | % | |
0f9c1975 KB |
3820 | % ..., ready, GO: |
3821 | % | |
98bf69dc KB |
3822 | \def\safewhatsit#1{% |
3823 | \ifhmode | |
3824 | #1% | |
3825 | \else | |
0f9c1975 | 3826 | % \lastskip and \lastpenalty cannot both be nonzero simultaneously. |
98bf69dc | 3827 | \whatsitskip = \lastskip |
0f9c1975 | 3828 | \edef\lastskipmacro{\the\lastskip}% |
98bf69dc | 3829 | \whatsitpenalty = \lastpenalty |
0f9c1975 KB |
3830 | % |
3831 | % If \lastskip is nonzero, that means the last item was a | |
3832 | % skip. And since a skip is discardable, that means this | |
3833 | % -\skip0 glue we're inserting is preceded by a | |
3834 | % non-discardable item, therefore it is not a potential | |
3835 | % breakpoint, therefore no \nobreak needed. | |
3836 | \ifx\lastskipmacro\zeroskipmacro | |
3837 | \else | |
98bf69dc | 3838 | \vskip-\whatsitskip |
0f9c1975 KB |
3839 | \fi |
3840 | % | |
98bf69dc | 3841 | #1% |
0f9c1975 KB |
3842 | % |
3843 | \ifx\lastskipmacro\zeroskipmacro | |
3844 | % If \lastskip was zero, perhaps the last item was a penalty, and | |
3845 | % perhaps it was >=10000, e.g., a \nobreak. In that case, we want | |
3846 | % to re-insert the same penalty (values >10000 are used for various | |
3847 | % signals); since we just inserted a non-discardable item, any | |
3848 | % following glue (such as a \parskip) would be a breakpoint. For example: | |
3849 | % | |
3850 | % @deffn deffn-whatever | |
3851 | % @vindex index-whatever | |
3852 | % Description. | |
3853 | % would allow a break between the index-whatever whatsit | |
3854 | % and the "Description." paragraph. | |
98bf69dc | 3855 | \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi |
0f9c1975 KB |
3856 | \else |
3857 | % On the other hand, if we had a nonzero \lastskip, | |
3858 | % this make-up glue would be preceded by a non-discardable item | |
3859 | % (the whatsit from the \write), so we must insert a \nobreak. | |
98bf69dc | 3860 | \nobreak\vskip\whatsitskip |
0f9c1975 | 3861 | \fi |
98bf69dc | 3862 | \fi |
2c825956 GM |
3863 | } |
3864 | ||
3865 | % The index entry written in the file actually looks like | |
3866 | % \entry {sortstring}{page}{topic} | |
3867 | % or | |
3868 | % \entry {sortstring}{page}{topic}{subtopic} | |
3869 | % The texindex program reads in these files and writes files | |
3870 | % containing these kinds of lines: | |
3871 | % \initial {c} | |
3872 | % before the first topic whose initial is c | |
3873 | % \entry {topic}{pagelist} | |
3874 | % for a topic that is used without subtopics | |
3875 | % \primary {topic} | |
3876 | % for the beginning of a topic that is used with subtopics | |
3877 | % \secondary {subtopic}{pagelist} | |
3878 | % for each subtopic. | |
3879 | ||
3880 | % Define the user-accessible indexing commands | |
3881 | % @findex, @vindex, @kindex, @cindex. | |
3882 | ||
3883 | \def\findex {\fnindex} | |
3884 | \def\kindex {\kyindex} | |
3885 | \def\cindex {\cpindex} | |
3886 | \def\vindex {\vrindex} | |
3887 | \def\tindex {\tpindex} | |
3888 | \def\pindex {\pgindex} | |
3889 | ||
3890 | \def\cindexsub {\begingroup\obeylines\cindexsub} | |
3891 | {\obeylines % | |
3892 | \gdef\cindexsub "#1" #2^^M{\endgroup % | |
3893 | \dosubind{cp}{#2}{#1}}} | |
3894 | ||
3895 | % Define the macros used in formatting output of the sorted index material. | |
3896 | ||
3897 | % @printindex causes a particular index (the ??s file) to get printed. | |
3898 | % It does not print any chapter heading (usually an @unnumbered). | |
3899 | % | |
0f9c1975 | 3900 | \parseargdef\printindex{\begingroup |
2c825956 GM |
3901 | \dobreak \chapheadingskip{10000}% |
3902 | % | |
3903 | \smallfonts \rm | |
3904 | \tolerance = 9500 | |
5ac8d2e8 | 3905 | \plainfrenchspacing |
0f9c1975 | 3906 | \everypar = {}% don't want the \kern\-parindent from indentation suppression. |
2c825956 GM |
3907 | % |
3908 | % See if the index file exists and is nonempty. | |
3909 | % Change catcode of @ here so that if the index file contains | |
3910 | % \initial {@} | |
3911 | % as its first line, TeX doesn't complain about mismatched braces | |
3912 | % (because it thinks @} is a control sequence). | |
3913 | \catcode`\@ = 11 | |
3914 | \openin 1 \jobname.#1s | |
3915 | \ifeof 1 | |
3916 | % \enddoublecolumns gets confused if there is no text in the index, | |
3917 | % and it loses the chapter title and the aux file entries for the | |
3918 | % index. The easiest way to prevent this problem is to make sure | |
3919 | % there is some text. | |
3920 | \putwordIndexNonexistent | |
3921 | \else | |
3922 | % | |
3923 | % If the index file exists but is empty, then \openin leaves \ifeof | |
3924 | % false. We have to make TeX try to read something from the file, so | |
3925 | % it can discover if there is anything in it. | |
3926 | \read 1 to \temp | |
3927 | \ifeof 1 | |
3928 | \putwordIndexIsEmpty | |
3929 | \else | |
3930 | % Index files are almost Texinfo source, but we use \ as the escape | |
3931 | % character. It would be better to use @, but that's too big a change | |
3932 | % to make right now. | |
0f9c1975 | 3933 | \def\indexbackslash{\backslashcurfont}% |
2c825956 GM |
3934 | \catcode`\\ = 0 |
3935 | \escapechar = `\\ | |
3936 | \begindoublecolumns | |
3937 | \input \jobname.#1s | |
3938 | \enddoublecolumns | |
3939 | \fi | |
3940 | \fi | |
3941 | \closein 1 | |
3942 | \endgroup} | |
3943 | ||
3944 | % These macros are used by the sorted index file itself. | |
3945 | % Change them to control the appearance of the index. | |
3946 | ||
3947 | \def\initial#1{{% | |
3948 | % Some minor font changes for the special characters. | |
3949 | \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt | |
3950 | % | |
3951 | % Remove any glue we may have, we'll be inserting our own. | |
3952 | \removelastskip | |
3953 | % | |
3954 | % We like breaks before the index initials, so insert a bonus. | |
0f9c1975 KB |
3955 | \nobreak |
3956 | \vskip 0pt plus 3\baselineskip | |
3957 | \penalty 0 | |
3958 | \vskip 0pt plus -3\baselineskip | |
2c825956 GM |
3959 | % |
3960 | % Typeset the initial. Making this add up to a whole number of | |
3961 | % baselineskips increases the chance of the dots lining up from column | |
3962 | % to column. It still won't often be perfect, because of the stretch | |
3963 | % we need before each entry, but it's better. | |
3964 | % | |
3965 | % No shrink because it confuses \balancecolumns. | |
3966 | \vskip 1.67\baselineskip plus .5\baselineskip | |
3967 | \leftline{\secbf #1}% | |
2c825956 GM |
3968 | % Do our best not to break after the initial. |
3969 | \nobreak | |
0f9c1975 | 3970 | \vskip .33\baselineskip plus .1\baselineskip |
2c825956 GM |
3971 | }} |
3972 | ||
0f9c1975 KB |
3973 | % \entry typesets a paragraph consisting of the text (#1), dot leaders, and |
3974 | % then page number (#2) flushed to the right margin. It is used for index | |
3975 | % and table of contents entries. The paragraph is indented by \leftskip. | |
2c825956 | 3976 | % |
0f9c1975 KB |
3977 | % A straightforward implementation would start like this: |
3978 | % \def\entry#1#2{... | |
3979 | % But this frozes the catcodes in the argument, and can cause problems to | |
3980 | % @code, which sets - active. This problem was fixed by a kludge--- | |
3981 | % ``-'' was active throughout whole index, but this isn't really right. | |
3982 | % | |
3983 | % The right solution is to prevent \entry from swallowing the whole text. | |
3984 | % --kasal, 21nov03 | |
3985 | \def\entry{% | |
3986 | \begingroup | |
3987 | % | |
3988 | % Start a new paragraph if necessary, so our assignments below can't | |
3989 | % affect previous text. | |
3990 | \par | |
3991 | % | |
3992 | % Do not fill out the last line with white space. | |
3993 | \parfillskip = 0in | |
2c825956 | 3994 | % |
0f9c1975 KB |
3995 | % No extra space above this paragraph. |
3996 | \parskip = 0in | |
2c825956 | 3997 | % |
0f9c1975 KB |
3998 | % Do not prefer a separate line ending with a hyphen to fewer lines. |
3999 | \finalhyphendemerits = 0 | |
4000 | % | |
4001 | % \hangindent is only relevant when the entry text and page number | |
4002 | % don't both fit on one line. In that case, bob suggests starting the | |
4003 | % dots pretty far over on the line. Unfortunately, a large | |
4004 | % indentation looks wrong when the entry text itself is broken across | |
4005 | % lines. So we use a small indentation and put up with long leaders. | |
4006 | % | |
4007 | % \hangafter is reset to 1 (which is the value we want) at the start | |
4008 | % of each paragraph, so we need not do anything with that. | |
4009 | \hangindent = 2em | |
4010 | % | |
4011 | % When the entry text needs to be broken, just fill out the first line | |
4012 | % with blank space. | |
4013 | \rightskip = 0pt plus1fil | |
4014 | % | |
4015 | % A bit of stretch before each entry for the benefit of balancing | |
4016 | % columns. | |
4017 | \vskip 0pt plus1pt | |
4018 | % | |
4019 | % Swallow the left brace of the text (first parameter): | |
4020 | \afterassignment\doentry | |
4021 | \let\temp = | |
4022 | } | |
4023 | \def\doentry{% | |
4024 | \bgroup % Instead of the swallowed brace. | |
4025 | \noindent | |
4026 | \aftergroup\finishentry | |
4027 | % And now comes the text of the entry. | |
4028 | } | |
4029 | \def\finishentry#1{% | |
4030 | % #1 is the page number. | |
4031 | % | |
4032 | % The following is kludged to not output a line of dots in the index if | |
4033 | % there are no page numbers. The next person who breaks this will be | |
4034 | % cursed by a Unix daemon. | |
4035 | \def\tempa{{\rm }}% | |
4036 | \def\tempb{#1}% | |
4037 | \edef\tempc{\tempa}% | |
4038 | \edef\tempd{\tempb}% | |
4039 | \ifx\tempc\tempd | |
4040 | \ % | |
2c825956 | 4041 | \else |
0f9c1975 KB |
4042 | % |
4043 | % If we must, put the page number on a line of its own, and fill out | |
4044 | % this line with blank space. (The \hfil is overwhelmed with the | |
4045 | % fill leaders glue in \indexdotfill if the page number does fit.) | |
4046 | \hfil\penalty50 | |
4047 | \null\nobreak\indexdotfill % Have leaders before the page number. | |
4048 | % | |
4049 | % The `\ ' here is removed by the implicit \unskip that TeX does as | |
4050 | % part of (the primitive) \par. Without it, a spurious underfull | |
4051 | % \hbox ensues. | |
4052 | \ifpdf | |
4053 | \pdfgettoks#1.% | |
4054 | \ \the\toksA | |
4055 | \else | |
4056 | \ #1% | |
4057 | \fi | |
2c825956 | 4058 | \fi |
0f9c1975 KB |
4059 | \par |
4060 | \endgroup | |
4061 | } | |
2c825956 | 4062 | |
d61cd812 | 4063 | % Like plain.tex's \dotfill, except uses up at least 1 em. |
2c825956 | 4064 | \def\indexdotfill{\cleaders |
d61cd812 | 4065 | \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill} |
2c825956 GM |
4066 | |
4067 | \def\primary #1{\line{#1\hfil}} | |
4068 | ||
4069 | \newskip\secondaryindent \secondaryindent=0.5cm | |
4070 | \def\secondary#1#2{{% | |
4071 | \parfillskip=0in | |
4072 | \parskip=0in | |
4073 | \hangindent=1in | |
4074 | \hangafter=1 | |
4075 | \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill | |
4076 | \ifpdf | |
4077 | \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. | |
4078 | \else | |
4079 | #2 | |
4080 | \fi | |
4081 | \par | |
4082 | }} | |
4083 | ||
4084 | % Define two-column mode, which we use to typeset indexes. | |
4085 | % Adapted from the TeXbook, page 416, which is to say, | |
4086 | % the manmac.tex format used to print the TeXbook itself. | |
4087 | \catcode`\@=11 | |
4088 | ||
4089 | \newbox\partialpage | |
4090 | \newdimen\doublecolumnhsize | |
4091 | ||
4092 | \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns | |
4093 | % Grab any single-column material above us. | |
4094 | \output = {% | |
4095 | % | |
4096 | % Here is a possibility not foreseen in manmac: if we accumulate a | |
4097 | % whole lot of material, we might end up calling this \output | |
4098 | % routine twice in a row (see the doublecol-lose test, which is | |
4099 | % essentially a couple of indexes with @setchapternewpage off). In | |
4100 | % that case we just ship out what is in \partialpage with the normal | |
4101 | % output routine. Generally, \partialpage will be empty when this | |
4102 | % runs and this will be a no-op. See the indexspread.tex test case. | |
4103 | \ifvoid\partialpage \else | |
4104 | \onepageout{\pagecontents\partialpage}% | |
4105 | \fi | |
4106 | % | |
4107 | \global\setbox\partialpage = \vbox{% | |
4108 | % Unvbox the main output page. | |
4109 | \unvbox\PAGE | |
4110 | \kern-\topskip \kern\baselineskip | |
4111 | }% | |
4112 | }% | |
4113 | \eject % run that output routine to set \partialpage | |
4114 | % | |
4115 | % Use the double-column output routine for subsequent pages. | |
4116 | \output = {\doublecolumnout}% | |
4117 | % | |
4118 | % Change the page size parameters. We could do this once outside this | |
4119 | % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 | |
4120 | % format, but then we repeat the same computation. Repeating a couple | |
4121 | % of assignments once per index is clearly meaningless for the | |
4122 | % execution time, so we may as well do it in one place. | |
4123 | % | |
4124 | % First we halve the line length, less a little for the gutter between | |
4125 | % the columns. We compute the gutter based on the line length, so it | |
4126 | % changes automatically with the paper format. The magic constant | |
4127 | % below is chosen so that the gutter has the same value (well, +-<1pt) | |
4128 | % as it did when we hard-coded it. | |
4129 | % | |
4130 | % We put the result in a separate register, \doublecolumhsize, so we | |
4131 | % can restore it in \pagesofar, after \hsize itself has (potentially) | |
4132 | % been clobbered. | |
4133 | % | |
4134 | \doublecolumnhsize = \hsize | |
4135 | \advance\doublecolumnhsize by -.04154\hsize | |
4136 | \divide\doublecolumnhsize by 2 | |
4137 | \hsize = \doublecolumnhsize | |
4138 | % | |
4139 | % Double the \vsize as well. (We don't need a separate register here, | |
4140 | % since nobody clobbers \vsize.) | |
4141 | \vsize = 2\vsize | |
4142 | } | |
4143 | ||
4144 | % The double-column output routine for all double-column pages except | |
4145 | % the last. | |
4146 | % | |
4147 | \def\doublecolumnout{% | |
4148 | \splittopskip=\topskip \splitmaxdepth=\maxdepth | |
4149 | % Get the available space for the double columns -- the normal | |
4150 | % (undoubled) page height minus any material left over from the | |
4151 | % previous page. | |
4152 | \dimen@ = \vsize | |
4153 | \divide\dimen@ by 2 | |
4154 | \advance\dimen@ by -\ht\partialpage | |
4155 | % | |
4156 | % box0 will be the left-hand column, box2 the right. | |
4157 | \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ | |
4158 | \onepageout\pagesofar | |
4159 | \unvbox255 | |
4160 | \penalty\outputpenalty | |
4161 | } | |
4162 | % | |
4163 | % Re-output the contents of the output page -- any previous material, | |
4164 | % followed by the two boxes we just split, in box0 and box2. | |
4165 | \def\pagesofar{% | |
4166 | \unvbox\partialpage | |
4167 | % | |
4168 | \hsize = \doublecolumnhsize | |
4169 | \wd0=\hsize \wd2=\hsize | |
4170 | \hbox to\pagewidth{\box0\hfil\box2}% | |
4171 | } | |
177c0ea7 | 4172 | % |
2c825956 GM |
4173 | % All done with double columns. |
4174 | \def\enddoublecolumns{% | |
98bf69dc KB |
4175 | % The following penalty ensures that the page builder is exercised |
4176 | % _before_ we change the output routine. This is necessary in the | |
4177 | % following situation: | |
4178 | % | |
4179 | % The last section of the index consists only of a single entry. | |
4180 | % Before this section, \pagetotal is less than \pagegoal, so no | |
4181 | % break occurs before the last section starts. However, the last | |
4182 | % section, consisting of \initial and the single \entry, does not | |
4183 | % fit on the page and has to be broken off. Without the following | |
4184 | % penalty the page builder will not be exercised until \eject | |
4185 | % below, and by that time we'll already have changed the output | |
4186 | % routine to the \balancecolumns version, so the next-to-last | |
4187 | % double-column page will be processed with \balancecolumns, which | |
4188 | % is wrong: The two columns will go to the main vertical list, with | |
4189 | % the broken-off section in the recent contributions. As soon as | |
4190 | % the output routine finishes, TeX starts reconsidering the page | |
4191 | % break. The two columns and the broken-off section both fit on the | |
4192 | % page, because the two columns now take up only half of the page | |
4193 | % goal. When TeX sees \eject from below which follows the final | |
4194 | % section, it invokes the new output routine that we've set after | |
4195 | % \balancecolumns below; \onepageout will try to fit the two columns | |
4196 | % and the final section into the vbox of \pageheight (see | |
4197 | % \pagebody), causing an overfull box. | |
4198 | % | |
4199 | % Note that glue won't work here, because glue does not exercise the | |
4200 | % page builder, unlike penalties (see The TeXbook, pp. 280-281). | |
4201 | \penalty0 | |
4202 | % | |
2c825956 GM |
4203 | \output = {% |
4204 | % Split the last of the double-column material. Leave it on the | |
4205 | % current page, no automatic page break. | |
4206 | \balancecolumns | |
4207 | % | |
4208 | % If we end up splitting too much material for the current page, | |
4209 | % though, there will be another page break right after this \output | |
4210 | % invocation ends. Having called \balancecolumns once, we do not | |
4211 | % want to call it again. Therefore, reset \output to its normal | |
4212 | % definition right away. (We hope \balancecolumns will never be | |
4213 | % called on to balance too much material, but if it is, this makes | |
4214 | % the output somewhat more palatable.) | |
4215 | \global\output = {\onepageout{\pagecontents\PAGE}}% | |
4216 | }% | |
4217 | \eject | |
4218 | \endgroup % started in \begindoublecolumns | |
4219 | % | |
4220 | % \pagegoal was set to the doubled \vsize above, since we restarted | |
4221 | % the current page. We're now back to normal single-column | |
4222 | % typesetting, so reset \pagegoal to the normal \vsize (after the | |
4223 | % \endgroup where \vsize got restored). | |
4224 | \pagegoal = \vsize | |
4225 | } | |
4226 | % | |
4227 | % Called at the end of the double column material. | |
4228 | \def\balancecolumns{% | |
4229 | \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. | |
4230 | \dimen@ = \ht0 | |
4231 | \advance\dimen@ by \topskip | |
4232 | \advance\dimen@ by-\baselineskip | |
4233 | \divide\dimen@ by 2 % target to split to | |
4234 | %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% | |
4235 | \splittopskip = \topskip | |
4236 | % Loop until we get a decent breakpoint. | |
4237 | {% | |
4238 | \vbadness = 10000 | |
4239 | \loop | |
4240 | \global\setbox3 = \copy0 | |
4241 | \global\setbox1 = \vsplit3 to \dimen@ | |
4242 | \ifdim\ht3>\dimen@ | |
4243 | \global\advance\dimen@ by 1pt | |
4244 | \repeat | |
4245 | }% | |
4246 | %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% | |
4247 | \setbox0=\vbox to\dimen@{\unvbox1}% | |
4248 | \setbox2=\vbox to\dimen@{\unvbox3}% | |
4249 | % | |
4250 | \pagesofar | |
4251 | } | |
4252 | \catcode`\@ = \other | |
4253 | ||
4254 | ||
4255 | \message{sectioning,} | |
4256 | % Chapters, sections, etc. | |
4257 | ||
0f9c1975 KB |
4258 | % \unnumberedno is an oxymoron, of course. But we count the unnumbered |
4259 | % sections so that we can refer to them unambiguously in the pdf | |
4260 | % outlines by their "section number". We avoid collisions with chapter | |
4261 | % numbers by starting them at 10000. (If a document ever has 10000 | |
4262 | % chapters, we're in trouble anyway, I'm sure.) | |
4263 | \newcount\unnumberedno \unnumberedno = 10000 | |
2c825956 GM |
4264 | \newcount\chapno |
4265 | \newcount\secno \secno=0 | |
4266 | \newcount\subsecno \subsecno=0 | |
4267 | \newcount\subsubsecno \subsubsecno=0 | |
4268 | ||
4269 | % This counter is funny since it counts through charcodes of letters A, B, ... | |
4270 | \newcount\appendixno \appendixno = `\@ | |
0f9c1975 | 4271 | % |
2c825956 | 4272 | % \def\appendixletter{\char\the\appendixno} |
0f9c1975 KB |
4273 | % We do the following ugly conditional instead of the above simple |
4274 | % construct for the sake of pdftex, which needs the actual | |
2c825956 | 4275 | % letter in the expansion, not just typeset. |
0f9c1975 | 4276 | % |
2c825956 GM |
4277 | \def\appendixletter{% |
4278 | \ifnum\appendixno=`A A% | |
4279 | \else\ifnum\appendixno=`B B% | |
4280 | \else\ifnum\appendixno=`C C% | |
4281 | \else\ifnum\appendixno=`D D% | |
4282 | \else\ifnum\appendixno=`E E% | |
4283 | \else\ifnum\appendixno=`F F% | |
4284 | \else\ifnum\appendixno=`G G% | |
4285 | \else\ifnum\appendixno=`H H% | |
4286 | \else\ifnum\appendixno=`I I% | |
4287 | \else\ifnum\appendixno=`J J% | |
4288 | \else\ifnum\appendixno=`K K% | |
4289 | \else\ifnum\appendixno=`L L% | |
4290 | \else\ifnum\appendixno=`M M% | |
4291 | \else\ifnum\appendixno=`N N% | |
4292 | \else\ifnum\appendixno=`O O% | |
4293 | \else\ifnum\appendixno=`P P% | |
4294 | \else\ifnum\appendixno=`Q Q% | |
4295 | \else\ifnum\appendixno=`R R% | |
4296 | \else\ifnum\appendixno=`S S% | |
4297 | \else\ifnum\appendixno=`T T% | |
4298 | \else\ifnum\appendixno=`U U% | |
4299 | \else\ifnum\appendixno=`V V% | |
4300 | \else\ifnum\appendixno=`W W% | |
4301 | \else\ifnum\appendixno=`X X% | |
4302 | \else\ifnum\appendixno=`Y Y% | |
4303 | \else\ifnum\appendixno=`Z Z% | |
4304 | % The \the is necessary, despite appearances, because \appendixletter is | |
4305 | % expanded while writing the .toc file. \char\appendixno is not | |
4306 | % expandable, thus it is written literally, thus all appendixes come out | |
4307 | % with the same letter (or @) in the toc without it. | |
4308 | \else\char\the\appendixno | |
4309 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi | |
4310 | \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} | |
4311 | ||
4312 | % Each @chapter defines this as the name of the chapter. | |
4313 | % page headings and footings can use it. @section does likewise. | |
0f9c1975 | 4314 | % However, they are not reliable, because we don't use marks. |
2c825956 GM |
4315 | \def\thischapter{} |
4316 | \def\thissection{} | |
4317 | ||
4318 | \newcount\absseclevel % used to calculate proper heading level | |
0f9c1975 | 4319 | \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count |
2c825956 GM |
4320 | |
4321 | % @raisesections: treat @section as chapter, @subsection as section, etc. | |
4322 | \def\raisesections{\global\advance\secbase by -1} | |
4323 | \let\up=\raisesections % original BFox name | |
4324 | ||
4325 | % @lowersections: treat @chapter as section, @section as subsection, etc. | |
4326 | \def\lowersections{\global\advance\secbase by 1} | |
4327 | \let\down=\lowersections % original BFox name | |
4328 | ||
0f9c1975 KB |
4329 | % we only have subsub. |
4330 | \chardef\maxseclevel = 3 | |
4331 | % | |
4332 | % A numbered section within an unnumbered changes to unnumbered too. | |
4333 | % To achive this, remember the "biggest" unnum. sec. we are currently in: | |
4334 | \chardef\unmlevel = \maxseclevel | |
4335 | % | |
4336 | % Trace whether the current chapter is an appendix or not: | |
4337 | % \chapheadtype is "N" or "A", unnumbered chapters are ignored. | |
4338 | \def\chapheadtype{N} | |
4339 | ||
4340 | % Choose a heading macro | |
4341 | % #1 is heading type | |
4342 | % #2 is heading level | |
4343 | % #3 is text for heading | |
4344 | \def\genhead#1#2#3{% | |
4345 | % Compute the abs. sec. level: | |
4346 | \absseclevel=#2 | |
4347 | \advance\absseclevel by \secbase | |
4348 | % Make sure \absseclevel doesn't fall outside the range: | |
4349 | \ifnum \absseclevel < 0 | |
4350 | \absseclevel = 0 | |
2c825956 | 4351 | \else |
0f9c1975 KB |
4352 | \ifnum \absseclevel > 3 |
4353 | \absseclevel = 3 | |
4354 | \fi | |
2c825956 | 4355 | \fi |
0f9c1975 KB |
4356 | % The heading type: |
4357 | \def\headtype{#1}% | |
4358 | \if \headtype U% | |
4359 | \ifnum \absseclevel < \unmlevel | |
4360 | \chardef\unmlevel = \absseclevel | |
4361 | \fi | |
2c825956 | 4362 | \else |
0f9c1975 KB |
4363 | % Check for appendix sections: |
4364 | \ifnum \absseclevel = 0 | |
4365 | \edef\chapheadtype{\headtype}% | |
4366 | \else | |
4367 | \if \headtype A\if \chapheadtype N% | |
4368 | \errmessage{@appendix... within a non-appendix chapter}% | |
4369 | \fi\fi | |
4370 | \fi | |
4371 | % Check for numbered within unnumbered: | |
4372 | \ifnum \absseclevel > \unmlevel | |
4373 | \def\headtype{U}% | |
4374 | \else | |
4375 | \chardef\unmlevel = 3 | |
4376 | \fi | |
2c825956 | 4377 | \fi |
0f9c1975 KB |
4378 | % Now print the heading: |
4379 | \if \headtype U% | |
4380 | \ifcase\absseclevel | |
4381 | \unnumberedzzz{#3}% | |
4382 | \or \unnumberedseczzz{#3}% | |
4383 | \or \unnumberedsubseczzz{#3}% | |
4384 | \or \unnumberedsubsubseczzz{#3}% | |
4385 | \fi | |
2c825956 | 4386 | \else |
0f9c1975 KB |
4387 | \if \headtype A% |
4388 | \ifcase\absseclevel | |
4389 | \appendixzzz{#3}% | |
4390 | \or \appendixsectionzzz{#3}% | |
4391 | \or \appendixsubseczzz{#3}% | |
4392 | \or \appendixsubsubseczzz{#3}% | |
4393 | \fi | |
4394 | \else | |
4395 | \ifcase\absseclevel | |
4396 | \chapterzzz{#3}% | |
4397 | \or \seczzz{#3}% | |
4398 | \or \numberedsubseczzz{#3}% | |
4399 | \or \numberedsubsubseczzz{#3}% | |
4400 | \fi | |
4401 | \fi | |
2c825956 | 4402 | \fi |
0f9c1975 KB |
4403 | \suppressfirstparagraphindent |
4404 | } | |
4405 | ||
4406 | % an interface: | |
4407 | \def\numhead{\genhead N} | |
4408 | \def\apphead{\genhead A} | |
4409 | \def\unnmhead{\genhead U} | |
4410 | ||
4411 | % @chapter, @appendix, @unnumbered. Increment top-level counter, reset | |
4412 | % all lower-level sectioning counters to zero. | |
4413 | % | |
4414 | % Also set \chaplevelprefix, which we prepend to @float sequence numbers | |
4415 | % (e.g., figures), q.v. By default (before any chapter), that is empty. | |
4416 | \let\chaplevelprefix = \empty | |
4417 | % | |
4418 | \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz | |
4419 | \def\chapterzzz#1{% | |
4420 | % section resetting is \global in case the chapter is in a group, such | |
4421 | % as an @include file. | |
4422 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 | |
4423 | \global\advance\chapno by 1 | |
4424 | % | |
4425 | % Used for \float. | |
4426 | \gdef\chaplevelprefix{\the\chapno.}% | |
4427 | \resetallfloatnos | |
4428 | % | |
4429 | \message{\putwordChapter\space \the\chapno}% | |
4430 | % | |
4431 | % Write the actual heading. | |
4432 | \chapmacro{#1}{Ynumbered}{\the\chapno}% | |
4433 | % | |
4434 | % So @section and the like are numbered underneath this chapter. | |
4435 | \global\let\section = \numberedsec | |
4436 | \global\let\subsection = \numberedsubsec | |
4437 | \global\let\subsubsection = \numberedsubsubsec | |
4438 | } | |
4439 | ||
4440 | \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz | |
4441 | \def\appendixzzz#1{% | |
4442 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 | |
4443 | \global\advance\appendixno by 1 | |
4444 | \gdef\chaplevelprefix{\appendixletter.}% | |
4445 | \resetallfloatnos | |
4446 | % | |
4447 | \def\appendixnum{\putwordAppendix\space \appendixletter}% | |
4448 | \message{\appendixnum}% | |
4449 | % | |
4450 | \chapmacro{#1}{Yappendix}{\appendixletter}% | |
4451 | % | |
4452 | \global\let\section = \appendixsec | |
4453 | \global\let\subsection = \appendixsubsec | |
4454 | \global\let\subsubsection = \appendixsubsubsec | |
2c825956 GM |
4455 | } |
4456 | ||
0f9c1975 KB |
4457 | \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz |
4458 | \def\unnumberedzzz#1{% | |
4459 | \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 | |
4460 | \global\advance\unnumberedno by 1 | |
4461 | % | |
4462 | % Since an unnumbered has no number, no prefix for figures. | |
4463 | \global\let\chaplevelprefix = \empty | |
4464 | \resetallfloatnos | |
4465 | % | |
4466 | % This used to be simply \message{#1}, but TeX fully expands the | |
4467 | % argument to \message. Therefore, if #1 contained @-commands, TeX | |
4468 | % expanded them. For example, in `@unnumbered The @cite{Book}', TeX | |
4469 | % expanded @cite (which turns out to cause errors because \cite is meant | |
4470 | % to be executed, not expanded). | |
4471 | % | |
4472 | % Anyway, we don't want the fully-expanded definition of @cite to appear | |
4473 | % as a result of the \message, we just want `@cite' itself. We use | |
4474 | % \the<toks register> to achieve this: TeX expands \the<toks> only once, | |
4475 | % simply yielding the contents of <toks register>. (We also do this for | |
4476 | % the toc entries.) | |
4477 | \toks0 = {#1}% | |
4478 | \message{(\the\toks0)}% | |
4479 | % | |
4480 | \chapmacro{#1}{Ynothing}{\the\unnumberedno}% | |
4481 | % | |
4482 | \global\let\section = \unnumberedsec | |
4483 | \global\let\subsection = \unnumberedsubsec | |
4484 | \global\let\subsubsection = \unnumberedsubsubsec | |
2c825956 GM |
4485 | } |
4486 | ||
4487 | % @centerchap is like @unnumbered, but the heading is centered. | |
0f9c1975 KB |
4488 | \outer\parseargdef\centerchap{% |
4489 | % Well, we could do the following in a group, but that would break | |
4490 | % an assumption that \chapmacro is called at the outermost level. | |
4491 | % Thus we are safer this way: --kasal, 24feb04 | |
4492 | \let\centerparametersmaybe = \centerparameters | |
4493 | \unnmhead0{#1}% | |
4494 | \let\centerparametersmaybe = \relax | |
4495 | } | |
2c825956 GM |
4496 | |
4497 | % @top is like @unnumbered. | |
0f9c1975 | 4498 | \let\top\unnumbered |
2c825956 GM |
4499 | |
4500 | % Sections. | |
0f9c1975 KB |
4501 | \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz |
4502 | \def\seczzz#1{% | |
4503 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 | |
4504 | \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% | |
4505 | } | |
4506 | ||
4507 | \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz | |
4508 | \def\appendixsectionzzz#1{% | |
4509 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 | |
4510 | \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% | |
4511 | } | |
4512 | \let\appendixsec\appendixsection | |
4513 | ||
4514 | \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz | |
4515 | \def\unnumberedseczzz#1{% | |
4516 | \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 | |
4517 | \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% | |
2c825956 GM |
4518 | } |
4519 | ||
4520 | % Subsections. | |
0f9c1975 KB |
4521 | \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz |
4522 | \def\numberedsubseczzz#1{% | |
4523 | \global\subsubsecno=0 \global\advance\subsecno by 1 | |
4524 | \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% | |
4525 | } | |
4526 | ||
4527 | \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz | |
4528 | \def\appendixsubseczzz#1{% | |
4529 | \global\subsubsecno=0 \global\advance\subsecno by 1 | |
4530 | \sectionheading{#1}{subsec}{Yappendix}% | |
4531 | {\appendixletter.\the\secno.\the\subsecno}% | |
4532 | } | |
4533 | ||
4534 | \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz | |
4535 | \def\unnumberedsubseczzz#1{% | |
4536 | \global\subsubsecno=0 \global\advance\subsecno by 1 | |
4537 | \sectionheading{#1}{subsec}{Ynothing}% | |
4538 | {\the\unnumberedno.\the\secno.\the\subsecno}% | |
2c825956 GM |
4539 | } |
4540 | ||
4541 | % Subsubsections. | |
0f9c1975 KB |
4542 | \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz |
4543 | \def\numberedsubsubseczzz#1{% | |
4544 | \global\advance\subsubsecno by 1 | |
4545 | \sectionheading{#1}{subsubsec}{Ynumbered}% | |
4546 | {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% | |
4547 | } | |
4548 | ||
4549 | \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz | |
4550 | \def\appendixsubsubseczzz#1{% | |
4551 | \global\advance\subsubsecno by 1 | |
4552 | \sectionheading{#1}{subsubsec}{Yappendix}% | |
4553 | {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% | |
4554 | } | |
4555 | ||
4556 | \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz | |
4557 | \def\unnumberedsubsubseczzz#1{% | |
4558 | \global\advance\subsubsecno by 1 | |
4559 | \sectionheading{#1}{subsubsec}{Ynothing}% | |
4560 | {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% | |
4561 | } | |
2c825956 GM |
4562 | |
4563 | % These macros control what the section commands do, according | |
4564 | % to what kind of chapter we are in (ordinary, appendix, or unnumbered). | |
4565 | % Define them by default for a numbered chapter. | |
0f9c1975 KB |
4566 | \let\section = \numberedsec |
4567 | \let\subsection = \numberedsubsec | |
4568 | \let\subsubsection = \numberedsubsubsec | |
2c825956 GM |
4569 | |
4570 | % Define @majorheading, @heading and @subheading | |
4571 | ||
4572 | % NOTE on use of \vbox for chapter headings, section headings, and such: | |
4573 | % 1) We use \vbox rather than the earlier \line to permit | |
4574 | % overlong headings to fold. | |
4575 | % 2) \hyphenpenalty is set to 10000 because hyphenation in a | |
4576 | % heading is obnoxious; this forbids it. | |
4577 | % 3) Likewise, headings look best if no \parindent is used, and | |
4578 | % if justification is not attempted. Hence \raggedright. | |
4579 | ||
4580 | ||
0f9c1975 KB |
4581 | \def\majorheading{% |
4582 | {\advance\chapheadingskip by 10pt \chapbreak }% | |
4583 | \parsearg\chapheadingzzz | |
4584 | } | |
2c825956 | 4585 | |
0f9c1975 KB |
4586 | \def\chapheading{\chapbreak \parsearg\chapheadingzzz} |
4587 | \def\chapheadingzzz#1{% | |
4588 | {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 | |
4589 | \parindent=0pt\raggedright | |
4590 | \rm #1\hfill}}% | |
4591 | \bigskip \par\penalty 200\relax | |
4592 | \suppressfirstparagraphindent | |
4593 | } | |
2c825956 GM |
4594 | |
4595 | % @heading, @subheading, @subsubheading. | |
0f9c1975 KB |
4596 | \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} |
4597 | \suppressfirstparagraphindent} | |
4598 | \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} | |
4599 | \suppressfirstparagraphindent} | |
4600 | \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} | |
4601 | \suppressfirstparagraphindent} | |
2c825956 GM |
4602 | |
4603 | % These macros generate a chapter, section, etc. heading only | |
4604 | % (including whitespace, linebreaking, etc. around it), | |
4605 | % given all the information in convenient, parsed form. | |
4606 | ||
4607 | %%% Args are the skip and penalty (usually negative) | |
4608 | \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} | |
4609 | ||
2c825956 GM |
4610 | %%% Define plain chapter starts, and page on/off switching for it |
4611 | % Parameter controlling skip before chapter headings (if needed) | |
4612 | ||
4613 | \newskip\chapheadingskip | |
4614 | ||
4615 | \def\chapbreak{\dobreak \chapheadingskip {-4000}} | |
4616 | \def\chappager{\par\vfill\supereject} | |
4617 | \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} | |
4618 | ||
4619 | \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} | |
4620 | ||
4621 | \def\CHAPPAGoff{% | |
4622 | \global\let\contentsalignmacro = \chappager | |
4623 | \global\let\pchapsepmacro=\chapbreak | |
4624 | \global\let\pagealignmacro=\chappager} | |
4625 | ||
4626 | \def\CHAPPAGon{% | |
4627 | \global\let\contentsalignmacro = \chappager | |
4628 | \global\let\pchapsepmacro=\chappager | |
4629 | \global\let\pagealignmacro=\chappager | |
4630 | \global\def\HEADINGSon{\HEADINGSsingle}} | |
4631 | ||
0f9c1975 | 4632 | \def\CHAPPAGodd{% |
2c825956 GM |
4633 | \global\let\contentsalignmacro = \chapoddpage |
4634 | \global\let\pchapsepmacro=\chapoddpage | |
4635 | \global\let\pagealignmacro=\chapoddpage | |
4636 | \global\def\HEADINGSon{\HEADINGSdouble}} | |
4637 | ||
4638 | \CHAPPAGon | |
4639 | ||
0f9c1975 KB |
4640 | % Chapter opening. |
4641 | % | |
4642 | % #1 is the text, #2 is the section type (Ynumbered, Ynothing, | |
4643 | % Yappendix, Yomitfromtoc), #3 the chapter number. | |
4644 | % | |
4645 | % To test against our argument. | |
4646 | \def\Ynothingkeyword{Ynothing} | |
4647 | \def\Yomitfromtockeyword{Yomitfromtoc} | |
4648 | \def\Yappendixkeyword{Yappendix} | |
4649 | % | |
4650 | \def\chapmacro#1#2#3{% | |
2c825956 GM |
4651 | \pchapsepmacro |
4652 | {% | |
4653 | \chapfonts \rm | |
0f9c1975 KB |
4654 | % |
4655 | % Have to define \thissection before calling \donoderef, because the | |
4656 | % xref code eventually uses it. On the other hand, it has to be called | |
4657 | % after \pchapsepmacro, or the headline will change too soon. | |
4658 | \gdef\thissection{#1}% | |
4659 | \gdef\thischaptername{#1}% | |
4660 | % | |
4661 | % Only insert the separating space if we have a chapter/appendix | |
4662 | % number, and don't print the unnumbered ``number''. | |
4663 | \def\temptype{#2}% | |
4664 | \ifx\temptype\Ynothingkeyword | |
4665 | \setbox0 = \hbox{}% | |
4666 | \def\toctype{unnchap}% | |
d61cd812 | 4667 | \gdef\thischapternum{}% |
0f9c1975 KB |
4668 | \gdef\thischapter{#1}% |
4669 | \else\ifx\temptype\Yomitfromtockeyword | |
4670 | \setbox0 = \hbox{}% contents like unnumbered, but no toc entry | |
4671 | \def\toctype{omit}% | |
d61cd812 | 4672 | \gdef\thischapternum{}% |
0f9c1975 KB |
4673 | \gdef\thischapter{}% |
4674 | \else\ifx\temptype\Yappendixkeyword | |
4675 | \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% | |
4676 | \def\toctype{app}% | |
d61cd812 | 4677 | \xdef\thischapternum{\appendixletter}% |
0f9c1975 KB |
4678 | % We don't substitute the actual chapter name into \thischapter |
4679 | % because we don't want its macros evaluated now. And we don't | |
4680 | % use \thissection because that changes with each section. | |
4681 | % | |
4682 | \xdef\thischapter{\putwordAppendix{} \appendixletter: | |
4683 | \noexpand\thischaptername}% | |
4684 | \else | |
4685 | \setbox0 = \hbox{#3\enspace}% | |
4686 | \def\toctype{numchap}% | |
d61cd812 | 4687 | \xdef\thischapternum{\the\chapno}% |
0f9c1975 KB |
4688 | \xdef\thischapter{\putwordChapter{} \the\chapno: |
4689 | \noexpand\thischaptername}% | |
4690 | \fi\fi\fi | |
4691 | % | |
4692 | % Write the toc entry for this chapter. Must come before the | |
4693 | % \donoderef, because we include the current node name in the toc | |
4694 | % entry, and \donoderef resets it to empty. | |
4695 | \writetocentry{\toctype}{#1}{#3}% | |
4696 | % | |
4697 | % For pdftex, we have to write out the node definition (aka, make | |
4698 | % the pdfdest) after any page break, but before the actual text has | |
4699 | % been typeset. If the destination for the pdf outline is after the | |
4700 | % text, then jumping from the outline may wind up with the text not | |
4701 | % being visible, for instance under high magnification. | |
4702 | \donoderef{#2}% | |
4703 | % | |
4704 | % Typeset the actual heading. | |
2c825956 | 4705 | \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright |
0f9c1975 | 4706 | \hangindent=\wd0 \centerparametersmaybe |
2c825956 GM |
4707 | \unhbox0 #1\par}% |
4708 | }% | |
4709 | \nobreak\bigskip % no page break after a chapter title | |
4710 | \nobreak | |
4711 | } | |
4712 | ||
2c825956 GM |
4713 | % @centerchap -- centered and unnumbered. |
4714 | \let\centerparametersmaybe = \relax | |
0f9c1975 KB |
4715 | \def\centerparameters{% |
4716 | \advance\rightskip by 3\rightskip | |
4717 | \leftskip = \rightskip | |
4718 | \parfillskip = 0pt | |
4719 | } | |
2c825956 | 4720 | |
2c825956 | 4721 | |
0f9c1975 KB |
4722 | % I don't think this chapter style is supported any more, so I'm not |
4723 | % updating it with the new noderef stuff. We'll see. --karl, 11aug03. | |
4724 | % | |
4725 | \def\setchapterstyle #1 {\csname CHAPF#1\endcsname} | |
4726 | % | |
2c825956 GM |
4727 | \def\unnchfopen #1{% |
4728 | \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 | |
4729 | \parindent=0pt\raggedright | |
4730 | \rm #1\hfill}}\bigskip \par\nobreak | |
4731 | } | |
2c825956 GM |
4732 | \def\chfopen #1#2{\chapoddpage {\chapfonts |
4733 | \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% | |
4734 | \par\penalty 5000 % | |
4735 | } | |
2c825956 GM |
4736 | \def\centerchfopen #1{% |
4737 | \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 | |
4738 | \parindent=0pt | |
4739 | \hfill {\rm #1}\hfill}}\bigskip \par\nobreak | |
4740 | } | |
0f9c1975 KB |
4741 | \def\CHAPFopen{% |
4742 | \global\let\chapmacro=\chfopen | |
4743 | \global\let\centerchapmacro=\centerchfopen} | |
2c825956 | 4744 | |
2c825956 | 4745 | |
0f9c1975 KB |
4746 | % Section titles. These macros combine the section number parts and |
4747 | % call the generic \sectionheading to do the printing. | |
4748 | % | |
2c825956 | 4749 | \newskip\secheadingskip |
0f9c1975 | 4750 | \def\secheadingbreak{\dobreak \secheadingskip{-1000}} |
2c825956 GM |
4751 | |
4752 | % Subsection titles. | |
0f9c1975 KB |
4753 | \newskip\subsecheadingskip |
4754 | \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} | |
2c825956 GM |
4755 | |
4756 | % Subsubsection titles. | |
0f9c1975 KB |
4757 | \def\subsubsecheadingskip{\subsecheadingskip} |
4758 | \def\subsubsecheadingbreak{\subsecheadingbreak} | |
2c825956 GM |
4759 | |
4760 | ||
0f9c1975 | 4761 | % Print any size, any type, section title. |
2c825956 | 4762 | % |
0f9c1975 KB |
4763 | % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is |
4764 | % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the | |
4765 | % section number. | |
4766 | % | |
4767 | \def\sectionheading#1#2#3#4{% | |
2c825956 GM |
4768 | {% |
4769 | % Switch to the right set of fonts. | |
0f9c1975 KB |
4770 | \csname #2fonts\endcsname \rm |
4771 | % | |
4772 | % Insert space above the heading. | |
4773 | \csname #2headingbreak\endcsname | |
4774 | % | |
4775 | % Only insert the space after the number if we have a section number. | |
4776 | \def\sectionlevel{#2}% | |
4777 | \def\temptype{#3}% | |
4778 | % | |
4779 | \ifx\temptype\Ynothingkeyword | |
4780 | \setbox0 = \hbox{}% | |
4781 | \def\toctype{unn}% | |
4782 | \gdef\thissection{#1}% | |
4783 | \else\ifx\temptype\Yomitfromtockeyword | |
4784 | % for @headings -- no section number, don't include in toc, | |
4785 | % and don't redefine \thissection. | |
4786 | \setbox0 = \hbox{}% | |
4787 | \def\toctype{omit}% | |
4788 | \let\sectionlevel=\empty | |
4789 | \else\ifx\temptype\Yappendixkeyword | |
4790 | \setbox0 = \hbox{#4\enspace}% | |
4791 | \def\toctype{app}% | |
4792 | \gdef\thissection{#1}% | |
4793 | \else | |
4794 | \setbox0 = \hbox{#4\enspace}% | |
4795 | \def\toctype{num}% | |
4796 | \gdef\thissection{#1}% | |
4797 | \fi\fi\fi | |
4798 | % | |
4799 | % Write the toc entry (before \donoderef). See comments in \chapmacro. | |
4800 | \writetocentry{\toctype\sectionlevel}{#1}{#4}% | |
2c825956 | 4801 | % |
0f9c1975 KB |
4802 | % Write the node reference (= pdf destination for pdftex). |
4803 | % Again, see comments in \chapmacro. | |
4804 | \donoderef{#3}% | |
2c825956 | 4805 | % |
0f9c1975 KB |
4806 | % Interline glue will be inserted when the vbox is completed. |
4807 | % That glue will be a valid breakpoint for the page, since it'll be | |
4808 | % preceded by a whatsit (usually from the \donoderef, or from the | |
4809 | % \writetocentry if there was no node). We don't want to allow that | |
4810 | % break, since then the whatsits could end up on page n while the | |
4811 | % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000. | |
4812 | \nobreak | |
4813 | % | |
4814 | % Output the actual section heading. | |
2c825956 | 4815 | \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright |
0f9c1975 KB |
4816 | \hangindent=\wd0 % zero if no section number |
4817 | \unhbox0 #1}% | |
2c825956 | 4818 | }% |
0f9c1975 KB |
4819 | % Add extra space after the heading -- half of whatever came above it. |
4820 | % Don't allow stretch, though. | |
4821 | \kern .5 \csname #2headingskip\endcsname | |
4822 | % | |
4823 | % Do not let the kern be a potential breakpoint, as it would be if it | |
4824 | % was followed by glue. | |
4825 | \nobreak | |
4826 | % | |
4827 | % We'll almost certainly start a paragraph next, so don't let that | |
4828 | % glue accumulate. (Not a breakpoint because it's preceded by a | |
4829 | % discardable item.) | |
4830 | \vskip-\parskip | |
4831 | % | |
4832 | % This is purely so the last item on the list is a known \penalty > | |
4833 | % 10000. This is so \startdefun can avoid allowing breakpoints after | |
4834 | % section headings. Otherwise, it would insert a valid breakpoint between: | |
4835 | % | |
4836 | % @section sec-whatever | |
4837 | % @deffn def-whatever | |
4838 | \penalty 10001 | |
2c825956 GM |
4839 | } |
4840 | ||
4841 | ||
4842 | \message{toc,} | |
4843 | % Table of contents. | |
4844 | \newwrite\tocfile | |
4845 | ||
4846 | % Write an entry to the toc file, opening it if necessary. | |
0f9c1975 KB |
4847 | % Called from @chapter, etc. |
4848 | % | |
4849 | % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} | |
4850 | % We append the current node name (if any) and page number as additional | |
4851 | % arguments for the \{chap,sec,...}entry macros which will eventually | |
4852 | % read this. The node name is used in the pdf outlines as the | |
4853 | % destination to jump to. | |
2c825956 | 4854 | % |
0f9c1975 KB |
4855 | % We open the .toc file for writing here instead of at @setfilename (or |
4856 | % any other fixed time) so that @contents can be anywhere in the document. | |
4857 | % But if #1 is `omit', then we don't do anything. This is used for the | |
4858 | % table of contents chapter openings themselves. | |
2c825956 GM |
4859 | % |
4860 | \newif\iftocfileopened | |
0f9c1975 KB |
4861 | \def\omitkeyword{omit}% |
4862 | % | |
4863 | \def\writetocentry#1#2#3{% | |
4864 | \edef\writetoctype{#1}% | |
4865 | \ifx\writetoctype\omitkeyword \else | |
4866 | \iftocfileopened\else | |
4867 | \immediate\openout\tocfile = \jobname.toc | |
4868 | \global\tocfileopenedtrue | |
4869 | \fi | |
4870 | % | |
4871 | \iflinks | |
4872 | {\atdummies | |
4873 | \edef\temp{% | |
4874 | \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}% | |
4875 | \temp | |
4876 | }% | |
4877 | \fi | |
2c825956 | 4878 | \fi |
08b16a02 | 4879 | % |
0f9c1975 KB |
4880 | % Tell \shipout to create a pdf destination on each page, if we're |
4881 | % writing pdf. These are used in the table of contents. We can't | |
4882 | % just write one on every page because the title pages are numbered | |
4883 | % 1 and 2 (the page numbers aren't printed), and so are the first | |
4884 | % two pages of the document. Thus, we'd have two destinations named | |
4885 | % `1', and two named `2'. | |
4886 | \ifpdf \global\pdfmakepagedesttrue \fi | |
4887 | } | |
4888 | ||
4889 | ||
4890 | % These characters do not print properly in the Computer Modern roman | |
4891 | % fonts, so we must take special care. This is more or less redundant | |
4892 | % with the Texinfo input format setup at the end of this file. | |
4893 | % | |
4894 | \def\activecatcodes{% | |
4895 | \catcode`\"=\active | |
4896 | \catcode`\$=\active | |
4897 | \catcode`\<=\active | |
4898 | \catcode`\>=\active | |
4899 | \catcode`\\=\active | |
4900 | \catcode`\^=\active | |
4901 | \catcode`\_=\active | |
4902 | \catcode`\|=\active | |
4903 | \catcode`\~=\active | |
4904 | } | |
4905 | ||
4906 | ||
4907 | % Read the toc file, which is essentially Texinfo input. | |
4908 | \def\readtocfile{% | |
4909 | \setupdatafile | |
4910 | \activecatcodes | |
4911 | \input \jobname.toc | |
2c825956 GM |
4912 | } |
4913 | ||
4914 | \newskip\contentsrightmargin \contentsrightmargin=1in | |
4915 | \newcount\savepageno | |
4916 | \newcount\lastnegativepageno \lastnegativepageno = -1 | |
4917 | ||
0f9c1975 | 4918 | % Prepare to read what we've written to \tocfile. |
2c825956 GM |
4919 | % |
4920 | \def\startcontents#1{% | |
0f9c1975 KB |
4921 | % If @setchapternewpage on, and @headings double, the contents should |
4922 | % start on an odd page, unlike chapters. Thus, we maintain | |
4923 | % \contentsalignmacro in parallel with \pagealignmacro. | |
4924 | % From: Torbjorn Granlund <tege@matematik.su.se> | |
4925 | \contentsalignmacro | |
4926 | \immediate\closeout\tocfile | |
4927 | % | |
4928 | % Don't need to put `Contents' or `Short Contents' in the headline. | |
4929 | % It is abundantly clear what they are. | |
4930 | \def\thischapter{}% | |
4931 | \chapmacro{#1}{Yomitfromtoc}{}% | |
4932 | % | |
4933 | \savepageno = \pageno | |
4934 | \begingroup % Set up to handle contents files properly. | |
4935 | \raggedbottom % Worry more about breakpoints than the bottom. | |
4936 | \advance\hsize by -\contentsrightmargin % Don't use the full line length. | |
4937 | % | |
4938 | % Roman numerals for page numbers. | |
4939 | \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi | |
2c825956 GM |
4940 | } |
4941 | ||
4942 | ||
4943 | % Normal (long) toc. | |
4944 | \def\contents{% | |
0f9c1975 KB |
4945 | \startcontents{\putwordTOC}% |
4946 | \openin 1 \jobname.toc | |
4947 | \ifeof 1 \else | |
4948 | \readtocfile | |
4949 | \fi | |
4950 | \vfill \eject | |
4951 | \contentsalignmacro % in case @setchapternewpage odd is in effect | |
4952 | \ifeof 1 \else | |
4953 | \pdfmakeoutlines | |
4954 | \fi | |
4955 | \closein 1 | |
4956 | \endgroup | |
4957 | \lastnegativepageno = \pageno | |
4958 | \global\pageno = \savepageno | |
2c825956 GM |
4959 | } |
4960 | ||
4961 | % And just the chapters. | |
4962 | \def\summarycontents{% | |
0f9c1975 KB |
4963 | \startcontents{\putwordShortTOC}% |
4964 | % | |
4965 | \let\numchapentry = \shortchapentry | |
4966 | \let\appentry = \shortchapentry | |
4967 | \let\unnchapentry = \shortunnchapentry | |
4968 | % We want a true roman here for the page numbers. | |
4969 | \secfonts | |
4970 | \let\rm=\shortcontrm \let\bf=\shortcontbf | |
4971 | \let\sl=\shortcontsl \let\tt=\shortconttt | |
4972 | \rm | |
4973 | \hyphenpenalty = 10000 | |
4974 | \advance\baselineskip by 1pt % Open it up a little. | |
4975 | \def\numsecentry##1##2##3##4{} | |
4976 | \let\appsecentry = \numsecentry | |
4977 | \let\unnsecentry = \numsecentry | |
4978 | \let\numsubsecentry = \numsecentry | |
4979 | \let\appsubsecentry = \numsecentry | |
4980 | \let\unnsubsecentry = \numsecentry | |
4981 | \let\numsubsubsecentry = \numsecentry | |
4982 | \let\appsubsubsecentry = \numsecentry | |
4983 | \let\unnsubsubsecentry = \numsecentry | |
4984 | \openin 1 \jobname.toc | |
4985 | \ifeof 1 \else | |
4986 | \readtocfile | |
4987 | \fi | |
4988 | \closein 1 | |
4989 | \vfill \eject | |
4990 | \contentsalignmacro % in case @setchapternewpage odd is in effect | |
4991 | \endgroup | |
4992 | \lastnegativepageno = \pageno | |
4993 | \global\pageno = \savepageno | |
4994 | } | |
4995 | \let\shortcontents = \summarycontents | |
2c825956 | 4996 | |
0f9c1975 KB |
4997 | % Typeset the label for a chapter or appendix for the short contents. |
4998 | % The arg is, e.g., `A' for an appendix, or `3' for a chapter. | |
4999 | % | |
5000 | \def\shortchaplabel#1{% | |
5001 | % This space should be enough, since a single number is .5em, and the | |
5002 | % widest letter (M) is 1em, at least in the Computer Modern fonts. | |
5003 | % But use \hss just in case. | |
5004 | % (This space doesn't include the extra space that gets added after | |
5005 | % the label; that gets put in by \shortchapentry above.) | |
5006 | % | |
5007 | % We'd like to right-justify chapter numbers, but that looks strange | |
5008 | % with appendix letters. And right-justifying numbers and | |
5009 | % left-justifying letters looks strange when there is less than 10 | |
5010 | % chapters. Have to read the whole toc once to know how many chapters | |
5011 | % there are before deciding ... | |
5012 | \hbox to 1em{#1\hss}% | |
5013 | } | |
2c825956 GM |
5014 | |
5015 | % These macros generate individual entries in the table of contents. | |
5016 | % The first argument is the chapter or section name. | |
5017 | % The last argument is the page number. | |
5018 | % The arguments in between are the chapter number, section number, ... | |
5019 | ||
08b16a02 | 5020 | % Chapters, in the main contents. |
0f9c1975 | 5021 | \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} |
08b16a02 PJ |
5022 | % |
5023 | % Chapters, in the short toc. | |
5024 | % See comments in \dochapentry re vbox and related settings. | |
0f9c1975 KB |
5025 | \def\shortchapentry#1#2#3#4{% |
5026 | \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% | |
2c825956 GM |
5027 | } |
5028 | ||
08b16a02 | 5029 | % Appendices, in the main contents. |
0f9c1975 | 5030 | % Need the word Appendix, and a fixed-size box. |
08b16a02 | 5031 | % |
0f9c1975 KB |
5032 | \def\appendixbox#1{% |
5033 | % We use M since it's probably the widest letter. | |
5034 | \setbox0 = \hbox{\putwordAppendix{} M}% | |
5035 | \hbox to \wd0{\putwordAppendix{} #1\hss}} | |
2c825956 | 5036 | % |
0f9c1975 | 5037 | \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} |
2c825956 | 5038 | |
08b16a02 | 5039 | % Unnumbered chapters. |
0f9c1975 KB |
5040 | \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} |
5041 | \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} | |
2c825956 GM |
5042 | |
5043 | % Sections. | |
0f9c1975 KB |
5044 | \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} |
5045 | \let\appsecentry=\numsecentry | |
5046 | \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} | |
2c825956 GM |
5047 | |
5048 | % Subsections. | |
0f9c1975 KB |
5049 | \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} |
5050 | \let\appsubsecentry=\numsubsecentry | |
5051 | \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} | |
2c825956 GM |
5052 | |
5053 | % And subsubsections. | |
0f9c1975 KB |
5054 | \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} |
5055 | \let\appsubsubsecentry=\numsubsubsecentry | |
5056 | \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} | |
2c825956 GM |
5057 | |
5058 | % This parameter controls the indentation of the various levels. | |
0f9c1975 KB |
5059 | % Same as \defaultparindent. |
5060 | \newdimen\tocindent \tocindent = 15pt | |
2c825956 GM |
5061 | |
5062 | % Now for the actual typesetting. In all these, #1 is the text and #2 is the | |
5063 | % page number. | |
5064 | % | |
5065 | % If the toc has to be broken over pages, we want it to be at chapters | |
5066 | % if at all possible; hence the \penalty. | |
5067 | \def\dochapentry#1#2{% | |
5068 | \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip | |
5069 | \begingroup | |
5070 | \chapentryfonts | |
5071 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | |
5072 | \endgroup | |
5073 | \nobreak\vskip .25\baselineskip plus.1\baselineskip | |
5074 | } | |
5075 | ||
5076 | \def\dosecentry#1#2{\begingroup | |
5077 | \secentryfonts \leftskip=\tocindent | |
5078 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | |
5079 | \endgroup} | |
5080 | ||
5081 | \def\dosubsecentry#1#2{\begingroup | |
5082 | \subsecentryfonts \leftskip=2\tocindent | |
5083 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | |
5084 | \endgroup} | |
5085 | ||
5086 | \def\dosubsubsecentry#1#2{\begingroup | |
5087 | \subsubsecentryfonts \leftskip=3\tocindent | |
5088 | \tocentry{#1}{\dopageno\bgroup#2\egroup}% | |
5089 | \endgroup} | |
5090 | ||
0f9c1975 KB |
5091 | % We use the same \entry macro as for the index entries. |
5092 | \let\tocentry = \entry | |
2c825956 GM |
5093 | |
5094 | % Space between chapter (or whatever) number and the title. | |
5095 | \def\labelspace{\hskip1em \relax} | |
5096 | ||
5097 | \def\dopageno#1{{\rm #1}} | |
5098 | \def\doshortpageno#1{{\rm #1}} | |
5099 | ||
5100 | \def\chapentryfonts{\secfonts \rm} | |
5101 | \def\secentryfonts{\textfonts} | |
0f9c1975 KB |
5102 | \def\subsecentryfonts{\textfonts} |
5103 | \def\subsubsecentryfonts{\textfonts} | |
2c825956 GM |
5104 | |
5105 | ||
5106 | \message{environments,} | |
5107 | % @foo ... @end foo. | |
5108 | ||
08b16a02 | 5109 | % @point{}, @result{}, @expansion{}, @print{}, @equiv{}. |
177c0ea7 | 5110 | % |
2c825956 GM |
5111 | % Since these characters are used in examples, it should be an even number of |
5112 | % \tt widths. Each \tt character is 1en, so two makes it 1em. | |
08b16a02 | 5113 | % |
2c825956 GM |
5114 | \def\point{$\star$} |
5115 | \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} | |
5116 | \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} | |
5117 | \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} | |
5118 | \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} | |
5119 | ||
08b16a02 | 5120 | % The @error{} command. |
2c825956 | 5121 | % Adapted from the TeXbook's \boxit. |
177c0ea7 | 5122 | % |
08b16a02 PJ |
5123 | \newbox\errorbox |
5124 | % | |
2c825956 GM |
5125 | {\tentt \global\dimen0 = 3em}% Width of the box. |
5126 | \dimen2 = .55pt % Thickness of rules | |
5127 | % The text. (`r' is open on the right, `e' somewhat less so on the left.) | |
08e5fcf1 | 5128 | \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt} |
08b16a02 | 5129 | % |
0f9c1975 | 5130 | \setbox\errorbox=\hbox to \dimen0{\hfil |
2c825956 GM |
5131 | \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. |
5132 | \advance\hsize by -2\dimen2 % Rules. | |
0f9c1975 | 5133 | \vbox{% |
2c825956 GM |
5134 | \hrule height\dimen2 |
5135 | \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. | |
5136 | \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. | |
5137 | \kern3pt\vrule width\dimen2}% Space to right. | |
5138 | \hrule height\dimen2} | |
5139 | \hfil} | |
08b16a02 | 5140 | % |
2c825956 GM |
5141 | \def\error{\leavevmode\lower.7ex\copy\errorbox} |
5142 | ||
5143 | % @tex ... @end tex escapes into raw Tex temporarily. | |
5144 | % One exception: @ is still an escape character, so that @end tex works. | |
5145 | % But \@ or @@ will get a plain tex @ character. | |
5146 | ||
0f9c1975 | 5147 | \envdef\tex{% |
2c825956 GM |
5148 | \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 |
5149 | \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 | |
0f9c1975 | 5150 | \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie |
2c825956 | 5151 | \catcode `\%=14 |
0f9c1975 KB |
5152 | \catcode `\+=\other |
5153 | \catcode `\"=\other | |
5154 | \catcode `\|=\other | |
5155 | \catcode `\<=\other | |
5156 | \catcode `\>=\other | |
2c825956 GM |
5157 | \escapechar=`\\ |
5158 | % | |
5159 | \let\b=\ptexb | |
5160 | \let\bullet=\ptexbullet | |
5161 | \let\c=\ptexc | |
5162 | \let\,=\ptexcomma | |
5163 | \let\.=\ptexdot | |
5164 | \let\dots=\ptexdots | |
5165 | \let\equiv=\ptexequiv | |
5166 | \let\!=\ptexexclam | |
5167 | \let\i=\ptexi | |
0f9c1975 KB |
5168 | \let\indent=\ptexindent |
5169 | \let\noindent=\ptexnoindent | |
2c825956 GM |
5170 | \let\{=\ptexlbrace |
5171 | \let\+=\tabalign | |
5172 | \let\}=\ptexrbrace | |
0f9c1975 | 5173 | \let\/=\ptexslash |
2c825956 GM |
5174 | \let\*=\ptexstar |
5175 | \let\t=\ptext | |
0f9c1975 | 5176 | \let\frenchspacing=\plainfrenchspacing |
2c825956 GM |
5177 | % |
5178 | \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% | |
5179 | \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% | |
5180 | \def\@{@}% | |
0f9c1975 KB |
5181 | } |
5182 | % There is no need to define \Etex. | |
2c825956 | 5183 | |
08b16a02 | 5184 | % Define @lisp ... @end lisp. |
0f9c1975 | 5185 | % @lisp environment forms a group so it can rebind things, |
08b16a02 | 5186 | % including the definition of @end lisp (which normally is erroneous). |
2c825956 GM |
5187 | |
5188 | % Amount to narrow the margins by for @lisp. | |
5189 | \newskip\lispnarrowing \lispnarrowing=0.4in | |
5190 | ||
5191 | % This is the definition that ^^M gets inside @lisp, @example, and other | |
5192 | % such environments. \null is better than a space, since it doesn't | |
5193 | % have any width. | |
5194 | \def\lisppar{\null\endgraf} | |
5195 | ||
2c825956 GM |
5196 | % This space is always present above and below environments. |
5197 | \newskip\envskipamount \envskipamount = 0pt | |
5198 | ||
5199 | % Make spacing and below environment symmetrical. We use \parskip here | |
5200 | % to help in doing that, since in @example-like environments \parskip | |
5201 | % is reset to zero; thus the \afterenvbreak inserts no space -- but the | |
0f9c1975 | 5202 | % start of the next paragraph will insert \parskip. |
2c825956 | 5203 | % |
08b16a02 | 5204 | \def\aboveenvbreak{{% |
0f9c1975 KB |
5205 | % =10000 instead of <10000 because of a special case in \itemzzz and |
5206 | % \sectionheading, q.v. | |
5207 | \ifnum \lastpenalty=10000 \else | |
08b16a02 PJ |
5208 | \advance\envskipamount by \parskip |
5209 | \endgraf | |
5210 | \ifdim\lastskip<\envskipamount | |
5211 | \removelastskip | |
0f9c1975 KB |
5212 | % it's not a good place to break if the last penalty was \nobreak |
5213 | % or better ... | |
5214 | \ifnum\lastpenalty<10000 \penalty-50 \fi | |
08b16a02 PJ |
5215 | \vskip\envskipamount |
5216 | \fi | |
5217 | \fi | |
5218 | }} | |
2c825956 GM |
5219 | |
5220 | \let\afterenvbreak = \aboveenvbreak | |
5221 | ||
0f9c1975 KB |
5222 | % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will |
5223 | % also clear it, so that its embedded environments do the narrowing again. | |
2c825956 GM |
5224 | \let\nonarrowing=\relax |
5225 | ||
5226 | % @cartouche ... @end cartouche: draw rectangle w/rounded corners around | |
5227 | % environment contents. | |
5228 | \font\circle=lcircle10 | |
5229 | \newdimen\circthick | |
5230 | \newdimen\cartouter\newdimen\cartinner | |
5231 | \newskip\normbskip\newskip\normpskip\newskip\normlskip | |
5232 | \circthick=\fontdimen8\circle | |
5233 | % | |
5234 | \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth | |
5235 | \def\ctr{{\hskip 6pt\circle\char'010}} | |
5236 | \def\cbl{{\circle\char'012\hskip -6pt}} | |
5237 | \def\cbr{{\hskip 6pt\circle\char'011}} | |
5238 | \def\carttop{\hbox to \cartouter{\hskip\lskip | |
5239 | \ctl\leaders\hrule height\circthick\hfil\ctr | |
5240 | \hskip\rskip}} | |
5241 | \def\cartbot{\hbox to \cartouter{\hskip\lskip | |
5242 | \cbl\leaders\hrule height\circthick\hfil\cbr | |
5243 | \hskip\rskip}} | |
5244 | % | |
5245 | \newskip\lskip\newskip\rskip | |
5246 | ||
0f9c1975 KB |
5247 | \envdef\cartouche{% |
5248 | \ifhmode\par\fi % can't be in the midst of a paragraph. | |
5249 | \startsavinginserts | |
5250 | \lskip=\leftskip \rskip=\rightskip | |
5251 | \leftskip=0pt\rightskip=0pt % we want these *outside*. | |
5252 | \cartinner=\hsize \advance\cartinner by-\lskip | |
5253 | \advance\cartinner by-\rskip | |
5254 | \cartouter=\hsize | |
5255 | \advance\cartouter by 18.4pt % allow for 3pt kerns on either | |
5256 | % side, and for 6pt waste from | |
5257 | % each corner char, and rule thickness | |
5258 | \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip | |
5259 | % Flag to tell @lisp, etc., not to narrow margin. | |
5260 | \let\nonarrowing = t% | |
5261 | \vbox\bgroup | |
5262 | \baselineskip=0pt\parskip=0pt\lineskip=0pt | |
5263 | \carttop | |
5264 | \hbox\bgroup | |
5265 | \hskip\lskip | |
5266 | \vrule\kern3pt | |
5267 | \vbox\bgroup | |
5268 | \kern3pt | |
5269 | \hsize=\cartinner | |
5270 | \baselineskip=\normbskip | |
5271 | \lineskip=\normlskip | |
5272 | \parskip=\normpskip | |
5273 | \vskip -\parskip | |
5274 | \comment % For explanation, see the end of \def\group. | |
5275 | } | |
2c825956 | 5276 | \def\Ecartouche{% |
0f9c1975 KB |
5277 | \ifhmode\par\fi |
5278 | \kern3pt | |
5279 | \egroup | |
5280 | \kern3pt\vrule | |
5281 | \hskip\rskip | |
5282 | \egroup | |
5283 | \cartbot | |
5284 | \egroup | |
5285 | \checkinserts | |
5286 | } | |
2c825956 GM |
5287 | |
5288 | ||
5289 | % This macro is called at the beginning of all the @example variants, | |
5290 | % inside a group. | |
5291 | \def\nonfillstart{% | |
5292 | \aboveenvbreak | |
2c825956 GM |
5293 | \hfuzz = 12pt % Don't be fussy |
5294 | \sepspaces % Make spaces be word-separators rather than space tokens. | |
2c825956 GM |
5295 | \let\par = \lisppar % don't ignore blank lines |
5296 | \obeylines % each line of input is a line of output | |
5297 | \parskip = 0pt | |
5298 | \parindent = 0pt | |
5299 | \emergencystretch = 0pt % don't try to avoid overfull boxes | |
2c825956 GM |
5300 | \ifx\nonarrowing\relax |
5301 | \advance \leftskip by \lispnarrowing | |
5302 | \exdentamount=\lispnarrowing | |
0f9c1975 KB |
5303 | \else |
5304 | \let\nonarrowing = \relax | |
2c825956 | 5305 | \fi |
0f9c1975 | 5306 | \let\exdent=\nofillexdent |
2c825956 GM |
5307 | } |
5308 | ||
0f9c1975 KB |
5309 | % If you want all examples etc. small: @set dispenvsize small. |
5310 | % If you want even small examples the full size: @set dispenvsize nosmall. | |
5311 | % This affects the following displayed environments: | |
5312 | % @example, @display, @format, @lisp | |
2c825956 | 5313 | % |
0f9c1975 KB |
5314 | \def\smallword{small} |
5315 | \def\nosmallword{nosmall} | |
5316 | \let\SETdispenvsize\relax | |
5317 | \def\setnormaldispenv{% | |
5318 | \ifx\SETdispenvsize\smallword | |
98bf69dc KB |
5319 | % end paragraph for sake of leading, in case document has no blank |
5320 | % line. This is redundant with what happens in \aboveenvbreak, but | |
5321 | % we need to do it before changing the fonts, and it's inconvenient | |
5322 | % to change the fonts afterward. | |
5323 | \ifnum \lastpenalty=10000 \else \endgraf \fi | |
0f9c1975 KB |
5324 | \smallexamplefonts \rm |
5325 | \fi | |
5326 | } | |
5327 | \def\setsmalldispenv{% | |
5328 | \ifx\SETdispenvsize\nosmallword | |
5329 | \else | |
98bf69dc | 5330 | \ifnum \lastpenalty=10000 \else \endgraf \fi |
0f9c1975 KB |
5331 | \smallexamplefonts \rm |
5332 | \fi | |
5333 | } | |
2c825956 | 5334 | |
0f9c1975 KB |
5335 | % We often define two environments, @foo and @smallfoo. |
5336 | % Let's do it by one command: | |
5337 | \def\makedispenv #1#2{ | |
5338 | \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2} | |
5339 | \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2} | |
5340 | \expandafter\let\csname E#1\endcsname \afterenvbreak | |
5341 | \expandafter\let\csname Esmall#1\endcsname \afterenvbreak | |
2c825956 GM |
5342 | } |
5343 | ||
0f9c1975 KB |
5344 | % Define two synonyms: |
5345 | \def\maketwodispenvs #1#2#3{ | |
5346 | \makedispenv{#1}{#3} | |
5347 | \makedispenv{#2}{#3} | |
5348 | } | |
2c825956 | 5349 | |
0f9c1975 | 5350 | % @lisp: indented, narrowed, typewriter font; @example: same as @lisp. |
2c825956 | 5351 | % |
0f9c1975 | 5352 | % @smallexample and @smalllisp: use smaller fonts. |
2c825956 | 5353 | % Originally contributed by Pavel@xerox. |
0f9c1975 KB |
5354 | % |
5355 | \maketwodispenvs {lisp}{example}{% | |
5356 | \nonfillstart | |
08e5fcf1 | 5357 | \tt\quoteexpand |
0f9c1975 KB |
5358 | \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. |
5359 | \gobble % eat return | |
2c825956 | 5360 | } |
0f9c1975 | 5361 | % @display/@smalldisplay: same as @lisp except keep current font. |
2c825956 | 5362 | % |
0f9c1975 | 5363 | \makedispenv {display}{% |
2c825956 | 5364 | \nonfillstart |
2c825956 GM |
5365 | \gobble |
5366 | } | |
2c825956 | 5367 | |
0f9c1975 | 5368 | % @format/@smallformat: same as @display except don't narrow margins. |
2c825956 | 5369 | % |
0f9c1975 KB |
5370 | \makedispenv{format}{% |
5371 | \let\nonarrowing = t% | |
2c825956 | 5372 | \nonfillstart |
2c825956 GM |
5373 | \gobble |
5374 | } | |
2c825956 | 5375 | |
0f9c1975 KB |
5376 | % @flushleft: same as @format, but doesn't obey \SETdispenvsize. |
5377 | \envdef\flushleft{% | |
5378 | \let\nonarrowing = t% | |
5379 | \nonfillstart | |
5380 | \gobble | |
5381 | } | |
5382 | \let\Eflushleft = \afterenvbreak | |
2c825956 GM |
5383 | |
5384 | % @flushright. | |
5385 | % | |
0f9c1975 KB |
5386 | \envdef\flushright{% |
5387 | \let\nonarrowing = t% | |
2c825956 | 5388 | \nonfillstart |
2c825956 GM |
5389 | \advance\leftskip by 0pt plus 1fill |
5390 | \gobble | |
5391 | } | |
0f9c1975 | 5392 | \let\Eflushright = \afterenvbreak |
2c825956 GM |
5393 | |
5394 | ||
5395 | % @quotation does normal linebreaking (hence we can't use \nonfillstart) | |
0f9c1975 KB |
5396 | % and narrows the margins. We keep \parskip nonzero in general, since |
5397 | % we're doing normal filling. So, when using \aboveenvbreak and | |
5398 | % \afterenvbreak, temporarily make \parskip 0. | |
2c825956 | 5399 | % |
0f9c1975 | 5400 | \envdef\quotation{% |
2c825956 | 5401 | {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip |
2c825956 | 5402 | \parindent=0pt |
2c825956 GM |
5403 | % |
5404 | % @cartouche defines \nonarrowing to inhibit narrowing at next level down. | |
5405 | \ifx\nonarrowing\relax | |
5406 | \advance\leftskip by \lispnarrowing | |
5407 | \advance\rightskip by \lispnarrowing | |
5408 | \exdentamount = \lispnarrowing | |
0f9c1975 | 5409 | \else |
2c825956 GM |
5410 | \let\nonarrowing = \relax |
5411 | \fi | |
0f9c1975 KB |
5412 | \parsearg\quotationlabel |
5413 | } | |
5414 | ||
5415 | % We have retained a nonzero parskip for the environment, since we're | |
5416 | % doing normal filling. | |
5417 | % | |
5418 | \def\Equotation{% | |
5419 | \par | |
5420 | \ifx\quotationauthor\undefined\else | |
5421 | % indent a bit. | |
5422 | \leftline{\kern 2\leftskip \sl ---\quotationauthor}% | |
5423 | \fi | |
5424 | {\parskip=0pt \afterenvbreak}% | |
5425 | } | |
5426 | ||
5427 | % If we're given an argument, typeset it in bold with a colon after. | |
5428 | \def\quotationlabel#1{% | |
5429 | \def\temp{#1}% | |
5430 | \ifx\temp\empty \else | |
5431 | {\bf #1: }% | |
5432 | \fi | |
2c825956 GM |
5433 | } |
5434 | ||
5435 | ||
5436 | % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} | |
177c0ea7 | 5437 | % If we want to allow any <char> as delimiter, |
2c825956 GM |
5438 | % we need the curly braces so that makeinfo sees the @verb command, eg: |
5439 | % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org | |
5440 | % | |
5441 | % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. | |
5442 | % | |
0f9c1975 KB |
5443 | % [Knuth] p.344; only we need to do the other characters Texinfo sets |
5444 | % active too. Otherwise, they get lost as the first character on a | |
5445 | % verbatim line. | |
2c825956 | 5446 | \def\dospecials{% |
0f9c1975 KB |
5447 | \do\ \do\\\do\{\do\}\do\$\do\&% |
5448 | \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% | |
5449 | \do\<\do\>\do\|\do\@\do+\do\"% | |
5450 | } | |
2c825956 GM |
5451 | % |
5452 | % [Knuth] p. 380 | |
5453 | \def\uncatcodespecials{% | |
0f9c1975 | 5454 | \def\do##1{\catcode`##1=\other}\dospecials} |
2c825956 GM |
5455 | % |
5456 | % [Knuth] pp. 380,381,391 | |
5457 | % Disable Spanish ligatures ?` and !` of \tt font | |
5458 | \begingroup | |
5459 | \catcode`\`=\active\gdef`{\relax\lq} | |
5460 | \endgroup | |
5461 | % | |
5462 | % Setup for the @verb command. | |
5463 | % | |
5464 | % Eight spaces for a tab | |
5465 | \begingroup | |
5466 | \catcode`\^^I=\active | |
5467 | \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} | |
5468 | \endgroup | |
5469 | % | |
5470 | \def\setupverb{% | |
5471 | \tt % easiest (and conventionally used) font for verbatim | |
5472 | \def\par{\leavevmode\endgraf}% | |
5473 | \catcode`\`=\active | |
5474 | \tabeightspaces | |
5475 | % Respect line breaks, | |
5476 | % print special symbols as themselves, and | |
5477 | % make each space count | |
5478 | % must do in this order: | |
5479 | \obeylines \uncatcodespecials \sepspaces | |
5480 | } | |
5481 | ||
5482 | % Setup for the @verbatim environment | |
5483 | % | |
5484 | % Real tab expansion | |
5485 | \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount | |
5486 | % | |
5487 | \def\starttabbox{\setbox0=\hbox\bgroup} | |
08e5fcf1 KB |
5488 | |
5489 | % Allow an option to not replace quotes with a regular directed right | |
5490 | % quote/apostrophe (char 0x27), but instead use the undirected quote | |
5491 | % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it | |
5492 | % the default, but it works for pasting with more pdf viewers (at least | |
5493 | % evince), the lilypond developers report. xpdf does work with the | |
5494 | % regular 0x27. | |
5495 | % | |
74acc6cb | 5496 | \def\codequoteright{% |
08e5fcf1 KB |
5497 | \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax |
5498 | '% | |
5499 | \else | |
5500 | \char'15 | |
5501 | \fi | |
5502 | } | |
5503 | % | |
74acc6cb KB |
5504 | % and a similar option for the left quote char vs. a grave accent. |
5505 | % Modern fonts display ASCII 0x60 as a grave accent, so some people like | |
5506 | % the code environments to do likewise. | |
5507 | % | |
5508 | \def\codequoteleft{% | |
5509 | \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax | |
5510 | `% | |
5511 | \else | |
5512 | \char'22 | |
5513 | \fi | |
5514 | } | |
5515 | % | |
2c825956 GM |
5516 | \begingroup |
5517 | \catcode`\^^I=\active | |
5518 | \gdef\tabexpand{% | |
5519 | \catcode`\^^I=\active | |
5520 | \def^^I{\leavevmode\egroup | |
5521 | \dimen0=\wd0 % the width so far, or since the previous tab | |
5522 | \divide\dimen0 by\tabw | |
5523 | \multiply\dimen0 by\tabw % compute previous multiple of \tabw | |
5524 | \advance\dimen0 by\tabw % advance to next multiple of \tabw | |
5525 | \wd0=\dimen0 \box0 \starttabbox | |
5526 | }% | |
5527 | } | |
08e5fcf1 | 5528 | \catcode`\'=\active |
74acc6cb KB |
5529 | \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}% |
5530 | % | |
5531 | \catcode`\`=\active | |
5532 | \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}% | |
5533 | % | |
5534 | \gdef\quoteexpand{\rquoteexpand \lquoteexpand}% | |
2c825956 | 5535 | \endgroup |
74acc6cb KB |
5536 | |
5537 | % start the verbatim environment. | |
2c825956 | 5538 | \def\setupverbatim{% |
0f9c1975 KB |
5539 | \let\nonarrowing = t% |
5540 | \nonfillstart | |
2c825956 GM |
5541 | % Easiest (and conventionally used) font for verbatim |
5542 | \tt | |
5543 | \def\par{\leavevmode\egroup\box0\endgraf}% | |
5544 | \catcode`\`=\active | |
5545 | \tabexpand | |
08e5fcf1 | 5546 | \quoteexpand |
2c825956 GM |
5547 | % Respect line breaks, |
5548 | % print special symbols as themselves, and | |
5549 | % make each space count | |
5550 | % must do in this order: | |
5551 | \obeylines \uncatcodespecials \sepspaces | |
5552 | \everypar{\starttabbox}% | |
5553 | } | |
5554 | ||
177c0ea7 JB |
5555 | % Do the @verb magic: verbatim text is quoted by unique |
5556 | % delimiter characters. Before first delimiter expect a | |
2c825956 GM |
5557 | % right brace, after last delimiter expect closing brace: |
5558 | % | |
5559 | % \def\doverb'{'<char>#1<char>'}'{#1} | |
5560 | % | |
5561 | % [Knuth] p. 382; only eat outer {} | |
5562 | \begingroup | |
0f9c1975 | 5563 | \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other |
2c825956 GM |
5564 | \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] |
5565 | \endgroup | |
5566 | % | |
5567 | \def\verb{\begingroup\setupverb\doverb} | |
5568 | % | |
5569 | % | |
5570 | % Do the @verbatim magic: define the macro \doverbatim so that | |
5571 | % the (first) argument ends when '@end verbatim' is reached, ie: | |
5572 | % | |
5573 | % \def\doverbatim#1@end verbatim{#1} | |
5574 | % | |
177c0ea7 | 5575 | % For Texinfo it's a lot easier than for LaTeX, |
2c825956 | 5576 | % because texinfo's \verbatim doesn't stop at '\end{verbatim}': |
0f9c1975 | 5577 | % we need not redefine '\', '{' and '}'. |
2c825956 GM |
5578 | % |
5579 | % Inspired by LaTeX's verbatim command set [latex.ltx] | |
0f9c1975 | 5580 | % |
2c825956 GM |
5581 | \begingroup |
5582 | \catcode`\ =\active | |
0f9c1975 KB |
5583 | \obeylines % |
5584 | % ignore everything up to the first ^^M, that's the newline at the end | |
5585 | % of the @verbatim input line itself. Otherwise we get an extra blank | |
5586 | % line in the output. | |
5587 | \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% | |
5588 | % We really want {...\end verbatim} in the body of the macro, but | |
5589 | % without the active space; thus we have to use \xdef and \gobble. | |
2c825956 GM |
5590 | \endgroup |
5591 | % | |
0f9c1975 KB |
5592 | \envdef\verbatim{% |
5593 | \setupverbatim\doverbatim | |
2c825956 | 5594 | } |
0f9c1975 KB |
5595 | \let\Everbatim = \afterenvbreak |
5596 | ||
2c825956 GM |
5597 | |
5598 | % @verbatiminclude FILE - insert text of file in verbatim environment. | |
5599 | % | |
0f9c1975 | 5600 | \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} |
2c825956 GM |
5601 | % |
5602 | \def\doverbatiminclude#1{% | |
0f9c1975 KB |
5603 | {% |
5604 | \makevalueexpandable | |
5605 | \setupverbatim | |
5606 | \input #1 | |
5607 | \afterenvbreak | |
5608 | }% | |
2c825956 GM |
5609 | } |
5610 | ||
08b16a02 PJ |
5611 | % @copying ... @end copying. |
5612 | % Save the text away for @insertcopying later. | |
177c0ea7 | 5613 | % |
0f9c1975 KB |
5614 | % We save the uninterpreted tokens, rather than creating a box. |
5615 | % Saving the text in a box would be much easier, but then all the | |
5616 | % typesetting commands (@smallbook, font changes, etc.) have to be done | |
5617 | % beforehand -- and a) we want @copying to be done first in the source | |
5618 | % file; b) letting users define the frontmatter in as flexible order as | |
5619 | % possible is very desirable. | |
08b16a02 | 5620 | % |
0f9c1975 KB |
5621 | \def\copying{\checkenv{}\begingroup\scanargctxt\docopying} |
5622 | \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}} | |
177c0ea7 | 5623 | % |
0f9c1975 KB |
5624 | \def\insertcopying{% |
5625 | \begingroup | |
5626 | \parindent = 0pt % paragraph indentation looks wrong on title page | |
5627 | \scanexp\copyingtext | |
5628 | \endgroup | |
5629 | } | |
2c825956 | 5630 | |
98bf69dc | 5631 | |
2c825956 GM |
5632 | \message{defuns,} |
5633 | % @defun etc. | |
5634 | ||
2c825956 GM |
5635 | \newskip\defbodyindent \defbodyindent=.4in |
5636 | \newskip\defargsindent \defargsindent=50pt | |
2c825956 | 5637 | \newskip\deflastargmargin \deflastargmargin=18pt |
98bf69dc | 5638 | \newcount\defunpenalty |
2c825956 | 5639 | |
0f9c1975 KB |
5640 | % Start the processing of @deffn: |
5641 | \def\startdefun{% | |
5642 | \ifnum\lastpenalty<10000 | |
5643 | \medbreak | |
98bf69dc KB |
5644 | \defunpenalty=10003 % Will keep this @deffn together with the |
5645 | % following @def command, see below. | |
0f9c1975 KB |
5646 | \else |
5647 | % If there are two @def commands in a row, we'll have a \nobreak, | |
5648 | % which is there to keep the function description together with its | |
5649 | % header. But if there's nothing but headers, we need to allow a | |
5650 | % break somewhere. Check specifically for penalty 10002, inserted | |
98bf69dc | 5651 | % by \printdefunline, instead of 10000, since the sectioning |
0f9c1975 KB |
5652 | % commands also insert a nobreak penalty, and we don't want to allow |
5653 | % a break between a section heading and a defun. | |
98bf69dc KB |
5654 | % |
5655 | % As a minor refinement, we avoid "club" headers by signalling | |
5656 | % with penalty of 10003 after the very first @deffn in the | |
5657 | % sequence (see above), and penalty of 10002 after any following | |
5658 | % @def command. | |
5659 | \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi | |
0f9c1975 KB |
5660 | % |
5661 | % Similarly, after a section heading, do not allow a break. | |
5662 | % But do insert the glue. | |
5663 | \medskip % preceded by discardable penalty, so not a breakpoint | |
5664 | \fi | |
08b16a02 PJ |
5665 | % |
5666 | \parindent=0in | |
5667 | \advance\leftskip by \defbodyindent | |
5668 | \exdentamount=\defbodyindent | |
5669 | } | |
5670 | ||
0f9c1975 KB |
5671 | \def\dodefunx#1{% |
5672 | % First, check whether we are in the right environment: | |
5673 | \checkenv#1% | |
5674 | % | |
5675 | % As above, allow line break if we have multiple x headers in a row. | |
5676 | % It's not a great place, though. | |
98bf69dc | 5677 | \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi |
0f9c1975 KB |
5678 | % |
5679 | % And now, it's time to reuse the body of the original defun: | |
5680 | \expandafter\gobbledefun#1% | |
08b16a02 | 5681 | } |
0f9c1975 | 5682 | \def\gobbledefun#1\startdefun{} |
2c825956 | 5683 | |
0f9c1975 | 5684 | % \printdefunline \deffnheader{text} |
177c0ea7 | 5685 | % |
0f9c1975 KB |
5686 | \def\printdefunline#1#2{% |
5687 | \begingroup | |
5688 | % call \deffnheader: | |
5689 | #1#2 \endheader | |
5690 | % common ending: | |
5691 | \interlinepenalty = 10000 | |
5692 | \advance\rightskip by 0pt plus 1fil | |
5693 | \endgraf | |
5694 | \nobreak\vskip -\parskip | |
98bf69dc | 5695 | \penalty\defunpenalty % signal to \startdefun and \dodefunx |
0f9c1975 KB |
5696 | % Some of the @defun-type tags do not enable magic parentheses, |
5697 | % rendering the following check redundant. But we don't optimize. | |
5698 | \checkparencounts | |
5699 | \endgroup | |
08b16a02 PJ |
5700 | } |
5701 | ||
0f9c1975 | 5702 | \def\Edefun{\endgraf\medbreak} |
2c825956 | 5703 | |
0f9c1975 KB |
5704 | % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; |
5705 | % the only thing remainnig is to define \deffnheader. | |
2c825956 | 5706 | % |
0f9c1975 KB |
5707 | \def\makedefun#1{% |
5708 | \expandafter\let\csname E#1\endcsname = \Edefun | |
5709 | \edef\temp{\noexpand\domakedefun | |
5710 | \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% | |
5711 | \temp | |
2c825956 GM |
5712 | } |
5713 | ||
0f9c1975 | 5714 | % \domakedefun \deffn \deffnx \deffnheader |
2c825956 | 5715 | % |
0f9c1975 KB |
5716 | % Define \deffn and \deffnx, without parameters. |
5717 | % \deffnheader has to be defined explicitly. | |
2c825956 | 5718 | % |
0f9c1975 KB |
5719 | \def\domakedefun#1#2#3{% |
5720 | \envdef#1{% | |
5721 | \startdefun | |
5722 | \parseargusing\activeparens{\printdefunline#3}% | |
5723 | }% | |
5724 | \def#2{\dodefunx#1}% | |
5725 | \def#3% | |
2c825956 GM |
5726 | } |
5727 | ||
0f9c1975 | 5728 | %%% Untyped functions: |
2c825956 | 5729 | |
0f9c1975 KB |
5730 | % @deffn category name args |
5731 | \makedefun{deffn}{\deffngeneral{}} | |
2c825956 | 5732 | |
0f9c1975 KB |
5733 | % @deffn category class name args |
5734 | \makedefun{defop}#1 {\defopon{#1\ \putwordon}} | |
2c825956 | 5735 | |
0f9c1975 KB |
5736 | % \defopon {category on}class name args |
5737 | \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } | |
2c825956 | 5738 | |
0f9c1975 KB |
5739 | % \deffngeneral {subind}category name args |
5740 | % | |
5741 | \def\deffngeneral#1#2 #3 #4\endheader{% | |
5742 | % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. | |
5743 | \dosubind{fn}{\code{#3}}{#1}% | |
5744 | \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% | |
2c825956 GM |
5745 | } |
5746 | ||
0f9c1975 | 5747 | %%% Typed functions: |
2c825956 | 5748 | |
0f9c1975 KB |
5749 | % @deftypefn category type name args |
5750 | \makedefun{deftypefn}{\deftypefngeneral{}} | |
2c825956 | 5751 | |
0f9c1975 KB |
5752 | % @deftypeop category class type name args |
5753 | \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} | |
2c825956 | 5754 | |
0f9c1975 KB |
5755 | % \deftypeopon {category on}class type name args |
5756 | \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } | |
2c825956 | 5757 | |
0f9c1975 KB |
5758 | % \deftypefngeneral {subind}category type name args |
5759 | % | |
5760 | \def\deftypefngeneral#1#2 #3 #4 #5\endheader{% | |
5761 | \dosubind{fn}{\code{#4}}{#1}% | |
5762 | \defname{#2}{#3}{#4}\defunargs{#5\unskip}% | |
2c825956 GM |
5763 | } |
5764 | ||
0f9c1975 | 5765 | %%% Typed variables: |
2c825956 | 5766 | |
0f9c1975 KB |
5767 | % @deftypevr category type var args |
5768 | \makedefun{deftypevr}{\deftypecvgeneral{}} | |
2c825956 | 5769 | |
0f9c1975 KB |
5770 | % @deftypecv category class type var args |
5771 | \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} | |
2c825956 | 5772 | |
0f9c1975 KB |
5773 | % \deftypecvof {category of}class type var args |
5774 | \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } | |
2c825956 | 5775 | |
0f9c1975 KB |
5776 | % \deftypecvgeneral {subind}category type var args |
5777 | % | |
5778 | \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% | |
5779 | \dosubind{vr}{\code{#4}}{#1}% | |
5780 | \defname{#2}{#3}{#4}\defunargs{#5\unskip}% | |
2c825956 GM |
5781 | } |
5782 | ||
0f9c1975 | 5783 | %%% Untyped variables: |
2c825956 | 5784 | |
0f9c1975 KB |
5785 | % @defvr category var args |
5786 | \makedefun{defvr}#1 {\deftypevrheader{#1} {} } | |
2c825956 | 5787 | |
0f9c1975 KB |
5788 | % @defcv category class var args |
5789 | \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} | |
2c825956 | 5790 | |
0f9c1975 KB |
5791 | % \defcvof {category of}class var args |
5792 | \def\defcvof#1#2 {\deftypecvof{#1}#2 {} } | |
2c825956 | 5793 | |
0f9c1975 KB |
5794 | %%% Type: |
5795 | % @deftp category name args | |
5796 | \makedefun{deftp}#1 #2 #3\endheader{% | |
5797 | \doind{tp}{\code{#2}}% | |
5798 | \defname{#1}{}{#2}\defunargs{#3\unskip}% | |
2c825956 GM |
5799 | } |
5800 | ||
0f9c1975 KB |
5801 | % Remaining @defun-like shortcuts: |
5802 | \makedefun{defun}{\deffnheader{\putwordDeffunc} } | |
5803 | \makedefun{defmac}{\deffnheader{\putwordDefmac} } | |
5804 | \makedefun{defspec}{\deffnheader{\putwordDefspec} } | |
5805 | \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } | |
5806 | \makedefun{defvar}{\defvrheader{\putwordDefvar} } | |
5807 | \makedefun{defopt}{\defvrheader{\putwordDefopt} } | |
5808 | \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } | |
5809 | \makedefun{defmethod}{\defopon\putwordMethodon} | |
5810 | \makedefun{deftypemethod}{\deftypeopon\putwordMethodon} | |
5811 | \makedefun{defivar}{\defcvof\putwordInstanceVariableof} | |
5812 | \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} | |
2c825956 | 5813 | |
0f9c1975 KB |
5814 | % \defname, which formats the name of the @def (not the args). |
5815 | % #1 is the category, such as "Function". | |
5816 | % #2 is the return type, if any. | |
5817 | % #3 is the function name. | |
2c825956 | 5818 | % |
0f9c1975 | 5819 | % We are followed by (but not passed) the arguments, if any. |
2c825956 | 5820 | % |
0f9c1975 KB |
5821 | \def\defname#1#2#3{% |
5822 | % Get the values of \leftskip and \rightskip as they were outside the @def... | |
5823 | \advance\leftskip by -\defbodyindent | |
5824 | % | |
5825 | % How we'll format the type name. Putting it in brackets helps | |
5826 | % distinguish it from the body text that may end up on the next line | |
5827 | % just below it. | |
5828 | \def\temp{#1}% | |
5829 | \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} | |
5830 | % | |
5831 | % Figure out line sizes for the paragraph shape. | |
5832 | % The first line needs space for \box0; but if \rightskip is nonzero, | |
5833 | % we need only space for the part of \box0 which exceeds it: | |
5834 | \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip | |
5835 | % The continuations: | |
5836 | \dimen2=\hsize \advance\dimen2 by -\defargsindent | |
5837 | % (plain.tex says that \dimen1 should be used only as global.) | |
5838 | \parshape 2 0in \dimen0 \defargsindent \dimen2 | |
5839 | % | |
5840 | % Put the type name to the right margin. | |
5841 | \noindent | |
5842 | \hbox to 0pt{% | |
5843 | \hfil\box0 \kern-\hsize | |
5844 | % \hsize has to be shortened this way: | |
5845 | \kern\leftskip | |
5846 | % Intentionally do not respect \rightskip, since we need the space. | |
5847 | }% | |
5848 | % | |
5849 | % Allow all lines to be underfull without complaint: | |
5850 | \tolerance=10000 \hbadness=10000 | |
5851 | \exdentamount=\defbodyindent | |
5852 | {% | |
5853 | % defun fonts. We use typewriter by default (used to be bold) because: | |
5854 | % . we're printing identifiers, they should be in tt in principle. | |
5855 | % . in languages with many accents, such as Czech or French, it's | |
5856 | % common to leave accents off identifiers. The result looks ok in | |
5857 | % tt, but exceedingly strange in rm. | |
5858 | % . we don't want -- and --- to be treated as ligatures. | |
5859 | % . this still does not fix the ?` and !` ligatures, but so far no | |
5860 | % one has made identifiers using them :). | |
5861 | \df \tt | |
5862 | \def\temp{#2}% return value type | |
5863 | \ifx\temp\empty\else \tclose{\temp} \fi | |
5864 | #3% output function name | |
5865 | }% | |
5866 | {\rm\enskip}% hskip 0.5 em of \tenrm | |
5867 | % | |
5868 | \boldbrax | |
5869 | % arguments will be output next, if any. | |
2c825956 GM |
5870 | } |
5871 | ||
0f9c1975 KB |
5872 | % Print arguments in slanted roman (not ttsl), inconsistently with using |
5873 | % tt for the name. This is because literal text is sometimes needed in | |
5874 | % the argument list (groff manual), and ttsl and tt are not very | |
5875 | % distinguishable. Prevent hyphenation at `-' chars. | |
2c825956 | 5876 | % |
0f9c1975 KB |
5877 | \def\defunargs#1{% |
5878 | % use sl by default (not ttsl), | |
5879 | % tt for the names. | |
5880 | \df \sl \hyphenchar\font=0 | |
5881 | % | |
5882 | % On the other hand, if an argument has two dashes (for instance), we | |
5883 | % want a way to get ttsl. Let's try @var for that. | |
5884 | \let\var=\ttslanted | |
5885 | #1% | |
5886 | \sl\hyphenchar\font=45 | |
2c825956 GM |
5887 | } |
5888 | ||
0f9c1975 | 5889 | % We want ()&[] to print specially on the defun line. |
2c825956 | 5890 | % |
0f9c1975 KB |
5891 | \def\activeparens{% |
5892 | \catcode`\(=\active \catcode`\)=\active | |
5893 | \catcode`\[=\active \catcode`\]=\active | |
5894 | \catcode`\&=\active | |
2c825956 GM |
5895 | } |
5896 | ||
0f9c1975 KB |
5897 | % Make control sequences which act like normal parenthesis chars. |
5898 | \let\lparen = ( \let\rparen = ) | |
2c825956 | 5899 | |
0f9c1975 KB |
5900 | % Be sure that we always have a definition for `(', etc. For example, |
5901 | % if the fn name has parens in it, \boldbrax will not be in effect yet, | |
5902 | % so TeX would otherwise complain about undefined control sequence. | |
5903 | { | |
5904 | \activeparens | |
5905 | \global\let(=\lparen \global\let)=\rparen | |
5906 | \global\let[=\lbrack \global\let]=\rbrack | |
5907 | \global\let& = \& | |
2c825956 | 5908 | |
0f9c1975 KB |
5909 | \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} |
5910 | \gdef\magicamp{\let&=\amprm} | |
5911 | } | |
2c825956 | 5912 | |
0f9c1975 | 5913 | \newcount\parencount |
2c825956 | 5914 | |
0f9c1975 KB |
5915 | % If we encounter &foo, then turn on ()-hacking afterwards |
5916 | \newif\ifampseen | |
5917 | \def\amprm#1 {\ampseentrue{\bf\ }} | |
5918 | ||
5919 | \def\parenfont{% | |
5920 | \ifampseen | |
5921 | % At the first level, print parens in roman, | |
5922 | % otherwise use the default font. | |
5923 | \ifnum \parencount=1 \rm \fi | |
5924 | \else | |
5925 | % The \sf parens (in \boldbrax) actually are a little bolder than | |
5926 | % the contained text. This is especially needed for [ and ] . | |
5927 | \sf | |
5928 | \fi | |
2c825956 | 5929 | } |
0f9c1975 KB |
5930 | \def\infirstlevel#1{% |
5931 | \ifampseen | |
5932 | \ifnum\parencount=1 | |
5933 | #1% | |
5934 | \fi | |
5935 | \fi | |
2c825956 | 5936 | } |
0f9c1975 | 5937 | \def\bfafterword#1 {#1 \bf} |
2c825956 | 5938 | |
0f9c1975 KB |
5939 | \def\opnr{% |
5940 | \global\advance\parencount by 1 | |
5941 | {\parenfont(}% | |
5942 | \infirstlevel \bfafterword | |
2c825956 | 5943 | } |
0f9c1975 KB |
5944 | \def\clnr{% |
5945 | {\parenfont)}% | |
5946 | \infirstlevel \sl | |
5947 | \global\advance\parencount by -1 | |
2c825956 GM |
5948 | } |
5949 | ||
0f9c1975 KB |
5950 | \newcount\brackcount |
5951 | \def\lbrb{% | |
5952 | \global\advance\brackcount by 1 | |
5953 | {\bf[}% | |
5954 | } | |
5955 | \def\rbrb{% | |
5956 | {\bf]}% | |
5957 | \global\advance\brackcount by -1 | |
5958 | } | |
2c825956 | 5959 | |
0f9c1975 KB |
5960 | \def\checkparencounts{% |
5961 | \ifnum\parencount=0 \else \badparencount \fi | |
5962 | \ifnum\brackcount=0 \else \badbrackcount \fi | |
5963 | } | |
5964 | \def\badparencount{% | |
5965 | \errmessage{Unbalanced parentheses in @def}% | |
5966 | \global\parencount=0 | |
5967 | } | |
5968 | \def\badbrackcount{% | |
5969 | \errmessage{Unbalanced square braces in @def}% | |
5970 | \global\brackcount=0 | |
5971 | } | |
2c825956 GM |
5972 | |
5973 | ||
5974 | \message{macros,} | |
5975 | % @macro. | |
5976 | ||
5977 | % To do this right we need a feature of e-TeX, \scantokens, | |
5978 | % which we arrange to emulate with a temporary file in ordinary TeX. | |
5979 | \ifx\eTeXversion\undefined | |
0f9c1975 KB |
5980 | \newwrite\macscribble |
5981 | \def\scantokens#1{% | |
5982 | \toks0={#1}% | |
5983 | \immediate\openout\macscribble=\jobname.tmp | |
5984 | \immediate\write\macscribble{\the\toks0}% | |
5985 | \immediate\closeout\macscribble | |
5986 | \input \jobname.tmp | |
5987 | } | |
2c825956 GM |
5988 | \fi |
5989 | ||
0f9c1975 KB |
5990 | \def\scanmacro#1{% |
5991 | \begingroup | |
5992 | \newlinechar`\^^M | |
5993 | \let\xeatspaces\eatspaces | |
5994 | % Undo catcode changes of \startcontents and \doprintindex | |
5995 | % When called from @insertcopying or (short)caption, we need active | |
5996 | % backslash to get it printed correctly. Previously, we had | |
5997 | % \catcode`\\=\other instead. We'll see whether a problem appears | |
5998 | % with macro expansion. --kasal, 19aug04 | |
5999 | \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ | |
6000 | % ... and \example | |
6001 | \spaceisspace | |
6002 | % | |
6003 | % Append \endinput to make sure that TeX does not see the ending newline. | |
0f9c1975 KB |
6004 | % I've verified that it is necessary both for e-TeX and for ordinary TeX |
6005 | % --kasal, 29nov03 | |
6006 | \scantokens{#1\endinput}% | |
6007 | \endgroup | |
6008 | } | |
6009 | ||
6010 | \def\scanexp#1{% | |
6011 | \edef\temp{\noexpand\scanmacro{#1}}% | |
6012 | \temp | |
6013 | } | |
6014 | ||
2c825956 GM |
6015 | \newcount\paramno % Count of parameters |
6016 | \newtoks\macname % Macro name | |
6017 | \newif\ifrecursive % Is it recursive? | |
0f9c1975 KB |
6018 | |
6019 | % List of all defined macros in the form | |
6020 | % \definedummyword\macro1\definedummyword\macro2... | |
6021 | % Currently is also contains all @aliases; the list can be split | |
6022 | % if there is a need. | |
6023 | \def\macrolist{} | |
6024 | ||
6025 | % Add the macro to \macrolist | |
6026 | \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname} | |
6027 | \def\addtomacrolistxxx#1{% | |
6028 | \toks0 = \expandafter{\macrolist\definedummyword#1}% | |
6029 | \xdef\macrolist{\the\toks0}% | |
6030 | } | |
2c825956 GM |
6031 | |
6032 | % Utility routines. | |
0f9c1975 KB |
6033 | % This does \let #1 = #2, with \csnames; that is, |
6034 | % \let \csname#1\endcsname = \csname#2\endcsname | |
6035 | % (except of course we have to play expansion games). | |
6036 | % | |
2c825956 | 6037 | \def\cslet#1#2{% |
0f9c1975 KB |
6038 | \expandafter\let |
6039 | \csname#1\expandafter\endcsname | |
6040 | \csname#2\endcsname | |
6041 | } | |
2c825956 GM |
6042 | |
6043 | % Trim leading and trailing spaces off a string. | |
6044 | % Concepts from aro-bend problem 15 (see CTAN). | |
6045 | {\catcode`\@=11 | |
6046 | \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} | |
6047 | \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} | |
6048 | \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} | |
6049 | \def\unbrace#1{#1} | |
6050 | \unbrace{\gdef\trim@@@ #1 } #2@{#1} | |
6051 | } | |
6052 | ||
6053 | % Trim a single trailing ^^M off a string. | |
0f9c1975 | 6054 | {\catcode`\^^M=\other \catcode`\Q=3% |
2c825956 GM |
6055 | \gdef\eatcr #1{\eatcra #1Q^^MQ}% |
6056 | \gdef\eatcra#1^^MQ{\eatcrb#1Q}% | |
6057 | \gdef\eatcrb#1Q#2Q{#1}% | |
6058 | } | |
6059 | ||
6060 | % Macro bodies are absorbed as an argument in a context where | |
6061 | % all characters are catcode 10, 11 or 12, except \ which is active | |
6062 | % (as in normal texinfo). It is necessary to change the definition of \. | |
6063 | ||
6064 | % It's necessary to have hard CRs when the macro is executed. This is | |
6065 | % done by making ^^M (\endlinechar) catcode 12 when reading the macro | |
6066 | % body, and then making it the \newlinechar in \scanmacro. | |
6067 | ||
0f9c1975 KB |
6068 | \def\scanctxt{% |
6069 | \catcode`\"=\other | |
6070 | \catcode`\+=\other | |
6071 | \catcode`\<=\other | |
6072 | \catcode`\>=\other | |
6073 | \catcode`\@=\other | |
6074 | \catcode`\^=\other | |
6075 | \catcode`\_=\other | |
6076 | \catcode`\|=\other | |
6077 | \catcode`\~=\other | |
6078 | } | |
6079 | ||
6080 | \def\scanargctxt{% | |
6081 | \scanctxt | |
6082 | \catcode`\\=\other | |
6083 | \catcode`\^^M=\other | |
6084 | } | |
6085 | ||
2c825956 | 6086 | \def\macrobodyctxt{% |
0f9c1975 KB |
6087 | \scanctxt |
6088 | \catcode`\{=\other | |
6089 | \catcode`\}=\other | |
6090 | \catcode`\^^M=\other | |
6091 | \usembodybackslash | |
6092 | } | |
2c825956 GM |
6093 | |
6094 | \def\macroargctxt{% | |
0f9c1975 KB |
6095 | \scanctxt |
6096 | \catcode`\\=\other | |
6097 | } | |
2c825956 GM |
6098 | |
6099 | % \mbodybackslash is the definition of \ in @macro bodies. | |
6100 | % It maps \foo\ => \csname macarg.foo\endcsname => #N | |
6101 | % where N is the macro parameter number. | |
6102 | % We define \csname macarg.\endcsname to be \realbackslash, so | |
6103 | % \\ in macro replacement text gets you a backslash. | |
6104 | ||
6105 | {\catcode`@=0 @catcode`@\=@active | |
6106 | @gdef@usembodybackslash{@let\=@mbodybackslash} | |
6107 | @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} | |
6108 | } | |
6109 | \expandafter\def\csname macarg.\endcsname{\realbackslash} | |
6110 | ||
6111 | \def\macro{\recursivefalse\parsearg\macroxxx} | |
6112 | \def\rmacro{\recursivetrue\parsearg\macroxxx} | |
6113 | ||
6114 | \def\macroxxx#1{% | |
6115 | \getargs{#1}% now \macname is the macname and \argl the arglist | |
6116 | \ifx\argl\empty % no arguments | |
6117 | \paramno=0% | |
6118 | \else | |
6119 | \expandafter\parsemargdef \argl;% | |
6120 | \fi | |
6121 | \if1\csname ismacro.\the\macname\endcsname | |
6122 | \message{Warning: redefining \the\macname}% | |
6123 | \else | |
6124 | \expandafter\ifx\csname \the\macname\endcsname \relax | |
08b16a02 | 6125 | \else \errmessage{Macro name \the\macname\space already defined}\fi |
2c825956 GM |
6126 | \global\cslet{macsave.\the\macname}{\the\macname}% |
6127 | \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% | |
0f9c1975 | 6128 | \addtomacrolist{\the\macname}% |
2c825956 GM |
6129 | \fi |
6130 | \begingroup \macrobodyctxt | |
6131 | \ifrecursive \expandafter\parsermacbody | |
6132 | \else \expandafter\parsemacbody | |
6133 | \fi} | |
6134 | ||
0f9c1975 | 6135 | \parseargdef\unmacro{% |
2c825956 GM |
6136 | \if1\csname ismacro.#1\endcsname |
6137 | \global\cslet{#1}{macsave.#1}% | |
6138 | \global\expandafter\let \csname ismacro.#1\endcsname=0% | |
0f9c1975 | 6139 | % Remove the macro name from \macrolist: |
2c825956 | 6140 | \begingroup |
0f9c1975 KB |
6141 | \expandafter\let\csname#1\endcsname \relax |
6142 | \let\definedummyword\unmacrodo | |
6143 | \xdef\macrolist{\macrolist}% | |
2c825956 GM |
6144 | \endgroup |
6145 | \else | |
6146 | \errmessage{Macro #1 not defined}% | |
6147 | \fi | |
6148 | } | |
6149 | ||
0f9c1975 KB |
6150 | % Called by \do from \dounmacro on each macro. The idea is to omit any |
6151 | % macro definitions that have been changed to \relax. | |
6152 | % | |
6153 | \def\unmacrodo#1{% | |
6154 | \ifx #1\relax | |
6155 | % remove this | |
6156 | \else | |
6157 | \noexpand\definedummyword \noexpand#1% | |
6158 | \fi | |
6159 | } | |
6160 | ||
2c825956 GM |
6161 | % This makes use of the obscure feature that if the last token of a |
6162 | % <parameter list> is #, then the preceding argument is delimited by | |
6163 | % an opening brace, and that opening brace is not consumed. | |
6164 | \def\getargs#1{\getargsxxx#1{}} | |
6165 | \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} | |
6166 | \def\getmacname #1 #2\relax{\macname={#1}} | |
6167 | \def\getmacargs#1{\def\argl{#1}} | |
6168 | ||
6169 | % Parse the optional {params} list. Set up \paramno and \paramlist | |
6170 | % so \defmacro knows what to do. Define \macarg.blah for each blah | |
6171 | % in the params list, to be ##N where N is the position in that list. | |
6172 | % That gets used by \mbodybackslash (above). | |
6173 | ||
6174 | % We need to get `macro parameter char #' into several definitions. | |
6175 | % The technique used is stolen from LaTeX: let \hash be something | |
6176 | % unexpandable, insert that wherever you need a #, and then redefine | |
6177 | % it to # just before using the token list produced. | |
6178 | % | |
6179 | % The same technique is used to protect \eatspaces till just before | |
6180 | % the macro is used. | |
6181 | ||
6182 | \def\parsemargdef#1;{\paramno=0\def\paramlist{}% | |
6183 | \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} | |
6184 | \def\parsemargdefxxx#1,{% | |
6185 | \if#1;\let\next=\relax | |
6186 | \else \let\next=\parsemargdefxxx | |
6187 | \advance\paramno by 1% | |
6188 | \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname | |
6189 | {\xeatspaces{\hash\the\paramno}}% | |
6190 | \edef\paramlist{\paramlist\hash\the\paramno,}% | |
6191 | \fi\next} | |
6192 | ||
6193 | % These two commands read recursive and nonrecursive macro bodies. | |
6194 | % (They're different since rec and nonrec macros end differently.) | |
6195 | ||
6196 | \long\def\parsemacbody#1@end macro% | |
6197 | {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% | |
6198 | \long\def\parsermacbody#1@end rmacro% | |
6199 | {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% | |
6200 | ||
6201 | % This defines the macro itself. There are six cases: recursive and | |
6202 | % nonrecursive macros of zero, one, and many arguments. | |
6203 | % Much magic with \expandafter here. | |
6204 | % \xdef is used so that macro definitions will survive the file | |
6205 | % they're defined in; @include reads the file inside a group. | |
6206 | \def\defmacro{% | |
6207 | \let\hash=##% convert placeholders to macro parameter chars | |
6208 | \ifrecursive | |
6209 | \ifcase\paramno | |
6210 | % 0 | |
6211 | \expandafter\xdef\csname\the\macname\endcsname{% | |
6212 | \noexpand\scanmacro{\temp}}% | |
6213 | \or % 1 | |
6214 | \expandafter\xdef\csname\the\macname\endcsname{% | |
6215 | \bgroup\noexpand\macroargctxt | |
6216 | \noexpand\braceorline | |
6217 | \expandafter\noexpand\csname\the\macname xxx\endcsname}% | |
6218 | \expandafter\xdef\csname\the\macname xxx\endcsname##1{% | |
6219 | \egroup\noexpand\scanmacro{\temp}}% | |
6220 | \else % many | |
6221 | \expandafter\xdef\csname\the\macname\endcsname{% | |
6222 | \bgroup\noexpand\macroargctxt | |
6223 | \noexpand\csname\the\macname xx\endcsname}% | |
6224 | \expandafter\xdef\csname\the\macname xx\endcsname##1{% | |
6225 | \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% | |
6226 | \expandafter\expandafter | |
6227 | \expandafter\xdef | |
6228 | \expandafter\expandafter | |
6229 | \csname\the\macname xxx\endcsname | |
6230 | \paramlist{\egroup\noexpand\scanmacro{\temp}}% | |
6231 | \fi | |
6232 | \else | |
6233 | \ifcase\paramno | |
6234 | % 0 | |
6235 | \expandafter\xdef\csname\the\macname\endcsname{% | |
6236 | \noexpand\norecurse{\the\macname}% | |
6237 | \noexpand\scanmacro{\temp}\egroup}% | |
6238 | \or % 1 | |
6239 | \expandafter\xdef\csname\the\macname\endcsname{% | |
6240 | \bgroup\noexpand\macroargctxt | |
6241 | \noexpand\braceorline | |
6242 | \expandafter\noexpand\csname\the\macname xxx\endcsname}% | |
6243 | \expandafter\xdef\csname\the\macname xxx\endcsname##1{% | |
6244 | \egroup | |
6245 | \noexpand\norecurse{\the\macname}% | |
6246 | \noexpand\scanmacro{\temp}\egroup}% | |
6247 | \else % many | |
6248 | \expandafter\xdef\csname\the\macname\endcsname{% | |
6249 | \bgroup\noexpand\macroargctxt | |
6250 | \expandafter\noexpand\csname\the\macname xx\endcsname}% | |
6251 | \expandafter\xdef\csname\the\macname xx\endcsname##1{% | |
6252 | \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% | |
6253 | \expandafter\expandafter | |
6254 | \expandafter\xdef | |
6255 | \expandafter\expandafter | |
6256 | \csname\the\macname xxx\endcsname | |
6257 | \paramlist{% | |
6258 | \egroup | |
6259 | \noexpand\norecurse{\the\macname}% | |
6260 | \noexpand\scanmacro{\temp}\egroup}% | |
6261 | \fi | |
6262 | \fi} | |
6263 | ||
6264 | \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} | |
6265 | ||
6266 | % \braceorline decides whether the next nonwhitespace character is a | |
6267 | % {. If so it reads up to the closing }, if not, it reads the whole | |
6268 | % line. Whatever was read is then fed to the next control sequence | |
6269 | % as an argument (by \parsebrace or \parsearg) | |
0f9c1975 | 6270 | \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} |
2c825956 GM |
6271 | \def\braceorlinexxx{% |
6272 | \ifx\nchar\bgroup\else | |
6273 | \expandafter\parsearg | |
0f9c1975 | 6274 | \fi \macnamexxx} |
2c825956 GM |
6275 | |
6276 | ||
6277 | % @alias. | |
6278 | % We need some trickery to remove the optional spaces around the equal | |
6279 | % sign. Just make them active and then expand them all to nothing. | |
0f9c1975 | 6280 | \def\alias{\parseargusing\obeyspaces\aliasxxx} |
2c825956 | 6281 | \def\aliasxxx #1{\aliasyyy#1\relax} |
0f9c1975 KB |
6282 | \def\aliasyyy #1=#2\relax{% |
6283 | {% | |
6284 | \expandafter\let\obeyedspace=\empty | |
6285 | \addtomacrolist{#1}% | |
6286 | \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% | |
6287 | }% | |
6288 | \next | |
6289 | } | |
2c825956 GM |
6290 | |
6291 | ||
6292 | \message{cross references,} | |
2c825956 GM |
6293 | |
6294 | \newwrite\auxfile | |
2c825956 GM |
6295 | \newif\ifhavexrefs % True if xref values are known. |
6296 | \newif\ifwarnedxrefs % True if we warned once that they aren't known. | |
6297 | ||
6298 | % @inforef is relatively simple. | |
6299 | \def\inforef #1{\inforefzzz #1,,,,**} | |
6300 | \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, | |
6301 | node \samp{\ignorespaces#1{}}} | |
6302 | ||
0f9c1975 KB |
6303 | % @node's only job in TeX is to define \lastnode, which is used in |
6304 | % cross-references. The @node line might or might not have commas, and | |
6305 | % might or might not have spaces before the first comma, like: | |
6306 | % @node foo , bar , ... | |
6307 | % We don't want such trailing spaces in the node name. | |
6308 | % | |
6309 | \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse} | |
6310 | % | |
6311 | % also remove a trailing comma, in case of something like this: | |
6312 | % @node Help-Cross, , , Cross-refs | |
6313 | \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse} | |
6314 | \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}} | |
6315 | ||
2c825956 | 6316 | \let\nwnode=\node |
0f9c1975 KB |
6317 | \let\lastnode=\empty |
6318 | ||
6319 | % Write a cross-reference definition for the current node. #1 is the | |
6320 | % type (Ynumbered, Yappendix, Ynothing). | |
6321 | % | |
6322 | \def\donoderef#1{% | |
6323 | \ifx\lastnode\empty\else | |
6324 | \setref{\lastnode}{#1}% | |
6325 | \global\let\lastnode=\empty | |
2c825956 GM |
6326 | \fi |
6327 | } | |
6328 | ||
2c825956 GM |
6329 | % @anchor{NAME} -- define xref target at arbitrary point. |
6330 | % | |
6331 | \newcount\savesfregister | |
0f9c1975 KB |
6332 | % |
6333 | \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} | |
6334 | \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} | |
6335 | \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} | |
6336 | ||
6337 | % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an | |
6338 | % anchor), which consists of three parts: | |
6339 | % 1) NAME-title - the current sectioning name taken from \thissection, | |
6340 | % or the anchor name. | |
6341 | % 2) NAME-snt - section number and type, passed as the SNT arg, or | |
6342 | % empty for anchors. | |
6343 | % 3) NAME-pg - the page number. | |
6344 | % | |
6345 | % This is called from \donoderef, \anchor, and \dofloat. In the case of | |
6346 | % floats, there is an additional part, which is not written here: | |
6347 | % 4) NAME-lof - the text as it should appear in a @listoffloats. | |
6348 | % | |
6349 | \def\setref#1#2{% | |
2c825956 | 6350 | \pdfmkdest{#1}% |
0f9c1975 KB |
6351 | \iflinks |
6352 | {% | |
6353 | \atdummies % preserve commands, but don't expand them | |
6354 | \edef\writexrdef##1##2{% | |
6355 | \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef | |
6356 | ##1}{##2}}% these are parameters of \writexrdef | |
6357 | }% | |
6358 | \toks0 = \expandafter{\thissection}% | |
6359 | \immediate \writexrdef{title}{\the\toks0 }% | |
6360 | \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. | |
98bf69dc | 6361 | \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout |
0f9c1975 KB |
6362 | }% |
6363 | \fi | |
6364 | } | |
2c825956 GM |
6365 | |
6366 | % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is | |
6367 | % the node name, #2 the name of the Info cross-reference, #3 the printed | |
6368 | % node name, #4 the name of the Info file, #5 the name of the printed | |
6369 | % manual. All but the node name can be omitted. | |
6370 | % | |
6371 | \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} | |
6372 | \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} | |
6373 | \def\ref#1{\xrefX[#1,,,,,,,]} | |
6374 | \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup | |
6375 | \unsepspaces | |
6376 | \def\printedmanual{\ignorespaces #5}% | |
0f9c1975 KB |
6377 | \def\printedrefname{\ignorespaces #3}% |
6378 | \setbox1=\hbox{\printedmanual\unskip}% | |
6379 | \setbox0=\hbox{\printedrefname\unskip}% | |
2c825956 GM |
6380 | \ifdim \wd0 = 0pt |
6381 | % No printed node name was explicitly given. | |
6382 | \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax | |
6383 | % Use the node name inside the square brackets. | |
0f9c1975 | 6384 | \def\printedrefname{\ignorespaces #1}% |
2c825956 GM |
6385 | \else |
6386 | % Use the actual chapter/section title appear inside | |
6387 | % the square brackets. Use the real section title if we have it. | |
6388 | \ifdim \wd1 > 0pt | |
6389 | % It is in another manual, so we don't have it. | |
0f9c1975 | 6390 | \def\printedrefname{\ignorespaces #1}% |
2c825956 GM |
6391 | \else |
6392 | \ifhavexrefs | |
6393 | % We know the real title if we have the xref values. | |
0f9c1975 | 6394 | \def\printedrefname{\refx{#1-title}{}}% |
2c825956 GM |
6395 | \else |
6396 | % Otherwise just copy the Info node name. | |
0f9c1975 | 6397 | \def\printedrefname{\ignorespaces #1}% |
2c825956 GM |
6398 | \fi% |
6399 | \fi | |
6400 | \fi | |
6401 | \fi | |
6402 | % | |
0f9c1975 | 6403 | % Make link in pdf output. |
2c825956 GM |
6404 | \ifpdf |
6405 | \leavevmode | |
6406 | \getfilename{#4}% | |
98bf69dc KB |
6407 | {\indexnofonts |
6408 | \turnoffactive | |
0f9c1975 KB |
6409 | % See comments at \activebackslashdouble. |
6410 | {\activebackslashdouble \xdef\pdfxrefdest{#1}% | |
6411 | \backslashparens\pdfxrefdest}% | |
6412 | % | |
08b16a02 PJ |
6413 | \ifnum\filenamelength>0 |
6414 | \startlink attr{/Border [0 0 0]}% | |
0f9c1975 | 6415 | goto file{\the\filename.pdf} name{\pdfxrefdest}% |
08b16a02 PJ |
6416 | \else |
6417 | \startlink attr{/Border [0 0 0]}% | |
0f9c1975 | 6418 | goto name{\pdfmkpgn{\pdfxrefdest}}% |
08b16a02 PJ |
6419 | \fi |
6420 | }% | |
2c825956 GM |
6421 | \linkcolor |
6422 | \fi | |
6423 | % | |
0f9c1975 KB |
6424 | % Float references are printed completely differently: "Figure 1.2" |
6425 | % instead of "[somenode], p.3". We distinguish them by the | |
6426 | % LABEL-title being set to a magic string. | |
6427 | {% | |
6428 | % Have to otherify everything special to allow the \csname to | |
6429 | % include an _ in the xref name, etc. | |
6430 | \indexnofonts | |
6431 | \turnoffactive | |
6432 | \expandafter\global\expandafter\let\expandafter\Xthisreftitle | |
6433 | \csname XR#1-title\endcsname | |
6434 | }% | |
6435 | \iffloat\Xthisreftitle | |
6436 | % If the user specified the print name (third arg) to the ref, | |
6437 | % print it instead of our usual "Figure 1.2". | |
6438 | \ifdim\wd0 = 0pt | |
6439 | \refx{#1-snt}{}% | |
6440 | \else | |
6441 | \printedrefname | |
6442 | \fi | |
6443 | % | |
6444 | % if the user also gave the printed manual name (fifth arg), append | |
6445 | % "in MANUALNAME". | |
6446 | \ifdim \wd1 > 0pt | |
6447 | \space \putwordin{} \cite{\printedmanual}% | |
6448 | \fi | |
2c825956 | 6449 | \else |
0f9c1975 KB |
6450 | % node/anchor (non-float) references. |
6451 | % | |
6452 | % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not | |
6453 | % insert empty discretionaries after hyphens, which means that it will | |
6454 | % not find a line break at a hyphen in a node names. Since some manuals | |
6455 | % are best written with fairly long node names, containing hyphens, this | |
6456 | % is a loss. Therefore, we give the text of the node name again, so it | |
6457 | % is as if TeX is seeing it for the first time. | |
6458 | \ifdim \wd1 > 0pt | |
6459 | \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}% | |
6460 | \else | |
6461 | % _ (for example) has to be the character _ for the purposes of the | |
6462 | % control sequence corresponding to the node, but it has to expand | |
6463 | % into the usual \leavevmode...\vrule stuff for purposes of | |
6464 | % printing. So we \turnoffactive for the \refx-snt, back on for the | |
6465 | % printing, back off for the \refx-pg. | |
6466 | {\turnoffactive | |
6467 | % Only output a following space if the -snt ref is nonempty; for | |
6468 | % @unnumbered and @anchor, it won't be. | |
6469 | \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% | |
6470 | \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi | |
6471 | }% | |
6472 | % output the `[mynode]' via a macro so it can be overridden. | |
6473 | \xrefprintnodename\printedrefname | |
6474 | % | |
6475 | % But we always want a comma and a space: | |
6476 | ,\space | |
6477 | % | |
6478 | % output the `page 3'. | |
6479 | \turnoffactive \putwordpage\tie\refx{#1-pg}{}% | |
6480 | \fi | |
2c825956 GM |
6481 | \fi |
6482 | \endlink | |
6483 | \endgroup} | |
6484 | ||
0f9c1975 KB |
6485 | % This macro is called from \xrefX for the `[nodename]' part of xref |
6486 | % output. It's a separate macro only so it can be changed more easily, | |
6487 | % since square brackets don't work well in some documents. Particularly | |
6488 | % one that Bob is working on :). | |
6489 | % | |
6490 | \def\xrefprintnodename#1{[#1]} | |
2c825956 | 6491 | |
0f9c1975 | 6492 | % Things referred to by \setref. |
2c825956 | 6493 | % |
0f9c1975 KB |
6494 | \def\Ynothing{} |
6495 | \def\Yomitfromtoc{} | |
6496 | \def\Ynumbered{% | |
6497 | \ifnum\secno=0 | |
6498 | \putwordChapter@tie \the\chapno | |
6499 | \else \ifnum\subsecno=0 | |
6500 | \putwordSection@tie \the\chapno.\the\secno | |
6501 | \else \ifnum\subsubsecno=0 | |
6502 | \putwordSection@tie \the\chapno.\the\secno.\the\subsecno | |
6503 | \else | |
6504 | \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno | |
6505 | \fi\fi\fi | |
6506 | } | |
6507 | \def\Yappendix{% | |
6508 | \ifnum\secno=0 | |
6509 | \putwordAppendix@tie @char\the\appendixno{}% | |
6510 | \else \ifnum\subsecno=0 | |
6511 | \putwordSection@tie @char\the\appendixno.\the\secno | |
6512 | \else \ifnum\subsubsecno=0 | |
6513 | \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno | |
6514 | \else | |
6515 | \putwordSection@tie | |
6516 | @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno | |
6517 | \fi\fi\fi | |
6518 | } | |
2c825956 GM |
6519 | |
6520 | % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. | |
6521 | % If its value is nonempty, SUFFIX is output afterward. | |
0f9c1975 | 6522 | % |
2c825956 | 6523 | \def\refx#1#2{% |
0f9c1975 KB |
6524 | {% |
6525 | \indexnofonts | |
6526 | \otherbackslash | |
6527 | \expandafter\global\expandafter\let\expandafter\thisrefX | |
6528 | \csname XR#1\endcsname | |
6529 | }% | |
6530 | \ifx\thisrefX\relax | |
2c825956 GM |
6531 | % If not defined, say something at least. |
6532 | \angleleft un\-de\-fined\angleright | |
6533 | \iflinks | |
6534 | \ifhavexrefs | |
6535 | \message{\linenumber Undefined cross reference `#1'.}% | |
6536 | \else | |
6537 | \ifwarnedxrefs\else | |
6538 | \global\warnedxrefstrue | |
6539 | \message{Cross reference values unknown; you must run TeX again.}% | |
6540 | \fi | |
6541 | \fi | |
6542 | \fi | |
6543 | \else | |
6544 | % It's defined, so just use it. | |
0f9c1975 | 6545 | \thisrefX |
2c825956 GM |
6546 | \fi |
6547 | #2% Output the suffix in any case. | |
6548 | } | |
6549 | ||
0f9c1975 KB |
6550 | % This is the macro invoked by entries in the aux file. Usually it's |
6551 | % just a \def (we prepend XR to the control sequence name to avoid | |
6552 | % collisions). But if this is a float type, we have more work to do. | |
2c825956 | 6553 | % |
0f9c1975 | 6554 | \def\xrdef#1#2{% |
98bf69dc KB |
6555 | {% The node name might contain 8-bit characters, which in our current |
6556 | % implementation are changed to commands like @'e. Don't let these | |
6557 | % mess up the control sequence name. | |
6558 | \indexnofonts | |
6559 | \turnoffactive | |
6560 | \xdef\safexrefname{#1}% | |
6561 | }% | |
6562 | % | |
6563 | \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref | |
0f9c1975 KB |
6564 | % |
6565 | % Was that xref control sequence that we just defined for a float? | |
98bf69dc | 6566 | \expandafter\iffloat\csname XR\safexrefname\endcsname |
0f9c1975 KB |
6567 | % it was a float, and we have the (safe) float type in \iffloattype. |
6568 | \expandafter\let\expandafter\floatlist | |
6569 | \csname floatlist\iffloattype\endcsname | |
6570 | % | |
6571 | % Is this the first time we've seen this float type? | |
6572 | \expandafter\ifx\floatlist\relax | |
6573 | \toks0 = {\do}% yes, so just \do | |
6574 | \else | |
6575 | % had it before, so preserve previous elements in list. | |
6576 | \toks0 = \expandafter{\floatlist\do}% | |
6577 | \fi | |
6578 | % | |
6579 | % Remember this xref in the control sequence \floatlistFLOATTYPE, | |
6580 | % for later use in \listoffloats. | |
98bf69dc KB |
6581 | \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0 |
6582 | {\safexrefname}}% | |
0f9c1975 | 6583 | \fi |
2c825956 GM |
6584 | } |
6585 | ||
6586 | % Read the last existing aux file, if any. No error if none exists. | |
0f9c1975 KB |
6587 | % |
6588 | \def\tryauxfile{% | |
6589 | \openin 1 \jobname.aux | |
6590 | \ifeof 1 \else | |
6591 | \readdatafile{aux}% | |
6592 | \global\havexrefstrue | |
6593 | \fi | |
6594 | \closein 1 | |
6595 | } | |
6596 | ||
6597 | \def\setupdatafile{% | |
2c825956 GM |
6598 | \catcode`\^^@=\other |
6599 | \catcode`\^^A=\other | |
6600 | \catcode`\^^B=\other | |
6601 | \catcode`\^^C=\other | |
6602 | \catcode`\^^D=\other | |
6603 | \catcode`\^^E=\other | |
6604 | \catcode`\^^F=\other | |
6605 | \catcode`\^^G=\other | |
6606 | \catcode`\^^H=\other | |
6607 | \catcode`\^^K=\other | |
6608 | \catcode`\^^L=\other | |
6609 | \catcode`\^^N=\other | |
6610 | \catcode`\^^P=\other | |
6611 | \catcode`\^^Q=\other | |
6612 | \catcode`\^^R=\other | |
6613 | \catcode`\^^S=\other | |
6614 | \catcode`\^^T=\other | |
6615 | \catcode`\^^U=\other | |
6616 | \catcode`\^^V=\other | |
6617 | \catcode`\^^W=\other | |
6618 | \catcode`\^^X=\other | |
6619 | \catcode`\^^Z=\other | |
6620 | \catcode`\^^[=\other | |
6621 | \catcode`\^^\=\other | |
6622 | \catcode`\^^]=\other | |
6623 | \catcode`\^^^=\other | |
6624 | \catcode`\^^_=\other | |
0f9c1975 | 6625 | % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. |
2c825956 GM |
6626 | % in xref tags, i.e., node names. But since ^^e4 notation isn't |
6627 | % supported in the main text, it doesn't seem desirable. Furthermore, | |
6628 | % that is not enough: for node names that actually contain a ^ | |
6629 | % character, we would end up writing a line like this: 'xrdef {'hat | |
6630 | % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first | |
6631 | % argument, and \hat is not an expandable control sequence. It could | |
6632 | % all be worked out, but why? Either we support ^^ or we don't. | |
6633 | % | |
6634 | % The other change necessary for this was to define \auxhat: | |
6635 | % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter | |
6636 | % and then to call \auxhat in \setq. | |
6637 | % | |
0f9c1975 KB |
6638 | \catcode`\^=\other |
6639 | % | |
6640 | % Special characters. Should be turned off anyway, but... | |
2c825956 GM |
6641 | \catcode`\~=\other |
6642 | \catcode`\[=\other | |
6643 | \catcode`\]=\other | |
6644 | \catcode`\"=\other | |
6645 | \catcode`\_=\other | |
6646 | \catcode`\|=\other | |
6647 | \catcode`\<=\other | |
6648 | \catcode`\>=\other | |
6649 | \catcode`\$=\other | |
6650 | \catcode`\#=\other | |
6651 | \catcode`\&=\other | |
0f9c1975 | 6652 | \catcode`\%=\other |
2c825956 | 6653 | \catcode`+=\other % avoid \+ for paranoia even though we've turned it off |
0f9c1975 KB |
6654 | % |
6655 | % This is to support \ in node names and titles, since the \ | |
6656 | % characters end up in a \csname. It's easier than | |
6657 | % leaving it active and making its active definition an actual \ | |
6658 | % character. What I don't understand is why it works in the *value* | |
6659 | % of the xrdef. Seems like it should be a catcode12 \, and that | |
6660 | % should not typeset properly. But it works, so I'm moving on for | |
6661 | % now. --karl, 15jan04. | |
6662 | \catcode`\\=\other | |
6663 | % | |
6664 | % Make the characters 128-255 be printing characters. | |
2c825956 | 6665 | {% |
0f9c1975 | 6666 | \count1=128 |
2c825956 | 6667 | \def\loop{% |
0f9c1975 KB |
6668 | \catcode\count1=\other |
6669 | \advance\count1 by 1 | |
6670 | \ifnum \count1<256 \loop \fi | |
2c825956 GM |
6671 | }% |
6672 | }% | |
0f9c1975 KB |
6673 | % |
6674 | % @ is our escape character in .aux files, and we need braces. | |
2c825956 GM |
6675 | \catcode`\{=1 |
6676 | \catcode`\}=2 | |
0f9c1975 KB |
6677 | \catcode`\@=0 |
6678 | } | |
2c825956 | 6679 | |
0f9c1975 KB |
6680 | \def\readdatafile#1{% |
6681 | \begingroup | |
6682 | \setupdatafile | |
6683 | \input\jobname.#1 | |
6684 | \endgroup} | |
2c825956 | 6685 | |
98bf69dc | 6686 | |
0f9c1975 KB |
6687 | \message{insertions,} |
6688 | % including footnotes. | |
2c825956 GM |
6689 | |
6690 | \newcount \footnoteno | |
6691 | ||
6692 | % The trailing space in the following definition for supereject is | |
6693 | % vital for proper filling; pages come out unaligned when you do a | |
6694 | % pagealignmacro call if that space before the closing brace is | |
6695 | % removed. (Generally, numeric constants should always be followed by a | |
6696 | % space to prevent strange expansion errors.) | |
6697 | \def\supereject{\par\penalty -20000\footnoteno =0 } | |
6698 | ||
6699 | % @footnotestyle is meaningful for info output only. | |
6700 | \let\footnotestyle=\comment | |
6701 | ||
2c825956 GM |
6702 | {\catcode `\@=11 |
6703 | % | |
6704 | % Auto-number footnotes. Otherwise like plain. | |
6705 | \gdef\footnote{% | |
0f9c1975 KB |
6706 | \let\indent=\ptexindent |
6707 | \let\noindent=\ptexnoindent | |
2c825956 GM |
6708 | \global\advance\footnoteno by \@ne |
6709 | \edef\thisfootno{$^{\the\footnoteno}$}% | |
6710 | % | |
6711 | % In case the footnote comes at the end of a sentence, preserve the | |
6712 | % extra spacing after we do the footnote number. | |
6713 | \let\@sf\empty | |
0f9c1975 | 6714 | \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi |
2c825956 GM |
6715 | % |
6716 | % Remove inadvertent blank space before typesetting the footnote number. | |
6717 | \unskip | |
6718 | \thisfootno\@sf | |
0f9c1975 | 6719 | \dofootnote |
2c825956 GM |
6720 | }% |
6721 | ||
6722 | % Don't bother with the trickery in plain.tex to not require the | |
6723 | % footnote text as a parameter. Our footnotes don't need to be so general. | |
6724 | % | |
0f9c1975 KB |
6725 | % Oh yes, they do; otherwise, @ifset (and anything else that uses |
6726 | % \parseargline) fails inside footnotes because the tokens are fixed when | |
2c825956 GM |
6727 | % the footnote is read. --karl, 16nov96. |
6728 | % | |
0f9c1975 KB |
6729 | \gdef\dofootnote{% |
6730 | \insert\footins\bgroup | |
2c825956 GM |
6731 | % We want to typeset this text as a normal paragraph, even if the |
6732 | % footnote reference occurs in (for example) a display environment. | |
6733 | % So reset some parameters. | |
0f9c1975 | 6734 | \hsize=\pagewidth |
2c825956 GM |
6735 | \interlinepenalty\interfootnotelinepenalty |
6736 | \splittopskip\ht\strutbox % top baseline for broken footnotes | |
6737 | \splitmaxdepth\dp\strutbox | |
6738 | \floatingpenalty\@MM | |
6739 | \leftskip\z@skip | |
6740 | \rightskip\z@skip | |
6741 | \spaceskip\z@skip | |
6742 | \xspaceskip\z@skip | |
6743 | \parindent\defaultparindent | |
6744 | % | |
6745 | \smallfonts \rm | |
6746 | % | |
08b16a02 PJ |
6747 | % Because we use hanging indentation in footnotes, a @noindent appears |
6748 | % to exdent this text, so make it be a no-op. makeinfo does not use | |
6749 | % hanging indentation so @noindent can still be needed within footnote | |
6750 | % text after an @example or the like (not that this is good style). | |
6751 | \let\noindent = \relax | |
6752 | % | |
6753 | % Hang the footnote text off the number. Use \everypar in case the | |
6754 | % footnote extends for more than one paragraph. | |
6755 | \everypar = {\hang}% | |
2c825956 GM |
6756 | \textindent{\thisfootno}% |
6757 | % | |
6758 | % Don't crash into the line above the footnote text. Since this | |
6759 | % expands into a box, it must come within the paragraph, lest it | |
6760 | % provide a place where TeX can split the footnote. | |
6761 | \footstrut | |
6762 | \futurelet\next\fo@t | |
6763 | } | |
2c825956 GM |
6764 | }%end \catcode `\@=11 |
6765 | ||
0f9c1975 KB |
6766 | % In case a @footnote appears in a vbox, save the footnote text and create |
6767 | % the real \insert just after the vbox finished. Otherwise, the insertion | |
6768 | % would be lost. | |
6769 | % Similarily, if a @footnote appears inside an alignment, save the footnote | |
6770 | % text to a box and make the \insert when a row of the table is finished. | |
6771 | % And the same can be done for other insert classes. --kasal, 16nov03. | |
6772 | ||
6773 | % Replace the \insert primitive by a cheating macro. | |
6774 | % Deeper inside, just make sure that the saved insertions are not spilled | |
6775 | % out prematurely. | |
2c825956 | 6776 | % |
0f9c1975 KB |
6777 | \def\startsavinginserts{% |
6778 | \ifx \insert\ptexinsert | |
6779 | \let\insert\saveinsert | |
6780 | \else | |
6781 | \let\checkinserts\relax | |
6782 | \fi | |
2c825956 GM |
6783 | } |
6784 | ||
0f9c1975 KB |
6785 | % This \insert replacement works for both \insert\footins{foo} and |
6786 | % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. | |
2c825956 | 6787 | % |
0f9c1975 KB |
6788 | \def\saveinsert#1{% |
6789 | \edef\next{\noexpand\savetobox \makeSAVEname#1}% | |
6790 | \afterassignment\next | |
6791 | % swallow the left brace | |
6792 | \let\temp = | |
6793 | } | |
6794 | \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} | |
6795 | \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} | |
6796 | ||
6797 | \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} | |
6798 | ||
6799 | \def\placesaveins#1{% | |
6800 | \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname | |
6801 | {\box#1}% | |
6802 | } | |
6803 | ||
6804 | % eat @SAVE -- beware, all of them have catcode \other: | |
6805 | { | |
6806 | \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) | |
6807 | \gdef\gobblesave @SAVE{} | |
6808 | } | |
6809 | ||
6810 | % initialization: | |
6811 | \def\newsaveins #1{% | |
6812 | \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% | |
6813 | \next | |
6814 | } | |
6815 | \def\newsaveinsX #1{% | |
6816 | \csname newbox\endcsname #1% | |
6817 | \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts | |
6818 | \checksaveins #1}% | |
6819 | } | |
6820 | ||
6821 | % initialize: | |
6822 | \let\checkinserts\empty | |
6823 | \newsaveins\footins | |
6824 | \newsaveins\margin | |
6825 | ||
2c825956 GM |
6826 | |
6827 | % @image. We use the macros from epsf.tex to support this. | |
6828 | % If epsf.tex is not installed and @image is used, we complain. | |
6829 | % | |
6830 | % Check for and read epsf.tex up front. If we read it only at @image | |
6831 | % time, we might be inside a group, and then its definitions would get | |
6832 | % undone and the next image would fail. | |
6833 | \openin 1 = epsf.tex | |
6834 | \ifeof 1 \else | |
0f9c1975 KB |
6835 | % Do not bother showing banner with epsf.tex v2.7k (available in |
6836 | % doc/epsf.tex and on ctan). | |
2c825956 GM |
6837 | \def\epsfannounce{\toks0 = }% |
6838 | \input epsf.tex | |
6839 | \fi | |
0f9c1975 | 6840 | \closein 1 |
2c825956 GM |
6841 | % |
6842 | % We will only complain once about lack of epsf.tex. | |
6843 | \newif\ifwarnednoepsf | |
6844 | \newhelp\noepsfhelp{epsf.tex must be installed for images to | |
6845 | work. It is also included in the Texinfo distribution, or you can get | |
6846 | it from ftp://tug.org/tex/epsf.tex.} | |
6847 | % | |
6848 | \def\image#1{% | |
6849 | \ifx\epsfbox\undefined | |
6850 | \ifwarnednoepsf \else | |
6851 | \errhelp = \noepsfhelp | |
6852 | \errmessage{epsf.tex not found, images will be ignored}% | |
6853 | \global\warnednoepsftrue | |
6854 | \fi | |
6855 | \else | |
08b16a02 | 6856 | \imagexxx #1,,,,,\finish |
2c825956 GM |
6857 | \fi |
6858 | } | |
6859 | % | |
6860 | % Arguments to @image: | |
6861 | % #1 is (mandatory) image filename; we tack on .eps extension. | |
6862 | % #2 is (optional) width, #3 is (optional) height. | |
08b16a02 PJ |
6863 | % #4 is (ignored optional) html alt text. |
6864 | % #5 is (ignored optional) extension. | |
6865 | % #6 is just the usual extra ignored arg for parsing this stuff. | |
6866 | \newif\ifimagevmode | |
6867 | \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup | |
6868 | \catcode`\^^M = 5 % in case we're inside an example | |
6869 | \normalturnoffactive % allow _ et al. in names | |
6870 | % If the image is by itself, center it. | |
6871 | \ifvmode | |
6872 | \imagevmodetrue | |
6873 | \nobreak\bigskip | |
6874 | % Usually we'll have text after the image which will insert | |
6875 | % \parskip glue, so insert it here too to equalize the space | |
177c0ea7 | 6876 | % above and below. |
08b16a02 PJ |
6877 | \nobreak\vskip\parskip |
6878 | \nobreak | |
0f9c1975 | 6879 | \line\bgroup |
08b16a02 PJ |
6880 | \fi |
6881 | % | |
6882 | % Output the image. | |
2c825956 | 6883 | \ifpdf |
08b16a02 | 6884 | \dopdfimage{#1}{#2}{#3}% |
2c825956 GM |
6885 | \else |
6886 | % \epsfbox itself resets \epsf?size at each figure. | |
6887 | \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi | |
6888 | \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi | |
08b16a02 | 6889 | \epsfbox{#1.eps}% |
2c825956 | 6890 | \fi |
08b16a02 | 6891 | % |
0f9c1975 | 6892 | \ifimagevmode \egroup \bigbreak \fi % space after the image |
08b16a02 | 6893 | \endgroup} |
2c825956 GM |
6894 | |
6895 | ||
0f9c1975 KB |
6896 | % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables, |
6897 | % etc. We don't actually implement floating yet, we always include the | |
6898 | % float "here". But it seemed the best name for the future. | |
6899 | % | |
6900 | \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish} | |
6901 | ||
6902 | % There may be a space before second and/or third parameter; delete it. | |
6903 | \def\eatcommaspace#1, {#1,} | |
6904 | ||
6905 | % #1 is the optional FLOATTYPE, the text label for this float, typically | |
6906 | % "Figure", "Table", "Example", etc. Can't contain commas. If omitted, | |
6907 | % this float will not be numbered and cannot be referred to. | |
6908 | % | |
6909 | % #2 is the optional xref label. Also must be present for the float to | |
6910 | % be referable. | |
6911 | % | |
6912 | % #3 is the optional positioning argument; for now, it is ignored. It | |
6913 | % will somehow specify the positions allowed to float to (here, top, bottom). | |
6914 | % | |
6915 | % We keep a separate counter for each FLOATTYPE, which we reset at each | |
6916 | % chapter-level command. | |
6917 | \let\resetallfloatnos=\empty | |
6918 | % | |
6919 | \def\dofloat#1,#2,#3,#4\finish{% | |
6920 | \let\thiscaption=\empty | |
6921 | \let\thisshortcaption=\empty | |
6922 | % | |
6923 | % don't lose footnotes inside @float. | |
6924 | % | |
6925 | % BEWARE: when the floats start float, we have to issue warning whenever an | |
6926 | % insert appears inside a float which could possibly float. --kasal, 26may04 | |
6927 | % | |
6928 | \startsavinginserts | |
6929 | % | |
6930 | % We can't be used inside a paragraph. | |
6931 | \par | |
6932 | % | |
6933 | \vtop\bgroup | |
6934 | \def\floattype{#1}% | |
6935 | \def\floatlabel{#2}% | |
6936 | \def\floatloc{#3}% we do nothing with this yet. | |
6937 | % | |
6938 | \ifx\floattype\empty | |
6939 | \let\safefloattype=\empty | |
6940 | \else | |
6941 | {% | |
6942 | % the floattype might have accents or other special characters, | |
6943 | % but we need to use it in a control sequence name. | |
6944 | \indexnofonts | |
6945 | \turnoffactive | |
6946 | \xdef\safefloattype{\floattype}% | |
6947 | }% | |
6948 | \fi | |
6949 | % | |
6950 | % If label is given but no type, we handle that as the empty type. | |
6951 | \ifx\floatlabel\empty \else | |
6952 | % We want each FLOATTYPE to be numbered separately (Figure 1, | |
6953 | % Table 1, Figure 2, ...). (And if no label, no number.) | |
6954 | % | |
6955 | \expandafter\getfloatno\csname\safefloattype floatno\endcsname | |
6956 | \global\advance\floatno by 1 | |
6957 | % | |
6958 | {% | |
6959 | % This magic value for \thissection is output by \setref as the | |
6960 | % XREFLABEL-title value. \xrefX uses it to distinguish float | |
6961 | % labels (which have a completely different output format) from | |
6962 | % node and anchor labels. And \xrdef uses it to construct the | |
6963 | % lists of floats. | |
6964 | % | |
6965 | \edef\thissection{\floatmagic=\safefloattype}% | |
6966 | \setref{\floatlabel}{Yfloat}% | |
6967 | }% | |
6968 | \fi | |
6969 | % | |
6970 | % start with \parskip glue, I guess. | |
6971 | \vskip\parskip | |
6972 | % | |
6973 | % Don't suppress indentation if a float happens to start a section. | |
6974 | \restorefirstparagraphindent | |
6975 | } | |
6976 | ||
6977 | % we have these possibilities: | |
6978 | % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap | |
6979 | % @float Foo,lbl & no caption: Foo 1.1 | |
6980 | % @float Foo & @caption{Cap}: Foo: Cap | |
6981 | % @float Foo & no caption: Foo | |
6982 | % @float ,lbl & Caption{Cap}: 1.1: Cap | |
6983 | % @float ,lbl & no caption: 1.1 | |
6984 | % @float & @caption{Cap}: Cap | |
6985 | % @float & no caption: | |
6986 | % | |
6987 | \def\Efloat{% | |
6988 | \let\floatident = \empty | |
6989 | % | |
6990 | % In all cases, if we have a float type, it comes first. | |
6991 | \ifx\floattype\empty \else \def\floatident{\floattype}\fi | |
6992 | % | |
6993 | % If we have an xref label, the number comes next. | |
6994 | \ifx\floatlabel\empty \else | |
6995 | \ifx\floattype\empty \else % if also had float type, need tie first. | |
6996 | \appendtomacro\floatident{\tie}% | |
6997 | \fi | |
6998 | % the number. | |
6999 | \appendtomacro\floatident{\chaplevelprefix\the\floatno}% | |
7000 | \fi | |
7001 | % | |
7002 | % Start the printed caption with what we've constructed in | |
7003 | % \floatident, but keep it separate; we need \floatident again. | |
7004 | \let\captionline = \floatident | |
7005 | % | |
7006 | \ifx\thiscaption\empty \else | |
7007 | \ifx\floatident\empty \else | |
7008 | \appendtomacro\captionline{: }% had ident, so need a colon between | |
7009 | \fi | |
7010 | % | |
7011 | % caption text. | |
7012 | \appendtomacro\captionline{\scanexp\thiscaption}% | |
7013 | \fi | |
7014 | % | |
7015 | % If we have anything to print, print it, with space before. | |
7016 | % Eventually this needs to become an \insert. | |
7017 | \ifx\captionline\empty \else | |
7018 | \vskip.5\parskip | |
7019 | \captionline | |
7020 | % | |
7021 | % Space below caption. | |
7022 | \vskip\parskip | |
7023 | \fi | |
7024 | % | |
7025 | % If have an xref label, write the list of floats info. Do this | |
7026 | % after the caption, to avoid chance of it being a breakpoint. | |
7027 | \ifx\floatlabel\empty \else | |
7028 | % Write the text that goes in the lof to the aux file as | |
7029 | % \floatlabel-lof. Besides \floatident, we include the short | |
7030 | % caption if specified, else the full caption if specified, else nothing. | |
7031 | {% | |
7032 | \atdummies | |
7033 | % | |
7034 | % since we read the caption text in the macro world, where ^^M | |
7035 | % is turned into a normal character, we have to scan it back, so | |
7036 | % we don't write the literal three characters "^^M" into the aux file. | |
7037 | \scanexp{% | |
7038 | \xdef\noexpand\gtemp{% | |
7039 | \ifx\thisshortcaption\empty | |
7040 | \thiscaption | |
7041 | \else | |
7042 | \thisshortcaption | |
7043 | \fi | |
7044 | }% | |
7045 | }% | |
7046 | \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident | |
7047 | \ifx\gtemp\empty \else : \gtemp \fi}}% | |
7048 | }% | |
7049 | \fi | |
7050 | \egroup % end of \vtop | |
7051 | % | |
7052 | % place the captured inserts | |
7053 | % | |
7054 | % BEWARE: when the floats start floating, we have to issue warning | |
7055 | % whenever an insert appears inside a float which could possibly | |
7056 | % float. --kasal, 26may04 | |
7057 | % | |
7058 | \checkinserts | |
7059 | } | |
7060 | ||
7061 | % Append the tokens #2 to the definition of macro #1, not expanding either. | |
7062 | % | |
7063 | \def\appendtomacro#1#2{% | |
7064 | \expandafter\def\expandafter#1\expandafter{#1#2}% | |
7065 | } | |
7066 | ||
7067 | % @caption, @shortcaption | |
7068 | % | |
7069 | \def\caption{\docaption\thiscaption} | |
7070 | \def\shortcaption{\docaption\thisshortcaption} | |
7071 | \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption} | |
7072 | \def\defcaption#1#2{\egroup \def#1{#2}} | |
7073 | ||
7074 | % The parameter is the control sequence identifying the counter we are | |
7075 | % going to use. Create it if it doesn't exist and assign it to \floatno. | |
7076 | \def\getfloatno#1{% | |
7077 | \ifx#1\relax | |
7078 | % Haven't seen this figure type before. | |
7079 | \csname newcount\endcsname #1% | |
7080 | % | |
7081 | % Remember to reset this floatno at the next chap. | |
7082 | \expandafter\gdef\expandafter\resetallfloatnos | |
7083 | \expandafter{\resetallfloatnos #1=0 }% | |
7084 | \fi | |
7085 | \let\floatno#1% | |
7086 | } | |
7087 | ||
7088 | % \setref calls this to get the XREFLABEL-snt value. We want an @xref | |
7089 | % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we | |
7090 | % first read the @float command. | |
7091 | % | |
7092 | \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% | |
7093 | ||
7094 | % Magic string used for the XREFLABEL-title value, so \xrefX can | |
7095 | % distinguish floats from other xref types. | |
7096 | \def\floatmagic{!!float!!} | |
7097 | ||
7098 | % #1 is the control sequence we are passed; we expand into a conditional | |
7099 | % which is true if #1 represents a float ref. That is, the magic | |
7100 | % \thissection value which we \setref above. | |
7101 | % | |
7102 | \def\iffloat#1{\expandafter\doiffloat#1==\finish} | |
7103 | % | |
7104 | % #1 is (maybe) the \floatmagic string. If so, #2 will be the | |
7105 | % (safe) float type for this float. We set \iffloattype to #2. | |
7106 | % | |
7107 | \def\doiffloat#1=#2=#3\finish{% | |
7108 | \def\temp{#1}% | |
7109 | \def\iffloattype{#2}% | |
7110 | \ifx\temp\floatmagic | |
7111 | } | |
7112 | ||
7113 | % @listoffloats FLOATTYPE - print a list of floats like a table of contents. | |
7114 | % | |
7115 | \parseargdef\listoffloats{% | |
7116 | \def\floattype{#1}% floattype | |
7117 | {% | |
7118 | % the floattype might have accents or other special characters, | |
7119 | % but we need to use it in a control sequence name. | |
7120 | \indexnofonts | |
7121 | \turnoffactive | |
7122 | \xdef\safefloattype{\floattype}% | |
7123 | }% | |
7124 | % | |
7125 | % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. | |
7126 | \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax | |
7127 | \ifhavexrefs | |
7128 | % if the user said @listoffloats foo but never @float foo. | |
7129 | \message{\linenumber No `\safefloattype' floats to list.}% | |
7130 | \fi | |
7131 | \else | |
7132 | \begingroup | |
7133 | \leftskip=\tocindent % indent these entries like a toc | |
7134 | \let\do=\listoffloatsdo | |
7135 | \csname floatlist\safefloattype\endcsname | |
7136 | \endgroup | |
7137 | \fi | |
7138 | } | |
7139 | ||
7140 | % This is called on each entry in a list of floats. We're passed the | |
7141 | % xref label, in the form LABEL-title, which is how we save it in the | |
7142 | % aux file. We strip off the -title and look up \XRLABEL-lof, which | |
7143 | % has the text we're supposed to typeset here. | |
7144 | % | |
7145 | % Figures without xref labels will not be included in the list (since | |
7146 | % they won't appear in the aux file). | |
7147 | % | |
7148 | \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} | |
7149 | \def\listoffloatsdoentry#1-title\finish{{% | |
7150 | % Can't fully expand XR#1-lof because it can contain anything. Just | |
7151 | % pass the control sequence. On the other hand, XR#1-pg is just the | |
7152 | % page number, and we want to fully expand that so we can get a link | |
7153 | % in pdf output. | |
7154 | \toksA = \expandafter{\csname XR#1-lof\endcsname}% | |
7155 | % | |
7156 | % use the same \entry macro we use to generate the TOC and index. | |
7157 | \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}% | |
7158 | \writeentry | |
7159 | }} | |
7160 | ||
98bf69dc | 7161 | |
2c825956 | 7162 | \message{localization,} |
2c825956 GM |
7163 | |
7164 | % @documentlanguage is usually given very early, just after | |
7165 | % @setfilename. If done too late, it may not override everything | |
7166 | % properly. Single argument is the language abbreviation. | |
7167 | % It would be nice if we could set up a hyphenation file here. | |
7168 | % | |
0f9c1975 | 7169 | \parseargdef\documentlanguage{% |
2c825956 | 7170 | \tex % read txi-??.tex file in plain TeX. |
0f9c1975 KB |
7171 | % Read the file if it exists. |
7172 | \openin 1 txi-#1.tex | |
7173 | \ifeof 1 | |
7174 | \errhelp = \nolanghelp | |
7175 | \errmessage{Cannot read language file txi-#1.tex}% | |
7176 | \else | |
7177 | \input txi-#1.tex | |
7178 | \fi | |
7179 | \closein 1 | |
2c825956 GM |
7180 | \endgroup |
7181 | } | |
7182 | \newhelp\nolanghelp{The given language definition file cannot be found or | |
7183 | is empty. Maybe you need to install it? In the current directory | |
7184 | should work if nowhere else does.} | |
7185 | ||
98bf69dc KB |
7186 | % Set the catcode of characters 128 through 255 to the specified number. |
7187 | % | |
7188 | \def\setnonasciicharscatcode#1{% | |
7189 | \count255=128 | |
7190 | \loop\ifnum\count255<256 | |
7191 | \global\catcode\count255=#1 | |
7192 | \advance\count255 by 1 | |
7193 | \repeat | |
7194 | } | |
2c825956 | 7195 | |
98bf69dc KB |
7196 | % @documentencoding sets the definition of non-ASCII characters |
7197 | % according to the specified encoding. | |
7198 | % | |
7199 | \parseargdef\documentencoding{% | |
7200 | % Encoding being declared for the document. | |
7201 | \def\declaredencoding{\csname #1.enc\endcsname}% | |
7202 | % | |
7203 | % Supported encodings: names converted to tokens in order to be able | |
7204 | % to compare them with \ifx. | |
7205 | \def\ascii{\csname US-ASCII.enc\endcsname}% | |
7206 | \def\latnine{\csname ISO-8859-15.enc\endcsname}% | |
7207 | \def\latone{\csname ISO-8859-1.enc\endcsname}% | |
7208 | \def\lattwo{\csname ISO-8859-2.enc\endcsname}% | |
7209 | \def\utfeight{\csname UTF-8.enc\endcsname}% | |
7210 | % | |
7211 | \ifx \declaredencoding \ascii | |
7212 | \asciichardefs | |
7213 | % | |
7214 | \else \ifx \declaredencoding \lattwo | |
7215 | \setnonasciicharscatcode\active | |
7216 | \lattwochardefs | |
7217 | % | |
7218 | \else \ifx \declaredencoding \latone | |
7219 | \setnonasciicharscatcode\active | |
7220 | \latonechardefs | |
7221 | % | |
7222 | \else \ifx \declaredencoding \latnine | |
7223 | \setnonasciicharscatcode\active | |
7224 | \latninechardefs | |
7225 | % | |
7226 | \else \ifx \declaredencoding \utfeight | |
7227 | \setnonasciicharscatcode\active | |
7228 | \utfeightchardefs | |
7229 | % | |
7230 | \else | |
7231 | \message{Unknown document encoding #1, ignoring.}% | |
7232 | % | |
7233 | \fi % utfeight | |
7234 | \fi % latnine | |
7235 | \fi % latone | |
7236 | \fi % lattwo | |
7237 | \fi % ascii | |
7238 | } | |
2c825956 | 7239 | |
98bf69dc KB |
7240 | % A message to be logged when using a character that isn't available |
7241 | % the default font encoding (OT1). | |
7242 | % | |
7243 | \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}} | |
7244 | ||
7245 | % Take account of \c (plain) vs. \, (Texinfo) difference. | |
7246 | \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi} | |
7247 | ||
7248 | % First, make active non-ASCII characters in order for them to be | |
7249 | % correctly categorized when TeX reads the replacement text of | |
7250 | % macros containing the character definitions. | |
7251 | \setnonasciicharscatcode\active | |
7252 | % | |
7253 | % Latin1 (ISO-8859-1) character definitions. | |
7254 | \def\latonechardefs{% | |
7255 | \gdef^^a0{~} | |
7256 | \gdef^^a1{\exclamdown} | |
7257 | \gdef^^a2{\missingcharmsg{CENT SIGN}} | |
7258 | \gdef^^a3{{\pounds}} | |
7259 | \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} | |
7260 | \gdef^^a5{\missingcharmsg{YEN SIGN}} | |
7261 | \gdef^^a6{\missingcharmsg{BROKEN BAR}} | |
7262 | \gdef^^a7{\S} | |
7263 | \gdef^^a8{\"{}} | |
7264 | \gdef^^a9{\copyright} | |
7265 | \gdef^^aa{\ordf} | |
7266 | \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}} | |
7267 | \gdef^^ac{$\lnot$} | |
7268 | \gdef^^ad{\-} | |
7269 | \gdef^^ae{\registeredsymbol} | |
7270 | \gdef^^af{\={}} | |
7271 | % | |
7272 | \gdef^^b0{\textdegree} | |
7273 | \gdef^^b1{$\pm$} | |
7274 | \gdef^^b2{$^2$} | |
7275 | \gdef^^b3{$^3$} | |
7276 | \gdef^^b4{\'{}} | |
7277 | \gdef^^b5{$\mu$} | |
7278 | \gdef^^b6{\P} | |
7279 | % | |
7280 | \gdef^^b7{$^.$} | |
7281 | \gdef^^b8{\cedilla\ } | |
7282 | \gdef^^b9{$^1$} | |
7283 | \gdef^^ba{\ordm} | |
7284 | % | |
7285 | \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}} | |
7286 | \gdef^^bc{$1\over4$} | |
7287 | \gdef^^bd{$1\over2$} | |
7288 | \gdef^^be{$3\over4$} | |
7289 | \gdef^^bf{\questiondown} | |
7290 | % | |
7291 | \gdef^^c0{\`A} | |
7292 | \gdef^^c1{\'A} | |
7293 | \gdef^^c2{\^A} | |
7294 | \gdef^^c3{\~A} | |
7295 | \gdef^^c4{\"A} | |
7296 | \gdef^^c5{\ringaccent A} | |
7297 | \gdef^^c6{\AE} | |
7298 | \gdef^^c7{\cedilla C} | |
7299 | \gdef^^c8{\`E} | |
7300 | \gdef^^c9{\'E} | |
7301 | \gdef^^ca{\^E} | |
7302 | \gdef^^cb{\"E} | |
7303 | \gdef^^cc{\`I} | |
7304 | \gdef^^cd{\'I} | |
7305 | \gdef^^ce{\^I} | |
7306 | \gdef^^cf{\"I} | |
7307 | % | |
7308 | \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}} | |
7309 | \gdef^^d1{\~N} | |
7310 | \gdef^^d2{\`O} | |
7311 | \gdef^^d3{\'O} | |
7312 | \gdef^^d4{\^O} | |
7313 | \gdef^^d5{\~O} | |
7314 | \gdef^^d6{\"O} | |
7315 | \gdef^^d7{$\times$} | |
7316 | \gdef^^d8{\O} | |
7317 | \gdef^^d9{\`U} | |
7318 | \gdef^^da{\'U} | |
7319 | \gdef^^db{\^U} | |
7320 | \gdef^^dc{\"U} | |
7321 | \gdef^^dd{\'Y} | |
7322 | \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}} | |
7323 | \gdef^^df{\ss} | |
7324 | % | |
7325 | \gdef^^e0{\`a} | |
7326 | \gdef^^e1{\'a} | |
7327 | \gdef^^e2{\^a} | |
7328 | \gdef^^e3{\~a} | |
7329 | \gdef^^e4{\"a} | |
7330 | \gdef^^e5{\ringaccent a} | |
7331 | \gdef^^e6{\ae} | |
7332 | \gdef^^e7{\cedilla c} | |
7333 | \gdef^^e8{\`e} | |
7334 | \gdef^^e9{\'e} | |
7335 | \gdef^^ea{\^e} | |
7336 | \gdef^^eb{\"e} | |
7337 | \gdef^^ec{\`{\dotless i}} | |
7338 | \gdef^^ed{\'{\dotless i}} | |
7339 | \gdef^^ee{\^{\dotless i}} | |
7340 | \gdef^^ef{\"{\dotless i}} | |
7341 | % | |
7342 | \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}} | |
7343 | \gdef^^f1{\~n} | |
7344 | \gdef^^f2{\`o} | |
7345 | \gdef^^f3{\'o} | |
7346 | \gdef^^f4{\^o} | |
7347 | \gdef^^f5{\~o} | |
7348 | \gdef^^f6{\"o} | |
7349 | \gdef^^f7{$\div$} | |
7350 | \gdef^^f8{\o} | |
7351 | \gdef^^f9{\`u} | |
7352 | \gdef^^fa{\'u} | |
7353 | \gdef^^fb{\^u} | |
7354 | \gdef^^fc{\"u} | |
7355 | \gdef^^fd{\'y} | |
7356 | \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}} | |
7357 | \gdef^^ff{\"y} | |
7358 | } | |
7359 | ||
7360 | % Latin9 (ISO-8859-15) encoding character definitions. | |
7361 | \def\latninechardefs{% | |
7362 | % Encoding is almost identical to Latin1. | |
7363 | \latonechardefs | |
7364 | % | |
7365 | \gdef^^a4{\euro} | |
7366 | \gdef^^a6{\v S} | |
7367 | \gdef^^a8{\v s} | |
7368 | \gdef^^b4{\v Z} | |
7369 | \gdef^^b8{\v z} | |
7370 | \gdef^^bc{\OE} | |
7371 | \gdef^^bd{\oe} | |
7372 | \gdef^^be{\"Y} | |
7373 | } | |
7374 | ||
7375 | % Latin2 (ISO-8859-2) character definitions. | |
7376 | \def\lattwochardefs{% | |
7377 | \gdef^^a0{~} | |
7378 | \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}} | |
7379 | \gdef^^a2{\u{}} | |
7380 | \gdef^^a3{\L} | |
7381 | \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} | |
7382 | \gdef^^a5{\v L} | |
7383 | \gdef^^a6{\'S} | |
7384 | \gdef^^a7{\S} | |
7385 | \gdef^^a8{\"{}} | |
7386 | \gdef^^a9{\v S} | |
7387 | \gdef^^aa{\cedilla S} | |
7388 | \gdef^^ab{\v T} | |
7389 | \gdef^^ac{\'Z} | |
7390 | \gdef^^ad{\-} | |
7391 | \gdef^^ae{\v Z} | |
7392 | \gdef^^af{\dotaccent Z} | |
7393 | % | |
7394 | \gdef^^b0{\textdegree} | |
7395 | \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}} | |
7396 | \gdef^^b2{\missingcharmsg{OGONEK}} | |
7397 | \gdef^^b3{\l} | |
7398 | \gdef^^b4{\'{}} | |
7399 | \gdef^^b5{\v l} | |
7400 | \gdef^^b6{\'s} | |
7401 | \gdef^^b7{\v{}} | |
7402 | \gdef^^b8{\cedilla\ } | |
7403 | \gdef^^b9{\v s} | |
7404 | \gdef^^ba{\cedilla s} | |
7405 | \gdef^^bb{\v t} | |
7406 | \gdef^^bc{\'z} | |
7407 | \gdef^^bd{\H{}} | |
7408 | \gdef^^be{\v z} | |
7409 | \gdef^^bf{\dotaccent z} | |
7410 | % | |
7411 | \gdef^^c0{\'R} | |
7412 | \gdef^^c1{\'A} | |
7413 | \gdef^^c2{\^A} | |
7414 | \gdef^^c3{\u A} | |
7415 | \gdef^^c4{\"A} | |
7416 | \gdef^^c5{\'L} | |
7417 | \gdef^^c6{\'C} | |
7418 | \gdef^^c7{\cedilla C} | |
7419 | \gdef^^c8{\v C} | |
7420 | \gdef^^c9{\'E} | |
7421 | \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}} | |
7422 | \gdef^^cb{\"E} | |
7423 | \gdef^^cc{\v E} | |
7424 | \gdef^^cd{\'I} | |
7425 | \gdef^^ce{\^I} | |
7426 | \gdef^^cf{\v D} | |
7427 | % | |
7428 | \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}} | |
7429 | \gdef^^d1{\'N} | |
7430 | \gdef^^d2{\v N} | |
7431 | \gdef^^d3{\'O} | |
7432 | \gdef^^d4{\^O} | |
7433 | \gdef^^d5{\H O} | |
7434 | \gdef^^d6{\"O} | |
7435 | \gdef^^d7{$\times$} | |
7436 | \gdef^^d8{\v R} | |
7437 | \gdef^^d9{\ringaccent U} | |
7438 | \gdef^^da{\'U} | |
7439 | \gdef^^db{\H U} | |
7440 | \gdef^^dc{\"U} | |
7441 | \gdef^^dd{\'Y} | |
7442 | \gdef^^de{\cedilla T} | |
7443 | \gdef^^df{\ss} | |
7444 | % | |
7445 | \gdef^^e0{\'r} | |
7446 | \gdef^^e1{\'a} | |
7447 | \gdef^^e2{\^a} | |
7448 | \gdef^^e3{\u a} | |
7449 | \gdef^^e4{\"a} | |
7450 | \gdef^^e5{\'l} | |
7451 | \gdef^^e6{\'c} | |
7452 | \gdef^^e7{\cedilla c} | |
7453 | \gdef^^e8{\v c} | |
7454 | \gdef^^e9{\'e} | |
7455 | \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}} | |
7456 | \gdef^^eb{\"e} | |
7457 | \gdef^^ec{\v e} | |
7458 | \gdef^^ed{\'\i} | |
7459 | \gdef^^ee{\^\i} | |
7460 | \gdef^^ef{\v d} | |
7461 | % | |
7462 | \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}} | |
7463 | \gdef^^f1{\'n} | |
7464 | \gdef^^f2{\v n} | |
7465 | \gdef^^f3{\'o} | |
7466 | \gdef^^f4{\^o} | |
7467 | \gdef^^f5{\H o} | |
7468 | \gdef^^f6{\"o} | |
7469 | \gdef^^f7{$\div$} | |
7470 | \gdef^^f8{\v r} | |
7471 | \gdef^^f9{\ringaccent u} | |
7472 | \gdef^^fa{\'u} | |
7473 | \gdef^^fb{\H u} | |
7474 | \gdef^^fc{\"u} | |
7475 | \gdef^^fd{\'y} | |
7476 | \gdef^^fe{\cedilla t} | |
7477 | \gdef^^ff{\dotaccent{}} | |
7478 | } | |
7479 | ||
7480 | % UTF-8 character definitions. | |
7481 | % | |
7482 | % This code to support UTF-8 is based on LaTeX's utf8.def, with some | |
7483 | % changes for Texinfo conventions. It is included here under the GPL by | |
7484 | % permission from Frank Mittelbach and the LaTeX team. | |
7485 | % | |
7486 | \newcount\countUTFx | |
7487 | \newcount\countUTFy | |
7488 | \newcount\countUTFz | |
2c825956 | 7489 | |
98bf69dc KB |
7490 | \gdef\UTFviiiTwoOctets#1#2{\expandafter |
7491 | \UTFviiiDefined\csname u8:#1\string #2\endcsname} | |
7492 | % | |
7493 | \gdef\UTFviiiThreeOctets#1#2#3{\expandafter | |
7494 | \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname} | |
2c825956 | 7495 | % |
98bf69dc KB |
7496 | \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter |
7497 | \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname} | |
7498 | ||
7499 | \gdef\UTFviiiDefined#1{% | |
7500 | \ifx #1\relax | |
7501 | \message{\linenumber Unicode char \string #1 not defined for Texinfo}% | |
7502 | \else | |
7503 | \expandafter #1% | |
7504 | \fi | |
7505 | } | |
7506 | ||
7507 | \begingroup | |
7508 | \catcode`\~13 | |
7509 | \catcode`\"12 | |
7510 | ||
7511 | \def\UTFviiiLoop{% | |
7512 | \global\catcode\countUTFx\active | |
7513 | \uccode`\~\countUTFx | |
7514 | \uppercase\expandafter{\UTFviiiTmp}% | |
7515 | \advance\countUTFx by 1 | |
7516 | \ifnum\countUTFx < \countUTFy | |
7517 | \expandafter\UTFviiiLoop | |
7518 | \fi} | |
7519 | ||
7520 | \countUTFx = "C2 | |
7521 | \countUTFy = "E0 | |
7522 | \def\UTFviiiTmp{% | |
7523 | \xdef~{\noexpand\UTFviiiTwoOctets\string~}} | |
7524 | \UTFviiiLoop | |
7525 | ||
7526 | \countUTFx = "E0 | |
7527 | \countUTFy = "F0 | |
7528 | \def\UTFviiiTmp{% | |
7529 | \xdef~{\noexpand\UTFviiiThreeOctets\string~}} | |
7530 | \UTFviiiLoop | |
7531 | ||
7532 | \countUTFx = "F0 | |
7533 | \countUTFy = "F4 | |
7534 | \def\UTFviiiTmp{% | |
7535 | \xdef~{\noexpand\UTFviiiFourOctets\string~}} | |
7536 | \UTFviiiLoop | |
7537 | \endgroup | |
7538 | ||
7539 | \begingroup | |
7540 | \catcode`\"=12 | |
7541 | \catcode`\<=12 | |
7542 | \catcode`\.=12 | |
7543 | \catcode`\,=12 | |
7544 | \catcode`\;=12 | |
7545 | \catcode`\!=12 | |
7546 | \catcode`\~=13 | |
7547 | ||
7548 | \gdef\DeclareUnicodeCharacter#1#2{% | |
7549 | \countUTFz = "#1\relax | |
7550 | \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% | |
7551 | \begingroup | |
7552 | \parseXMLCharref | |
7553 | \def\UTFviiiTwoOctets##1##2{% | |
7554 | \csname u8:##1\string ##2\endcsname}% | |
7555 | \def\UTFviiiThreeOctets##1##2##3{% | |
7556 | \csname u8:##1\string ##2\string ##3\endcsname}% | |
7557 | \def\UTFviiiFourOctets##1##2##3##4{% | |
7558 | \csname u8:##1\string ##2\string ##3\string ##4\endcsname}% | |
7559 | \expandafter\expandafter\expandafter\expandafter | |
7560 | \expandafter\expandafter\expandafter | |
7561 | \gdef\UTFviiiTmp{#2}% | |
7562 | \endgroup} | |
7563 | ||
7564 | \gdef\parseXMLCharref{% | |
7565 | \ifnum\countUTFz < "A0\relax | |
7566 | \errhelp = \EMsimple | |
7567 | \errmessage{Cannot define Unicode char value < 00A0}% | |
7568 | \else\ifnum\countUTFz < "800\relax | |
7569 | \parseUTFviiiA,% | |
7570 | \parseUTFviiiB C\UTFviiiTwoOctets.,% | |
7571 | \else\ifnum\countUTFz < "10000\relax | |
7572 | \parseUTFviiiA;% | |
7573 | \parseUTFviiiA,% | |
7574 | \parseUTFviiiB E\UTFviiiThreeOctets.{,;}% | |
7575 | \else | |
7576 | \parseUTFviiiA;% | |
7577 | \parseUTFviiiA,% | |
7578 | \parseUTFviiiA!% | |
7579 | \parseUTFviiiB F\UTFviiiFourOctets.{!,;}% | |
7580 | \fi\fi\fi | |
7581 | } | |
7582 | ||
7583 | \gdef\parseUTFviiiA#1{% | |
7584 | \countUTFx = \countUTFz | |
7585 | \divide\countUTFz by 64 | |
7586 | \countUTFy = \countUTFz | |
7587 | \multiply\countUTFz by 64 | |
7588 | \advance\countUTFx by -\countUTFz | |
7589 | \advance\countUTFx by 128 | |
7590 | \uccode `#1\countUTFx | |
7591 | \countUTFz = \countUTFy} | |
7592 | ||
7593 | \gdef\parseUTFviiiB#1#2#3#4{% | |
7594 | \advance\countUTFz by "#10\relax | |
7595 | \uccode `#3\countUTFz | |
7596 | \uppercase{\gdef\UTFviiiTmp{#2#3#4}}} | |
7597 | \endgroup | |
7598 | ||
7599 | \def\utfeightchardefs{% | |
7600 | \DeclareUnicodeCharacter{00A0}{\tie} | |
7601 | \DeclareUnicodeCharacter{00A1}{\exclamdown} | |
7602 | \DeclareUnicodeCharacter{00A3}{\pounds} | |
7603 | \DeclareUnicodeCharacter{00A8}{\"{ }} | |
7604 | \DeclareUnicodeCharacter{00A9}{\copyright} | |
7605 | \DeclareUnicodeCharacter{00AA}{\ordf} | |
7606 | \DeclareUnicodeCharacter{00AD}{\-} | |
7607 | \DeclareUnicodeCharacter{00AE}{\registeredsymbol} | |
7608 | \DeclareUnicodeCharacter{00AF}{\={ }} | |
7609 | ||
7610 | \DeclareUnicodeCharacter{00B0}{\ringaccent{ }} | |
7611 | \DeclareUnicodeCharacter{00B4}{\'{ }} | |
7612 | \DeclareUnicodeCharacter{00B8}{\cedilla{ }} | |
7613 | \DeclareUnicodeCharacter{00BA}{\ordm} | |
7614 | \DeclareUnicodeCharacter{00BF}{\questiondown} | |
7615 | ||
7616 | \DeclareUnicodeCharacter{00C0}{\`A} | |
7617 | \DeclareUnicodeCharacter{00C1}{\'A} | |
7618 | \DeclareUnicodeCharacter{00C2}{\^A} | |
7619 | \DeclareUnicodeCharacter{00C3}{\~A} | |
7620 | \DeclareUnicodeCharacter{00C4}{\"A} | |
7621 | \DeclareUnicodeCharacter{00C5}{\AA} | |
7622 | \DeclareUnicodeCharacter{00C6}{\AE} | |
7623 | \DeclareUnicodeCharacter{00C7}{\cedilla{C}} | |
7624 | \DeclareUnicodeCharacter{00C8}{\`E} | |
7625 | \DeclareUnicodeCharacter{00C9}{\'E} | |
7626 | \DeclareUnicodeCharacter{00CA}{\^E} | |
7627 | \DeclareUnicodeCharacter{00CB}{\"E} | |
7628 | \DeclareUnicodeCharacter{00CC}{\`I} | |
7629 | \DeclareUnicodeCharacter{00CD}{\'I} | |
7630 | \DeclareUnicodeCharacter{00CE}{\^I} | |
7631 | \DeclareUnicodeCharacter{00CF}{\"I} | |
7632 | ||
7633 | \DeclareUnicodeCharacter{00D1}{\~N} | |
7634 | \DeclareUnicodeCharacter{00D2}{\`O} | |
7635 | \DeclareUnicodeCharacter{00D3}{\'O} | |
7636 | \DeclareUnicodeCharacter{00D4}{\^O} | |
7637 | \DeclareUnicodeCharacter{00D5}{\~O} | |
7638 | \DeclareUnicodeCharacter{00D6}{\"O} | |
7639 | \DeclareUnicodeCharacter{00D8}{\O} | |
7640 | \DeclareUnicodeCharacter{00D9}{\`U} | |
7641 | \DeclareUnicodeCharacter{00DA}{\'U} | |
7642 | \DeclareUnicodeCharacter{00DB}{\^U} | |
7643 | \DeclareUnicodeCharacter{00DC}{\"U} | |
7644 | \DeclareUnicodeCharacter{00DD}{\'Y} | |
7645 | \DeclareUnicodeCharacter{00DF}{\ss} | |
7646 | ||
7647 | \DeclareUnicodeCharacter{00E0}{\`a} | |
7648 | \DeclareUnicodeCharacter{00E1}{\'a} | |
7649 | \DeclareUnicodeCharacter{00E2}{\^a} | |
7650 | \DeclareUnicodeCharacter{00E3}{\~a} | |
7651 | \DeclareUnicodeCharacter{00E4}{\"a} | |
7652 | \DeclareUnicodeCharacter{00E5}{\aa} | |
7653 | \DeclareUnicodeCharacter{00E6}{\ae} | |
7654 | \DeclareUnicodeCharacter{00E7}{\cedilla{c}} | |
7655 | \DeclareUnicodeCharacter{00E8}{\`e} | |
7656 | \DeclareUnicodeCharacter{00E9}{\'e} | |
7657 | \DeclareUnicodeCharacter{00EA}{\^e} | |
7658 | \DeclareUnicodeCharacter{00EB}{\"e} | |
7659 | \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}} | |
7660 | \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}} | |
7661 | \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}} | |
7662 | \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}} | |
7663 | ||
7664 | \DeclareUnicodeCharacter{00F1}{\~n} | |
7665 | \DeclareUnicodeCharacter{00F2}{\`o} | |
7666 | \DeclareUnicodeCharacter{00F3}{\'o} | |
7667 | \DeclareUnicodeCharacter{00F4}{\^o} | |
7668 | \DeclareUnicodeCharacter{00F5}{\~o} | |
7669 | \DeclareUnicodeCharacter{00F6}{\"o} | |
7670 | \DeclareUnicodeCharacter{00F8}{\o} | |
7671 | \DeclareUnicodeCharacter{00F9}{\`u} | |
7672 | \DeclareUnicodeCharacter{00FA}{\'u} | |
7673 | \DeclareUnicodeCharacter{00FB}{\^u} | |
7674 | \DeclareUnicodeCharacter{00FC}{\"u} | |
7675 | \DeclareUnicodeCharacter{00FD}{\'y} | |
7676 | \DeclareUnicodeCharacter{00FF}{\"y} | |
7677 | ||
7678 | \DeclareUnicodeCharacter{0100}{\=A} | |
7679 | \DeclareUnicodeCharacter{0101}{\=a} | |
7680 | \DeclareUnicodeCharacter{0102}{\u{A}} | |
7681 | \DeclareUnicodeCharacter{0103}{\u{a}} | |
7682 | \DeclareUnicodeCharacter{0106}{\'C} | |
7683 | \DeclareUnicodeCharacter{0107}{\'c} | |
7684 | \DeclareUnicodeCharacter{0108}{\^C} | |
7685 | \DeclareUnicodeCharacter{0109}{\^c} | |
7686 | \DeclareUnicodeCharacter{010A}{\dotaccent{C}} | |
7687 | \DeclareUnicodeCharacter{010B}{\dotaccent{c}} | |
7688 | \DeclareUnicodeCharacter{010C}{\v{C}} | |
7689 | \DeclareUnicodeCharacter{010D}{\v{c}} | |
7690 | \DeclareUnicodeCharacter{010E}{\v{D}} | |
7691 | ||
7692 | \DeclareUnicodeCharacter{0112}{\=E} | |
7693 | \DeclareUnicodeCharacter{0113}{\=e} | |
7694 | \DeclareUnicodeCharacter{0114}{\u{E}} | |
7695 | \DeclareUnicodeCharacter{0115}{\u{e}} | |
7696 | \DeclareUnicodeCharacter{0116}{\dotaccent{E}} | |
7697 | \DeclareUnicodeCharacter{0117}{\dotaccent{e}} | |
7698 | \DeclareUnicodeCharacter{011A}{\v{E}} | |
7699 | \DeclareUnicodeCharacter{011B}{\v{e}} | |
7700 | \DeclareUnicodeCharacter{011C}{\^G} | |
7701 | \DeclareUnicodeCharacter{011D}{\^g} | |
7702 | \DeclareUnicodeCharacter{011E}{\u{G}} | |
7703 | \DeclareUnicodeCharacter{011F}{\u{g}} | |
7704 | ||
7705 | \DeclareUnicodeCharacter{0120}{\dotaccent{G}} | |
7706 | \DeclareUnicodeCharacter{0121}{\dotaccent{g}} | |
7707 | \DeclareUnicodeCharacter{0124}{\^H} | |
7708 | \DeclareUnicodeCharacter{0125}{\^h} | |
7709 | \DeclareUnicodeCharacter{0128}{\~I} | |
7710 | \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}} | |
7711 | \DeclareUnicodeCharacter{012A}{\=I} | |
7712 | \DeclareUnicodeCharacter{012B}{\={\dotless{i}}} | |
7713 | \DeclareUnicodeCharacter{012C}{\u{I}} | |
7714 | \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}} | |
7715 | ||
7716 | \DeclareUnicodeCharacter{0130}{\dotaccent{I}} | |
7717 | \DeclareUnicodeCharacter{0131}{\dotless{i}} | |
7718 | \DeclareUnicodeCharacter{0132}{IJ} | |
7719 | \DeclareUnicodeCharacter{0133}{ij} | |
7720 | \DeclareUnicodeCharacter{0134}{\^J} | |
7721 | \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}} | |
7722 | \DeclareUnicodeCharacter{0139}{\'L} | |
7723 | \DeclareUnicodeCharacter{013A}{\'l} | |
7724 | ||
7725 | \DeclareUnicodeCharacter{0141}{\L} | |
7726 | \DeclareUnicodeCharacter{0142}{\l} | |
7727 | \DeclareUnicodeCharacter{0143}{\'N} | |
7728 | \DeclareUnicodeCharacter{0144}{\'n} | |
7729 | \DeclareUnicodeCharacter{0147}{\v{N}} | |
7730 | \DeclareUnicodeCharacter{0148}{\v{n}} | |
7731 | \DeclareUnicodeCharacter{014C}{\=O} | |
7732 | \DeclareUnicodeCharacter{014D}{\=o} | |
7733 | \DeclareUnicodeCharacter{014E}{\u{O}} | |
7734 | \DeclareUnicodeCharacter{014F}{\u{o}} | |
7735 | ||
7736 | \DeclareUnicodeCharacter{0150}{\H{O}} | |
7737 | \DeclareUnicodeCharacter{0151}{\H{o}} | |
7738 | \DeclareUnicodeCharacter{0152}{\OE} | |
7739 | \DeclareUnicodeCharacter{0153}{\oe} | |
7740 | \DeclareUnicodeCharacter{0154}{\'R} | |
7741 | \DeclareUnicodeCharacter{0155}{\'r} | |
7742 | \DeclareUnicodeCharacter{0158}{\v{R}} | |
7743 | \DeclareUnicodeCharacter{0159}{\v{r}} | |
7744 | \DeclareUnicodeCharacter{015A}{\'S} | |
7745 | \DeclareUnicodeCharacter{015B}{\'s} | |
7746 | \DeclareUnicodeCharacter{015C}{\^S} | |
7747 | \DeclareUnicodeCharacter{015D}{\^s} | |
7748 | \DeclareUnicodeCharacter{015E}{\cedilla{S}} | |
7749 | \DeclareUnicodeCharacter{015F}{\cedilla{s}} | |
7750 | ||
7751 | \DeclareUnicodeCharacter{0160}{\v{S}} | |
7752 | \DeclareUnicodeCharacter{0161}{\v{s}} | |
7753 | \DeclareUnicodeCharacter{0162}{\cedilla{t}} | |
7754 | \DeclareUnicodeCharacter{0163}{\cedilla{T}} | |
7755 | \DeclareUnicodeCharacter{0164}{\v{T}} | |
7756 | ||
7757 | \DeclareUnicodeCharacter{0168}{\~U} | |
7758 | \DeclareUnicodeCharacter{0169}{\~u} | |
7759 | \DeclareUnicodeCharacter{016A}{\=U} | |
7760 | \DeclareUnicodeCharacter{016B}{\=u} | |
7761 | \DeclareUnicodeCharacter{016C}{\u{U}} | |
7762 | \DeclareUnicodeCharacter{016D}{\u{u}} | |
7763 | \DeclareUnicodeCharacter{016E}{\ringaccent{U}} | |
7764 | \DeclareUnicodeCharacter{016F}{\ringaccent{u}} | |
7765 | ||
7766 | \DeclareUnicodeCharacter{0170}{\H{U}} | |
7767 | \DeclareUnicodeCharacter{0171}{\H{u}} | |
7768 | \DeclareUnicodeCharacter{0174}{\^W} | |
7769 | \DeclareUnicodeCharacter{0175}{\^w} | |
7770 | \DeclareUnicodeCharacter{0176}{\^Y} | |
7771 | \DeclareUnicodeCharacter{0177}{\^y} | |
7772 | \DeclareUnicodeCharacter{0178}{\"Y} | |
7773 | \DeclareUnicodeCharacter{0179}{\'Z} | |
7774 | \DeclareUnicodeCharacter{017A}{\'z} | |
7775 | \DeclareUnicodeCharacter{017B}{\dotaccent{Z}} | |
7776 | \DeclareUnicodeCharacter{017C}{\dotaccent{z}} | |
7777 | \DeclareUnicodeCharacter{017D}{\v{Z}} | |
7778 | \DeclareUnicodeCharacter{017E}{\v{z}} | |
7779 | ||
7780 | \DeclareUnicodeCharacter{01C4}{D\v{Z}} | |
7781 | \DeclareUnicodeCharacter{01C5}{D\v{z}} | |
7782 | \DeclareUnicodeCharacter{01C6}{d\v{z}} | |
7783 | \DeclareUnicodeCharacter{01C7}{LJ} | |
7784 | \DeclareUnicodeCharacter{01C8}{Lj} | |
7785 | \DeclareUnicodeCharacter{01C9}{lj} | |
7786 | \DeclareUnicodeCharacter{01CA}{NJ} | |
7787 | \DeclareUnicodeCharacter{01CB}{Nj} | |
7788 | \DeclareUnicodeCharacter{01CC}{nj} | |
7789 | \DeclareUnicodeCharacter{01CD}{\v{A}} | |
7790 | \DeclareUnicodeCharacter{01CE}{\v{a}} | |
7791 | \DeclareUnicodeCharacter{01CF}{\v{I}} | |
7792 | ||
7793 | \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}} | |
7794 | \DeclareUnicodeCharacter{01D1}{\v{O}} | |
7795 | \DeclareUnicodeCharacter{01D2}{\v{o}} | |
7796 | \DeclareUnicodeCharacter{01D3}{\v{U}} | |
7797 | \DeclareUnicodeCharacter{01D4}{\v{u}} | |
7798 | ||
7799 | \DeclareUnicodeCharacter{01E2}{\={\AE}} | |
7800 | \DeclareUnicodeCharacter{01E3}{\={\ae}} | |
7801 | \DeclareUnicodeCharacter{01E6}{\v{G}} | |
7802 | \DeclareUnicodeCharacter{01E7}{\v{g}} | |
7803 | \DeclareUnicodeCharacter{01E8}{\v{K}} | |
7804 | \DeclareUnicodeCharacter{01E9}{\v{k}} | |
7805 | ||
7806 | \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}} | |
7807 | \DeclareUnicodeCharacter{01F1}{DZ} | |
7808 | \DeclareUnicodeCharacter{01F2}{Dz} | |
7809 | \DeclareUnicodeCharacter{01F3}{dz} | |
7810 | \DeclareUnicodeCharacter{01F4}{\'G} | |
7811 | \DeclareUnicodeCharacter{01F5}{\'g} | |
7812 | \DeclareUnicodeCharacter{01F8}{\`N} | |
7813 | \DeclareUnicodeCharacter{01F9}{\`n} | |
7814 | \DeclareUnicodeCharacter{01FC}{\'{\AE}} | |
7815 | \DeclareUnicodeCharacter{01FD}{\'{\ae}} | |
7816 | \DeclareUnicodeCharacter{01FE}{\'{\O}} | |
7817 | \DeclareUnicodeCharacter{01FF}{\'{\o}} | |
7818 | ||
7819 | \DeclareUnicodeCharacter{021E}{\v{H}} | |
7820 | \DeclareUnicodeCharacter{021F}{\v{h}} | |
7821 | ||
7822 | \DeclareUnicodeCharacter{0226}{\dotaccent{A}} | |
7823 | \DeclareUnicodeCharacter{0227}{\dotaccent{a}} | |
7824 | \DeclareUnicodeCharacter{0228}{\cedilla{E}} | |
7825 | \DeclareUnicodeCharacter{0229}{\cedilla{e}} | |
7826 | \DeclareUnicodeCharacter{022E}{\dotaccent{O}} | |
7827 | \DeclareUnicodeCharacter{022F}{\dotaccent{o}} | |
7828 | ||
7829 | \DeclareUnicodeCharacter{0232}{\=Y} | |
7830 | \DeclareUnicodeCharacter{0233}{\=y} | |
7831 | \DeclareUnicodeCharacter{0237}{\dotless{j}} | |
7832 | ||
7833 | \DeclareUnicodeCharacter{1E02}{\dotaccent{B}} | |
7834 | \DeclareUnicodeCharacter{1E03}{\dotaccent{b}} | |
7835 | \DeclareUnicodeCharacter{1E04}{\udotaccent{B}} | |
7836 | \DeclareUnicodeCharacter{1E05}{\udotaccent{b}} | |
7837 | \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}} | |
7838 | \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}} | |
7839 | \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}} | |
7840 | \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}} | |
7841 | \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}} | |
7842 | \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}} | |
7843 | \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}} | |
7844 | \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}} | |
7845 | ||
7846 | \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}} | |
7847 | \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}} | |
7848 | ||
7849 | \DeclareUnicodeCharacter{1E20}{\=G} | |
7850 | \DeclareUnicodeCharacter{1E21}{\=g} | |
7851 | \DeclareUnicodeCharacter{1E22}{\dotaccent{H}} | |
7852 | \DeclareUnicodeCharacter{1E23}{\dotaccent{h}} | |
7853 | \DeclareUnicodeCharacter{1E24}{\udotaccent{H}} | |
7854 | \DeclareUnicodeCharacter{1E25}{\udotaccent{h}} | |
7855 | \DeclareUnicodeCharacter{1E26}{\"H} | |
7856 | \DeclareUnicodeCharacter{1E27}{\"h} | |
7857 | ||
7858 | \DeclareUnicodeCharacter{1E30}{\'K} | |
7859 | \DeclareUnicodeCharacter{1E31}{\'k} | |
7860 | \DeclareUnicodeCharacter{1E32}{\udotaccent{K}} | |
7861 | \DeclareUnicodeCharacter{1E33}{\udotaccent{k}} | |
7862 | \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}} | |
7863 | \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}} | |
7864 | \DeclareUnicodeCharacter{1E36}{\udotaccent{L}} | |
7865 | \DeclareUnicodeCharacter{1E37}{\udotaccent{l}} | |
7866 | \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}} | |
7867 | \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}} | |
7868 | \DeclareUnicodeCharacter{1E3E}{\'M} | |
7869 | \DeclareUnicodeCharacter{1E3F}{\'m} | |
7870 | ||
7871 | \DeclareUnicodeCharacter{1E40}{\dotaccent{M}} | |
7872 | \DeclareUnicodeCharacter{1E41}{\dotaccent{m}} | |
7873 | \DeclareUnicodeCharacter{1E42}{\udotaccent{M}} | |
7874 | \DeclareUnicodeCharacter{1E43}{\udotaccent{m}} | |
7875 | \DeclareUnicodeCharacter{1E44}{\dotaccent{N}} | |
7876 | \DeclareUnicodeCharacter{1E45}{\dotaccent{n}} | |
7877 | \DeclareUnicodeCharacter{1E46}{\udotaccent{N}} | |
7878 | \DeclareUnicodeCharacter{1E47}{\udotaccent{n}} | |
7879 | \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}} | |
7880 | \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}} | |
7881 | ||
7882 | \DeclareUnicodeCharacter{1E54}{\'P} | |
7883 | \DeclareUnicodeCharacter{1E55}{\'p} | |
7884 | \DeclareUnicodeCharacter{1E56}{\dotaccent{P}} | |
7885 | \DeclareUnicodeCharacter{1E57}{\dotaccent{p}} | |
7886 | \DeclareUnicodeCharacter{1E58}{\dotaccent{R}} | |
7887 | \DeclareUnicodeCharacter{1E59}{\dotaccent{r}} | |
7888 | \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}} | |
7889 | \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}} | |
7890 | \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}} | |
7891 | \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}} | |
7892 | ||
7893 | \DeclareUnicodeCharacter{1E60}{\dotaccent{S}} | |
7894 | \DeclareUnicodeCharacter{1E61}{\dotaccent{s}} | |
7895 | \DeclareUnicodeCharacter{1E62}{\udotaccent{S}} | |
7896 | \DeclareUnicodeCharacter{1E63}{\udotaccent{s}} | |
7897 | \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}} | |
7898 | \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}} | |
7899 | \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}} | |
7900 | \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}} | |
7901 | \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}} | |
7902 | \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}} | |
7903 | ||
7904 | \DeclareUnicodeCharacter{1E7C}{\~V} | |
7905 | \DeclareUnicodeCharacter{1E7D}{\~v} | |
7906 | \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}} | |
7907 | \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}} | |
7908 | ||
7909 | \DeclareUnicodeCharacter{1E80}{\`W} | |
7910 | \DeclareUnicodeCharacter{1E81}{\`w} | |
7911 | \DeclareUnicodeCharacter{1E82}{\'W} | |
7912 | \DeclareUnicodeCharacter{1E83}{\'w} | |
7913 | \DeclareUnicodeCharacter{1E84}{\"W} | |
7914 | \DeclareUnicodeCharacter{1E85}{\"w} | |
7915 | \DeclareUnicodeCharacter{1E86}{\dotaccent{W}} | |
7916 | \DeclareUnicodeCharacter{1E87}{\dotaccent{w}} | |
7917 | \DeclareUnicodeCharacter{1E88}{\udotaccent{W}} | |
7918 | \DeclareUnicodeCharacter{1E89}{\udotaccent{w}} | |
7919 | \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}} | |
7920 | \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}} | |
7921 | \DeclareUnicodeCharacter{1E8C}{\"X} | |
7922 | \DeclareUnicodeCharacter{1E8D}{\"x} | |
7923 | \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}} | |
7924 | \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}} | |
7925 | ||
7926 | \DeclareUnicodeCharacter{1E90}{\^Z} | |
7927 | \DeclareUnicodeCharacter{1E91}{\^z} | |
7928 | \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}} | |
7929 | \DeclareUnicodeCharacter{1E93}{\udotaccent{z}} | |
7930 | \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}} | |
7931 | \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}} | |
7932 | \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}} | |
7933 | \DeclareUnicodeCharacter{1E97}{\"t} | |
7934 | \DeclareUnicodeCharacter{1E98}{\ringaccent{w}} | |
7935 | \DeclareUnicodeCharacter{1E99}{\ringaccent{y}} | |
7936 | ||
7937 | \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}} | |
7938 | \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}} | |
7939 | ||
7940 | \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}} | |
7941 | \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}} | |
7942 | \DeclareUnicodeCharacter{1EBC}{\~E} | |
7943 | \DeclareUnicodeCharacter{1EBD}{\~e} | |
7944 | ||
7945 | \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}} | |
7946 | \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}} | |
7947 | \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}} | |
7948 | \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}} | |
7949 | ||
7950 | \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}} | |
7951 | \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}} | |
7952 | ||
7953 | \DeclareUnicodeCharacter{1EF2}{\`Y} | |
7954 | \DeclareUnicodeCharacter{1EF3}{\`y} | |
7955 | \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}} | |
7956 | ||
7957 | \DeclareUnicodeCharacter{1EF8}{\~Y} | |
7958 | \DeclareUnicodeCharacter{1EF9}{\~y} | |
7959 | ||
7960 | \DeclareUnicodeCharacter{2013}{--} | |
7961 | \DeclareUnicodeCharacter{2014}{---} | |
7962 | \DeclareUnicodeCharacter{2022}{\bullet} | |
7963 | \DeclareUnicodeCharacter{2026}{\dots} | |
7964 | \DeclareUnicodeCharacter{20AC}{\euro} | |
7965 | ||
7966 | \DeclareUnicodeCharacter{2192}{\expansion} | |
7967 | \DeclareUnicodeCharacter{21D2}{\result} | |
7968 | ||
7969 | \DeclareUnicodeCharacter{2212}{\minus} | |
7970 | \DeclareUnicodeCharacter{2217}{\point} | |
7971 | \DeclareUnicodeCharacter{2261}{\equiv} | |
7972 | }% end of \utfeightchardefs | |
7973 | ||
7974 | ||
7975 | % US-ASCII character definitions. | |
7976 | \def\asciichardefs{% nothing need be done | |
7977 | \relax | |
7978 | } | |
7979 | ||
7980 | % Make non-ASCII characters printable again for compatibility with | |
7981 | % existing Texinfo documents that may use them, even without declaring a | |
7982 | % document encoding. | |
7983 | % | |
7984 | \setnonasciicharscatcode \other | |
7985 | ||
7986 | ||
7987 | \message{formatting,} | |
7988 | ||
2c825956 GM |
7989 | \newdimen\defaultparindent \defaultparindent = 15pt |
7990 | ||
7991 | \chapheadingskip = 15pt plus 4pt minus 2pt | |
7992 | \secheadingskip = 12pt plus 3pt minus 2pt | |
7993 | \subsecheadingskip = 9pt plus 2pt minus 2pt | |
7994 | ||
7995 | % Prevent underfull vbox error messages. | |
7996 | \vbadness = 10000 | |
7997 | ||
7998 | % Don't be so finicky about underfull hboxes, either. | |
7999 | \hbadness = 2000 | |
8000 | ||
8001 | % Following George Bush, just get rid of widows and orphans. | |
8002 | \widowpenalty=10000 | |
8003 | \clubpenalty=10000 | |
8004 | ||
8005 | % Use TeX 3.0's \emergencystretch to help line breaking, but if we're | |
8006 | % using an old version of TeX, don't do anything. We want the amount of | |
8007 | % stretch added to depend on the line length, hence the dependence on | |
8008 | % \hsize. We call this whenever the paper size is set. | |
8009 | % | |
8010 | \def\setemergencystretch{% | |
8011 | \ifx\emergencystretch\thisisundefined | |
8012 | % Allow us to assign to \emergencystretch anyway. | |
8013 | \def\emergencystretch{\dimen0}% | |
8014 | \else | |
8015 | \emergencystretch = .15\hsize | |
8016 | \fi | |
8017 | } | |
8018 | ||
0f9c1975 KB |
8019 | % Parameters in order: 1) textheight; 2) textwidth; |
8020 | % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip; | |
8021 | % 7) physical page height; 8) physical page width. | |
2c825956 | 8022 | % |
0f9c1975 KB |
8023 | % We also call \setleading{\textleading}, so the caller should define |
8024 | % \textleading. The caller should also set \parskip. | |
8025 | % | |
8026 | \def\internalpagesizes#1#2#3#4#5#6#7#8{% | |
2c825956 GM |
8027 | \voffset = #3\relax |
8028 | \topskip = #6\relax | |
8029 | \splittopskip = \topskip | |
8030 | % | |
8031 | \vsize = #1\relax | |
8032 | \advance\vsize by \topskip | |
8033 | \outervsize = \vsize | |
8034 | \advance\outervsize by 2\topandbottommargin | |
8035 | \pageheight = \vsize | |
8036 | % | |
8037 | \hsize = #2\relax | |
8038 | \outerhsize = \hsize | |
8039 | \advance\outerhsize by 0.5in | |
8040 | \pagewidth = \hsize | |
8041 | % | |
8042 | \normaloffset = #4\relax | |
8043 | \bindingoffset = #5\relax | |
8044 | % | |
0f9c1975 KB |
8045 | \ifpdf |
8046 | \pdfpageheight #7\relax | |
8047 | \pdfpagewidth #8\relax | |
8048 | \fi | |
8049 | % | |
08b16a02 PJ |
8050 | \setleading{\textleading} |
8051 | % | |
2c825956 GM |
8052 | \parindent = \defaultparindent |
8053 | \setemergencystretch | |
8054 | } | |
8055 | ||
2c825956 GM |
8056 | % @letterpaper (the default). |
8057 | \def\letterpaper{{\globaldefs = 1 | |
8058 | \parskip = 3pt plus 2pt minus 1pt | |
08b16a02 | 8059 | \textleading = 13.2pt |
2c825956 GM |
8060 | % |
8061 | % If page is nothing but text, make it come out even. | |
0f9c1975 KB |
8062 | \internalpagesizes{46\baselineskip}{6in}% |
8063 | {\voffset}{.25in}% | |
8064 | {\bindingoffset}{36pt}% | |
8065 | {11in}{8.5in}% | |
2c825956 GM |
8066 | }} |
8067 | ||
0f9c1975 | 8068 | % Use @smallbook to reset parameters for 7x9.25 trim size. |
2c825956 GM |
8069 | \def\smallbook{{\globaldefs = 1 |
8070 | \parskip = 2pt plus 1pt | |
08b16a02 | 8071 | \textleading = 12pt |
2c825956 | 8072 | % |
0f9c1975 KB |
8073 | \internalpagesizes{7.5in}{5in}% |
8074 | {\voffset}{.25in}% | |
8075 | {\bindingoffset}{16pt}% | |
8076 | {9.25in}{7in}% | |
2c825956 GM |
8077 | % |
8078 | \lispnarrowing = 0.3in | |
8079 | \tolerance = 700 | |
8080 | \hfuzz = 1pt | |
8081 | \contentsrightmargin = 0pt | |
2c825956 | 8082 | \defbodyindent = .5cm |
0f9c1975 KB |
8083 | }} |
8084 | ||
8085 | % Use @smallerbook to reset parameters for 6x9 trim size. | |
8086 | % (Just testing, parameters still in flux.) | |
8087 | \def\smallerbook{{\globaldefs = 1 | |
8088 | \parskip = 1.5pt plus 1pt | |
8089 | \textleading = 12pt | |
8090 | % | |
8091 | \internalpagesizes{7.4in}{4.8in}% | |
8092 | {-.2in}{-.4in}% | |
8093 | {0pt}{14pt}% | |
8094 | {9in}{6in}% | |
8095 | % | |
8096 | \lispnarrowing = 0.25in | |
8097 | \tolerance = 700 | |
8098 | \hfuzz = 1pt | |
8099 | \contentsrightmargin = 0pt | |
8100 | \defbodyindent = .4cm | |
2c825956 GM |
8101 | }} |
8102 | ||
8103 | % Use @afourpaper to print on European A4 paper. | |
8104 | \def\afourpaper{{\globaldefs = 1 | |
2c825956 | 8105 | \parskip = 3pt plus 2pt minus 1pt |
0f9c1975 | 8106 | \textleading = 13.2pt |
2c825956 | 8107 | % |
0f9c1975 KB |
8108 | % Double-side printing via postscript on Laserjet 4050 |
8109 | % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. | |
8110 | % To change the settings for a different printer or situation, adjust | |
8111 | % \normaloffset until the front-side and back-side texts align. Then | |
8112 | % do the same for \bindingoffset. You can set these for testing in | |
8113 | % your texinfo source file like this: | |
8114 | % @tex | |
8115 | % \global\normaloffset = -6mm | |
8116 | % \global\bindingoffset = 10mm | |
8117 | % @end tex | |
8118 | \internalpagesizes{51\baselineskip}{160mm} | |
8119 | {\voffset}{\hoffset}% | |
8120 | {\bindingoffset}{44pt}% | |
8121 | {297mm}{210mm}% | |
2c825956 GM |
8122 | % |
8123 | \tolerance = 700 | |
8124 | \hfuzz = 1pt | |
0f9c1975 KB |
8125 | \contentsrightmargin = 0pt |
8126 | \defbodyindent = 5mm | |
2c825956 GM |
8127 | }} |
8128 | ||
8129 | % Use @afivepaper to print on European A5 paper. | |
8130 | % From romildo@urano.iceb.ufop.br, 2 July 2000. | |
8131 | % He also recommends making @example and @lisp be small. | |
8132 | \def\afivepaper{{\globaldefs = 1 | |
2c825956 | 8133 | \parskip = 2pt plus 1pt minus 0.1pt |
08b16a02 | 8134 | \textleading = 12.5pt |
2c825956 | 8135 | % |
0f9c1975 KB |
8136 | \internalpagesizes{160mm}{120mm}% |
8137 | {\voffset}{\hoffset}% | |
8138 | {\bindingoffset}{8pt}% | |
8139 | {210mm}{148mm}% | |
2c825956 GM |
8140 | % |
8141 | \lispnarrowing = 0.2in | |
8142 | \tolerance = 800 | |
8143 | \hfuzz = 1.2pt | |
0f9c1975 | 8144 | \contentsrightmargin = 0pt |
2c825956 GM |
8145 | \defbodyindent = 2mm |
8146 | \tableindent = 12mm | |
2c825956 GM |
8147 | }} |
8148 | ||
0f9c1975 | 8149 | % A specific text layout, 24x15cm overall, intended for A4 paper. |
2c825956 | 8150 | \def\afourlatex{{\globaldefs = 1 |
2c825956 | 8151 | \afourpaper |
0f9c1975 KB |
8152 | \internalpagesizes{237mm}{150mm}% |
8153 | {\voffset}{4.6mm}% | |
8154 | {\bindingoffset}{7mm}% | |
8155 | {297mm}{210mm}% | |
2c825956 | 8156 | % |
0f9c1975 | 8157 | % Must explicitly reset to 0 because we call \afourpaper. |
2c825956 GM |
8158 | \globaldefs = 0 |
8159 | }} | |
8160 | ||
0f9c1975 KB |
8161 | % Use @afourwide to print on A4 paper in landscape format. |
8162 | \def\afourwide{{\globaldefs = 1 | |
2c825956 | 8163 | \afourpaper |
0f9c1975 KB |
8164 | \internalpagesizes{241mm}{165mm}% |
8165 | {\voffset}{-2.95mm}% | |
8166 | {\bindingoffset}{7mm}% | |
8167 | {297mm}{210mm}% | |
8168 | \globaldefs = 0 | |
8169 | }} | |
2c825956 GM |
8170 | |
8171 | % @pagesizes TEXTHEIGHT[,TEXTWIDTH] | |
8172 | % Perhaps we should allow setting the margins, \topskip, \parskip, | |
8173 | % and/or leading, also. Or perhaps we should compute them somehow. | |
8174 | % | |
0f9c1975 | 8175 | \parseargdef\pagesizes{\pagesizesyyy #1,,\finish} |
2c825956 GM |
8176 | \def\pagesizesyyy#1,#2,#3\finish{{% |
8177 | \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi | |
8178 | \globaldefs = 1 | |
8179 | % | |
8180 | \parskip = 3pt plus 2pt minus 1pt | |
08b16a02 | 8181 | \setleading{\textleading}% |
2c825956 | 8182 | % |
0f9c1975 KB |
8183 | \dimen0 = #1 |
8184 | \advance\dimen0 by \voffset | |
8185 | % | |
8186 | \dimen2 = \hsize | |
8187 | \advance\dimen2 by \normaloffset | |
8188 | % | |
8189 | \internalpagesizes{#1}{\hsize}% | |
8190 | {\voffset}{\normaloffset}% | |
8191 | {\bindingoffset}{44pt}% | |
8192 | {\dimen0}{\dimen2}% | |
2c825956 GM |
8193 | }} |
8194 | ||
8195 | % Set default to letter. | |
8196 | % | |
8197 | \letterpaper | |
8198 | ||
8199 | ||
8200 | \message{and turning on texinfo input format.} | |
8201 | ||
8202 | % Define macros to output various characters with catcode for normal text. | |
8203 | \catcode`\"=\other | |
8204 | \catcode`\~=\other | |
8205 | \catcode`\^=\other | |
8206 | \catcode`\_=\other | |
8207 | \catcode`\|=\other | |
8208 | \catcode`\<=\other | |
8209 | \catcode`\>=\other | |
8210 | \catcode`\+=\other | |
8211 | \catcode`\$=\other | |
8212 | \def\normaldoublequote{"} | |
8213 | \def\normaltilde{~} | |
8214 | \def\normalcaret{^} | |
8215 | \def\normalunderscore{_} | |
8216 | \def\normalverticalbar{|} | |
8217 | \def\normalless{<} | |
8218 | \def\normalgreater{>} | |
8219 | \def\normalplus{+} | |
08b16a02 | 8220 | \def\normaldollar{$}%$ font-lock fix |
2c825956 | 8221 | |
0f9c1975 KB |
8222 | % This macro is used to make a character print one way in \tt |
8223 | % (where it can probably be output as-is), and another way in other fonts, | |
2c825956 GM |
8224 | % where something hairier probably needs to be done. |
8225 | % | |
8226 | % #1 is what to print if we are indeed using \tt; #2 is what to print | |
8227 | % otherwise. Since all the Computer Modern typewriter fonts have zero | |
8228 | % interword stretch (and shrink), and it is reasonable to expect all | |
8229 | % typewriter fonts to have this, we can check that font parameter. | |
8230 | % | |
8231 | \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} | |
8232 | ||
8233 | % Same as above, but check for italic font. Actually this also catches | |
8234 | % non-italic slanted fonts since it is impossible to distinguish them from | |
8235 | % italic fonts. But since this is only used by $ and it uses \sl anyway | |
8236 | % this is not a problem. | |
8237 | \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} | |
8238 | ||
8239 | % Turn off all special characters except @ | |
8240 | % (and those which the user can use as if they were ordinary). | |
8241 | % Most of these we simply print from the \tt font, but for some, we can | |
8242 | % use math or other variants that look better in normal text. | |
8243 | ||
8244 | \catcode`\"=\active | |
8245 | \def\activedoublequote{{\tt\char34}} | |
8246 | \let"=\activedoublequote | |
8247 | \catcode`\~=\active | |
8248 | \def~{{\tt\char126}} | |
8249 | \chardef\hat=`\^ | |
8250 | \catcode`\^=\active | |
8251 | \def^{{\tt \hat}} | |
8252 | ||
8253 | \catcode`\_=\active | |
8254 | \def_{\ifusingtt\normalunderscore\_} | |
0f9c1975 | 8255 | \let\realunder=_ |
2c825956 | 8256 | % Subroutine for the previous macro. |
0f9c1975 | 8257 | \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } |
2c825956 GM |
8258 | |
8259 | \catcode`\|=\active | |
8260 | \def|{{\tt\char124}} | |
8261 | \chardef \less=`\< | |
8262 | \catcode`\<=\active | |
8263 | \def<{{\tt \less}} | |
8264 | \chardef \gtr=`\> | |
8265 | \catcode`\>=\active | |
8266 | \def>{{\tt \gtr}} | |
8267 | \catcode`\+=\active | |
8268 | \def+{{\tt \char 43}} | |
8269 | \catcode`\$=\active | |
08b16a02 | 8270 | \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix |
2c825956 GM |
8271 | |
8272 | % If a .fmt file is being used, characters that might appear in a file | |
8273 | % name cannot be active until we have parsed the command line. | |
8274 | % So turn them off again, and have \everyjob (or @setfilename) turn them on. | |
8275 | % \otherifyactive is called near the end of this file. | |
8276 | \def\otherifyactive{\catcode`+=\other \catcode`\_=\other} | |
8277 | ||
0f9c1975 KB |
8278 | % Used sometimes to turn off (effectively) the active characters even after |
8279 | % parsing them. | |
8280 | \def\turnoffactive{% | |
8281 | \normalturnoffactive | |
8282 | \otherbackslash | |
8283 | } | |
2c825956 | 8284 | |
0f9c1975 | 8285 | \catcode`\@=0 |
2c825956 | 8286 | |
0f9c1975 KB |
8287 | % \backslashcurfont outputs one backslash character in current font, |
8288 | % as in \char`\\. | |
8289 | \global\chardef\backslashcurfont=`\\ | |
8290 | \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work | |
2c825956 | 8291 | |
0f9c1975 KB |
8292 | % \realbackslash is an actual character `\' with catcode other, and |
8293 | % \doublebackslash is two of them (for the pdf outlines). | |
8294 | {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}} | |
2c825956 | 8295 | |
0f9c1975 KB |
8296 | % In texinfo, backslash is an active character; it prints the backslash |
8297 | % in fixed width font. | |
2c825956 | 8298 | \catcode`\\=\active |
0f9c1975 KB |
8299 | @def@normalbackslash{{@tt@backslashcurfont}} |
8300 | % On startup, @fixbackslash assigns: | |
8301 | % @let \ = @normalbackslash | |
8302 | ||
8303 | % \rawbackslash defines an active \ to do \backslashcurfont. | |
8304 | % \otherbackslash defines an active \ to be a literal `\' character with | |
8305 | % catcode other. | |
8306 | @gdef@rawbackslash{@let\=@backslashcurfont} | |
8307 | @gdef@otherbackslash{@let\=@realbackslash} | |
8308 | ||
8309 | % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of | |
8310 | % the literal character `\'. | |
8311 | % | |
8312 | @def@normalturnoffactive{% | |
8313 | @let\=@normalbackslash | |
8314 | @let"=@normaldoublequote | |
8315 | @let~=@normaltilde | |
8316 | @let^=@normalcaret | |
8317 | @let_=@normalunderscore | |
8318 | @let|=@normalverticalbar | |
8319 | @let<=@normalless | |
8320 | @let>=@normalgreater | |
8321 | @let+=@normalplus | |
8322 | @let$=@normaldollar %$ font-lock fix | |
8323 | @unsepspaces | |
8324 | } | |
2c825956 GM |
8325 | |
8326 | % Make _ and + \other characters, temporarily. | |
8327 | % This is canceled by @fixbackslash. | |
8328 | @otherifyactive | |
8329 | ||
8330 | % If a .fmt file is being used, we don't want the `\input texinfo' to show up. | |
8331 | % That is what \eatinput is for; after that, the `\' should revert to printing | |
8332 | % a backslash. | |
8333 | % | |
8334 | @gdef@eatinput input texinfo{@fixbackslash} | |
8335 | @global@let\ = @eatinput | |
8336 | ||
8337 | % On the other hand, perhaps the file did not have a `\input texinfo'. Then | |
0f9c1975 | 8338 | % the first `\' in the file would cause an error. This macro tries to fix |
2c825956 | 8339 | % that, assuming it is called before the first `\' could plausibly occur. |
0f9c1975 | 8340 | % Also turn back on active characters that might appear in the input |
2c825956 GM |
8341 | % file name, in case not using a pre-dumped format. |
8342 | % | |
8343 | @gdef@fixbackslash{% | |
8344 | @ifx\@eatinput @let\ = @normalbackslash @fi | |
8345 | @catcode`+=@active | |
8346 | @catcode`@_=@active | |
8347 | } | |
8348 | ||
8349 | % Say @foo, not \foo, in error messages. | |
8350 | @escapechar = `@@ | |
8351 | ||
177c0ea7 | 8352 | % These look ok in all fonts, so just make them not special. |
2c825956 GM |
8353 | @catcode`@& = @other |
8354 | @catcode`@# = @other | |
8355 | @catcode`@% = @other | |
8356 | ||
2c825956 GM |
8357 | |
8358 | @c Local variables: | |
8359 | @c eval: (add-hook 'write-file-hooks 'time-stamp) | |
8360 | @c page-delimiter: "^\\\\message" | |
8361 | @c time-stamp-start: "def\\\\texinfoversion{" | |
8362 | @c time-stamp-format: "%:y-%02m-%02d.%02H" | |
8363 | @c time-stamp-end: "}" | |
8364 | @c End: | |
ab5796a9 | 8365 | |
0f9c1975 KB |
8366 | @c vim:sw=2: |
8367 | ||
38572aef LT |
8368 | @ignore |
8369 | arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 | |
8370 | @end ignore |