summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/refman
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/refman')
-rw-r--r--Master/texmf-dist/doc/latex/refman/00Contents23
-rw-r--r--Master/texmf-dist/doc/latex/refman/lay_d2.tex403
-rw-r--r--Master/texmf-dist/doc/latex/refman/lay_e2.tex378
-rw-r--r--Master/texmf-dist/doc/latex/refman/layout_d.pdfbin214846 -> 212034 bytes
-rw-r--r--Master/texmf-dist/doc/latex/refman/layout_d.tex51
-rw-r--r--Master/texmf-dist/doc/latex/refman/layout_e.pdfbin193909 -> 202816 bytes
-rw-r--r--Master/texmf-dist/doc/latex/refman/layout_e.tex328
-rw-r--r--Master/texmf-dist/doc/latex/refman/refman.dvibin204688 -> 0 bytes
-rw-r--r--Master/texmf-dist/doc/latex/refman/refman.pdfbin0 -> 301000 bytes
-rw-r--r--Master/texmf-dist/doc/latex/refman/refman.upl15
10 files changed, 653 insertions, 545 deletions
diff --git a/Master/texmf-dist/doc/latex/refman/00Contents b/Master/texmf-dist/doc/latex/refman/00Contents
new file mode 100644
index 00000000000..7fc08d6c076
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/refman/00Contents
@@ -0,0 +1,23 @@
+00Contents This file
+
+layout_d.tex German description of the refman classes
+
+layout_d.pdf The PDF version of Layout_d formatted for A4
+
+layout_e.tex English description of the refman classes
+
+layout_e.pdf The PDF version of Layout_e formatted for A4
+
+lay_d2.tex Part 2 of the german description
+
+lay_e2.tex Part 2 of the english description
+
+pagepc.sty Package to get pagenumbers in the chapter-page format
+
+refman.dtx The refman classes
+
+refman.pdf The PDF version of refman.dtx
+
+refman.ins The install script
+
+refman.upl A short note about refman recent changes
diff --git a/Master/texmf-dist/doc/latex/refman/lay_d2.tex b/Master/texmf-dist/doc/latex/refman/lay_d2.tex
index 5b355674205..b042e0de325 100644
--- a/Master/texmf-dist/doc/latex/refman/lay_d2.tex
+++ b/Master/texmf-dist/doc/latex/refman/lay_d2.tex
@@ -24,38 +24,38 @@ erzeugt wurde).
\emph{Nicht} zu diesem Bereich geh"oren Kopfzeilen,
Fu"szeilen und Randnoten.
- Der Textbereich hat die Breite {\tt\bs text"-width} und die
- H"ohe {\tt\bs text"-height}.
+ Der Textbereich hat die Breite \cs{text"-width} und die
+ H"ohe \cs{text"-height}.
- Bei zweispaltiger Ausgabe enth"alt der Textbereich zwei
- Spalten, die jeweils {\tt\bs column"-width} breit sind, und
- zwischen ihnen einen Abstand der Breite {\tt\bs
- column"-sep}. Die Spaltenbreite {\tt\bs column"-width} ist also
- etwas geringer als die H"alfte von {\tt\bs text"-width}.
+ Bei zweispaltiger Ausgabe enth"alt der Textbereich zwei Spalten, die
+ jeweils \cs{column"-width} breit sind, und zwischen ihnen einen
+ Abstand der Breite \cs{column"-sep}. Die Spaltenbreite
+ \cs{column"-width} ist also etwas geringer als die H"alfte von
+ \cs{text"-width}.
- {\tt\bs text"-width} bzw.\ {\tt\bs column"-width} soll ein
- Vielfaches der Buchstabenbreite des \verb|\tt|-Fonts sein.
+ \cs{text"-width} bzw.\ \cs{column"-width} soll ein
+ Vielfaches der Buchstabenbreite des \texttt{tt}-Fonts sein.
- {\tt\bs text"-height} soll ein Vielfaches der
- Zeilenh"ohe {\tt\bs baseline"-skip}, vermehrt um die Konstante
- {\tt\bs top"-skip}, sein.
+ \cs{text"-height} soll ein Vielfaches der
+ Zeilenh"ohe \cs{baseline"-skip}, vermehrt um die Konstante
+ \cs{top"-skip}, sein.
- Innerhalb des Textbereichs werden Einr"uckungen mit {\tt\bs
- left"-skip} und {\tt\bs right"-skip} festgelegt. Diese beiden
- Gr"o"sen sollen nicht explizit ver"-"andert werden sondern nur
- implizit durch die Environments.
+ Innerhalb des Textbereichs werden Einr"uckungen mit \cs{left"-skip}
+ und \cs{right"-skip} festgelegt. Diese beiden Gr"o"sen sollen nicht
+ explizit ver"-"andert werden sondern nur implizit durch die
+ Environments.
\item[linker Rand]
- Der Rand links vom Textbereich ist um 1~Inch mehr als {\tt\bs
- odd-} bzw.\ {\tt\bs even"-side"-margin}, je nachdem ob die
+ Der Rand links vom Textbereich ist um 1~Inch mehr als \cs{
+ odd-} bzw.\ \cs{even"-side"-margin}, je nachdem ob die
Seitennummer ungerade oder gerade ist. Normalerweise sind beide
- Gr"o"sen gleich, nur bei der Option {\tt twoside} werden rechte
+ Gr"o"sen gleich, nur bei der Option \texttt{twoside} werden rechte
(=""ungerade) und linke (=""gerade) Seiten verschieden gesetzt.
\item[oberer Rand]
Der Rand oberhalb des Textbereichs ist um 1~Inch mehr als die
- Summe von {\tt\bs top"-margin}, {\tt\bs head"-height} und
- {\tt\bs head"-sep}.
+ Summe von \cs{top"-margin}, \cs{head"-height} und
+ \cs{head"-sep}.
\item[rechter Rand]
Der Rand rechts vom Textbereich ergibt sich aus der
@@ -68,23 +68,23 @@ erzeugt wurde).
\item[Kopfzeilen]\index{Kopfzeilen}
Kopfzeilen ("`Header"') stehen innerhalb des oberen Randes, und
zwar so, da"s zwischen dem unteren Rand der Kopfzeile und dem
- oberen Rand des Textbereichs der Abstand {\tt\bs head"-sep}
+ oberen Rand des Textbereichs der Abstand \cs{head"-sep}
bleibt. Oberhalb der Kopfzeile bleibt ein freier Rand von
- 1~Inch mehr als {\tt\bs top"-margin}.
+ 1~Inch mehr als \cs{top"-margin}.
\item[Fu"szeilen]\index{Fu{\ss}zeilen}
Fu"szeilen ("`Footer"') stehen innerhalb des unteren Randes,
und zwar so, da"s der Abstand vom unteren Rand des
- Textbereichs zum unteren Rand der Fu"s"-zeile {\tt\bs
+ Textbereichs zum unteren Rand der Fu"s"-zeile \cs{
foot"-skip} ist.
\item[Randnoten]\index{Randnoten}
Randnoten ("`Margin Notes"') stehen innerhalb des rechten oder
- linken Randes. Sie haben eine Breite von {\tt\bs
+ linken Randes. Sie haben eine Breite von \cs{
margin"-par"-width}, und zwischen den Randnoten und dem
- Textbereich bleibt ein horizontaler Abstand von {\tt\bs
+ Textbereich bleibt ein horizontaler Abstand von \cs{
margin"-par"-sep}. Der vertikale Abstand zwischen
- aufeinanderfolgenden Randnoten ist mindestens {\tt\bs
+ aufeinanderfolgenden Randnoten ist mindestens \cs{
margin"-par"-push}.
\end{description}
@@ -93,11 +93,11 @@ Die Papierh"ohe setzt sich also von oben nach unten
aus folgenden Elementen zusammen:
\begin{verse}
\rm 1 Inch \\*[2pt]
-\tt \bs topmargin \\*[2pt]
-\bs headheight \\*[2pt]
-\bs headsep \\*[2pt]
-\bs textheight \\*[2pt]
-\bs footskip \\*[2pt]
+\cs{topmargin} \\*[2pt]
+\cs{headheight} \\*[2pt]
+\cs{headsep} \\*[2pt]
+\cs{textheight} \\*[2pt]
+\cs{footskip} \\*[2pt]
\rm Rest der Seite
\end{verse}
@@ -106,34 +106,33 @@ Bei Seiten mit rechten Randnoten
setzt sich die Papierbreite
von links nach rechts aus folgenden Elementen zusammen:
\begin{verse}
-\rm 1 Inch \\*[2pt]
-\tt \bs oddsidemargin\rm\ \ bzw.\ \ \tt \bs evensidemargin \\*[2pt]
-\bs textwidth \\*[2pt]
-\bs marginparsep \\*[2pt]
-\bs marginparwidth \\*[2pt]
+1 Inch \\*[2pt]
+\cs{oddsidemargin}\ \ bzw.\ \ \cs{evensidemargin} \\*[2pt]
+\cs{textwidth} \\*[2pt]
+\cs{marginparsep} \\*[2pt]
+\cs{marginparwidth} \\*[2pt]
\rm Rest der Seite
\end{verse}
-Bei der Option {\tt twoside} besteht die Seitenbreite
+Bei der Option \texttt{twoside} besteht die Seitenbreite
von linken Seiten mit linken Randnoten
aus folgenden Elementen:
\begin{verse}
\rm 1 Inch \\*[2pt]
-\tt \bs evensidemargin \\*[2pt]
-\bs textwidth \\*[2pt]
+\cs{evensidemargin} \\*[2pt]
+\cs{textwidth} \\*[2pt]
\rm Rest der Seite
\end{verse}
\marginlabel{Anmerkungen:}
-Die Gr"o"sen {\tt \bs topmargin}, {\tt \bs oddside"-margin} und {\tt
-\bs evenside"-margin} k"onnen auch negative Werte haben, dann ergibt
-sich an der betreffenden Stelle ein Rand von weniger als 1~Inch.
-Auch {\tt\bs left"-skip} und {\tt\bs right"-skip} k"onnen negative
-Werte haben, dann ragt der Text entsprechend aus dem Textbereich
-heraus. Ausf"uhrlichere Hinweise und Skizzen zu diesem Thema findet
-man unter anderem in der Zeitschrift {\sc TUGboat} Vol.9, No.1 (April
-1988).
-
-Die Gr"o"se {\tt \bs footheight} ist in \LaTeX2e\ \emph{nicht}
+Die Gr"o"sen \cs{topmargin}, \cs{oddside"-margin} und \cs{evenside"-margin}
+k"onnen auch negative Werte haben, dann ergibt sich an der betreffenden
+Stelle ein Rand von weniger als 1~Inch. Auch \cs{left"-skip} und
+\cs{right"-skip} k"onnen negative Werte haben, dann ragt der Text
+entsprechend aus dem Textbereich heraus. Ausf"uhrlichere Hinweise und
+Skizzen zu diesem Thema findet man unter anderem in der Zeitschrift {\sc
+TUGboat} Vol.9, No.1 (April 1988).
+
+Die Gr"o"se \cs{footheight} ist in \LaTeX2e\ \emph{nicht}
mehr definiert, da sie anscheinend von niemandem benutzt wurde.
@@ -466,13 +465,13 @@ mehr definiert, da sie anscheinend von niemandem benutzt wurde.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section{Beschreibung der Style-Option REFMAN}
+\section{Beschreibung der Dokumentklasse Refman}
\label{refman}
Am EDV-Zentrum der TU Wien wurde -- aufbauend auf den in
den vorangegangenen Kapiteln angef"uhrten Grunds"atzen -- eine
-Style-Option {\tt refman} zu den \LaTeX-Styles {\tt article} und {\tt
-report} entwickelt, die ein Layout f"ur Reference Manuals, technische
+Style-Option \texttt{refman} zu den \LaTeX-Styles \texttt{article} und
+\texttt{report} entwickelt, die ein Layout f"ur Reference Manuals, technische
Beschreibungen und dergleichen realisiert. Das Layout entspricht im
wesentlichen den Angaben in Abschnitt~\ref{refmanex}: Die normalen
Textseiten haben einen breiten linken Rand, der f"ur "Uberschriften
@@ -487,7 +486,7 @@ Papierformate zu unterst"uzen. Au"serdem gibt es neben der
\texttt{article}-"ahnliche
\texttt{refart}-Class\index{Refart.cls}, die sich durch andere
Eintr"age in Kopf- und Fu"s-Zeile sowie das Fehlen der
-Gliederungsebene \texttt{chapter} vom \texttt{refrep}
+Gliederungsebene \texttt{chapter} von \texttt{refrep}
unterscheidet.
Die derzeitige Version dieser Class wird im folgenden kurz in Hinblick
@@ -507,7 +506,7 @@ f"ur das von dieser Class bewirkte Layout.
Im \LaTeX\ Local Guide ist jeweils angegeben, ob und wo dieses oder
ein "ahnliches Class-File in einer bestimmten
\LaTeX-""Installation verf"ugbar ist. Der Aufruf erfolgt durch die
-Angabe der Class {\tt refart} im Befehl \verb|\documentclass|,
+Angabe der Class \texttt{refart} im Befehl \cs{documentclass},
also \zB~mit
\begin{verbatim}
\documentclass[11pt,a4paper]{refart}
@@ -519,8 +518,8 @@ also \zB~mit
Die Class \texttt{refart} ersetzt die Class \texttt{article} und
die Class \texttt{refrep} die Class \texttt{report}. Sie kann
-\emph{nicht} mit den folgenden Optionen verwendet werden:
-{\tt twocolumn}.
+\emph{nicht} mit der folgenden Option verwendet werden:
+\texttt{twocolumn}.
Da es sich jetzt um eine selbstst"andige Class handelt, sind folgende
Optionen m"oglich:
@@ -537,11 +536,11 @@ Sie \emph{kann} auch mit zahlreichen anderen Optionen kombiniert
werden, auch \zB\ mit \texttt{twoside} oder \texttt{fleqn}. Die
Option \texttt{titelpage} erzeugt bei der \texttt{refart}-Class
eine eigene Titelseite. Bei der Class \texttt{refrep} ist dies
-die Standarteinstellung.
+die Standardeinstellung.
-Die Classes {\tt refart} und {\tt refrep} unter"-st"utzen nur
-die einspaltige Ausgabe, die Befehle \verb|\twocolumn| und
-\verb|\onecolumn| k"onnen in diesem Fall \emph{nicht} verwendet
+Die Classes \texttt{refart} und \texttt{refrep} unter"-st"utzen nur
+die einspaltige Ausgabe, die Befehle \cs{twocolumn} und
+\cs{onecolumn} k"onnen in diesem Fall \emph{nicht} verwendet
werden.
Der Index wird automatisch zweispaltig gesetzt. Das Layout entspricht
@@ -552,112 +551,119 @@ wie im Rest des Dokumentes.
\subsubsection{Seitenaufteilung}
-\index{Seitenaufteilung, horizontal}\marginlabel{Horizontal:}
-Die komplette gen"utzte Breite (\verb|\fullwidth|) berechnet
-sich so, da"s am Papier rechts und links noch jeweils 1~Inch
-freier Rand bleiben. Die Zeilenl"ange des normalen Textes
-(\verb|\textwidth|) und alle davon abgeleiteten Gr"o"sen
-betragen 70\% der \verb|\fullwidth|. Die Breite des Randes
-(\verb|\leftmarginwidth|), der links vom normalen Textbereich
-f"ur "Uberschriften und Randnoten verwendet wird, ergibt sich
-aus der Differenz von \verb|\fullwidth| und \verb|\textwidth|.
-
-\index{Seitenaufteilung, vertikal}\marginlabel{Vertikal:}
-Die Texth"ohe berechnet sich so, da"s ein oberer und unterer Rand von
-1~Inch bleibt.
+\index{Seitenaufteilung, horizontal}\marginlabel{Horizontal:} Die
+komplette gen"utzte Breite (\cs{fullwidth}) berechnet sich so, da"s am
+Papier rechts und links noch jeweils 1~Inch freier Rand bleiben. Die
+Zeilenl"ange des normalen Textes (\cs{textwidth}) und alle davon
+abgeleiteten Gr"o"sen betragen 70\% der \cs{fullwidth}. Die Breite des
+Randes (\cs{leftmarginwidth}), der links vom normalen Textbereich f"ur
+"Uberschriften und Randnoten verwendet wird, ergibt sich aus der
+Differenz von \cs{fullwidth} und \cs{textwidth}.
+
+\index{Seitenaufteilung, vertikal}\marginlabel{Vertikal:} Die Texth"ohe
+berechnet sich so, da"s ein oberer und unterer Rand von 1~Inch bleibt.
Manche Pagestyles verwenden einen anderen Wert f"ur den oberen Rand.
(siehe \ref{pagestyle}).
-Es wird kein vertikaler Randausgleich gemacht (\verb|\raggedbottom|).
+Mit der Option \texttt{smallborder} wird der Rand auf 0,25~Inch verringert.
+
+Der Rand kann durch den Befehl
+\verb|\setlength\papermarginwidth|\verb|{0.25in}| umdefiniert werden,
+danach ist der Befehl \verb|\setpagefraction{0.7}| aufzurufen, um das
+neue Layout zu berechnen. Dies funktioniert nur in der Pr"aambel. Die
+Blattgr"o"se wird dem DVI-Treiber mitgeteilt, wenn die Option
+\texttt{pagesize} angegeben wird.
+
+Es wird kein vertikaler Randausgleich gemacht (\cs{raggedbottom}).
\subsubsection{Kapitel-"Uberschriften}
-Die "Uberschriften von \verb|\section|, \verb|\subsection| und
-\verb|\subsubsection| verwenden die gesamte Seitenbreite, \dH\ sie
-ragen in den linken Rand hinaus. Daf"ur werden kleinere vertikale
-Abst"ande vor und nach den "Uberschriften und eine weniger gro"se
-Schrift verwendet. In den "Uberschriften werden keine Wort"-abteilungen
-und kein rechter Randausgleich gemacht.
-
-Beim Style {\tt refart} werden die von \verb|\maketitle| und
-\verb|\part| erzeugten "Uberschriften im folgenden Layout gesetzt: Sie
-stehen am Beginn einer neuen Seite (\verb|\clearpage|), verwenden die
-gesamte Breite und sind von zwei waagrechten Linien eingeschlossen. Der
-Befehl \verb|\maketitle| setzt die "Uberschrift (\verb|\title|) und den
-Autor (\verb|\author|). Der Befehl \verb|\makeauthor|, wird nicht mehr
-unterst"utzt. Beim Befehl \verb|\part| wird nur die r"omische Nummer
-des Abschnitts vor den Text gesetzt (ohne das Wort "`Part"' oder
-"`Teil"').
-
-Beim Style {\tt refrep} werden Kapitel-"Uberschriften
-(\verb|\chapter|) im folgenden Layout gesetzt: Sie stehen am
-Beginn einer neuen Seite (\verb|\clearpage|), verwenden die
-gesamte Breite und sind von zwei waagrechten Linien
-eingeschlossen. Die Befehle \verb|\maketitle| und \verb|\part|
-bleiben in diesem Style unver"-"andert, es wird aber empfohlen,
-sie in ein Fullpage-""Environment (siehe \ref{fullpage})
+Die "Uberschriften von \cs{section}, \cs{subsection} und
+\cs{subsubsection} verwenden die gesamte Seitenbreite, \dH\ sie ragen in
+den linken Rand hinaus. Daf"ur werden kleinere vertikale Abst"ande vor
+und nach den "Uberschriften und eine weniger gro"se Schrift verwendet.
+In den "Uberschriften werden keine Wort"-abteilungen und kein rechter
+Randausgleich gemacht.
+
+Beim Style \texttt{refart} werden die von \cs{maketitle} und \cs{part}
+erzeugten "Uberschriften im folgenden Layout gesetzt: Sie stehen am
+Beginn einer neuen Seite (\cs{clearpage}), verwenden die gesamte Breite
+und sind von zwei waagrechten Linien eingeschlossen. Der Befehl
+\cs{maketitle} setzt die "Uberschrift (\cs{title}) und den Autor
+(\cs{author}). Der Befehl \cs{makeauthor}, wird nicht mehr unterst"utzt.
+Beim Befehl \cs{part} wird nur die r"omische Nummer des Abschnitts vor
+den Text gesetzt (ohne das Wort "`Part"' oder "`Teil"').
+
+Beim Style \texttt{refrep} werden Kapitel-"Uberschriften (\cs{chapter})
+im folgenden Layout gesetzt: Sie stehen am Beginn einer neuen Seite
+(\cs{clearpage}), verwenden die gesamte Breite und sind von zwei
+waagrechten Linien eingeschlossen. Die Befehle \cs{maketitle} und
+\cs{part} bleiben in diesem Style unver"-"andert, es wird aber
+empfohlen, sie in ein Fullpage-""Environment (siehe \ref{fullpage})
einzu"-schlie"sen.
\subsubsection{Abs"atze}
-Abs"atze werden durch einen vertikalen Abstand (\verb|\parskip|) von
-einer halben Zeile getrennt, ohne horizontale Einr"uckung
-(\verb|\parindent| ist Null). Der vertikale Abstand ent"-h"alt einen
-"`stretchable"' Anteil von "`{\tt plus 2pt}"'; dies ver"-gr"o"sert die
-Wahrscheinlichkeit, da"s \LaTeX\ die am besten geeigneten Stellen f"ur
-alle Seitenwechsel findet.
+Abs"atze werden durch einen vertikalen Abstand (\cs{parskip}) von einer
+halben Zeile getrennt, ohne horizontale Einr"uckung (\cs{parindent} ist
+Null). Der vertikale Abstand ent"-h"alt einen "`stretchable"' Anteil von
+"`\texttt{plus 2pt}"'; dies ver"-gr"o"sert die Wahrscheinlichkeit, da"s
+\LaTeX\ die am besten geeigneten Stellen f"ur alle Seitenwechsel findet.
-Die vertikalen Ab"-st"an"-de in den List-""Environments sind so
-gesetzt, da"s sich vor, nach und innerhalb der Environments jeweils
-derselbe Abstand wie zwischen den normalen Ab"-s"atzen ergibt.
+Die vertikalen Ab"-st"an"-de in den List-""Environments sind so gesetzt,
+da"s sich vor, nach und innerhalb der Environments jeweils derselbe
+Abstand wie zwischen den normalen Ab"-s"atzen ergibt.
\subsection{Fu"snoten}
-Das Layout der Fu"snoten wurde an das Absatzlayout angepast, \dH\ auch
+Das Layout der Fu"snoten wurde an das Absatzlayout angepast, \dH\ auch
die Fu"snoten werden ohne Einzug in der ersten Zeile gesetzt.
\subsubsection{Description-Environment}
\index{Description-Environment}
-Das {\tt description}-Environment ist so abge"-"an"-dert, da"s
+Das \texttt{description}-Environment ist so abge"-"an"-dert, da"s
die Item-Labels den gesamten linken Rand verwenden.
-\seealso{\ref{layout}}
+\seealso{Kapitel \ref{layout}}
Beispiele daf"ur finden sich unter anderem in Kapitel~\ref{layout}.
\subsubsection{Positionierung der Randnoten}
-Randnoten (\verb|\marginpar|) werden stets in den linken Rand gesetzt
+Randnoten (\cs{marginpar}) werden stets in den linken Rand gesetzt
und verwenden dessen gesamte Breite.
-Der minimale vertikale Abstand zwischen Randnoten
-(\verb|\marginparpush|) ist auf Null gesetzt, damit m"oglichst keine
-Verschiebung von Randnoten erfolgt.
+Der minimale vertikale Abstand zwischen Randnoten (\cs{marginparpush})
+ist auf Null gesetzt, damit m"oglichst keine Verschiebung von Randnoten
+erfolgt.
\subsubsection{Kopf- und Fu"szeilen, Pagestyles} \label{pagestyle}
\index{Pagestyles}
-Beim Pagestyle {\tt plain} werden die Seitennummern in der
-Fu"s"-zeile jeweils ganz rechts bzw.\ (auf linken Seiten bei der Option
-{\tt twoside}) ganz links au"sen gesetzt.
-
-\index{Headings}
-\index{Myheadings}
-Bei den Pagestyles {\tt headings} und {\tt myheadings} wird
-ebenfalls die gesamte Breite verwendet, und unter die Kopfzeile
-wird eine waagrechte Linie gesetzt. Beim Pagestyle {\tt
-headings} enth"alt die Kopfzeile beim {\tt refart} die
-\verb|\section|-"""Uberschrift auf der linke und die
-\verb|\subsection|-"""Uberschrift auf der linken Seite, beim
-{\tt refrep} die \verb|\chapter|-"""Uberschrift auf der linken
-und die \verb|\section|-"""Uberschrift auf der rechten Seite.
-Die Schrift wird in schr"ager (slanted) Schrift gesetzt.
-
+Beim Pagestyle \texttt{plain} werden die Seitennummern in der
+Fu"s"-zeile jeweils ganz rechts bzw.\ (auf linken Seiten bei der Option
+\texttt{twoside}) ganz links au"sen gesetzt.
+
+\index{Headings} \index{Myheadings} Bei den Pagestyles \texttt{headings}
+und \texttt{myheadings} wird ebenfalls die gesamte Breite verwendet, und
+unter die Kopfzeile wird eine waagrechte Linie gesetzt. Beim Pagestyle
+\texttt{ headings} enth"alt die Kopfzeile beim \texttt{refart} die
+\verb|\section|-"""Uberschrift auf der linke und die
+\verb|\subsection|-"""Uberschrift auf der linken Seite, beim
+\texttt{refrep} die \verb|\chapter|-"""Uberschrift auf der linken und
+die \verb|\section|-"""Uberschrift auf der rechten Seite. Die Schrift
+wird in schr"ager (slanted) Schrift gesetzt.
+
+Seit Version 2.0~e wird f"ur die erste Seite eines Kapitels der
+Pagestyle \texttt{empty} anstelle von \texttt{plain} verwendet. Bei
+Verwendung des Pagestyles \texttt{headings} kamm es zu seltsamen
+Effekten, wenn die erste Seite mit den Pagestyle \texttt{plain} ges"atzt
+wurde.
\index{Footings}
\index{Myfootings}
-Zus"atzlich sind auch Pagestyles {\tt footings} und {\tt myfootings}
+Zus"atzlich sind auch Pagestyles \texttt{footings} und \texttt{myfootings}
definiert, die entsprechende Fu"s"-zeilen (mit einer waagrechten Linie
dar"uber) setzen. Beispiel: Die folgenden Befehle setzen den Kurztitel des
Schrift"-st"ucks in die Fu"s"-zeile:
@@ -666,18 +672,18 @@ Schrift"-st"ucks in die Fu"s"-zeile:
\verb|\markboth{Kurztitel}{Kurztitel}|
\end{verse}
-Die Pagestyles {\tt headings} und {\tt myheadings} setzen den oberen
-Rand auf einen etwas gr"o"seren Wert, um die leere Fu"s"-zeile
-auszugleichen. Die Pagestyles {\tt footings} und {\tt myfootings}
-setzen den oberen Rand auf einen etwas kleineren Wert, um die
-leere Kopf"-zeile auszugleichen. Die Pagestyles {\tt empty} und {\tt
-plain} lassen den Rand unver"-"andert. Daraus ergibt sich: Innerhalb
-eines Schrift"-st"ucks kann man\newline entweder zwischen den
-Pagestyles {\tt headings}, {\tt myheadings}, {\tt empty} und {\tt
-plain}\newline oder zwischen den Pagestyles {\tt footings}, {\tt
-myfootings}, {\tt empty} und {\tt plain}\newline wechseln, aber man
-sollte nicht zwischen {\tt footings}- und {\tt headings}-Seiten
-wechseln.
+Die Pagestyles \texttt{headings} und \texttt{myheadings} setzen den
+oberen Rand auf einen etwas gr"o"seren Wert, um die leere Fu"s"-zeile
+auszugleichen. Die Pagestyles \texttt{footings} und \texttt{myfootings}
+setzen den oberen Rand auf einen etwas kleineren Wert, um die leere
+Kopf"-zeile auszugleichen. Die Pagestyles \texttt{empty} und
+\texttt{plain} lassen den Rand unver"-"andert. Daraus ergibt sich:
+Innerhalb eines Schrift"-st"ucks kann manentweder zwischen den
+Pagestyles \texttt{headings}, \texttt{myheadings} und \texttt{empty}
+\newline oder zwischen den Pagestyles \texttt{footings},
+\texttt{ myfootings} und \texttt{empty}
+wechseln, aber man sollte nicht zwischen \texttt{footings}-
+\texttt{headings}- und \texttt{plain} Seiten wechseln.
\subsection{Zus"atzliche Befehle}
@@ -685,17 +691,18 @@ wechseln.
\subsubsection{Marginlabel}
\index{Marginlabel}
-Der Befehl \verb|\marginlabel{xxx}| setzt das Wort oder den Text {\tt
-xxx} rechts"-b"undig in den linken Rand. Dies kann f"ur Stichworte,
-kurze "Uberschriften von Abs"atzen oder "ahnliches verwendet werden.
+Der Befehl \verb|\marginlabel{xxx}| setzt das Wort oder den Text
+\texttt{ xxx} rechts"-b"undig in den linken Rand. Dies kann f"ur
+Stichworte, kurze "Uberschriften von Abs"atzen oder "ahnliches verwendet
+werden.
-\marginlabel{Beispiel:}Das Wort "`Beispiel:"' links von diesem
-Absatz ist ein Beispiel f"ur einen Marginlabel.
+\marginlabel{Beispiel:}Das Wort "`Beispiel:"' links von diesem Absatz
+ist ein Beispiel f"ur einen Marginlabel.
\subsubsection{Attention}
\index{Attention}\index{Attentionsymbol}\index{manfnt}
-Der Befehl \verb|\attention| setzt ein Achtung-Zeichen in den linken
+Der Befehl \verb|\attention| setzt ein Ausrufungszeichen in den linken
Rand. Dies dient zum Markieren wichtiger Abs"atze oder S"atze.
\attention
@@ -711,17 +718,17 @@ zu ver"andern. Mit
\renewcommand{\attentionsymbol}{\large \bfseries ! $\rightarrow$}
wird wieder auf das Originalverhalten zur"uckgeschaltet.
-Zus"atzlich unterst"utzt der \cs{attention} Befehl ein optionales
+Zus"atzlich unterst"utzt der \cs{attention} Befehl ein optionales
Argument um das Symbol im Rand einmalig durch ein anderes zu ers"atzen.
-In diesem Fall ist es nicht notwendig, das \cs{attentionsymbol}
-zur"uckzus"atzen. Diese Erweiterung dient vor allem zur
-Unterst"utzung f"ur das \texttt{manfnt} Paket und sollte nicht zur
-Erzeugung eines bunten Layouts mi"sbraucht werden.\attention[\texttt{:-(}]
+In diesem Fall ist es nicht notwendig, das \cs{attentionsymbol}
+zur"uckzus"atzen. Diese Erweiterung dient vor allem zur Unterst"utzung
+f"ur das \texttt{manfnt} Paket und sollte nicht zur Erzeugung eines
+bunten Layouts mi"sbraucht werden.\attention[\texttt{:-(}]
-Mit dem \texttt{manfnt} Paket existiert eine einfache M"oglichkeit, um auf
-die Symbole des \texttt{manfnt} Zeichensatzes zuzugreifen. Dieser
-Zeichensatz enth"alt u.a. das "`Dangerous Bend"' und "`Double
-Dangerous Bend"' Zeichen.
+Mit dem \texttt{manfnt} Paket existiert eine einfache M"oglichkeit, um
+auf die Symbole des \texttt{manfnt} Zeichensatzes zuzugreifen. Dieser
+Zeichensatz enth"alt u.a. das "`Dangerous Bend"' und "`Double Dangerous
+Bend"' Zeichen.
\subsubsection{Seealso}
\index{Seealso}
@@ -730,18 +737,18 @@ Der Befehl \verb|\seealso{n}| markiert einen Verweis auf ein Kapitel
oder eine Abbildung.
Beispiele daf"ur finden sich nicht nur hier (am linken Rand)
-sondern unter anderem auch in \seealso{1} Kapitel~1.
+sondern unter anderem auch in \seealso{Kapitel 1} Kapitel~1.
\subsubsection{Maxipage-Environment}
\index{Maxipage}
-Das {\tt maxipage}-Environment ist eine Art von "`Minipage"', die sich
-"uber die gesamte Seitenbreite erstreckt. Dies eignet sich \zB\ f"ur
-"uberlange mathematische Gleichungen oder breite Tabellen innerhalb des
-Textes oder in "`Floats"' ({\tt table} oder {\tt figure}). Innerhalb
-der "`Maxipage"' sind keine Seitenwechsel und keine Randnoten
-m"oglich. Beginn und Ende des {\tt maxipage}-Envrionment bewirken
+Das \texttt{maxipage}-Environment ist eine Art von "`Minipage"', die
+sich "uber die gesamte Seitenbreite erstreckt. Es eignet sich \zB\
+f"ur "uberlange mathematische Gleichungen oder breite Tabellen innerhalb
+des Textes oder in "`Floats"' (\texttt{table} oder \texttt{figure}).
+Innerhalb der "`Maxipage"' sind keine Seitenwechsel und keine Randnoten
+m"oglich. Beginn und Ende des \texttt{maxipage}-Envrionment bewirken
jeweils einen neuen Absatz und eine waagrechte Linie.
Hier folgt nun ein Beispiel f"ur eine Maxipage.\nopagebreak
@@ -755,17 +762,17 @@ Dies ist der normale Text nach dem Ende der Maxipage.
\subsubsection{Fullpage-Environment} \label{fullpage}
\index{Fullpage}
-Das {\tt fullpage}-Environment besteht aus einer oder mehreren
-Seiten, bei denen sich der Text "uber die gesamte Seitenbreite
-erstreckt und kein linker Rand bleibt. Randnoten sind darin nicht
-m"oglich. Beginn und Ende des {\tt fullpage}-Envrionment bewirken
-jeweils einen Seitenwechsel (\verb|\clearpage|).
+Das \texttt{fullpage}-Environment besteht aus einer oder mehreren
+Seiten, bei denen sich der Text "uber die gesamte Seitenbreite erstreckt
+und kein linker Rand bleibt. Randnoten sind darin nicht m"oglich. Beginn
+und Ende des \texttt{fullpage}-Envrionment bewirken jeweils einen
+Seitenwechsel (\verb|\clearpage|).
Dies eignet sich f"ur Spezialseiten wie mehrseitige gro"se
Tabellen, Programmlistings, Titelseiten, Inhaltsverzeichnisse und
"ahnliches.
-\seealso{S.\,\pageref{bild}}
+\seealso{Seite \pageref{bild}}
Seite~\pageref{bild} ist ein Beispiel f"ur eine Fullpage.
\subsubsection{Noparskip}
@@ -785,7 +792,7 @@ Argument mu"s zwischen 0 und 1 liegen.
\subsubsection{Descriptioncolon}
\index{Descriptioncolon}
-Der Doppelpunkt in einer {\tt description} kann durch den Befehl
+Der Doppelpunkt in einer \texttt{description} kann durch den Befehl
\verb|\descriptioncolonfalse| ab und durch \verb|\descriptioncolontrue|
wieder eingeschaltet werden. Im Normalfall ist der Doppelpunkt
eingeschaltet.
@@ -793,15 +800,15 @@ eingeschaltet.
\subsubsection{Descriptionleft}
\index{Descriptionleft}
-Mit \verb|\descriptionlefttrue| wird der Label f"ur eine {\tt
-description} linksb"undig in den Rand gesetzt. Der Normalfall ist
+Mit \verb|\descriptionlefttrue| wird der Label f"ur eine
+\texttt{description} linksb"undig in den Rand gesetzt. Der Normalfall ist
rechtsb"undig, dies wird durch \verb|\descriptionleftfalse| erreicht.
\subsubsection{Maxipagerule}
\index{Maxipagerule}
Mit \verb|\maxipagerulefalse| lassen sich die Striche vor und nach
-einer {\tt maxipage} abschalten. Sie sind normalerweise aktiv.
+einer \texttt{maxipage} abschalten. Sie sind normalerweise aktiv.
\subsubsection{Condbreak}
\index{Condbreak}
@@ -813,8 +820,8 @@ oder werden komplett auf die neue Seite umgebrochen.
\subsubsection{Example}
\index{Example}
-Die {\tt example}-Umgebung erzeugt eine {\tt verse}-Umgebung, schaltet
-allerdings auf \verb|\tt| und versucht einen Seitenumbruch vor der
+Die \texttt{example}-Umgebung erzeugt eine \texttt{verse}-Umgebung, schaltet
+allerdings auf \texttt{tt} und versucht einen Seitenumbruch vor der
Umgebung zu vermeiden.
\subsubsection{Pageperchapter}
@@ -826,7 +833,45 @@ Reference Manuals sinnvoll. Da nur \texttt{refrep} "uber die
Gliederungsebene \texttt{chapter} verf"ugt, ist dieser Befehl
auch nur hier m"oglich.
-\printindex
+\subsubsection{Smallborder}
+\index{Smallborder}
+
+Der normale Seitenrand betr"agt 1~inch (25,4~mm). Das ist f"ur ein gedrucktes
+Dokument in Ordnung, f"ur die Betrachtung auf dem Monitor aber verschwendete
+Bildschirmfl"ache. Die Option \verb|smallborder| reduziert den Rand auf 0,25~inch
+(6,35~mm). Damit klebt der Text noch nicht am Rand, es wird aber auch nicht
+zu viel Bildschirmfl"ache verschenkt.
+
+Der Rand kann durch den Befehl \verb|\setlength\papermarginwidth|\verb|{0.25in}|
+umdefiniert werden, danach ist der Befehl \verb|\setpagefraction{0.7}|
+aufzurufen, um das neue Layout zu berechnen.
+
+\subsubsection{Dvips}
+\index{Dvips}
+
+Die Option \verb|dvips| teilt DVIPS die aktuelle Blattgr"o"se mit.
+
+\subsubsection{Pdftex}
+\index{Pdftex}
+
+Die Option \verb|pdftex| teilt PDFTEX die aktuelle Blattgr"o"se mit.
+
+\subsubsection{Pagesize}
+\index{Pagesize}
+
+Pagesize w"ahlt automatisch den passenden Befehl f"ur den jeweiligen
+DVI-Treiber. Dies funktioniert bei DVIPS und DVIPDFMX f"ur DVI-Ausgabe und
+PDF\TeX f"ur PDF-Ausgabe.
+
+\subsubsection{Ifpdfoutput}
+\index{Ifpdfoutput}
+
+Mit dem Befehl \verb|\ifpdfoutput{pdftext}{dvitext}| k"onnen Texte abh"angig
+vom Ausgabeformat ges"atzt werden. Die Option \verb|pagesize| nutzt diesen
+Befehl.
+
+Die letzten vier Befehle wurden aus KOMA-Script "ubernommen, vielen Dank
+Markus!
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\endinput
diff --git a/Master/texmf-dist/doc/latex/refman/lay_e2.tex b/Master/texmf-dist/doc/latex/refman/lay_e2.tex
index 6450566e427..9590edbfb40 100644
--- a/Master/texmf-dist/doc/latex/refman/lay_e2.tex
+++ b/Master/texmf-dist/doc/latex/refman/lay_e2.tex
@@ -10,10 +10,10 @@
\section{The page structure in \LaTeX}
-This appendix describes how the actual page is build from it's
-components and how they are influenced by \TeX s parameters
-(\seealso{Fig.\,\ref{bild}}. Figure~\ref{bild} has been created by
-Nelson Beebe at the University of Utah.
+This appendix describes how the actual page is build from its
+components and how they are influenced by \TeX{}'s parameters.
+(\seealso{Fig.\,\ref{bild}} Figure~\ref{bild} has been created by
+Nelson Beebe at the University of Utah.)
\begin{description}
@@ -22,39 +22,32 @@ Nelson Beebe at the University of Utah.
including footnotes, tables and figures. The headings, footer
and margin notes do \emph{not} belong to the text area.
- The text area has the width \texttt{\textbackslash textwidth}
- and the height \texttt{\textbackslash text\-height}.
+ The text area has the width \cs{textwidth}
+ and the height \cs{text\-height}.
- In a twocolumn layout the text area is split into two
- columns, with the width \texttt{\textbackslash columnwidth}
- each and a space of \texttt{\textbackslash columnsep} between
- them. Thus the \texttt{\textbackslash columnwidth} is a
- little bit smaller than half the \texttt{\textbackslash
- textwidth}.
+ In a two column layout the text area is split into two columns, with
+ the width \cs{columnwidth} each and a space of \cs{columnsep} between
+ them. Thus the \cs{columnwidth} is a little bit smaller than half
+ the \cs{textwidth}.
- \texttt{\textbackslash textwidth} and \texttt{\textbackslash
- columnwidth} should be a multiple of the width of one
- character in the \texttt{tt} font.
+ \cs{textwidth} and \cs{columnwidth} should be a multiple of the
+ width of one character in the \texttt{tt} font.
- \texttt{\textbackslash textheight} should be multiple of the
- line height \texttt{\textbackslash baselineskip}, increased by
- the constant value of \texttt{\textbackslash topskip}.
+ \cs{textheight} should be multiple of the line height
+ \cs{baselineskip}, increased by the constant value of \cs{topskip}.
- Indentations inside the text area are defined with
- \texttt{\textbackslash leftskip} and \texttt{\textbackslash
- rightskip}. These parameters should not be changed explicit
- by the user but rather implicit through environments.
+ Indentations inside the text area are defined with \cs{leftskip} and
+ \cs{rightskip}. These parameters should not be changed explicitly
+ by the user but rather implicitly through environments.
\item[left margin]
- The left margin is either \texttt{\textbackslash odd-} or
- \texttt{\textbackslash evensidemargin} increased by 1~inch.
- Both parameters have the same value, unless the
+ The left margin is either \cs{odd-} or \cs{evensidemargin} plus
+ 1~inch. Both parameters have the same value, unless the
\texttt{twoside} option is given.
\item[top margin]
- The top margin is the sum of \texttt{\textbackslash
- topmargin}, \texttt{\textbackslash headheight} and
- \texttt{\textbackslash headsep} increased by 1~inch.
+ The top margin is the sum of \cs{topmargin}, \cs{headheight} and
+ \cs{headsep} plus 1~inch.
\item[right margin]
The right margin is the paper width minus the left margin and
@@ -65,69 +58,63 @@ Nelson Beebe at the University of Utah.
the text area.
\item[heading]\index{headings}
- The heading is inside the top margin with a space of
- \texttt{\textbackslash headsep} between the lower border of
- the header and the upper border of the text area. Above the
- header is a free space of \texttt{\textbackslash topmargin}
+ The heading is inside the top margin with a space of \cs{headsep}
+ between the lower border of the header and the upper border of the
+ text area. Above the header is a free space of \cs{topmargin}
increased by 1~inch.
-\item[footing]\index{footings}
- The footer is inside the bottom margin with a space of
- \texttt{\textbackslash footskip} between the lower border of the text
- area and the lower border of the footer.
+\item[footing]\index{footings} The footer is inside the bottom margin with a
+ space of \cs{footskip} between the lower border
+ of the text area and the lower border of the footer.
-\item[margin notes]\index{margin notes}
- Margin notes are inside the left or right margin. They have a
- width of \texttt{\textbackslash marginparwidth} and a space of
- \texttt{\textbackslash marginparsep} between the margin note
- and the text area. The vertical space between two margin
- notes is \texttt{\textbackslash marginparpush}.
+\item[margin notes]\index{margin notes} Margin notes are inside the left or
+ right margin. They have a width of \cs{marginparwidth} and a space
+ of \cs{marginparsep} between the margin note and the text area. The
+ vertical space between two margin notes is \cs{marginparpush}.
\end{description}
-The paperheight consists of the following elements (from top to
+The \texttt{paperheight} consists of the following elements (from top to
bottom):
\begin{verse}
-\rmfamily 1 Inch \\*[2pt]
-\ttfamily \textbackslash topmargin \\*[2pt]
-\textbackslash headheight \\*[2pt]
-\textbackslash headsep \\*[2pt]
-\textbackslash textheight \\*[2pt]
-\textbackslash footskip \\*[2pt]
-\rmfamily remaining page.
+1 inch \\*[2pt]
+\cs{topmargin} \\*[2pt]
+\cs{headheight} \\*[2pt]
+\cs{headsep} \\*[2pt]
+\cs{textheight} \\*[2pt]
+\cs{footskip} \\*[2pt]
+remaining page.
\end{verse}
-On pages with margin notes in the right margin the paperwidth consists
+On pages with margin notes in the right margin the \texttt{paperwidth} consists
of the following elements:
\begin{verse}
-\rmfamily 1 Inch \\*[2pt]
-\ttfamily \textbackslash oddsidemargin
-\rmfamily\ \ or\ \
-\ttfamily \textbackslash evensidemargin \\*[2pt]
-\textbackslash textwidth \\*[2pt]
-\textbackslash marginparsep \\*[2pt]
-\textbackslash marginparwidth \\*[2pt]
-\rm remaining page
+1 inch\\*[2pt]
+\cs{oddsidemargin}
+\ \ or\ \
+\cs{evensidemargin}\\*[2pt]
+\cs{textwidth}\\*[2pt]
+\cs{marginparsep}\\*[2pt]
+\cs{marginparwidth}\\*[2pt]
+remaining page
\end{verse}
With the option \texttt{twoside} the left pages change to
\begin{verse}
-\rmfamily 1 Inch \\*[2pt]
-\ttfamily \textbackslash evensidemargin \\*[2pt]
-\textbackslash textwidth \\*[2pt]
-\rmfamily remaining page
+1 inch\\*[2pt]
+\cs{evensidemargin}\\*[2pt]
+\cs{textwidth}\\*[2pt]
+remaining page
\end{verse}
-\marginlabel{Comments:} The parameters \texttt{\textbackslash
-topmargin}, \texttt{\textbackslash oddsidemargin} and
-\texttt{\textbackslash evensidemargin} may be negative. In this case
-the margin will be smaller than 1~inch. The same is true for
-\texttt{\textbackslash leftskip} and \texttt{\textbackslash
-rightskip} which leads to text that is wider than the text area.
+\marginlabel{Comments:} The parameters \cs{topmargin}, \cs{oddsidemargin},
+and \cs{evensidemargin} may be negative. In this case, the margin will be
+smaller than 1~inch. The same is true for \cs{leftskip} and \cs{rightskip}
+which leads to text that is wider than the text area.
Extensive treatment and figures to this subject may be found in the
\textsc{TUGboat} Vol.9, No.1 (April 1988).
-The parameter \texttt{\textbackslash footheight} is no longer defined
+The parameter \cs{footheight} is no longer defined
in \LaTeXe\ since no-one used it.
@@ -463,24 +450,23 @@ in \LaTeXe\ since no-one used it.
\section{Description of the refman-class family}
\label{refman}
-The \texttt{refman.sty} was defined at the EDV-Zentrum (computing
-center) of the TU Wien. This layout is suitable for reference
-manuals, technical descriptions and similar applications. It is based
-on the ideas shown in previous sections: The layout has a wide left
-margin for headings and margin notes and smaller margins on the right
-side, the top and the bottom.
+The \texttt{refman.sty} was defined at the EDV-Zentrum (computing center) of
+the TU\footnote{Technical University} Wien. This layout is suitable for
+reference manuals, technical descriptions and similar applications. It is
+based on the ideas shown in previous sections: The layout has a wide left
+margin for headings and margin notes and smaller margins on the right side,
+the top and the bottom.
In 1994 this layout was re-implemented as a class for the new \LaTeXe.
-This made it possible to include some minor improvements, like the
+This made it possible to include some minor improvements, such as the
support of different paper sizes. The \texttt{refman.sty} was split
into two classes
-\texttt{refrep}\index{refrep.cls} similar to \texttt{report} and
-\texttt{refart}\index{refart.cls} similar to \texttt{article}.
+\texttt{refrep}\index{refrep.cls}, similar to \texttt{report} and
+\texttt{refart}\index{refart.cls}, similar to \texttt{article}.
These classes differ in the layout of the header and footer. The
-\texttt{refart} does not support the \texttt{\textbackslash chapter}
-command.
+\texttt{refart} does not support the \cs{chapter} command.
-The current version of this class is described in this document. If
+The current version of both classes is described in this document. It
serves as an example for the layout.
@@ -490,7 +476,7 @@ serves as an example for the layout.
The \LaTeX\ local guide (if available) shows if this class is available
at your \TeX\ installation or where to install it. To use the
-\texttt{refart} class, simply call it with the \verb|\documentclass|
+\texttt{refart} class, simply call it with the \cs{documentclass}
command:
\begin{verbatim}
@@ -505,15 +491,13 @@ The \texttt{refart} class replaces \texttt{article} and \texttt{refrep}
replaces \texttt{report}. They support all options of these classes
except for the \texttt{twocolumn} option.
-It supports the additional option \texttt{square} which makes the
-\texttt{\textbackslash textheight} equal to the
-\texttt{\textbackslash textwidth}.
+It supports the additional option \texttt{square} which makes the
+\cs{textheight} equal to the \cs{textwidth}.
-Neither \texttt{refart} nor \texttt{refrep} support twocolumn
-layout, thus the commands \verb|\twocolumn| and \verb|\onecolumn|
-must not be used.
+Neither \texttt{refart} nor \texttt{refrep} support two column layout, thus
+the commands \cs{twocolumn} and \cs{onecolumn} must not be used.
-The index will be set in twocolumn format and you can't change it
+The index will be set in two column format and you can't change it
with the means of this class.
\subsection{Layout changes}
@@ -521,52 +505,56 @@ with the means of this class.
\subsubsection{Page design}
\index{page design, horizontal}\marginlabel{Horizontal:}
-In this design the usable area for text (\verb|\fullwidth|) is
-calculated as the paper width minus 2~inch. Only a fraction of this
-width is used for the running text (\verb|\textwidth|), the remaining
-part forms a wide left margin (\verb|\leftmarginwidth|) which is used
-for headings and margin notes. The \verb|\textwidth| is 70~\% of the
-\verb|\fullwidth| by default, but this can be changed with the
-\verb|\settextfraction| command\index{settextfraction} which accepts
-arguments between 0 and 1.
+In this design the usable area for text (\cs{fullwidth}) is
+calculated as the paper width minus 2~\cs{papermarginwidth}. The default
+value for \cs{papermarginwidth}\index{papermarginwidth} is 1~Inch.
+The option \texttt{smallborder} reduces \cs{papermarginwidth} to 0.25~Inch.
+This is more suitable for documents viewed on screen, especially when
+combined with the \texttt{a5paper} and \texttt{landscape} options.
-\index{page design, vertical}\marginlabel{Vertical:}
-The text height is calculated as the paper height minus 2~inch. This
-leaves a top margin of 1~inch, which is modified by some pagestyles
-(see \ref{pagestyle}).
+Only a fraction of this width is used for the running text (\cs{textwidth}),
+the remaining part forms a wide left margin (\cs{leftmarginwidth}) which is
+used for headings and margin notes. The \cs{textwidth} is 70~\% of the
+\cs{fullwidth} by default, but this can be changed with the
+\cs{settextfraction} command\index{settextfraction} which accepts arguments
+between 0 and 1.
+
+\index{page design, vertical}\marginlabel{Vertical:} The text height is
+calculated as the paper height minus 2~\cs{papermarginwidth}. The
+\texttt{topmargin} is modified by some pagestyles. (see \ref{pagestyle}).
The pages are always set with a ragged bottom.
\subsubsection{Section headings}
-The headings for \verb|\section|, \verb|\subsection| and
-\verb|\subsubsection| extend into the left margin, thus using the full
+The headings for \cs{section}, \cs{subsection}, and
+\cs{subsubsection} extend into the left margin, thus using the full
width of the page. They are not justified and hyphenation is
discouraged. A small space is kept free above and below the heading.
-Headings for \verb|\section| and \verb|\subsection| are set in a bold
+Headings for \cs{section} and \cs{subsection} are set in a bold
font.
The \texttt{refrep} class defines a different layout for the
-\verb|\chapter| command: It always starts a new page and prints the
+\cs{chapter} command: It always starts a new page and prints the
chapter headings in a large bold font with a thick line above and
below. This heading uses the full width of the page.
-A similar heading is created by the \verb|\part| commands which is
+A similar heading is created by the \cs{part} commands which is
available in both classes. It uses a roman part number instead of the
arabic section number.
-The \verb|\maketitle| commands sets the title of the document in the
-same layout when no special titlepage is requested. (This is the
-default for \texttt{refart}. To suppress the titlepage in a
+The \cs{maketitle} commands sets the title of the document in the
+same layout when no special title page is requested. (This is the
+default for \texttt{refart}. To suppress the title page in a
\texttt{refrep} document, you can use the \texttt{notitlepage} option.)
The name of the author and the date is printed in italic flush right
below the document title.
\subsubsection{Paragraphs}
-Paragraphs are separated by a vertikal space (\verb|\parskip|) of
-half a line (\verb|0.5\baselineskip|) plus a strechtable length of 2pt.
+Paragraphs are separated by a vertical space (\cs{parskip}) of
+half a line (\verb|0.5\baselineskip|) plus a stretchable length of 2~pt.
Paragraphs are not indented.
The vertical spacing inside, above and below a list environment is the
@@ -588,12 +576,12 @@ solve this.
The \texttt{description} environment will use the whole left margin
for the description label.
-\seealso{\ref{layout}}
+\seealso{Section \ref{layout}}
You will find examples in the section~\ref{layout}.
\subsubsection{Positioning of margin notes}
-Margin notes (\verb|\marginpar|) are always put into the left margin.
+Margin notes (\cs{marginpar}) are always put into the left margin.
They use the whole width of the margin.
The minimum space between two margin notes is set to 0 to prevent
@@ -602,20 +590,17 @@ them from being shifted around when many margin notes are used.
\subsubsection{Headers and Footers} \label{pagestyle}
\index{pagestyle}
-The pagestyle \texttt{plain} puts the page number into the footer in
+The page style \texttt{plain} puts the page number into the footer in
the right corner. When the option \texttt{twoside} is active, the page
number of left pages is put into the left corner.
-\index{headings}
-\index{myheadings}
-The pagestyles \texttt{headings} and \texttt{myheadings} create a
-header which spans the whole width of the page. The headings contain
-the running head (\verb|\section| and \verb|\subsection| in
-\texttt{refart} and \verb|\chapter| and \verb|\section| in
-\texttt{refrep}) when \texttt{headings} is used or a fixed text that can
-defined with the \texttt{\textbackslash markboth} command when
-\texttt{myheadings} is used. The heading will be set in a slanted
-font and separated from the body by a thin line.
+\index{headings} \index{myheadings} The pagestyles \texttt{headings} and
+\texttt{myheadings} create a header which spans the whole width of the page.
+The headings contain the running head (\cs{section} and \cs{subsection} in
+\texttt{refart} and \cs{chapter} and \cs{section} in \texttt{refrep}) when
+\texttt{headings} is used or a fixed text that can defined with the
+\cs{markboth} command when \texttt{myheadings} is used. The heading will be
+set in a slanted font and separated from the body by a thin line.
\index{footings}
\index{myfootings}
@@ -624,27 +609,32 @@ for footers, which is used in this documentation. The information is
exactly the same as in the headings but now printed in the footer with
a thin line above.
-To use a userdefined string you can say:
+To use a user-defined string you can say:
\begin{verbatim}
\pagestyle{myfootings} % or myheadings
\markboth{left title}{right title}
\end{verbatim}
-The \texttt{heading} and \texttt{myheading} commands increase the top
-margin by one line while the \texttt{footings} and
-\texttt{myfootings} commands decrease the top margin by one line.
-The pagestyles \texttt{empty} and \texttt{plain} leave the top margin
-unchanged. You should not combine headings and footings in one document.
+The \texttt{heading} and \texttt{myheading} commands increase the top margin
+by one line while the \texttt{footings} and \texttt{myfootings} commands
+decrease the top margin by one line. The page styles \texttt{empty} and
+\texttt{plain} leave the top margin unchanged. You should not combine
+headings and footings in one document.
+
+User feedback has shown that it is not a good idea to combine \texttt{plain}
+and \texttt{(my)heading} either. Therefore I changed the layout of the
+\cs{chapter} page to \texttt{empty}. Maybe it is necessary to define a
+\texttt{hplain} and \texttt{fplain} pagestyle or to define some magic to use
+the correct definition of \texttt{plain}. Feedback is welcome.
\subsection{Additional commands}
\subsubsection{Marginlabel}
\index{marginlabel}
-The command \verb|\marginlabel{xxx}| prints the text \texttt{xxx} right
-justified into the left margin. Please note that a
-\texttt{\textbackslash marginpar} will print it left justified.
-
+The command \verb|\marginlabel{xxx}| prints the text \texttt{xxx} right
+justified into the left margin. Please note that a \cs{marginpar} will print
+it left justified.
\marginlabel{Example:} The word ``Example'' in the left margin is
printed with the command \verb|\marginlabel{Example:}|
@@ -653,7 +643,7 @@ printed with the command \verb|\marginlabel{Example:}|
\index{attention}\index{attentionsymbol}\index{manfnt}
The command \cs{attention} puts an exclamation mark with an arrow
-pointing to the text into the left margin.\attention This is an
+pointing to the text into the left margin.\attention{} This is an
example for \cs{attention}.
\renewcommand{\attentionsymbol}{\texttt{:-)}}
@@ -665,37 +655,34 @@ command. To get the default back use
\verb|\renewcommand{\attentionsymbol}| \verb|{\large \bfseries ! $\rightarrow$}|
\renewcommand{\attentionsymbol}{\large \bfseries ! $\rightarrow$}
-Since version 2.0c \cs{attention} takes an optional argument to
-define the symbol used in the margin. Thus you can change the symbol
-once without having to restore it later. Do not abuse this
-feature\attention[\texttt{:-(}], it is primarily meant as an support
-for the manfnt package to substitute the ``dangerous bend'' by a
-``double dangerous bend''.
+Since version 2.0c \cs{attention} takes an optional argument to define the
+symbol used in the margin. Thus you can change the symbol once, without
+having to restore it later. Do not abuse this
+feature\attention[\texttt{:-(}], it is primarily meant as an support for the
+\texttt{manfnt} package which enables you to use the ``dangerous bend'' and
+``double dangerous bend'' signs.
-If you have the manfnt-font available you can use the enclosed
-\texttt{manfnt} package. It gives you easy
-access to the symbols defined in this font.
+The \texttt{manfnt} package is no longer enclosed with Refman, it
+has grown and is now a package of its own.
\subsubsection{Seealso}
\index{seealso}
The command \verb|\seealso{n}| prints an arrow and its argument into
the left margin. You will find examples for this in the left margin
-and in \seealso{1} chapter~1.
+and in \seealso{Chapter 1} chapter~1.
\subsubsection{Maxipage environment}
\index{maxipage}
-The \texttt{maxipage} environment is a special kind of
-\texttt{minipage} which extends over the full width of the page. It
-can be used for long formulas or \texttt{tabular} environments. You may
-use \texttt{maxipage} environments inside floats. You cannot use
-margin notes inside a \texttt{maxipage} and no pagebreak will occur
-while in a \texttt{maxipage}. A \texttt{maxipage} is always a
-paragraph of its own with a thick line above and below. You can
-disable these lines with the \texttt{\textbackslash
-maxipagerulefalse}\index{maxipagerule}
-command. They are on by default.
+The \texttt{maxipage} environment is a special kind of \texttt{minipage}
+which extends over the full width of the page. It can be used for long
+formulas or \texttt{tabular} environments. You may use \texttt{maxipage}
+environments inside floats. You cannot use margin notes inside a
+\texttt{maxipage} and no page break will occur while in a \texttt{maxipage}.
+A \texttt{maxipage} is always a paragraph of its own with a thick line above
+and below. You can disable these lines with the
+\cs{maxipagerulefalse}\index{maxipagerule} command. They are on by default.
The following paragraph is an example for a \texttt{maxipage}:
\nopagebreak
@@ -708,61 +695,59 @@ This is normal text after the \texttt{maxipage}.
\subsubsection{Fullpage environment} \label{fullpage}
\index{fullpage}
-The \texttt{fullpage} environment consists of one ore more pages where
+The \texttt{fullpage} environment consists of one or more pages where
the text extends over the full width of the page. You cannot use
margin notes inside a \texttt{fullpage} environment. A \texttt{fullpage}
will always start and end on a page of its own. It may be used for
large tables, program listings or anything that does not fit into the
normal layout.
-\seealso{See page \pageref{bild}}
+\seealso{Page \pageref{bild}}
Page~\pageref{bild} is an example for a \texttt{fullpage}.
\subsubsection{Noparskip}
-The \verb|\noparskip| removes the vertical space between two
-paragraphs. It is similar to the \verb|\noindent| command that removes
+The \cs{noparskip} removes the vertical space between two
+paragraphs. It is similar to the \cs{noindent} command that removes
the indent of the first line of a paragraph.
\subsubsection{Setleftmarginwidth}
\index{setleftmarginwidth}
-The \verb|\setleftmarginwidth| command is no longer supported. You can
-achieve similar results by using the \verb|\settextfraction| command.
+The \cs{setleftmarginwidth} command is no longer supported. You can
+achieve similar results by using the \cs{settextfraction} command.
\subsubsection{Descriptioncolon}
\index{descriptioncolon}
-By default a colon is printed after the description label.
-The command \texttt{\textbackslash description\-colonfalse} disables
-the colon, the \texttt{\textbackslash description\-colontrue}
-re-enables ist.
+By default a colon is printed after the description label. The command
+\cs{description\-colonfalse} disables the colon, the
+\cs{description\-colontrue} re-enables it.
\subsubsection{Descriptionleft}
\index{descriptionleft}
-The \verb|\descriptionlefttrue| command sets the description label
+The \cs{descriptionlefttrue} command sets the description label
left justified into the margin. The default is right justified which
-will be achieved with \verb|\descriptionleftfalse|
+will be achieved with \cs{descriptionleftfalse}
\subsubsection{Maxipagerule}
\index{maxipagerule}
-You can disable the rules before and after a \texttt{maxipage} with
-the \texttt{\textbackslash maxipage\-rulefalse} command and re-enable
-them with the \texttt{\textbackslash maxipageruletrue} command. The
-default is on. You should not mix \texttt{maxipage}s with and without
-rules in one document.
+You can disable the rules before and after a \texttt{maxipage} with the
+\cs{maxipage\-rulefalse} command and re-enable them with the
+\cs{maxipageruletrue} command. The default is on. You should not mix
+\texttt{maxipage}s with and without rules in one document.
\subsubsection{Condbreak}
\index{condbreak}
The command \verb|\condbreak{2cm}| ensures, that the next 2~cm are
either completely on this page or completely on the next. No
-pagebreak will appear in the next 2~cm.
+page break will appear in the next 2~cm.
-This is really a hack to achieve what the \texttt{\textbackslash
-samepage} command often fails to do.
+This is really a hack to achieve what the \cs{samepage} command often fails
+to do.
\subsubsection{Example}
\index{example}
@@ -773,12 +758,49 @@ environment but uses a \texttt{tt} font.
\subsubsection{Pageperchapter}
\index{pageperchapter}
-The command \verb|\pageperchapter| creates page number that start with
+The command \cs{pageperchapter} creates page number that start with
1 for every new chapter. This may be useful for larger manuals. Since
it works with chapters it is only available in the
\texttt{refrep} class.
-\printindex
+\subsubsection{Smallborder}
+\index{smallborder}
+
+The normal border around the page is 1~Inch. That is fine for a printed
+document, but wastes a lot of space when a document is meant for reading on
+screen. The option \texttt{smallborder} reduces the margin to 0.25~Inch.
+
+
+You can redefine the border with \cs{setlength}\cs{papermarginwidth}
+\verb|{0.25in}|.
+Call \verb|\setpagefraction{0.7}| afterwards to recalculate the page layout.
+
+\subsubsection{Dvips}
+\index{dvips}
+
+The option \texttt{dvips} tells DVIPS about the current page size.
+
+\subsubsection{Pdftex}
+\index{pdftex}
+
+The option \texttt{pdftex} tells PDF\TeX about the current page size.
+
+\subsubsection{Pagesize}
+\index{pagesize}
+
+\texttt{pagesize} chooses the correct \cs{special}-command to tell the
+DVI-driver about the paper size. It works with DVIPS and DVIPDFMX for DVI
+output and PDF\TeX\ for PDF output.
+
+\subsubsection{Ifpdfoutput}
+\index{ifpdfoutput}
+
+You can use \verb|\ifpdfoutput{pdftext}{dvitext}| to write different text
+depending on the output format. This command was necessary to implement the
+\texttt{pagesize} option and is available for the user as well.
+
+The last four commands have been taken from KOMA-Script, thanks Markus.
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\endinput
diff --git a/Master/texmf-dist/doc/latex/refman/layout_d.pdf b/Master/texmf-dist/doc/latex/refman/layout_d.pdf
index e2cbda1b955..dfd2758d489 100644
--- a/Master/texmf-dist/doc/latex/refman/layout_d.pdf
+++ b/Master/texmf-dist/doc/latex/refman/layout_d.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/refman/layout_d.tex b/Master/texmf-dist/doc/latex/refman/layout_d.tex
index 5ee67ea50d6..899d8dcb4c1 100644
--- a/Master/texmf-dist/doc/latex/refman/layout_d.tex
+++ b/Master/texmf-dist/doc/latex/refman/layout_d.tex
@@ -5,30 +5,35 @@
% Updated for REFMAN.CLS (LaTeX2e)
%
\documentclass[twoside,a4paper]{refart}
+%\documentclass[pagesize,twoside,a5paper,smallborder,10pt]{refart}
+\usepackage[T1]{fontenc}
+\usepackage{ae} % CM-Zeichens"atze mit T1 encoding
\usepackage{makeidx}
\usepackage{ifthen}
\usepackage{german}
+%\usepackage{showidx}
\DeclareRobustCommand\cs[1]{\texttt{\char`\\#1}}
\def\bs{\char'134 } % backslash in \tt font.
\newcommand{\zB}{z.\,B.}
-\newcommand{\dH}{d.\,h.}
+\newcommand{\dH}{d.\,h.}
\title{Layout-"Anderungen mit \LaTeX}
\author{EDV-Zentrum der TU Wien, Abt.~Digitalrechenanlage \\
Hubert Partl \\
1988-10-04 \\
-Axel Kielhorn\thanks{a.kielhorn@web.de}\\
+Axel Kielhorn\thanks{A.Kielhorn@web.de}\\
1996-01-01 \\
H27.0 --- Version 1}
-
\date{}
\emergencystretch1em % F"ur TeX <3.0 auskommentieren!
-\pagestyle{myfootings}
-\markboth{Layout-"Anderungen mit \rm\LaTeX}%
- {Layout-"Anderungen mit \rm\LaTeX}
+%\pagestyle{footings}
+%\pagestyle{headings}
+%\pagestyle{myfootings}
+\markboth{Layout-"Anderungen mit \textrm{\LaTeX}}%
+ {Layout-"Anderungen mit \textrm{\LaTeX}}
\makeindex % Dies nur als Demonstration, das jetzt auch ein Index
% m"oglich ist :-)
@@ -40,9 +45,9 @@ H27.0 --- Version 1}
\setcounter{tocdepth}{2}
+\settextfraction{0.7}
\begin{document}
-
\maketitle
\begin{abstract}
@@ -69,27 +74,27 @@ des \LaTeX-Manuals von Leslie Lamport gedacht.
\subsection{Autor, Layout-Designer und Setzer}
-Jedes Schrift"-st"uck -- von einer kurzen handgeschriebenen Notiz bis
-zu einem gedruckten Buch --besteht aus zwei Komponenten: {\bf Inhalt}
-und {\bf Form.} In den meisten F"allen ist die Form nicht Selbstzweck
-sondern dient nur dazu, den Inhalt f"ur den Leser verst"and"-lich
+Jedes Schrift"-st"uck -- von einer kurzen handgeschriebenen Notiz bis zu
+einem gedruckten Buch --besteht aus zwei Komponenten: \textbf{Inhalt}
+und \textbf{Form.} In den meisten F"allen ist die Form nicht Selbstzweck
+sondern dient nur dazu, den Inhalt f"ur den Leser verst"and"-lich
darzustellen.
\index{Autor}\marginlabel{Autor:}
-Der {\bf Inhalt} wird vom jeweiligen Autor geliefert.
-Bei Druckwerken wird der Autor meist durch den Lektor des
-Verlages oder den Herausgeber der Zeitschrift unterst"utzt.
+Der \textbf{Inhalt} wird vom jeweiligen Autor geliefert. Bei
+Druckwerken wird der Autor meist durch den Lektor des Verlages oder den
+Herausgeber der Zeitschrift unterst"utzt.
-Bei der Verwendung des Textsatzsystems \LaTeX\ wird der Inhalt im
-Hauptteil des \LaTeX-""Eingabefiles angegeben -- also zwischen
-\verb|\begin{document}| und \verb|\end{document}| -- erg"anzt durch
-\LaTeX-Befehle, die angeben, welche Bedeutung die einzelnen Text-
-Teile haben.
+Bei der Verwendung des Textsatzsystems \LaTeX\ wird der Inhalt im
+Hauptteil des \LaTeX-""Eingabefiles angegeben -- also zwischen
+\verb|\begin{document}| und \verb|\end{document}| -- erg"anzt durch
+\LaTeX-Befehle, die angeben, welche Bedeutung die einzelnen Text"-Teile
+haben.
\index{Designer}\marginlabel{Designer:}
-Die {\bf Form} eines Druckwerks wird "ublicherweise vom Verleger
-festgelegt, der das Layout von den im Verlag angestellten
-Designern entwerfen l"a"st.
+Die \textbf{Form} eines Druckwerks wird "ublicherweise vom Verleger
+festgelegt, der das Layout von den im Verlag angestellten Designern
+entwerfen l"a"st.
Die mit \LaTeX\ mitgelieferten sogenannten "`Document Classes"'
wurden von professionellen amerikanischen Layout-Designern f"ur die
@@ -733,7 +738,7 @@ Befehls zu k"ummern, wir m"ussen nur eines herausfinden: Im ersten Teil
des Befehls wird eine interne Gr"o"se \verb|\@tempcnta| entweder auf
\verb|\@ne| oder auf \verb|\m@ne| gesetzt, je nachdem, ob die Randnote
rechts oder links vom Text gesetzt werden soll.
-Dazu dienen die folgenden Zeilen:
+Dazu dienen die folgenden Zeilen.
\begin{verbatim}
\@tempcnta\@ne
\if@twocolumn
diff --git a/Master/texmf-dist/doc/latex/refman/layout_e.pdf b/Master/texmf-dist/doc/latex/refman/layout_e.pdf
index 251c1e2e599..95915fc4fd2 100644
--- a/Master/texmf-dist/doc/latex/refman/layout_e.pdf
+++ b/Master/texmf-dist/doc/latex/refman/layout_e.pdf
Binary files differ
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}
diff --git a/Master/texmf-dist/doc/latex/refman/refman.dvi b/Master/texmf-dist/doc/latex/refman/refman.dvi
deleted file mode 100644
index 5ae935eddfa..00000000000
--- a/Master/texmf-dist/doc/latex/refman/refman.dvi
+++ /dev/null
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/refman/refman.pdf b/Master/texmf-dist/doc/latex/refman/refman.pdf
new file mode 100644
index 00000000000..981d932202d
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/refman/refman.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/refman/refman.upl b/Master/texmf-dist/doc/latex/refman/refman.upl
index 0bfcd534eb8..2252e75399c 100644
--- a/Master/texmf-dist/doc/latex/refman/refman.upl
+++ b/Master/texmf-dist/doc/latex/refman/refman.upl
@@ -1,4 +1,4 @@
-This is version 2.0d[2003/05/31] of the refman class family for LaTeX2e
+This is version 2.0e[2006/11/18] of the refman class family for LaTeX2e
Refman is based on classes.dtx (1.4a) and the Refman.sty version 1.1.
@@ -77,6 +77,12 @@ been removed.
Both commands should only be used in the preamble.
+A new option smallborder has been introduced. It reduces the border
+around the page from 1 in to 0.25 in (1/4 in for users in the USA). This
+will reduce the amout of screen area wasted when preparing online
+documentation. Since the result are rather long lines, you should use this
+only with smaller papersizes, like a5paper.
+
History:
========
@@ -144,3 +150,10 @@ History:
of it's own. No other file has changed, the version number is
unchanged.
2.0d Fixed a typo using the wrong penalty, updated e-mail address.
+2.0e Fixed many typos in the documentation, added option smallborder
+ Changed calculation of textheight and textwidth, please report
+ errors.
+ Added option dvips, pdftex and pagesize to export the pagesize.
+ Changes pagestyle for titlepage to empty since plain does not work
+ with pagestyle{headings}. No longer change the pagestyle for the
+ index.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-05 01:10:59 +0000