summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex203
1 files changed, 135 insertions, 68 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
index 49fc2321c00..fe43c56e545 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
@@ -45,58 +45,113 @@
%
% ======================================================================
-\ProvidesFile{introduction.tex}[2007/09/26 KOMA-Script guide introduction]
-\translator{Kevin Pfeiffer\and Gernot Hassenpflug\and Markus Kohm}
+\ProvidesFile{introduction.tex}[2012/03/14 KOMA-Script guide introduction]
+\translator{Kevin Pfeiffer\and Gernot Hassenpflug\and
+ Krickette Murabayashi\and Markus Kohm}
-% Date of translated german file: 2006/07/05
+% Date of translated german file: 2011/10/12
\chapter{Introduction}
\labelbase{introduction}
-\section{Preface}\label{sec:introduction.preface}
+This chapter includes important information about the structure of the manual
+and the history of KOMA-Script, which begins years before the first
+version. You will also find information for those who have not installed
+KOMA-Script or encounter errors.
-The {\KOMAScript} bundle is actually several packages and classes. It
-provides counterparts or replacements for the standard {\LaTeX} classes such
-as \emph{article}, \emph{book}, etc. (see \autoref{cha:maincls}), but offers
-many additional features and its own unique look and feel.
+\section{Preface}\label{sec:introduction.preface}
-The {\KOMAScript} user guide is intended to serve the advanced as well as the
-inexperienced {\LaTeX} user and is accordingly quite large. The result is a
-compromise and we hope that you will keep this in mind when using it.
-Your suggestions for improvement are, of course, always welcome.
+\KOMAScript{} is very complex. This is evidenced by the fact that it
+consists of
+not only a single class or a single package, but a bundle of many classes and
+packages. Although the classes are designed as a counterpart to the standard
+classes, that does not necessarily mean that they only have the commands,
+environments, and setting of the standard classes or imitate their
+appearance. The capabilities of \KOMAScript{} surpass the capabilities of the
+standard classes considerably. Some of them are to be regarded as a supplement
+to the basic skills of the \LaTeX{} kernel.
+
+The foregoing means that the documentation of \KOMAScript{} has to be
+extensive. In addition, \KOMAScript{} usually is not taught. That means there
+is no teacher who knows his students and can therefore choose the teaching and
+learning materials and adapt them accordingly. It would be easy to write the
+documentation for any specific audience. The difficulty is, however, that the
+guide must service all potential audiences. We, the authors, have tried to
+create a guide that is suited for the computer scientist as well as the
+secretary or the fishmonger. We have tried, although this is actually % dealing
+% with
+an impossible task. The result consists of several compromises and we
+hope that you will keep this in mind when using it. Your suggestions for
+improvement are, of course, always welcome.
+
+Despite the volume of the manual, % in case of problems
+it is recommended to
+consult the documentation. Attention is drawn to the multi-part index at the
+end of this document. In addition to this guide, documentation includes all the
+text documents that are part of the bundle. See \File{manifest.tex} for a list
+of all of them.
\section{Structure of the Guide}\label{sec:introduction.structure}
-The {\KOMAScript} user guide is not intended to be a {\LaTeX} primer.
-Those new to {\LaTeX} should look at \emph{The Not So Short Introduction
-to {\LaTeXe}} \cite{lshort} or \emph{{\LaTeXe} for Authors}
-\cite{latex:usrguide} or a {\LaTeX} reference book. You will also find
-useful information in the many {\LaTeX} FAQs, including the \emph{{\TeX}
-Frequently Asked Questions on the Web} \cite{UK:FAQ}.
-
-\begin{Explain}
- In this guide you will find supplemental information about {\LaTeX} and
- {\KOMAScript} in (sans serif) paragraphs like this one.
- The information given in these explanatory sections is not essential for
- using {\KOMAScript}, but if you experience problems you should
- take a look at it\,---\,particularly before sending a bug report.
-\end{Explain}
-
-If you are only interested in using a single {\KOMAScript} class or
-package you can probably successfully avoid reading the entire guide.
-Each class and package typically has its own chapter; however, the three
-main classes (\Class{scrbook}, \Class{scrrprt}, and \Class{scrartcl})
-are introduced together in chapter three. Where an example or note only
-applies to one or two of the three classes, it is called out in the
-margin. \OnlyAt{\Class{Like this.}}
+This manual consists of several parts. There's a part for average users,
+another part for advanced users and experts, and an appendix with additional
+examples and information for those who always want to know more.
+
+\hyperref[part:forAuthors]{Part~\ref{part:forAuthors}} is recommended for all
+\KOMAScript{} users. This means that you may find here even some information
+for newcomers to \LaTeX. In particular, this part is enhanced by many examples
+to the average user that are intended to illustrate the explanations. Do not
+be afraid to try these examples yourself and in modifying them to find out how
+\KOMAScript{} works. Nevertheless the {\KOMAScript} user guide is not intended
+to be a {\LaTeX} primer. Those new to {\LaTeX} should look at \emph{The Not
+ So Short Introduction to {\LaTeXe}} \cite{lshort} or \emph{{\LaTeXe} for
+ Authors} \cite{latex:usrguide} or a {\LaTeX} reference book. You will also
+find useful information in the many {\LaTeX} FAQs, including the \emph{{\TeX}
+ Frequently Asked Questions on the Web} \cite{UK:FAQ}.
+Although the length of the \emph{{\TeX} Frequently Asked Questions
+on the Web} is considerably long, it is nevertheless
+quite useful not only to those having problems using \LaTeX{} or \KOMAScript.
+
+\hyperref[part:forExperts]{Part~\ref{part:forExperts}} is recommended for
+advanced \KOMAScript{} users. These are all of you who already know
+\LaTeX{}, maybe worked with \KOMAScript{} for a while, and want to
+learn more about \KOMAScript{} internals, interaction of \KOMAScript{}
+with other packages, and how to use \KOMAScript{} as an answer to
+special demands. For this purpose we will have a closer look at some
+aspects from \autoref{part:forAuthors} again. In addition some
+instructions that have been implemented for advanced users and
+experts, especially, will be documented. This is complemented by the
+documentation of packages that are normally hidden to the user insofar
+as they do their work under the surface of the classes and user
+packages. These packages are specifically designed to be used by other
+authors of classes and packages.
+
+The appendix, which may be found only in the German book version, contains
+information which is beyond what is covered in \autoref{part:forAuthors} and
+\autoref{part:forExperts}. Advanced users may find background information on
+issues of typography to give them a basis for their own decisions. In
+addition, the appendix provides examples for aspiring authors of
+packages. These examples are less intended to be simply transferred. Rather,
+they convey knowledge of planning and implementation of projects as well as
+some basic \LaTeX{} instructions for authors of packages.
+
+If you are only interested in using a single {\KOMAScript} class or package
+you can probably successfully avoid reading the entire guide. Each class and
+package typically has its own chapter; however, the three main classes
+(\Class{scrbook}, \Class{scrrprt}, and \Class{scrartcl}) are introduced
+together in \autoref{cha:maincls}. Where an example or note only
+applies to one or two of the three classes, e.\,g.,
+\Class{scrartcl}\OnlyAt{\Class{scrartcl}}, it is called out in the
+margin, as
+shown here with \Class{scrartcl}.
\begin{Explain}
The primary documentation for {\KOMAScript} is in German and has been
translated for your convenience; like most of the {\LaTeX} world, its
commands, environments, options, etc., are in English. In a few cases, the
name of a command may sound a little strange, but even so, we hope and
- believe that with the help of this guide {\KOMAScript} will be usable
+ believe that with the help of this guide, {\KOMAScript} will be usable
and useful to you.
\end{Explain}
@@ -109,17 +164,19 @@ was no distinction between classes and packages\,---\,there were only
\emph{styles}. Frank felt that the standard document styles were not
good enough for his work; he wanted additional commands and
environments. At the same time he was interested in typography and,
-after reading Tschichold's \emph{Ausgewählte Aufsätze über Fragen der
+after reading Tschichold's \emph{Ausgew\"ahlte Aufs\"atze \"uber Fragen der
Gestalt des Buches und der Typographie} (Selected Articles on the
Problems of Book Design and Typography) \cite{JTsch87}, he decided to
write his own document style\,---\,and not just a one-time solution to his
lecture notes, but an entire style family, one specifically designed for
European and German typography. Thus {\Script} was born.
-Markus Kohm, the developer of {\KOMAScript}, came across {\Script} in
-December 1992 and added an option to use the A5 paper format. This and
-other changes were then incorporated into {\ScriptII}, released by Frank
-in December 1993.
+Markus Kohm, the developer of {\KOMAScript}, came across {\Script} in December
+1992 and added an option to use the A5 paper format. At that time neither the
+standard style nor {\Script} provided support for A5 paper. Therefore it did
+not take long until Markus made the first changes to {\Script}. This and other
+changes were then incorporated into {\ScriptII}, released by Frank in December
+1993.
Beginning in mid-1994, {\LaTeXe} became available and brought with it
many changes. Users of {\ScriptII} were faced with either limiting their
@@ -144,7 +201,8 @@ all over the world, and this has led to many new macros\,---\,all
needing documentation; hence this ``small guide.''
-\section{Special Thanks}\label{sec:introduction.thanks}
+\section{Special Thanks}
+\label{sec:introduction.thanks}
Acknowledgements in the introduction? No, the proper acknowledgements can be
found in the addendum. My comments here are not intended for the authors of
@@ -156,7 +214,7 @@ come about. I am indebted to the many persons who have contributed to
Jens-Uwe Morawski and Torsten Kr\"uger. The English translation of the guide
is, among many other things, due to Jens's untiring commitment. Torsten was
the best beta-tester I ever had. His work has particularly enhanced the
-usability of \Class{scrlttr2} und \Class{scrpage2}. Many thanks to all who
+usability of \Class{scrlttr2} and \Class{scrpage2}. Many thanks to all who
encouraged me to go on, to make things better and less error-prone, or to
implement additional features.
@@ -167,7 +225,9 @@ distributed. Thanks as well to everybody in the {\TeX} newsgroups and mailing
lists who answer questions and have helped me to provide support for
{\KOMAScript}.
-\section{Legal Notes}\label{sec:introduction.legal}
+
+\section{Legal Notes}
+\label{sec:introduction.legal}
{\KOMAScript} was released under the {\LaTeX} Project Public License. You
will find it in the file \File{lppl.txt}. An unofficial German-language
@@ -181,36 +241,44 @@ conditions of the {\LaTeX} Project Public Licence. If you need a free version
of this guide, use the version that is provided as part of the {\KOMAScript}
bundle.}
-\section{Installation}\label{sec:introduction.installation}
-Installation information can be found in the file \File{INSTALL.txt}. You
-should also read the documentation that comes with the {\TeX} distribution you
-are using.
-\section{Bugreports and Other Requests}
+\section{Installation}
+\label{sec:introduction.installation}
+
+The three most important \TeX{} distributions, Mac\TeX, MiK\TeX, and \TeX{}
+Live, make \KOMAScript{} available by their package management software. It is
+recommended to make installations and updates of \KOMAScript{} using these
+tools. Nevertheless the manual installation without using the package managers
+has been described in the file \File{INSTALL.txt}, that is part of every legal
+\KOMAScript{} bundle. You should also read the documentation that comes with
+the {\TeX} distribution you are using.
+
+
+\section{Bug Reports and Other Requests}
\label{sec:introduction.errors}
If you think you have found an error in the documentation or a bug in one of
-the {\KOMAScript} classes, one of the {\KOMAScript} packages, or another
-part of {\KOMAScript}, please do the following: first have a look on
-CTAN to see if a newer version of {\KOMAScript} is available; in this case
-install the applicable section and try again.
+the {\KOMAScript} classes, one of the {\KOMAScript} packages, or another part
+of {\KOMAScript}, please do the following: first have a look on CTAN to see if
+a newer version of {\KOMAScript} is available; if a newer version is
+available, % in this case
+install the
+applicable section and try again.
If you are using the most recent version of {\KOMAScript} and still have a
-bug, please provide a short {\LaTeX} document that demonstrates the problem. You
-should only use the packages and definitions needed to demonstrate the
-problem; do not use any unusual packages.
+bug, please provide a short {\LaTeX} document that demonstrates the
+problem. You should only use the packages and definitions needed to
+demonstrate the problem; do not use any unusual packages.
By preparing such an example it often becomes clear whether the problem is
-truly a {\KOMAScript} bug or something else. Please report {\KOMAScript} (only)
-bugs to the author of {\KOMAScript}. Please use \File{komabug.tex}, an
-interactive {\LaTeX} document, to generate your bug report and send it to the
-address you may find at \File{komabug.tex}.
+truly a {\KOMAScript} bug or something else. To find out the version numbers
+of all packages in use, simply put \Macro{listfiles} in the preamble of your
+example and read the end of the \File{log}-file.
-If you want to ask your question in a newsgroup or mailing list, you
-should also include such an example as part of your question, but in this
-case, using \File{komabug.tex} is not necessary. To find out the version
-numbers of all packages in use, simply put \Macro{listfiles} in the preamble of
-your example and read the end of the \File{log}-file.
+Please report {\KOMAScript} (only) bugs to
+\href{mailto:komascript@gmx.info}{komascript@gmx.info}. If you want to ask
+your question in a Usenet group, mailing list, or Internet forum, you should
+also include such an example as part of your question.
\section{Additional Information}
@@ -218,13 +286,12 @@ your example and read the end of the \File{log}-file.
Once you become an experienced {\KOMAScript} user you may want to look at some
more advanced examples and information. These you will find on the
-{\KOMAScript} documentation web site \cite{homepage}. The main
-language of the site is German, but nevertheless English is
-welcome.
+{\KOMAScript} documentation web site \cite{homepage}. The main language of the
+site is German, but nevertheless English is welcome.
\endinput
%%% Local Variables:
%%% mode: latex
-%%% coding: iso-latin-1
+%%% coding: us-ascii
%%% TeX-master: "../guide.tex"
%%% End: