diff options
author | Karl Berry <karl@freefriends.org> | 2012-05-16 23:12:50 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-05-16 23:12:50 +0000 |
commit | 33a91552392adacad1480db2e7ea4e966c0f4533 (patch) | |
tree | 6e4a4f772fcce778b4726d75f2ae00a217ca41d1 /Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex | |
parent | 20572a9d0911336a8588b561872220d6aba8e208 (diff) |
koma-script (15may12)
git-svn-id: svn://tug.org/texlive/trunk@26455 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex | 868 |
1 files changed, 407 insertions, 461 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex index 8ec64348da1..a57b75f9624 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex @@ -40,13 +40,15 @@ % % ---------------------------------------------------------------------- % -% Absätze, die mehreren Kapiteln der KOMA-Script-Anleitung gemeinsam sind +% Absaetze, die mehreren Kapiteln der KOMA-Script-Anleitung gemeinsam sind % Verwaltet von Markus Kohm % % ====================================================================== -\ProvidesFile{common-12.tex}[2009/01/04 KOMA-Script guide (common paragraphs)] -\translator{Gernot Hassenpflug} +\ProvidesFile{common-12.tex}[2012/05/15 KOMA-Script guide (common paragraphs)] +\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi} + +% Date of the translated German file: 2011/09/21 \makeatletter \@ifundefined{ifCommonmaincls}{\newif\ifCommonmaincls}{}% @@ -56,31 +58,33 @@ \makeatother -\section{Listen} +\section{Lists} \label{sec:\csname label@base\endcsname.lists}% \ifshortversion\IgnoreThisfalse\IfNotCommon{maincls}{\IgnoreThistrue}\fi% -\ifIgnoreThis -Es gilt sinngemäß, was in \autoref{sec:maincls.footnotes} geschrieben -wurde. \IfCommon{scrextend}{Allerdings werden vom Paket \Package{scrextend} - nur die Umgebungen \Environment{labeling}, \Environment{addmargin} und - \Environment{addmargin*} definiert. Alle anderen Listenumgebungen bleiben - der Verantwortung und Kontrolle der verwendeten Klasse überlassen.} -\else -\BeginIndex{}{Listen}% - -{\LaTeX} und die Standardklassen bieten verschiedene Umgebungen für -Listen. All diese Umgebungen bietet {\KOMAScript} selbstverständlich auch, -teilweise jedoch mit leichten Abwandlungen oder Erweiterungen. Grundsätzlich -gilt, dass Listen -- auch unterschiedlicher Art -- bis zu einer Tiefe von vier -Listen geschachtelt werden können. Eine tiefere Schachtelung wäre auch aus -typografischen Gründen kaum sinnvoll, da genau genommen schon mehr als drei -Ebenen nicht mehr überblickt werden können. Ich empfehle in solchen Fällen, -die eine große Liste in mehrere kleinere Listen aufzuteilen. - -\IfCommon{scrlttr2}{Da Listen zu den Standardelementen von \LaTeX{} gehören, - wurde in diesem Abschnitt auf Beispiele verzichtet. Sie finden solche in - \autoref{sec:maincls.lists} ab \autopageref{sec:maincls.lists} oder in jeder - \LaTeX-Einführung.} +\ifIgnoreThis %+++++++++++++++++++++++++++++++++++++++++++++ nicht maincls + +What is described in +\autoref{sec:maincls.lists} applies, mutatis mutandis. +\IfCommon{scrextend}{% + However, \Package{scrextend} does support only the environments + \Environment{labeling}, \Environment{addmargin} and + \Environment{addmargin*}. All the other list environments may be supported + and controlled by the used class.} +\else %------------------------------------------------------- nur maincls - +\BeginIndex{}{lists}% + +Both {\LaTeX} and the standard classes offer different environments for +lists. Though slightly changed or extended all these list are of course +offered in {\KOMAScript} as well. In general, all lists\,---\,even of different +kind\,---\,can be nested up to four levels. From a typographical view, +anything more would make no sense, as more than three levels can no longer be +easily perceived. The recommended\textnote{Hint!} procedure in such a case is +to split the large list into several smaller ones. + +\IfCommon{scrlttr2}{% + Because lists are standard elements of \LaTeX{} this section abandons on + examples. Nevertheless, you may find examples either in + \autoref{sec:maincls.lists} from \autopageref{sec:maincls.lists} or in + almost every introduction to \LaTeX.} \ifCommonscrextend\else \begin{Declaration} @@ -99,84 +103,91 @@ die eine große Liste in mehrere kleinere Listen aufzuteilen. \BeginIndex{Cmd}{labelitemii}% \BeginIndex{Cmd}{labelitemiii}% \BeginIndex{Cmd}{labelitemiv}% -Die einfachste Form einer Liste ist die Stichpunkt- oder -\Environment{itemize}-Liste. Die Benutzer einer unbeliebten Textverarbeitung -nennen diese Form der Liste auch gerne \emph{Bulletpoints}. Vermutlich können -sie sich nicht vorstellen, dass je nach Ebene auch ein anderes Zeichen als ein -fetter Punkt zur Einleitung eines Stichpunkts verwendet werden kann. Bei den -\KOMAScript-Klassen werden je nach Ebene folgende Zeichen verwendet: -%»{\labelitemi}«, »{\labelitemii}«, »{\labelitemiii}« und »{\labelitemiv}«. Die -Definition der Zeichen für die einzelnen Ebenen sind in den Makros -\Macro{labelitemi}, \Macro{labelitemii}, \Macro{labelitemiii} und -\Macro{labelitemiv} abgelegt. Sie können mit \Macro{renewcommand} umdefiniert -werden. Die einzelnen Stichpunkte werden mit \Macro{item} eingeleitet.% +The simplest form of a list is an \Environment{itemize} list. +\iffalse % Umbruckoptimierungstext +The users of a certain disliked word processing package often refer to +this form of a list as \emph{bulletpoints}. Presumably, these users +are unable to envisage that, depending on the level, a different +symbol from a large dot could be used to introduce each +point. % +\fi% +Depending on the level, {\KOMAScript} uses the following marks: +``{\labelitemi}'', ``{\labelitemii}'', ``{\labelitemiii}'' and +``{\labelitemiv}''. The definition of these symbols is specified in +the macros \Macro{labelitemi}, \Macro{labelitemii}, +\Macro{labelitemiii} and \Macro{labelitemiv}, all of which can be +redefined using \Macro{renewcommand}. Every item is introduced with +\Macro{item}.% % \ifCommonmaincls \begin{Example} \phantomsection\label{desc:maincls.env.itemize.example}% - Sie haben eine einfache Aufzählung, die in mehreren Ebenen geschachtelt - ist. Sie schreiben beispielsweise: - \begin{lstcode} - \minisec{Die Fahrzeuge im Spiel} + You have a simple list which is nested in several levels. You write + for example: +\begin{lstcode} + \minisec{Vehicles} \begin{itemize} - \item Flugzeuge + \item aeroplanes \begin{itemize} - \item Doppeldecker - \item Jets - \item Transportmaschinen + \item biplane + \item jets + \item transport planes \begin{itemize} - \item einmotorig + \item single-engined \begin{itemize} - \item{düsengetrieben} - \item{propellergetrieben} + \item jet-driven + \item propeller-driven \end{itemize} - \item mehrmotorig + \item multi-engined \end{itemize} - \item Drehflügler + \item helicopters \end{itemize} - \item Motorräder + \item automobiles \begin{itemize} - \item historisch korrekt - \item futurisch nicht real + \item racing cars + \item private cars + \item lorries \end{itemize} - \item Automobile + \item bicycles \end{itemize} - \end{lstcode} - Anschließend erhalten Sie: +\end{lstcode} + As output you get: \begin{ShowOutput}[\baselineskip] - \minisec{Die Fahrzeuge im Spiel} + \minisec{Vehicles} + \begin{itemize} + \item aeroplanes \begin{itemize} - \item Flugzeuge + \item biplanes + \item jets + \item transport planes \begin{itemize} - \item Doppeldecker - \item Jets - \item Transportmaschinen + \item single-engined \begin{itemize} - \item einmotorig - \begin{itemize} - \item{düsengetrieben} - \item{propellergetrieben} - \end{itemize} - \item mehrmotorig + \item jet-driven + \item propeller-driven \end{itemize} - \item Drehflügler + \item multi-engined \end{itemize} - \item Motorräder - \begin{itemize} - \item historisch korrekt - \item futurisch nicht real - \end{itemize} - \item Automobile -% \begin{itemize} -% \item Rennwagen -% \item Personenwagen -% \item Lastwagen -% \end{itemize} -% \item Fahrräder + \item helicopters \end{itemize} +% Falls fuer die Umbruchoptimierung erforderlich, kann die Liste +% beispielsweise so erweitert werden: +% \item motorcycles +% \begin{itemize} +% \item historically accurate +% \item futuristic, not real +% \end{itemize} + \item automobiles + \begin{itemize} + \item racing cars + \item private cars + \item lorries + \end{itemize} + \item bicycles + \end{itemize} \end{ShowOutput} -\end{Example}% -\fi +\end{Example} +\fi% \ifCommonmaincls % \EndIndex{Env}{itemize}% \EndIndex{Cmd}{item}% @@ -210,64 +221,61 @@ werden. Die einzelnen Stichpunkte werden mit \Macro{item} eingeleitet.% \BeginIndex{Cmd}{labelenumii}% \BeginIndex{Cmd}{labelenumiii}% \BeginIndex{Cmd}{labelenumiv}% -Die nummerierte Liste ist ebenfalls sehr häufig zu finden und bereits vom -{\LaTeX}-Kern vorgesehen. Die Nummerierung\Index{Nummerierung} erfolgt je nach -Ebene in unterschiedlicher Art: mit arabischen Zahlen, mit Kleinbuchstaben, -mit kleinen römischen Zahlen und mit Großbuchstaben. Die Art der Nummerierung -wird dabei über die Makros \Macro{theenumi} bis \Macro{theenumiv} -festgelegt. Das Format der Ausgabe wird von den Makros \Macro{labelenumi} bis -\Macro{labelenumiv} bestimmt. Dabei folgt auf den Wert der zweiten Ebene, der -in Kleinbuchstaben ausgegeben wird, eine runde Klammer, während die Werte -aller anderen Ebenen von einem Punkt gefolgt werden. Die einzelnen -Stichpunkte werden wieder mit \Macro{item} eingeleitet.% +Another form of a list often used is a numbered list which is already +implemented by the {\LaTeX} kernel. Depending on the level, the +numbering\Index{numbering} uses the following characters: Arabic numbers, +small letters, small roman numerals, and capital letters. The kind of numbering +is defined with the macros \Macro{theenumi} down to \Macro{theenumiv}. The +output format is determined by the macros \Macro{labelenumi} to +\Macro{labelenumiv}. While the small letter of the second level is followed by +a round parenthesis, the values of all other levels are followed by a +dot. Every item is introduced with \Macro{item}.% \ifCommonmaincls \begin{Example} \phantomsection\label{desc:maincls.env.enumerate.example}% - Verkürzen wir das vorherige Beispiel und verwenden statt der - \Environment{itemize}- eine - \Environment{enumerate}-Umgebung: -% Übernehmen wir das Beispiel der \Environment{itemize}-Umgebung, -% wobei wir jede \Environment{itemize}-Umgebung durch eine -% \Environment{enumerate}-Umgebung ersetzen. Das Ergebnis wäre dann: + Replacing every occurrence of an \Environment{itemize} environment + with an \Environment{enumerate} environment in the example above we + get the following result: \begin{ShowOutput}[\baselineskip] - \minisec{Die Fahrzeuge im Spiel} + \minisec{Vehicles} \begin{enumerate} - \item Flugzeuge + \item aeroplanes \begin{enumerate} - \item Doppeldecker -% \item Jets - \item Transportmaschinen + \item biplanes + \item jets + \item transport planes \begin{enumerate} - \item einmotorig + \item single-engined \begin{enumerate} - \item{düsengetrieben}\label{xmp:maincls.jets} - \item{propellergetrieben} + \item jet-driven\label{xmp:maincls.jets} + \item propeller-driven \end{enumerate} - \item mehrmotorig + \item multi-engined \end{enumerate} -% \item Drehflügler + \item helicopters \end{enumerate} - \item Motorräder - \begin{enumerate} - \item historisch korrekt - \item futurisch nicht real - \end{enumerate} -% \item Automobile +% Wie oben: +% \item motorcycles % \begin{enumerate} -% \item Rennwagen -% \item Personenwagen -% \item Lastwagen +% \item historically accurate +% \item futuristic, not real % \end{enumerate} -% \item Fahrräder + \item automobiles + \begin{enumerate} + \item racing cars + \item private cars + \item lorries + \end{enumerate} + \item bicycles \end{enumerate} \end{ShowOutput} - Innerhalb der Aufzählung können ganz normal mit \Macro{label} Marken - gesetzt werden, auf die dann mit \Macro{ref} zugegriffen werden - kann. So wurde oben hinter den düsengetriebenen, einmotorigen -% Flugzeugen mit »\Macro{label}\PParameter{bsp:duesen}« ein Label -% gesetzt. Der \Macro{ref}-Wert ist dann »\ref{xmp:maincls.jets}«. -\end{Example}% -\fi + Using \Macro{label} within a list you can set labels which are + referenced with \Macro{ref}. In the example above, a label was set + after the jet-driven, single-engined transport planes with + \Macro{label}\PParameter{xmp:jets}. The \Macro{ref} value is then + \ref{xmp:maincls.jets}. +\end{Example} +\fi% \ifCommonmaincls % \EndIndex{Env}{enumerate}% \EndIndex{Cmd}{item}% @@ -283,65 +291,56 @@ Stichpunkte werden wieder mit \Macro{item} eingeleitet.% \begin{Declaration} \XMacro{begin}\PParameter{\Environment{description}}\\ - \quad\XMacro{item}\OParameter{Stichwort}\\ + \quad\XMacro{item}\OParameter{keyword}\\ \quad\dots\\ \XMacro{end}\PParameter{description} \end{Declaration}% \BeginIndex{Env}{description}% \BeginIndex{Cmd}{item}% -Eine weitere Listenform ist die Stichwortliste. Sie dient in erster Linie der -Beschreibung einzelner Begriffe. Diese werden als optionale Parameter bei -\Macro{item} angegeben. Die -Schriftart\Index{Schriftart}\ChangedAt{v2.8p}{\Class{scrbook}\and - \Class{scrreprt}\and \Class{scrartcl}}, die für die Hervorhebung des -Stichworts verwendet wird, kann außerdem bei den \KOMAScript-Klassen mit Hilfe -der Anweisungen \Macro{setkomafont} und \Macro{addtokomafont} (siehe -\autoref{sec:\csname label@base\endcsname.textmarkup}, -\autopageref{desc:\csname label@base\endcsname.cmd.setkomafont}) für das -Element \FontElement{descriptionlabel}\IndexFontElement{descriptionlabel} -(siehe \autoref{tab:\csname label@base\endcsname.elementsWithoutText}, -\autopageref{tab:\csname label@base\endcsname.elementsWithoutText}) geändert -werden. In der Voreinstellung wird \Macro{sffamily}""\Macro{bfseries} -verwendet.% +A further list form is the description list. Its main use is the description +of several items. The item itself is an optional parameter in +\Macro{item}. The font\Index{font>style}\ChangedAt{v2.8p}{% + \Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% + which is responsible for emphasizing the item can be changed with the commands +\Macro{setkomafont} and \Macro{addtokomafont} (see \autoref{sec:\csname + label@base\endcsname.textmarkup}, \autopageref{desc:\csname + label@base\endcsname.cmd.setkomafont}) for the element +\FontElement{descriptionlabel}\IndexFontElement{descriptionlabel} (see +\autoref{tab:\csname label@base\endcsname.elementsWithoutText}, +\autopageref{tab:\csname label@base\endcsname.elementsWithoutText}). Default +setting is \Macro{sffamily}\linebreak[2]\Macro{bfseries}.% \ifCommonmaincls \begin{Example} \phantomsection\label{desc:maincls.env.description.example}% - Sie wollen, dass die Stichworte statt serifenlos und fett lediglich - fett, aber in der Standardschriftart ausgegeben werden. Mit + Instead of items in sans serif and bold, you want them printed in the + standard font in bold. Using \begin{lstcode} \setkomafont{descriptionlabel}{\normalfont\bfseries} \end{lstcode} - definieren Sie daher die Schrift entsprechend um. + you redefine the font accordingly. - Ein Beispiel für die Ausgabe einer Stichwortliste ist eine Aufzählung der - Seitenstile. Der Quelltext dazu lautet beispielsweise: + An example for a description list is the output of the page styles + listed in \autoref{sec:maincls.pagestyle}. The heavily + abbreviated source could be: \begin{lstcode} \begin{description} - \item[empty] ist der Seitenstil, bei dem Kopf- und - Fußzeile vollständig leer bleiben. - \item[plain] ist der Seitenstil, bei dem keinerlei - Kolumnentitel verwendet wird. - \item[headings] ist der Seitenstil für - automatische Kolumnentitel. - \item[myheadings] ist der Seitenstil für manuelle - Kolumnentitel. + \item[empty] is the page style without any header or footer. + \item[plain] is the page style without headings. + \item[headings] is the page style with running headings. + \item[myheadings] is the page style for manual headings. \end{description} \end{lstcode} - Diese ergibt: + This abbreviated version gives: \begin{ShowOutput} \begin{description} - \item[empty] ist der Seitenstil, bei dem Kopf- und - Fußzeile vollständig leer bleiben. - \item[plain] ist der Seitenstil, bei dem keinerlei - Kolumnentitel verwendet wird. - \item[headings] ist der Seitenstil für automatische - Kolumnentitel. - \item[myheadings] ist der Seitenstil für manuelle - Kolumnentitel. + \item[empty] is the page style without any header or footer. + \item[plain] is the page style without headings. + \item[headings] is the page style with running headings. + \item[myheadings] is the page style for manual headings. \end{description} \end{ShowOutput} -\end{Example}% -\fi +\end{Example} +\fi% \ifComminmaincls % \EndIndex{Env}{description}% \EndIndex{Cmd}{item}% @@ -349,70 +348,83 @@ verwendet.% \begin{Declaration} \XMacro{begin}\PParameter{\Environment{labeling}}% - \OParameter{Trennzeichen}\Parameter{längstes - Muster}\\ - \quad\XMacro{item}\OParameter{Schlüsselwort}\\ + \OParameter{delimiter}\Parameter{widest pattern}\\ + \quad\XMacro{item}\OParameter{keyword}\\ \quad\dots\\ \XMacro{end}\PParameter{labeling} \end{Declaration}% \BeginIndex{Env}{labeling}% \BeginIndex{Cmd}{item}% -Eine andere Form der % -\IfCommon{scrextend}{in vielen Klassen als \Environment{description}-Umgebung -vorhandenen }% -Stichwortliste ist nur bei den {\KOMAScript}-Klassen % -\IfCommon{scrextend}{und \Package{scrextend} }% -vorhanden: die \Environment{labeling}-Umgebung. Im Unterschied zur zuvor -vorgestellten Umgebung \Environment{description} kann bei -\Environment{labeling} ein Muster angegeben werden, dessen Länge die -Einrücktiefe bei allen Stichpunkten ergibt. Darüber hinaus kann zwischen -Stichpunkt und Beschreibungstext ein optionales \PName{Trennzeichen} -festgelegt werden.% -\ifCommonscrlttr\else +An additional form of a description list is only available in the +{\KOMAScript} classes% +\IfCommon{scrextend}{ and the package \Package{scrextend}}: the +\Environment{labeling} environment. Unlike the +\Environment{description} environment, you can provide a pattern whose length +determines the indentation of all items. Furthermore, you can put an optional +\PName{delimiter} between the item and its description. The +font\Index{font>style}\ChangedAt{v3.01}{% + \Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}\and + \Package{scrextend}}% + which is responsible for emphasizing the item and the separator can be changed +with the commands \Macro{setkomafont} and \Macro{addtokomafont} (see \autoref{sec:\csname + label@base\endcsname.textmarkup}, \autopageref{desc:\csname + label@base\endcsname.cmd.setkomafont}) for the element +\FontElement{labelinglabel}\IndexFontElement{labelinglabel} and +\FontElement{labelingseparator}\IndexFontElement{labelingseparator} (see +\ifCommonscrextend +\autoref{tab:maincls.elementsWithoutText}, +\autopageref{tab:maincls.elementsWithoutText} +\else +\autoref{tab:\csname label@base\endcsname.elementsWithoutText}, +\autopageref{tab:\csname label@base\endcsname.elementsWithoutText}% +\fi). +\ifCommonscrlttr\par\else \begin{Example} \phantomsection\label{desc:\csname label@base\endcsname.env.labeling.example}% - \IfCommon{maincls}{Wir schreiben das Beispiel der - \Environment{description}-Umgebung etwas um:}% - \IfCommon{scrextend}{Eine einfache Liste könnte beispielsweise wie folgt - definiert werden:}% - \begin{lstcode} - \begin{labeling}[~--]{% - \usekomafont{descriptionlabel}myheadings} - \item[\usekomafont{descriptionlabel}empty] - Seitenstil für leere Seiten ohne Kopf und Fuß - \item[\usekomafont{descriptionlabel}plain] - Seitenstil für Kapitelanfänge ganz ohne - Kolumnentitel - \item[\usekomafont{descriptionlabel}headings] - Seitenstil für automatische Kolumnentitel - \item[\usekomafont{descriptionlabel}myheadings] - Seitenstil für manuelle Kolumnentitel + \IfCommon{maincls}{Slightly changing the example from the + \Environment{description} environment, we could write:}% + \IfCommon{scrextend}{A small example of a list like this may be written:}% +\begin{lstcode} + \setkomafont{labelinglabel}{\ttfamily} + \setkomafont{labelingseparator}{\normalfont} + \begin{labeling}[~--]{myheadings} + \item[empty] + Page style without header and footer + \item[plain] + Page style for chapter beginnings without headings + \item[headings] + Page style for running headings + \item[myheadings] + Page style for manual headings \end{labeling} - \end{lstcode} - Als Ergebnis erhalten wir dann: +\end{lstcode} + As the result we get: \begin{ShowOutput} - \begin{labeling}[~--]{\usekomafont{descriptionlabel}myheadings} - \item[\usekomafont{descriptionlabel}empty] Seitenstil für leere - Seiten ohne Kopf und Fuß - \item[\usekomafont{descriptionlabel}plain] Seitenstil für - Kapitelanfänge ganz ohne Kolumnentitel - \item[\usekomafont{descriptionlabel}headings] Seitenstil für - automatische Kolumnentitel - \item[\usekomafont{descriptionlabel}myheadings] Seitenstil für - manuelle Kolumnentitel + \setkomafont{labelinglabel}{\ttfamily} + \setkomafont{labelingseparator}{\normalfont} + \begin{labeling}[~--]{myheadings} + \item[empty] + Page style without header and footer + \item[plain] + Page style for chapter beginnings without headings + \item[headings] + Page style for running headings + \item[myheadings] + Page style for manual headings \end{labeling} \end{ShowOutput} - Wie in diesem Beispiel zu sehen ist, muss eine eventuell geforderte - Schriftumschaltung bei dieser Umgebung sowohl im Muster als auch im - optionalen Parameter jeder \Macro{item}-Anweisung wiederholt werden. + As can be seen in this example, a font changing command may be set + in the usual way. But if you don't want the font of the separator to + be changed in the same way as the font of the label, you have to set + the font of the separator as well. \end{Example} -Gedacht war die Umgebung ursprünglich für Strukturen wie »Voraussetzung, -%Aussage, Beweis« oder »Gegeben, Gesucht, Lösung«, wie man sie in -Vorlesungsskripten häufiger findet. Inzwischen findet die Umgebung aber ganz -unterschiedliche Anwendungen. So wurde die Umgebung für Beispiele in dieser -Anleitung mit Hilfe der \Environment{labeling}-Umgebung definiert.% -\fi +\fi% \ifCommonscrlttr \else +Originally, this environment was implemented for things like ``Precondition, +Assertion, Proof'', or ``Given, Required, Solution'' that are often used in +lecture hand-outs. By now this environment has found many different +applications. For example, the environment for examples in this guide was +defined with the \Environment{labeling} environment.% % \EndIndex{Env}{labeling}% \EndIndex{Cmd}{item}% @@ -425,128 +437,88 @@ Anleitung mit Hilfe der \Environment{labeling}-Umgebung definiert.% \XMacro{end}\PParameter{verse} \end{Declaration}% \BeginIndex{Env}{verse}% -Die \Environment{verse}-Umgebung wird normalerweise nicht als Listenumgebung -wahrgenommen, da hier nicht mit \Macro{item} gearbeitet wird. Stattdessen wird -wie innerhalb der \Environment{flushleft}-Umgebung mit festen Zeilenumbrüchen -gearbeitet. Intern handelt es sich jedoch sowohl bei den Standardklassen als -auch bei {\KOMAScript} durchaus um eine Listenumgebung. - -Die \Environment{verse}-Umgebung findet hauptsächlich für -Gedichte\Index{Gedichte} Anwendung. Dabei werden die Zeilen links und rechts -eingezogen. Einzelne Verse werden mit einem festen Zeilenumbruch, also mit -\verb|\\| beendet. Strophen werden ganz normal als Absatz gesetzt, also durch -eine Leerzeile getrennt. Häufig findet stattdessen auch -\Macro{medskip}\IndexCmd{medskip} oder \Macro{bigskip}\IndexCmd{bigskip} -Verwendung. Will man verhindern, dass am Ende eines Verses ein Seitenumbruch -erfolgt, so verwendet man ganz normal \verb|\\*| an Stelle von \verb|\\|.% +Usually the \Environment{verse} environment is not perceived as a list +environment because you do not work with \Macro{item} +commands. Instead, fixed line breaks are used within the +\Environment{flushleft} environment. Yet internally in both the +standard classes as well as {\KOMAScript} it is indeed a list +environment. + +In general, the \Environment{verse} environment is used for +poems\Index{poems}. Lines are indented both left and +right. Individual lines of verse are ended by a fixed line break +\verb|\\|. Verses are set as paragraphs, separated by an empty +line. Often also \Macro{medskip}\IndexCmd{medskip} or +\Macro{bigskip}\IndexCmd{bigskip} is used instead. To avoid a page +break at the end of a line of verse you could, as usual, insert \verb|\\*| +instead of \verb|\\|. \ifCommonmaincls \begin{Example} \phantomsection\label{desc:maincls.env.verse.example}% - Als Beispiel ein kurzes Gedicht von Wilhelm Busch: - \begin{lstcode} + As an example, the first lines of ``Little Red Riding Hood and the + Wolf'' by Roald Dahl: +\begin{lstcode} \begin{verse} - Wenn einer, der mit Mühe kaum\\* - Gekrochen ist auf einen Baum,\\* - Schon meint, dass er ein Vogel wär,\\* - So irrt sich der. + As soon as Wolf began to feel\\* + that he would like a decent meal,\\* + He went and knocked on Grandma's door.\\* + When Grandma opened it, she saw\\* + The sharp white teeth, the horrid grin,\\* + And Wolfie said, `May I come in?' \end{verse} - \end{lstcode} - Mit dem Resultat: +\end{lstcode} + The result is as follows: \begin{ShowOutput} - \vskip-.8\baselineskip% Umbruchkorrektur \begin{verse} - Wenn einer, der mit Mühe kaum\\* - Gekrochen ist auf einen Baum,\\* - Schon meint, dass er ein Vogel wär,\\* - So irrt sich der. + As soon as Wolf began to feel\\* + That he would like a decent meal,\\* + He went and knocked on Grandma's door.\\* + When Grandma opened it, she saw\\* + The sharp white teeth, the horrid grin,\\* + And Wolfie said, `May I come in?' \end{verse} \end{ShowOutput} - Bei einem sehr langen Vers wie: - \begin{lstcode} - \begin{verse} - Der Philosoph wie der Hausbesitzer hat - immer Reparaturen.\\* - \bigskip - Wer dir sagt, er hätte noch nie gelogen, - dem traue nicht, mein Sohn. - \end{verse} - \end{lstcode} - bei dem ein Zeilenumbruch innerhalb des Verses erfolgt: - \begin{ShowOutput} - \vskip-.8\baselineskip% Umbruchkorrektur + However, if you have very long lines of verse, for instance: +\begin{lstcode} \begin{verse} - Der Philosoph wie der Hausbesitzer hat immer Reparaturen.\\ + Both the philosopher and the house-owner + have always something to repair.\\ \bigskip - Wer dir sagt, er hätte noch nie gelogen, dem traue nicht, mein - Sohn. + Don't trust a man, my son, who tells you + that he has never lied. \end{verse} - \end{ShowOutput} - kann mit \verb|\\*| allerdings nicht verhindert werden, dass am - Zeilenumbruch auch ein Seitenumbruch erfolgt. Um dies zu erreichen, müsste - innerhalb der ersten Zeile zusätzlich ein - \Macro{nopagebreak}\IndexCmd{nopagebreak} eingefügt werden: - \begin{lstcode} +\end{lstcode} + where a line break occurs within a line of verse: +\begin{ShowOutput} \begin{verse} - Der Philosoph wie der Hausbesitzer\nopagebreak - hat immer Reparaturen.\\ + Both the philosopher and the house-owner + have always something to repair.\\ \bigskip - Wer dir sagt, er hätte noch nie\nopagebreak - gelogen, dem traue nicht, mein Sohn. + Don't trust a man, my son, who tells you + that he has never lied. \end{verse} - \end{lstcode} -\iftrue% Umbruchkorrekturtext - Hier noch zwei Sprüche, die man immer bedenken sollte, wenn man mit - scheinbar seltsamen Fragen zu {\LaTeX} oder den dazugehörigen Antworten - konfrontiert ist: - \begin{ShowOutput} - \vskip-.8\baselineskip% Umbruchkorrektur +\end{ShowOutput} + there \verb|\\*| can not prevent a page break occurring within a verse + at such a line break. To prevent such a page break, a + \Macro{nopagebreak}\IndexCmd{nopagebreak} would have to be inserted + somewhere in the first line: +\begin{lstcode} \begin{verse} - Wir mögen's keinem gerne gönnen,\\* - Dass er was kann, was wir nicht können.\\ + Both the philosopher and the house-owner\nopagebreak + have always something to repair.\\ \bigskip - Wie klein ist das, was einer ist,\\* - Wenn man's mit seinem Dünkel misst. + Don't trust a man, my son, who tells you\nopagebreak + that he has never lied. \end{verse} - \end{ShowOutput} -\fi - In diesen Beispielen wurde übrigens jeweils \Macro{bigskip} verwendet, um - zwei Sprüche voneinander zu trennen. -\end{Example}% -\fi +\end{lstcode} + + In the above example, \Macro{bigskip} was used to separate the lines + of verse. +\end{Example} +\fi % \ifCommonmaincls % \EndIndex{Env}{verse}% - -\iffalse% Umbruchkorrekturvarianten -\begin{Declaration} - \XMacro{begin}\PParameter{\Environment{quote}}\\ - \quad\dots\\ - \XMacro{end}\PParameter{quote} -\end{Declaration}% -\BeginIndex{Env}{quote}% -Dies ist intern ebenfalls eine Listenumgebung und sowohl bei den -Standardklassen als auch bei {\KOMAScript} zu finden. Der Inhalt der Umgebung -wird im Blocksatz mit beidseitigem Einzug gesetzt. Die Umgebung wird häufig -verwendet, um längere Zitate\Index{Zitat} abzusetzen. Dabei werden Absätze -innerhalb der Umgebung durch einen vertikalen Abstand gekennzeichnet.% -\EndIndex{Env}{quote}% - -\begin{Declaration} - \XMacro{begin}\PParameter{\Environment{quotation}}\\ - \quad\dots\\ - \XMacro{end}\PParameter{quotation} -\end{Declaration}% -\BeginIndex{Env}{quotation}% -Diese Umgebung ist mit \Environment{quote} vergleichbar. Während bei -\Environment{quote} Absätze durch vertikalen Abstand gekennzeichnet werden, -wird bei \Environment{quotation} mit horizontalem Einzug der ersten Zeile -eines Absatzes gearbeitet. Dies gilt auch für den ersten Absatz einer -\Environment{quotation}-Umgebung. Wollen Sie dort den Einzug verhindern, -müssen Sie die \Macro{noindent}-Anweisung\IndexCmd{noindent} voranstellen.% -\EndIndex{Env}{quotation}% - -\else - \begin{Declaration} \XMacro{begin}\PParameter{\Environment{quote}}\\ \quad\dots\\ @@ -557,156 +529,129 @@ müssen Sie die \Macro{noindent}-Anweisung\IndexCmd{noindent} voranstellen.% \end{Declaration}% \BeginIndex{Env}{quote}% \BeginIndex{Env}{quotation}% -Diese beiden Umgebungen sind intern ebenfalls Listenumgebungen und sowohl bei -den Standardklassen als auch bei {\KOMAScript} zu finden. Beide Umgebungen -setzen Blocksatz, der rechts und links eingezogen ist. Verwendet werden die -Umgebungen häufig, um längere Zitate\Index{Zitat} abzusetzen. Der Unterschied -zwischen beiden liegt in der Art und Weise, wie Absätze abgesetzt -werden. Während bei \Environment{quote} Absätze durch vertikalen Abstand -gekennzeichnet werden, wird bei \Environment{quotation} mit horizontalem -Einzug der ersten Zeile eines Absatzes gearbeitet. Dies gilt auch für den -ersten Absatz einer \Environment{quotation}-Umgebung% Umbruchkorrektur -\IfCommon{maincls}{, außer es wird \Macro{noindent}\IndexCmd{noindent} - vorangestellt.}% -\IfCommon{scrlttr2}{. Wollen Sie dort den Einzug verhindern, müssen Sie die - \Macro{noindent}-Anweisung\IndexCmd{noindent} voranstellen.}% +These two environments are also list environments and can be found +both in the standard and the {\KOMAScript} classes. Both environments +use justified text which is indented both on the left and right side. +Usually they are used to separate long citations\Index{citations} from +the main text. The difference between these two lies in the manner in +which paragraphs are typeset. While \Environment{quote} paragraphs are +highlighted by vertical space, in \Environment{quotation} paragraphs +the first line is indented. This is also true for the first line of a +\Environment{quotation} environment. To prevent indentation you have +to insert a \Macro{noindent} command\IndexCmd{noindent} before the +text. \ifCommonmaincls \begin{Example} \phantomsection\label{desc:maincls.env.quote.example}% - Sie wollen eine kleine Anekdote hervorheben. Also schreiben Sie - folgende \Environment{quotation}-Umgebung: + You want to highlight a short anecdote. You write the following + \Environment{quotation} environment for this: % \begin{lstcode} + A small example for a short anecdote: \begin{quotation} - Es klingelt an der Tür eines Pfarrhauses in Stuttgart. - Als die Haushälterin öffnet, steht ein unrasierter - Mann in einem reichlich schäbigen Mantel vor der Tür - und hält seine Strickmütze in der Hand. - - "`Gute Frau,"' verkündet der Mann in gequältem Ton, - doch bestem Hochdeutsch, während er verlegen von einem - Bein auf das andere wechselt, "`ich habe seit drei - Tagen nichts mehr gegessen."' - - Die Frau schüttelt mitleidig den Kopf und - entgegnet im Brustton vollster Überzeugung: - - "`Guda Moh, Sie missat sich halt zwinga!"' + The old year was turning brown; the West Wind was + calling; + + Tom caught the beechen leaf in the forest falling. + ``I've caught the happy day blown me by the breezes! + Why wait till morrow-year? I'll take it when me pleases. + This I'll mend my boat and journey as it chances + west down the withy-stream, following my fancies!'' + + Little Bird sat on twig. ``Whillo, Tom! I heed you. + I've a guess, I've a guess where your fancies lead you. + Shall I go, shall I go, bring him word to meet you?'' \end{quotation} \end{lstcode} - Das Ergebnis ist dann: + The result is: \begin{ShowOutput} -\iffalse% Umbruchkorrekturtext - Ein kleines Beispiel für eine Anekdote, die sich einst - in Schwaben zugetragen haben soll: -\fi + A small example for a short anecdote: \begin{quotation} - Es klingelt an der Tür eines Pfarrhauses in - Stuttgart. Als die Haushälterin öffnet, steht ein - unrasierter Mann in einem reichlich schäbigen - Mantel vor der Tür und hält seine Strickmütze in - der Hand. - - "`Gute Frau,"' verkündet der Mann in gequältem Ton, - doch bestem Hochdeutsch, -\iftrue% Umbruchkorrekturtext - während er verlegen von einem Bein auf das andere wechselt, -\fi - "`ich habe - seit drei Tagen nichts mehr gegessen."' - - Die Frau schüttelt mitleidig den Kopf und entgegnet - im Brustton vollster Überzeugung: - - "`Guda Moh, Sie missat sich halt zwinga!"' + The old year was turning brown; the West Wind was + calling; + + Tom caught the beechen leaf in the forest falling. + ``I've caught the happy day blown me by the breezes! + Why wait till morrow-year? I'll take it when me pleases. + This I'll mend my boat and journey as it chances + west down the withy-stream, following my fancies!'' + + Little Bird sat on twig. ``Whillo, Tom! I heed you. + I've a guess, I've a guess where your fancies lead you. + Shall I go, shall I go, bring him word to meet you?'' \end{quotation} \end{ShowOutput} % - Wenn Sie stattdessen eine \Environment{quote}-Umgebung - verwenden, sieht das Ganze so aus: + Using a \Environment{quote} environment instead you get: % \begin{ShowOutput} -\iffalse% Umbruchkorrekturtext - Ein kleines Beispiel für eine Anekdote, die sich einst - in Schwaben zugetragen haben soll: -\fi - \begin{quote}\setlength{\parskip}{4pt plus 2pt minus 2pt} - Es klingelt an der Tür eines Pfarrhauses in Stuttgart. Als die - Haushälterin öffnet, steht ein unrasierter Mann in einem reichlich - schäbigen Mantel vor der Tür und hält seine Strickmütze in der Hand. - - "`Gute Frau,"' verkündet der Mann in gequältem Ton, doch bestem - Hochdeutsch, -\iftrue% Umbruchkorrekturtext - während er verlegen von einem Bein auf das andere wechselt, -\fi - "`ich habe seit drei Tagen nichts mehr gegessen."' - - Die Frau schüttelt mitleidig den Kopf und entgegnet im Brustton vollster - Überzeugung: - - "`Guda Moh, Sie missat sich halt zwinga!"' + A small example for a short anecdote: + \begin{quote}\setlength{\parskip}{4pt plus 2pt minus 2pt} + The old year was turning brown; the West Wind was + calling; + + Tom caught the beechen leaf in the forest falling. + ``I've caught the happy day blown me by the breezes! + Why wait till morrow-year? I'll take it when me pleases. + This I'll mend my boat and journey as it chances + west down the withy-stream, following my fancies!'' + + Little Bird sat on twig. ``Whillo, Tom! I heed you. + I've a guess, I've a guess where your fancies lead you. + Shall I go, shall I go, bring him word to meet you?'' \end{quote} \end{ShowOutput} % -\end{Example}% -\fi +\end{Example} +\fi % \ifCommonmaincls % \EndIndex{Env}{quote}% \EndIndex{Env}{quotation}% -\fi % Umbruchkorrekturvarianten \fi % \ifCommonscrextend\else \begin{Declaration} \XMacro{begin}\PParameter{\Environment{addmargin}}% - \OParameter{linker Einzug}\Parameter{Einzug}\\ + \OParameter{left indentation}\Parameter{indentation}\\ \quad\dots\\ \XMacro{end}\PParameter{addmargin}\\ \XMacro{begin}\PParameter{\Environment{addmargin*}}% - \OParameter{innerer Einzug}\Parameter{Einzug}\\ + \OParameter{inner indentation}\Parameter{indentation}\\ \quad\dots\\ \XMacro{end}\PParameter{addmargin*} \end{Declaration} \BeginIndex{Env}{addmargin}% \BeginIndex{Env}{addmargin*}% -Wie bei % -\IfCommon{scrextend}{den in den Standardklassen und den \KOMAScript-Klassen - vorhandenen Umgebungen }% -\Environment{quote} und \Environment{quotation} handelt es sich bei -\Environment{addmargin} um eine Umgebung, die den Rand\Index{Rand} -verändert. Im Unterschied zu den beiden erstgenannten Umgebungen kann der -Anwender jedoch bei \Environment{addmargin} wählen, um welchen Wert der Rand -verändert werden kann. Des Weiteren verändert die Umgebung den Absatzeinzug -und den Absatzabstand nicht. Es wird auch kein zusätzlicher vertikaler Abstand -vor und nach der Umgebung eingefügt. - -Ist nur das obligatorische Argument \PName{Einzug} angegeben, so wird der -Inhalt der Umgebung rechts und links um diesen Wert eingezogen. Ist das -optionale Argument \PName{linker Einzug} hingegen angegeben, so wird links -abweichend von \PName{Einzug} der Wert \PName{linker Einzug} zum Rand addiert. - -Die Sternvariante \Environment{addmargin*} unterscheidet sich nur im -doppelseitigen Satz von der Variante ohne Stern, wobei der Unterschied auch -nur dann auf"|tritt, wenn das optionale Argument \PName{innerer Einzug} -verwendet wird. Dabei wird dann der Wert von \PName{innerer Einzug} zum -inneren Randanteil der Seite addiert. Dies ist bei rechten Seiten der linke -Rand der Seite, bei linken Seiten jedoch der rechte Rand der -Seite. \PName{Einzug} gilt dann für den jeweils anderen Rand. - -Bei beiden Varianten der Umgebung sind für alle Parameter auch negative Werte -erlaubt. % Umbruchkorrektur -\IfNotCommon{scrextend}{Damit kann man erreichen, dass die Umgebung in den - Rand hineinragt.}% -\IfCommon{scrextend}{Die Umgebung ragt dann entsprechend in den Rand hinein.}% +Similar to \Environment{quote} and \Environment{quotation}% +\IfCommon{scrextend}{ which are available at the standard classes and also the + \KOMAScript{} classes}% +, the \Environment{addmargin} environment changes the margin\Index{margin}. +In contrast to the first two environments, with \Environment{addmargin} the +user can set the width of the indentation. Besides this, this environment does +not change the indentation of the first line nor the vertical spacing between +paragraphs. + +If only the obligatory argument \PName{indentation} is given, both the +left and right margin are expanded by this value. If the optional +argument \PName{left indentation} is given as well, then at the left +margin the value \PName{left indentation} is used instead of +\PName{indentation}. + +The starred \Environment{addmargin*} only differs from the normal +version in a two-sided layout. Furthermore, the difference only occurs +if the optional argument \PName{inner indentation} is used. In this +case this value \PName{inner indentation} is added to the normal inner +indentation. For right-hand pages this is the left margin, for +left-hand pages the right margin. Then the value of +\PName{indentation} determines the width of the opposite margin. + +Both versions of this environment take also negative values for all +parameters. This has the effect of expanding the environment into the +margin. \ifCommonscrlttr\else \begin{Example} \phantomsection\label{desc:maincls.env.addmargin.example}% - Angenommen, Sie schreiben eine Anleitung mit kurzen - Quellcode-Beispielen. Um diese sehr stark hervorzuheben, sollen sie mit - horizontalen Linien vom Text abgesetzt und leicht in den äußeren Rand - verschoben werden. Sie definieren sich dafür zunächst eine Umgebung: - \begin{lstcode} - \newenvironment{QuellcodeRahmen}{% +\begin{lstcode} + \newenvironment{SourceCodeFrame}{% \begin{addmargin*}[1em]{-1em}% \begin{minipage}{\linewidth}% \rule{\linewidth}{2pt}% @@ -715,9 +660,11 @@ erlaubt. % Umbruchkorrektur \end{minipage}% \end{addmargin*}% } - \end{lstcode} +\end{lstcode} + If you now put your source code in such an environment it will show + up as: \begin{ShowOutput} - \newenvironment{QuellcodeRahmen}{% + \newenvironment{SourceCodeFrame}{% \begin{addmargin*}[1em]{-1em}% \begin{minipage}{\linewidth}% \rule{\linewidth}{2pt}% @@ -726,10 +673,10 @@ erlaubt. % Umbruchkorrektur \end{minipage}% \end{addmargin*}% } - Die Umgebung in sich selbst gesetzt ergibt: - \begin{QuellcodeRahmen} + You define yourself the following environment: + \begin{SourceCodeFrame} \begin{lstcode} -\newenvironment{\QuellcodeRahmen}{% +\newenvironment{\SourceCodeFrame}{% \begin{addmargin*}[1em]{-1em}% \begin{minipage}{\linewidth}% \rule{\linewidth}{2pt}% @@ -739,48 +686,47 @@ erlaubt. % Umbruchkorrektur \end{addmargin*}% } \end{lstcode} - \end{QuellcodeRahmen} - Das mag praktisch sein oder unpraktisch, zumindest jedoch zeigt es, - wie die Umgebung verwendet werden kann. + \end{SourceCodeFrame} + This may be feasible or not. In any case it shows the usage of this + environment. \end{ShowOutput} - Das optionale Argument der \Environment{addmargin*}-Umgebung sorgt - dafür, dass der innere Rand um den Wert - 1\Unit{em} vergrößert wird. Dafür wird der äußere - Rand um den negativen Wert vergrößert, also in Wirklichkeit um - 1\Unit{em} verkleinert. Dies resultiert in einer - Verschiebung um 1\Unit{em} nach außen. Selbstverständlich kann statt - \PValue{1em} auch eine Länge, beispielsweise - \PValue{2\Macro{parindent}}, verwendet werden. + The optional argument of the \Environment{addmargin*} environment + makes sure that the inner margin is extended by 1\Unit{em}. In turn + the outer margin is decreased by 1\Unit{em}. The result is a shift + by 1\Unit{em} to the outside. Instead of \PValue{1em} you can of + course use a length, for example, \PValue{2\Macro{parindent}}. \end{Example} -Ob eine Seite eine linke oder eine rechte Seite ist, kann übrigens beim ersten -\LaTeX-Durchlauf nicht zuverlässig festgestellt werden. Siehe dazu die -Erklärungen zu den Anweisungen \Macro{ifthispageodd} (\autoref{sec:\csname +Whether a page is going to be on the left or right side +of the book can not be determined for certain in the first {\LaTeX} +run. For details please refer to the explanation of the commands +\Macro{ifthispageodd} (\autoref{sec:\csname label@base\endcsname.oddOrEven}, \autopageref{desc:\csname - label@base\endcsname.cmd.ifthispageodd}) und \Macro{ifthispagewasodd} + label@base\endcsname.cmd.ifthispageodd}) and \Macro{ifthispagewasodd} (\autoref{sec:maincls-experts.addInfos}, \autopageref{desc:maincls-experts.cmd.ifthispageodd}). \begin{Explain} - Im Zusammenspiel von Umgebungen wie Listen mit Absätzen ergeben sich für - Laien häufiger Fragen. Daher widmet sich die weiterführende Erklärung zu - Option \Option{parskip} in \autoref{sec:maincls-experts.addInfos}, - \autopageref{desc:maincls-experts.option.parskip} auch diesem - Thema. Ebenfalls im Expertenteil in \autoref{sec:maincls-experts.addInfos}, - \autopageref{desc:maincls-experts.env.addmargin*} wird die - Problematik von mehrseitigen \Environment{addmargin*}-Umgebungen behandelt. + There may be several questions about coexistence of lists and + paragraphs. Because of this additional information may be found at the + description of option \Option{parskip} in + \autoref{sec:maincls-experts.addInfos}, + \autopageref{desc:maincls-experts.option.parskip}. Also at the expert part, + in \autoref{sec:maincls-experts.addInfos}, + \autopageref{desc:maincls-experts.env.addmargin*}, you may find additional + information about page breaks inside of \Environment{addmargin*}.% \end{Explain}% -\fi% \ifCommonmaincls +\fi% \ifCommonscrlttr\else % \EndIndex{Env}{addmargin}% \EndIndex{Env}{addmargin*}% % -\EndIndex{}{Listen} -\fi% IgnoreThis +\EndIndex{}{lists} +\fi %**************************************************** Ende nur maincls * %%% Local Variables: %%% mode: latex -%%% coding: iso-latin-1 +%%% coding: us-ascii %%% TeX-master: "../guide" %%% End: |