Document Class refman for L

(1)

Document Class refman for L

A

_{TEX version 2e}

∗

Copyright (C) 1988 by Hubert Partl

Copyright (C) 1994-2006 by Axel Kielhorn

2006/11/13

8.2 Bibliography . . . 42 8.3 The index . . . 44 8.4 Footnotes . . . 45 9 New commands 46 9.1 Margin commands . . . 47 9.2 Rules . . . 47 9.3 Pages . . . 47 9.4 Miscellaneous . . . 48 9.5 Obsolete commands . . . 48 9.6 Future commands . . . 49 10 Initialization 50 10.1 Words . . . 50 10.2 Date . . . 50

10.3 Two column mode . . . 50

10.4 The page style . . . 50

10.5 Single or double sided printing . . . 51

1 _{The docstrip modules}

The following modules are used in the implementation to direct docstrip in generating the external files:

refart produce the documentclass refart refrep produce the documentclass refrep driver produce a documentation driver file

2 Initial Code

In this part we define a few commands that are used later on.

\@ptsize This control sequence is used to store the second digit of the pointsize we are typesetting in. So, normally, its value is one of 0, 1 or 2.

1h∗refart | refrepi

2\newcommand\@ptsize{}

\if@restonecol Only the index is printed in two-column layout.

3\newif\if@restonecol

\if@titlepage A switch to indicate if a titlepage has to be produced. For the refart document class the default is not to make a separate titlepage.

4\newif\if@titlepage

5h+refarti\@titlepagefalse

(4)

\if@openright A switch to indicate if chapters must start on a right-hand page. The default for the refrep class is no. There are no chapters in the refart class.

7h+refrepi\newif\if@openright

3 Declaration of Options

3.1 Setting Paper Sizes

The variables \paperwidth and \paperheight should reflect the physical paper size after trimming. For desk printer output this is usually the real paper size since there is no post-processing. Classes for real book production will probably add other paper sizes and additionally the production of crop marks for trimming. Since repbook does not exist you may change the papersizes in your document if needed. 8\DeclareOption{a4paper} 9 {\setlength\paperheight {297mm}% 10 \setlength\paperwidth {210mm}} 11\DeclareOption{a5paper} 12 {\setlength\paperheight {210mm}% 13 \setlength\paperwidth {148mm}} 14\DeclareOption{b5paper} 15 {\setlength\paperheight {250mm}% 16 \setlength\paperwidth {176mm}} 17\DeclareOption{letterpaper} 18 {\setlength\paperheight {11in}% 19 \setlength\paperwidth {8.5in}} 20\DeclareOption{legalpaper} 21 {\setlength\paperheight {14in}% 22 \setlength\paperwidth {8.5in}} 23\DeclareOption{executivepaper} 24 {\setlength\paperheight {10.5in}% 25 \setlength\paperwidth {7.25in}}

A new lenght \papermarginwidth is allocated and set to 1 in. The option smallborder reduces the margin around the document to 0.25 in. This is suitable for documents that are ment to be read on the screen, since it wastes less screen area. It is probably no good idea to use this option for a printed document.

If you want to change this margin use \setlength\papermarginwidth in your document and issue a \settowidth{0.7} command to recalculate the page lay-ouot.

26\newlength\papermarginwidth

27\setlength\papermarginwidth {1in}

28\DeclareOption{smallborder}

29 {\setlength\papermarginwidth {0.25in}}

The option landscape switches the values of \paperheight and \paperwidth, assuming the dimensions were given for portrait paper.

(5)

31 {\setlength\@tempdima {\paperheight}%

32 \setlength\paperheight {\paperwidth}%

33 \setlength\paperwidth {\@tempdima}}

The option square assigns the values of \paperwidth to \paperheight, which will result in a square layout. If you use landscape first you will get a square layout which uses the height of your original paper.

34\DeclareOption{square}

35 {\setlength\paperheight {\paperwidth}}

3.2 Telling the DVI-driver what we know

We know the actual paper size, let’s tell the dvi-driver about it. You have to specify the dvi-driver you are using. These three options are compatible to the options of the KOMA-script class, thanks Markus.

dvips 36\DeclareOption{dvips}{\AtBeginDocument{\AtBeginDvi{% 37 \special{papersize=\the\paperwidth,\the\paperheight}}}} pdftex 38\DeclareOption{pdftex}{\AtBeginDocument{% 39 \pdfpagewidth=\paperwidth \pdfpageheight=\paperheight}}

Since we need to know whether we are generating DVI or PDF we can make this information available to the user as well.

\ifpdfoutput

40\newcommand{\ref@ifpdfoutput}[2]{%

41 \begingroup\@ifundefined{pdfoutput}{\endgroup #2}{\endgroup%

42 \ifnum\pdfoutput>0\relax #1\else #2\fi}}%

43\@ifundefined{ifpdfoutput}{% 44 \let\ifpdfoutput\ref@ifpdfoutput}{% 45h∗refarti 46\PackageInfo{refart} 47h/refarti 48h∗refrepi 49\PackageInfo{refrep} 50h/refrepi

51 {\string\ifpdfoutput\space already defined.\MessageBreak

52 If \string\ifpdfoutput\space does not behave like\MessageBreak

53 is is described at the Refman manual, try find out\MessageBreak

54 at which package \string\ifpdfoutput\space was defined.}}

The option pagesize will export the correct definition for the dvi-driver used. (Unless magic fails, then you need to specify the driver manually.)

pagesize

(6)

56 \ref@ifpdfoutput

57 {\pdfpagewidth=\paperwidth\pdfpageheight=\paperheight}

58 {\AtBeginDvi{\special{papersize=\the\paperwidth,\the\paperheight}}}}}

3.3 Choosing the type size

The type size options are handled by defining \@ptsize to contain the last digit of the size in question and branching on \ifcase statements. This is done for historical reasons, to stay compatible with other packages that use the \@ptsize variable to select special actions. It makes the declarations of size options less than 10pt difficult, although one can probably use 8 assuming that a class won’t define both 8pt and 18pt options.

59\DeclareOption{10pt}{\renewcommand\@ptsize{0}}

3.4 Two-side or one-side printing

For two-sided printing we use the switch \if@twoside. We set \if@mparswitch which does nothing now but is kept for compatibility reasons.

62\DeclareOption{oneside}{\@twosidefalse \@mparswitchfalse}

63\DeclareOption{twoside}{\@twosidetrue \@mparswitchtrue}

3.5 Draft option

If the user requests draft we show any overfull boxes. We could probably add some more interesting stuff to this option.

64\DeclareOption{draft}{\setlength\overfullrule{5pt}}

65\DeclareOption{final}{\setlength\overfullrule{0pt}}

3.6 Titlepage option

The refart usually has no separate titlepage, but the user can request one.

66\DeclareOption{titlepage} {\@titlepagetrue}

67\DeclareOption{notitlepage}{\@titlepagefalse}

3.7 openright option

This option determines whether or not a chapter must start on a right-hand page and request one.

(7)

3.8 Twocolumn printing

Two-column is used in the index. There is no user command or option to request two-column printing. Therefore twocolumn will lead to an error message.

70\DeclareOption{onecolumn}{\@twocolumnfalse}

71\DeclareOption{twocolumn}{%

72h+refarti \ClassError{Refart}

73h+refrepi \ClassError{Refrep}

74 {There is no twocolumn layout in this class!}

75 {Can you imagine how twocolumn layout will look\MessageBreak

76 in this class? That’s why!}

77 \@twocolumnfalse}

3.9 Equation numbering on the left

The option leqno can be used to get the equation numbers on the left side of the equation.

78\DeclareOption{leqno}{\input{leqno.clo}}

3.10 Flush left displays

The option fleqn redefines the displayed math environmens in such a way that they come out flush left, with an indentation of \mathindent from the prevailing left margin.

79\DeclareOption{fleqn}{\input{fleqn.clo}}

3.11 Open bibliography

The option openbib produces the “open” bibliography style, in which each block starts on a new line, and succeeding lines in a block are indented by \bibindent.

80\DeclareOption{openbib}{%

First some hook into the bibliography environment is filled.

81 \AtEndOfClass{% 82 \renewcommand\@openbib@code{% 83 \advance\leftmargin\bibindent 84 \itemindent -\bibindent 85 \listparindent \itemindent 86 \parsep \z@ 87 }%

In addition the definition of \newblock is overwritten.

88 \renewcommand\newblock{\par}}%

(8)

3.12 User flags

There are some flags the user may change to control the behaviour of some com-mands:

\ifdescriptioncolon This switch controls whether there is a colon in the description item or not. The default is to include a colon.

90\newif\ifdescriptioncolon \descriptioncolontrue

\ifdescriptionleft This switch controls whether the description items are set left bound or right bound. The default is right bound.

91\newif\ifdescriptionleft \descriptionleftfalse

\ifmaxipagerule This switch controls whether there is a rule at the beginning and end of a maxipage. This flag may later be used to select rules at other places (like part or chapter) as well.

92\newif\ifmaxipagerule \maxipageruletrue

4 Executing Options

Here we execute the default options to initialize certain variables.

93h∗refarti 94\ExecuteOptions{letterpaper,10pt,oneside,onecolumn,final} 95h/refarti 96h∗refrepi 97\ExecuteOptions{letterpaper,10pt,oneside,onecolumn,final,openany} 98h/refrepi

The \ProcessOptions command causes the execution of the code for every option FOO which is declared and for which the user typed the FOO option in his \documentclass command. For every option BAR he typed, which is not declared, the option is assumed to be a global option. All options will be passed as document options to any \usepackage command in the document preamble.

99\ProcessOptions

Now that all the options have been executed we can load the chosen class option file that contains all size dependent-code. We are using the sizexx.clo Files from classes.dtx now and do the page layout caculation inside the class-file.

101\input{size1\@ptsize.clo}

102h/refart | refrepi

5 Loading Packages

(9)

6 Document Layout

In this section we are finally dealing with the nasty typographical details.

6.1 Fonts

LA_{TEX offers the user commands to change the size of the font, relative to the}

‘main’ size. Each relative size changing command \size executes the command \@setfontsize\sizehfont-sizeihbaselineskipi where:

hfont-sizei The absolute size of the font to use from now on.

hbaselineskipi The normal value of \baselineskip for the size of the font se-lected. (The actual value will be \baselinestretch * hbaselineskipi.) A number of commands, defined in the LA_{TEX kernel, shorten the following}

definitions and are used throughout. They are:

\@vpt 5 \@vipt 6 \@viipt 7 \@viiipt 8 \@ixpt 9 \@xpt 10 \@xipt 10.95 \@xiipt 12 \@xivpt 14.4 ...

\normalsize \@normalsize

The user level command for the main size is \normalsize. Internally, LA_{TEX uses}

\@normalsize when it refers to the main size. \@normalsize will be defined to work like \normalsize if the latter is redefined from its default definition (that just issues an error message). Otherwise \@normalsize simply selects a 10pt/12pt size.

See classes.dtx for documentaion on sizexx.clo

6.2 Paragraphing

\lineskip \normallineskip

These parameters control TEX’s behaviour when two lines tend to come too close together.

104\setlength\lineskip{1\p@}

105\setlength\normallineskip{1\p@}

\baselinestretch This is used as a multiplier for \baselineskip. The default is to not stretch the baselines.

106\renewcommand\baselinestretch{} \parskip

\parindent

\parskip gives extra vertical space between paragraphs and \parindent is the width of the paragraph indentation. The value of \parindent is set to 0.

107\setlength\parskip {0.5\baselineskip \@plus 2\p@}

(10)

\@lowpenalty \@medpenalty \@highpenalty

The commands \nopagebreak and \nolinebreak put in penalties to discourage these breaks at the point they are put in. They use \@lowpenalty, \@medpenalty or \@highpenalty, dependent on their argument.

109\@lowpenalty 51

110\@medpenalty 151

111\@highpenalty 301 \clubpenalty

\widowpenalty

These penalties are use to discourage club and widow lines. Because we use their default values we only show them here, commented out.

112% \clubpenalty 150

113% \widowpenalty 150 \displaywidowpenalty

\predisplaypenalty \postdisplaypenalty

Discourrage (but not so much) widows in front of a math display and forbid breaking directly in front of a display. Allow break after a display without a penalty. Again the default values are used, therefore we only show them here.

114% \displaywidowpenalty 50

115% \predisplaypenalty 10000

116% \postdisplaypenalty 0

\interlinepenalty Allow the breaking of a page in the middle of a paragraph.

117% \interlinepenalty 0

\brokenpenalty We allow the breaking of a page after a hyphenated line.

118% \brokenpenalty 100

6.3 Page Layout

All margin dimensions are measured from a point one inch from the top and lefthand side of the page.

6.3.1 Vertical spacing

\headheight \headsep \topskip

The \headheight is the height of the box that will contain the running head. The \headsep is the distance between the bottom of the running head and the top of the text. \topskip is the \baselineskip for the first line on a page. Only the definition of \headsep differs from sizexx and has to be changed.

119\setlength\headsep {\baselineskip}

6.3.2 The dimension of text

\fullwidth \textwidth \leftmarginwidth

There is no need to supply a compatibility mode since the independent refman.sty was never released to the public.

We will set the dimensions differently, taking into account the paper size for instance.

First, we calculate the maximum text width, which will fit on the selected paper and store it in \@tempdima.

120\newdimen\leftmarginwidth

(11)

\emptyfoottopmargin \emptyheadtopmargin

Your document uses either footings or headings. Depending on this, the whole page is shifted up or down by one line.

122\newdimen\emptyfoottopmargin

123\newdimen\emptyheadtopmargin

\settextfraction You can specify how much of the \fullwidth will be used for the text by using

the \settextfraction command. The argument should be between 0 and 1. The remaining width is used for the left margin. This command recalculates the page layout. You have to call \settextfraction with the default value of 0.7 to adjust the layout when you want to change the \papermarginwidth.

124\newcommand\settextfraction[1]%

125{

126 \setlength\fullwidth{\paperwidth}

127 \addtolength\fullwidth{-2\papermarginwidth}

128 \@settopoint\fullwidth

Now we can set the \textwidth, depending on whether we will be setting one or two columns. 129 \if@twocolumn 130 \setlength\textwidth{\fullwidth} 131 \else 132 \setlength\textwidth{#1\fullwidth} 133 \fi

Here we modify the width of the text a little to be a whole number of points and calculate the remaining margin.

134 \@settopoint\textwidth 135 \setlength\leftmarginwidth{\fullwidth} 136 \addtolength\leftmarginwidth{-\textwidth} 6.3.3 Horizontal margins \oddsidemargin \evensidemargin \marginparwidth

The values for \oddsidemargin and \marginparwidth will be set independing on the status of the \if@twoside. (We have the same layout on odd and even pages.)

The \oddsidemargin is simply the \papermarginwidth plus the \leftmarginwidth calculated earlier, adjusted by 1 in for the printer driver offset and rounded to full points.

137 \setlength\oddsidemargin {-1in}

138 \addtolength\oddsidemargin {\papermarginwidth}

139 \addtolength\oddsidemargin {\leftmarginwidth}

140 \@settopoint\oddsidemargin

Then \evensidemargin and \marginparwidth are set to \oddsidemargin. \marginparwidth will be modified later.

141 \setlength\evensidemargin {\oddsidemargin}

142 \setlength\marginparwidth {\leftmarginwidth

(12)

\marginparsep \marginparpush

The horizontal space between the main text and marginal notes is determined by \marginparsep (defined in sizexx), the minimum vertical separation between two marginal notes is controlled by \marginparpush which is set to 0 because we will have lots of margin notes. The width of the marginpar is reduced by marginparsep to produce flush left pages.

144 \addtolength\marginparwidth {-\marginparsep}

145 \setlength\marginparpush {0\p@}

146}

Now we call \settextfraction with the default value of 0.7

147\@onlypreamble\settextfraction

148\settextfraction {0.7}

\textheight Now that we have computed the width of the text, we have to take care of the

height. The \textheight is the height of text (including footnotes and figures, excluding running head and foot).

Again we compute this, depending on the papersize and depending on the baselineskip that is used, in order to have a whole number of lines on the page.

149\setlength\@tempdima {\paperheight}

We leave at least a \papermarginwidth margin on the top and the bottom of the page.

150\addtolength\@tempdima{-2\papermarginwidth}

The running headers and footers extend partly into the top and bottom mar-gins.

151\addtolength\@tempdima{-.5in}

Then we divide the result by the current \baselineskip and store this in the count register \@tempcnta, which then contains the number of lines that fit on this page.

152\divide\@tempdima\baselineskip

153\@tempcnta=\@tempdima

From this we can calculate the height of the text.

154\setlength\textheight{\@tempcnta\baselineskip}

The first line on the page has a height of \topskip.

155\advance\textheight by \topskip

6.3.4 Vertical margins

\topmargin The \topmargin is the distance between the top of ‘the printable area’ –which

is 1 inch below the top of the paper– and the top of the box which contains the running head.

It can now be computed from the values set above and rounded to full points.

156\setlength\topmargin {\paperheight}

157\addtolength\topmargin{-\headheight}

(13)

159\addtolength\topmargin{-\textheight}

160\addtolength\topmargin{-\footskip} % this might be wrong!

161\addtolength\topmargin{-.5\topmargin}

162\addtolength\topmargin{-1in}

163\@settopoint\topmargin

By changing the factor in the next line the complete page can be shifted vertically. The contents of the page is shifted up or down by one \baselineskip depend-ing on the pagestyle. Do not combine headdepend-ings and footdepend-ings in one document!

164\setlength\emptyfoottopmargin {\topmargin}

165\addtolength\emptyfoottopmargin{\baselineskip}

166\setlength\emptyheadtopmargin {\topmargin}

167\addtolength\emptyheadtopmargin{-\baselineskip}

6.3.5 Float placement parameters

All float parameters are given default values in the LA_{TEX 2ε kernel. For this reason}

counters only need to be set with \setcounter and other parameters are set using \renewcommand.

Limits for the placement of floating objects

\c@topnumber Thetopnumber counter holds the maximum number of floats that can appear on the top of a text page.

168\setcounter{topnumber} {2}

\topfraction This indicates the maximum part of a text page that can be occupied by floats at the top.

169\renewcommand\topfraction {.7}

\c@bottomnumber Thebottomnumber counter holds the maximum number of floats that can appear on the bottom of a text page.

170\setcounter{bottomnumber} {1}

\bottomfraction This indicates the maximum part of a text page that can be occupied by floats at the bottom.

171\renewcommand\bottomfraction{.3}

\c@totalnumber This indicates the maximum number of floats that can appear on any text page.

172\setcounter{totalnumber} {3}

\textfraction This indicates the minimum part of a text page that has to be occupied by text.

173\renewcommand\textfraction{.2}

\floatpagefraction This indicates the minimum part of a page that has to be occupied by floating objects before a ‘float page’ is produced.

(14)

\c@dbltopnumber Thedbltopnumber counter holds the maximum number of two column floats that can appear on the top of a two column text page.

175\setcounter{dbltopnumber} {2}

\dbltopfraction This indicates the maximum part of a two column text page that can be occupied by two column floats at the top.

176\renewcommand\dbltopfraction{.7}

\dblfloatpagefraction This indicates the minimum part of a page that has to be occupied by two column wide floating objects before a ‘float page’ is produced.

177\renewcommand\dblfloatpagefraction{.5}

6.4 Page Styles

The page style foo is defined by defining the command \ps@foo. This command should make only local definitions. There should be no stray spaces in the defini-tion, since they could lead to mysterious extra spaces in the output (well, that’s something that should be always avoided).

\@evenhead \@oddhead \@evenfoot \@oddfoot

The \ps@... command defines the macros \@oddhead, \@oddfoot, \@evenhead, and \@evenfoot to define the running heads and feet—e.g., \@oddhead is the macro to produce the contents of the heading box for odd-numbered pages. It is called inside an \hbox of width \textwidth.

6.4.1 Marking conventions

To make headings determined by the sectioning commands, the page style defines the commands \chaptermark, \sectionmark, . . . , where \chaptermark{hTEXT i} is called by \chapter to set a mark, and so on.

The \...mark commands and the \...head macros are defined with the help of the following macros. (All the \...mark commands should be initialized to no-ops.)

LA_{TEX extends TEX’s \mark facility by producing two kinds of marks, a ‘left’}

and a ‘right’ mark, using the following commands: \markboth{hLEFT i}{hRIGHT i}: Adds both marks. \markright{hRIGHT i}: Adds a ‘right’ mark.

\leftmark: Used in the \@oddhead, \@oddfoot, \@evenhead or \@evenfoot macros, it gets the current ‘left’ mark. \leftmark works like TEX’s \botmark command.

\rightmark: Used in the \@oddhead, \@oddfoot, \@evenhead or \@evenfoot macros, it gets the current ‘right’ mark. \rightmark works like TEX’s

\firstmark command.

(15)

the right mark is changed by a \section command. However, it does produce somewhat anomalous results if two \markboth’s occur on the same page.

Commands like \tableofcontents that should set the marks in some page styles use a \@mkboth command, which is \let by the pagestyle command (\ps@...) to \markboth for setting the heading or to \@gobbletwo to do nothing.

179% %%%\mark{{}{}} % Initializes TeX’s marks <--- can vanish

6.4.2 Defining the page styles

The pagestyles empty is defined in latex.dtx.

\ps@plain We have to redefine plain to support twoside layout.

180h∗refart | refrepi 181\if@twoside 182 \def\ps@plain{% 183 \let\@mkboth\@gobbletwo 184 \let\@oddhead\@empty 185 \let\@evenhead\@empty 186 \def\@oddfoot{\normalfont\hfil\thepage} 187 \def\@evenfoot{\normalfont\thepage\hfil}} 188\else 189 \def\ps@plain{% 190 \let\@mkboth\@gobbletwo 191 \let\@oddhead\@empty 192 \let\@evenhead\@empty 193 \def\@oddfoot{\normalfont\hfil\thepage} 194 \let\@evenfoot\@oddfoot} 195\fi 196% \end{macrocode} 197% \end{macro} 198% 199% \begin{macro}{\ps@headings}

200% The definition of the page style \pstyle{headings} has to be

201% different for two sided printing than it is for one sided

202% printing.

203%

204% \begin{macrocode}

205\if@twoside

206 \def\ps@headings{%

The running feet are empty in this page style, the running head contains the page number and one of the marks.

(16)

When using this page style, the contents of the running head is determined by the chapter and section titles. So we \let \@mkboth to \markboth.

214 \let\@mkboth\markboth

We shift the page one \baselineskip to the bottom to compensate for the headings.

215 \topmargin\emptyfoottopmargin

For the refart document class we define \sectionmark to clear the right mark and put the number of the section (when it is numbered) and its title in the left mark. The rightmark is set by \subsectionmark to contain the subsection titles. Note the use of ##1 for the parameter of the \sectionmark command, which will be defined when \ps@headings is executed.

217h∗refarti

218 \def\sectionmark##1{%

219 \markboth {\ifnum \c@secnumdepth >\z@

220 \thesection\quad\fi

221 ##1}{}}%

222 \def\subsectionmark##1{%

223 \markright {\ifnum \c@secnumdepth >\@ne

224 \thesubsection\quad\fi

225 ##1}}}

226h/refarti

In the refrep document class we use the \chaptermark and \sectionmark macros to fill the running heads.

Note the use of ##1 for the parameter of the \chaptermark command, which will be defined when \ps@headings is executed.

227h∗refrepi

228 \def\chaptermark##1{%

229 \markboth {\ifnum \c@secnumdepth >\m@ne

230 \@chapapp\ \thechapter \ \fi

231 ##1}{}}%

233 \markright {\ifnum \c@secnumdepth >\z@

234 \thesection \ \fi

235 ##1}}}

236h/refrepi

(17)

243 \vskip 3\p@ \hrule}}%

We use \markright now instead of \markboth as we did for two sided printing.

247h∗refarti

249 \markright {\ifnum \c@secnumdepth >\m@ne

251 ##1}}}

252h/refarti 253h∗refrepi

257 ##1}}}

258h/refrepi 259h∗refart | refrepi 260\fi

\ps@footings The definition of the page style footings has to be different for two sided printing than it is for one sided printing.

261\if@twoside

262 \def\ps@footings{%

The running head is empty in this page style, the running foot contains the page number and one of the marks.

263 \let\@oddhead\@empty\let\@evenhead\@empty 264 \def\@evenfoot{\hss\vbox to \z@{\vss\hsize=\fullwidth 265 \hrule \vskip 3\p@ 266 \hb@xt@\fullwidth{\thepage\hfil\slshape\leftmark}}}% 267 \def\@oddfoot{\hss\vbox to \z@{\vss\hsize=\fullwidth 268 \hrule \vskip 3\p@ 269 \hb@xt@\fullwidth{{\slshape\rightmark}\hfil\thepage}}}%

When using this page style, the contents of the running foot is determined by the chapter and section titles. So we \let \@mkboth to \markboth.

We shift the page one \baselineskip to the top to compensate for the footings.

271 \topmargin\emptyheadtopmargin

(18)

Note the use of ##1 for the parameter of the \sectionmark command, which will be defined when \ps@headings is executed.

273h∗refarti

275 \markboth {\ifnum \c@secnumdepth >\z@

277 ##1}{}}%

278 \def\subsectionmark##1{%

279 \markright {\ifnum \c@secnumdepth >\@ne

280 \thesubsection\quad\fi

281 ##1}}}

282h/refarti

In the refrep document class we use the \chaptermark and \sectionmark macros to fill the running heads.

Note the use of ##1 for the parameter of the \chaptermark command, which will be defined when \ps@footings is executed.

283h∗refrepi

285 \markboth {\ifnum \c@secnumdepth >\m@ne

287 ##1}{}}%

289 \markright {\ifnum \c@secnumdepth >\z@

290 \thesection \ \fi

291 ##1}}}

292h/refrepi

The definition of \ps@footings for one sided printing can be much simpler, because we treat even and odd pages the same. Therefore we don’t need to define \@even.... 293h∗refart | refrepi 294\else 295 \def\ps@footings{% 296 \let\@oddhead\@empty 297 \def\@oddfoot{\hss\vbox to \z@{\vss\hsize=\fullwidth 298 \hrule \vskip 3\p@ 299 \hb@xt@\fullwidth{{\slshape\rightmark}\hfil\thepage}}}% 300 \let\@mkboth\markboth

301 \topmargin\emptyheadtopmargin

We use \markright now instead of \markboth as we did for two sided printing.

303h∗refarti

(19)

313 ##1}}}

314h/refrepi 315h∗refart | refrepi

316\fi

\ps@myheadings The definition of the page style myheadings is fairly simple because the user de-termines the contents of the running head himself by using the \markboth and \markright commands. 317\def\ps@myheadings{% 318 \let\@oddfoot\@empty\let\@evenfoot\@empty 319 \def\@evenhead{\hss\vbox to \z@{\vss\hsize=\fullwidth 320 \hb@xt@\fullwidth{\thepage\hfil\slshape\leftmark} 321 \vskip 3\p@ \hrule}}% 322 \def\@oddhead{\hss\vbox to \z@{\vss\hsize=\fullwidth 323 \hb@xt@\fullwidth{{\slshape\rightmark}\hfil\thepage} 324 \vskip 3\p@ \hrule}}%

We have to make sure that the marking commands that are used by the chapter and section headings are disabled. We do this \letting them to a macro that gobbles its argument(s).

325 \let\@mkboth\@gobbletwo

326h+refrepi \let\chaptermark\@gobble

327 \let\sectionmark\@gobble

328h+refarti \let\subsectionmark\@gobble

330 }

(20)

We have to make sure that the marking commands that are used by the chapter and section footings are disabled. We do this \letting them to a macro that gobbles its argument(s).

339 \let\@mkboth\@gobbletwo

340h+refrepi \let\chaptermark\@gobble

341 \let\sectionmark\@gobble

342h+refarti \let\subsectionmark\@gobble

343 \topmargin\emptyheadtopmargin 344 }

7 Document Markup

7.1 The title

\title \author \date

These three macros are provided by latex.dtx to provide information about the title, author(s) and date of the document. The information is stored away in internal control sequences. It is the task of the \maketitle command to use the information provided. The definitions of these macros are shown here for information.

345% \newcommand*{\title}[1]{\gdef\@title{#1}}

346% \newcommand*{\author}[1]{\gdef\@author{#1}}

347% \newcommand*{\date}[1]{\gdef\@date{#1}}

The \date macro gets today’s date by default.

348% \gdef\@date{\today}

\maketitle The definition of \maketitle depends on whether a separate title page is made. This is the default for refrep. If you want a titlepage with refart you can enable it using the titlepage option.

When we are making a title page, we locally redefine \footnotesize and footnoterule to change the appearance of the footnotes that are produced by the \thanks command.

349\if@titlepage 350 \newcommand\maketitle{\begin{titlepage}% 351 \let\footnotesize\small 352 \let\footnoterule\relax 353 \let\footnote\thanks 354 \renewcommand\thefootnote{\@fnsymbol\c@footnote}% 355 \def\@makefnmark% 356 {\rlap{\@textsuperscript{\normalfont\@thefnmark}}}% 357 \long\def\@makefntext##1{% 358 \@setpar{\@@par 359 \@tempdima = \hsize 360 \advance\@tempdima -1em

361 \parshape \@ne 1em \@tempdima}%

(21)

363 \hb@xt@\z@{\hss\@textsuperscript{\normalfont\@thefnmark}\,}##1}

We center the entire title vertically; the centering is set off a little by adding a \vskip. In compatibility mode the page number is set to 0 to keep the behaviour of LA_{TEX 2.09 style files}

364 \null\vfil

365 \vskip 60\p@

Then we set the title, in a \LARGE font; leave a little space and set the author(s) in a \large font. We do this inside a tabular environment to get them in a single column. Before the date we leave a little whitespace again.

366 \begin{center}%

367 {\LARGE \@title \par}%

368 \vskip 3em% 369 {\large 370 \lineskip .75em% 371 \begin{tabular}[t]{c}% 372 \@author 373 \end{tabular}\par}% 374 \vskip 1.5em%

375 {\large \@date \par}% % Set date in \large size.

376 \end{center}\par

Then we call \@thanks to print the information that goes into the footnote and finish the page.

377 \@thanks

378 \vfil\null

379 \end{titlepage}%

We reset the footnote counter, disable \thanks and \maketitle and save some storage space by emptying the internal information macros.

380 \setcounter{footnote}{0}% 381 \global\let\thanks\relax 382 \global\let\maketitle\relax 383 \global\let\@thanks\@empty 384 \global\let\@author\@empty 385 \global\let\@date\@empty 386 \global\let\@title\@empty

After the title is set the declaration commands \title, etc. can vanish. The definition of \and makes only sense within the argument of \author so this can go as well. 387 \global\let\title\relax 388 \global\let\author\relax 389 \global\let\date\relax 390 \global\let\and\relax 391 }

(22)

Therefore we first start a new group to keep changes local. Then we redefine \thefootnote to use \fnsymbol; and change \@makefnmark so that footnotemarks have zero width (to make the centering of the author names look better).

392\else 393 \newcommand\maketitle{\par 394 \begingroup 395 \renewcommand\thefootnote{\@fnsymbol\c@footnote}% 396 \def\@makefnmark% 397 {\rlap{\@textsuperscript{\normalfont\@thefnmark}}}% 398 \long\def\@makefntext##1{% 399 \@setpar{\@@par 400 \@tempdima = \hsize 401 \advance\@tempdima -1em

402 \parshape \@ne 1em \@tempdima}%

403 \par\parindent 1em \noindent

404 \hb@xt@\z@{\hss\@textsuperscript{\normalfont\@thefnmark}\,}##1}

If this is a twocolumn document we start a new page in two-column mode, with the title set to the full width of the text. The actual printing of the title information is left to \@maketitle. 405 \if@twocolumn 406 \ifnum \col@number=\@ne 407 \@maketitle 408 \else 409 \twocolumn[\@maketitle]% 410 \fi 411 \else

When this is not a two-column document we just start a new page, prevent floating objects from appearing on the top of this page and print the title information.

412 \newpage

413 \global\@topnum\z@ % Prevents figures from going at top of page.

414 \@maketitle

415 \fi

This page gets a empty layout. We call \@thanks to produce the footnotes.

416 \thispagestyle{empty}\@thanks

Now we can close the group, reset the footnote counter, disable \thanks, \maketitle and \@maketitle and save some storage space by emptying the in-ternal information macros.

(23)

426 \global\let\title\relax

427 \global\let\author\relax

428 \global\let\date\relax

429 \global\let\and\relax

430}

\@maketitle This macro takes care of formatting the title information when we have no separate title page.

We always start a new page and put the title flush left using a \Large bold font with thick rules above and below. Then we put the autor information flush right in slanted type. This title will allways show the date unless it is set to nothing, using the \date{} command.

431 \def\@maketitle{%

432 \newpage

433 \null

434 \longthickrule\vskip1.5em%

435 \let \footnote \thanks

436 {\secshape \parskip\z@ \parindent\z@

437 \Large\bfseries \@title \par}%

438 \vskip1.5em\longthickrule\vskip1.5em% 439 {\normalsize 440 \lineskip .5em% 441 \begin{flushright}% 442 {\slshape\@author\par} 443 \vskip 1em% 444 {\@date}% 445 \end{flushright}\par}% 446 \vskip 1.5em} 447\fi

7.2 Chapters and Sections

7.2.1 Building blocks

The definitions in this part of the class file make use of two macros, \@startsection and \secdef, which are defined by latex.dtx. They are not described here, see the classes.dtx for more information.

7.2.2 Mark commands \chaptermark \sectionmark \subsectionmark \subsubsectionmark \paragraphmark \subparagraphmark

Default initializations of \...mark commands. These commands are used in the definition of the page styles (see section 6.4.2) Most of them are already defined by latex.dtx, so they are only shown here.

(24)

7.2.3 Define Counters

\c@secnumdepth The value of the countersecnumdepthgives the depth of the highest-level sectioning command that is to produce section numbers.

454h+refarti\setcounter{secnumdepth}{3} 455h+refrepi\setcounter{secnumdepth}{2} \c@part \c@chapter \c@section \c@subsection \c@subsubsection \c@paragraph \c@subparagraph

These counters are used for the section numbers. The macro \newcounter{hnewctr i}[holdctr i] defines hnewctr i to be a counter, which is reset to zero when counter holdctr i is

stepped. Counter holdctr i must already be defined.

456\newcounter {part} 457h+refarti\newcounter {section} 458h∗refrepi 459\newcounter {chapter} 460\newcounter {section}[chapter] 461h/refrepi 462\newcounter {subsection}[section] 463\newcounter {subsubsection}[subsection] 464\newcounter {paragraph}[subsubsection] 465\newcounter {subparagraph}[paragraph] \thepart \thechapter \thesection \thesubsection \thesubsubsection \theparagraph \thesubparagraph

For any counter CTR, \theCTR is a macro that defines the printed version of counterCTR. It is defined in terms of the following macros:

\arabic{COUNTER} prints the value ofCOUNTERas an arabic numeral. \roman{COUNTER} prints the value ofCOUNTERas a lowercase roman num-beral.

\Roman{COUNTER} prints the value of COUNTER as an uppercase roman numberal.

\alph{COUNTER} prints the value ofCOUNTERas a lowercase letter: 1 = a, 2 = b, etc.

\Alph{COUNTER} prints the value of COUNTER as an uppercase letter: 1 = A, 2 = B, etc. 466\renewcommand\thepart {\@Roman\c@part} 467h+refarti\renewcommand\thesection {\@arabic\c@section} 468h∗refrepi 469\renewcommand\thechapter {\@arabic\c@chapter} 470\renewcommand\thesection {\thechapter.\@arabic\c@section} 471h/refrepi 472\renewcommand\thesubsection {\thesection.\@arabic\c@subsection}

473\renewcommand\thesubsubsection {\thesubsection .\@arabic\c@subsubsection}

474\renewcommand\theparagraph {\thesubsubsection.\@arabic\c@paragraph}

475\renewcommand\thesubparagraph {\theparagraph.\@arabic\c@subparagraph} \@chapapp \@chapapp is initially defined to be empty. The \appendix command redefines it

to be ‘\appendixname’.

(25)

7.2.4 Parts

\part The command to start a new part of our document.

In the refart class the definition of \part is rather simple; we start a new para-graph, add a little whitespace, suppress the indentation of the first paragraph and make use of \@secdef. As in other sectioning commands (cf. \@startsection in the LA_{TEX 2ε kernel), we need to check the @noskipsec switch and force horizontal}

mode if it is set.

477h∗refarti

478\newcommand\part{%

479 \if@noskipsec \leavevmode \fi

480 \par

481 \addvspace{4ex}%

482 \@afterindentfalse

483 \secdef\@part\@spart}

484h/refarti

For the refrep class things are a bit different.

We start a new (righthand) page and use the empty.

485h∗refrepi 486\newcommand\part{% 487 \if@openright 488 \cleardoublepage 489 \else 490 \clearpage 491 \fi 492 \thispagestyle{empty}%

When we are making a two column document, this will be a one column page. We use @tempswa to remember to switch back to two columns.

493 \if@twocolumn 494 \onecolumn 495 \@tempswatrue 496 \else 497 \@tempswafalse 498 \fi

We need an empty box to prevent the fill glue from disappearing.

499 \null\vfil

Here we use \secdef to indicate which commands to use to make the actual heading.

500 \secdef\@part\@spart}

501h/refrepi

\@part This macro does the actual formatting of the title of the part. Again the macro is differently defined for the refart document class than for the document class refrep.

(26)

502h∗refart | refrepi 503\def\@part[#1]#2{%

504h+refarti \ifnum \c@secnumdepth >\m@ne

505h+refrepi \ifnum \c@secnumdepth >-2\relax

506 \refstepcounter{part}%

507 \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}%

508 \else

509 \addcontentsline{toc}{part}{#1}%

510 \fi

We print the title flush left, we also prevent breaking between lines and reset the font.

511 \longrule\medskip

512 {\parindent \z@ \raggedright

513 \interlinepenalty \@M

514 \normalfont

When this is a numbered part we have to print the number and the title. The \nobreak should prevent a page break here.

515 \Large

516h+refarti \ifnum \c@secnumdepth >\m@ne

517h+refrepi \ifnum \c@secnumdepth >-2 \relax

518 \thepart.\quad

519 \fi

520 #2\par \medskip

521 \longrule\bigskip%

Then we empty the mark registers, leave some whitespace and call \@afterheading to takes care of suppressing the indentation.

522 \markboth{}{}\par}%

523 \nobreak

524 \vskip 3ex

525 \@afterheading}

\@spart This macro does the actual formatting of the title of the part when the star form of the user command was used. In this case we never print a number. Otherwise the formatting is the same.

(27)

7.2.5 Chapters

\chapter A chapter should always start on a new page therefore we start by calling

\clearpage and setting the pagestyle for this page to plain.

539h∗refrepi

540\newcommand\chapter{\if@openright\cleardoublepage\else\clearpage\fi

541 \if@pageperchapter\setcounter{page}{1}\fi

542 \thispagestyle{empty}%

Then we prevent floats from appearing at the top of this page because it looks weird to see a floating object above a chapter title.

543 \global\@topnum\z@

Then we suppress the indentation of the first paragraph by setting the switch \@afterindent to false. We use \secdef to specify the macros to use for actually setting the chapter title.

544 \@afterindentfalse

545 \secdef\@chapter\@schapter}

\@chapter This macro is called when we have a numbered chapter. When secnumdepth is larger than −1 we display the chapter number. We also inform the user that a new chapter is about to be typeset by writing a message to the terminal.

546\def\@chapter[#1]#2{\ifnum \c@secnumdepth >\m@ne

547 \refstepcounter{chapter}% 548 \typeout{\@chapapp\space\thechapter.}% 549 \addcontentsline{toc}{chapter}% 550 {\protect\numberline{\thechapter}#1}% 551 \else 552 \addcontentsline{toc}{chapter}{#1} 553 \fi

After having written an entry to the table of contents we store the (alternative) title of this chapter with \chaptermark and add some whitespace to the lists of figures and tables.

554 \chaptermark{#1}%

555 \addtocontents{lof}{\protect\addvspace{10\p@}}%

556 \addtocontents{lot}{\protect\addvspace{10\p@}}%

Then we call upon \@makechapterhead to format the actual chapter title. We have to do this in a special way when we are in two-column mode in order to have the chapter title use the entire \textwidth. In one column mode we call \@afterheading which takes care of suppressing the indentation.

557 \if@twocolumn 558 \@topnewpage[\@makechapterhead{#2}]% 559 \else 560 \@makechapterhead{#2}% 561 \@afterheading 562 \fi}

(28)

We begin by leaving some whitespace. The we open a group in which we have a paragraph indent of 0pt, and in which we have the text set ragged right. We also reset the font.

563\def\@makechapterhead#1{%

564 \longthickrule\bigskip%

565 {\parindent \z@ \secshape \normalfont \Large\bfseries

Then we check whether the number of the chapter has to be printed. If so we leave some whitespace between the chapternumber and its title.

566 \@hangfrom{\ifnum \c@secnumdepth >\m@ne

567 \@chapapp\space \thechapter\quad

568 \fi}%

Now we set the title in a large bold font. We prevent a page break at this point and leave some whitespace before the text begins.

569 #1\par}

570 \bigskip\longthickrule\bigskip

571 }

\@schapter This macro is called when we have an unnumbered chapter. It is much simpler than \@chapter because it only needs to typeset the chapter title.

572\def\@schapter#1{\if@twocolumn 573 \@topnewpage[\@makeschapterhead{#1}]% 574 \else 575 \@makeschapterhead{#1}% 576 \@afterheading 577 \fi}

\@makeschapterhead The macro above uses \@makeschapterheadhtext ito format the heading of the chapter. It is similar to \@makechapterhead except that it never has to print a chapter number.

578\def\@makeschapterhead#1{%

579 \longthickrule\bigskip%

580 {\parindent \z@ \secshape \normalfont

581 \Large \bfseries #1\par}

582 \bigskip\longthickrule\bigskip

583 }

584h/refrepi

7.2.6 Lower level headings

\secshape

585\newcommand\secshape{\leftskip=-\leftmarginwidth%

586 \rightskip=\@flushglue%

587 \hyphenpenalty=2000}

(29)

\section This gives a normal heading with whitespace above and below the heading, the title set in \large\bfseries, and no indentation on the first paragraph.

588\newcommand\section{\@startsection {section}{1}{\z@}%

589 {-2ex \@plus -1ex \@minus -.2ex}%

590 {0.5ex \@plus .2ex}%

591 {\secshape\normalfont\large\bfseries}} \subsection This gives a normal heading with whitespace above and below the heading, the

title set in \large\bfseries, and no indentation on the first paragraph.

592\newcommand\subsection{\@startsection{subsection}{2}{\z@}%

593 {-1.5ex\@plus -.5ex \@minus -.2ex}%

594 {0.5ex \@plus .2ex}%

595 {\secshape\normalfont\normalsize\bfseries}} \subsubsection This gives a normal heading with whitespace above and below the heading, the

title set in \normalsize\bfseries, and no indentation on the first paragraph.

596\newcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}%

597 {-1.5ex\@plus -.5ex \@minus -.2ex}%

598 {0.5ex \@plus .2ex}%

599 {\secshape\normalfont\normalsize\mdseries}} \paragraph This gives a run-in heading with whitespace above and to the right of the heading,

the title set in \normalsize\bfseries.

600\newcommand\paragraph{\@startsection{paragraph}{4}{\z@}%

601 {2ex\@plus 1ex \@minus .2ex}%

602 {-1em}%

603 {\normalfont\normalsize\bfseries}} \subparagraph This gives an indented run-in heading with whitespace above and to the right of

the heading, the title set in \normalsize\bfseries.

604\newcommand\subparagraph{\@startsection{subparagraph}{5}{\parindent}%

605 {2ex \@plus 1ex \@minus .2ex}%

606 {-1em}%

607 {\normalfont\normalsize\bfseries}}

7.3 Lists

7.3.1 General List Parameters

The following commands are used to set the default values for the list environ-ment’s parameters. See the LA_{TEX manual for an explanation of the meanings}

(30)

\leftmargin \leftmargini \leftmarginii \leftmarginiii \leftmarginiv \leftmarginv \leftmarginvi

For efficiency, level-one list’s values are defined at top level, and \@listi is defined to set only \leftmargin.

When we are in two column mode some of the margins are set somewhat smaller. 608\if@twocolumn 609 \setlength\leftmargini {2em} 610\else 611 \setlength\leftmargini {2.5em} 612\fi

The following three are calculated so that they are larger than the sum of \labelsep and the width of the default labels (which are ‘(m)’, ‘vii.’ and ‘M.’).

613\setlength\leftmarginii {2.2em} 614\setlength\leftmarginiii {1.87em} 615\setlength\leftmarginiv {1.7em} 616\if@twocolumn 617 \setlength\leftmarginv {.5em} 618 \setlength\leftmarginvi {.5em} 619\else 620 \setlength\leftmarginv {1em} 621 \setlength\leftmarginvi {1em} 622\fi

Here we set the top level leftmargin.

623\setlength\leftmargin {\leftmargini} \labelsep

\labelwidth

\labelsep is the distance between the label and the text of an item; \labelwidth is the width of the label.

624\setlength \labelsep {.5em}

625\setlength \labelwidth{\leftmargini}

626\addtolength\labelwidth{-\labelsep} \@beginparpenalty

\@endparpenalty

These penalties are inserted before and after a list or paragraph environment. They are set to a bonus value to encourage page breaking at these points.

\@itempenalty This penalty is inserted between list items.

627h∗refart | refrepi 628\@beginparpenalty -\@lowpenalty 629\@endparpenalty -\@lowpenalty 630\@itempenalty -\@lowpenalty 631h/refart | refrepi \@listI \@listi

(31)

We have to initialise these parameters. 638\@listi \@listii \@listiii \@listiv \@listv \@listvi

Here are the same macros for the higher level lists.

639\def\@listii {\leftmargin\leftmarginii 640 \labelwidth\leftmarginii 641 \advance\labelwidth-\labelsep 642 \topsep \z@ 643 \parsep \parskip 644 \itemsep \z@} 645\def\@listiii{\leftmargin\leftmarginiii 646 \labelwidth\leftmarginiii 647 \advance\labelwidth-\labelsep 648 \topsep \z@ 649 \parsep \parskip 650 \partopsep \z@ 651 \itemsep \topsep} 652\def\@listiv {\leftmargin\leftmarginiv 653 \labelwidth\leftmarginiv 654 \advance\labelwidth-\labelsep} 655\def\@listv {\leftmargin\leftmarginv 656 \labelwidth\leftmarginv 657 \advance\labelwidth-\labelsep} 658\def\@listvi {\leftmargin\leftmarginvi 659 \labelwidth\leftmarginvi 660 \advance\labelwidth-\labelsep} 661h∗refart | refrepi 7.3.2 Enumerate

The enumerate environment uses four counters: enumi,enumii,enumiiiandenumiv, whereenumN controls the numbering of the Nth level enumeration.

\theenumi \theenumii \theenumiii \theenumiv

The counters are already defined in latex.dtx, but their representation is changed here. 662h∗refart | refrepi 663\renewcommand\theenumi {\@arabic\c@enumi} 664\renewcommand\theenumii {\@alph\c@enumii} 665\renewcommand\theenumiii{\@roman\c@enumiii} 666\renewcommand\theenumiv {\@Alph\c@enumiv} \labelenumi \labelenumii \labelenumiii \labelenumiv

The label for each item is generated by the commands \labelenumi ... \labelenumiv.

667\newcommand\labelenumi {\theenumi.} 668\newcommand\labelenumii {(\theenumii)} 669\newcommand\labelenumiii{\theenumiii.} 670\newcommand\labelenumiv {\theenumiv.} \p@enumii \p@enumiii \p@enumiv

(32)

671\renewcommand\p@enumii {\theenumi} 672\renewcommand\p@enumiii {\theenumi(\theenumii)} 673\renewcommand\p@enumiv {\p@enumiii\theenumiii} 7.3.3 Itemize \labelitemi \labelitemii \labelitemiii \labelitemiv

Itemization is controlled by four commands: \labelitemi, \labelitemii, \labelitemiii, and \labelitemiv, which define the labels of the various item-ization levels: the symbols used are bullet, bold en-dash, asterisk and centred dot.

674\newcommand\labelitemi {\textbullet}

675\newcommand\labelitemii {\normalfont\bfseries \textendash}

676\newcommand\labelitemiii{\textasteriskcentered}

677\newcommand\labelitemiv {\textperiodcentered}

7.3.4 Description

description The description environment is defined here – while the itemize and enumerate environments are defined in latex.dtx.

678\newenvironment{description} 679 {\list{}{% 680 \labelsep\marginparsep 681 \labelwidth\leftmarginwidth 682 \advance\labelwidth by \leftmargin 683 \advance\labelwidth by -\labelsep 684 \let\makelabel\descriptionlabel}} 685 {\endlist}

\descriptionlabel To change the formatting of the label, you must redefine \descriptionlabel.

686\newcommand*\descriptionlabel[1]{%

687 \ifdescriptionleft\else \hfil\fi

688 \normalfont #1 \ifdescriptioncolon :\fi

689 \ifdescriptionleft \hfil \fi}

7.4 Defining new environments

7.4.1 Abstract

abstract When we are producing a separate titlepage we also put the abstract on a page of its own. It will be centred vertically on the page.

(33)

698 \end{center}}

699 {\par\vfil\null\endtitlepage}

When we are not making a separate titlepage –the default for the refart document class– we have to check if we are in twocolumn mode. In that case the abstract is as a \section*, otherwise the quote environment is used to typeset the abstract.

700\else 701 \newenvironment{abstract}{% 702 \if@twocolumn 703 \section*{\abstractname}% 704 \else 705 \small 706 \begin{center}% 707 {\bfseries \abstractname\vspace{-.5em}\vspace{\z@}}% 708 \end{center}% 709 \quote 710 \fi} 711 {\if@twocolumn\else\endquote\fi} 712\fi 7.4.2 Verse

verse The verse environment is defined by making clever use of the list environment’s parameters. The user types \\ to end a line. This is implemented by \let’ing \\ equal \@centercr. 713\newenvironment{verse} 714 {\let\\=\@centercr 715 \list{}{\itemsep \z@ 716 \itemindent -1.5em% 717 \listparindent\itemindent 718 \rightmargin \leftmargin 719 \advance\leftmargin 1.5em}% 720 \item\relax} 721 {\endlist} 7.4.3 Quotation

quotation The quotation environment is also defined by making clever use of the list environ-ment’s parameters. The lines in the environment are set smaller than \textwidth. The first line of a paragraph inside this environment is indented.

(34)

7.4.4 Quote

quote The quote environment is like the quotation environment except that paragraphs

are not indented.

729\newenvironment{quote}

730 {\list{}{\rightmargin\leftmargin}%

731 \item\relax}

732 {\endlist}

7.4.5 Example

\example The example environment is a verse environment with tt font which tries to avoid page brakes at the \begin{example}.

733\newenvironment{example} 734 {\@beginparpenalty=\@highpenalty 735 \let\\=\@centercr 736 \list{}{\itemsep \z@ 737 \itemindent -1.5em% 738 \listparindent\itemindent 739 \rightmargin \leftmargin 740 \advance\leftmargin 1.5em}% 741 \ttfamily 742 \item\relax} 743 {\endlist} 7.4.6 Theorem

This document class does not define its own theorem environments, the defaults supplied by latex.dtx are available.

7.4.7 Titlepage

titlepage In the normal environments, the titlepage environment does nothing but start and

end a page, and inhibit page numbers. It also resets the page number to zero. In two-column style, it still makes a one-column page.

744\newenvironment{titlepage} 745 {\if@twocolumn 746 \@restonecoltrue\onecolumn 747 \else 748 \@restonecolfalse\newpage 749 \fi 750 \thispagestyle{empty}% 751 \setcounter{page}\@ne 752 }

753 {\if@restonecol\twocolumn \else \newpage \fi

754 \if@twoside\else

755 \setcounter{page}\@ne

756 \fi

(35)

7.4.8 Appendix

\appendix The \appendix command is not really an environment, it is a macro that makes

some changes in the way things are done.

In the article document class the \appendix command must do the following: • reset the section and subsection counters to zero,

• redefine \thesection to produce alphabetic appendix numbers.

758h∗refarti 759\newcommand\appendix{\par 760 \setcounter{section}{0}% 761 \setcounter{subsection}{0}% 762 \gdef\thesection{\@Alph\c@section}} 763h/refarti

In the report and book document classes the \appendix command must do the following:

• issue a \newpage if pageperchapter is defined, otherwise the page number would come out wrong.

• reset the chapter and section counters to zero, • set \@chapapp to \appendixname (for messages),

• redefine the chapter counter to produce appendix numbers,

• possibly redefine the \chapter command if appendix titles and headings are to look different from chapter titles and headings.

764h∗refrepi 765\newcommand\appendix{\par 766 \if@pageperchapter\newpage\fi 767 \setcounter{chapter}{0}% 768 \setcounter{section}{0}% 769 \gdef\@chapapp{\appendixname}% 770 \gdef\thechapter{\@Alph\c@chapter}} 771h/refrepi

7.5 Setting parameters for existing environments

7.5.1 Array and tabular

\arraycolsep The columns in an array environment are separated by 2\arraycolsep.

772\setlength\arraycolsep {5\p@}

\tabcolsep The columns in an tabular environment are separated by 2\tabcolsep.

(36)

\arrayrulewidth The width of rules in the array and tabular environments is given by \arrayrulewidth.

774\setlength\arrayrulewidth{.4\p@}

\doublerulesep The space between adjacent rules in the array and tabular environments is given by \doublerulesep.

775\setlength\doublerulesep {2\p@}

7.5.2 Tabbing

\tabbingsep This controls the space that the \’ command puts in. (See LATEX manual for an

explanation.)

776\setlength\tabbingsep {\labelsep}

7.5.3 Minipage

\@minipagerestore The macro \@minipagerestore is called upon entry to a minipage environment to set up things that are to be handled differently inside a minipage environment. In the current styles, it does nothing.

\@mpfootins Minipages have their own footnotes; \skip\@mpfootins plays same rˆole for foot-notes in a minipage as \skip\footins does for ordinary footfoot-notes.

777\skip\@mpfootins = \skip\footins

7.5.4 Framed boxes

\fboxsep The space left by \fbox and \framebox between the box and the text in it.

\fboxrule The width of the rules in the box made by \fbox and \framebox.

778\setlength\fboxsep {3\p@}

779\setlength\fboxrule{.4\p@}

7.5.5 Equation and eqnarray

\theequation The equation counter will be reset at beginning of a new chapter and the equation number will be prefixed by the chapter number.

This code must follow the \chapter definition, or more exactly the definition of the chapter counter.

780h+refarti\renewcommand\theequation{\@arabic\c@equation} 781h∗refrepi

782\@addtoreset{equation}{chapter}

783\renewcommand\theequation

784{\ifnum \c@chapter>\z@ \thechapter.\fi \@arabic\c@equation}

785h/refrepi

\jot \jot is the extra space added between lines of an eqnarray environment. The default value is used.

(37)

\@eqnnum The macro \@eqnnum defines how equation numbers are to appear in equations. Again the default is used.

787% \def\@eqnnum{(\theequation)}

7.6 Floating objects

The file latex.dtx only defines a number of tools with which floating objects can be defined. This is done in the document class. It needs to define the following macros for each floating object of type TYPE (e.g., TYPE = figure).

\fps@TYPE The default placement specifier for floats of type TYPE.

\ftype@TYPE The type number for floats of type TYPE. Each TYPE has associated a unique positive TYPE number, which is a power of two. E.g., figures might have type number 1, tables type number 2, programs type number 4, etc. \ext@TYPE The file extension indicating the file on which the contents list for float

type TYPE is stored. For example, \ext@figure = ‘lof’.

\fnum@TYPE A macro to generate the figure number for a caption. For example, \fnum@TYPE == ‘Figure \thefigure’.

\@makecaptionhnum ihtext i A macro to make a caption, with hnumi the value produced by \fnum@... and htext i the text of the caption. It can assume it’s in a \parbox of the appropriate width. This will be used for all floating objects.

The actual environment that implements a floating object such as a figure is de-fined using the macros \@float and \end@float, which are dede-fined in latex.dtx. An environment that implements a single column floating object is started with \@float{TYPE}[hplacement i] of type TYPE with hplacement i as the placement specifier. The default value of hPLACEMENT i is defined by \fps@TYPE.

The environment is ended by \end@float. E.g., \figure == \@floatfigure, \endfigure == \end@float.

7.6.1 Figure

Here is the implementation of the figure environment.

\c@figure First we have to allocate a counter to number the figures. In the report and book

document classes the figures are numbered per chapter.

788h∗refarti

789\newcounter{figure}

790\renewcommand \thefigure {\@arabic\c@figure}

793\newcounter{figure}[chapter]

794\renewcommand\thefigure

795 {\ifnum \c@chapter>\z@ \thechapter.\fi \@arabic\c@figure}

(38)

\fps@figure \ftype@figure \ext@figure \num@figure

Here are the parameters for the floating objects of type ‘figure’.

797\def\fps@figure{tbp} 798\def\ftype@figure{1} 799\def\ext@figure{lof} 800\def\fnum@figure{\figurename~\thefigure} figure figure*

Here is the definition of the actual environment. The form with the * is used for double column figures.

801\newenvironment{figure} 802 {\@float{figure}} 803 {\end@float} 804\newenvironment{figure*} 805 {\@dblfloat{figure}} 806 {\end@dblfloat} 7.6.2 Table

Here is the implementation of the table environment. It is very much the same as the figure environment.

\c@table First we have to allocate a counter to number the tables. In the report and book document classes the tables are numbered per chapter.

807h∗refarti 808\newcounter{table} 809\renewcommand\thetable{\@arabic\c@table} 810h/refarti 811h∗refrepi 812\newcounter{table}[chapter] 813\renewcommand\thetable%

814 {\ifnum \c@chapter>\z@ \thechapter.\fi \@arabic\c@table}

815h/refrepi

\fps@table \ftype@table \ext@table \num@table

Here are the parameters for the floating objects of type ‘table’.

816\def\fps@table{tbp} 817\def\ftype@table{2} 818\def\ext@table{lot} 819\def\fnum@table{\tablename~\thetable} table table*

Here is the definition of the actual environment. The form with the * is used for double column tables.

(39)

7.6.3 Captions

\@makecaption The \caption command calls \@makecaption to format the caption of floating

objects. It gets two arguments, hnumber i, the number of the floating object and htext i, the text of the caption. Usually hnumber i contains a string such as ‘Figure 3.2’. The macro can assume it is called inside a \parbox of right width, with \normalsize.

\abovecaptionskip \belowcaptionskip

These lengths contain the amount of whitespace to leave above and below the caption.

826\newlength\abovecaptionskip

827\newlength\belowcaptionskip

828\setlength\abovecaptionskip{10\p@}

829\setlength\belowcaptionskip{0\p@}

The definition of this macro is \long in order to allow more then one paragraph in a caption.

830\long\def\@makecaption#1#2{%

831 \vskip\abovecaptionskip

We want to see if the caption fits on one line on the page, therefore we first typeset it in a temporary box.

832 \sbox\@tempboxa{#1: #2}%

We can the measure its width. If that is larger than the current \hsize we typeset the caption as an ordinary paragraph.

833 \ifdim \wd\@tempboxa >\hsize

834 #1: #2\par

If the caption fits, we center it.

835 \else 836 \global \@minipagefalse 837 \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}% 838 \fi 839 \vskip\belowcaptionskip}

7.7 Font changing

Here we supply the declarative font changing commands that were common in LA_{TEX version 2.09 and earlier. These commands work in text mode and in}

math mode. They are provided for compatibility, but one should start using the \text... and \math... commands instead. These commands are defined using \@newfontswitch, a command with three arguments: the user command to be defined; LA_{TEX commands to execute in text mode and L}A_{TEX commands to}

execute in math mode.

\rm \tt \sf

The commands to change the family. When in compatibility mode we select the ‘default’ font first, to get LA_{TEX2.09 behviour.}

(40)

841\DeclareOldFontCommand{\sf}{\normalfont\sffamily}{\mathsf}

842\DeclareOldFontCommand{\tt}{\normalfont\ttfamily}{\mathtt}

\bf The command to change to the bold series. One should use \mdseries to explicitly switch back to medium series.

843\DeclareOldFontCommand{\bf}{\normalfont\bfseries}{\mathbf} \sl

\it \sc

Here are the commands to change the shape of the font. The slanted and small caps shapes are not available by default as math alphabets, so those changes do nothing in math mode. One should use \upshape to explicitly change back to the upright shape. 844\DeclareOldFontCommand{\it}{\normalfont\itshape}{\mathit} 845\DeclareOldFontCommand{\sl}{\normalfont\slshape}{\@nomath\sl} 846\DeclareOldFontCommand{\sc}{\normalfont\scshape}{\@nomath\sc} \cal \mit

The commands \cal and \mit should only be used in math mode, outside math mode they have no effect. Currently the New Font Selection Scheme defines these commands to generate warning messages. Therefore we have to define them ‘by hand’.

847\DeclareRobustCommand*{\cal}{\@fontswitch\relax\mathcal}

848\DeclareRobustCommand*{\mit}{\@fontswitch\relax\mathnormal}

8 Cross Referencing

8.1 Table of Contents, etc.

A \section command writes a \contentsline{section}{htitlei}{hpagei} com-mand on the .toc file, where htitlei contains the contents of the entry and hpagei is the page number. If sections are being numbered, then htitlei will be of the form \numberline{hnumi}{hheadingi} where hnumi is the number produced by \thesection. Other sectioning commands work similarly.

A \caption command in a ‘figure’ environment writes

\contentsline{figure}{\numberline{hnumi}{ hcaptioni}}{hpagei} on the .lof file, where hnumi is the number produced by \thefigure and hcaptioni is the figure caption. It works similarly for a ‘table’ environment.

The command \contentsline{hnamei} expands to \l@hnamei. So, to specify the table of contents, we must define \l@chapter, \l@section, \l@subsection, ... ; to specify the list of figures, we must define \l@figure; and so on. Most of these can be defined with the \@dottedtocline command, which works as follows.

\@dottedtocline{hlevel i}{hindent i}{hnumwidthi}{htitlei}{hpagei}

hlevel i An entry is produced only ifh level i <= value of the tocdepth counter. Note, \chapter is level 0, \section is level 1, etc.

(41)

hnumwidth i The width of a box in which the section number is to go, if htitlei includes a \numberline command.

\@pnumwidth \@tocrmarg \@dotsep

This command uses the following three parameters, which are set with a \newcommand (so em’s can be used to make them depend upon the font).

\@pnumwidth The width of a box in which the page number is put.

\@tocrmarg The right margin for multiple line entries. One wants \@tocrmarg ≥ \@pnumwidth

\@dotsep Separation between dots, in mu units. Should be defined as a number like 2 or 1.7 849\newcommand\@pnumwidth{1.55em} 850\newcommand\@tocrmarg {2.55em} 851\newcommand\@dotsep {4.5} 852h+refarti\setcounter{tocdepth}{3} 853h+refrepi\setcounter{tocdepth}{2} 8.1.1 Table of Contents

\tableofcontents This macro is used to request that LA_{TEX produces a table of contents. In the}

report and book document classes the tables of contents, figures, etc. are always set in single-column style.

854\newcommand\tableofcontents{% 855h∗refrepi 856 \if@twocolumn 857 \@restonecoltrue\onecolumn 858 \else 859 \@restonecolfalse 860 \fi

The title is set using the \chapter* command, making sure that the running head –if one is required– contains the right information.

861 \chapter*{\contentsname

862h/refrepi

863h+refarti \section*{\contentsname

864 \@mkboth{\contentsname}{\contentsname}}%

The the actual table of contents is made by calling \@starttoc{toc}. After that, we restore twocolumn mode if necessary.

865 \@starttoc{toc}%

866 \if@restonecol\twocolumn\fi

867 }

(42)

First we make sure that if a page break should occur, it occurs before this entry. Also a little whitespace is added and a group begun to keep changes local.

868\newcommand*\l@part[2]{%

869 \ifnum \c@tocdepth >-2\relax

870h+refarti \addpenalty\@secpenalty

871h+refrepi \addpenalty{-\@highpenalty}%

872 \addvspace{2.25em \@plus\p@}%

873 \begingroup

The we set \parindent to 0pt and use \rightskip to leave enough room for the page numbers. To prevent overfull box messages the \parfillskip is set to a negative value.

874 \parindent \z@ \rightskip \@pnumwidth

875 \parfillskip -\@pnumwidth

Now we can set the entry, in a large bold font. We make sure to leave vertical mode, set the part title and add the page number, set flush right.

876 {\leavevmode

877 \large \bfseries #1\hfil \hbox to\@pnumwidth{\hss #2}}\par

Prevent a page break immediately after this entry, but use \everypar to reset the \if@nobreak switch. Finally we close the group.

878 \nobreak

879 \global\@nobreaktrue

880 \everypar{\global\@nobreakfalse\everypar{}}%

881 \endgroup

882 \fi}

\l@chapter This macro formats the entries in the table of contents for chapters. It is very similar to \l@part

First we make sure that if a page break should occur, it occurs before this entry. Also a little whitespace is added and a group begun to keep changes local.

883h∗refrepi

884\newcommand*\l@chapter[2]{%

885 \ifnum \c@tocdepth >\m@ne

886 \addpenalty{-\@highpenalty}%

887 \vskip 1.0em \@plus\p@

The macro \numberline requires that the width of the box that holds the part number is stored in LA_{TEX’s scratch register \@tempdima. Therefore we put}

it there. We begin a group, and change some of the paragraph parameters.

888 \setlength\@tempdima{1.5em}%

889 \begingroup

890 \parindent \z@ \rightskip \@pnumwidth

891 \parfillskip -\@pnumwidth

Then we leave vertical mode and switch to a bold font.