summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/refman
diff options
context:
space:
mode:
authorManuel Pégourié-Gonnard <mpg@elzevir.fr>2008-07-07 13:54:04 +0000
committerManuel Pégourié-Gonnard <mpg@elzevir.fr>2008-07-07 13:54:04 +0000
commit86d7ee7f07e962b1b62426b2db62a35ea40be057 (patch)
tree8828497c1920c77158cc0f9392fb3eb9c6a6ee59 /Master/texmf-dist/source/latex/refman
parent12372868dcef43b25fba8b547b8ef2fbb33690c6 (diff)
refman update
git-svn-id: svn://tug.org/texlive/trunk@9332 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/refman')
-rw-r--r--Master/texmf-dist/source/latex/refman/refman.dtx272
1 files changed, 175 insertions, 97 deletions
diff --git a/Master/texmf-dist/source/latex/refman/refman.dtx b/Master/texmf-dist/source/latex/refman/refman.dtx
index bc3fa2875c8..ebec8d9cd55 100644
--- a/Master/texmf-dist/source/latex/refman/refman.dtx
+++ b/Master/texmf-dist/source/latex/refman/refman.dtx
@@ -1,7 +1,7 @@
% \iffalse meta-comment
%
% Copyright 1988 - 94 by H. Partl.
-% Copyright 1994 - 2003 by Axel Kielhorn
+% Copyright 1994 - 2006 by Axel Kielhorn
%
% This program can be redistributed and/or modified under the terms
% of the LaTeX Project Public License Distributed from CTAN
@@ -14,7 +14,7 @@
% A.Kielhorn@web.de
%
% \fi
-% \CheckSum{2570}
+% \CheckSum{2625}
%% \CharacterTable
%% {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
%% 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
@@ -48,7 +48,7 @@
%<*driver>
\ProvidesFile{refman.drv}
%</driver>
- [2003/05/31 v2.0d
+ [2006/11/13 v2.0e
%<+refart|refrep> LaTeX document class]
% \end{macrocode}
% \fi
@@ -152,7 +152,7 @@
%
% \author{%
% Copyright (C) 1988 by Hubert Partl \and
-% Copyright (C) 1994-2003 by Axel Kielhorn
+% Copyright (C) 1994-2006 by Axel Kielhorn
% }
% \date{\filedate}
% \maketitle
@@ -178,7 +178,7 @@
%
% \begin{macro}{\@ptsize}
% This control sequence is used to store the second digit of the
-% pointsize we are typesetting in. So, normally, it's value is one
+% pointsize we are typesetting in. So, normally, its value is one
% of 0, 1 or 2.
% \begin{macrocode}
%<*refart|refrep>
@@ -187,7 +187,7 @@
% \end{macro}
%
% \begin{macro}{\if@restonecol}
-% Only the index is printed in twocolumn-layout.
+% Only the index is printed in two-column layout.
% \begin{macrocode}
\newif\if@restonecol
% \end{macrocode}
@@ -206,8 +206,8 @@
%
% \begin{macro}{\if@openright}
% A switch to indicate if chapters must start on a right-hand page.
-% The default for the \file{refref} class is no. There are no
-% chapters in the \file{refart} class
+% The default for the \file{refrep} class is no. There are no
+% chapters in the \file{refart} class.
% \begin{macrocode}
%<+refrep>\newif\if@openright
% \end{macrocode}
@@ -247,6 +247,25 @@
\setlength\paperwidth {7.25in}}
% \end{macrocode}
%
+% \changes{v2.0e}{2006/08/10}{Added option smallborder with smaller
+% margins.}
+%
+% A new lenght |\papermarginwidth| is allocated and set to 1 in. The
+% option \Lopt{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 layouot.
+% \begin{macrocode}
+\newlength\papermarginwidth
+\setlength\papermarginwidth {1in}
+\DeclareOption{smallborder}
+ {\setlength\papermarginwidth {0.25in}}
+% \end{macrocode}
+%
% The option \Lopt{landscape} switches the values of |\paperheight|
% and |\paperwidth|, assuming the dimensions were given for portrait
% paper.
@@ -266,15 +285,75 @@
{\setlength\paperheight {\paperwidth}}
% \end{macrocode}
%
+% \subsection{Telling the DVI-driver what we know}
+%
+% \changes{v2.0e}{2006/11/13}{Add support for DVIPS}
+% \changes{v2.0e}{2006/10/08}{Add support for PDFTEX}
+% \changes{v2.0e}{2006/11/13}{Made this an option (cleaner)}
+%
+% 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.
+%
+% \begin{macro}{dvips}
+% \begin{macrocode}
+\DeclareOption{dvips}{\AtBeginDocument{\AtBeginDvi{%
+ \special{papersize=\the\paperwidth,\the\paperheight}}}}
+% \end{macrocode}
+% \end{macro}
+
+% \begin{macro}{pdftex}
+% \begin{macrocode}
+\DeclareOption{pdftex}{\AtBeginDocument{%
+ \pdfpagewidth=\paperwidth \pdfpageheight=\paperheight}}
+% \end{macrocode}
+% \end{macro}
+%
+% Since we need to know whether we are generating DVI or PDF we
+% can make this information available to the user as well.
+%
+% \begin{macro}{\ifpdfoutput}
+% \begin{macrocode}
+\newcommand{\ref@ifpdfoutput}[2]{%
+ \begingroup\@ifundefined{pdfoutput}{\endgroup #2}{\endgroup%
+ \ifnum\pdfoutput>0\relax #1\else #2\fi}}%
+\@ifundefined{ifpdfoutput}{%
+ \let\ifpdfoutput\ref@ifpdfoutput}{%
+%<*refart>
+\PackageInfo{refart}
+%</refart>
+%<*refrep>
+\PackageInfo{refrep}
+%</refrep>
+ {\string\ifpdfoutput\space already defined.\MessageBreak
+ If \string\ifpdfoutput\space does not behave like\MessageBreak
+ is is described at the Refman manual, try find out\MessageBreak
+ at which package \string\ifpdfoutput\space was defined.}}
+% \end{macrocode}
+% \end{macro}
+%
+% The option \Lopt{pagesize} will export the correct definition
+% for the dvi-driver used. (Unless magic fails, then you need to
+% specify the driver manually.)
+%
+% \begin{macro}{pagesize}
+% \begin{macrocode}
+\DeclareOption{pagesize}{\AtBeginDocument{%
+ \ref@ifpdfoutput
+ {\pdfpagewidth=\paperwidth\pdfpageheight=\paperheight}
+ {\AtBeginDvi{\special{papersize=\the\paperwidth,\the\paperheight}}}}}
+% \end{macrocode}
+% \end{macro}
+%
% \subsection{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
+% 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 \texttt{8}
-% assuming that a class wont define both \Lopt{8pt} and \Lopt{18pt}
+% assuming that a class won't define both \Lopt{8pt} and \Lopt{18pt}
% options.
%
% \begin{macrocode}
@@ -323,7 +402,7 @@
% \subsection{Twocolumn printing}
%
% Two-column is used in the index. There is no user command
-% or option to request twocolumn printing. Therefore
+% or option to request two-column printing. Therefore
% \Lopt{twocolumn} will lead to an error message.
% \begin{macrocode}
\DeclareOption{onecolumn}{\@twocolumnfalse}
@@ -384,7 +463,7 @@
%
% \begin{macro}{\ifdescriptioncolon}
% This switch controls whether there is a colon in the
-% description item or not. The default is to inclue a colon.
+% description item or not. The default is to include a colon.
% \begin{macrocode}
\newif\ifdescriptioncolon \descriptioncolontrue
% \end{macrocode}
@@ -430,11 +509,12 @@
% 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.
-% \begin{macrocode}
+% \begin{macrocode}
\ProcessOptions
% \end{macrocode}
+%
% Now that all the options have been executed we can load the
-% chosen class option file that contains all size dependent code.
+% chosen class option file that contains all size dependent-code.
% We are using the \file{sizexx.clo} Files from classes.dtx now
% and do the page layout caculation inside the class-file.
% \begin{macrocode}
@@ -485,7 +565,7 @@
% \begin{macro}{\@normalsize}
%
% The user level command for the main size is |\normalsize|.
-% Internally \LaTeX{} uses |\@normalsize| when it refers to the
+% Internally, \LaTeX{} 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
@@ -548,7 +628,7 @@
%
% \begin{macro}{\clubpenalty}
% \begin{macro}{\widowpenalty}
-% These penalties are use to discourrage club and widow lines.
+% These penalties are use to discourage club and widow lines.
% Because we use their default values we only show them here,
% commented out.
% \begin{macrocode}
@@ -619,13 +699,13 @@
% \begin{macro}{\textwidth}
% \begin{macro}{\leftmarginwidth}
% There is no need to supply a compatibility mode since the
-% independend \texttt{refman.sty} was never released to the
+% independent \texttt{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 textwidth, which will fit on the
+% First, we calculate the maximum text width, which will fit on the
% selected paper and store it in |\@tempdima|.
% \begin{macrocode}
\newdimen\leftmarginwidth
@@ -636,7 +716,7 @@
% \end{macro}
% \begin{macro}{\emptyfoottopmargin}
% \begin{macro}{\emptyheadtopmargin}
-% Either your document uses \pstyle{footings} or \pstyle{headings}.
+% Your document uses either \pstyle{footings} or \pstyle{headings}.
% Depending on this, the whole page is shifted up or down by one line.
% \begin{macrocode}
\newdimen\emptyfoottopmargin
@@ -649,11 +729,15 @@
% 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|.
% \begin{macrocode}
\newcommand\settextfraction[1]%
{
- \setlength\@tempdima{\paperwidth}
- \addtolength\@tempdima{-2in}
+ \setlength\fullwidth{\paperwidth}
+ \addtolength\fullwidth{-2\papermarginwidth}
+ \@settopoint\fullwidth
% \end{macrocode}
% \end{macro}
%
@@ -662,11 +746,9 @@
%
% \begin{macrocode}
\if@twocolumn
- \setlength\textwidth{\@tempdima}
+ \setlength\textwidth{\fullwidth}
\else
- \setlength\fullwidth{\@tempdima}
- \@settopoint\fullwidth
- \setlength\textwidth{#1\fullwidth} % This may change
+ \setlength\textwidth{#1\fullwidth}
\fi
% \end{macrocode}
%
@@ -689,17 +771,12 @@
% independing on the status of the |\if@twoside|. (We have the same
% layout on odd and even pages.)
%
-% For one-sided printing we center the text on the page, by
-% calculating the difference between |textwidth| and
-% |\paperwidth|$-$|2in|. Half of that difference is than used for
-% the margin. The amount of space that can be used for marginal
-% notes is |leftmarginwidth| $-$ |marginparsep|
-% to which we add any `leftover' space.
-% \begin{macrocode}
- \setlength\@tempdima {\paperwidth}
- \addtolength\@tempdima {-2in}
- \addtolength\@tempdima {-\fullwidth}
- \setlength\oddsidemargin {.5\@tempdima}
+% 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.
+% \begin{macrocode}
+ \setlength\oddsidemargin {-1in}
+ \addtolength\oddsidemargin {\papermarginwidth}
\addtolength\oddsidemargin {\leftmarginwidth}
\@settopoint\oddsidemargin
% \end{macrocode}
@@ -708,7 +785,8 @@
% |\oddsidemargin|. |\marginparwidth| will be modified later.
% \begin{macrocode}
\setlength\evensidemargin {\oddsidemargin}
- \setlength\marginparwidth {\oddsidemargin}
+ \setlength\marginparwidth {\leftmarginwidth
+ }
% \end{macrocode}
% \end{macro}
% \end{macro}
@@ -721,7 +799,7 @@
% 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 flushleft
+% of the |marginpar| is reduced by |marginparsep| to produce flush left
% pages.
% \begin{macrocode}
\addtolength\marginparwidth {-\marginparsep}
@@ -752,10 +830,10 @@
\setlength\@tempdima {\paperheight}
% \end{macrocode}
%
-% We leave at least a 1 inch margin on the top and the bottom of
+% We leave at least a |\papermarginwidth| margin on the top and the bottom of
% the page.
% \begin{macrocode}
-\addtolength\@tempdima{-2in}
+\addtolength\@tempdima{-2\papermarginwidth}
% \end{macrocode}
%
% The running headers and footers extend partly into the top
@@ -791,15 +869,15 @@
% 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 pooints.
+% full points.
% \begin{macrocode}
-\setlength\topmargin{\paperheight}
-\addtolength\topmargin{-2in}
+\setlength\topmargin {\paperheight}
\addtolength\topmargin{-\headheight}
\addtolength\topmargin{-\headsep}
\addtolength\topmargin{-\textheight}
\addtolength\topmargin{-\footskip} % this might be wrong!
\addtolength\topmargin{-.5\topmargin}
+\addtolength\topmargin{-1in}
\@settopoint\topmargin
% \end{macrocode}
% By changing the factor in the next line the complete page
@@ -1374,7 +1452,7 @@
\hb@xt@\z@{\hss\@textsuperscript{\normalfont\@thefnmark}\,}##1}
% \end{macrocode}
% We center the entire title vertically; the centering is set off a
-% little by adding a |\vskip|. In compatibility mode the pagenumber
+% little by adding a |\vskip|. In compatibility mode the page number
% is set to 0 to keep the behaviour of \LaTeX\ 2.09 style files
% \begin{macrocode}
\null\vfil
@@ -1452,7 +1530,7 @@
\par\parindent 1em \noindent
\hb@xt@\z@{\hss\@textsuperscript{\normalfont\@thefnmark}\,}##1}
% \end{macrocode}
-% If this is a twocolumn document we start a new page in twocolumn
+% 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|.
@@ -1465,7 +1543,7 @@
\fi
\else
% \end{macrocode}
-% When this is not a twocolumn document we just start a new page,
+% 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.
% \begin{macrocode}
@@ -1474,10 +1552,10 @@
\@maketitle
\fi
% \end{macrocode}
-% This page gets a \pstyle{plain} layout. We call |\@thanks| to
+% This page gets a \pstyle{empty} layout. We call |\@thanks| to
% produce the footnotes.
% \begin{macrocode}
- \thispagestyle{plain}\@thanks
+ \thispagestyle{empty}\@thanks
% \end{macrocode}
% Now we can close the group, reset the \Lcount{footnote} counter,
% disable |\thanks|, |\maketitle| and |\@maketitle| and save some
@@ -1504,10 +1582,10 @@
% 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 flushleft
+% 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
-% flushright in slanted type. This title will allways show the
+% flush right in slanted type. This title will allways show the
% date unless it is set to nothing, using the |\date{}| command.
% \begin{macrocode}
\def\@maketitle{%
@@ -1672,7 +1750,7 @@
% 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 paragraph, add a little white space, suppress the
+% we start a new paragraph, 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
% {\LaTeXe} kernel), we need to check the |@noskipsec| switch and
@@ -1692,7 +1770,7 @@
%
% For the refrep class things are a bit different.
%
-% We start a new (righthand) page and use the \pstyle{plain}.
+% We start a new (righthand) page and use the \pstyle{empty}.
% \changes{v2.0}{1997/02/14}{Make this command react to the option
% \texttt{openany}}% \begin{macrocode}
%<*refrep>
@@ -1702,7 +1780,7 @@
\else
\clearpage
\fi
- \thispagestyle{plain}%
+ \thispagestyle{empty}%
% \end{macrocode}
% 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
@@ -1715,7 +1793,7 @@
\@tempswafalse
\fi
% \end{macrocode}
-% We need an empty box to prevent the fil glue from disappearing.
+% We need an empty box to prevent the fill glue from disappearing.
% \begin{macrocode}
\null\vfil
% \end{macrocode}
@@ -1765,7 +1843,7 @@
#2\par \medskip
\longrule\bigskip%
% \end{macrocode}
-% Then we empty the mark registers, leave some white space and call
+% Then we empty the mark registers, leave some whitespace and call
% |\@afterheading| to takes care of suppressing the indentation.
% \begin{macrocode}
\markboth{}{}\par}%
@@ -1807,7 +1885,7 @@
%<*refrep>
\newcommand\chapter{\if@openright\cleardoublepage\else\clearpage\fi
\if@pageperchapter\setcounter{page}{1}\fi
- \thispagestyle{plain}%
+ \thispagestyle{empty}%
% \end{macrocode}
% Then we prevent floats from appearing at the top of this page
% because it looks weird to see a floating object above a chapter
@@ -1842,7 +1920,7 @@
% \end{macrocode}
% After having written an entry to the table of contents we store
% the (alternative) title of this chapter with |\chaptermark| and
-% add some white space to the lists of figures and tables.
+% add some whitespace to the lists of figures and tables.
% \begin{macrocode}
\chaptermark{#1}%
\addtocontents{lof}{\protect\addvspace{10\p@}}%
@@ -1850,7 +1928,7 @@
% \end{macrocode}
% Then we call upon |\@makechapterhead| to format the actual
% chapter title. We have to do this in a special way when we are in
-% twocolumn mode in order to have the chapter title use the entire
+% 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.
% \begin{macrocode}
@@ -1867,7 +1945,7 @@
% The macro above uses |\@makechapterhead|\meta{text} to format the
% heading of the chapter.
%
-% We begin by leaving some white space. The we open a group in
+% 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.
% \begin{macrocode}
@@ -1883,7 +1961,7 @@
\@chapapp\space \thechapter\quad
\fi}%
% \end{macrocode}
-% Now we set the title in a large bold font. We prevent a pagebreak
+% 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.
% \begin{macrocode}
#1\par}
@@ -1934,7 +2012,7 @@
%
% These commands all make use of |\@startsection|.
% \begin{macro}{\section}
-% This gives a normal heading with white space above and below the
+% 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.
% \begin{macrocode}
@@ -1946,7 +2024,7 @@
% \end{macro}
%
% \begin{macro}{\subsection}
-% This gives a normal heading with white space above and below the
+% 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.
% \begin{macrocode}
@@ -1958,7 +2036,7 @@
% \end{macro}
%
% \begin{macro}{\subsubsection}
-% This gives a normal heading with white space above and below the
+% 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.
% \begin{macrocode}
@@ -1970,7 +2048,7 @@
% \end{macro}
%
% \begin{macro}{\paragraph}
-% This gives a run-in heading with white space above and to the
+% This gives a run-in heading with whitespace above and to the
% right of the heading, the title set in |\normalsize\bfseries|.
% \begin{macrocode}
\newcommand\paragraph{\@startsection{paragraph}{4}{\z@}%
@@ -1981,7 +2059,7 @@
% \end{macro}
%
% \begin{macro}{\subparagraph}
-% This gives an indented run-in heading with white space above and
+% This gives an indented run-in heading with whitespace above and
% to the right of the heading, the title set in
% |\normalsize\bfseries|.
% \begin{macrocode}
@@ -2209,7 +2287,7 @@
% \cs{textasteriskcentered} and \cs{textperiodcentered}}
% Itemization is controlled by four commands: |\labelitemi|,
% |\labelitemii|, |\labelitemiii|, and |\labelitemiv|, which define
-% the labels of thevarious itemization levels: the symbols used are
+% the labels of the various itemization levels: the symbols used are
% bullet, bold en-dash, asterisk and centred dot.
%
% \begin{macrocode}
@@ -2352,7 +2430,7 @@
%
% \begin{macro}{\example}
% The example environment is a verse environment with tt font
-% which tries to avoid pagebrakes at the |\begin{example}|.
+% which tries to avoid page brakes at the |\begin{example}|.
%
% \begin{macrocode}
\newenvironment{example}
@@ -2371,8 +2449,8 @@
%
% \subsubsection{Theorem}
%
-% This document class does not define it's own theorem environments,
-% the defaults, supplied by \file{latex.dtx} are available.
+% This document class does not define its own theorem environments,
+% the defaults supplied by \file{latex.dtx} are available.
%
% \subsubsection{Titlepage}
%
@@ -2429,7 +2507,7 @@
% must do the following:
% \begin{itemize}
% \item issue a |\newpage| if pageperchapter is defined,
-% otherwise the pagenumber would come out wrong.
+% otherwise the page number would come out wrong.
% \item reset the chapter and section counters to zero,
% \item set |\@chapapp| to |\appendixname| (for messages),
% \item redefine the chapter counter to produce appendix numbers,
@@ -2656,7 +2734,7 @@
%
% \begin{environment}{figure}
% \begin{environment}{figure*}
-% And the definition of the actual environment. The form with the
+% Here is the definition of the actual environment. The form with the
% |*| is used for double column figures.
% \begin{macrocode}
\newenvironment{figure}
@@ -2711,7 +2789,7 @@
%
% \begin{environment}{table}
% \begin{environment}{table*}
-% And the definition of the actual environment. The form with the
+% Here is the definition of the actual environment. The form with the
% |*| is used for double column tables.
% \begin{macrocode}
\newenvironment{table}
@@ -2736,7 +2814,7 @@
%
% \begin{macro}{\abovecaptionskip}
% \begin{macro}{\belowcaptionskip}
-% These lengths contain the amount of white space to leave above
+% These lengths contain the amount of whitespace to leave above
% and below the caption.
% \begin{macrocode}
\newlength\abovecaptionskip
@@ -2812,7 +2890,7 @@
% \begin{macro}{\it}
% \begin{macro}{\sc}
%
-% And the commands to change the shape of the font. The slanted and
+% 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.
@@ -2913,7 +2991,7 @@
% \begin{macro}{\tableofcontents}
% This macro is used to request that \LaTeX{} 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.
+% contents, figures, etc. are always set in single-column style.
%
% \begin{macrocode}
\newcommand\tableofcontents{%
@@ -2934,7 +3012,7 @@
\@mkboth{\contentsname}{\contentsname}}%
% \end{macrocode}
% The the actual table of contents is made by calling
-% |\@starttoc{toc}|. After that we restore twocolumn mode if
+% |\@starttoc{toc}|. After that, we restore twocolumn mode if
% necessary.
% \begin{macrocode}
\@starttoc{toc}%
@@ -2948,7 +3026,7 @@
% entry in the table of contents, as described above. The macro for
% the entry for parts is defined in a special way.
%
-% First we make sure that if a pagebreak should occur, it occurs
+% First we make sure that if a page break should occur, it occurs
% {\em before} this entry. Also a little whitespace is added and a
% group begun to keep changes local.
% \changes{v2.0c}{1999/03/28}{Removed setting of \cs{@tempdima} as
@@ -2962,20 +3040,20 @@
\begingroup
% \end{macrocode}
% The we set |\parindent| to 0pt and use |\rightskip| to leave
-% enough room for the pagenumbers. To prevent overfull box messages
+% enough room for the page numbers. To prevent overfull box messages
% the |\parfillskip| is set to a negative value.
% \begin{macrocode}
\parindent \z@ \rightskip \@pnumwidth
\parfillskip -\@pnumwidth
% \end{macrocode}
% 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 pagenumber,
+% leave vertical mode, set the part title and add the page number,
% set flush right.
% \begin{macrocode}
{\leavevmode
\large \bfseries #1\hfil \hbox to\@pnumwidth{\hss #2}}\par
% \end{macrocode}
-% Prevent a pagebreak immediately after this entry, but use
+% Prevent a page break immediately after this entry, but use
% |\everypar| to reset the |\if@nobreak| switch. Finally we close
% the group.
% \begin{macrocode}
@@ -2991,7 +3069,7 @@
% 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 pagebreak should occur, it occurs
+% First we make sure that if a page break should occur, it occurs
% {\em before} this entry. Also a little whitespace is added and a
% group begun to keep changes local.
% \begin{macrocode}
@@ -3018,7 +3096,7 @@
% \end{macrocode}
% Because we do not use |\numberline| here, we have do some fine
% tuning `by hand', before we can set the entry. We discourage but
-% not disallow a pagebreak immediately after a chapter entry.
+% not disallow a page break immediately after a chapter entry.
% \begin{macrocode}
\advance\leftskip\@tempdima
\hskip -\leftskip
@@ -3035,7 +3113,7 @@
% for sections looks much like the chapter entries for the report
% and book document classes.
%
-% First we make sure that if a pagebreak should occur, it occurs
+% First we make sure that if a page break should occur, it occurs
% {\em before} this entry. Also a little whitespace is added and a
% group begun to keep changes local.
% \begin{macrocode}
@@ -3062,7 +3140,7 @@
% \end{macrocode}
% Because we do not use |\numberline| here, we have do some fine
% tuning `by hand', before we can set the entry. We discourage but
-% not disallow a pagebreak immediately after a chapter entry.
+% not disallow a page break immediately after a chapter entry.
% \begin{macrocode}
\advance\leftskip\@tempdima
\hskip -\leftskip
@@ -3264,7 +3342,7 @@
% the user level the commands |\item|, |\subitem| and |\subsubitem|
% are used to produce index entries of various levels. When a new
% letter of the alphabet is encountered an amount of |\indexspace|
-% white space can be added.
+% whitespace can be added.
%
%
% \begin{macrocode}
@@ -3299,7 +3377,7 @@
%</refrep>
\@mkboth{\indexname}%
{\indexname}%
- \thispagestyle{plain}\parindent\z@
+ \parindent\z@
\parskip\z@ \@plus .3\p@\relax
\let\item\@idxitem}
% \end{macrocode}
@@ -3325,7 +3403,7 @@
% \end{macro}
%
% \begin{macro}{\indexspace}
-% The amount of white space that is inserted between `letter
+% The amount of whitespace that is inserted between `letter
% blocks' in the index.
% \begin{macrocode}
\newcommand\indexspace{\par \vskip 10\p@ \@plus5\p@ \@minus3\p@\relax}
@@ -3470,10 +3548,10 @@
% \begin{macro}{\attentionsymbol}
%
% This defines three commands to put information in the margin:
-% |\marginlabel| buts the argument into a flushright marginpar,
+% |\marginlabel| buts the argument into a flush right marginpar,
% |\attention| puts |\attentionsymbol| to the left of the text to mark
% an important piece of text and |\seealso| puts a $\rightarrow$ to
-% the left oft the margin to mark a reference within the text.
+% the left of the margin to mark a reference within the text.
% |\attentionsymbol| is defined as \large\bfseries ! $\rightarrow$
% but can be changed with a |\renewcommand{\attentionsymbol}{:-)}|
% command.
@@ -3506,7 +3584,7 @@
% \begin{macro}{\longthickrule}
%
% These rules are used in several places, like the title, new
-% parts and chapters and for maxi and fullpages.
+% parts and chapters and for maxi- and fullpages.
% \begin{macrocode}
\def\longrule{\par\hb@xt@\linewidth{\hss
\vrule width \fullwidth height 0.4\p@ depth \z@}\par}
@@ -3571,7 +3649,7 @@
%
% \begin{macro}{\condbreak}
% \begin{macro}{\noparskip}
-% The |\condbreak{length}| controls pagebreaks:
+% The |\condbreak{length}| controls page breaks:
% If less then length is left on this page it will be moved
% to the next page. Thus it will remain together, either on
% this page or on the next.
@@ -3609,7 +3687,7 @@
% implemented in this version and will not be implemented later
% unless there is popular demand.
%
-% |\makeauthor|: The author is printed when |\maketitel| is
+% |\makeauthor|: The author is printed when |\maketitle| is
% executed thus there is no need for this command.
%
% |\setleftmarginwidth| has been used in version 1.1 to
@@ -3624,7 +3702,7 @@
%
% \begin{macro}{\ppc}
% \begin{macro}{\pageperchapter}
-% This gives you a pagecount per chapter like 1-1, 1-2, 2-1.
+% This gives you a page count per chapter like 1-1, 1-2, 2-1.
% Since this is often requested and would be usefull in a
% reference manual style. |\pageperchapter| is only supported
% in refrep.cls.
@@ -3632,8 +3710,8 @@
% This version redefines the \LaTeX\ |\@wrindex| command
% which writes the indexentry. This hack is needed to keep
% MakeIndex happy when processing the index-file. The |\ppc|
-% command is responsible to extract the chapternumber from the
-% index-entry and reformat it. The chapternumber can be a
+% command is responsible to extract the chapter number from the
+% index-entry and reformat it. The chapter number can be a
% Roman or Alpha number but the page has to be arabic.
%
% \begin{macrocode}
@@ -3670,7 +3748,7 @@
%
% \begin{macro}{\leftmarginfraction}
% This provides an interface to change the horizontal layout.
-% In this version the margin is set to 0.3 |fullwidth|, this
+% In this version, the margin is set to 0.3 |fullwidth|, this
% may change in future versions.
%
% \end{macro}
@@ -3757,7 +3835,7 @@
% \subsection{The page style}
% We have \pstyle{plain} pages in the document classes refart
% and refrep unless the user specified otherwise.
-% We use arabic pagenumbers.
+% We use arabic page numbers.
% \begin{macrocode}
\pagestyle{plain}
\pagenumbering{arabic} % Arabic page numbers