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