summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/english/common-draftmode.tex
blob: 383c9236c568d3c2b57088ba3fcf8e5e4e506b90 (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
% ======================================================================
% common-draftmode.tex
% Copyright (c) Markus Kohm, 2001-2018
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
% This work may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c of the license.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX 
% version 2005/12/01 or later and of this work.
%
% This work has the LPPL maintenance status "author-maintained".
%
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-draftmode.tex
% 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.
% Die neuste Version dieser Lizenz ist
%   http://www.latex-project.org/lppl.txt
% und Version 1.3c ist Teil aller Verteilungen von LaTeX
% Version 2005/12/01 oder spaeter und dieses Werks.
%
% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
% (allein durch den Autor verwaltet).
%
% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
% 
% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
%
% Paragraphs that are common for several chapters of the KOMA-Script guide
% Maintained by Markus Kohm
%
% ----------------------------------------------------------------------
%
% Absaetze, die mehreren Kapiteln der KOMA-Script-Anleitung gemeinsam sind
% Verwaltet von Markus Kohm
%
% ======================================================================

\KOMAProvidesFile{common-draftmode.tex}
                 [$Date: 2018-02-28 13:23:23 +0100 (Wed, 28 Feb 2018) $
                  KOMA-Script guide (common paragraphs)]
\translator{Markus Kohm\and Gernot Hassenpflug\and Krickette Murabayashi\and
  Karl Hagen}

% Date of the translated German file: 2018-01-30

\section{Draft Mode}
\seclabel{draft}%
\BeginIndexGroup
\BeginIndex{}{draft mode}%

\IfThisCommonFirstRun{}{%
  The information in \autoref{sec:\ThisCommonFirstLabelBase.draft} applies
  equally to \IfThisCommonLabelBase{scrlttr2}{\Class{scrlttr2}%
	\OnlyAt{\Class{scrlttr2}}}{this chapter}. So if you have already read 
  and understood \autoref{sec:\ThisCommonFirstLabelBase.draft}, you can skip
  ahead to \autoref{sec:\ThisCommonLabelBase.draft.next} on
  \autopageref{sec:\ThisCommonLabelBase.draft.next}.%
  \IfThisCommonLabelBase{scrlttr2}{ The \Package{scrletter} package does not
  	provide a draft mode itself but relies upon the class you use.}{}%
}

Many classes and packages provide a draft mode in addition to the normal
typesetting mode. The differences between these two are as diverse as
the classes and packages that offer this distinction.%
\IfThisCommonLabelBase{scrextend}{% Umbruchkorrekturtext
  \ The draft mode of some packages also results in changes to the output
  that affect the document's layout. This is not the case with
  \Package{scrextend}.%
}{}

\begin{Declaration}
  \OptionVName{draft}{simple switch}
  \OptionVName{overfullrule}{simple switch}
\end{Declaration}%
The \Option{draft}\IfThisCommonLabelBase{maincls}{%
  \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrartcl}\and
    \Class{scrreprt}}%
}{%
  \IfThisCommonLabelBase{scrlttr2}{%
    \ChangedAt{v3.00}{\Class{scrlttr2}}\OnlyAt{\Class{scrlttr2}}%
  }{}%
} option distinguishes between documents being drafted and finished
documents\Index{final version}. The \PName{simple switch} can be one of the
standard values for simple switches from \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}. If you activate this
option\important{\OptionValue{draft}{true}}, small black boxes will be output
at the end of overly long lines. These boxes make it easier for the untrained
eye to locate the paragraphs that require manual post-processing. By contrast,
the default, \OptionValue{draft}{false}, shows no such boxes. Incidentally,
such lines often disappear when you use the
\Package{microtype}\IndexPackage{microtype}\important{\Package{microtype}}
package \cite{package:microtype}.

Since\IfThisCommonLabelBase{maincls}{%
  \ChangedAt{v3.25}{\Class{scrbook}\and \Class{scrartcl}\and
    \Class{scrreprt}}%
}{%
  \IfThisCommonLabelBase{scrlttr2}{%
    \ChangedAt{v3.25}{\Class{scrlttr2}}%
  }{%
    \IfThisCommonLabelBase{scrextend}{%
      \ChangedAt{v3.25}{\Package{scrextend}}%
    }{}%
  }%
} the \Option{draft} option can lead to all sorts of unwanted effects with
various packages, \KOMAScript{} allows you to control this marking of overly
long lines separately with the
\Option{overfullrule}\important{\OptionValue{overfullrule}{true}} option.  If
this option is enabled, the marker is again displayed.%
% 
\EndIndexGroup
%
\EndIndexGroup

%%% Local Variables:
%%% mode: latex
%%% coding: us-ascii
%%% TeX-master: "../guide"
%%% End: