summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/common-dictum.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-dictum.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-dictum.tex192
1 files changed, 106 insertions, 86 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-dictum.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-dictum.tex
index c89b4e093a6..5dff550ac7d 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-dictum.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-dictum.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-dictum.tex
-% Copyright (c) Markus Kohm, 2001-2017
+% Copyright (c) Markus Kohm, 2001-2018
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-dictum.tex
-% Copyright (c) Markus Kohm, 2001-2017
+% Copyright (c) Markus Kohm, 2001-2018
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,42 +46,51 @@
% ======================================================================
\KOMAProvidesFile{common-dictum.tex}
- [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
+ [$Date: 2018-03-30 09:37:06 +0200 (Fri, 30 Mar 2018) $
KOMA-Script guide (common paragraphs)]
-\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi}
+\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi\and
+ Karl Hagen}
-% Date of the translated German file: 2017-01-02
+% Date of the translated German file: 2018-01-29
\section{Dicta}
\seclabel{dictum}%
\BeginIndexGroup
-\BeginIndex{}{smart slogan}%
+\BeginIndex{}{saying}%
\BeginIndex{}{dictum}%
-\BeginIndex{}{excerpt}%
+\BeginIndex{}{epigraph}%
\IfThisCommonFirstRun{}{%
- What is written in \autoref{sec:\ThisCommonFirstLabelBase.dictum} applies,
- mutatis mutandis. %
+ The information in \autoref{sec:\ThisCommonFirstLabelBase.dictum} applies
+ equally to this chapter. %
\IfThisCommonLabelBase{scrextend}{%
However, \Package{scrextend} does not support the commands
\DescRef{maincls.cmd.setchapterpreamble} and
- \DescRef{maincls.cmd.setpartpreamble}. You should read the manual of the
- used class, if you want to know, if that class does support similar
- commands. %
+ \DescRef{maincls.cmd.setpartpreamble}.
+ \iftrue% Umbruchvariante
+ Whether the class you are using offers an equivalent instruction
+ can be found in the documentation for the respective class .%
+ \fi%
}{}%
- So if you have alread read and understood
- \autoref{sec:\ThisCommonFirstLabelBase.dictum} you can jump to
- \autoref{sec:\ThisCommonLabelBase.dictum.next} on
+ So if you have already read and understood
+ \autoref{sec:\ThisCommonFirstLabelBase.dictum}, you can skip ahead to
+ \autoref{sec:\ThisCommonLabelBase.dictum.next},
\autopageref{sec:\ThisCommonLabelBase.dictum.next}.%
-}
-
-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.
+}{}%
+\IfThisCommonLabelBase{scrextend}{% Umbruchkorrekturvarianten
+ A common element in a document is an epigraph or quotation that is set above
+ or below a chapter or section heading, typically right-justified. The
+ epigraph and its source are usually specially formatted.%
+}{%
+ A common element in a document is an epigraph or quotation that is set above
+ or below a chapter or section heading, along with a reference to the source
+ and its own formatting.%
+} %
+\KOMAScript{} refers to such an epigraph as a \emph{dictum}.
\begin{Declaration}
- \Macro{dictum}\OParameter{author}\Parameter{dictum}%
+ \Macro{dictum}\OParameter{author}\Parameter{text}%
\Macro{dictumwidth}%
\Macro{dictumauthorformat}\Parameter{author}%
\Macro{dictumrule}%
@@ -89,30 +98,34 @@ the source of the slogan often use special styles.
\Macro{raggeddictumtext}%
\Macro{raggeddictumauthor}
\end{Declaration}%
-The command \Macro{dictum} inserts such a dictum. %
+You can set such a saying with the help of the \Macro{dictum} command. %
\IfThisCommonLabelBase{maincls}{%
- This\textnote{Hint!} macro can be used as obligatory argument of either the
- command \DescRef{maincls.cmd.setchapterpreamble} or
- \DescRef{maincls.cmd.setpartpreamble}. However, this is not obligatory.\par%
+ This\textnote{Hint!} macro can be included in the mandatory argument of
+ either the \DescRef{maincls.cmd.setchapterpreamble} or the
+ \DescRef{maincls.cmd.setpartpreamble} command. However, this is not
+ obligatory.\par%
}{}%
-The dictum together with an optional \PName{author} is inserted in a
+The dictum, along 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 \PValue{0.3333\Length{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}.
+\Macro{dictumwidth}. However, \Macro{dictumwidth} is not a length which can be
+set with \Macro{setlength}. It is a macro that can be redefined using
+\Macro{renewcommand}. The default is \PValue{0.3333\Length{textwidth}}, which
+is one third of the text width. The box itself is aligned with the command
+\Macro{raggeddictum}. The default is \Macro{raggedleft}\IndexCmd{raggedleft},
+that is, right justified. \Macro{raggeddictum} can be redefined
+with \IfThisCommonLabelBase{scrextend}{% Umbruchoptimierung
+}{the help of }\Macro{renewcommand}.
+You can align the \PName{dictum} within the box using
+\Macro{raggeddictumtext}\important{\Macro{raggeddictumtext}}.
+The default is \Macro{raggedright}\IndexCmd{raggedright}, that is, left
+justified. You can also redefine this macro with \Macro{renewcommand}.%
\BeginIndexGroup
\BeginIndex{FontElement}{dictum}\LabelFontElement{dictum}%
-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{dictum}, which can be changed with the commands
-\DescRef{\ThisCommonLabelBase.cmd.setkomafont} and
+\LabelFontElement{dictumtext}%
+The output uses the default font setting for the element
+\FontElement{dictum}\important{\FontElement{dictum}}, which can be changed
+with the commands \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and
\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} (see
\autoref{sec:\ThisCommonLabelBase.textmarkup},
\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}). Default settings are
@@ -141,9 +154,10 @@ listed in \autoref{tab:maincls.dictumfont}%
}{%
, \autopageref{tab:\ThisCommonFirstLabelBase.dictumfont}.%
}
+\EndIndexGroup
-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%
+If an \PName{author} is defined, it is separated from the \PName{dictum} by
+a horizontal rule spanning the full width of the \Macro{parbox}. This%
\IfThisCommonLabelBase{maincls}{%
\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}%
@@ -152,81 +166,85 @@ a rule to the full width of the \Macro{parbox}. This%
\ChangedAt{v3.10}{\Package{scrextend}}%
}{\InternalCommonFileUsageError}%
} %
-rule is defined as vertical object to command \Macro{dictumrule}:
+rule is defined in \Macro{dictumrule}\important{\Macro{dictumrule}} as a
+vertical object with
\begin{lstcode}
\newcommand*{\dictumrule}{\vskip-1ex\hrulefill\par}
\end{lstcode}
-The alignment is defined with \Macro{raggeddictumauthor}. Default is
+The \Macro{raggeddictumauthor}\important{\Macro{raggeddictumauthor}} command
+defines the alignment for the rule and the \PName{author}. The 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 \PName{author} as
-argument. As default \Macro{dictumauthorformat} is defined as:
+\Macro{renewcommand}. The format is defined with
+\Macro{dictumauthorformat}\important{\Macro{dictumauthorformat}}. This macro
+expects the \PName{author} text as its argument. By default
+\Macro{dictumauthorformat} is defined as
\begin{lstcode}
\newcommand*{\dictumauthorformat}[1]{(#1)}
\end{lstcode}
+Thus the \PName{author} is set enclosed in rounded parentheses.
+\BeginIndexGroup
\BeginIndex{FontElement}{dictumauthor}\LabelFontElement{dictumauthor}%
-Thus the \PName{author} is set enclosed in rounded parentheses. For the
-element \FontElement{dictumauthor}, a different font than for the element
-\DescRef{\LabelBase.fontelement.dictum} can be defined. Default settings are
+For the \FontElement{dictumauthor}\important{\FontElement{dictumauthor}}
+element, you can define a different font than that used for the
+\DescRef{\LabelBase.fontelement.dictum} element. The default settings are
listed in \autoref{tab:maincls.dictumfont}. Changes can be made using the
-commands \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and
-\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} (see
+\DescRef{\ThisCommonLabelBase.cmd.setkomafont} and
+\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} commands (see
\autoref{sec:\ThisCommonLabelBase.textmarkup},
\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}).%
\EndIndexGroup
\IfThisCommonLabelBase{maincls}{%
- If \Macro{dictum} is used within the macro
+ If you use \Macro{dictum} within the
\DescRef{maincls.cmd.setchapterpreamble} or
- \DescRef{maincls.cmd.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. \Length{textwidth} is not the width of the whole text corpus but the
- actually used text width. If \Macro{dictumwidth} is set to
+ \DescRef{maincls.cmd.setpartpreamble} macro, you must ensure that
+ 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.
+ \Length{textwidth} is not the width of the whole text body but the
+ current text width. If \Macro{dictumwidth} is set to
\PValue{.5\Length{textwidth}} and \DescRef{maincls.cmd.setchapterpreamble}
has an optional width of \PValue{.5\Length{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 \DescRef{maincls.cmd.setchapterpreamble} or
+ box with a width one quarter of the text width. Therefore, if you use
+ \Macro{dictum} you should refrain from setting the optional width for
+ \DescRef{maincls.cmd.setchapterpreamble} or
\DescRef{maincls.cmd.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}.%
+ should separate them by an additional vertical space, which is easily
+ accomplished using the \Macro{bigskip}\IndexCmd{bigskip} command.%
\iftrue%
}{\csname iffalse\endcsname}
- \begin{Example}
- 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{Example}
+ You are writing a chapter about modern marriage, and you want to place a
+ dictum in the preamble to the chapter heading. You write:
\begin{lstcode}
\setchapterpreamble[u]{%
- \dictum[Anonymous]{Forecasting is the art of saying
- what is going to happen and then to explain
- why it didn't.}}
- \chapter{Weather forecasting}
+ \dictum[Schiller]{So pause ye who would link your fates~\dots}}
+ \chapter{Modern Marriage}
\end{lstcode}
- The output would look as follows:
- \begin{ShowOutput}
- {\usekomafont{disposition}\usekomafont{chapter}%
- 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}
-
- If you would rather the dictum span only a quarter of the text width
- rather than one third you can redefine \Macro{dictumwidth}:
+ The output would look as follows:
+ \begin{ShowOutput}
+ {\usekomafont{disposition}\usekomafont{chapter}%
+ 17\enskip Modern Marriage\par} \vspace{\baselineskip}
+ \dictum[Schiller]{So pause ye who would link
+ your fates~\dots}
+ \end{ShowOutput}
+
+ If you want the dictum to span only a quarter of the text width
+ rather than a third, you can redefine \Macro{dictumwidth} this way:
\begin{lstcode}
\renewcommand*{\dictumwidth}{.25\textwidth}
\end{lstcode}
- \end{Example}
+\end{Example}
- For a somewhat more sophisticated formatting of left- or right-aligned
- paragraphs including hyphenation you can use the
- package~\Package{ragged2e}~\cite{package:ragged2e}.%
+\IfThisCommonLabelBase{maincls}{}{% Umbruchkorrekturtext
+ At this point, note the \Package{ragged2e}\important{\Package{ragged2e}}%
+ \IndexPackage{ragged2e} package, with which you can produce unjustified text
+ that uses hyphenation (see \cite{package:ragged2e}).%
+}%
\fi
%
\EndIndexGroup
@@ -235,6 +253,8 @@ commands \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and
%%% Local Variables:
%%% mode: latex
+%%% mode: flyspell
%%% coding: us-ascii
+%%% ispell-local-dictionary: "en_GB"
%%% TeX-master: "../guide"
-%%% End:
+%%% End: