.mdw-build.conf: Don't try `vpath' builds with this package.
[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%
2713c178 38% \CheckSum{3090}
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>
29384960 59\documentclass[10pt,a4paper,book,nohyperref]{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
29384960 197\newif\if@hyperref\@hyperreftrue
0ef5b158 198\newif\if@indentpar
1ffa9044 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}
b8d14be9 281\DeclareOption{noarticle}{\@articlefalse}
1ffa9044 282\DeclareOption{numbering}{\@numberingtrue}
283\DeclareOption{nonumbering}{\@numberingfalse}
284\DeclareOption{runinsubsubsec}{\@runinsubsubsectrue}
285\DeclareOption{noruninsubsubsec}{\@runinsubsubsecfalse}
0ef5b158
MW
286\DeclareOption{indentpar}{\@indentpartrue}
287\DeclareOption{noindentpar}{\@indentparfalse}
b8d14be9 288\DeclareOption{book}{\@titlepagetrue\@articlefalse}
29384960
MW
289\DeclareOption{hyperref}{\@hyperreftrue}
290\DeclareOption{nohyperref}{\@hyperreffalse}
1ffa9044 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}
b8d14be9 298\ExecuteOptions{a4paper,10pt,twoside,onecolumn,final}
1ffa9044 299\ProcessOptions
300% \end{macrocode}
301%
302% If this is PDF\TeX\ then tell it the page bounds.
303%
304% \begin{macrocode}
b8d14be9
MW
305\newif\ifpdfing\pdfingfalse
306\if1\ifx\pdfoutput\@@undefined@@0\else\the\pdfoutput\fi
307 \pdfingtrue
308\fi
309\ifpdfing
1ffa9044 310 \pdfpageheight\paperheight
311 \pdfpagewidth\paperwidth
29384960
MW
312\fi
313\if@hyperref
b8d14be9
MW
314 \AtEndOfClass{%
315 \RequirePackage[%
29384960 316 bookmarks = true, bookmarksnumbered = true, bookmarksdepth = 3,
a6bb7088 317 colorlinks = true, linkcolor = blue, citecolor = blue, urlcolor = blue,
29384960 318 breaklinks = true]{hyperref}
b8d14be9 319 }
29384960
MW
320 \ifpdfing
321 \PassOptionsToPackage{pdftex}{hyperref}
322 \else
323 \PassOptionsToPackage{dvips}{hyperref}
324 \fi
b8d14be9 325\fi
1ffa9044 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}
0ef5b158
MW
377\newskip\@parskip
378\newdimen\@parshortfall
1ffa9044 379\def\@setparskip{%
0ef5b158
MW
380 \@parskip.67\baselineskip\@plus\p@\relax%
381 \ifdim\parskip=\z@\else\parskip\@parskip\relax\fi%
382 \@parshortfall\@parskip\advance\@parshortfall-\parskip%
1ffa9044 383}
0ef5b158 384\def\set@vsep#1{#1\@parshortfall\advance#1}
1ffa9044 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>
186f3b71 395 \@setfontsize\normalsize\@viiipt{9.6\p@}%
1ffa9044 396 \abovedisplayskip8\p@\@plus2\p@\@minus4\p@%
0ef5b158
MW
397 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
398 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
1ffa9044 399%</8pt>
400%<*9pt>
401 \@setfontsize\normalsize\@ixpt\@xipt%
402 \abovedisplayskip9\p@\@plus2\p@\@minus5\p@%
0ef5b158
MW
403 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
404 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
1ffa9044 405%</9pt>
406%<*10pt>
407 \@setfontsize\normalsize\@xpt\@xiipt%
408 \abovedisplayskip10\p@\@plus2\p@\@minus5\p@%
0ef5b158
MW
409 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
410 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
1ffa9044 411%</10pt>
412%<*11pt>
413 \@setfontsize\normalsize\@xipt{13.6}%
414 \abovedisplayskip11\p@\@plus3\p@\@minus6\p@%
0ef5b158
MW
415 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
416 \set@vsep\belowdisplayshortskip6.5\p@ \@plus3.5\p@\@minus3\p@%
1ffa9044 417%</11pt>
418%<*12pt>
419 \@setfontsize\normalsize\@xiipt{14.5}%
420 \abovedisplayskip12\p@\@plus3\p@\@minus7\p@%
0ef5b158
MW
421 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
422 \set@vsep\belowdisplayshortskip6.5\p@ \@plus3.5\p@\@minus3\p@%
1ffa9044 423%</12pt>
424%<*text>
425 \@setfontsize\normalsize\@xpt\@xiipt%
426 \abovedisplayskip10\p@\@plus2\p@\@minus5\p@%
0ef5b158
MW
427 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
428 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
1ffa9044 429%</text>
430 \belowdisplayskip\abovedisplayskip%
431 \let\@listi\@listI%
432 \@setparskip%
433}
434\normalsize
0ef5b158
MW
435\if@indentpar
436 \parskip0pt\@plus\p@
437\else
438 \parskip2ex\@plus\p@
439\fi
1ffa9044 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@%
0ef5b158
MW
456 \set@vsep\abovedisplayshortskip\z@\@plus2\p@%
457 \set@vsep\belowdisplayshortskip4\p@\@plus2\p@\@minus2\p@%
1ffa9044 458%</8pt>
459%<*9pt>
460 \@setfontsize\small\@viiipt{9.5}%
461 \abovedisplayskip8\p@\@plus2\p@\@minus4\p@%
0ef5b158
MW
462 \set@vsep\abovedisplayshortskip\z@\@plus2\p@%
463 \set@vsep\belowdisplayshortskip4\p@\@plus2\p@\@minus2\p@%
1ffa9044 464%</9pt>
465%<*10pt>
466 \@setfontsize\small\@ixpt{11}%
467 \abovedisplayskip8.5\p@\@plus3\p@\@minus4\p@%
0ef5b158
MW
468 \set@vsep\abovedisplayshortskip\z@\@plus2\p@%
469 \set@vsep\belowdisplayshortskip4\p@\@plus2\p@\@minus2\p@%
1ffa9044 470%</10pt>
471%<*11pt>
472 \@setfontsize\small\@xpt\@xiipt%
473 \abovedisplayskip10\p@\@plus2\p@\@minus5\p@%
0ef5b158
MW
474 \set@vsep\abovedisplayshortskip\z@\@plus3\p@%
475 \set@vsep\belowdisplayshortskip6\p@\@plus3\p@\@minus3\p@%
1ffa9044 476%</11pt>
477%<*12pt>
478 \@setfontsize\small\@xipt{13.6}%
479 \abovedisplayskip11\p@\@plus3\p@\@minus6\p@%
0ef5b158
MW
480 \set@vsep\abovedisplayshortskip\z@ \@plus3\p@%
481 \set@vsep\belowdisplayshortskip6.5\p@ \@plus3.5\p@\@minus3\p@%
1ffa9044 482%</12pt>
483 \def\@listi{%
484 \leftmargin\leftmargini%
0ef5b158
MW
485 \topsep\@parshortfall%
486 \parsep\@parskip%
1ffa9044 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%
0ef5b158
MW
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@%
1ffa9044 510%</8pt>
511%<*9pt>
512 \@setfontsize\footnotesize\@viipt{8.4}%
0ef5b158
MW
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@%
1ffa9044 516%</9pt>
517%<*10pt>
518 \@setfontsize\footnotesize\@viiipt{9.5}%
0ef5b158
MW
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@%
1ffa9044 522%</10pt>
523%<*11pt>
524 \@setfontsize\footnotesize\@ixpt{11}%
0ef5b158
MW
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@%
1ffa9044 528%</11pt>
529%<*12pt>
530 \@setfontsize\footnotesize\@xpt\@xiipt
0ef5b158
MW
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@%
1ffa9044 534%</12pt>
535 \def\@listi{%
536 \leftmargin\leftmargini%
0ef5b158
MW
537 \topsep\@parshortfall%
538 \parsep\@parskip%
1ffa9044 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}
1ffa9044 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}
1ffa9044 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}
1ffa9044 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}
1ffa9044 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
1ffa9044 597%</12pt>
c3f26ad3 598%<+8pt|9pt|10pt|11pt|12pt>\let\listingsize\footnotesize
1ffa9044 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%
0ef5b158 639% Paragraph indentation is set up later.
1ffa9044 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}
fddb126a 778%
1ffa9044 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
420183b8
MW
856\def\chaptermark##1{\markboth {\thechapter. ##1}{}}%
857\def\sectionmark##1{\markright {\thesection. ##1}}%
1ffa9044 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%
fddb126a 982% The \env{titlepage} environment typesets its contents on a title page.
1ffa9044 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\newif\if@mainmatter
1072\@mainmattertrue
1073\newcommand\frontmatter{%
1074 \cleardoublepage%
1075 \@mainmatterfalse%
1076 \pagenumbering{roman}%
1077}
1078\newcommand\mainmatter{%
1079 \cleardoublepage%
1080 \@mainmattertrue%
1081 \pagenumbering{arabic}%
1082}
1083\newcommand\backmatter{%
1084 \if@openright%
1085 \cleardoublepage%
1086 \else%
1087 \clearpage%
1088 \fi%
1089 \@mainmatterfalse%
1090}
1091% \end{macrocode}
1092%
1093% \subsection{Abstracts}
1094%
1095% \begin{environment}{abstract}
1096%
1097% The \env{abstract} environment reduces the type size and margins slightly.
1098% Abstracts are placed on their own pages when the |titlepage| option is
1099% enabled. The code is filched from the LaTeX article class.
1100%
1101% \begin{macrocode}
1102\if@titlepage
1103 \newenvironment{abstract}{%
1104 \titlepage
1105 \null\vfil
1106 \@beginparpenalty\@lowpenalty
1107 \begin{center}%
1108 \bfseries \abstractname
1109 \@endparpenalty\@M
1110 \end{center}}%
1111 {\par\vfil\null\endtitlepage}
1112\else
1113 \newenvironment{abstract}{%
1114 \if@twocolumn
1115 \section*{\abstractname}%
1116 \else
1117 \small
1118 \list{}{%
1119 \def\makelabel##1{%
1120 \normalfont%
1121 \fontseries{b}\fontfamily\headdefault\selectfont%
1122 ##1%
1123 }%
1124 \labelsep1em\labelwidth\z@\itemindent\labelsep%
1125 \rightmargin\leftmargin%
1126 }
1127 \item[\abstractname]%
1128 \fi}
1129 {\if@twocolumn\else\endlist\fi}
1130\fi
1131% \end{macrocode}
1132% \end{environment}
1133%
1134% \subsection{Appendices}
1135%
1136% \begin{macro}{\appendix}
1137%
1138% This command sets everything up to typeset the appendix.
1139%
1140% \begin{macrocode}
1141\newcommand\appendix{%
1142 \par%
1143 \setcounter{chapter}{0}%
1144 \setcounter{section}{0}%
1145 \renewcommand\@chapapp{\appendixname}%
1146 \if@article%
1147 \renewcommand\thesection{\Alph{section}}%
1148 \else%
1149 \renewcommand\thechapter{\Alph{chapter}}%
1150 \fi%
1151 \@appendixtrue%
1152}
1153% \end{macrocode}
1154% \end{macro}
1155%
1156% \subsection{Parts}
1157%
1158% Part headings are typeset on completely unadorned sheets, devoid of page
1159% numbers and suchlike. Because of the strange page layout, we have to
1160% put the part heading into a |central| environment. to stop the page looking
1161% horribly lopsided.
1162%
1163% \begin{macro}{\part}
1164%
1165% The |\part| macro moves to an appropriate page, changes the pagestyle to
1166% empty to switch off page numbering, and then calls |\@part| or |\@spart|
1167% as appropriate, according to whether a \lit* was supplied. We put some
1168% |\vfil| glue in, to vertically centre anything that these commands typeset,
1169% and ensure printing in a single column.
1170%
1171% \begin{macrocode}
1172\newcommand\part{%
1173 \cleardoublepage%
1174 \thispagestyle{empty}%
1175 \if@twocolumn%
1176 \onecolumn%
1177 \@tempswatrue%
1178 \else%
1179 \@tempswafalse%
1180 \fi%
1181 \hbox{}\vfil%
1ffa9044 1182 \secdef\@part\@spart%
1183}
1184% \end{macrocode}
1185%
1186% \begin{macro}{\@part}
1187%
1188% This is where most of the part heading typesetting is done. We stick a
1189% line in the contents file, clear the heading markers, and typeset the
1190% heading in the biggest letters we can find. When we're done, we call
1191% |\@endpart| to do some common cleaning up.
1192%
1193% \begin{macrocode}
1194\def\@part[#1]#2{%
1195 \ifnum\c@secnumdepth>-2\relax%
1196 \refstepcounter{part}%
1197 \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}%
1198 \else%
1199 \addcontentsline{toc}{part}{#1}%
1200 \fi%
1201 \markboth{}{}%
9c3e8626 1202 \begin{centrepage}%
1ffa9044 1203 \centering%
1204 \interlinepenalty\@M%
1205 \reset@font%
1206 \ifnum\c@secnumdepth>-2\relax%
1207 \huge\bfseries\headfam\partname~\thepart%
1208 \par%
1209 \vskip20\p@
1210 \fi%
1211 \normalfont\Huge\bfseries\headfam#2\par%
1212 \@endpart%
1213}
1214% \end{macrocode}
1215% \end{macro}
1216%
1217% \begin{macro}{\@spart}
1218%
1219% Here we typeset just the part heading: numbers have been suppressed. Also
1220% we don't put things into the contents file. Otherwise, this is similar to
1221% |\@part|.
1222%
1223% \begin{macrocode}
1224\def\@spart#1{%
9c3e8626 1225 \begin{centrepage}%
1ffa9044 1226 \centering%
1227 \interlinepenalty\@M%
1228 \reset@font%
1229 \normalfont\Huge\bfseries\headfam#1\par%
1230 \@endpart%
1231}
1232% \end{macrocode}
1233% \end{macro}
1234%
1235% \begin{macro}{\@endpart}
1236%
1237% This does the clearing up operation after a part has been typeset. We
1238% insert the other |\vfil| glue to centre the heading, clear the other
1239% side of the page, if printing two-sided, and return if necessary to
1240% two-column printing.
1241%
1242% \begin{macrocode}
1243\def\@endpart{%
1244 \vfil\newpage%
1245 \end{centrepage}%
1246 \if@twoside%
1247 \hbox{}%
1248 \thispagestyle{empty}%
1249 \newpage%
1250 \fi%
1251 \if@tempswa%
1252 \twocolumn%
1253 \fi%
1254}
1255% \end{macrocode}
1256% \end{macro}
1257% \end{macro}
1258%
1259% \subsection{Chapters}
1260%
1261% The chapter typesetting has been more-or-less rewritten. We'll follow this
1262% in a reasonable amount of detail.
1263%
1264% \begin{macro}{\@chapapp}
1265%
1266% Because |\appendix| needs to change what chapters are called, we add a
1267% level of indirection through |\@chapapp|:
1268%
1269% \begin{macrocode}
1270\newcommand\@chapapp{\chaptername}
1271% \end{macrocode}
1272% \end{macro}
1273%
1274% \begin{macro}{\chapter}
1275%
1276% The |\chapter| command is the main dispatcher for chapters. We move to
1277% an appropriate page, depending on the |openright| setting, suppress
1278% headers, and then call |\@chapter| or |\@schapter| as appropriate.
1279%
1280% \begin{macrocode}
1281\newcommand\chapter{%
1282 \if@openright%
1283 \cleardoublepage%
1284 \else%
1285 \clearpage%
1286 \fi%
1287 \thispagestyle{plain}%
1288 \global\@topnum\z@%
1289 \@afterindentfalse%
1290 \secdef\@chapter\@schapter%
1291}
1292% \end{macrocode}
1293%
1294% \begin{macro}{\@chapter}
1295%
1296% There's a lot of messing about to do, depending on whether we're in the
1297% main matter and so on. We'll take this carefully.
1298%
1299% \begin{macrocode}
1300\def\@chapter[#1]#2{%
1301% \end{macrocode}
1302%
1303% The first thing to do is put a line in the contents table. We need to
1304% check |secnumdepth| and the |mainmatter| flag for this: we should only
1305% include a number if both these tests pass. In this case, we also type a
1306% message on the terminal.
1307%
1308% \begin{macrocode}
1309 \ifnum\c@secnumdepth>\m@ne%
1310 \if@mainmatter%
1311 \refstepcounter{chapter}%
1312 \typeout{\@chapapp\space\thechapter.}%
1313 \addcontentsline{toc}{chapter}{\protect\numberline{\thechapter}#1}%
1314 \else
1315 \addcontentsline{toc}{chapter}{#1}%
1316 \fi
1317 \else
1318 \addcontentsline{toc}{chapter}{#1}
1319 \fi
1320% \end{macrocode}
1321%
1322% Now we put a bit of space in the lists of figures and tables, and set up
1323% the mark to put the chapter heading in the running header.
1324% \begin{macrocode}
1325 \chaptermark{#1}%
1326 \addtocontents{lof}{\protect\addvspace{10\p@}}%
1327 \addtocontents{lot}{\protect\addvspace{10\p@}}%
1328% \end{macrocode}
1329%
1330% Finally, we need to decide how to typeset the chapter heading. On
1331% single-column chapters, this is easy. On double-column formats, we need
1332% to do horrid things with |\@topnewpage|.
1333%
1334% \begin{macrocode}
1335 \if@twocolumn%
1336 \@topnewpage[\@makechapterhead{%
1337 \hb@xt@.5\leftindent{\thechapter\hfil}%
1338 }{#2}]%
1339 \else%
1340 \@makechapterhead{%
1341 \hb@xt@.5\leftindent{\thechapter\hfil}%
1342 }{#2}%
1343 \@afterheading%
1344 \fi%
1345}
1346% \end{macrocode}
1347% \end{macro}
1348%
1349% \begin{macro}{\@makechapterhead}
1350%
1351% This macro actually does the job of typesetting a chapter heading. Call
1352% this routine as |\@makechapterhead{|\synt{number}|}{|\synt{title}|}|.
1353% Here, \synt{number} is how to typeset the chapter number, and \synt{title}
1354% is the rest of the title. To suppress the number, just leave \synt{number}
1355% empty. The number is only typeset when it is correct to do so anyway.
1356%
1357% The spacing is rather awkward. We have to cope with two-column layouts,
1358% which seem to require different spacing. In a double-column layout,
1359% the title is normally one |\baselineskip| too high. Also, the space I
1360% add at the bottom of the heading gets eaten in double-column chapters,
1361% because I'm actually typesetting into a vbox which is floated to the top
1362% by \LaTeX\ in a fairly horrid way. This can't really be worked around,
1363% so we just make the space beneath the heading equal to |\dbltextfloatsep|,
1364% which is what gets added anyway.
1365%
1366% The other snags are to do with the rule after the chapter heading.
1367% Firstly, this is meant to be typeset into the left margin, like the
1368% heading itself, which is a bit messy. More awkwardly, we have to be
1369% careful not to let the depth of the line vary when the chapter heading has
1370% descenders, although obviously we must lower the rule if the heading really
1371% is very deep indeed.
1372%
fddb126a 1373%
1ffa9044 1374% We'll approach this a bit at a time.
1375%
1376% \begin{macrocode}
1377\def\@makechapterhead#1#2{%
1378 \begingroup% % Stop my hacking messing things up
1379% \end{macrocode}
1380%
1381% First, the top spacing. This is divided into two parts, by an invisible
1382% rule: the |\vskip| above the rule is eaten by \TeX\ if this is a genuine
1383% new page, but put into the floating vbox if this is a two-column affair.
1384% The second bit is added in both cases.
1385%
1386% \begin{macrocode}
1387 \vskip\baselineskip% % This is gobbled in single column
1388 \hrule\@height\z@% % Stops TeX from binning my vskips
1389 \vskip32\p@% % Start chapters in a funny place
1390% \end{macrocode}
1391%
1392% Now we actually typeset the heading. This is fairly simple: we must just
1393% check that we need to typeset the number.
1394%
1395% \begin{macrocode}
1396 \normalfont\Huge\bfseries\headfam% % Choose a nice font for it
1397 \raggedright % Don't justify -- it looks nasty
1398 \@hangfrom{\hskip-\leftindent}% % Start text at `real left margin'
1399 \ifnum\c@secnumdepth>\m@ne% % Do we typeset chapter numbers?
1400 \if@mainmatter% % Are we past the front matter?
1401 #1% % Yes -- then typeset the number
1402 \fi\fi% % Now back to normality
1403 {#2}% % Typeset the actual chapter head
1404 \par\nobreak% % Back to vmode again, please
1405% \end{macrocode}
1406%
1407% The next tricky bit is the space before the ruleoff. We must be careful
1408% here:
1409%
1410% \begin{itemize}
1411%
1412% \item We want the rule to be the right depth below the heading baseline,
1413% regardless of whether the heading contains descenders: helpfully, \TeX\
1414% omits |\baselineskip| glue before and after rules.
1415%
1416% \item We want the rule to always be below any oddly deep descenders that
1417% a strange user might throw at us (e.g., horrid fractions or weird
1418% |\vrule|s).
1419%
1420% \end{itemize}
1421%
1422% We accomplish this by scrutinising |\prevdepth| carefully.
1423%
1424% \begin{macrocode}
1425 \@tempdima14\p@% % Be this low below the baseline
1426 \advance\@tempdima-\prevdepth% % This is the actual skip then
1427 \ifdim\@tempdima<8\p@% % Is this not enough skippage?
1428 \@tempdima8\p@% % No: then skip some more
1429 \fi%
1430 \vskip\@tempdima% % Skip a bit below the title
1431% \end{macrocode}
1432%
1433% Now we can set the rule. This needs a little care.
1434%
1435% \begin{macrocode}
1436 \@tempskipa\textwidth% % Find the width of the column
1437 \advance\@tempskipa\leftindent% % Add on the big lefthand gap
1438 \nointerlineskip% % Don't add any more space please
1439 \moveleft\leftindent\vbox{% % Shift something left by an amount
1440 \hrule\@width\@tempskipa% % Typeset the rule nicely
1441 }%
1442 \nointerlineskip% % Don't leave a gap beneath it
1443% \end{macrocode}
1444%
1445% Finally, we leave a gap. In two-column layouts this is done for us, and
1446% \LaTeX\ gobbles this glue and replaces it with |\dbltextfloatsep|. To make
1447% things consistent, this is the glue we use anyway.
1448%
1449% \begin{macrocode}
1450 \nobreak% % This would be a bad place to break
1451 \vspace{\dbltextfloatsep}% % Add in some extra glue beneath
1452 \endgroup%
1453}
1454% \end{macrocode}
1455% \end{macro}
1456%
1457% \begin{macro}{\@makeschapterhead}
1458%
1459% This is now just a veneer onto |\@makechapterhead|. It's needed, because
1460% other bits of \LaTeX\ call it.
1461%
1462% \begin{macrocode}
1463\def\@makeschapterhead{%
1464 \@makechapterhead{}
1465}
1466% \end{macrocode}
1467% \end{macro}
1468%
1469% \begin{macro}{\@schapter}
1470%
1471% This macro typesets a starred chapter heading. This is terribly simple,
1472% compared to the sort of things we've been doing so far.
1473%
1474% \begin{macrocode}
1475\def\@schapter#1{%
1476 \if@twocolumn%
1477 \@topnewpage[\@makeschapterhead{#1}]%
1478 \else%
1479 \@makeschapterhead{#1}%
1480 \@afterheading%
1481 \fi%
1482}
1483% \end{macrocode}
1484% \end{macro}
1485% \end{macro}
1486%
1487% \subsection{The other sectioning commands}
1488%
1489% These are all defined through |\@startsection|. They've been modified
1490% to typeset sections and subsections hanging into the left margin, and to
1491% moderate the amount of following space, due to the extra |\parskip| already
1492% introduced.
1493%
1494% \begin{macrocode}
0ef5b158
MW
1495\def\@defsection#1#2#3#4#5#6{%
1496 \expandafter\newcommand\csname#1\endcsname{%
1497 \skip@#4\advance\skip@\ifdim\skip@<\z@-\fi\@parshortfall%
1498 \skip\tw@#5\relax\ifdim\skip\tw@>\z@\advance\skip\tw@\@parshortfall\fi%
1499 \@startsection%
1500 {#1}%
1501 {#2}%
1502 {#3}%
1503 \skip@
1504 {\skip\tw@}%
1505 {\reset@font#6\bfseries\headfam}%
1506 }%
1507}
1508\@defsection
1ffa9044 1509 {section}% % Section name (for contents)
1510 {1}% % Level number (for numbering)
1511 {-.5\sectindent}% % Indentation of title
1512 {-1.5ex\@plus-1ex\@minus-.2ex}% % Space after title (vert/horiz)
1513 {.3ex\@plus.2ex}% % Space before title
1514 {\reset@font\Large\bfseries\headfam}% How to typeset the title
0ef5b158 1515\@defsection
1ffa9044 1516 {subsection}%
1517 {2}%
1518 {-.25\sectindent}%
1519 {-1.25ex\@plus-1ex\@minus-.2ex}%
1520 {\p@\@plus.2ex}%
1521 {\reset@font\large\bfseries\headfam}%
1ffa9044 1522\if@runinsubsubsec
0ef5b158 1523\@defsection
1ffa9044 1524 {subsubsection}%
1525 {3}%
1526 {\z@}%
1527 {0pt\@plus1ex\@minus.2ex}%
1528 {-1em}%
1529 {\reset@font\normalsize\bfseries\headfam}%
0ef5b158 1530\@defsection
1ffa9044 1531 {paragraph}%
1532 {4}%
1533 {\z@}%
1534 {0pt\@plus.5ex\@minus.1ex}%
1535 {-1em}%
1536 {\reset@font\normalsize\bfseries\headfam}%
0ef5b158 1537\@defsection
1ffa9044 1538 {subparagraph}%
1539 {5}%
1540 {\parindent}%
1541 {0pt\@plus.5ex\@minus.1ex}%
1542 {-1em}%
1543 {\reset@font\normalsize\bfseries\headfam}%
1ffa9044 1544\else
0ef5b158 1545\@defsection
1ffa9044 1546 {subsubsection}%
1547 {3}%
1548 {\z@}%
1549 {-1.25ex\@plus-1ex\@minus-.2ex}%
1550 {\p@\@plus.2ex}%
1551 {\reset@font\normalsize\bfseries\headfam}%
0ef5b158 1552\@defsection
1ffa9044 1553 {paragraph}%
1554 {4}%
1555 {\z@}%
1556 {0pt\@plus1ex\@minus.2ex}%
1557 {-1em}%
1558 {\reset@font\normalsize\bfseries\headfam}%
0ef5b158 1559\@defsection
1ffa9044 1560 {subparagraph}%
1561 {5}%
1562 {\parindent}%
1563 {0pt\@plus.5ex\@minus.1ex}%
1564 {-1em}%
1565 {\reset@font\normalsize\bfseries\headfam}%
1ffa9044 1566\fi
1567% \end{macrocode}
1568%
1569% \subsection{Section number formatting}
1570%
1571% \begin{macro}{\@seccntformat}
1572%
1573% The macro is given a section counter and must format it in some nice way.
1574%
1575% \begin{macrocode}
1576\def\@seccntformat#1{%
1577 \llap{\csname the#1\endcsname{\normalsize\quad}\hfil}%
1578}
1579%
1580% \subsection{Top level sectioning}
1581%
1582% \begin{macro}{\@topsect}
1583%
1584% Articles are divided into sections; other documents are divided into
1585% chapters. Things like the table of contents need to know which.
1586%
1587% \begin{macrocode}
1588\if@article
c3f26ad3 1589 \def\@topsect@star{\section*}
1590 \let\@topsect\section
1ffa9044 1591\else
c3f26ad3 1592 \let\@topsect@star\chapter
1ffa9044 1593 \let\@topsect\chapter
1594\fi
1595% \end{macrocode}
1596%
1597% \end{macro}
1598%
1599%
1600% \section{List handling}
1601%
1602% A surprising number of \LaTeX's environments are defined in terms of
1603% lists, many of which hide the fact by putting the entire text in one big
1604% item.
1605%
1606% This part of the document class has to set up lots of list parameters.
1607% This is largely the same as the standard classes, altered slightly to cope
1608% with the different paragraph spacing.
1609%
1610% \subsection{General list parameters}
1611%
1612% Default left margins for lists:
1613%
1614% \begin{macrocode}
1615\if@twocolumn
1616 \leftmargini2em
1617\else
1618 \leftmargini2.2em
1619\fi
1620\leftmarginii2em
1621\leftmarginiii1.87em
1622\leftmarginiv1.7em
1623\if@twocolumn
1624 \leftmarginv.5em
1625 \leftmarginvi.5em
1626\else
1627 \leftmarginv1em
1628 \leftmarginvi1em
1629\fi
1630% \end{macrocode}
0ef5b158
MW
1631% And now we can set the paragraph indent.
1632% \begin{macrocode}
1633\if@indentpar
98945a11 1634 \parindent1.2em
0ef5b158
MW
1635\else
1636 \parindent\z@
1637\fi
1638% \end{macrocode}
1ffa9044 1639%
1640% Other spacing defaults:
1641%
1642% \begin{macrocode}
1643\leftmargin\leftmargini
1644\labelsep.5em
1645\labelwidth\leftmargini
1646\advance\labelwidth-\labelsep
1647\partopsep\z@\@plus1\p@\@minus1\p@
1648% \end{macrocode}
1649%
1650% Interline penalties:
1651%
1652% \begin{macrocode}
1653\@beginparpenalty -\@lowpenalty
1654\@endparpenalty -\@lowpenalty
1655\@itempenalty -\@lowpenalty
1656% \end{macrocode}
1657%
1658% Now we define the defaults for the list environments. These have managed
1659% to migrate from the size options into the main document class.
1660%
1661% \begin{macrocode}
1662\def\@listI{%
35f7eeda 1663 \ifvmode\else\@beginparpenalty\@M\fi%
1ffa9044 1664 \leftmargin\leftmargini%
0ef5b158 1665 \parsep\@parskip%
4ef1fb33 1666 \topsep\@parshortfall%
1ffa9044 1667 \itemsep\z@%
1668}
1669\let\@listi\@listI
b8d14be9 1670\@listi%
1ffa9044 1671\def\@listii{%
35f7eeda 1672 \ifvmode\else\@beginparpenalty\@M\fi%
2a8b8e43 1673 \topsep\z@\@plus\p@%
1ffa9044 1674 \leftmargin\leftmarginii%
1675 \labelwidth\leftmarginii%
1676 \advance\labelwidth-\labelsep%
1677}
1678\def\@listiii{%
35f7eeda 1679 \ifvmode\else\@beginparpenalty\@M\fi%
1ffa9044 1680 \leftmargin\leftmarginiii%
1681 \labelwidth\leftmarginiii%
1682 \advance\labelwidth-\labelsep%
c3f26ad3 1683% \partopsep\p@\@plus\z@\@minus\p@%
1ffa9044 1684}
1685\def\@listiv{%
35f7eeda 1686 \ifvmode\else\@beginparpenalty\@M\fi%
1ffa9044 1687 \leftmargin\leftmarginiv%
1688 \labelwidth\leftmarginiv%
1689 \advance\labelwidth-\labelsep%
1690}
1691\def\@listv{%
35f7eeda 1692 \ifvmode\else\@beginparpenalty\@M\fi%
1ffa9044 1693 \leftmargin\leftmarginv%
1694 \labelwidth\leftmarginv%
1695 \advance\labelwidth-\labelsep%
1696}
1697\def\@listvi{%
35f7eeda 1698 \ifvmode\else\@beginparpenalty\@M\fi%
1ffa9044 1699 \leftmargin\leftmarginvi%
1700 \labelwidth\leftmarginvi%
1701 \advance\labelwidth-\labelsep%
1702}
1703% \end{macrocode}
1704%
186f3b71 1705% \subsection{Numbering things}
1706%
1707% \begin{macro}{\numberwithin}
1708%
1709% Does the obvious thing. Optional argument gives numbering style.
1710%
1711% \begin{macrocode}
1712\def\numberwithin{\@testopt\nw@i\arabic}
1713\def\nw@i[#1]#2#3{%
1714 \@addtoreset{#2}{#3}%
1715 \expandafter\xdef\csname the#2\endcsname{%
1716 \expandafter\noexpand\csname the#3\endcsname.%
1717 \noexpand#1{#2}}%
1718}
1719% \end{macrocode}
1720%
1721% \end{macro}
1722%
1723% \begin{macro}{\removefromreset}
1724%
1725% Does the obvious thing.
1726%
1727% \begin{macrocode}
1728\def\removefromreset#1#2{%
1729 \begingroup%
1730 \def\@tempa{#1}%
1731 \toks@{}%
1732 \def\@elt##1{%
1733 \def\@tempb{##1}%
1734 \ifx\@tempa\@tempb%
1735 \else\toks@\expandafter{\the\toks@\@elt{##1}}%
1736 \fi%
1737 }
1738 \csname cl@#2\endcsname%
1739 \expandafter\xdef\csname cl@#2\endcsname{\the\toks@}%
1740 \endgroup%
1741}
1742% \end{macrocode}
1743%
1744% \end{macro}
1745%
1ffa9044 1746% \subsection{Enumerated lists}
1747%
1748% We busily redefine all the counters for enumerated lists, and how to
1749% typeset them.
1750%
1751% How to typeset the numbers:
1752%
1753% \begin{macrocode}
1754\renewcommand\theenumi{\arabic{enumi}}
1755\renewcommand\theenumii{\alph{enumii}}
1756\renewcommand\theenumiii{\roman{enumiii}}
1757\renewcommand\theenumiv{\Alph{enumiv}}
1758% \end{macrocode}
1759%
1760% Typesetting the item labels:
1761%
1762% \begin{macrocode}
1763\newcommand\labelenumi{\theenumi.}
1764\newcommand\labelenumii{(\theenumii)}
1765\newcommand\labelenumiii{\theenumiii.}
1766\newcommand\labelenumiv{\theenumiv.}
1767% \end{macrocode}
1768%
1769% And finally how to typeset references to the items:
1770%
1771% \begin{macrocode}
1772\renewcommand\p@enumii{\theenumi}
1773\renewcommand\p@enumiii{\theenumi(\theenumii)}
1774\renewcommand\p@enumiv{\p@enumiii\theenumiii}
1775% \end{macrocode}
1776%
1777% \subsection{Itemized lists}
1778%
1779% We set up the various bullet shapes for the itemized lists.
1780%
1781% \begin{macrocode}
1782\newcommand\labelitemi{$\m@th\bullet$}
1783\newcommand\labelitemii{\normalfont\bfseries --}
1784\newcommand\labelitemiii{$\m@th\ast$}
1785\newcommand\labelitemiv{$\m@th\cdot$}
1786% \end{macrocode}
1787%
1788% \subsection{Description lists}
1789%
1790% This has been redefined a little to make it more sensible. The old version
1791% had a weird |\hspace\labelsep| in the labelling macro. This has now been
1792% added into the main list definition. You can now redefine
1793% |\descriptionlabel| without fear of messing up the spacing.
1794%
1795% \begin{environment}{description}
1796%
1797% Here we set up the main list parameters. The label width is zeroed to
1798% ensure that the text is always indented nicely.
1799%
1800% \begin{macrocode}
1801\def\description{%
1802 \list{}{%
1803 \labelwidth\z@%
1804 \itemindent-\leftmargin%
1805 \advance\itemindent\labelsep%
1806 \def\makelabel{\descriptionlabel}%
1807 }%
1808}
1809\let\enddescription\endlist
1810% \end{macrocode}
1811%
1812% \begin{macro}{\descriptionlabel}
1813%
1814% This typesets a description label. Redefine it the obvious way for
1815% different exciting effects.
1816%
1817% \begin{macrocode}
1818\def\descriptionlabel#1{\normalfont\bfseries #1}
1819% \end{macrocode}
1820%
1821% \end{macro}
1822% \end{environment}
1823%
1824% \subsection{Other list-based environments}
1825%
1826% Several other standard environments are defined in terms of lists. These
1827% are all dealt with here.
1828%
1829% \begin{environment}{verse}
1830%
1831% The \env{verse} environment is specially fiddled so that |\\| works as it
1832% should. There's nothing else exciting about it.
1833%
1834% \begin{macrocode}
1835\newenvironment{verse}{%
1836 \let\\\@centercr%
1837 \list{}{%
1838 \itemsep\z@%
1839 \itemindent-1.5em%
1840 \listparindent\itemindent%
1841 \rightmargin\leftmargin%
1842 \advance\leftmargin1.5em%
1843 }%
1844 \item[]%
1845}{%
1846 \endlist%
1847}
1848% \end{macrocode}
1849% \end{environment}
1850%
1851% \begin{environment}{quotation}
1852%
1853% The \env{quotation} environment is a pretty standard display, except that
1854% we kill off inter-paragraph space. The current definition means that
1855% \env{quotation}s are typeset in normal indented-paragraph style, which
1856% is inconsistent with the rest of the document style.
1857%
1858% \begin{macrocode}
1859\newenvironment{quotation}{%
1860 \list{}{%
1861 \listparindent\z@%
1862 \itemindent\listparindent%
1863 \rightmargin\leftmargin%
1864 }%
1865 \item[]%
1866}{%
1867 \endlist%
1868}
1869% \end{macrocode}
1870% \end{environment}
1871%
1872% \begin{environment}{quote}
1873%
1874% This is even simpler. We just pull in the right margin a bit.
1875%
1876% \begin{macrocode}
1877\newenvironment{quote}{%
1878 \list{}{%
1879 \rightmargin\leftmargin%
1880 }%
1881 \item[]%
1882}{%
1883 \endlist%
1884}
1885% \end{macrocode}
1886% \end{environment}
1887%
1888% \begin{environment}{display}
1889%
1890% The \env{display} environment is intended for any other displays which you
1891% need to typeset. This is \emph{not} a standard environment.
1892%
1893% \begin{macrocode}
1894\newenvironment{display}{%
1895 \list{}{%
1896 \leftmargin1em%
1897 \rightmargin\leftmargin%
1898 \labelsep\z@%
1899 \labelwidth\z@%
1900 }%
1901 \item[]\relax%
1902}{%
1903 \endlist%
1904}
1905% \end{macrocode}
1906% \end{environment}
1907%
1908% And some quick hacking of the theorem environment.
1909%
1910% \section{Other parameters}
1911%
1912% We define some miscellaneous parameters for standard environments.
1913%
1914% \begin{macrocode}
1915\arraycolsep5\p@
1916\tabcolsep6\p@
1917\arrayrulewidth.4\p@
1918\doublerulesep2\p@
1919\tabbingsep\labelsep
1920\skip\@mpfootins\skip\footins
1921\fboxsep3\p@
1922\fboxrule.4\p@
1923%
1924\if@article
1925 \renewcommand\theequation{\arabic{equation}}
1926\else
1927 \@addtoreset{equation}{chapter}
1928 \renewcommand\theequation{\thechapter.\arabic{equation}}
1929\fi
1930% \end{macrocode}
1931%
1932% \section{Floats}
1933%
1934% Since raw \LaTeX\ doesn't actually define any floating objects, we have
1935% to do some of the work here. This isn't actually terribly arduous. For
1936% a float called \synt{float}, we have to define the following macros:
1937%
1938% \begin{description}
1939% \let\descriptionlabel\relax
1940%
1941% \item[\texttt{\bslash fps@}\synt{float}] is the default float positioning
1942% argument for the float type.
1943%
1944% \item[\texttt{\bslash ftype@}\synt{float}] is a flag bit for the float
1945% type. This is used in \LaTeX's |\output| routine to identify floats of
1946% this type.
1947%
1948% \item[\texttt{\bslash ext@}\synt{float}] is the file extension for the
1949% list of these floats (e.g., \lit{lof} for figures).
1950%
1951% \item[\texttt{\bslash fnum@}\synt{float}] is a macro which generates the
1952% caption number. For figures, this expands to `|Figure~\thefigure|'.
1953%
1954% \end{description}
1955%
1956% We must also define |\@makecaption|, which typesets a float caption in
1957% an appropriate way, and an environment for each type of float.
1958%
1959% \subsection{Figures}
1960%
1961% This is all fairly straightforward stuff. First, we create a counter for
1962% figures:
1963%
1964% \begin{macrocode}
1965\newcounter{figure}[chapter]
1966\if@article
1967 \renewcommand\thefigure{\@arabic\c@figure}
1968\else
1969 \renewcommand\thefigure{\thechapter.\@arabic\c@figure}
1970\fi
1971% \end{macrocode}
1972%
1973% Now we define all the macros \LaTeX\ requires.
1974%
1975% \begin{macrocode}
1976\if@herefloats\def\fps@figure{htbp}\else\def\fps@figure{tbp}\fi
1977\def\ftype@figure{1}
1978\def\ext@figure{lof}
1979\def\fnum@figure{\figurename~\thefigure}
1980% \end{macrocode}
1981%
1982% \begin{environment}{figure}
1983% \begin{environment}{figure*}
1984%
1985% Finally, we create the \env{figure} and \env{figure$*$} environments.
1986%
1987% \begin{macrocode}
1988\newenvironment{figure}{\@float{figure}}{\end@float}
1989\newenvironment{figure*}{\@dblfloat{figure}}{\end@dblfloat}
1990% \end{macrocode}
1991% \end{environment}
1992% \end{environment}
1993%
1994% \subsection{Tables}
1995%
1996% This is pretty similar to the figure handling.
1997%
1998% \begin{macrocode}
1999\newcounter{table}[chapter]
2000\if@article
2001 \renewcommand\thetable{\@arabic\c@table}
2002\else
2003 \renewcommand\thetable{\thechapter.\@arabic\c@table}
2004\fi
2005%
2006\if@herefloats\def\fps@table{htbp}\else\def\fps@table{tbp}\fi
2007\def\ftype@table{2}
2008\def\ext@table{lot}
2009\def\fnum@table{\tablename~\thetable}
2010%
2011\newenvironment{table}{\@float{table}}{\end@float}
2012\newenvironment{table*}{\@dblfloat{table}}{\end@dblfloat}
2013% \end{macrocode}
2014%
2015% \subsection{Other float parameters}
2016%
2017% \begin{macro}{\@makecaption}
2018%
2019% The |\@makecaption| macro is called to display a float caption. It will
2020% typeset its argument either centred in a box, if it is short enough, or
2021% in a paragraph if it is longer than a line.
2022%
2023% \begin{macrocode}
2024\newlength\abovecaptionskip
2025\newlength\belowcaptionskip
2026\abovecaptionskip10\p@
2027\belowcaptionskip0\p@
2028%
c3f26ad3 2029\long\def\captionstyle#1#2{\itshape #1: #2}
1ffa9044 2030\long\def\@makecaption#1#2{%
2031 \vskip\abovecaptionskip%
c3f26ad3 2032 \sbox\@tempboxa{\captionstyle{#1}{#2}}%
1ffa9044 2033 \ifdim\wd\@tempboxa>\hsize%
c3f26ad3 2034 \unhbox\@tempboxa\par%
1ffa9044 2035 \else%
c3f26ad3 2036 \hb@xt@\hsize{\hfil\unhbox\@tempboxa\hfil}%
1ffa9044 2037 \fi%
2038 \vskip\belowcaptionskip%
2039}
2040% \end{macrocode}
2041% \end{macro}
2042%
2043% \section{Font commands}
2044%
2045% We allow the `old' font commands to do sensible \textsf{NFSS} things, since
2046% we don't have any legacy documents. This means that we have proper
2047% abbreviations for font changes. We also add |\nm| to return to a normal
2048% font, whatever that may mean.
2049%
2050% \begin{macrocode}
2051\DeclareOldFontCommand{\rm}{\rmfamily}{\mathrm}
2052\DeclareOldFontCommand{\sf}{\sffamily}{\mathsf}
2053\DeclareOldFontCommand{\tt}{\ttfamily}{\mathtt}
2054\DeclareOldFontCommand{\bf}{\bfseries}{\mathbf}
2055\DeclareOldFontCommand{\md}{\mdseries}{\@nomath\md}
2056\DeclareOldFontCommand{\it}{\itshape}{\mathit}
2057\DeclareOldFontCommand{\up}{\upshape}{\@nomath\up}
2058\DeclareOldFontCommand{\sl}{\slshape}{\@nomath\sl}
2059\DeclareOldFontCommand{\sc}{\scshape}{\@nomath\sc}
2060\DeclareOldFontCommand{\nm}{\normalfont}{\mathnormal}
2061% \end{macrocode}
2062%
2063% Now we define some special commands which only work in maths mode. It
2064% seems that older versions of \LaTeX\ (in particular, that at Warwick
2065% University) don't define these commands initially, so we'd better not
2066% use |\renewcommand| after all. We also dispose of lots of messing with
2067% |\protect| by using |\DeclareRobustCommand|.
2068%
2069% \begin{macrocode}
2070\DeclareRobustCommand\cal{\@fontswitch{\relax}{\mathcal}}
2071\DeclareRobustCommand\pmit{\@fontswitch{\relax}{\mathnormal}}
2072% \end{macrocode}
2073%
2074% \section{Tables of contents}
2075%
2076% This section deals with tables of contents, and lists of figures.
2077%
2078% \subsection{Contents}
2079%
2080% First, we have to define some parameters.
2081%
2082% \begin{macrocode}
2083\newcommand\@pnumwidth{2em}
2084\newcommand\@tocrmarg {3em}
2085\newcommand\@dotsep{4.5}
2086\setcounter{tocdepth}{\if@runinsubsubsec1\else2\fi}
2087% \end{macrocode}
2088%
2089% \begin{macro}{\tableofcontents}
2090%
2091% This is the main command for setting up tables of contents. We ensure
2092% a single-page layout, put in the chapter heading, read in the contents
2093% file, and then restore the old layout.
2094%
2095% \begin{macrocode}
c3f26ad3 2096\def\@tocthing#1#2{%
2097 \@ifnextchar[{\@tocthing@i{#1}{#2}}{\@tocthing@i{#1}{#2}[\relax][\relax]}%
2098}
2099\def\@tocthing@i#1#2[#3][#4]{%
2100 \if@twocolumn\@restonecoltrue\onecolumn\else\@restonecolfalse\fi%
2101 \@topsect@star{#1}#3{\parskip\z@\@starttoc{#2}}#4%
2102 \if@restonecol\twocolumn\fi%
1ffa9044 2103}
c3f26ad3 2104\newcommand\tableofcontents{\@tocthing\contentsname{toc}}
1ffa9044 2105% \end{macrocode}
2106% \end{macro}
2107%
2108% Each section type \synt{type} is typeset by a command |\l@|\synt{type}:
2109% for example, the |\l@chapter| command typesets the entry for a chapter
2110% heading.
2111%
2112% \begin{macro}{\l@part}
2113%
2114% This command is vaguely interesting. We'll explore in detail.
2115%
2116% \begin{macrocode}
2117\def\l@part#1#2{%
2118% \end{macrocode}
2119%
2120% We don't typeset the entry if |tocdepth| tells us not to. What kind of
2121% stupid user is going to disable \emph{all} the contents items.
2122%
2123% \begin{macrocode}
2124 \ifnum\c@tocdepth>-2\relax%
2125% \end{macrocode}
2126%
2127% Before we start, we try to break above the title. Later, we'll disable
2128% breaking afterwards. We then leave some vertical space.
2129%
2130% \begin{macrocode}
2131 \addpenalty{-\@highpenalty}%
2132 \addvspace{2.25em\@plus\p@}%
2133% \end{macrocode}
2134%
2135% We open a group, to avoid messing other things up. The |\numberline|
2136% macro, which numbers the entry on the left, typesets its argument in a box
2137% of width |\@tempdima|, which we must set up. We then set up the values
2138% of |\rightskip| and |\parfillskip| to avoid printing over the page number.
2139% We also make |\interlinepenalty| infinite to suppress breaking pages in
2140% the middle of the title.
2141%
2142% \begin{macrocode}
2143 \begingroup%
2144 \@tempdima3em%
2145 \parindent\z@%
2146 \rightskip\@pnumwidth%
2147 \parfillskip-\@pnumwidth%
2148 \interlinepenalty\@M
2149% \end{macrocode}
2150%
2151% Time to typeset the actual title. This is fairly simple, apart from
2152% a complicated mixture of glue and penalties, which handles a line break
2153% right at the end of the title.
2154%
2155% \begin{macrocode}
2156 {%
2157 \leavevmode%
2158 \large\bfseries {#1}%
2159 \nobreak\hfil\penalty\@highpenalty\hbox{}\nobreak\hfil%
2160 \hb@xt@\@pnumwidth{\hss #2}%
2161 }%
2162% \end{macrocode}
2163%
2164% Now we end the paragraph and suppress page breaking here.
2165%
2166% \begin{macrocode}
2167 \par%
2168 \nobreak%
2169 \global\@nobreaktrue%
2170 \everypar{\global\@nobreakfalse\everypar{}}%
2171 \endgroup%
2172 \fi%
2173}
2174% \end{macrocode}
2175% \end{macro}
2176%
2177% \begin{macro}{\@artsw}
2178%
2179% Define a macro named after the first or second argument depending on
2180% whether the document is an article.
2181%
2182% \begin{macrocode}
2183\def\@artsw#1#2#3{%
2184 \edef\@tempa{#1\if@article\noexpand#3\else\noexpand#2\fi}%
2185 \@tempa%
2186}
2187% \end{macrocode}
2188%
2189% \end{macro}
2190%
2191% \begin{macro}{\l@chapter}
2192%
2193% This is terribly similar to the previous macro.
2194%
2195% \begin{macrocode}
2196\@artsw\def\l@chapter\l@section#1#2{%
2197 \ifnum\c@tocdepth >\m@ne%
2198 \addpenalty{-\@highpenalty}%
2199 \vskip1.0em\@plus\p@%
2200 \setlength\@tempdima{2em}%
2201 \begingroup%
2202 \interlinepenalty\@M
2203 \parindent\z@%
2204 \rightskip\@pnumwidth%
2205 \parfillskip-\@pnumwidth%
2206 \leavevmode%
2207 \bfseries%
2208 \advance\leftskip\@tempdima%
2209 \hskip-\leftskip%
2210 {#1}%
2211 \nobreak\hfil\penalty\@highpenalty\hbox{}\nobreak\hfil%
2212 \hb@xt@\@pnumwidth{\hss #2}%
2213 \par%
2214 \penalty\@highpenalty%
2215 \endgroup%
2216 \fi%
2217}
2218% \end{macrocode}
2219% \end{macro}
2220%
2221% The other types are all defined in terms of |\@dottedtocline|, which is
2222% redefined beloew.
2223%
2224% \begin{macrocode}
2225\@artsw\def\l@section\l@subsection{\@dottedtocline{1}{2em}{2.5em}}
2226\@artsw\def\l@subsection\l@subsubsection{\@dottedtocline{2}{4.5em}{3.2em}}
2227\@artsw\def\l@subsubsection\l@paragraph{\@dottedtocline{3}{7.7em}{4.1em}}
2228\@artsw\def\l@paragraph\l@subparagraph{\@dottedtocline{4}{10.5em}{5em}}
2229\@artsw\def\l@subparagraph\@tempa{\@dottedtocline{5}{12.5em}{6em}}
2230% \end{macrocode}
2231%
2232% \begin{macro}{\@dottedtocline}
2233%
2234% This is actually a part of the \LaTeX\ kernel, although it's not quite
fddb126a 2235% right the way it is. We've improved the handling of line breaks after the
1ffa9044 2236% title.
2237%
2238% \begin{macrocode}
2239\def\@dottedtocline#1#2#3#4#5{%
2240% \end{macrocode}
2241%
2242% We have to make sure that we're meant to typeset this contents entry.
2243%
2244% \begin{macrocode}
2245 \ifnum#1>\c@tocdepth\else%
2246% \end{macrocode}
2247%
2248% Now we add in a little stretchy space.
2249%
2250% \begin{macrocode}
2251 \vskip\z@\@plus.2\p@%
2252% \end{macrocode}
2253%
2254% Set up the paragraph layout now. We forbid page breaks in the middle of
2255% the title.
2256%
2257% \begin{macrocode}
2258 {%
2259 \leftskip#2\relax%
2260 \rightskip\@tocrmarg%
2261 \parfillskip-\rightskip%
2262 \parindent#2\relax%
2263 \@afterindenttrue%
2264 \interlinepenalty\@M%
2265% \end{macrocode}
2266%
2267% Now we typeset the actual title.
2268%
2269% \begin{macrocode}
2270 \leavevmode%
2271 \@tempdima#3\relax%
2272 \advance\leftskip\@tempdima%
2273 \hbox{}%
2274 \hskip-\leftskip%
2275 {#4}%
2276% \end{macrocode}
2277%
2278% This is the clever bit. After the actual title, we add the following
2279% items:
2280%
2281% \begin{itemize}
2282%
2283% \item A |\nobreak| penalty, to stop a break from eating the glue.
2284%
2285% \item A glob of |\hfil| glue. If there's a line break after this glue,
2286% the title is set flush left as a result of this. Otherwise, it is ignored
2287% because the leaders are |\hfill|.
2288%
2289% \item A penalty. This is a reasonable place to break the line if
2290% necessary.
2291%
2292% \item An empty |\hbox|. This stops the following glue from being discarded
2293% at the beginning of a new line.
2294%
2295% \item Another |\nobreak|, which stops a break at the following glue item.
2296%
2297% \item The dotted |\leaders|, which have |\hfill| stretchiness. This forces
2298% the page number to be flush right.
2299%
2300% \end{itemize}
2301%
2302% The net result of all this is we can now cope with a line break at the
2303% end of the title, before the page number, which means that the dots are
2304% put on the next line. The original \LaTeX\ version forced the last word
2305% of the title onto the next line as well, which can cause underful boxes.
2306%
2307% \begin{macrocode}
2308 \nobreak\hfil\penalty\@highpenalty\hbox{}\nobreak%
2309 \leaders\hbox{$\m@th\mkern\@dotsep mu.\mkern\@dotsep mu$}\hfill%
2310 \hb@xt@\@pnumwidth{\hfil\reset@font\rmfamily#5}\par%
2311 }%
2312 \fi%
2313}
2314% \end{macrocode}
2315% \end{macro}
2316%
2317% \subsection{Lists of figures and tables}
2318%
2319% These macros are terribly similar to the other ones.
2320%
2321% \begin{macrocode}
c3f26ad3 2322\newcommand\listoffigures{\@tocthing\listfigurename{lof}}
2323\newcommand\l@figure{\@dottedtocline{0}{0pt}{2em}}
2324\newcommand\listoftables{\@tocthing\listtablename{lot}}
1ffa9044 2325\let\l@table\l@figure
2326% \end{macrocode}
2327%
2328% \section{Bibliography}
2329%
2330% This isn't actually terribly interesting.
2331%
2332% \begin{environment}{thebibliography}
2333%
2334% \begin{macrocode}
2335\newdimen\bibindent
2336\bibindent1.5em
2337%
2338\newenvironment{thebibliography}[1]{%
2339 \@topsect\bibname%
2340 \list{\@biblabel{\arabic{enumiv}}}%
2341 {\settowidth\labelwidth{\@biblabel{#1}}%
2342 \leftmargin\labelwidth%
2343 \advance\leftmargin\labelsep%
2344 \if@openbib%
2345 \advance\leftmargin\bibindent%
2346 \itemindent-\bibindent%
2347 \listparindent\itemindent%
2348 \parsep\z@%
2349 \fi%
2350 \usecounter{enumiv}%
2351 \let\p@enumiv\@empty%
2352 \renewcommand\theenumiv{\arabic{enumiv}}}%
2353 \if@openbib%
2354 \renewcommand\newblock{\par}%
2355 \else%
2356 \renewcommand\newblock{\hskip.11em\@plus.33em\@minus.07em}%
2357 \fi%
2358 \sloppy%
2359 \clubpenalty4000%
2360 \widowpenalty4000%
2361 \sfcode`\.\@m%
2362}{%
2363 \def\@noitemerr{\@latex@warning{Empty `thebibliography' environment}}%
2364 \endlist%
2365}
2366%
2367\newcommand\newblock{}
2368% \end{macrocode}
2369% \end{environment}
2370%
2371% \section{Index}
2372%
2373% Defines the \env{theindex} environment.
2374%
2375% \begin{environment}{theindex}
2376%
2377% The macros are fairly simple. We change to a two column layout, and
2378% redefine |\item| appropriately.
2379%
2380% \begin{macrocode}
2381\newenvironment{theindex}{%
2382 \columnseprule\z@%
2383 \columnsep35\p@%
2384 \@topsect\indexname%
2385 \if@twocolumn\else%
2386 \begin{multicols}{2}%
2387 \fi%
2388 \parskip\z@\@plus.3\p@\relax%
2389 \raggedright%
2390 \let\item\@idxitem%
2391}{%
2392 \if@twocolumn\else%
2393 \end{multicols}%
2394 \fi%
2395}
2396% \end{macrocode}
2397% \end{environment}
2398%
2399% Now we define the item and spacing macros.
2400%
2401% \begin{macrocode}
2402\newcommand\@idxitem {\par\hangindent 40\p@}
2403\newcommand\subitem {\par\hangindent 40\p@ \hspace*{20\p@}}
2404\newcommand\subsubitem{\par\hangindent 40\p@ \hspace*{30\p@}}
2405\newcommand\indexspace{\par \vskip 10\p@ \@plus5\p@ \@minus3\p@\relax}
2406% \end{macrocode}
2407%
2408% \begin{macro}{\passim}
2409%
2410% The |passim| encapsulator is used to typeset the word `\textit{passim}'
2411% after a page range.
fddb126a 2412%
1ffa9044 2413% \begin{macrocode}
2414\def\passim#1{#1 \textit{passim}} % Passim encapsulator for indices
2415% \end{macrocode}
2416% \end{macro}
2417%
2418% Other useful commands for indexing:
2419%
2420% \begin{description*}
2421% \def\descriptionlabel#1{\ttfamily \bslash #1}
2422%
2423% \item[Term] typesets its argument in italics, and adds it to the index.
2424%
2425% \item[term] typesets its first argument in italics, and adds its second
2426% to the index.
2427%
2428% \item[Index] typesets its argument normally, and adds it to the index.
2429%
2430% \end{description*}
2431%
2432% \begin{macrocode}
2433\def\Term#1{\emph{#1}\index{#1}}
2434\def\term#1{\emph{#1}\index}
2435\def\Index#1{#1\index{#1}}
2436% \end{macrocode}
2437%
2438% \section{Footnotes}
2439%
2440% \begin{macro}{\footnoterule}
2441%
2442% This macro typesets the rule above footnotes. This is a bit more complex
2443% than the default: we try and typeset the rule to be at most 1\,in wide,
2444% although if the column isn't wide enough, we use $4\over10$~of the
2445% box width instead.
2446%
2447% \begin{macrocode}
2448\def\footnoterule{%
2449 \@tempdima.4\columnwidth%
2450 \ifdim\@tempdima>1in\relax%
2451 \@tempdima1in\relax%
2452 \fi%
2453 \kern-3\p@%
2454 \hrule\@width\@tempdima%
2455 \kern2.6\p@%
2456}
2457% \end{macrocode}
2458% \end{macro}
2459%
2460% We number footnotes within chapters:
2461%
2462% \begin{macrocode}
2463\@addtoreset{footnote}{chapter}
2464% \end{macrocode}
2465%
2466% \begin{macro}{\@makefntext}
2467%
2468% This is the macro which actually typesets a footnote. This is rather
2469% complicated. It's based on example code from \file{classes.dtx} which
2470% doesn't actually work properly.
2471%
2472% \begin{macrocode}
2473\long\def\@makefntext#1{%
2474% \end{macrocode}
2475%
2476% First, we redefine |\par| to set up the correct paragraph shape. This
2477% is indented from the left margin by a small amount.
2478%
2479% \begin{macrocode}
2480 \@setpar{%
2481 \@@par%
2482 \@tempdima\hsize%
2483 \advance\@tempdima-1.6em%
2484 \parshape\@ne1.6em\@tempdima%
2485 }%
2486% \end{macrocode}
2487%
2488% Now we set up some parameters so that \env{list} environments work properly
2489% within the footnote. We also clear |\parindent| to prevent nasty
2490% indentation. The |\par| sets up the paragraph shape for the next
2491% paragraph: we're in vertical mode already, so it does nothing else.
2492%
2493% \begin{macrocode}
2494 \advance\linewidth-1.6em%
2495 \advance\@totalleftmargin1.6em%
2496 \par%
2497 \parindent\z@%
2498% \end{macrocode}
2499%
2500% We leave vertical mode to stop the hbox created by |\llap| from being
2501% stacked vertically. Then we typeset the footnote mark, and put in the
2502% main text. Finally we leave some space afterwards, to space out the next
2503% footnote.
2504%
2505% \begin{macrocode}
2506 \leavevmode%
2507 \llap{\@makefnmark\enspace}#1\par%
2508 \vskip\parskip%
2509}
2510% \end{macrocode}
2511% \end{macro}
2512%
2513% \begin{macro}{\@makecol}
2514%
2515% The standard \LaTeX\ output routine messes up footnotes a bit, in my
2516% opinion:
2517% \begin{itemize}
2518%
2519% \item If a page is cut off short, because the next item won't fit (e.g.,
2520% a section heading), then footnotes are added right below the end
2521% of the text, which can look strange.
2522%
2523% \item Footnotes are displayed \emph{above} floats at the bottom of a page,
2524% which also looks strange.
2525%
2526% \item The |\@makefntext| routine above needs to add vertical space between
2527% footnotes, but this leaves a gap at the very bottom. We remove this
2528% gap with an |\unskip|.
2529%
2530% \end{itemize}
2531%
2532% \begin{macrocode}
2533\def\@makecol{%
2534 \setbox\@outputbox \box\@cclv
2535 \xdef\@freelist{\@freelist\@midlist}%
2536 \global \let \@midlist \@empty
2537 \@combinefloats
2538 \ifvoid\footins \else
2539 \setbox\@outputbox \vbox {%
fddb126a 2540 \boxmaxdepth \@maxdepth
1ffa9044 2541 \unvbox \@outputbox
2542 \vskip \skip\footins
2543 \vfil
2544 \footnoterule
2545 \unvbox \footins
2546 \unskip
2547 }%
2548 \fi
2549 \ifvbox\@kludgeins
2550 \@makespecialcolbox
2551 \else
2552 \setbox\@outputbox \vbox to\@colht {%
2553 \@texttop
2554 \dimen@ \dp\@outputbox
2555 \unvbox \@outputbox
2556 \vskip -\dimen@
2557 \@textbottom
2558 }%
2559 \fi
2560 \global \maxdepth \@maxdepth
2561}
2562% \end{macrocode}
2563% \end{macro}
2564%
2565% \section{Tidying up}
2566%
2567% This section gathers together various other useful bits of standard
2568% document class setting.
2569%
2570% \subsection{Item names}
2571%
2572% These commands typeset bits of text. They can then be redefined by
2573% \package{babel} and suchlike.
2574%
2575% \begin{macrocode}
2576\newcommand\contentsname{Contents}
c3f26ad3 2577\newcommand\listfigurename{List of figures}
2578\newcommand\listtablename{List of tables}
1ffa9044 2579\if@article\newcommand\bibname{References}
2580\else\newcommand\bibname{Bibliography}\fi
2581\newcommand\indexname{Index}
2582\newcommand\figurename{Figure}
2583\newcommand\tablename{Table}
2584\newcommand\partname{Part}
2585\newcommand\abstractname{Abstract}
2586\newcommand\chaptername{Chapter}
2587\newcommand\appendixname{Appendix}
2588\newcommand\today{\number\day\space\ifcase\month\or
2589 January\or February\or March\or April\or May\or June\or
2590 July\or August\or September\or October\or November\or December\fi
2591 \space\number\year}
2592% \end{macrocode}
2593%
2594% \subsection{Final fiddling for two columns}
2595%
2596% \begin{macrocode}
2597\columnsep10\p@
2598\columnseprule\z@
2599\pagestyle{headings}
2600\pagenumbering{arabic} % Arabic page numbers
2601\if@twocolumn
2602 \twocolumn
2603 \sloppy
2604 \flushbottom
2605\else
2606 \onecolumn
2607\fi
2608% \end{macrocode}
2609%
2610% \section{The \protect\env{central} environment}
2611%
2612% Because of the strange layout of the pages, text which is centred using
2613% normal \LaTeX\ commands is centred in the text area, not on the page,
2614% which is undesirable for large headings, like part headings.
2615%
2616% \begin{environment}{central}
2617%
2618% The \env{central} environment typesets its contents centrally on the page.
2619% It should only be used from outer vertical mode.
2620%
2621% The code just creates a box of the appropriate size and moves it into the
2622% right place.
2623%
2624% \begin{macrocode}
2625\newenvironment{central}{%
2626 \par%
2627 \vbox\bgroup\moveleft\leftindent\vbox\bgroup%
2628 \textwidth\paperwidth%
2629 \advance\textwidth-2\pagesurround\relax%
2630 \hsize\textwidth%
2631 \hrule\@height\z@\@depth\z@\@width\hsize%
2632}{%
2633 \egroup%
2634 \egroup%
2635}
2636% \end{macrocode}
2637% \end{environment}
2638%
2639% \section{Headers and footers}
2640%
2641% The \strayman\ class uses \package{fancyheadings} for its headers
2642% and footers. This has already been included in the preamble. We now
2643% need to fix a few problems with \package{fancyheadings} and set up some
2644% macros.
2645%
2646% \begin{macro}{\title}
2647%
2648% We extend |\title|, and give it an optional argument. It can now specify
2649% the document title as used by |\maketitle| and the running title for the
2650% header separately.
2651%
2652% We store the running header in the macro |\@headertitle|, which is
2653% initially empty.
2654%
2655% \begin{macrocode}
2656\def\@headertitle{}
2657% \end{macrocode}
2658%
2659% Now we define the |\title| macro, using |\@dblarg| to duplicate the
2660% mandatory argument if the optional one is omitted.
2661%
2662% \begin{macrocode}
2663\def\title{\@dblarg\title@i}
2664\def\title@i[#1]#2{%
2665 \gdef\@title{#2}%
2666 \gdef\@headertitle{#1}%
2667}
2668% \end{macrocode}
2669% \end{macro}
2670%
2671% \begin{macro}{\innerhead}
2672% \begin{macro}{\innerfoot}
2673%
2674% We allow the user to specify an `inner heading' which is displayed on the
2675% inside of the header on of each page. This can be used for security
2676% classifications, for example. Any \package{fancyheadings} commands can
2677% be used to control the header, which is expanded on each page.
2678%
2679% \begin{macrocode}
2680\def\l@innerhead{}
2681\def\r@innerhead{}
2682\def\l@innerfoot{}
2683\def\r@innerfoot{}
2684\def\innerhead{\@dblarg\innerhead@i}
2685\def\innerhead@i[#1]#2{%
2686 \def\l@innerhead{#1}%
2687 \def\r@innerhead{#2}%
2688}
2689\def\innerfoot{\@dblarg\innerfoot@i}
2690\def\innerfoot@i[#1]#2{%
2691 \def\l@innerfoot{#1}%
2692 \def\r@innerfoot{#2}%
2693}
2694% \end{macrocode}
2695% \end{macro}
2696% \end{macro}
2697%
2698% The next step is to set up the headings:
2699%
2700% \begin{macrocode}
2701\let\headrulewidth\z@
2702\headwidth\textwidth
2703 \advance\headwidth\leftindent
2713c178 2704\fancyhfoffset[LE,LO]{\leftindent}
1ffa9044 2705\fancypagestyle{headings}{%
2706 \fancyhf{}
2707 \fancyhead[LE]{\bfseries\@headertitle}
2708 \if@article\fancyhead[RO]{\rightmark}\else\fancyhead[RO]{\leftmark}\fi
2709 \fancyhead[RE]{\l@innerhead} \fancyhead[LO]{\r@innerhead}
2710 \fancyfoot[RE]{\l@innerfoot} \fancyfoot[LO]{\r@innerfoot}
2711 \fancyfoot[LE,RO]{\thepage}
2712}
2713\fancypagestyle{plain}{%
2714 \fancyhf{}%
2715 \fancyfoot[RE]{\l@innerfoot} \fancyfoot[LO]{\r@innerfoot}
2716 \fancyfoot[LE,RO]{\thepage}%
2717}
2718\let\ps@fancy\ps@@fancy
2719% \end{macrocode}
2720%
2721% The \package{fancyheadings} package by default expects pages to be
2722% symmetrical. We have to redefine the |\ps@fancy| macro to make it
2723% work properly.
2724%
2725% \begin{macrocode}
2726\def\@lodd{\ifodd\c@page\hss\else\relax\fi}
2727\def\@rodd{\ifodd\c@page\relax\else\hss\fi}
2728% \end{macrocode}
2729%
2730% Finally, we can choose the page style we want:
2731%
2732% \begin{macrocode}
2733\pagestyle{headings}
2734% \end{macrocode}
2735%
2736% \section{Parbox alteration}
2737%
2738% The standard \LaTeX\ |\parbox| command, and the \env{minipage} environment,
2739% reset |\parskip| to zero, which is inconsistent with the document style.
2740% We amend |\@arrayparboxrestore|, the macro which sets up the paragraph
2741% style for parboxes.
2742%
2743% First, we define a macro explaining how the parbox should set the spacing.
2744%
2745% \begin{macrocode}
2746\def\parboxparskip{2ex}
2747% \end{macrocode}
2748%
2749% Next, we redefine the macro. This is taken directly from the \LaTeXe
2750% source.
2751%
2752% \begin{macrocode}
2753\def\@arrayparboxrestore{%
2754 \let\par\@@par
2755 \let\-\@dischyph
2756 \let\'\@acci\let\`\@accii\let\=\@acciii
2757 \parindent\z@ \parskip\z@
2758 \everypar{\parskip\parboxparskip\everypar{}}%
2759 \linewidth\hsize
fddb126a 2760 \@totalleftmargin\z@
1ffa9044 2761 \leftskip\z@skip \rightskip\z@skip \@rightskip\z@skip
2762 \parfillskip\@flushglue \lineskip\normallineskip
2763 \baselineskip\normalbaselineskip
2764 \@noskipsectrue% % The comp.text.tex gurus said it should be
2765 \sloppy}
2766% \end{macrocode}
2767%
2768%
2769% \section{Other features}
2770%
2771% At the end is a miscellany of useful features.
2772%
2773% \subsection{Other typesetting conventions}
2774%
2775% Some items need typesetting in particular ways.
2776%
2777% \begin{macrocode}
2778\let\key\textit
2779\let\button\textbf
2780\def\submenu{\ensuremath\Rightarrow}
2781\let\name\relax
2782\def\file#1{\mbox{\itshape #1\/}}
2783% \end{macrocode}
2784%
2785% \subsection{And finally}
2786%
2787% \begin{macrocode}
2788\sloppy
2789\raggedbottom
2790\def\riscos{RISC~OS}
2791\hyphenpenalty1000
2792%</strayman>
2793% \end{macrocode}
2794%
2795% \Finale
2796%
2797\endinput