summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/scrguide/english/introduc.tex
blob: a679d94a798ef9d1343405c3b40de2b92d26155e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
\ProvidesFile{introduc.tex}[2004/09/13 KOMA-Script Manual]
% ============================================================================
% introduct.tex 
% Copyright (c) 2002 Markus Kohm and the authors.
%
% This file is part of the LaTeX2e KOMA-Script-Bundle
%
% This file can be redistributed and/or modified under the terms of the LaTeX
% Project Public License Version 1.0 distributed together with this file. See
% LEGAL.TXT or LEGALDE.TXT.
%
% This bundle is written specialy for use at german-language. So the main
% documentation is german. There may also be an english documentation. See
% readme.txt, if you search for it.
% ----------------------------------------------------------------------------
% introduct.tex
% Copyright (c) 2002 Markus Kohm und bei die weiteren Autoren.
%
% Diese Datei ist Teil des LaTeX2e KOMA-Script-Pakets.
%
% Diese Datei kann nach den Regeln der LaTeX Project Public Licence 
% Version 1.0, wie sie zusammen mit dieser Datei verteilt wird,
% weiterverbreitet und/oder modifiziert werden. Siehe dazu auch LEGAL.TXT oder
% LEGALDE.TXT.
%
% Dieses Paket ist fuer den deutschen Sprachraum konzipiert. Daher ist auch
% diese Anleitung komplett in Deutsch. Moeglicherweise existiert auch eine
% englische Version der Anleitung. Falls Sie eine solche benoetigen, schauen
% Sie bitte in liesmich.txt nach, ob eine solche vorhanden ist.
% ============================================================================
%
% Module:                         Introduction
% Translation by:                 Markus Kohm (MJK) <markus.kohm@gmx.de>
% Contents:                       The introduction to the manual
% Language:                       English
% Charset of comments:            US-ASCII
% Translation of german file:     einleit.tex
% Date of translated german file: 2002-05-27
%

\chapter{Introduction}
\label{cha:introduction}

\section{Preface}\label{sec:introduction.preface}

{\KOMAScript} is a very complex bundle. You may see this, because it
is not only one class or one package but a bundle of many classes and
packages. The classes are counterparts to the standard classes (see
\autoref{cha:maincls}) but never they come with only the same
commands, environments, options and optional possibilities like the
standard classes nor they result in the same look-a-like. More about
the history of \KOMAScript{} you will find at
\autoref{sec:introduction.history}.

\KOMAScript{} comes with a lot of classes, packages, commands,
environments and possibilities. Some of these you may find also at the
standard classes, many of them you wouldn't. Some are even supplements to
the \LaTeX{} kernel.

Because of all this \KOMAScript{} manual has to be large. Also there's
no school for \KOMAScript. So there's no teacher knowing everyone of
his students. Such a teacher should be able to change the lessons
dependent on the kind of students he has to teach. It would be easy to
write a manual which is good for one kind of a reader. But it is nearly
impossible to write a manual which is good for every reader. Never the
less the authors tried to do so. The result must be a
compromise. Please remebers this, if you don't like the manual or
parts of it, before you'll write a report about. We hope the
compromise is a good one. Never the less, if you have solutions of
improvements write us.

If you habe any problem with \KOMAScript{} please read the manual
despite the size of it. Apart from the guide this means also all the
other text files of the bundle. You will find a list of these as
\File{readme.txt}.


\section{Structure of the Manual}\label{sec:introduction.structure}

There's only less information for \LaTeX{} beginners at the guide.
Beginners should first read documents like \cite{lshort} or
\cite{latex:usrguide}. It would also be good to read a book about
\LaTeX. You'll find literature at almost every faq like \cite{UK:FAQ}.
You should also have a look to these faqs, if you have a problem with
\LaTeX{}.

\begin{Explain}
  Informations about understanding \LaTeX{} or \KOMAScript{} are
  written like this paragraph. You do not need this informations to
  use \KOMAScript{}, but if you have problems in using \KOMAScript you
  should read this parts too. So read them before writing a bug
  report.
\end{Explain}

Some of you do not want to read the whole guide but only informations
about one class or package. This should be possible, because you will
find almost all informations about one package or one class at one
chapter. Only the three main classes are described together at one
chapter, because most informations about are valid for all of them. If
something is only valid for one or two of the three you will find a
note at the margin. If for example something is only valid for
\Class{scrartcl}\OnlyAt{\Class{scrartcl}} this is marked at the
margin like here.


\section{History of \KOMAScript}\label{sec:introduction.history}

\begin{Explain}
  At the early 90th Frank Neukam has to write a student script. At
  that time \LaTeX2.09 was \LaTeX. At \LaTeX2.09 classes and packages
  has been all the same and where called \emph{styles}. Frank thought
  the standard document styles not to be good enough for his work. He
  needed more and other commands and environments.

  At the same time Frank was very interested in typography. After
  reading \cite{JTsch87} he decided to write his own document style
  not only to write the one script but also to have a style family
  especialy for european and german typography. \Script{} was born.

  I, Markus Kohm, found {\Script} at december 1992. While Frank used
  A4 paper format, I often had to use A5. At 1992/1993 the standard
  styles and \Script{} had no options for A5 paper. So I`ve changed
  \Script{}. These and other changes where also found at \ScriptII{}
  released by Frank at december 1993. 
  
  At the middle of 1994 \LaTeXe{} could be found at CTAN. Most users
  of \ScriptII{} not only wanted to use these styles at compatibility
  mode of \LaTeXe{} but have a native \LaTeXe{} \Script{} --- me too.
  So I have made new \LaTeXe{} classes a first package and released all
  together named \KOMAScript{} at july~7th~1994. Some month later
  Frank declared \KOMAScript{} to be the new \Script. At this time
  there was no letter class at \KOMAScript{}. Axel Kielhorn wrote it
  and so since december~1994 it is part of \KOMAScript{}. Some time
  later Axel Sommerfeldt has written the first real scrguide. The
  old english scrguide was made by Werner Lemberg.

  A lot of time is gone. There where minor changes at \LaTeX{} but a
  lot of changes at the surroundings. There are many new packages and
  classes. \KOMAScript{} isn't the \KOMAScript{} from 1994, it's much
  more. While it was first made to have good classes for german
  authors, now it made to have classes with more flexibility than the
  standard classes. I've got a lot email from all over the
  world. Because of this I've written lots of new macros. They all
  needs documentation. Some day we needed simply a new scrguide. 
\end{Explain}

This new scrguide is not only made for A5 paper. Because of the
history the implementation is german. The primary documentation is in
german too. Maybe this isn't easy to understand. But see: Almost
everything around \LaTeX{} is english. \KOMAScript{} is german. But
don't worry, the commands, environments, options etc. are
english. Sometimes my english was not good enough to find the correct
english name, never the less I tried. As result you'll find options
called \Option{pointlessnumbers} which means only ``numbers without
dot at the end'' and should be called e.g.\ \Option{dotlessnumbers}.


\section{Thanks}\label{sec:introduction.thanks}

In fact the thanks-giving is part of the addendum, but my thanks
are not primarily for the authors of this guide.
These thanks should be given by the readers!

I give my personal thanks to Frank Neukam. Without his \Script{}
family \KOMAScript{} wouldn't be.

I am indebted to the persons who have contributed to {\KOMAScript}
in many different fashions.
Vicariously for all those contributers I would like mention
Jens-Uwe Morawski and Torsten Kr\"uger.
The english translation of the guide is , besides many other things,
obliged to Jens' untiring engagement.
Torsten was the best beta-tester I ever had. Especially his work has
enhanced the usabillity of \Class{scrlttr2} und \Class{scrpage2}.

Many thanks to all who have encouraged me to go on, make things
better, less error-prone or to implement some additional features.

Thanks to DANTE, Deutschsprachige Anwendervereinigung
\TeX~e.V\kern-.18em, without the DANTE server, \KOMAScript{} couldn't
be released and distributed.
Thanks to everybody at the \TeX{} news groups and mailing lists,
who answer questions and help me to support \KOMAScript{}.

\section{Legal Notes}\label{sec:introduction.legal}

{\KOMAScript} was released under {\LaTeX} Project Public Licence. You
will find it at the file \File{LEGAL.TXT}. Germans will also find a
inofficial translation at \File{LEGALDE.TXT}. This german file is
valid at every country with german being an official language.

There's no warranty for any documentation or any other part of the
\KOMAScript{} bundle.

\section{Installation}\label{sec:introduction.installation}
You'll find the documentation about installation at the files
\File{readme.txt} and \File{INSTALL.TXT}. Read also the documentation
of the \TeX{} distribution you're using.

\section{Bugreports and Other Requests}
\label{sec:introduction.errors}

If you think, you've found a bug at the documentation, one of the
\KOMAScript{} classes, one of the \KOMAScript{} packages or another
part of \KOMAScript{} please do the following. First have a look at
CTAN to see, if there is a new version of the part with the bug. In
this case install the new part and try it again.

If you've found an error not at the documentation or a bug, which is
still at the updated file, please write a short example \LaTeX{}
document to show the problem. At this example you should only use
these packages and definitions needed to demonstrate the
problem. Don't use unusual packages.

Writing this example you will often find out, if the problem is a bug
at \KOMAScript{} or not. Report only bugs at \KOMAScript{} to the
author of \KOMAScript{}. Please use \File{komabug.tex} for the
generation of the bug report. \File{komabug.tex} is an interactive
\LaTeX{} document.

If you want to ask your question at a news group or mainling list, you
should also write such a example as part of your question. But you
need not use \File{komabug.tex} in this case. To get the versions of
all used packages, simply put \Macro{listfiles} in the preamble of
your example and read the end of the \File{log}-file.


\section{Authors}\label{sec:introduction.authors}
Every chapter will be finished with a section called ``authors''. You
will find there the authors of the original chapter of the german
scrguide. The main author is written using a bold font. The translator
is shown using an italic font. If there is an email address, please
send reports about this chapter of the documentation to this
address. If no translator is given, the authors are the translators.
% Please use \textit{} for the name of the translator add all the
% names of the untranslated german file. If the translator is the
% main author, simply use \textbf. 
\begin{itemize}
\item \textbf{Markus Kohm} \TextEMail{Markus.Kohm@gmx.de}
\end{itemize}

\endinput
%%% Local Variables: 
%%% mode: latex
%%% TeX-master: "main"
%%% End: