diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex | 245 |
1 files changed, 131 insertions, 114 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex index dede85afca5..2f8f870f71d 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.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-15.tex}[2009/01/04 KOMA-Script guide (common paragraphs)] -\translator{Gernot Hassenpflug} +\ProvidesFile{common-15.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,29 +58,32 @@ \makeatother -\section{Schlauer Spruch} +\section{Dicta} \label{sec:\csname label@base\endcsname.dictum}% \ifshortversion\IgnoreThisfalse\IfNotCommon{maincls}{\IgnoreThistrue}\fi% -\ifIgnoreThis -Es gilt sinngemäß, was in \autoref{sec:maincls.dictum} geschrieben -wurde. \IfCommon{scrextend}{Allerdings werden von \Package{scrextend} die - Anweisungen \Macro{setchapterpreamble} und \Macro{setpartpreamble} nicht - definiert. Ob die verwendete Klasse eine entsprechende Anweisung bietet, ist - der Anleitung zur jeweiligen Klasse zu entnehmen.} -\else -\BeginIndex{}{Spruch}% -\BeginIndex{}{Zitat}% -\BeginIndex{}{Redewendung}% - -Ein häufiger anzutreffendes Element ist ein Zitat oder eine Redewendung, die -rechtsbündig unter oder über einer Überschrift gesetzt wird. Dabei werden der -Spruch selbst und der Quellennachweis in der Regel speziell formatiert. +\ifIgnoreThis %+++++++++++++++++++++++++++++++++++++++++++++ nicht maincls + +It applies, mutatis mutandis, what is described in +\autoref{sec:maincls.dictum}. +\IfCommon{scrextend}{% + However, \Package{scrextend} does not support the commands + \Macro{setchapterpreamble} and \Macro{setpartpreamble}. You should read + the manual of the used class, if you want to know, if that class does + support similar commands.} +\else %------------------------------------------------------- nur maincls - +\BeginIndex{}{smart slogan}% +\BeginIndex{}{dictum}% +\BeginIndex{}{excerpt}% + +Sometimes you may find a dictum, a kind of smart slogan or excerpt, often ragged +left above or below the heading of a chapter or section. The text and the +source of the slogan often use special styles. \begin{Declaration} - \Macro{dictum}\OParameter{Urheber}\Parameter{Spruch}\\ + \Macro{dictum}\OParameter{author}\Parameter{dictum}\\ \Macro{dictumwidth}\\ - \Macro{dictumauthorformat}\Parameter{Urheber}\\ + \Macro{dictumauthorformat}\Parameter{author}\\ + \Macro{dictumrule}\\ \Macro{raggeddictum}\\ \Macro{raggeddictumtext}\\ \Macro{raggeddictumauthor} @@ -86,141 +91,153 @@ Spruch selbst und der Quellennachweis in der Regel speziell formatiert. \BeginIndex{Cmd}{dictum}% \BeginIndex{Cmd}{dictumwidth}% \BeginIndex{Cmd}{dictumauthorformat}% +\BeginIndex{Cmd}{dictumrule}% \BeginIndex{Cmd}{raggeddictum}% \BeginIndex{Cmd}{raggeddictumtext}% \BeginIndex{Cmd}{raggeddictumauthor}% -Ein solcher Spruch kann mit der Anweisung \Macro{dictum} gesetzt werden. % -\IfCommon{maincls}{Bei \KOMAScript-Klassen wird für Kapitel oder die Teile - empfohlen, \Macro{dictum} als obligatorisches Argument einer der Anweisungen - \Macro{setchapterpreamble} oder \Macro{setpartpreamble} (siehe - \autoref{sec:maincls.structure}, - \autopageref{desc:maincls.cmd.setchapterpreamble}) zu verwenden. Dies ist - jedoch nicht zwingend.\par}% -Der Spruch wird zusammen mit einem optional anzugebenden \PName{Urheber} in -einer \Macro{parbox}\IndexCmd{parbox} (siehe \cite{latex:usrguide}) der Breite -\Macro{dictumwidth} gesetzt. Dabei ist \Macro{dictumwidth} keine Länge, die -mit \Macro{setlength} gesetzt wird. Es handelt sich um ein Makro, das mit -\Macro{renewcommand} umdefiniert werden kann. Vordefiniert ist -\lstinline;0.3333\textwidth;, also ein Drittel der jeweiligen Textbreite. Die -Box selbst wird mit der Anweisung \Macro{raggeddictum} -ausgerichtet. Voreingestellt ist dabei -\Macro{raggedleft}\IndexCmd{raggedleft}, also rechtsbündig. -\Macro{raggeddictum} kann mit Hilfe von \Macro{renewcommand} umdefiniert -werden. - -Innerhalb der Box wird der \PName{Spruch} mit \Macro{raggeddictumtext} -angeordnet. Voreingestellt ist hier \Macro{raggedright}\IndexCmd{raggedright}, -also linksbündig. Eine Umdefinierung ist auch hier mit \Macro{renewcommand} -möglich. Die Ausgabe erfolgt in der für Element \FontElement{dictumtext} -eingestellten Schriftart, die mit den Anweisungen \Macro{setkomafont} und -\Macro{addtokomafont} (siehe \autoref{sec:\csname +The command \Macro{dictum} inserts such a dictum. +\IfCommon{maincls}{This\textnote{Hint!} macro can be used as obligatory + argument of either the command \Macro{setchapterpreamble} or + \Macro{setpartpreamble}. However, this is not obligatory.\par}% +The dictum together with an optional \PName{author} is inserted in a +\Macro{parbox}\IndexCmd{parbox} (see \cite{latex:usrguide}) of width +\Macro{dictumwidth}. Yet \Macro{dictumwidth} is not a length which can be set +with \Macro{setlength}. It is a macro that can be redefined using +\Macro{renewcommand}. Default setting is \verb;0.3333\textwidth;, which is a +third of the textwidth. The box itself is positioned with the command +\Macro{raggeddictum}. Default here is \Macro{raggedleft}\IndexCmd{raggedleft}, +that is, right justified. The command \Macro{raggeddictum} can be redefined +using \Macro{renewcommand}. + +Within the box the \PName{dictum} is set using \Macro{raggeddictumtext}. +Default setting is \Macro{raggedright}\IndexCmd{raggedright}, that is, left +justified. Similarly to \Macro{raggeddictum} this can be redefined with +\Macro{renewcommand}. The output uses the default font setting for the +element \FontElement{dictumtext}, which 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}) geändert werden kann. Die -Voreinstellung entnehmen Sie bitte \autoref{tab:maincls.dictumfont}% + label@base\endcsname.cmd.setkomafont}). Default settings are listed in +\autoref{tab:maincls.dictumfont}% \IfNotCommon{maincls}{, \autopageref{tab:maincls.dictumfont}}% . -Ist ein \PName{Urheber} angegeben, so wird dieser mit einer Linie über die -gesamte Breite der \Macro{parbox} vom \PName{Spruch} abgetrennt. Mit -\Macro{raggeddictumauthor} wird die Ausrichtung vorgenommen. Voreingestellt -ist \Macro{raggedleft}. Auch diese Anweisung kann mit \Macro{renewcommand} -umdefiniert werden. Die Ausgabe erfolgt in der Form, die mit -\Macro{dictumauthorformat} festgelegt ist. Das Makro erwartet schlicht den -\Macro{Urheber} als Argument. In der Voreinstellung ist -\Macro{dictumauthorformat} als -\begin{lstcode}[aboveskip={1ex plus 2ex},belowskip={1ex plus 2ex}] - \newcommand*{\dictumauthorformat}[1]{(#1)} -\end{lstcode} -definiert. Der \PName{Urheber} wird also in runde Klammern gesetzt. Für das -Element \PName{dictumauthor} kann dabei eine Abweichung der Schrift von der -des Elementes \PName{dictumtext} definiert werden. Die Voreinstellung -entnehmen Sie bitte \autoref{tab:maincls.dictumfont}. Eine Änderung ist 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}) möglich.% -% \ifCommonmaincls \begin{table} - \centering% - \caption{Schriftvoreinstellungen für die Elemente des Spruchs} - \begin{tabular}{ll} +% \centering% + \KOMAoptions{captions=topbeside}% + \setcapindent{0pt}% +% \caption + \begin{captionbeside}{Default settings for the elements of a dictum} + [l] + \begin{tabular}[t]{ll} \toprule - Element & Voreinstellung \\ + Element & Default \\ \midrule - \FontElement{dictumtext} & + \FontElement{dictumtext} & \Macro{normalfont}\Macro{normalcolor}\Macro{sffamily}\Macro{small}\\ \FontElement{dictumauthor} & \Macro{itshape}\\ \bottomrule \end{tabular} + \end{captionbeside} \label{tab:maincls.dictumfont} \end{table} +\fi + +If there is an \PName{author} name, it is separated from the \PName{dictum} by +a rule to the full width of the +\Macro{parbox}. This\IfCommon{maincls}{\ChangedAt{v3.10}{\Class{scrbook}\and + \Class{scrreprt}\and \Class{scrartcl}}}% +\IfCommon{scrextend}{\ChangedAt{v3.10}{\Package{scrextend}}} rule is defined +as vertical object to command \Macro{dictumrule}: +% Satzkorrektur listings +\begin{lstcode}[belowskip=\dp\strutbox] + \newcommand*{\dictumrule}{\vskip-1ex\hrulefill\par} +\end{lstcode} -Wird \Macro{dictum} innerhalb der Anweisung \Macro{setchapterpreamble} oder -\Macro{setpartpreamble} (siehe \autoref{sec:maincls.structure}, -\autopageref{desc:maincls.cmd.setchapterpreamble}) verwendet, so ist -Folgendes zu beachten: Die horizontale Anordnung erfolgt immer mit -\Macro{raggeddictum}. Das optionale Argument zur horizontalen Anordnung, das -die beiden Anweisungen vorsehen, bleibt daher ohne Wirkung. \Macro{textwidth} -ist nicht die Breite des gesamten Textkörpers, sondern die aktuelle -Textbreite. Ist also die Breite \Macro{dictumwidth} als -\lstinline;.5\textwidth; definiert und bei \Macro{setchapterpreamble} wird als -optionales Argument für die Breite ebenfalls \lstinline;.5\textwidth; -angegeben, so erfolgt die Ausgabe in einer Box, deren Breite ein Viertel der -Breite des Textkörpers ist. Es wird empfohlen, bei Verwendung von -\Macro{dictum} auf die optionale Angabe einer Breite bei -\Macro{setchapterpreamble} oder \Macro{setpartpreamble} zu verzichten. - -Sollen mehrere schlaue Sprüche untereinander gesetzt werden, so sollten diese -durch einen zusätzlichen Abstand vertikal voneinander abgesetzt werden. Ein -solcher kann leicht mit der Anweisung \Macro{bigskip}\IndexCmd{bigskip} -gesetzt werden. +The alignment is defined with \Macro{raggeddictumauthor}. Default is +\Macro{raggedleft}. This command can also be redefined using +\Macro{renewcommand}. The format of the output is defined with +\Macro{dictumauthorformat}. This macro expects the \Macro{author} as +argument. As default \Macro{dictumauthorformat} is defined as: +% Satzkorrektur listings +\begin{lstcode}[belowskip=\dp\strutbox] + \newcommand*{\dictumauthorformat}[1]{(#1)} +\end{lstcode} +Thus the \PName{author} is set enclosed in rounded parentheses. For +the element \FontElement{dictumauthor}, a different font than for the +element \FontElement{dictumtext} can be defined. Default settings are +listed in \autoref{tab:maincls.dictumfont}. Changes can be made using +the commands \Macro{setkomafont} and \Macro{addtokomafont} (see +\autoref{sec:\csname label@base\endcsname.textmarkup}, +\autopageref{desc:\csname label@base\endcsname.cmd.setkomafont}).% +% +\ifCommonmaincls + +If \Macro{dictum} is used within the macro \Macro{setchapterpreamble} +or \Macro{setpartpreamble} you have to take care of the following: the +horizontal positioning is always done with \Macro{raggeddictum}. +Therefore, the optional argument for horizontal positioning which is +implemented for these two commands has no effect. \Macro{textwidth} is +not the width of the whole text corpus but the actually used text +width. If \Macro{dictumwidth} is set to \verb;.5\textwidth; and +\Macro{setchapterpreamble} has an optional width of +\verb;.5\textwidth; too, you will get a box with a width one quarter +of the text width. Therefore, if you use \Macro{dictum} it is +recommended to refrain from setting the optional width for +\Macro{setchapterpreamble} or \Macro{setpartpreamble}. + +If\textnote{Hint!} you have more than one dictum, one under another, you should +separate them by an additional vertical space, easily accomplished using the +command \Macro{bigskip}\IndexCmd{bigskip}. \begin{Example} - Sie schreiben ein Kapitel über die moderne Ehe. Dabei wollen sie in der - Präambel zur Kapitelüberschrift einen schlauen Spruch setzen. Dieser soll - unter der Überschrift erscheinen. Also schreiben Sie: - \begin{lstcode} + You are writing a chapter on an aspect of weather forecasting. You + have come across an aphorism which you would like to place at the + beginning of the chapter beneath the heading. You could write: +\begin{lstcode} \setchapterpreamble[u]{% - \dictum[Schiller]{Drum prüfe, - wer sich ewig bindet \dots}} - \chapter{Die moderne Ehe} - \end{lstcode} - Die Ausgabe erfolgt dann in der Form: + \dictum[Anonymous]{Forecasting is the art of saying + what is going to happen and then to explain + why it didn't.}} + \chapter{Weather forecasting} +\end{lstcode} + The output would look as follows: \begin{ShowOutput} {\usekomafont{disposition}\usekomafont{chapter}% - 17\enskip Die moderne Ehe\par} - \vspace{\baselineskip} - \dictum[Schiller]{Drum prüfe, wer sich ewig bindet \dots} + 17\enskip Weather forecasting\par} \vspace{\baselineskip} + \dictum[Anonymous]{Forecasting is the art of saying what is going to + happen and then to explain why it didn't.} \end{ShowOutput} - Wenn Sie wollen, dass nicht ein Drittel, sondern nur ein Viertel der - verfügbaren Textbreite für den Spruch verwendet wird, so definieren Sie - \Macro{dictumwidth} wie folgt um: - \begin{lstcode} + If you would rather the dictum span only a quarter of the text width + rather than one third you can redefine \Macro{dictumwidth}: +\begin{lstcode} \renewcommand*{\dictumwidth}{.25\textwidth} - \end{lstcode} +\end{lstcode} \end{Example} -An dieser Stelle sei noch auf das Paket~\cite{package:ragged2e} hingewiesen, -mit dem man Flattersatz mit Trennung erreichen kann.% +For a somewhat more sophisticated formatting of left- or right-aligned +paragraphs including hyphenation you can use the +package~\Package{ragged2e}~\cite{package:ragged2e}.% \fi % \EndIndex{Cmd}{dictum}% \EndIndex{Cmd}{dictumwidth}% \EndIndex{Cmd}{dictumauthorformat}% +\EndIndex{Cmd}{dictumrule}% \EndIndex{Cmd}{raggeddictum}% \EndIndex{Cmd}{raggeddictumtext}% \EndIndex{Cmd}{raggeddictumauthor}% % -\EndIndex{}{Redewendung}% -\EndIndex{}{Zitat}% -\EndIndex{}{Spruch}% -\fi % IgnoreThis +\EndIndex{}{excerpt}% +\EndIndex{}{smart slogan}% +\EndIndex{}{dictum}% +\fi %**************************************************** Ende nur maincls * %%% Local Variables: %%% mode: latex -%%% coding: iso-latin-1 +%%% coding: us-ascii %%% TeX-master: "../guide" %%% End: |