summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/scrguide/einleit.tex
blob: 977f090d199fc1e9fbfaea083058ad8431e1f03d (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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
\ProvidesFile{einleit.tex}[2003/05/26 KOMA-Script Anleitung]
% ============================================================================
% einleit.tex 
% Copyright (c) 2001 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.
% ----------------------------------------------------------------------------
% einleit.tex
% Copyright (c) 2001 Markus Kohm und bei den 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.
% ============================================================================
%
% Modul:    Einleitung
% Autoren:  Markus Kohm (MJK) <markus.kohm@gmx.de>
% Inhalt:   Die Einleitung zu dem Dokument
% Sprache:  Deutsch
% Zeichensatz der Kommentare:
%           US-ASCII
%

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

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

{\KOMAScript} ist ein sehr komplexes Paket (engl. \emph{bundle}). Dies
ist schon allein darin begründet, dass es nicht nur aus einer einzigen
Klasse (engl. \emph{class}) oder einem einzigen Paket (engl.
\emph{package}), sondern einer Vielzahl derer besteht. Zwar sind die
Klassen als Gegenstücke zu den Standardklassen konzipiert (siehe
\autoref{cha:maincls}), das heißt jedoch insbesondere nicht,
dass sie nur über die Befehle, Umgebungen und Einstellmöglichkeiten
der Standardklassen verfügen oder deren Aussehen als
Standardeinstellung übernehmen.
Die Fähigkeiten von {\KOMAScript} reichen
teilweise weit über die Fähigkeiten der Standardklassen hinaus.
Manche davon sind auch als Ergänzung zu den Grundfähigkeiten des
\LaTeX-Kerns zu betrachten.

Allein aus dem Vorgenannten ergibt sich schon zwangsläufig, dass die
Dokumentation zu {\KOMAScript} sehr umfangreich ausfällt. Hinzu kommt,
dass {\KOMAScript} in der Regel nicht gelehrt wird. Das heißt, es gibt
keinen Lehrer, der seine Schüler kennt und damit den Unterricht und
das Unterrichtsmaterial entsprechend wählen und anpassen kann. Es wäre
ein Leichtes, die Dokumentation für irgendeine Zielgruppe zu
verfassen.  Die Schwierigkeit, der sich die Autoren gegenüber sehen,
besteht jedoch darin, dass eine Anleitung für alle möglichen
Zielgruppen benötigt wird. Wir haben uns bemüht, eine Anleitung zu
erstellen, die für den Informatiker gleichermaßen geeignet ist wie für
die Sekretärin des Fischhändlers. Wir haben uns bemüht, obwohl es sich
dabei eigentlich um ein unmögliches Unterfangen handelt. Ergebnis sind
zahlreiche Kompromisse. Wir bitten jedoch, die Problematik bei
eventuellen Beschwerden zu berücksichtigen und bei der Verbesserung
unserer derzeitigen Lösung zu helfen.

Trotz des Umfangs der Anleitung bitten wir außerdem darum, im Falle von
Problemen zunächst die Dokumentation zu konsultieren. Hierzu gehören
neben dieser Anleitung auch alle Text-Dokumente, die Bestandteil
des Pakets sind. Sie sind in \File{liesmich.txt} vollständig aufgeführt.

%\clearpage% HACK: Feintuning, um overfull \vbox zu vermeiden (nicht
          % nachmachen!) 
\section{Dokumentaufbau}\label{sec:introduction.structure}

Diese Anleitung enthält sehr wenige Informationen, die speziell für den
\LaTeX-Neuling geschrieben wurden. Es wird als zwingend vorausgesetzt,
dass Dokumente wie \cite{l2kurz} und \cite{latex:usrguide} gelesen und
verstanden sind. Auch das Studium des einen oder anderen Buches zu
\LaTeX{} wird empfohlen.  Literaturempfehlungen finden sich
beispielsweise in \cite{DANTE:FAQ}. Der Umfang von \cite{DANTE:FAQ}
ist ebenfalls erheblich. Dennoch wird darum gebeten, das Dokument
nicht nur irgendwo vorliegen zu haben, sondern es mindestens einmal zu
lesen und bei Problemen zu konsultieren.
\iffalse% Nicht in die gedruckte Version!
In \cite{DANTE:FAQ} findet
man übrigens auch einen Tipp, wie man ein A5-Dokument so auf A4-Papier
drucken kann, dass man durch Falten in der Mitte ein Heft daraus
machen kann. Die \KOMAScript-Anleitung liegt im A5-Format vor.
\fi

\begin{Explain}
  Im Gegensatz zu tiefgehender Anfängerinformation sind weiterführende
  Informationen und Begründungen in dieser Dokumentation reichlich
  vorhanden.  Um solche Dokumentteile leichter erkennbar zu machen,
  sind sie in einer besonderen Schrift hervorgehoben. Damit ist es
  besonders ungeduldigen und uninteressierten Zeitgenossen möglich,
  solche Teile zu überspringen.  Empfohlen wird dies aber ausdrücklich
  nicht.  Gleichwohl ist es gut zu wissen, dass diese Teile nicht
  zwingend verstanden werden müssen, um {\KOMAScript} anzuwenden. Vor
  der Änderung und Kritisierung der Voreinstellungen von
  {\KOMAScript}, ist das Studium und Verständnis dieser Teile jedoch
  von erheblichem Vorteil.
\end{Explain}

Die Einteilung der Anleitung in Kapitel und Abschnitte soll ebenfalls dabei
helfen, nur die Teile lesen zu müssen, die tatsächlich von Interesse sind. Um
dies zu erreichen, sind die Informationen zu den einzelnen Klassen und Paketen
nicht über das gesamte Dokument verteilt, sondern jeweils in einem Kapitel
konzentriert. Querverweise in ein anderes Kapitel sind damit in der Regel auch
Verweise auf einen anderen Teil des Gesamtpakets. Da die drei Hauptklassen in
weiten Teilen übereinstimmen, sind sie in einem gemeinsamen Kapitel
zusammengefasst. Die Unterschiede werden deutlich hervorgehoben. Soweit dies
sinnvoll ist, geschieht es auch durch eine entsprechende Randnotiz. Wenn etwas
nur die Klasse \Class{scrartcl}\OnlyAt{\Class{scrartcl}} betrifft, kann
dies beispielsweise wie in diesem Absatz erfolgen.

\section{Die Geschichte von \KOMAScript}\label{sec:introduction.history}

\begin{Explain}
  Anfang der 90er~Jahre wurde Frank Neukam damit beauf"|tragt, ein
  Vorlesungsskript zu setzen. Damals war noch \LaTeX2.09 aktuell und
  es gab keine Unterscheidung nach Klassen und Paketen, sondern alles
  waren Stile (engl. \emph{styles}). Die Standarddokumentstile
  erschienen ihm für ein Vorlesungsskript nicht optimal und boten auch
  nicht alle Befehle und Umgebungen, die er benötigte.
  
  Zur selben Zeit beschäftigte sich Frank auch mit Fragen der
  Typografie, insbesondere mit \cite{JTsch87}. Damit stand für Frank
  fest, nicht nur irgendeinen Dokumentstil für Skripten zu erstellen,
  sondern allgemein eine Stilfamilie, die den Regeln der europäischen
  Typografie folgt. {\Script} war geboren.
  
  Ich, Markus Kohm, traf auf {\Script} ungefähr um den Jahreswechsel
  1992/1993. Im Gegensatz zu Frank Neukam hatte ich häufig mit
  Dokumenten zu tun, für die ich das A5-Format bevorzuge. Zu jenem
  Zeitpunkt wurde A5 weder von den Standardklassen noch von {\Script}
  unterstützt. Daher dauerte es nicht lange, bis ich erste
  Veränderungen an {\Script} vornahm. Diese fanden sich auch in
  {\ScriptII} wieder, das im Dezember~1993 von Frank veröffentlicht
  wurde.
  
  Mitte 1994 erschien dann \LaTeXe. Die damit einhergehenden
  Änderungen waren tiefgreifend. Daher blieb dem Anwender von
  {\ScriptII} nur die Entscheidung, sich entweder auf den
  Kompatibilitätsmodus von \LaTeX{} zu beschränken, oder auf {\Script}
  zu verzichten. Wie viele andere wollte ich beides nicht. Also machte
  ich mich daran, einen \Script-Nachfolger für {\LaTeXe} zu
  entwickeln, der am 7.~Juli~1994 unter dem Namen {\KOMAScript}
  erschienen ist. Ich will hier nicht näher auf die Wirren eingehen,
  die es um die offizielle Nachfolge von {\Script} gab und warum mein
  Paket einen neuen Namen hat. Tatsache ist, dass auch aus Franks
  Sicht {\KOMAScript} der Nachfolger von {\ScriptII} ist. Zu erwähnen
  ist noch, dass {\KOMAScript} ursprünglich ohne Briefklasse
  erschienen war. Diese wurde im Dezember~1994 von Axel Kielhorn
  beigesteuert. Noch etwas später erstellte Axel Sommerfeldt den
  ersten richtigen scrguide zu {\KOMAScript}.
  
  Seither ist einiges an Zeit vergangen. {\LaTeX} hat sich ein wenig
  verändert, die \LaTeX-Landschaft erheblich. {\KOMAScript} hat sich
  weiterentwickelt. Es findet nicht mehr allein im deutschsprachigen
  Raum Anwender, sondern in ganz Europa, Nordamerika, Australien
  und Asien.
  Diese Anwenderklientel sucht bei {\KOMAScript} nicht allein nach
  einem typografisch ansprechenden Ergebnis. Zu beobachten ist
  vielmehr, dass bei {\KOMAScript} ein neuer Schwerpunkt entstanden
  ist: Flexibilisierung durch Variabilisierung. Unter diesem
  Schlagwort verstehe ich die Möglichkeit, in das Erscheinungsbild an
  vielen Stellen eingreifen zu können. Dies führte zu vielen neuen
  Makros, die mehr schlecht als recht in die existierende Anleitung
  integriert wurden.  Irgendwann wurde es damit auch Zeit für eine
  komplett überarbeitete Anleitung.\par
\end{Explain}


\section{Danksagung}\label{sec:introduction.thanks}
Eine Danksagung in der Einleitung? Gehört sie nicht vielmehr an den
Schluss?  Richtig! Eigentlich gehört die an das Ende. Mein Dank gilt
hier jedoch nicht primär denjenigen, die diese Anleitung möglich
gemacht haben. Für den Dank an die Guide-Autoren mache ich den Leser
zuständig! Mein persönlicher Dank gilt Frank Neukam, ohne dessen
\Script-Familie es vermutlich {\KOMAScript} nie gegeben hätte. Mein
Dank gilt denjenigen, die an der Entstehung von {\KOMAScript} und den
Anleitungen mitgewirkt haben. Stellvertretend für andere möchte ich
hier Jens-Uwe Morawski und Torsten Krüger nennen. Jens unermüdlichem
Einsatz ist neben vielem Anderen die englische Übersetzung der
Anleitung zu verdanken. Torsten war der beste Betatester, den ich je
hatte. Er hat damit insbesondere an der Verwendbarkeit von
\Class{scrlttr2} und \Class{scrpage2} einen erheblichen Anteil. Mein
Dank gilt auch allen, die mich immer wieder aufgemuntert haben, weiter
zu machen und dieses oder jenes noch besser, weniger fehlerhaft oder
schlicht zusätzlich zu implementieren.

Ganz besonderen Dank bin ich den Gründern von DANTE, Deutschsprachige
Anwendervereinigung \TeX~e.V\kern-.18em., schuldig, durch die letztlich die
Verbreitung von \TeX{} und \LaTeX{} und allen Paketen einschließlich
{\KOMAScript} an einer zentralen Stelle überhaupt ermöglicht wird. In gleicher
Weise bedanke ich mich bei den aktiven Helfern in der Usenet-Gruppe
\texttt{de.comp.text.tex} und der Mailingliste
\texttt{\TeX-D-L} \cite{DANTE:FAQ}, die mir so
manche Antwort auf Fragen zu {\KOMAScript} abnehmen.


\section{Rechtliches}\label{sec:introduction.legal}
{\KOMAScript} steht unter der {\LaTeX} Project Public Licence. Eine nicht
offizielle deutsche Übersetzung ist Bestandteil dieses Pakets. In allen
Zweifelsfällen gilt im deutschsprachigen Raum der Text \File{LEGALDE.TXT},
während in allen anderen Ländern der Text \File{LEGAL.TXT} anzuwenden ist.

Für die Korrektheit der Anleitung, Teile der Anleitung oder einer anderen in
diesem Paket enthaltenen Dokumentation wird keine Gewähr übernommen.


\section{Installation}\label{sec:introduction.installation}
Die Installation von {\KOMAScript} wird in den Dateien \File{liesmich.txt} und
\File{INSTALLDE.TXT} beschrieben. Beachten Sie dazu auch die jeweilige
Dokumentation zu der installierten \TeX-Distribution.


\section{Fehlermeldungen}
\label{sec:introduction.errors}
Sollten Sie der Meinung sein, dass Sie einen Fehler in der Anleitung,
einer der \KOMAScript-Klassen, einem der \KOMAScript-Pakete oder einem
anderen Bestandteil von \KOMAScript{} gefunden haben, so sollten Sie
wie folgt vorgehen. Prüfen Sie zunächst, ob inzwischen eine neue
Version von \KOMAScript{} erschienen ist. Installieren Sie diese neue
Version gegebenenfalls und kontrollieren Sie, ob der Fehler oder das
Problem auch dann noch vorhanden ist.

Wenn es sich nicht um einen Fehler in der Dokumentation handelt und
der Fehler oder das Problem nach einem Update noch immer auf"|tritt,
erstellen Sie bitte wie in \cite{DANTE:FAQ} angegeben ein minimales
Beispiel. Ein solches Beispiel sollte nur einen minimalen Text und
nur die Pakete und Definitionen enthalten, die für die Verdeutlichung
des Fehlers unbedingt notwendig sind. Auf exotische Pakete sollte
möglichst ganz verzichtet werden.
Oft lässt sich ein Problem durch ein minimales Beispiel so weit
eingrenzen, dass bereits vom Anwender selbst festgestellt werden kann,
ob es sich um einen Anwendungsfehler handelt oder nicht. Auch ist so
sehr häufig zu erkennen, welche Pakete oder Klassen konkret das
Problem verursachen und ob es sich überhaupt um ein
\KOMAScript-Problem handelt. Dies können Sie gegebenenfalls
zusätzlich überprüfen, indem Sie statt einer \KOMAScript-Klasse einen
Test mit der entsprechenden Standardklasse vornehmen. Danach ist dann
auch klar, ob der Fehlerbericht an den Autor von \KOMAScript{} oder an
den Autor eines anderen Pakets zu richten ist. Sie sollten spätestens
jetzt noch einmal gründlich die Anleitungen der entsprechenden Paket,
Klassen und \KOMAScript-Bestandteile studieren sowie \cite{DANTE:FAQ}
konsultieren. Möglicherweise existiert ja bereits eine Lösung für Ihr
Problem, so dass sich eine Fehlermeldung erübrigt.

Für die eigentliche Meldung sollte unbedingt das zu \KOMAScript{}
gehörende interaktive \LaTeX-Dokument \File{komabug.tex} verwendet
werden. Dazu sollte das Programm \File{latex} in einer Shell --
beispielsweise die Eingabeaufforderung von Windows -- mit dem Parameter
\File{komabug.tex} gestartet werden. Es erfolgt dann ein textueller
Frage-Antwort-Dialog, bei dem eine Nachricht in die Datei
\File{komabug.msg} ausgegeben wird, die alle grundlegenden
Informationen enthält. Im Dokument ist auch die Adresse angegeben, an
die Sie die Meldung schicken können. Bitte beachten Sie unbedingt
die Angaben zum Betreff Ihrer E-Mail in der erzeugten Datei
\File{komabug.msg}. Anfragen, bei denen diese wenigen Punkte beachtet
wurden, werden normalerweise zügig bearbeitet.

Häufig werden Sie eine Frage zu \KOMAScript{} oder im Zusammenhang mit
\KOMAScript{} lieber öffentlich, beispielsweise in
\texttt{de.comp.text.tex} stellen wollen, als dem \KOMAScript-Autor zu
schreiben. Auch in diesem Fall sollten Sie unbedingt die Version des
\LaTeX-Kerns, die Version der verwendeten Klassen und Pakete und ein
minimales Beispiel angeben.  Wenn Sie in diesem Beispiel noch vor
\Macro{documentclass} die Anweisung \Macro{listfiles}
verwenden, können Sie die
Angaben zu den Versionen anschließend der \File{log}-Datei entnehmen.


\section{Weitere Informationen}

Sobald Sie im Umgang mit \KOMAScript{} geübt sind, werden Sie sich
möglicherweise Beispiele zu schwierigeren Aufgaben wünschen. Solche
Beispiele gehen über die Vermittlung von Grundwissen hinaus und sind
daher nicht Bestandteil dieser Anleitung. Auf den Internetseiten des
\KOMAScript{} Documentation Projects \cite{homepage} finden Sie
jedoch weiterführende Beispiele. Diese sind für fortgeschrittene
\LaTeX-Anwender konzipiert. Für Anfänger sind sie wenig oder nicht
geeignet.


\section{Autoren}\label{sec:introduction.authors}
Unter dieser Überschrift ist am Ende jedes Kapitels der Dokumentation
zu finden, welche Autoren daran mitgewirkt haben. Der jeweils
zuständige Autor ist dabei fett hervorgehoben. Ist beim zuständigen
Autor eine E-Mail-Adresse angegeben, können Sie diesem auch direkt
schreiben. Bei diesem Kapitel ist das:
\begin{itemize}
\item \textbf{Markus Kohm} \TextEMail{Markus.Kohm@gmx.de}
\end{itemize}

%%% Local Variables: 
%%% mode: latex
%%% TeX-master: "scrguide2"
%%% End: