f99c0be7b32c2037323ff81e070b77406364c584
[strayman] / strayman.dtx
1 % \begin{meta-comment}
2 %
3 % $Id: strayman.dtx,v 1.4 2003/11/07 11:32:53 mdw Exp $
4 %
5 % Document class for Straylight manuals
6 %
7 % (c) 1996 Straylight
8 %
9 % \end{meta-comment}
10 %
11 % \begin{meta-comment} <general public licence>
12 %%
13 %% strayman -- a LaTeX document class for Straylight manuals
14 %% Copyright (c) 1996 Straylight
15 %%
16 %% This program is free software; you can redistribute it and/or modify
17 %% it under the terms of the GNU General Public License as published by
18 %% the Free Software Foundation; either version 2 of the License, or
19 %% (at your option) any later version.
20 %%
21 %% This program is distributed in the hope that it will be useful,
22 %% but WITHOUT ANY WARRANTY; without even the implied warranty of
23 %% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 %% GNU General Public License for more details.
25 %%
26 %% You should have received a copy of the GNU General Public License
27 %% along with this program; if not, write to the Free Software
28 %% Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 %%
30 % \end{meta-comment}
31 %
32 % \begin{meta-comment} <Package preamble>
33 %<+strayman>\NeedsTeXFormat{LaTeX2e}
34 %<+strayman>\ProvidesClass{strayman}
35 %<+strayman> [2003/09/04 1.10 Straylight document class]
36 % \end{meta-comment}
37 %
38 % \CheckSum{3173}
39 %% \CharacterTable
40 %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
41 %% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
42 %% Digits \0\1\2\3\4\5\6\7\8\9
43 %% Exclamation \! Double quote \" Hash (number) \#
44 %% Dollar \$ Percent \% Ampersand \&
45 %% Acute accent \' Left paren \( Right paren \)
46 %% Asterisk \* Plus \+ Comma \,
47 %% Minus \- Point \. Solidus \/
48 %% Colon \: Semicolon \; Less than \<
49 %% Equals \= Greater than \> Question mark \?
50 %% Commercial at \@ Left bracket \[ Backslash \\
51 %% Right bracket \] Circumflex \^ Underscore \_
52 %% Grave accent \` Left brace \{ Vertical bar \|
53 %% Right brace \} Tilde \~}
54 %%
55 %
56 % \begin{meta-comment} <driver>
57 %
58 %<*driver>
59 \documentclass[10pt,a4paper,book,nohyperref]{strayman}
60 \input{mdwtools}
61 \usepackage{mdwlist}
62 \describesclass{strayman}
63 \errorcontextlines\maxdimen
64 \title[The \strayman\ document class]
65 {The \strayman\footnote{The \strayman\ document class is currently %
66 at version \mdwfileinfo{strayman.cls}{version}, dated %
67 \mdwfileinfo{strayman.cls}{date}.} {} document class}
68 \newenvironment{syndisplay}{\display\synshorts}{\enddisplay}
69 \DeclareRobustCommand\strayman{\package{strayman}}
70 \mdwdoc
71 %</driver>
72 %
73 % \end{meta-comment}
74 %
75 % \chapter{About the \strayman\ document class}
76 %
77 % The standard \LaTeX\ document classes are all very well for simple
78 % documents, but the style isn't appropriate for works like manuals.
79 % The \strayman\ document class is an attempt to rectify this situation,
80 % providing an attractive and distinctive style for Straylight documents.
81 % The layout is based on an earlier style built for \emph{Impression}
82 % documents, although many improvements have been made. This document
83 % was typeset using \strayman, and it demonstrates the design far better
84 % than I can describe it.
85 %
86 %
87 % \section{Document class options}
88 %
89 % The document class provides many options, most of which are taken from
90 % the standard \LaTeX\ classes.
91 %
92 % \begin{description}
93 % \def\|{\ensuremath\vert}
94 %
95 % \item [\texttt{a4paper} \| \texttt{a5paper} \| \texttt{b5paper} \|
96 % \texttt{letterpaper} \| \texttt{legalpaper} \|
97 % \texttt{executivepaper}] Select the output paper size. Since
98 % \strayman\ is intended to be used mainly for manuals, the default
99 % size is |a5paper|.
100 %
101 % \item [\texttt{landscape}] Swaps the width and height of the paper.
102 % Probably not much use, to be honest.
103 %
104 % \item [\texttt{9pt} \| \texttt{10pt} \| \texttt{11pt} \| \texttt{12pt}]
105 % Selects the basic type size for the document. The |9pt| option is
106 % nonstandard, but it is the default, since larger sizes don't work
107 % well on A5~paper.
108 %
109 % \item [\texttt{text}] Sets up the page layout and fonts so that the
110 % output can be converted fairly easily into a raw text file.
111 %
112 % \item [\texttt{oneside} \| \texttt{twoside}] Selects one- or two-sided
113 % page layouts. Note that one-sided output doesn't look too good.
114 %
115 % \item [\texttt{draft} \| \texttt{final}] Select various options for draft
116 % or final copy.
117 %
118 % \item [\texttt{titlepage} \| \texttt{notitlepage}] Selects whether
119 % the |\maketitle| displays its output on a separate title page.
120 %
121 % \item [\texttt{openright} \| \texttt{openany}] Select whether chapters
122 % start only on quarto pages, or any page. The default is |openright|.
123 %
124 % \item [\texttt{onecolumn} \| \texttt{twocolumn}] Choose whether the
125 % main body text is set in one or two columns. Note that this uses
126 % \LaTeX's built-in column handling, not the \package{multicol}
127 % package.
128 %
129 % \item [\texttt{leqno}] Put the equation numbers on the left, not the
130 % right.
131 %
132 % \item [\texttt{fleqn}] Typeset displayed equations left aligned.
133 %
134 % \item [\texttt{openbib}] Use the `open' style for the bibliography.
135 %
136 % \item [\texttt{article}] Change the formatting slightly, in a way more
137 % suited to short documents.
138 %
139 % \item [\texttt{square} \| \texttt{rounded}] These options are passed
140 % directly to the \package{syntax} package, when it's loaded.
141 %
142 % \end{description}
143 %
144 %
145 % \section{The \texttt{text} option}
146 %
147 % In order to facilitate creation of attractively formatted text files
148 % from \LaTeX\ documents, \strayman\ provides a |text| option. This will
149 % set up \emph{all} the fonts to be monospaced, in the same size. The page
150 % size is set up to be a multiple of the character size. The command
151 % \begin{syndisplay}
152 % "dvi2tty -e-17" <filename>
153 % \end{syndisplay}
154 % appears to produce a reasonable output from a DVI file created in this
155 % way. The output will need to be formatted and corrected slightly by hand
156 % although there's a good deal less work to do than might be required
157 % otherwise.
158 %
159 %
160 % \section{That's it}
161 %
162 % That's all I'm writing for now. It's a document class. It defines the
163 % style. What more do you expect?
164 %
165 %
166 % \implementation
167 %
168 % \chapter{Implementation}
169 %
170 % \section{Options handling}
171 %
172 % From here on, a lot of the code is shamelessly borrowed from
173 % \file{book.cls} and other places. This is what code re-use is for.
174 %
175 % This bit handles all the options on the |\documentclass| command, either
176 % altering our own internal arguments, or loading other packages as
177 % appropriate.
178 %
179 % \subsection{Set up some defaults}
180 %
181 % We create some variables to hold the settings, and initialise them to
182 % sensible values.
183 %
184 % \begin{macrocode}
185 %<*strayman>
186 \newcommand\@ptsize{}
187 \newif\if@restonecol\@restonecolfalse
188 \newif\if@titlepage\@titlepagefalse
189 \newif\if@openright\@openrighttrue
190 \newif\if@openbib\@openbibfalse
191 \newif\if@appendix\@appendixfalse
192 \newif\if@article\@articletrue
193 \newif\if@offsetpages\@offsetpagestrue
194 \newif\if@numbering\@numberingtrue
195 \newif\if@herefloats\@herefloatsfalse
196 \newif\if@runinsubsubsec\@runinsubsubsectrue
197 \newif\if@hyperref\@hyperreftrue
198 \newif\if@indentpar
199 \newdimen\pagesurround
200 \let\headfam\rmfamily
201 \let\pad@margin\@empty
202 \def\@delayed{}
203 \def\@delaycode#1{%
204 \expandafter\def\expandafter\@delayed\expandafter{\@delayed#1}%
205 }
206 % \end{macrocode}
207 %
208 % \subsection{Declare the options we support}
209 %
210 % This is just a tedious list of all the options.
211 %
212 % \begin{macrocode}
213 \DeclareOption{a4paper}{%
214 \paperheight297mm%
215 \paperwidth210mm%
216 \pagesurround1in%
217 }
218 \DeclareOption{a5paper}{%
219 \paperheight210mm%
220 \paperwidth148mm%
221 \pagesurround12mm%
222 }
223 \DeclareOption{b5paper}{%
224 \paperheight250mm%
225 \paperwidth176mm%
226 \pagesurround1in%
227 }
228 \DeclareOption{letterpaper}{%
229 \paperheight11in%
230 \paperwidth8.5in%
231 \pagesurround1in%
232 }
233 \DeclareOption{legalpaper}{%
234 \paperheight14in%
235 \paperwidth8.5in%
236 \pagesurround1in%
237 }
238 \DeclareOption{executivepaper}{%
239 \paperheight10.5in%
240 \paperwidth7.25in%
241 \pagesurround1in%
242 }
243 \DeclareOption{landscape}{%
244 \@tempdima\paperheight%
245 \paperheight\paperwidth%
246 \paperwidth\@tempdima%
247 }
248 \DeclareOption{8pt}{\renewcommand\@ptsize{8pt}}
249 \DeclareOption{9pt}{\renewcommand\@ptsize{9pt}}
250 \DeclareOption{10pt}{\renewcommand\@ptsize{10pt}}
251 \DeclareOption{11pt}{\renewcommand\@ptsize{11pt}}
252 \DeclareOption{12pt}{\renewcommand\@ptsize{12pt}}
253 \DeclareOption{text}{%
254 \renewcommand\@ptsize{text}%
255 \setbox\z@\hbox{\texttt{M\strut}}%
256 \newdimen\tt@chw\tt@chw\wd\z@%
257 \newdimen\tt@chh\tt@chh\ht\z@\advance\tt@chh\dp\z@%
258 \paperwidth77\tt@chw%
259 \paperheight60\tt@chh%
260 \raggedright%
261 \def\pad@margin{.}
262 }
263 \DeclareOption{oneside}{\@twosidefalse \@mparswitchfalse}
264 \DeclareOption{twoside}{\@twosidetrue \@mparswitchfalse \reversemarginpar}
265 \DeclareOption{draft}{\overfullrule5\p@}
266 \DeclareOption{final}{\overfullrule\z@}
267 \DeclareOption{titlepage}{\@titlepagetrue}
268 \DeclareOption{notitlepage}{\@titlepagefalse}
269 \DeclareOption{openright}{\@openrighttrue}
270 \DeclareOption{openany}{\@openrightfalse}
271 \DeclareOption{onecolumn}{\@twocolumnfalse}
272 \DeclareOption{twocolumn}{\@twocolumntrue}
273 \DeclareOption{offsetpages}{\@offsetpagestrue}
274 \DeclareOption{nooffsetpages}{\@offsetpagesfalse}
275 \DeclareOption{herefloats}{\@herefloatstrue}
276 \DeclareOption{noherefloats}{\@herefloatsfalse}
277 \DeclareOption{leqno}{\input{leqno.clo}}
278 \DeclareOption{fleqn}{\input{fleqn.clo}}
279 \DeclareOption{openbib}{\@openbibtrue}
280 \DeclareOption{article}{\@articletrue}
281 \DeclareOption{noarticle}{\@articlefalse}
282 \DeclareOption{numbering}{\@numberingtrue}
283 \DeclareOption{nonumbering}{\@numberingfalse}
284 \DeclareOption{runinsubsubsec}{\@runinsubsubsectrue}
285 \DeclareOption{noruninsubsubsec}{\@runinsubsubsecfalse}
286 \DeclareOption{indentpar}{\@indentpartrue}
287 \DeclareOption{noindentpar}{\@indentparfalse}
288 \DeclareOption{book}{\@titlepagetrue\@articlefalse}
289 \DeclareOption{hyperref}{\@hyperreftrue}
290 \DeclareOption{nohyperref}{\@hyperreffalse}
291 % \end{macrocode}
292 %
293 % \subsection{Set up the options}
294 %
295 % We set up some default options, and then read the user's.
296 %
297 % \begin{macrocode}
298 \ExecuteOptions{a4paper,10pt,twoside,onecolumn,final}
299 \ProcessOptions
300 % \end{macrocode}
301 %
302 % If this is PDF\TeX\ then tell it the page bounds.
303 %
304 % \begin{macrocode}
305 \newif\ifpdfing\pdfingfalse
306 \if1\ifx\pdfoutput\@@undefined@@0\else\the\pdfoutput\fi
307 \pdfingtrue
308 \fi
309 \ifpdfing
310 \pdfpageheight\paperheight
311 \pdfpagewidth\paperwidth
312 \fi
313 \if@hyperref
314 \AtEndOfClass{%
315 \RequirePackage[%
316 bookmarks = true, bookmarksnumbered = true, bookmarksdepth = 3,
317 colorlinks = true, linkcolor = blue, citecolor = blue, urlcolor = blue,
318 breaklinks = true]{hyperref}
319 }
320 \ifpdfing
321 \PassOptionsToPackage{pdftex}{hyperref}
322 \else
323 \PassOptionsToPackage{dvips}{hyperref}
324 \fi
325 \fi
326 % \end{macrocode}
327 %
328 % \subsection{Read in the text size option}
329 %
330 % The text sizing is rather messy. We store this in a separate file. To
331 % keep this stuff away from other classes, we use the file \emph{extension}
332 % as the size specifier, rather than the filename, which is the normal
333 % \LaTeX\ way of doing this. This is a \riscos\ thing mainly: I don't like
334 % loads of directories cluttering up my disk, and it means that I can move
335 % the whole of the \strayman\ stuff around as one directory.
336 %
337 % \begin{macrocode}
338 \input{strayman.\@ptsize}
339 %</strayman>
340 % \end{macrocode}
341 %
342 % \section{Package loading}
343 %
344 % \begin{macrocode}
345 %<*strayman>
346 \RequirePackage{fancyhdr}
347 \RequirePackage{multicol}
348 \@delayed
349 %</strayman>
350 % \end{macrocode}
351 %
352 % \section{Page layout}
353 %
354 % This is largely the domain of the size option files.
355 %
356 % \begin{macrocode}
357 %<*8pt|9pt|10pt|11pt|12pt|text>
358 %<+8pt>\ProvidesFile{strayman.8pt}
359 %<+9pt>\ProvidesFile{strayman.9pt}
360 %<+10pt>\ProvidesFile{strayman.10pt}
361 %<+11pt>\ProvidesFile{strayman.11pt}
362 %<+12pt>\ProvidesFile{strayman.12pt}
363 %<+text>\ProvidesFile{strayman.text}
364 % \end{macrocode}
365 %
366 % \subsection{Font sizes}
367 %
368 % These are fairly standard, and mainly copied from the original size
369 % options.
370 %
371 % \begin{macro}{\@setparskip}
372 %
373 % Because we separate paragraphs by vertical space, we need to vary this
374 % gap when we change font size. This macro does the job.
375 %
376 % \begin{macrocode}
377 \newskip\@parskip
378 \newdimen\@parshortfall
379 \def\@setparskip{%
380 \@parskip.67\baselineskip\@plus\p@\relax%
381 \ifdim\parskip=\z@\else\parskip\@parskip\relax\fi%
382 \@parshortfall\@parskip\advance\@parshortfall-\parskip%
383 }
384 \def\set@vsep#1{#1\@parshortfall\advance#1}
385 % \end{macrocode}
386 % \end{macro}
387 %
388 % \begin{macro}{\normalsize}
389 %
390 % Defines the standard size of text in the document.
391 %
392 % \begin{macrocode}
393 \renewcommand\normalsize{%
394 %<*8pt>
395 \@setfontsize\normalsize\@viiipt{9.6\p@}%
396 \abovedisplayskip8\p@\@plus2\p@\@minus4\p@%
397 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
398 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
399 %</8pt>
400 %<*9pt>
401 \@setfontsize\normalsize\@ixpt\@xipt%
402 \abovedisplayskip9\p@\@plus2\p@\@minus5\p@%
403 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
404 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
405 %</9pt>
406 %<*10pt>
407 \@setfontsize\normalsize\@xpt\@xiipt%
408 \abovedisplayskip10\p@\@plus2\p@\@minus5\p@%
409 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
410 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
411 %</10pt>
412 %<*11pt>
413 \@setfontsize\normalsize\@xipt{13.6}%
414 \abovedisplayskip11\p@\@plus3\p@\@minus6\p@%
415 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
416 \set@vsep\belowdisplayshortskip6.5\p@ \@plus3.5\p@\@minus3\p@%
417 %</11pt>
418 %<*12pt>
419 \@setfontsize\normalsize\@xiipt{14.5}%
420 \abovedisplayskip12\p@\@plus3\p@\@minus7\p@%
421 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
422 \set@vsep\belowdisplayshortskip6.5\p@ \@plus3.5\p@\@minus3\p@%
423 %</12pt>
424 %<*text>
425 \@setfontsize\normalsize\@xpt\@xiipt%
426 \abovedisplayskip10\p@\@plus2\p@\@minus5\p@%
427 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
428 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
429 %</text>
430 \belowdisplayskip\abovedisplayskip%
431 \let\@listi\@listI%
432 \@setparskip%
433 }
434 \normalsize
435 \if@indentpar
436 \parskip0pt\@plus\p@
437 \else
438 \parskip2ex\@plus\p@
439 \fi
440 % \end{macrocode}
441 % \end{macro}
442 %
443 % \begin{macro}{\small}
444 %
445 % The |\small| size is defined with similar care to |\normalsize|. The
446 % list defaults are altered to cope with our different value for |\parskip|.
447 % We can then separate this out independently from the typesize.
448 %
449 % \begin{macrocode}
450 %<+text>\let\small\normalsize
451 %<*8pt|9pt|10pt|11pt|12pt>
452 \newcommand\small{%
453 %<*8pt>
454 \@setfontsize\small\@viipt{8.4}%
455 \abovedisplayskip8\p@\@plus2\p@\@minus4\p@%
456 \set@vsep\abovedisplayshortskip\z@\@plus2\p@%
457 \set@vsep\belowdisplayshortskip4\p@\@plus2\p@\@minus2\p@%
458 %</8pt>
459 %<*9pt>
460 \@setfontsize\small\@viiipt{9.5}%
461 \abovedisplayskip8\p@\@plus2\p@\@minus4\p@%
462 \set@vsep\abovedisplayshortskip\z@\@plus2\p@%
463 \set@vsep\belowdisplayshortskip4\p@\@plus2\p@\@minus2\p@%
464 %</9pt>
465 %<*10pt>
466 \@setfontsize\small\@ixpt{11}%
467 \abovedisplayskip8.5\p@\@plus3\p@\@minus4\p@%
468 \set@vsep\abovedisplayshortskip\z@\@plus2\p@%
469 \set@vsep\belowdisplayshortskip4\p@\@plus2\p@\@minus2\p@%
470 %</10pt>
471 %<*11pt>
472 \@setfontsize\small\@xpt\@xiipt%
473 \abovedisplayskip10\p@\@plus2\p@\@minus5\p@%
474 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
475 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
476 %</11pt>
477 %<*12pt>
478 \@setfontsize\small\@xipt{13.6}%
479 \abovedisplayskip11\p@\@plus3\p@\@minus6\p@%
480 \set@vsep\abovedisplayshortskip\z@ \@plus3\p@%
481 \set@vsep\belowdisplayshortskip6.5\p@ \@plus3.5\p@\@minus3\p@%
482 %</12pt>
483 \def\@listi{%
484 \leftmargin\leftmargini%
485 \topsep\@parshortfall%
486 \parsep\@parskip%
487 \itemsep\z@%
488 }%
489 \belowdisplayskip\abovedisplayskip%
490 \@setparskip%
491 }
492 %</8pt|9pt|10pt|11pt|12pt>
493 % \end{macrocode}
494 % \end{macro}
495 %
496 % \begin{macro}{\footnotesize}
497 %
498 % This is also defined with the meticulous care of |\normalsize|, and
499 % altered in the same way as for |\small|.
500 %
501 % \begin{macrocode}
502 %<+text>\let\footnotesize\normalsize
503 %<*8pt|9pt|10pt|11pt|12pt>
504 \newcommand\footnotesize{%
505 %<*8pt>
506 \@setfontsize\footnotesize\@vipt\@viipt%
507 \set@vsep\abovedisplayskip6\p@\@plus2\p@\@minus4\p@%
508 \set@vsep\abovedisplayshortskip\z@\@plus\p@%
509 \set@vsep\belowdisplayshortskip3\p@\@plus\p@\@minus2\p@%
510 %</8pt>
511 %<*9pt>
512 \@setfontsize\footnotesize\@viipt{8.4}%
513 \set@vsep\abovedisplayskip6\p@\@plus2\p@\@minus4\p@%
514 \set@vsep\abovedisplayshortskip\z@\@plus\p@%
515 \set@vsep\belowdisplayshortskip3\p@\@plus\p@\@minus2\p@%
516 %</9pt>
517 %<*10pt>
518 \@setfontsize\footnotesize\@viiipt{9.5}%
519 \set@vsep\abovedisplayskip6\p@\@plus2\p@\@minus4\p@%
520 \set@vsep\abovedisplayshortskip\z@\@plus\p@%
521 \set@vsep\belowdisplayshortskip3\p@\@plus\p@\@minus2\p@%
522 %</10pt>
523 %<*11pt>
524 \@setfontsize\footnotesize\@ixpt{11}%
525 \set@vsep\abovedisplayskip8\p@\@plus2\p@\@minus4\p@%
526 \set@vsep\abovedisplayshortskip\z@\@plus\p@%
527 \set@vsep\belowdisplayshortskip4\p@\@plus2\p@\@minus2\p@%
528 %</11pt>
529 %<*12pt>
530 \@setfontsize\footnotesize\@xpt\@xiipt
531 \set@vsep\abovedisplayskip10\p@\@plus2\p@\@minus5\p@%
532 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
533 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
534 %</12pt>
535 \def\@listi{%
536 \leftmargin\leftmargini%
537 \topsep\@parshortfall%
538 \parsep\@parskip%
539 \itemsep\z@%
540 }%
541 \belowdisplayskip\abovedisplayskip%
542 \@setparskip%
543 }
544 %</8pt|9pt|10pt|11pt|12pt>
545 % \end{macrocode}
546 % \end{macro}
547 %
548 % The other sizes are all much simpler. We introduce a new size,
549 % |\listingsize|, which is used for the \env{listing} environment, to ensure
550 % that 77 columns of text fit across an A5 sheet.
551 %
552 % \begin{macrocode}
553 %<*8pt>
554 \newcommand\scriptsize{\@setfontsize\scriptsize\@vpt\@vipt\@setparskip}
555 \newcommand\tiny{\@setfontsize\tiny{4}\@vpt\@setparskip}
556 \newcommand\large{\@setfontsize\large\@xpt\@xiipt\@setparskip}
557 \newcommand\Large{\@setfontsize\Large\@xipt{13}\@setparskip}
558 \newcommand\LARGE{\@setfontsize\LARGE\@xiipt\@xivpt\@setparskip}
559 \newcommand\huge{\@setfontsize\huge\@xviipt{20}\@setparskip}
560 \newcommand\Huge{\@setfontsize\Huge\@xxpt{26}\@setparskip}
561 %</8pt>
562 %<*9pt>
563 \newcommand\scriptsize{\@setfontsize\scriptsize\@vipt\@viipt\@setparskip}
564 \newcommand\tiny{\@setfontsize\tiny\@vpt\@vipt\@setparskip}
565 \newcommand\large{\@setfontsize\large\@xipt{13}\@setparskip}
566 \newcommand\Large{\@setfontsize\Large\@xiipt{14.4}\@setparskip}
567 \newcommand\LARGE{\@setfontsize\LARGE\@xivpt{17}\@setparskip}
568 \newcommand\huge{\@setfontsize\huge\@xviipt{20}\@setparskip}
569 \newcommand\Huge{\@setfontsize\Huge\@xxpt{26}\@setparskip}
570 %</9pt>
571 %<*10pt>
572 \newcommand\scriptsize{\@setfontsize\scriptsize\@viipt\@viiipt\@setparskip}
573 \newcommand\tiny{\@setfontsize\tiny\@vpt\@vipt\@setparskip}
574 \newcommand\large{\@setfontsize\large\@xiipt{14}\@setparskip}
575 \newcommand\Large{\@setfontsize\Large\@xivpt{18}\@setparskip}
576 \newcommand\LARGE{\@setfontsize\LARGE\@xviipt{22}\@setparskip}
577 \newcommand\huge{\@setfontsize\huge\@xxpt{25}\@setparskip}
578 \newcommand\Huge{\@setfontsize\Huge\@xxvpt{30}\@setparskip}
579 %</10pt>
580 %<*11pt>
581 \newcommand\scriptsize{\@setfontsize\scriptsize\@viiipt{9.5}\@setparskip}
582 \newcommand\tiny{\@setfontsize\tiny\@vipt\@viipt\@setparskip}
583 \newcommand\large{\@setfontsize\large\@xiipt{14}\@setparskip}
584 \newcommand\Large{\@setfontsize\Large\@xivpt{18}\@setparskip}
585 \newcommand\LARGE{\@setfontsize\LARGE\@xviipt{22}\@setparskip}
586 \newcommand\huge{\@setfontsize\huge\@xxpt{25}\@setparskip}
587 \newcommand\Huge{\@setfontsize\Huge\@xxvpt{30}\@setparskip}
588 %</11pt>
589 %<*12pt>
590 \newcommand\scriptsize{\@setfontsize\scriptsize\@viiipt{9.5}\@setparskip}
591 \newcommand\tiny{\@setfontsize\tiny\@vipt\@viipt\@setparskip}
592 \newcommand\large{\@setfontsize\large\@xivpt{18}\@setparskip}
593 \newcommand\Large{\@setfontsize\Large\@xviipt{22}\@setparskip}
594 \newcommand\LARGE{\@setfontsize\LARGE\@xxpt{25}\@setparskip}
595 \newcommand\huge{\@setfontsize\huge\@xxvpt{30}\@setparskip}
596 \let\Huge\huge
597 %</12pt>
598 %<+8pt|9pt|10pt|11pt|12pt>\let\listingsize\footnotesize
599 %<*text>
600 \def\scriptsize{\@setfontsize\scriptsize\@xpt\@xiipt\@setparskip}
601 \let\tiny\scriptsize
602 \let\large\scriptsize
603 \let\Large\scriptsize
604 \let\LARGE\scriptsize
605 \let\huge\scriptsize
606 \let\Huge\scriptsize
607 \let\listingsize\scriptsize
608 %
609 \let\txt@selectfont\selectfont
610 \def\selectfont{%
611 \fontfamily\ttdefault%
612 \fontseries{m}%
613 \fontshape{n}%
614 \txt@selectfont%
615 }
616 %</text>
617 %</8pt|9pt|10pt|11pt|12pt|text>
618 % \end{macrocode}
619 %
620 % \subsection{Paragraph layout}
621 %
622 % Here we define various paragraph layout parameters.
623 %
624 % First, set up the line separation parameters. |\baselineskip| is set
625 % up by the individual size commands.
626 %
627 % \begin{macrocode}
628 %<*strayman>
629 \lineskip\p@
630 \normallineskip\p@
631 % \end{macrocode}
632 %
633 % We don't try to stretch the baselines apart:
634 %
635 % \begin{macrocode}
636 \renewcommand\baselinestretch{}
637 % \end{macrocode}
638 %
639 % Paragraph indentation is set up later.
640 %
641 % Set up some standard penalty values.
642 %
643 % \begin{macrocode}
644 \@lowpenalty 51
645 \@medpenalty 151
646 \@highpenalty 301
647 %</strayman>
648 % \end{macrocode}
649 %
650 % \subsection{Page layout}
651 %
652 % Our layout is a bit different to the standard \LaTeX\ ones: we leave a lot
653 % of space down the left hand side: this is reserved for headings and
654 % marginal notes.
655 %
656 % Calculating the size of the space on the left, which we call |\leftindent|,
657 % is complicated. We want to use as much of the width of the page as
658 % possible, unlike the \LaTeX\ defaults, making sure that we can fit on
659 % 77 columns of |\listingsize\tt| text. We also try to make space for a
660 % reasonable amount of marginal text, although we don't worry too much if
661 % that suffers.
662 %
663 % The calculation is done as follows. More than about 40\,mm of margin will
664 % look very strange. We must have at least 104\,mm of main text, which
665 % leaves 20\,mm for the notes on A5 paper (actually, 17\,mm, since we leave
666 % 3\,mm gap between the notes and the main text). We divide the page
667 % horizontally into $s$\,mm of left border, $m$\,mm of marginal notes,
668 % $t$\,mm of body text, and another $s$\,mm of right border, giving
669 % a total of $w$\,mm. The value $s$ is given to us by the parameter
670 % |\pagesurround|.
671 %
672 % Articles look odd with a big gap down the side, so this is reduced when
673 % necessary.
674 %
675 % We calculate the quantity~$m$ as $\min\bigl(40,17(w-2s-3)/121+3\bigr)$\@.
676 % Then we calculate $t=w-m-24-3$.
677 %
678 % \begin{macrocode}
679 %<*8pt|9pt|10pt|11pt|12pt|text>
680 \newdimen\leftindent
681 %<*8pt|9pt|10pt|11pt|12pt>
682 \leftindent\paperwidth
683 \if@offsetpages
684 \advance\leftindent-2\pagesurround
685 \advance\leftindent-3mm
686 \leftindent0.1405\leftindent
687 \advance\leftindent3mm
688 \ifdim\leftindent>40mm\relax
689 \leftindent40mm
690 \fi
691 \if@article\divide\leftindent\tw@\fi
692 \ifdim\leftindent<15mm\leftindent15mm\fi
693 \else
694 \leftindent\z@
695 \fi
696 %</8pt|9pt|10pt|11pt|12pt>
697 %<+text>\leftindent8\tt@chw
698 % \end{macrocode}
699 %
700 % In two-column layouts, we prevent headings from being outdented, by
701 % zeroing |\sectindent|. Chapter headings and suchlike are still outdented
702 % as before. We do not support margin paragraphs in two-column layouts.
703 %
704 % \begin{macrocode}
705 \newdimen\sectindent
706 \if@twocolumn
707 \sectindent\z@
708 \else
709 \sectindent\if@numbering\z@\else\if@article\else\tw@\fi\leftindent\fi
710 \fi
711 % \end{macrocode}
712 %
713 % Having set up the size of the margin, we can get on with the rest of the
714 % setting up.
715 %
716 % First, we fix |\hoffset| and |\voffset| so we can work on the whole size
717 % of the paper.
718 %
719 % \begin{macrocode}
720 \advance\hoffset-1in
721 \advance\voffset-1in
722 % \end{macrocode}
723 %
724 % Now we can design the page layout in earnest. We begin with the vertical
725 % layout.
726 %
727 % \begin{macrocode}
728 %<+8pt>\topskip8\p@
729 %<+9pt>\topskip9\p@
730 %<+10pt>\topskip10\p@
731 %<+11pt>\topskip11\p@
732 %<+12pt>\topskip12\p@
733 %<+text>\topskip\tt@chh
734 %<-text>\topmargin\pagesurround
735 %<+text>\topmargin\z@
736 %<-text>\headheight12\p@
737 %<+text>\headheight12\p@
738 %<-text>\headsep.5\pagesurround
739 %<+text>\headsep2\tt@chh
740 %<+text>\advance\headsep-12\p@
741 %<-text>\footskip12\p@
742 %<-text>\advance\footskip.5\pagesurround
743 %<+text>\footskip2\tt@chh
744 \textheight\paperheight
745 %<-text>\advance\textheight-24\p@
746 %<-text>\advance\textheight-3\pagesurround
747 %<+text>\advance\textheight-4\tt@chh
748 % \end{macrocode}
749 %
750 % Now we define the horizontal layout.
751 %
752 % \begin{macrocode}
753 \oddsidemargin\leftindent
754 %<-text>\advance\oddsidemargin\pagesurround
755 \evensidemargin\oddsidemargin
756 \textwidth\paperwidth
757 \advance\textwidth-\oddsidemargin
758 %<-text> \advance\textwidth-\pagesurround
759 %<-text>\marginparsep3mm
760 %<+text>\marginparsep\tt@chw
761 \marginparwidth\leftindent
762 \advance\marginparwidth-\marginparsep
763 % \end{macrocode}
764 %
765 % Setting |\maxdepth| is fairly simple. This looks odd, because normally
766 % there's some messing for compatibility with \LaTeX~2.09.
767 %
768 % \begin{macrocode}
769 \maxdepth.5\topskip
770 \@maxdepth\maxdepth
771 % \end{macrocode}
772 %
773 % Marginal notes need some setting up.
774 %
775 % \begin{macrocode}
776 \marginparpush5\p@
777 % \end{macrocode}
778 %
779 % Footnotes need some setting up now.
780 %
781 % \begin{macrocode}
782 %<+8pt>\footnotesep5.8\p@
783 %<+9pt>\footnotesep6.2\p@
784 %<+10pt>\footnotesep6.65\p@
785 %<+11pt>\footnotesep7.7\p@
786 %<+12pt>\footnotesep8.4\p@
787 %<+8pt>\setlength{\skip\footins}{7\p@\@plus4\p@\@minus2\p@}
788 %<+9pt>\setlength{\skip\footins}{8\p@\@plus4\p@\@minus2\p@}
789 %<+10pt>\setlength{\skip\footins}{9\p@\@plus4\p@\@minus2\p@}
790 %<+11pt>\setlength{\skip\footins}{10\p@\@plus4\p@\@minus2\p@}
791 %<+12pt>\setlength{\skip\footins}{10.8\p@\@plus4\p@\@minus2\p@}
792 %</8pt|9pt|10pt|11pt|12pt|text>
793 % \end{macrocode}
794 %
795 % \subsection{Float placement}
796 %
797 % First, we determine how we position the floats on the page.
798 %
799 % \begin{macrocode}
800 %<*strayman>
801 \setcounter{topnumber}{2}
802 \renewcommand\topfraction{.7}
803 \setcounter{bottomnumber}{1}
804 \renewcommand\bottomfraction{.3}
805 \setcounter{totalnumber}{3}
806 \renewcommand\textfraction{.1}
807 \renewcommand\floatpagefraction{.8}
808 \setcounter{dbltopnumber}{2}
809 \renewcommand\dbltopfraction{.7}
810 \renewcommand\dblfloatpagefraction{.5}
811 %</strayman>
812 % \end{macrocode}
813 %
814 % Now we define the glue which surrounds floats.
815 %
816 % \begin{macrocode}
817 %<*8pt|9pt|10pt|11pt|12pt>
818 \floatsep12\p@\@plus2\p@\@minus2\p@
819 \textfloatsep20\p@\@plus2\p@\@minus4\p@
820 \dbltextfloatsep20\p@\@plus2\p@\@minus4\p@
821 %<+8pt|9pt|10pt|11pt>\intextsep12\p@\@plus2\p@\@minus 2\p@
822 %<+8pt|9pt|10pt|11pt>\dblfloatsep12\p@\@plus2\p@\@minus 2\p@
823 %<+12pt>\intextsep14\p@\@plus4\p@\@minus 4\p@
824 %<+12pt>\dblfloatsep14\p@\@plus2\p@\@minus 4\p@
825 % \end{macrocode}
826 %
827 % We must now define the parameters for float pages and columns.
828 %
829 % \begin{macrocode}
830 \@fptop0\p@\@plus 1fil
831 %<+8pt|9pt|10pt|11pt>\@fpsep8\p@\@plus2fil
832 %<+12pt>\@fpsep10\p@\@plus2fil
833 \@fpbot0\p@\@plus 1fil
834 %
835 \@dblfptop0\p@\@plus 1fil
836 %<+8pt|9pt|10pt|11pt>\@dblfpsep8\p@\@plus 2fil
837 %<+12pt>\@dblfpsep10\p@\@plus2fil
838 \@dblfpbot0\p@\@plus 1fil
839 %</8pt|9pt|10pt|11pt|12pt>
840 % \end{macrocode}
841 %
842 % \section{Headers and footers}
843 %
844 % This part defines the standard page styles. By default, \strayman\
845 % imports \package{fancyheadings} and uses them, although this section is
846 % retained in case anything actually needs the original \LaTeX-style
847 % headings.
848 %
849 % \begin{macrocode}
850 %<*strayman>
851 \def\ps@headings{%
852 \let\@oddfoot\@empty\let\@evenfoot\@empty
853 \def\@evenhead{\thepage\hfil\slshape\leftmark}%
854 \def\@oddhead{{\slshape\rightmark}\hfil\thepage}%
855 \let\@mkboth\markboth
856 \def\chaptermark##1{\markboth {\thechapter. ##1}{}}%
857 \def\sectionmark##1{\markright {\thesection. ##1}}%
858 }
859 %
860 \def\ps@myheadings{%
861 \let\@oddfoot\@empty\let\@evenfoot\@empty
862 \def\@evenhead{\thepage\hfil\slshape\leftmark}%
863 \def\@oddhead{{\slshape\rightmark}\hfil\thepage}%
864 \let\@mkboth\@gobbletwo
865 \let\chaptermark\@gobble
866 \let\sectionmark\@gobble
867 }
868 % \end{macrocode}
869 %
870 % \section{Titles}
871 %
872 % \begin{macro}{\maketitle}
873 % This is a bit of a thorny issue at the moment. Really, these titles need
874 % a complete rewrite. The |\maketitle| command will only be used for inside
875 % front covers anyway. I'm wondering if it wouldn't be better just to use
876 % special case code for each individual manual. Until a decision is made,
877 % I'll leave this as it was in \package{book}.
878 %
879 % \begin{note}
880 % This code is largely uncommented. It seems to be fairly straightforward,
881 % and if I do need to change it, I'll probably start again from scratch
882 % anyway.
883 % \end{note}
884 %
885 % \begin{macrocode}
886 \if@titlepage
887 %
888 \newcommand\maketitle{%
889 \begin{titlepage}%
890 \let\footnotesize\small%
891 \let\footnoterule\relax%
892 \null\vfil%
893 \vskip 60\p@%
894 \begin{center}%
895 {\LARGE\@title\par}%
896 \vskip3em%
897 {%
898 \large%
899 \lineskip.75em%
900 \begin{tabular}[t]{c}%
901 \@author%
902 \end{tabular}%
903 \par%
904 }%
905 \vskip1.5em%
906 {\large \@date \par}% % Set date in \large size.
907 \end{center}%
908 \par%
909 \@thanks%
910 \vfil\null%
911 \end{titlepage}%
912 \setcounter{footnote}{0}%
913 \let\thanks\relax%
914 \let\maketitle\relax%
915 \gdef\@thanks{}%
916 \gdef\@author{}%
917 \gdef\@title{}%
918 }
919 %
920 \else
921 %
922 \newcommand\maketitle{%
923 \par%
924 \begingroup%
925 \renewcommand\thefootnote{\fnsymbol{footnote}}%
926 \def\@makefnmark{\hb@xt@\z@{$\m@th^{\@thefnmark}$\hss}}%
927 \long\def\@makefntext##1{%
928 \parindent1em\noindent%
929 \hb@xt@1.8em{\hss$\m@th^{\@thefnmark}$}##1%
930 }%
931 \if@twocolumn%
932 \ifnum\col@number=\@ne%
933 \@maketitle%
934 \else%
935 \twocolumn[\@maketitle]%
936 \fi%
937 \else%
938 \newpage%
939 \global\@topnum\z@% % Prevents figures from going at top of page.
940 \@maketitle%
941 \fi%
942 \thispagestyle{plain}%
943 \@thanks%
944 \endgroup%
945 \setcounter{footnote}{0}%
946 \let\thanks\relax%
947 \let\maketitle\relax%
948 \let\@maketitle\relax%
949 \gdef\@thanks{}%
950 \gdef\@author{}%
951 \gdef\@title{}%
952 }
953 %
954 \fi
955 %
956 \def\@maketitle{%
957 \newpage%
958 \null%
959 \vskip2em%
960 \begin{center}%
961 {\LARGE\@title\par}%
962 \vskip1.5em%
963 {%
964 \large%
965 \lineskip.5em%
966 \begin{tabular}[t]{c}%
967 \@author%
968 \end{tabular}%
969 \par%
970 }%
971 \vskip 1em%
972 {\large\@date}%
973 \end{center}%
974 \par%
975 \vskip1.5em%
976 }
977 % \end{macrocode}
978 % \end{macro}
979 %
980 % \begin{environment}{titlepage}
981 %
982 % The \env{titlepage} environment typesets its contents on a title page.
983 % The implementation is fairly straightforward: we just need to do some
984 % fiddling with two-column layouts. We also add in some hacking to make
985 % title pages centred properly, a bit like the \env{central} environment.
986 %
987 % \begin{macrocode}
988 \newenvironment{titlepage}{%
989 \cleardoublepage%
990 \if@twocolumn%
991 \@restonecoltrue\onecolumn%
992 \else%
993 \@restonecolfalse\newpage%
994 \fi%
995 \centrepage%
996 \if@compatibility%
997 \setcounter{page}{0}%
998 \fi%
999 }{%
1000 \thispagestyle{empty}%
1001 \if@restonecol%
1002 \twocolumn%
1003 \else%
1004 \newpage%
1005 \fi%
1006 }
1007 % \end{macrocode}
1008 % \end{environment}
1009 %
1010 % \begin{macro}{\centrepage}
1011 %
1012 % Change the page layout to centre everything properly. We guard against
1013 % this sort of thing happening again by clearing |\leftindent| and
1014 % |\sectindent|. This should only be cleared after the page has been
1015 % finished, for obvious reasons.
1016 %
1017 % \begin{macrocode}
1018 \def\centrepage{%
1019 \advance\oddsidemargin-\leftindent%
1020 \advance\evensidemargin-\leftindent%
1021 \advance\textwidth\leftindent%
1022 \advance\linewidth\leftindent%
1023 \advance\leftmargini0.5\leftindent%
1024 \leftindent\z@%
1025 \sectindent\z@%
1026 \hsize\textwidth%
1027 }
1028 % \end{macrocode}
1029 % \end{macro}
1030 %
1031 % \section{Sectioning commands}
1032 %
1033 % In \strayman, quite a lot of the sectioning is different. We
1034 % don't tend to number sections much. Also, the chapter heading style has
1035 % been completely rewritten (several times).
1036 %
1037 % \subsection{Setting up the counters}
1038 %
1039 % This is pretty simple stuff.
1040 %
1041 % \begin{macrocode}
1042 \newcommand\chaptermark[1]{}
1043 \setcounter{secnumdepth}{\if@numbering\if@runinsubsubsec2\else3\fi\else0\fi}
1044 \newcounter {part}
1045 \newcounter {chapter}
1046 \newcounter {section}[chapter]
1047 \newcounter {subsection}[section]
1048 \newcounter {subsubsection}[subsection]
1049 \newcounter {paragraph}[subsubsection]
1050 \newcounter {subparagraph}[paragraph]
1051 \renewcommand\thepart {\Roman{part}}
1052 \renewcommand\thechapter {\arabic{chapter}}
1053 \if@article
1054 \renewcommand\thesection {\arabic{section}}
1055 \else
1056 \renewcommand\thesection {\thechapter.\arabic{section}}
1057 \fi
1058 \renewcommand\thesubsection {\thesection.\arabic{subsection}}
1059 \renewcommand\thesubsubsection {\thesubsection .\arabic{subsubsection}}
1060 \renewcommand\theparagraph {\thesubsubsection.\arabic{paragraph}}
1061 \renewcommand\thesubparagraph {\theparagraph.\arabic{subparagraph}}
1062 % \end{macrocode}
1063 %
1064 % \subsection{Frontmatter, mainmatter and backmatter}
1065 %
1066 % We start off thinking we're in the main matter. The user ought to put a
1067 % |\frontmatter| command at the beginning of the document if this is not
1068 % correct, as it usually won't be.
1069 %
1070 % \begin{macrocode}
1071 \if@article\else%
1072 \newif\if@mainmatter
1073 \@mainmattertrue
1074 \newcommand\frontmatter{%
1075 \cleardoublepage%
1076 \@mainmatterfalse%
1077 \pagenumbering{roman}%
1078 }
1079 \newcommand\mainmatter{%
1080 \cleardoublepage%
1081 \@mainmattertrue%
1082 \pagenumbering{arabic}%
1083 }
1084 \newcommand\backmatter{%
1085 \if@openright%
1086 \cleardoublepage%
1087 \else%
1088 \clearpage%
1089 \fi%
1090 \@mainmatterfalse%
1091 }
1092 \fi
1093 % \end{macrocode}
1094 %
1095 % \subsection{Abstracts}
1096 %
1097 % \begin{environment}{abstract}
1098 %
1099 % The \env{abstract} environment reduces the type size and margins slightly.
1100 % Abstracts are placed on their own pages when the |titlepage| option is
1101 % enabled. The code is filched from the LaTeX article class.
1102 %
1103 % \begin{macrocode}
1104 \if@titlepage
1105 \newenvironment{abstract}{%
1106 \titlepage
1107 \null\vfil
1108 \@beginparpenalty\@lowpenalty
1109 \begin{center}%
1110 \bfseries \abstractname
1111 \@endparpenalty\@M
1112 \end{center}}%
1113 {\par\vfil\null\endtitlepage}
1114 \else
1115 \newenvironment{abstract}{%
1116 \if@twocolumn
1117 \section*{\abstractname}%
1118 \else
1119 \small
1120 \list{}{%
1121 \def\makelabel##1{%
1122 \normalfont%
1123 \fontseries{b}\fontfamily\headdefault\selectfont%
1124 ##1%
1125 }%
1126 \labelsep1em\labelwidth\z@\itemindent\labelsep%
1127 \rightmargin\leftmargin%
1128 }
1129 \item[\abstractname]%
1130 \fi}
1131 {\if@twocolumn\else\endlist\fi}
1132 \fi
1133 % \end{macrocode}
1134 % \end{environment}
1135 %
1136 % \subsection{Appendices}
1137 %
1138 % \begin{macro}{\appendix}
1139 %
1140 % This command sets everything up to typeset the appendix.
1141 %
1142 % \begin{macrocode}
1143 \newcommand\appendix{%
1144 \par%
1145 \setcounter{chapter}{0}%
1146 \setcounter{section}{0}%
1147 \renewcommand\@chapapp{\appendixname}%
1148 \if@article%
1149 \renewcommand\thesection{\Alph{section}}%
1150 \else%
1151 \renewcommand\thechapter{\Alph{chapter}}%
1152 \fi%
1153 \@appendixtrue%
1154 }
1155 % \end{macrocode}
1156 % \end{macro}
1157 %
1158 % \subsection{Parts}
1159 %
1160 % Part headings are typeset on completely unadorned sheets, devoid of page
1161 % numbers and suchlike. Because of the strange page layout, we have to
1162 % put the part heading into a |central| environment. to stop the page looking
1163 % horribly lopsided.
1164 %
1165 % \begin{macro}{\part}
1166 %
1167 % The |\part| macro moves to an appropriate page, changes the pagestyle to
1168 % empty to switch off page numbering, and then calls |\@part| or |\@spart|
1169 % as appropriate, according to whether a \lit* was supplied. We put some
1170 % |\vfil| glue in, to vertically centre anything that these commands typeset,
1171 % and ensure printing in a single column.
1172 %
1173 % \begin{macrocode}
1174 \if@article
1175 \newcommand\part{%
1176 \if@noskipsec\leavevmode\fi\par%
1177 \addvspace{4ex}%
1178 \@afterindentfalse
1179 \secdef\@part\@spart%
1180 }
1181 \else
1182 \newcommand\part{%
1183 \cleardoublepage%
1184 \thispagestyle{empty}%
1185 \if@twocolumn%
1186 \onecolumn%
1187 \@tempswatrue%
1188 \else%
1189 \@tempswafalse%
1190 \fi%
1191 \hbox{}\vfil%
1192 \secdef\@part\@spart%
1193 }
1194 \fi
1195 % \end{macrocode}
1196 %
1197 % \begin{macro}{\@part}
1198 %
1199 % This is where most of the part heading typesetting is done. We stick a
1200 % line in the contents file, clear the heading markers, and typeset the
1201 % heading in the biggest letters we can find. When we're done, we call
1202 % |\@endpart| to do some common cleaning up.
1203 %
1204 % \begin{macrocode}
1205 \if@article
1206 \def\@part[#1]#2{%
1207 \ifnum\c@secnumdepth>\m@ne\relax%
1208 \refstepcounter{part}%
1209 \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}%
1210 \else%
1211 \addcontentsline{toc}{part}{#1}%
1212 \fi%
1213 \begingroup%
1214 \parindent\z@ \raggedright \interlinepenalty\@M%
1215 \reset@font\bfseries\headfam%
1216 \ifnum\c@secnumdepth>\m@ne%
1217 \Large\partname\nobreakspace\thepart \par\nobreak%
1218 \fi%
1219 \huge #2%
1220 \markboth{}{}\par%
1221 \endgroup%
1222 \nobreak \vskip3ex \@afterheading%
1223 }
1224 \else
1225 \def\@part[#1]#2{%
1226 \ifnum\c@secnumdepth>-2\relax%
1227 \refstepcounter{part}%
1228 \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}%
1229 \else%
1230 \addcontentsline{toc}{part}{#1}%
1231 \fi%
1232 \markboth{}{}%
1233 \begin{centrepage}%
1234 \centering%
1235 \interlinepenalty\@M%
1236 \reset@font%
1237 \ifnum\c@secnumdepth>-2\relax%
1238 \huge\bfseries\headfam\partname~\thepart%
1239 \par%
1240 \vskip20\p@
1241 \fi%
1242 \normalfont\Huge\bfseries\headfam#2\par%
1243 \@endpart%
1244 }
1245 \fi
1246 % \end{macrocode}
1247 % \end{macro}
1248 %
1249 % \begin{macro}{\@spart}
1250 %
1251 % Here we typeset just the part heading: numbers have been suppressed. Also
1252 % we don't put things into the contents file. Otherwise, this is similar to
1253 % |\@part|.
1254 %
1255 % \begin{macrocode}
1256 \if@article
1257 \def\@spart#1{%
1258 \begingroup%
1259 \parindent\z@ \raggedright \interlinepenalty\@M%
1260 \reset@font\bfseries\headfam%
1261 \huge #1%
1262 \markboth{}{}\par%
1263 \endgroup%
1264 \nobreak \vskip3ex \@afterheading%
1265 }
1266 \else
1267 \def\@spart#1{%
1268 \begin{centrepage}%
1269 \centering%
1270 \interlinepenalty\@M%
1271 \reset@font%
1272 \normalfont\Huge\bfseries\headfam#1\par%
1273 \@endpart%
1274 }
1275 \fi
1276 % \end{macrocode}
1277 % \end{macro}
1278 %
1279 % \begin{macro}{\@endpart}
1280 %
1281 % This does the clearing up operation after a part has been typeset. We
1282 % insert the other |\vfil| glue to centre the heading, clear the other
1283 % side of the page, if printing two-sided, and return if necessary to
1284 % two-column printing.
1285 %
1286 % \begin{macrocode}
1287 \def\@endpart{%
1288 \vfil\newpage%
1289 \end{centrepage}%
1290 \if@twoside%
1291 \hbox{}%
1292 \thispagestyle{empty}%
1293 \newpage%
1294 \fi%
1295 \if@tempswa%
1296 \twocolumn%
1297 \fi%
1298 }
1299 % \end{macrocode}
1300 % \end{macro}
1301 % \end{macro}
1302 %
1303 % \subsection{Chapters}
1304 %
1305 % The chapter typesetting has been more-or-less rewritten. We'll follow this
1306 % in a reasonable amount of detail.
1307 %
1308 % \begin{macro}{\@chapapp}
1309 %
1310 % Because |\appendix| needs to change what chapters are called, we add a
1311 % level of indirection through |\@chapapp|:
1312 %
1313 % \begin{macrocode}
1314 \newcommand\@chapapp{\chaptername}
1315 % \end{macrocode}
1316 % \end{macro}
1317 %
1318 % \begin{macro}{\chapter}
1319 %
1320 % The |\chapter| command is the main dispatcher for chapters. We move to
1321 % an appropriate page, depending on the |openright| setting, suppress
1322 % headers, and then call |\@chapter| or |\@schapter| as appropriate.
1323 %
1324 % \begin{macrocode}
1325 \if@article\else
1326 \newcommand\chapter{%
1327 \if@openright%
1328 \cleardoublepage%
1329 \else%
1330 \clearpage%
1331 \fi%
1332 \thispagestyle{plain}%
1333 \global\@topnum\z@%
1334 \@afterindentfalse%
1335 \secdef\@chapter\@schapter%
1336 }
1337 \fi
1338 % \end{macrocode}
1339 %
1340 % \begin{macro}{\@chapter}
1341 %
1342 % There's a lot of messing about to do, depending on whether we're in the
1343 % main matter and so on. We'll take this carefully.
1344 %
1345 % \begin{macrocode}
1346 \def\@chapter[#1]#2{%
1347 % \end{macrocode}
1348 %
1349 % The first thing to do is put a line in the contents table. We need to
1350 % check |secnumdepth| and the |mainmatter| flag for this: we should only
1351 % include a number if both these tests pass. In this case, we also type a
1352 % message on the terminal.
1353 %
1354 % \begin{macrocode}
1355 \ifnum\c@secnumdepth>\m@ne%
1356 \if@mainmatter%
1357 \refstepcounter{chapter}%
1358 \typeout{\@chapapp\space\thechapter.}%
1359 \addcontentsline{toc}{chapter}{\protect\numberline{\thechapter}#1}%
1360 \else
1361 \addcontentsline{toc}{chapter}{#1}%
1362 \fi
1363 \else
1364 \addcontentsline{toc}{chapter}{#1}
1365 \fi
1366 % \end{macrocode}
1367 %
1368 % Now we put a bit of space in the lists of figures and tables, and set up
1369 % the mark to put the chapter heading in the running header.
1370 % \begin{macrocode}
1371 \chaptermark{#1}%
1372 \addtocontents{lof}{\protect\addvspace{10\p@}}%
1373 \addtocontents{lot}{\protect\addvspace{10\p@}}%
1374 % \end{macrocode}
1375 %
1376 % Finally, we need to decide how to typeset the chapter heading. On
1377 % single-column chapters, this is easy. On double-column formats, we need
1378 % to do horrid things with |\@topnewpage|.
1379 %
1380 % \begin{macrocode}
1381 \if@twocolumn%
1382 \@topnewpage[\@makechapterhead{%
1383 \hb@xt@.5\leftindent{\thechapter\hfil}%
1384 }{#2}]%
1385 \else%
1386 \@makechapterhead{%
1387 \hb@xt@.5\leftindent{\thechapter\hfil}%
1388 }{#2}%
1389 \@afterheading%
1390 \fi%
1391 }
1392 % \end{macrocode}
1393 % \end{macro}
1394 %
1395 % \begin{macro}{\@makechapterhead}
1396 %
1397 % This macro actually does the job of typesetting a chapter heading. Call
1398 % this routine as |\@makechapterhead{|\synt{number}|}{|\synt{title}|}|.
1399 % Here, \synt{number} is how to typeset the chapter number, and \synt{title}
1400 % is the rest of the title. To suppress the number, just leave \synt{number}
1401 % empty. The number is only typeset when it is correct to do so anyway.
1402 %
1403 % The spacing is rather awkward. We have to cope with two-column layouts,
1404 % which seem to require different spacing. In a double-column layout,
1405 % the title is normally one |\baselineskip| too high. Also, the space I
1406 % add at the bottom of the heading gets eaten in double-column chapters,
1407 % because I'm actually typesetting into a vbox which is floated to the top
1408 % by \LaTeX\ in a fairly horrid way. This can't really be worked around,
1409 % so we just make the space beneath the heading equal to |\dbltextfloatsep|,
1410 % which is what gets added anyway.
1411 %
1412 % The other snags are to do with the rule after the chapter heading.
1413 % Firstly, this is meant to be typeset into the left margin, like the
1414 % heading itself, which is a bit messy. More awkwardly, we have to be
1415 % careful not to let the depth of the line vary when the chapter heading has
1416 % descenders, although obviously we must lower the rule if the heading really
1417 % is very deep indeed.
1418 %
1419 %
1420 % We'll approach this a bit at a time.
1421 %
1422 % \begin{macrocode}
1423 \def\@makechapterhead#1#2{%
1424 \begingroup% % Stop my hacking messing things up
1425 % \end{macrocode}
1426 %
1427 % First, the top spacing. This is divided into two parts, by an invisible
1428 % rule: the |\vskip| above the rule is eaten by \TeX\ if this is a genuine
1429 % new page, but put into the floating vbox if this is a two-column affair.
1430 % The second bit is added in both cases.
1431 %
1432 % \begin{macrocode}
1433 \vskip\baselineskip% % This is gobbled in single column
1434 \hrule\@height\z@% % Stops TeX from binning my vskips
1435 \vskip32\p@% % Start chapters in a funny place
1436 % \end{macrocode}
1437 %
1438 % Now we actually typeset the heading. This is fairly simple: we must just
1439 % check that we need to typeset the number.
1440 %
1441 % \begin{macrocode}
1442 \normalfont\Huge\bfseries\headfam% % Choose a nice font for it
1443 \raggedright % Don't justify -- it looks nasty
1444 \@hangfrom{\hskip-\leftindent}% % Start text at `real left margin'
1445 \ifnum\c@secnumdepth>\m@ne% % Do we typeset chapter numbers?
1446 \if@mainmatter% % Are we past the front matter?
1447 #1% % Yes -- then typeset the number
1448 \fi\fi% % Now back to normality
1449 {#2}% % Typeset the actual chapter head
1450 \par\nobreak% % Back to vmode again, please
1451 % \end{macrocode}
1452 %
1453 % The next tricky bit is the space before the ruleoff. We must be careful
1454 % here:
1455 %
1456 % \begin{itemize}
1457 %
1458 % \item We want the rule to be the right depth below the heading baseline,
1459 % regardless of whether the heading contains descenders: helpfully, \TeX\
1460 % omits |\baselineskip| glue before and after rules.
1461 %
1462 % \item We want the rule to always be below any oddly deep descenders that
1463 % a strange user might throw at us (e.g., horrid fractions or weird
1464 % |\vrule|s).
1465 %
1466 % \end{itemize}
1467 %
1468 % We accomplish this by scrutinising |\prevdepth| carefully.
1469 %
1470 % \begin{macrocode}
1471 \@tempdima14\p@% % Be this low below the baseline
1472 \advance\@tempdima-\prevdepth% % This is the actual skip then
1473 \ifdim\@tempdima<8\p@% % Is this not enough skippage?
1474 \@tempdima8\p@% % No: then skip some more
1475 \fi%
1476 \vskip\@tempdima% % Skip a bit below the title
1477 % \end{macrocode}
1478 %
1479 % Now we can set the rule. This needs a little care.
1480 %
1481 % \begin{macrocode}
1482 \@tempskipa\textwidth% % Find the width of the column
1483 \advance\@tempskipa\leftindent% % Add on the big lefthand gap
1484 \nointerlineskip% % Don't add any more space please
1485 \moveleft\leftindent\vbox{% % Shift something left by an amount
1486 \hrule\@width\@tempskipa% % Typeset the rule nicely
1487 }%
1488 \nointerlineskip% % Don't leave a gap beneath it
1489 % \end{macrocode}
1490 %
1491 % Finally, we leave a gap. In two-column layouts this is done for us, and
1492 % \LaTeX\ gobbles this glue and replaces it with |\dbltextfloatsep|. To make
1493 % things consistent, this is the glue we use anyway.
1494 %
1495 % \begin{macrocode}
1496 \nobreak% % This would be a bad place to break
1497 \vspace{\dbltextfloatsep}% % Add in some extra glue beneath
1498 \endgroup%
1499 }
1500 % \end{macrocode}
1501 % \end{macro}
1502 %
1503 % \begin{macro}{\@makeschapterhead}
1504 %
1505 % This is now just a veneer onto |\@makechapterhead|. It's needed, because
1506 % other bits of \LaTeX\ call it.
1507 %
1508 % \begin{macrocode}
1509 \def\@makeschapterhead{%
1510 \@makechapterhead{}
1511 }
1512 % \end{macrocode}
1513 % \end{macro}
1514 %
1515 % \begin{macro}{\@schapter}
1516 %
1517 % This macro typesets a starred chapter heading. This is terribly simple,
1518 % compared to the sort of things we've been doing so far.
1519 %
1520 % \begin{macrocode}
1521 \def\@schapter#1{%
1522 \if@twocolumn%
1523 \@topnewpage[\@makeschapterhead{#1}]%
1524 \else%
1525 \@makeschapterhead{#1}%
1526 \@afterheading%
1527 \fi%
1528 }
1529 % \end{macrocode}
1530 % \end{macro}
1531 % \end{macro}
1532 %
1533 % \subsection{The other sectioning commands}
1534 %
1535 % These are all defined through |\@startsection|. They've been modified
1536 % to typeset sections and subsections hanging into the left margin, and to
1537 % moderate the amount of following space, due to the extra |\parskip| already
1538 % introduced.
1539 %
1540 % \begin{macrocode}
1541 \def\@defsection#1#2#3#4#5#6{%
1542 \expandafter\newcommand\csname#1\endcsname{%
1543 \skip@#4\advance\skip@\ifdim\skip@<\z@-\fi\@parshortfall%
1544 \skip\tw@#5\relax\ifdim\skip\tw@>\z@\advance\skip\tw@\@parshortfall\fi%
1545 \@startsection%
1546 {#1}%
1547 {#2}%
1548 {#3}%
1549 \skip@
1550 {\skip\tw@}%
1551 {\reset@font#6\bfseries\headfam}%
1552 }%
1553 }
1554 \@defsection
1555 {section}% % Section name (for contents)
1556 {1}% % Level number (for numbering)
1557 {-.5\sectindent}% % Indentation of title
1558 {-1.5ex\@plus-1ex\@minus-.2ex}% % Space after title (vert/horiz)
1559 {.3ex\@plus.2ex}% % Space before title
1560 {\reset@font\Large\bfseries\headfam}% How to typeset the title
1561 \@defsection
1562 {subsection}%
1563 {2}%
1564 {-.25\sectindent}%
1565 {-1.25ex\@plus-1ex\@minus-.2ex}%
1566 {\p@\@plus.2ex}%
1567 {\reset@font\large\bfseries\headfam}%
1568 \if@runinsubsubsec
1569 \@defsection
1570 {subsubsection}%
1571 {3}%
1572 {\z@}%
1573 {0pt\@plus1ex\@minus.2ex}%
1574 {-1em}%
1575 {\reset@font\normalsize\bfseries\headfam}%
1576 \@defsection
1577 {paragraph}%
1578 {4}%
1579 {\z@}%
1580 {0pt\@plus.5ex\@minus.1ex}%
1581 {-1em}%
1582 {\reset@font\normalsize\bfseries\headfam}%
1583 \@defsection
1584 {subparagraph}%
1585 {5}%
1586 {\parindent}%
1587 {0pt\@plus.5ex\@minus.1ex}%
1588 {-1em}%
1589 {\reset@font\normalsize\bfseries\headfam}%
1590 \else
1591 \@defsection
1592 {subsubsection}%
1593 {3}%
1594 {\z@}%
1595 {-1.25ex\@plus-1ex\@minus-.2ex}%
1596 {\p@\@plus.2ex}%
1597 {\reset@font\normalsize\bfseries\headfam}%
1598 \@defsection
1599 {paragraph}%
1600 {4}%
1601 {\z@}%
1602 {0pt\@plus1ex\@minus.2ex}%
1603 {-1em}%
1604 {\reset@font\normalsize\bfseries\headfam}%
1605 \@defsection
1606 {subparagraph}%
1607 {5}%
1608 {\parindent}%
1609 {0pt\@plus.5ex\@minus.1ex}%
1610 {-1em}%
1611 {\reset@font\normalsize\bfseries\headfam}%
1612 \fi
1613 % \end{macrocode}
1614 %
1615 % \subsection{Section number formatting}
1616 %
1617 % \begin{macro}{\@seccntformat}
1618 %
1619 % The macro is given a section counter and must format it in some nice way.
1620 %
1621 % \begin{macrocode}
1622 \def\@seccntformat#1{%
1623 \llap{\csname the#1\endcsname{\normalsize\quad}\hfil}%
1624 }
1625 %
1626 % \subsection{Top level sectioning}
1627 %
1628 % \begin{macro}{\@topsect}
1629 %
1630 % Articles are divided into sections; other documents are divided into
1631 % chapters. Things like the table of contents need to know which.
1632 %
1633 % \begin{macrocode}
1634 \if@article
1635 \def\@topsect@star{\section*}
1636 \let\@topsect\section
1637 \else
1638 \let\@topsect@star\chapter
1639 \let\@topsect\chapter
1640 \fi
1641 % \end{macrocode}
1642 %
1643 % \end{macro}
1644 %
1645 %
1646 % \section{List handling}
1647 %
1648 % A surprising number of \LaTeX's environments are defined in terms of
1649 % lists, many of which hide the fact by putting the entire text in one big
1650 % item.
1651 %
1652 % This part of the document class has to set up lots of list parameters.
1653 % This is largely the same as the standard classes, altered slightly to cope
1654 % with the different paragraph spacing.
1655 %
1656 % \subsection{General list parameters}
1657 %
1658 % Default left margins for lists:
1659 %
1660 % \begin{macrocode}
1661 \if@twocolumn
1662 \leftmargini2em
1663 \else
1664 \leftmargini2.2em
1665 \fi
1666 \leftmarginii2em
1667 \leftmarginiii1.87em
1668 \leftmarginiv1.7em
1669 \if@twocolumn
1670 \leftmarginv.5em
1671 \leftmarginvi.5em
1672 \else
1673 \leftmarginv1em
1674 \leftmarginvi1em
1675 \fi
1676 % \end{macrocode}
1677 % And now we can set the paragraph indent.
1678 % \begin{macrocode}
1679 \if@indentpar
1680 \parindent1.2em
1681 \else
1682 \parindent\z@
1683 \fi
1684 % \end{macrocode}
1685 %
1686 % Other spacing defaults:
1687 %
1688 % \begin{macrocode}
1689 \leftmargin\leftmargini
1690 \labelsep.5em
1691 \labelwidth\leftmargini
1692 \advance\labelwidth-\labelsep
1693 \partopsep\z@\@plus1\p@\@minus1\p@
1694 % \end{macrocode}
1695 %
1696 % Interline penalties:
1697 %
1698 % \begin{macrocode}
1699 \@beginparpenalty -\@lowpenalty
1700 \@endparpenalty -\@lowpenalty
1701 \@itempenalty -\@lowpenalty
1702 % \end{macrocode}
1703 %
1704 % Now we define the defaults for the list environments. These have managed
1705 % to migrate from the size options into the main document class.
1706 %
1707 % \begin{macrocode}
1708 \def\@listI{%
1709 \ifvmode\else\@beginparpenalty\@M\fi%
1710 \leftmargin\leftmargini%
1711 \parsep\@parskip%
1712 \topsep\@parshortfall%
1713 \itemsep\z@%
1714 }
1715 \let\@listi\@listI
1716 \@listi%
1717 \def\@listii{%
1718 \ifvmode\else\@beginparpenalty\@M\fi%
1719 \topsep\z@\@plus\p@%
1720 \leftmargin\leftmarginii%
1721 \labelwidth\leftmarginii%
1722 \advance\labelwidth-\labelsep%
1723 }
1724 \def\@listiii{%
1725 \ifvmode\else\@beginparpenalty\@M\fi%
1726 \leftmargin\leftmarginiii%
1727 \labelwidth\leftmarginiii%
1728 \advance\labelwidth-\labelsep%
1729 % \partopsep\p@\@plus\z@\@minus\p@%
1730 }
1731 \def\@listiv{%
1732 \ifvmode\else\@beginparpenalty\@M\fi%
1733 \leftmargin\leftmarginiv%
1734 \labelwidth\leftmarginiv%
1735 \advance\labelwidth-\labelsep%
1736 }
1737 \def\@listv{%
1738 \ifvmode\else\@beginparpenalty\@M\fi%
1739 \leftmargin\leftmarginv%
1740 \labelwidth\leftmarginv%
1741 \advance\labelwidth-\labelsep%
1742 }
1743 \def\@listvi{%
1744 \ifvmode\else\@beginparpenalty\@M\fi%
1745 \leftmargin\leftmarginvi%
1746 \labelwidth\leftmarginvi%
1747 \advance\labelwidth-\labelsep%
1748 }
1749 % \end{macrocode}
1750 %
1751 % \subsection{Numbering things}
1752 %
1753 % \begin{macro}{\numberwithin}
1754 %
1755 % Does the obvious thing. Optional argument gives numbering style.
1756 %
1757 % \begin{macrocode}
1758 \def\numberwithin{\@testopt\nw@i\arabic}
1759 \def\nw@i[#1]#2#3{%
1760 \@addtoreset{#2}{#3}%
1761 \expandafter\xdef\csname the#2\endcsname{%
1762 \expandafter\noexpand\csname the#3\endcsname.%
1763 \noexpand#1{#2}}%
1764 }
1765 % \end{macrocode}
1766 %
1767 % \end{macro}
1768 %
1769 % \begin{macro}{\removefromreset}
1770 %
1771 % Does the obvious thing.
1772 %
1773 % \begin{macrocode}
1774 \def\removefromreset#1#2{%
1775 \begingroup%
1776 \def\@tempa{#1}%
1777 \toks@{}%
1778 \def\@elt##1{%
1779 \def\@tempb{##1}%
1780 \ifx\@tempa\@tempb%
1781 \else\toks@\expandafter{\the\toks@\@elt{##1}}%
1782 \fi%
1783 }
1784 \csname cl@#2\endcsname%
1785 \expandafter\xdef\csname cl@#2\endcsname{\the\toks@}%
1786 \endgroup%
1787 }
1788 % \end{macrocode}
1789 %
1790 % \end{macro}
1791 %
1792 % \subsection{Enumerated lists}
1793 %
1794 % We busily redefine all the counters for enumerated lists, and how to
1795 % typeset them.
1796 %
1797 % How to typeset the numbers:
1798 %
1799 % \begin{macrocode}
1800 \renewcommand\theenumi{\arabic{enumi}}
1801 \renewcommand\theenumii{\alph{enumii}}
1802 \renewcommand\theenumiii{\roman{enumiii}}
1803 \renewcommand\theenumiv{\Alph{enumiv}}
1804 % \end{macrocode}
1805 %
1806 % Typesetting the item labels:
1807 %
1808 % \begin{macrocode}
1809 \newcommand\labelenumi{\theenumi.}
1810 \newcommand\labelenumii{(\theenumii)}
1811 \newcommand\labelenumiii{\theenumiii.}
1812 \newcommand\labelenumiv{\theenumiv.}
1813 % \end{macrocode}
1814 %
1815 % And finally how to typeset references to the items:
1816 %
1817 % \begin{macrocode}
1818 \renewcommand\p@enumii{\theenumi}
1819 \renewcommand\p@enumiii{\theenumi(\theenumii)}
1820 \renewcommand\p@enumiv{\p@enumiii\theenumiii}
1821 % \end{macrocode}
1822 %
1823 % \subsection{Itemized lists}
1824 %
1825 % We set up the various bullet shapes for the itemized lists.
1826 %
1827 % \begin{macrocode}
1828 \newcommand\labelitemi{$\m@th\bullet$}
1829 \newcommand\labelitemii{\normalfont\bfseries --}
1830 \newcommand\labelitemiii{$\m@th\ast$}
1831 \newcommand\labelitemiv{$\m@th\cdot$}
1832 % \end{macrocode}
1833 %
1834 % \subsection{Description lists}
1835 %
1836 % This has been redefined a little to make it more sensible. The old version
1837 % had a weird |\hspace\labelsep| in the labelling macro. This has now been
1838 % added into the main list definition. You can now redefine
1839 % |\descriptionlabel| without fear of messing up the spacing.
1840 %
1841 % \begin{environment}{description}
1842 %
1843 % Here we set up the main list parameters. The label width is zeroed to
1844 % ensure that the text is always indented nicely.
1845 %
1846 % \begin{macrocode}
1847 \def\description{%
1848 \list{}{%
1849 \labelwidth\z@%
1850 \itemindent-\leftmargin%
1851 \advance\itemindent\labelsep%
1852 \def\makelabel{\descriptionlabel}%
1853 }%
1854 }
1855 \let\enddescription\endlist
1856 % \end{macrocode}
1857 %
1858 % \begin{macro}{\descriptionlabel}
1859 %
1860 % This typesets a description label. Redefine it the obvious way for
1861 % different exciting effects.
1862 %
1863 % \begin{macrocode}
1864 \def\descriptionlabel#1{\normalfont\bfseries #1}
1865 % \end{macrocode}
1866 %
1867 % \end{macro}
1868 % \end{environment}
1869 %
1870 % \subsection{Other list-based environments}
1871 %
1872 % Several other standard environments are defined in terms of lists. These
1873 % are all dealt with here.
1874 %
1875 % \begin{environment}{verse}
1876 %
1877 % The \env{verse} environment is specially fiddled so that |\\| works as it
1878 % should. There's nothing else exciting about it.
1879 %
1880 % \begin{macrocode}
1881 \newenvironment{verse}{%
1882 \let\\\@centercr%
1883 \list{}{%
1884 \itemsep\z@%
1885 \itemindent-1.5em%
1886 \listparindent\itemindent%
1887 \rightmargin\leftmargin%
1888 \advance\leftmargin1.5em%
1889 }%
1890 \item[]%
1891 }{%
1892 \endlist%
1893 }
1894 % \end{macrocode}
1895 % \end{environment}
1896 %
1897 % \begin{environment}{quotation}
1898 %
1899 % The \env{quotation} environment is a pretty standard display, except that
1900 % we kill off inter-paragraph space. The current definition means that
1901 % \env{quotation}s are typeset in normal indented-paragraph style, which
1902 % is inconsistent with the rest of the document style.
1903 %
1904 % \begin{macrocode}
1905 \newenvironment{quotation}{%
1906 \list{}{%
1907 \listparindent\z@%
1908 \itemindent\listparindent%
1909 \rightmargin\leftmargin%
1910 }%
1911 \item[]%
1912 }{%
1913 \endlist%
1914 }
1915 % \end{macrocode}
1916 % \end{environment}
1917 %
1918 % \begin{environment}{quote}
1919 %
1920 % This is even simpler. We just pull in the right margin a bit.
1921 %
1922 % \begin{macrocode}
1923 \newenvironment{quote}{%
1924 \list{}{%
1925 \rightmargin\leftmargin%
1926 }%
1927 \item[]%
1928 }{%
1929 \endlist%
1930 }
1931 % \end{macrocode}
1932 % \end{environment}
1933 %
1934 % \begin{environment}{display}
1935 %
1936 % The \env{display} environment is intended for any other displays which you
1937 % need to typeset. This is \emph{not} a standard environment.
1938 %
1939 % \begin{macrocode}
1940 \newenvironment{display}{%
1941 \list{}{%
1942 \leftmargin1em%
1943 \rightmargin\leftmargin%
1944 \labelsep\z@%
1945 \labelwidth\z@%
1946 }%
1947 \item[]\relax%
1948 }{%
1949 \endlist%
1950 }
1951 % \end{macrocode}
1952 % \end{environment}
1953 %
1954 % And some quick hacking of the theorem environment.
1955 %
1956 % \section{Other parameters}
1957 %
1958 % We define some miscellaneous parameters for standard environments.
1959 %
1960 % \begin{macrocode}
1961 \arraycolsep5\p@
1962 \tabcolsep6\p@
1963 \arrayrulewidth.4\p@
1964 \doublerulesep2\p@
1965 \tabbingsep\labelsep
1966 \skip\@mpfootins\skip\footins
1967 \fboxsep3\p@
1968 \fboxrule.4\p@
1969 %
1970 \if@article
1971 \renewcommand\theequation{\arabic{equation}}
1972 \else
1973 \@addtoreset{equation}{chapter}
1974 \renewcommand\theequation{\thechapter.\arabic{equation}}
1975 \fi
1976 % \end{macrocode}
1977 %
1978 % \section{Floats}
1979 %
1980 % Since raw \LaTeX\ doesn't actually define any floating objects, we have
1981 % to do some of the work here. This isn't actually terribly arduous. For
1982 % a float called \synt{float}, we have to define the following macros:
1983 %
1984 % \begin{description}
1985 % \let\descriptionlabel\relax
1986 %
1987 % \item[\texttt{\bslash fps@}\synt{float}] is the default float positioning
1988 % argument for the float type.
1989 %
1990 % \item[\texttt{\bslash ftype@}\synt{float}] is a flag bit for the float
1991 % type. This is used in \LaTeX's |\output| routine to identify floats of
1992 % this type.
1993 %
1994 % \item[\texttt{\bslash ext@}\synt{float}] is the file extension for the
1995 % list of these floats (e.g., \lit{lof} for figures).
1996 %
1997 % \item[\texttt{\bslash fnum@}\synt{float}] is a macro which generates the
1998 % caption number. For figures, this expands to `|Figure~\thefigure|'.
1999 %
2000 % \end{description}
2001 %
2002 % We must also define |\@makecaption|, which typesets a float caption in
2003 % an appropriate way, and an environment for each type of float.
2004 %
2005 % \subsection{Figures}
2006 %
2007 % This is all fairly straightforward stuff. First, we create a counter for
2008 % figures:
2009 %
2010 % \begin{macrocode}
2011 \newcounter{figure}[chapter]
2012 \if@article
2013 \renewcommand\thefigure{\@arabic\c@figure}
2014 \else
2015 \renewcommand\thefigure{\thechapter.\@arabic\c@figure}
2016 \fi
2017 % \end{macrocode}
2018 %
2019 % Now we define all the macros \LaTeX\ requires.
2020 %
2021 % \begin{macrocode}
2022 \if@herefloats\def\fps@figure{htbp}\else\def\fps@figure{tbp}\fi
2023 \def\ftype@figure{1}
2024 \def\ext@figure{lof}
2025 \def\fnum@figure{\figurename~\thefigure}
2026 % \end{macrocode}
2027 %
2028 % \begin{environment}{figure}
2029 % \begin{environment}{figure*}
2030 %
2031 % Finally, we create the \env{figure} and \env{figure$*$} environments.
2032 %
2033 % \begin{macrocode}
2034 \newenvironment{figure}{\@float{figure}}{\end@float}
2035 \newenvironment{figure*}{\@dblfloat{figure}}{\end@dblfloat}
2036 % \end{macrocode}
2037 % \end{environment}
2038 % \end{environment}
2039 %
2040 % \subsection{Tables}
2041 %
2042 % This is pretty similar to the figure handling.
2043 %
2044 % \begin{macrocode}
2045 \newcounter{table}[chapter]
2046 \if@article
2047 \renewcommand\thetable{\@arabic\c@table}
2048 \else
2049 \renewcommand\thetable{\thechapter.\@arabic\c@table}
2050 \fi
2051 %
2052 \if@herefloats\def\fps@table{htbp}\else\def\fps@table{tbp}\fi
2053 \def\ftype@table{2}
2054 \def\ext@table{lot}
2055 \def\fnum@table{\tablename~\thetable}
2056 %
2057 \newenvironment{table}{\@float{table}}{\end@float}
2058 \newenvironment{table*}{\@dblfloat{table}}{\end@dblfloat}
2059 % \end{macrocode}
2060 %
2061 % \subsection{Other float parameters}
2062 %
2063 % \begin{macro}{\@makecaption}
2064 %
2065 % The |\@makecaption| macro is called to display a float caption. It will
2066 % typeset its argument either centred in a box, if it is short enough, or
2067 % in a paragraph if it is longer than a line.
2068 %
2069 % \begin{macrocode}
2070 \newlength\abovecaptionskip
2071 \newlength\belowcaptionskip
2072 \abovecaptionskip10\p@
2073 \belowcaptionskip0\p@
2074 %
2075 \long\def\captionstyle#1#2{\itshape #1: #2}
2076 \long\def\@makecaption#1#2{%
2077 \vskip\abovecaptionskip%
2078 \sbox\@tempboxa{\captionstyle{#1}{#2}}%
2079 \ifdim\wd\@tempboxa>\hsize%
2080 \unhbox\@tempboxa\par%
2081 \else%
2082 \hb@xt@\hsize{\hfil\unhbox\@tempboxa\hfil}%
2083 \fi%
2084 \vskip\belowcaptionskip%
2085 }
2086 % \end{macrocode}
2087 % \end{macro}
2088 %
2089 % \section{Font commands}
2090 %
2091 % We allow the `old' font commands to do sensible \textsf{NFSS} things, since
2092 % we don't have any legacy documents. This means that we have proper
2093 % abbreviations for font changes. We also add |\nm| to return to a normal
2094 % font, whatever that may mean.
2095 %
2096 % \begin{macrocode}
2097 \DeclareOldFontCommand{\rm}{\rmfamily}{\mathrm}
2098 \DeclareOldFontCommand{\sf}{\sffamily}{\mathsf}
2099 \DeclareOldFontCommand{\tt}{\ttfamily}{\mathtt}
2100 \DeclareOldFontCommand{\bf}{\bfseries}{\mathbf}
2101 \DeclareOldFontCommand{\md}{\mdseries}{\@nomath\md}
2102 \DeclareOldFontCommand{\it}{\itshape}{\mathit}
2103 \DeclareOldFontCommand{\up}{\upshape}{\@nomath\up}
2104 \DeclareOldFontCommand{\sl}{\slshape}{\@nomath\sl}
2105 \DeclareOldFontCommand{\sc}{\scshape}{\@nomath\sc}
2106 \DeclareOldFontCommand{\nm}{\normalfont}{\mathnormal}
2107 % \end{macrocode}
2108 %
2109 % Now we define some special commands which only work in maths mode. It
2110 % seems that older versions of \LaTeX\ (in particular, that at Warwick
2111 % University) don't define these commands initially, so we'd better not
2112 % use |\renewcommand| after all. We also dispose of lots of messing with
2113 % |\protect| by using |\DeclareRobustCommand|.
2114 %
2115 % \begin{macrocode}
2116 \DeclareRobustCommand\cal{\@fontswitch{\relax}{\mathcal}}
2117 \DeclareRobustCommand\pmit{\@fontswitch{\relax}{\mathnormal}}
2118 % \end{macrocode}
2119 %
2120 % \section{Tables of contents}
2121 %
2122 % This section deals with tables of contents, and lists of figures.
2123 %
2124 % \subsection{Contents}
2125 %
2126 % First, we have to define some parameters.
2127 %
2128 % \begin{macrocode}
2129 \newcommand\@pnumwidth{2em}
2130 \newcommand\@tocrmarg {3em}
2131 \newcommand\@dotsep{4.5}
2132 \setcounter{tocdepth}{\if@runinsubsubsec1\else2\fi}
2133 % \end{macrocode}
2134 %
2135 % \begin{macro}{\tableofcontents}
2136 %
2137 % This is the main command for setting up tables of contents. We ensure
2138 % a single-page layout, put in the chapter heading, read in the contents
2139 % file, and then restore the old layout.
2140 %
2141 % \begin{macrocode}
2142 \def\@tocthing#1#2{%
2143 \@ifnextchar[{\@tocthing@i{#1}{#2}}{\@tocthing@i{#1}{#2}[\relax][\relax]}%
2144 }
2145 \def\@tocthing@i#1#2[#3][#4]{%
2146 \if@twocolumn\@restonecoltrue\onecolumn\else\@restonecolfalse\fi%
2147 \@topsect@star{#1}#3{\parskip\z@\@starttoc{#2}}#4%
2148 \if@restonecol\twocolumn\fi%
2149 }
2150 \newcommand\tableofcontents{\@tocthing\contentsname{toc}}
2151 % \end{macrocode}
2152 % \end{macro}
2153 %
2154 % Each section type \synt{type} is typeset by a command |\l@|\synt{type}:
2155 % for example, the |\l@chapter| command typesets the entry for a chapter
2156 % heading.
2157 %
2158 % \begin{macro}{\l@part}
2159 %
2160 % This command is vaguely interesting. We'll explore in detail.
2161 %
2162 % \begin{macrocode}
2163 \def\l@part#1#2{%
2164 % \end{macrocode}
2165 %
2166 % We don't typeset the entry if |tocdepth| tells us not to. What kind of
2167 % stupid user is going to disable \emph{all} the contents items.
2168 %
2169 % \begin{macrocode}
2170 \ifnum\c@tocdepth>-2\relax%
2171 % \end{macrocode}
2172 %
2173 % Before we start, we try to break above the title. Later, we'll disable
2174 % breaking afterwards. We then leave some vertical space.
2175 %
2176 % \begin{macrocode}
2177 \addpenalty{-\@highpenalty}%
2178 \addvspace{2.25em\@plus\p@}%
2179 % \end{macrocode}
2180 %
2181 % We open a group, to avoid messing other things up. The |\numberline|
2182 % macro, which numbers the entry on the left, typesets its argument in a box
2183 % of width |\@tempdima|, which we must set up. We then set up the values
2184 % of |\rightskip| and |\parfillskip| to avoid printing over the page number.
2185 % We also make |\interlinepenalty| infinite to suppress breaking pages in
2186 % the middle of the title.
2187 %
2188 % \begin{macrocode}
2189 \begingroup%
2190 \@tempdima3em%
2191 \parindent\z@%
2192 \rightskip\@pnumwidth%
2193 \parfillskip-\@pnumwidth%
2194 \interlinepenalty\@M
2195 % \end{macrocode}
2196 %
2197 % Time to typeset the actual title. This is fairly simple, apart from
2198 % a complicated mixture of glue and penalties, which handles a line break
2199 % right at the end of the title.
2200 %
2201 % \begin{macrocode}
2202 {%
2203 \leavevmode%
2204 \large\bfseries {#1}%
2205 \nobreak\hfil\penalty\@highpenalty\hbox{}\nobreak\hfil%
2206 \hb@xt@\@pnumwidth{\hss #2}%
2207 }%
2208 % \end{macrocode}
2209 %
2210 % Now we end the paragraph and suppress page breaking here.
2211 %
2212 % \begin{macrocode}
2213 \par%
2214 \nobreak%
2215 \global\@nobreaktrue%
2216 \everypar{\global\@nobreakfalse\everypar{}}%
2217 \endgroup%
2218 \fi%
2219 }
2220 % \end{macrocode}
2221 % \end{macro}
2222 %
2223 % \begin{macro}{\@artsw}
2224 %
2225 % Define a macro named after the first or second argument depending on
2226 % whether the document is an article.
2227 %
2228 % \begin{macrocode}
2229 \def\@artsw#1#2#3{%
2230 \edef\@tempa{#1\if@article\noexpand#3\else\noexpand#2\fi}%
2231 \@tempa%
2232 }
2233 % \end{macrocode}
2234 %
2235 % \end{macro}
2236 %
2237 % \begin{macro}{\l@chapter}
2238 %
2239 % This is terribly similar to the previous macro.
2240 %
2241 % \begin{macrocode}
2242 \@artsw\def\l@chapter\l@section#1#2{%
2243 \ifnum\c@tocdepth >\m@ne%
2244 \addpenalty{-\@highpenalty}%
2245 \vskip1.0em\@plus\p@%
2246 \setlength\@tempdima{2em}%
2247 \begingroup%
2248 \interlinepenalty\@M
2249 \parindent\z@%
2250 \rightskip\@pnumwidth%
2251 \parfillskip-\@pnumwidth%
2252 \leavevmode%
2253 \bfseries%
2254 \advance\leftskip\@tempdima%
2255 \hskip-\leftskip%
2256 {#1}%
2257 \nobreak\hfil\penalty\@highpenalty\hbox{}\nobreak\hfil%
2258 \hb@xt@\@pnumwidth{\hss #2}%
2259 \par%
2260 \penalty\@highpenalty%
2261 \endgroup%
2262 \fi%
2263 }
2264 % \end{macrocode}
2265 % \end{macro}
2266 %
2267 % The other types are all defined in terms of |\@dottedtocline|, which is
2268 % redefined beloew.
2269 %
2270 % \begin{macrocode}
2271 \@artsw\def\l@section\l@subsection{\@dottedtocline{1}{2em}{2.5em}}
2272 \@artsw\def\l@subsection\l@subsubsection{\@dottedtocline{2}{4.5em}{3.2em}}
2273 \@artsw\def\l@subsubsection\l@paragraph{\@dottedtocline{3}{7.7em}{4.1em}}
2274 \@artsw\def\l@paragraph\l@subparagraph{\@dottedtocline{4}{10.5em}{5em}}
2275 \@artsw\def\l@subparagraph\@tempa{\@dottedtocline{5}{12.5em}{6em}}
2276 % \end{macrocode}
2277 %
2278 % \begin{macro}{\@dottedtocline}
2279 %
2280 % This is actually a part of the \LaTeX\ kernel, although it's not quite
2281 % right the way it is. We've improved the handling of line breaks after the
2282 % title.
2283 %
2284 % \begin{macrocode}
2285 \def\@dottedtocline#1#2#3#4#5{%
2286 % \end{macrocode}
2287 %
2288 % We have to make sure that we're meant to typeset this contents entry.
2289 %
2290 % \begin{macrocode}
2291 \ifnum#1>\c@tocdepth\else%
2292 % \end{macrocode}
2293 %
2294 % Now we add in a little stretchy space.
2295 %
2296 % \begin{macrocode}
2297 \vskip\z@\@plus.2\p@%
2298 % \end{macrocode}
2299 %
2300 % Set up the paragraph layout now. We forbid page breaks in the middle of
2301 % the title.
2302 %
2303 % \begin{macrocode}
2304 {%
2305 \leftskip#2\relax%
2306 \rightskip\@tocrmarg%
2307 \parfillskip-\rightskip%
2308 \parindent#2\relax%
2309 \@afterindenttrue%
2310 \interlinepenalty\@M%
2311 % \end{macrocode}
2312 %
2313 % Now we typeset the actual title.
2314 %
2315 % \begin{macrocode}
2316 \leavevmode%
2317 \@tempdima#3\relax%
2318 \advance\leftskip\@tempdima%
2319 \hbox{}%
2320 \hskip-\leftskip%
2321 {#4}%
2322 % \end{macrocode}
2323 %
2324 % This is the clever bit. After the actual title, we add the following
2325 % items:
2326 %
2327 % \begin{itemize}
2328 %
2329 % \item A |\nobreak| penalty, to stop a break from eating the glue.
2330 %
2331 % \item A glob of |\hfil| glue. If there's a line break after this glue,
2332 % the title is set flush left as a result of this. Otherwise, it is ignored
2333 % because the leaders are |\hfill|.
2334 %
2335 % \item A penalty. This is a reasonable place to break the line if
2336 % necessary.
2337 %
2338 % \item An empty |\hbox|. This stops the following glue from being discarded
2339 % at the beginning of a new line.
2340 %
2341 % \item Another |\nobreak|, which stops a break at the following glue item.
2342 %
2343 % \item The dotted |\leaders|, which have |\hfill| stretchiness. This forces
2344 % the page number to be flush right.
2345 %
2346 % \end{itemize}
2347 %
2348 % The net result of all this is we can now cope with a line break at the
2349 % end of the title, before the page number, which means that the dots are
2350 % put on the next line. The original \LaTeX\ version forced the last word
2351 % of the title onto the next line as well, which can cause underful boxes.
2352 %
2353 % \begin{macrocode}
2354 \nobreak\hfil\penalty\@highpenalty\hbox{}\nobreak%
2355 \leaders\hbox{$\m@th\mkern\@dotsep mu.\mkern\@dotsep mu$}\hfill%
2356 \hb@xt@\@pnumwidth{\hfil\reset@font\rmfamily#5}\par%
2357 }%
2358 \fi%
2359 }
2360 % \end{macrocode}
2361 % \end{macro}
2362 %
2363 % \subsection{Lists of figures and tables}
2364 %
2365 % These macros are terribly similar to the other ones.
2366 %
2367 % \begin{macrocode}
2368 \newcommand\listoffigures{\@tocthing\listfigurename{lof}}
2369 \newcommand\l@figure{\@dottedtocline{0}{0pt}{2em}}
2370 \newcommand\listoftables{\@tocthing\listtablename{lot}}
2371 \let\l@table\l@figure
2372 % \end{macrocode}
2373 %
2374 % \section{Bibliography}
2375 %
2376 % This isn't actually terribly interesting.
2377 %
2378 % \begin{environment}{thebibliography}
2379 %
2380 % \begin{macrocode}
2381 \newdimen\bibindent
2382 \bibindent1.5em
2383 %
2384 \newenvironment{thebibliography}[1]{%
2385 \@topsect\bibname%
2386 \list{\@biblabel{\arabic{enumiv}}}%
2387 {\settowidth\labelwidth{\@biblabel{#1}}%
2388 \leftmargin\labelwidth%
2389 \advance\leftmargin\labelsep%
2390 \if@openbib%
2391 \advance\leftmargin\bibindent%
2392 \itemindent-\bibindent%
2393 \listparindent\itemindent%
2394 \parsep\z@%
2395 \fi%
2396 \usecounter{enumiv}%
2397 \let\p@enumiv\@empty%
2398 \renewcommand\theenumiv{\arabic{enumiv}}}%
2399 \if@openbib%
2400 \renewcommand\newblock{\par}%
2401 \else%
2402 \renewcommand\newblock{\hskip.11em\@plus.33em\@minus.07em}%
2403 \fi%
2404 \sloppy%
2405 \clubpenalty4000%
2406 \widowpenalty4000%
2407 \sfcode`\.\@m%
2408 }{%
2409 \def\@noitemerr{\@latex@warning{Empty `thebibliography' environment}}%
2410 \endlist%
2411 }
2412 %
2413 \newcommand\newblock{}
2414 % \end{macrocode}
2415 % \end{environment}
2416 %
2417 % \section{Index}
2418 %
2419 % Defines the \env{theindex} environment.
2420 %
2421 % \begin{environment}{theindex}
2422 %
2423 % The macros are fairly simple. We change to a two column layout, and
2424 % redefine |\item| appropriately.
2425 %
2426 % \begin{macrocode}
2427 \newenvironment{theindex}{%
2428 \columnseprule\z@%
2429 \columnsep35\p@%
2430 \@topsect\indexname%
2431 \if@twocolumn\else%
2432 \begin{multicols}{2}%
2433 \fi%
2434 \parskip\z@\@plus.3\p@\relax%
2435 \raggedright%
2436 \let\item\@idxitem%
2437 }{%
2438 \if@twocolumn\else%
2439 \end{multicols}%
2440 \fi%
2441 }
2442 % \end{macrocode}
2443 % \end{environment}
2444 %
2445 % Now we define the item and spacing macros.
2446 %
2447 % \begin{macrocode}
2448 \newcommand\@idxitem {\par\hangindent 40\p@}
2449 \newcommand\subitem {\par\hangindent 40\p@ \hspace*{20\p@}}
2450 \newcommand\subsubitem{\par\hangindent 40\p@ \hspace*{30\p@}}
2451 \newcommand\indexspace{\par \vskip 10\p@ \@plus5\p@ \@minus3\p@\relax}
2452 % \end{macrocode}
2453 %
2454 % \begin{macro}{\passim}
2455 %
2456 % The |passim| encapsulator is used to typeset the word `\textit{passim}'
2457 % after a page range.
2458 %
2459 % \begin{macrocode}
2460 \def\passim#1{#1 \textit{passim}} % Passim encapsulator for indices
2461 % \end{macrocode}
2462 % \end{macro}
2463 %
2464 % Other useful commands for indexing:
2465 %
2466 % \begin{description*}
2467 % \def\descriptionlabel#1{\ttfamily \bslash #1}
2468 %
2469 % \item[Term] typesets its argument in italics, and adds it to the index.
2470 %
2471 % \item[term] typesets its first argument in italics, and adds its second
2472 % to the index.
2473 %
2474 % \item[Index] typesets its argument normally, and adds it to the index.
2475 %
2476 % \end{description*}
2477 %
2478 % \begin{macrocode}
2479 \def\Term#1{\emph{#1}\index{#1}}
2480 \def\term#1{\emph{#1}\index}
2481 \def\Index#1{#1\index{#1}}
2482 % \end{macrocode}
2483 %
2484 % \section{Footnotes}
2485 %
2486 % \begin{macro}{\footnoterule}
2487 %
2488 % This macro typesets the rule above footnotes. This is a bit more complex
2489 % than the default: we try and typeset the rule to be at most 1\,in wide,
2490 % although if the column isn't wide enough, we use $4\over10$~of the
2491 % box width instead.
2492 %
2493 % \begin{macrocode}
2494 \def\footnoterule{%
2495 \@tempdima.4\columnwidth%
2496 \ifdim\@tempdima>1in\relax%
2497 \@tempdima1in\relax%
2498 \fi%
2499 \kern-3\p@%
2500 \hrule\@width\@tempdima%
2501 \kern2.6\p@%
2502 }
2503 % \end{macrocode}
2504 % \end{macro}
2505 %
2506 % We number footnotes within chapters:
2507 %
2508 % \begin{macrocode}
2509 \@addtoreset{footnote}{chapter}
2510 % \end{macrocode}
2511 %
2512 % \begin{macro}{\@makefntext}
2513 %
2514 % This is the macro which actually typesets a footnote. This is rather
2515 % complicated. It's based on example code from \file{classes.dtx} which
2516 % doesn't actually work properly.
2517 %
2518 % \begin{macrocode}
2519 \long\def\@makefntext#1{%
2520 % \end{macrocode}
2521 %
2522 % First, we redefine |\par| to set up the correct paragraph shape. This
2523 % is indented from the left margin by a small amount.
2524 %
2525 % \begin{macrocode}
2526 \@setpar{%
2527 \@@par%
2528 \@tempdima\hsize%
2529 \advance\@tempdima-1.6em%
2530 \parshape\@ne1.6em\@tempdima%
2531 }%
2532 % \end{macrocode}
2533 %
2534 % Now we set up some parameters so that \env{list} environments work properly
2535 % within the footnote. We also clear |\parindent| to prevent nasty
2536 % indentation. The |\par| sets up the paragraph shape for the next
2537 % paragraph: we're in vertical mode already, so it does nothing else.
2538 %
2539 % \begin{macrocode}
2540 \advance\linewidth-1.6em%
2541 \advance\@totalleftmargin1.6em%
2542 \par%
2543 \parindent\z@%
2544 % \end{macrocode}
2545 %
2546 % We leave vertical mode to stop the hbox created by |\llap| from being
2547 % stacked vertically. Then we typeset the footnote mark, and put in the
2548 % main text. Finally we leave some space afterwards, to space out the next
2549 % footnote.
2550 %
2551 % \begin{macrocode}
2552 \leavevmode%
2553 \llap{\@makefnmark\enspace}#1\par%
2554 \vskip\parskip%
2555 }
2556 % \end{macrocode}
2557 % \end{macro}
2558 %
2559 % \begin{macro}{\@makecol}
2560 %
2561 % The standard \LaTeX\ output routine messes up footnotes a bit, in my
2562 % opinion:
2563 % \begin{itemize}
2564 %
2565 % \item If a page is cut off short, because the next item won't fit (e.g.,
2566 % a section heading), then footnotes are added right below the end
2567 % of the text, which can look strange.
2568 %
2569 % \item Footnotes are displayed \emph{above} floats at the bottom of a page,
2570 % which also looks strange.
2571 %
2572 % \item The |\@makefntext| routine above needs to add vertical space between
2573 % footnotes, but this leaves a gap at the very bottom. We remove this
2574 % gap with an |\unskip|.
2575 %
2576 % \end{itemize}
2577 %
2578 % \begin{macrocode}
2579 \def\@makecol{%
2580 \setbox\@outputbox \box\@cclv
2581 \xdef\@freelist{\@freelist\@midlist}%
2582 \global \let \@midlist \@empty
2583 \@combinefloats
2584 \ifvoid\footins \else
2585 \setbox\@outputbox \vbox {%
2586 \boxmaxdepth \@maxdepth
2587 \unvbox \@outputbox
2588 \vskip \skip\footins
2589 \vfil
2590 \footnoterule
2591 \unvbox \footins
2592 \unskip
2593 }%
2594 \fi
2595 \ifvbox\@kludgeins
2596 \@makespecialcolbox
2597 \else
2598 \setbox\@outputbox \vbox to\@colht {%
2599 \@texttop
2600 \dimen@ \dp\@outputbox
2601 \unvbox \@outputbox
2602 \vskip -\dimen@
2603 \@textbottom
2604 }%
2605 \fi
2606 \global \maxdepth \@maxdepth
2607 }
2608 % \end{macrocode}
2609 % \end{macro}
2610 %
2611 % \section{Tidying up}
2612 %
2613 % This section gathers together various other useful bits of standard
2614 % document class setting.
2615 %
2616 % \subsection{Item names}
2617 %
2618 % These commands typeset bits of text. They can then be redefined by
2619 % \package{babel} and suchlike.
2620 %
2621 % \begin{macrocode}
2622 \newcommand\contentsname{Contents}
2623 \newcommand\listfigurename{List of figures}
2624 \newcommand\listtablename{List of tables}
2625 \if@article\newcommand\bibname{References}
2626 \else\newcommand\bibname{Bibliography}\fi
2627 \newcommand\indexname{Index}
2628 \newcommand\figurename{Figure}
2629 \newcommand\tablename{Table}
2630 \newcommand\partname{Part}
2631 \newcommand\abstractname{Abstract}
2632 \newcommand\chaptername{Chapter}
2633 \newcommand\appendixname{Appendix}
2634 \newcommand\today{\number\day\space\ifcase\month\or
2635 January\or February\or March\or April\or May\or June\or
2636 July\or August\or September\or October\or November\or December\fi
2637 \space\number\year}
2638 % \end{macrocode}
2639 %
2640 % \subsection{Final fiddling for two columns}
2641 %
2642 % \begin{macrocode}
2643 \columnsep10\p@
2644 \columnseprule\z@
2645 \pagestyle{headings}
2646 \pagenumbering{arabic} % Arabic page numbers
2647 \if@twocolumn
2648 \twocolumn
2649 \sloppy
2650 \flushbottom
2651 \else
2652 \onecolumn
2653 \fi
2654 % \end{macrocode}
2655 %
2656 % \section{The \protect\env{central} environment}
2657 %
2658 % Because of the strange layout of the pages, text which is centred using
2659 % normal \LaTeX\ commands is centred in the text area, not on the page,
2660 % which is undesirable for large headings, like part headings.
2661 %
2662 % \begin{environment}{central}
2663 %
2664 % The \env{central} environment typesets its contents centrally on the page.
2665 % It should only be used from outer vertical mode.
2666 %
2667 % The code just creates a box of the appropriate size and moves it into the
2668 % right place.
2669 %
2670 % \begin{macrocode}
2671 \newenvironment{central}{%
2672 \par%
2673 \vbox\bgroup\moveleft\leftindent\vbox\bgroup%
2674 \textwidth\paperwidth%
2675 \advance\textwidth-2\pagesurround\relax%
2676 \hsize\textwidth%
2677 \hrule\@height\z@\@depth\z@\@width\hsize%
2678 }{%
2679 \egroup%
2680 \egroup%
2681 }
2682 % \end{macrocode}
2683 % \end{environment}
2684 %
2685 % \section{Headers and footers}
2686 %
2687 % The \strayman\ class uses \package{fancyheadings} for its headers
2688 % and footers. This has already been included in the preamble. We now
2689 % need to fix a few problems with \package{fancyheadings} and set up some
2690 % macros.
2691 %
2692 % \begin{macro}{\title}
2693 %
2694 % We extend |\title|, and give it an optional argument. It can now specify
2695 % the document title as used by |\maketitle| and the running title for the
2696 % header separately.
2697 %
2698 % We store the running header in the macro |\@headertitle|, which is
2699 % initially empty.
2700 %
2701 % \begin{macrocode}
2702 \def\@headertitle{}
2703 % \end{macrocode}
2704 %
2705 % Now we define the |\title| macro, using |\@dblarg| to duplicate the
2706 % mandatory argument if the optional one is omitted.
2707 %
2708 % \begin{macrocode}
2709 \def\title{\@dblarg\title@i}
2710 \def\title@i[#1]#2{%
2711 \gdef\@title{#2}%
2712 \gdef\@headertitle{#1}%
2713 }
2714 % \end{macrocode}
2715 % \end{macro}
2716 %
2717 % \begin{macro}{\innerhead}
2718 % \begin{macro}{\innerfoot}
2719 %
2720 % We allow the user to specify an `inner heading' which is displayed on the
2721 % inside of the header on of each page. This can be used for security
2722 % classifications, for example. Any \package{fancyheadings} commands can
2723 % be used to control the header, which is expanded on each page.
2724 %
2725 % \begin{macrocode}
2726 \def\l@innerhead{}
2727 \def\r@innerhead{}
2728 \def\l@innerfoot{}
2729 \def\r@innerfoot{}
2730 \def\innerhead{\@dblarg\innerhead@i}
2731 \def\innerhead@i[#1]#2{%
2732 \def\l@innerhead{#1}%
2733 \def\r@innerhead{#2}%
2734 }
2735 \def\innerfoot{\@dblarg\innerfoot@i}
2736 \def\innerfoot@i[#1]#2{%
2737 \def\l@innerfoot{#1}%
2738 \def\r@innerfoot{#2}%
2739 }
2740 % \end{macrocode}
2741 % \end{macro}
2742 % \end{macro}
2743 %
2744 % The next step is to set up the headings:
2745 %
2746 % \begin{macrocode}
2747 \let\headrulewidth\z@
2748 \headwidth\textwidth
2749 \advance\headwidth\leftindent
2750 \fancyhfoffset[LE,LO]{\leftindent}
2751 \fancypagestyle{headings}{%
2752 \fancyhf{}
2753 \fancyhead[LE]{\bfseries\@headertitle}
2754 \if@article\fancyhead[RO]{\rightmark}\else\fancyhead[RO]{\leftmark}\fi
2755 \fancyhead[RE]{\l@innerhead} \fancyhead[LO]{\r@innerhead}
2756 \fancyfoot[RE]{\l@innerfoot} \fancyfoot[LO]{\r@innerfoot}
2757 \fancyfoot[LE,RO]{\thepage}
2758 }
2759 \fancypagestyle{plain}{%
2760 \fancyhf{}%
2761 \fancyfoot[RE]{\l@innerfoot} \fancyfoot[LO]{\r@innerfoot}
2762 \fancyfoot[LE,RO]{\thepage}%
2763 }
2764 \let\ps@fancy\ps@@fancy
2765 % \end{macrocode}
2766 %
2767 % The \package{fancyheadings} package by default expects pages to be
2768 % symmetrical. We have to redefine the |\ps@fancy| macro to make it
2769 % work properly.
2770 %
2771 % \begin{macrocode}
2772 \def\@lodd{\ifodd\c@page\hss\else\relax\fi}
2773 \def\@rodd{\ifodd\c@page\relax\else\hss\fi}
2774 % \end{macrocode}
2775 %
2776 % Finally, we can choose the page style we want:
2777 %
2778 % \begin{macrocode}
2779 \pagestyle{headings}
2780 % \end{macrocode}
2781 %
2782 % \section{Parbox alteration}
2783 %
2784 % The standard \LaTeX\ |\parbox| command, and the \env{minipage} environment,
2785 % reset |\parskip| to zero, which is inconsistent with the document style.
2786 % We amend |\@arrayparboxrestore|, the macro which sets up the paragraph
2787 % style for parboxes.
2788 %
2789 % First, we define a macro explaining how the parbox should set the spacing.
2790 %
2791 % \begin{macrocode}
2792 \def\parboxparskip{2ex}
2793 % \end{macrocode}
2794 %
2795 % Next, we redefine the macro. This is taken directly from the \LaTeXe
2796 % source.
2797 %
2798 % \begin{macrocode}
2799 \def\@arrayparboxrestore{%
2800 \let\par\@@par
2801 \let\-\@dischyph
2802 \let\'\@acci\let\`\@accii\let\=\@acciii
2803 \parindent\z@ \parskip\z@
2804 \everypar{\parskip\parboxparskip\everypar{}}%
2805 \linewidth\hsize
2806 \@totalleftmargin\z@
2807 \leftskip\z@skip \rightskip\z@skip \@rightskip\z@skip
2808 \parfillskip\@flushglue \lineskip\normallineskip
2809 \baselineskip\normalbaselineskip
2810 \@noskipsectrue% % The comp.text.tex gurus said it should be
2811 \sloppy}
2812 % \end{macrocode}
2813 %
2814 %
2815 % \section{Other features}
2816 %
2817 % At the end is a miscellany of useful features.
2818 %
2819 % \subsection{Other typesetting conventions}
2820 %
2821 % Some items need typesetting in particular ways.
2822 %
2823 % \begin{macrocode}
2824 \let\key\textit
2825 \let\button\textbf
2826 \def\submenu{\ensuremath\Rightarrow}
2827 \let\name\relax
2828 \def\file#1{\mbox{\itshape #1\/}}
2829 % \end{macrocode}
2830 %
2831 % \subsection{And finally}
2832 %
2833 % \begin{macrocode}
2834 \sloppy
2835 \raggedbottom
2836 \def\riscos{RISC~OS}
2837 \hyphenpenalty1000
2838 %</strayman>
2839 % \end{macrocode}
2840 %
2841 % \Finale
2842 %
2843 \endinput