summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/refman/layout_e.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/refman/layout_e.tex')
-rw-r--r--Master/texmf-dist/doc/latex/refman/layout_e.tex328
1 files changed, 164 insertions, 164 deletions
diff --git a/Master/texmf-dist/doc/latex/refman/layout_e.tex b/Master/texmf-dist/doc/latex/refman/layout_e.tex
index e55c09a3f31..df4815b73c5 100644
--- a/Master/texmf-dist/doc/latex/refman/layout_e.tex
+++ b/Master/texmf-dist/doc/latex/refman/layout_e.tex
@@ -10,8 +10,8 @@
% ifthen wird vom Bild von N.Beebe gebraucht!
\def\bs{\char'134 } % backslash in \tt font.
-\newcommand{\ie}{i.\,e.}
-\newcommand{\eg}{e.\,g.}
+\newcommand{\ie}{i.\,e.,}
+\newcommand{\eg}{e.\,g..}
\DeclareRobustCommand\cs[1]{\texttt{\char`\\#1}}
\title{Changing the layout with \LaTeX}
@@ -27,8 +27,8 @@ H27.0 --- Version 1}
\emergencystretch1em %
\pagestyle{myfootings}
-\markboth{Changing the layout with \rm\LaTeX}%
- {Changing the layout with \rm\LaTeX}
+\markboth{Changing the layout with \textrm{\LaTeX}}%
+ {Changing the layout with \textrm{\LaTeX}}
\makeindex
@@ -39,21 +39,21 @@ H27.0 --- Version 1}
\maketitle
\begin{abstract}
- This document describes the capabilities of the
- \texttt{refart} and \texttt{refrep} classes for \LaTeXe.
- These classes do not work with \LaTeX\ 2.09. They contain some
- improvements over the original \texttt{refman} style which may result
- in different output and minor incompatibilities, but make refman
- work with paper sizes other than ISO A4, which I consider an
- improvement.
+ This document describes the capabilities of the
+ \texttt{refart} and \texttt{refrep} classes for \LaTeXe.
+ These classes do not work with \LaTeX\ 2.09. They contain some
+ improvements over the original \texttt{refman} style which may result
+ in different output and minor incompatibilities, but make refman
+ work with paper sizes other than ISO A4, which I consider an
+ improvement.
\end{abstract}
This manual is an addition to chapter~5 (``Designing It Yourself'') of
the \LaTeX-manual by Leslie Lamport. It was originally written in
-1988 by Hubert Partl and updated by me during the developement of
-\texttt{refman}~2.0. The translation into english was done in summer
-1998, almost 10 years after the initial release in german.
+1988 by Hubert Partl and updated by me during the development of
+\texttt{refman}~2.0. The translation into English was done in summer
+1998, almost 10 years after the initial release in German.
\tableofcontents
@@ -69,11 +69,11 @@ the \LaTeX-manual by Leslie Lamport. It was originally written in
Every piece of writing -- from a short handwritten note to a printed
book -- consists of two components: \textbf{contents} and
\textbf{design.} In most cases the design is only a means to allow
-the reader to understand the contents easier.
+the reader to understand the contents more easily.
\index{author}\marginlabel{Author:}
The \textbf{contents} will be written by the author of the document.
-She usually is supported by the publisher who issues guidelines
+She usually is supported by the publisher, who issues guidelines
about how the document should be written and conducts proofreading.
When using \LaTeX\ the contents appears in the main part of the
@@ -90,9 +90,9 @@ document you have to specify the class you want to use with the
\verb+\documentclass+ command.
The document classes distributed with \LaTeX\ have been designed by
-american layout designers according to the conventions used in the
-USA. The ``Koma-Script'' classes have been adapted to european taste
-and contain a lot of small improvements.
+American layout designers according to the conventions used in the
+USA. The ``Koma-Script'' classes have been adapted to European taste
+and contain many small improvements.
\index{compositor}\marginlabel{Compositor:}
The compositor takes the contents from the author and formats it
@@ -110,23 +110,23 @@ If you want to use a layout different from the ones distributed with
\item
The layout has to be defined.
- This is usually a job for a professional designer.
+ This is usually a job for a professional designer.
-\seealso{\ref{design}}
- You can find detailed information about how change the design in
- chapter~\ref{design}.
+\seealso{Chapter \ref{design}}
+ You can find detailed information about how change the design in
+ chapter~\ref{design}.
\item
- The Layout has to be programmed in \LaTeX. This can either result in
- a ``package'' that changes the behaviour of a standard class or
- in the definition of a new ``class''. \texttt{Refman} used to be a
- package that changed the definition of the \texttt{article}
- class but is now a class of it's own. When writing a new class, you
- will have more work but as a result more freedom to change things.
-
-\seealso{\ref{layout}}
- Chapter~\ref{layout} contains more information about the new layout.
-
+ The layout has to be programmed in \LaTeX. This can either result in
+ a ``package'' that changes the behaviour of a standard class, or
+ in the definition of a new ``class''. \texttt{Refman} used to be a
+ package that changed the definition of the \texttt{article}
+ class but is now a class of its own. When writing a new class, you
+ will have more work, but as a result more freedom to change things.
+
+\seealso{Chapter \ref{layout}}
+ Chapter~\ref{layout} contains more information about the new layout.
+
\end{enumerate}
\section{The Art of Layout-Design}
@@ -137,13 +137,13 @@ If you want to use a layout different from the ones distributed with
\subsection{Common Rules}
\index{rules}
-There are almost no common rules because every kind of documents has
+There are almost no common rules because every kind of document has
different requirements and needs a specific layout. This layout
-should consider \emph{who} will read the document \emph{how}.
+should consider \emph{who} will read the document, and \emph{how}.
An important criteria is if the reader will read the document from
start to end like a detective novel (linear reading) or if he wants to
-find a certain information like in a telephone directory or a
+find certain information as in a telephone directory or a
reference manual. \index{manual}\index{telephone directory}
In addition to that, the layout has to consider certain conventions,
@@ -154,10 +154,10 @@ like ``page'' or ``invers''.}
\attention
The main purpose of a layout is to make sure the reader finds the
-information he wants and is able to read and understand them easily.
-The structure, readability and consistence of a document is more
+information he wants and is able to read and understand it easily.
+The structure, readability, and consistency of a document is more
important than it's ``beauty''.\footnote{This is not always true for
-adverts that usually contain no information at all and picture
+adverts that usually contain no information at all and, picture
magazines where the beauty of the picture \emph{is} the contents.}
The following ``rules of thumb''\index{rules of thumb} will be valid
@@ -165,87 +165,87 @@ for most applications:
\begin{description}
-\item[Linespacing]\index{linespacing}
- The spacing between two lines should be larger than the spacing
- between two words to guide the eyes of the reader.
-
-\item[Linelength]\index{linelength}
- The length of a line -- or when using multicolumn layout of a
- column -- should be about 60 characters. When lines get longer they
- are more difficult to read and it is easier to go to the wrong line
- after finishing the current. Increasing the linespacing may help a
- little.
- When lines get to short it is difficult to set them justified and you
- will get lots of hyphenated words.
-
-\item[Pagelayout]\index{pagelayout}
- Normal text pages should look the same throughout the document.
- Figures, tables and special pages like the index need not appear in
- the same layout but should take as much space as needed.
-
+\item[Line spacing]\index{line spacing}
+ The spacing between two lines should be larger than the spacing
+ between two words to guide the eyes of the reader.
+
+\item[Line length]\index{line length}
+ The length of a line -- or when using multicolumn layout of a
+ column -- should be about 60 characters. When lines get longer they
+ are more difficult to read and it is easier to go to the wrong line
+ after finishing the current one. Increasing the linespacing may help a
+ little.
+ When lines get to short it is difficult to set them justified, and you
+ will get lots of hyphenated words.
+
+\item[Page layout]\index{page layout}
+ Normal text pages should look the same throughout the document.
+ Figures, tables and special pages like the index need not appear in
+ the same layout but should take as much space as needed.
+
\item[Margin notes]\index{margin notes}
- Margin notes are often more suitable than footnotes because they
- appear right next to the text they refer to. Special margin notes are
- the ``attention sign'' or the ``dangerous bend'' that guide the user
- to important parts of the text.
-
+ Margin notes are often more suitable than footnotes because they
+ appear right next to the text they refer to. Special margin notes are
+ the ``attention sign'' or the ``dangerous bend'' that guide the user
+ to important parts of the text.
+
\item[Headings and Footings]\index{headings}\index{footings}
- Headings and footings should make it easier to orientate in the
- document. If you expect readers to copy single pages from the
- document they should contain information about the paper as a whole,
- just in case you need more information or want to cite the whole paper.
-
- If you expect the document to change often (like software
- manuals), each page should contain a version information or at
- least a date.
-
+ Headings and footings should make it easier for the reader to orient
+ himself in the document. If you expect readers to copy single pages
+ from the document they should contain information about the paper as
+ a whole, just in case you need more information or want to cite the
+ whole paper.
+
+ If you expect the document to change often (like software manuals),
+ each page should contain a version information or at least a date.
+
\end{description}
\subsection{Special note for technical descriptions}
Let us compare three different layouts and check if they are usable for
-technical descriptions, User's guides and reference manuals.
-\footnote{This hint came from Paul Stiff who teaches layout design at
+technical descriptions, user's guides and reference manuals.
+\footnote{This hint came from Paul Stiff, who teaches layout design at
the University of Reading.}
\begin{description}
\item[Plain \TeX]
- The standard format use by plain \TeX\ has the great disadvantage
- that the lines are much to long which reduces the readability.
-
+ The standard format use by plain \TeX\ has the great disadvantage
+ that the lines are much to long, which reduces the readability.
+
\item[Standard-\LaTeX]
- The format used by \LaTeX{}s standard classes isn't ideal. The
- linelength is correct, but that leaves us with a wide unused margin.
- The font used for section headings is too large. The Koma-Script
- classes improve this and offer many ways to configure the fonts.
- This is a good design for a paper one usually reads from start to
- end.
-
+ The format used by \LaTeX{}s standard classes isn't ideal. The
+ line length is correct, but that leaves us with a wide unused margin.
+ The font used for section headings is too large. The Koma-Script
+ classes improve this and offer many ways to configure the fonts.
+ This is a good design for a paper one usually reads from start to
+ end.
+
\item[Reference Manual Style]
- A new design that appeared some years ago and is used in recent
- reference manuals, is much more suited for our purpose.
- \footnote{The ``PostScript Reference Manual'' is one document that
- uses such a design.}
+ A new design that appeared some years ago and is used in recent
+ reference manuals, is much more suited for our purpose.
+ \footnote{The ``PostScript Reference Manual'' is one document that
+ uses such a design.}
\begin{itemize}
\item
- The text is printed in rather short lines in the right part of the
- page. This part is used for continuous reading.
+ The text is printed in rather short lines in the right part of the
+ page. This part is used for continuous reading.
\item
- The wide left margin is used for headings and margin notes. Since
- you now have a wide margin it is easier to use long margin notes to
- supply additional information and to lead the reader to important
- parts of the documents. Please note that the margin is always on the
- left side thus twosided printing does not look symmetrical. This is
- done on purpose because the reader will always start reading at the
- left side and with this layout section headers really ``stand out''.
- In a symmetrical layout, half the headers would be buried in the text.
+ The wide left margin is used for headings and margin notes. Since
+ you now have a wide margin it is easier to use long margin notes to
+ supply additional information and to lead the reader to important
+ parts of the documents. Please note that the margin is always on the
+ left side thus two-sided printing does not look symmetrical. This is
+ done on purpose, because the reader will always start reading at the
+ left side, and with this layout section headers really ``stand out''.
+ In a symmetrical layout, half the headers would be buried in the text.
\item
- Figures and tables are either inside the text column, the margin or,
- if necessary fill the whole page.
+ Figures and tables are either inside the text column, inside the
+ margin or, if necessary, fill the whole page.
\end{itemize}
-\seealso{\ref{refmanex}}
+\seealso{Section \ref{refmanex}}
Section~\ref{refmanex} describes how to implement such a layout in
\LaTeX.
@@ -262,10 +262,10 @@ Section~\ref{refmanex} describes how to implement such a layout in
\marginlabel{Advantages:} The big advantage of \LaTeX\ is, that it
implements a ``generic'' or ``logical'' design.\index{design,
logical}\index{design, generic} This means that the author has to
-specify the \emph{meaning} of special parts of the test like:
-headings, citations, lists, literature references and so on. These
+specify the \emph{meaning} of special parts of the text like:
+headings, citations, lists, literature references, and so on. These
logical definitions will be processed by the system and printed in
-the ``correct'' way. The meaning of correct is defined in the
+the ``correct'' way. The meaning of \emph{correct} is defined in the
document class and additional packages.
The opposite of this is the ``visual'' design\index{design, visual}
@@ -275,19 +275,19 @@ printing.
The logical design makes it easier for the author to write
consistent documents (\ie\ same font and fontsize for section headings
-of the same level, same layout for lists and enumerations, \dots)
+of the same level, same layout for lists and enumerations, \dots).
\marginlabel{Disadvantages:}
The main disadvantage of \LaTeX\ is that the author has only limited
means to change the layout and that she has only four classes to
-choose from. This has changed a lot with the appearance of the
-Script classes for \LaTeX\ 2.09 in 1992 which have been replaced by
-the even further improved Koma-Script classes for \LaTeXe.
+choose from. This has changed a great deal with the appearance of the
+Script classes for \LaTeX\ 2.09 in 1992, which in turn have been replaced by
+the even more improved Koma-Script classes for \LaTeXe.
Another disadvantage is that \LaTeX\ seems to be tied to the
``Computer modern'' font family. This is simply not true, at least
-not, when you have a PostScript printer. Setting up different fonts
-isn't an easy task but once they are installed they are as easy
+not when you have a PostScript printer. Setting up different fonts
+isn't an easy task, but once they are installed they are as easy
to use as the standard fonts.
But \LaTeX\ is much more powerful and flexible: you can define an
@@ -297,27 +297,27 @@ happens more often than you think. Many universities and publishers
have their own \LaTeX\ class but do not distribute it to the
world.\footnote{You can find a generic \texttt{elsevier.cls} on CTAN
which you can use to prepare article before submission. This will be
-replaced by the magazine specific class at the publisher.}
+replaced by the magazine-specific class at the publisher.}
\subsection{Input files and class files}
-According to the principle of separation between contents and design
+According to the principle of separation of content and design,
there are two kind of files:
\begin{itemize}
\item
- The contents and the logical structure of a document is defined in
- the \LaTeX\ input file.
+ The content and the logical structure of a document are defined in
+ the \LaTeX\ input file.
\item
- The design (layout) is defined in the class files and packages.
+ The design (layout) is defined in the class files and packages.
\end{itemize}
Which class and packages files a document will use is defined at the
beginning of the input file. The \verb|\documentclass| command
-selects the class, the \verb+\usepackage+ command specifies
+selects the class and the \verb+\usepackage+ command specifies
additional packages.
-To generate a paper you need at least two files, the input file an a
+To generate a paper you need at least two files, the input file and a
class file.
These two files represent the work of the author and designer as
@@ -326,13 +326,13 @@ the same person, this has some advantages:
\begin{itemize}
\item
- Similar documents (that appear in a series) have the same layout
- because the layout is defined in a file of its own and not part of
- the document.
+ Similar documents (that appear in a series) have the same layout
+ because the layout is defined in a file of its own and not part of
+ the document.
\item
- You can print the same contents without much work in different
- layouts, \eg\ as an article for a magazine and as a chapter for a
- dissertation.
+ You can print the same contents without much work in different
+ layouts, \eg\ as an article for a magazine and as a chapter for a
+ dissertation.
\end{itemize}
\subsection{Class files and Packages}
@@ -340,21 +340,21 @@ the same person, this has some advantages:
\LaTeX\ supports a hierarchy of layout definitions.
\begin{itemize}
\item
- The first file processed is the class file that is specified inside
- the curly braces of the \verb|\documentclass| command. This
- defines the kind of document you want to write.
+ The first file processed is the class file that is specified inside
+ the curly braces of the \verb|\documentclass| command. This
+ defines the kind of document you want to write.
\item
- The optional argument of the \verb|\documentclass| command inside
- the square brackets defines class options which select variants of
- the basic layout like different font sizes.
+ The optional argument of the \verb|\documentclass| command inside
+ the square brackets defines class options which select variants of
+ the basic layout,such as different font sizes.
\item
- The last step is reading the packages specified by the
- \verb|\usepackage| command. This command again takes options to
- select the layout.
+ The last step is reading the packages specified by the
+ \verb|\usepackage| command. This command again takes options to
+ select the layout.
\item
- You can change layout parameters in the input file, but this is
- discouraged because it violates the principle of separation between
- contents and design.
+ You can change layout parameters in the input file, but this is
+ discouraged because it violates the principle of separation of
+ content and design.
\end{itemize}
@@ -362,15 +362,15 @@ There are some important differences between class and package files
and ``normal'' input files:
\begin{itemize}
\item
- Class and package files should only contain definitions. They must
- not output text.
+ Class and package files should only contain definitions. They must
+ not output text.
\item
- The ``at''-sign \texttt{@} is treated as a letter and therefore may
- appear in command names. Most internal commands of \LaTeX\ contain
- an \texttt{@} to prevent the author from using them accidently.
+ The ``at''-sign \texttt{@} is treated as a letter and therefore may
+ appear in command names. Most internal commands of \LaTeX\ contain
+ an \texttt{@} to prevent the author from using them accidentally.
\item
- The extension of the file is \texttt{.cls}, \texttt{.clo} or
- \texttt{.sty} instead of \texttt{.tex}.
+ The extension of the file is \texttt{.cls}, \texttt{.clo} or
+ \texttt{.sty} instead of \texttt{.tex}.
\end{itemize}
\subsection{Changing the layout, step by step}
@@ -378,10 +378,10 @@ and ``normal'' input files:
It is usually easier to change existing class files instead of
writing a new one from scratch. In many cases it is even sufficient
-so replace some definitions and put them into a packages instead of
+so replace some definitions and put them into a package instead of
creating a new class.
-Please note, that you are \emph{not} allowed to change the standard
+Please note that you are \emph{not} allowed to change the standard
classes distributed with \LaTeX. You \emph{have} to change the name
when you want to make changes. That is another reason to put small
changes in packages.
@@ -419,7 +419,7 @@ adding the extension \texttt{.sty}.
This file will only contain the definitions you want to change or the
new commands you want to define.
-If you want to change definitions or certain parameters the best way
+If you want to change definitions or certain parameters, the best way
is to copy them from the original file and modify them according to
your liking.
@@ -429,12 +429,12 @@ original files which you can change.
It is always a good idea to include the reason you wrote the package,
the changes it makes and the new commands it defines in the file. You
should include the date of the last change and the \LaTeX\ version it
-works with just in case some internal \LaTeX\ commands you use will change.
+works with, just in case some internal \LaTeX\ commands you use will change.
When writing larger packages, it is an even better idea to use the
-docstrip program which is used to document the \LaTeXe\ files. Thus
+\texttt{docstrip} program which is used to document the \LaTeXe\ files. Thus
you have your code and documentation in one file and it's easier to
-prevent them from going out of sync.
+keep them from going out of sync.
\subsubsection{Using the new package}
@@ -474,7 +474,7 @@ commands that deal with equation numbers:\nopagebreak
% or in LaTeX2e since 1995/06/01:
\renewcommand\theequation{
\thechapter.\@arabic\c@equation
- }
+ }
\end{verbatim}
You don't necessarily need to understand these two commands in detail.
@@ -505,7 +505,7 @@ and add some comments.\nopagebreak
% or in more recent versions of LaTeX
\renewcommand\theequation{
\thesection.\@arabic\c@equation
- }
+ }
\end{verbatim}
@@ -515,7 +515,7 @@ Whenever you use a \verb|\usepacakge{eqpersec}| command as in
\documentclass[11pt]{article}
\usepackage{eqpersec}
\end{verbatim}
-you will get equations numbered according to you conventions.
+you will get equations numbered according to your conventions.
%%%%%%%%%% %%%%%%%%%%%%%% %%%%%%%%%%%% %%%%%%%%%%%% %%%%%%%% %%%%%%%%%%%%
@@ -523,8 +523,8 @@ you will get equations numbered according to you conventions.
\subsection{A more complex example (Reference Manual)}
\label{refmanex}
-We want to create a layout similar to the one used in the PostScript
-Reference Manual, with a wide left margin for headings and margin
+We want to create a layout similar to the one used in the \textit{PostScript
+Reference Manual}, with a wide left margin for headings and margin
notes and a small margin at the right and bottom.
\subsubsection{Page layout}
@@ -537,7 +537,7 @@ manual. For full details see the file \texttt{refman.dtx}.
\marginlabel{Horizontal:}
First we define two new names for length that we will use often:
-\verb|\fullwidth| is the width of the whole page minus a margin of 1~inch
+\cs{fullwidth} is the width of the whole page minus a margin of 1~inch
on every side.
%
\begin{displaymath}
@@ -550,14 +550,14 @@ From this the width of the text is calculated.
\texttt{textwidth} = \texttt{fullwidth} \times \texttt{textfraction}
\end{displaymath}
%
-\verb|\leftmarginwidth| is the width of the left margin that will be
+\cs{leftmarginwidth} is the width of the left margin that will be
used for headings and margin notes.
\begin{displaymath}
\texttt{leftmarginwidth} = \texttt{fullwidth} - \texttt{textwidth}
\end{displaymath}
%
-This is a little more difficult in reality because the length have to
-be rounded to full points and a possible twocolumn layout -- as used
+This is a little more difficult in reality because the lengths have to
+be rounded to full points and a possible two column layout -- as used
in the index -- must be taken into consideration.
\marginlabel{Vertical:}
@@ -569,7 +569,7 @@ deal with the page header and footer.
\end{displaymath}
%
The result of this calculation is rounded to full lines. Depending on
-the pagestyle -- headings or footings -- it is shifted up or down by one
+the page style -- headings or footings -- it is shifted up or down by one
line.
\vspace{0pt plus 1cm}
@@ -594,12 +594,12 @@ This is the original definition:\nopagebreak
\end{verbatim}
The commands for sub- and subsubsections are similar. Note that the
-measures are all in \texttt{ex} thus depending on the fontsize used.
+measures are all in \texttt{ex}, thus depending on the font size used.
-We define a new command \verb|\secshape| to format the headings. This
+We define a new command \cs{secshape} to format the headings. This
command uses the whole width of the page for the heading. To discourage
hyphenation of the heading we give it a high penalty. This still
-allows hyphenation when absolutely needed.
+allows hyphenation when absolutely necessary.
\begin{verbatim}
\newcommand\secshape{%
@@ -611,7 +611,7 @@ allows hyphenation when absolutely needed.
This command is inserted into the 6th parameter of \verb|\@startsection|.
Since the headings now extend into the left margin, we can use a
-smaller font and reduce a space between the text and the heading. The
+smaller font and reduce the space between the text and the heading. The
new definition looks like the following:\nopagebreak
\begin{verbatim}
\newcommand\section{\@startsection
@@ -630,7 +630,7 @@ The normal layout puts them into the outer margin in twoside layout.
The file \texttt{latex.dtx} contains the definition of the
\verb|\@addmarginpar| command which is responsible for the margin
-notes. We don't have to understand the whole definition, the important
+notes. We don't have to understand the whole definition; the important
part is the internal variable \verb|\@tempcnta| that is either
\verb|\@ne| (1) when the note should appear on the right side of the
text or \verb|\m@ne| ($-1$) when it should appear on the left side.
@@ -660,7 +660,7 @@ depending on the parameter \verb|\@tempcnta| are left unchanged.
The definitions described above are sufficient for simple applications
but in practical use one may want some additional commands.
-\seealso{\ref{refman}} You will find the description for the whole new
+\seealso{Appendix \ref{refman}} You will find the description for the whole new
class in the appendix~\ref{refman}.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -669,6 +669,6 @@ class in the appendix~\ref{refman}.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%\printindex
+\printindex
\end{document}