summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/english/common-interleafpage.tex
blob: 24842ac25b10e0e592ec5fd806f49eb7445a2f7e (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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
% ======================================================================
% common-interleafpage.tex
% Copyright (c) Markus Kohm, 2001-2019
%
% 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-interleafpage.tex
% Copyright (c) Markus Kohm, 2001-2019
%
% 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-interleafpage.tex}%
                 [$Date: 2019-11-11 08:22:00 +0100 (Mon, 11 Nov 2019) $
                  KOMA-Script guide (common paragraphs: Interleaf Pages)]
\translator{Markus Kohm\and Gernot Hassenpflug\and Krickette Murabayashi\and
	Karl Hagen}

% Date of the translated German file: 2019-11-11

\section{Interleaf Pages}
\seclabel{emptypage}%
\BeginIndexGroup
\BeginIndex{}{interleaf page}%%
\BeginIndex{}{page>style}%

\IfThisCommonFirstRun{}{%
  The information in \autoref{sec:\ThisCommonFirstLabelBase.emptypage} applies
  equally to this chapter. So if you have already read and understood
  \autoref{sec:\ThisCommonFirstLabelBase.emptypage}, you can skip ahead to
  \autoref{sec:\ThisCommonLabelBase.emptypage.next},
  \autopageref{sec:\ThisCommonLabelBase.emptypage.next}.%
}

\IfThisCommonLabelBase{scrextend}{}{%
  Interleaf pages are pages that are inserted between parts of a document.
  Traditionally, these pages are completely blank. \LaTeX{}, however, sets
  them by default with the current page style. \KOMAScript{} provides several
  extensions to this functionality.

  Interleaf pages are mostly found in books. Because book chapters commonly
  start on the right (recto) page of a two-page spread, an empty left (verso)
  page must be inserted if the previous chapter ends on a recto page. For this
  reason, interleaf pages really only exist for two-sided printing.
%
  \iffalse % Umbruchkorrektur
  The blank versos in one-sided printing are not true interleaf pages,
  although they may appear as such in counting the printed sheets.%
  \fi%

  \IfThisCommonLabelBase{scrlttr2}{%
    Interleaf pages are unusual in letters. This is not least because
    two-sided letters are rare, as letters are usually not
    bound. Nevertheless, \KOMAScript{} also supports interleaf pages for
    two-sided letters. However, since the commands described here are seldom
    used in letters, you will not find any examples here. If necessary, please
    refer to the examples in \autoref{sec:maincls.emptypage}, starting on
    \autopageref{sec:maincls.emptypage}.%
  }{}%
}%

\begin{Declaration}
  \OptionVName{cleardoublepage}{page style}
  \OptionValue{cleardoublepage}{current}
\end{Declaration}%
With this option,\IfThisCommonLabelBase{maincls}{%
  \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
    \Class{scrartcl}}%
}{%
  \IfThisCommonLabelBase{scrlttr2}{%
    \ChangedAt{v3.00}{\Class{scrlttr2}}%
  }{}%
} you can define the page style of the interleaf pages created by the commands
\DescRef{\LabelBase.cmd.cleardoublepage},
\DescRef{\LabelBase.cmd.cleardoubleoddpage}, or
\DescRef{\LabelBase.cmd.cleardoubleevenpage} to advance to the desired page.
You can use any previously defined \PName{page style} (see
\autoref{sec:\ThisCommonLabelBase.pagestyle} from
\autopageref{sec:\ThisCommonLabelBase.pagestyle} and
\autoref{cha:scrlayer-scrpage} from \autopageref{cha:scrlayer-scrpage}).
In addition, \OptionValue{cleardoublepage}{current} is also possible.
This case corresponds to the default prior to \KOMAScript~2.98c and creates an
interleaf page without changing the page style. Starting with
\KOMAScript~3.00\IfThisCommonLabelBase{maincls}{%
  \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
    \Class{scrartcl}}%
}{%
  \IfThisCommonLabelBase{scrlttr2}{%
    \ChangedAt{v3.00}{\Class{scrlttr2}}%
  }{}%
}, the default\textnote{default} follows the recommendation of most
typographers and creates interleaf pages with the
\IfThisCommonLabelBase{scrextend}{%
  \DescRef{maincls.pagestyle.empty}}{%
  \DescRef{\ThisCommonLabelBase.pagestyle.empty}}\IndexPagestyle{empty}
page style unless you switch compatibility to earlier \KOMAScript{} versions
(see option \DescRef{\ThisCommonLabelBase.option.version}%
\important{\OptionValueRef{\LabelBase}{version}{2.98c}},
\autoref{sec:\ThisCommonLabelBase.compatibilityOptions},
\DescPageRef{\ThisCommonLabelBase.option.version}).
\IfThisCommonLabelBase{maincls}{\iftrue}{\csname iffalse\endcsname}
  \begin{Example}
    \phantomsection\xmpllabel{option.cleardoublepage}%
    Suppose you want interleaf pages that are empty except for the pagination% 
    \iffree{, so they are created with \IfThisCommonLabelBase{scrextend}{%
        \DescRef{maincls.pagestyle.plain}}{%
        \DescRef{\LabelBase.pagestyle.plain}}}{}. You can achieve this,
    for example, with:
\begin{lstcode}
  \KOMAoptions{cleardoublepage=plain}
\end{lstcode}
    You can find more information about the
    \IfThisCommonLabelBase{scrextend}{%
      \DescRef{maincls.pagestyle.plain}}{\DescRef{\LabelBase.pagestyle.plain}}
    page style in \IfThisCommonLabelBase{scrextend}{%
      \autoref{sec:maincls.pagestyle}}{%
      \autoref{sec:\LabelBase.pagestyle}},
    \IfThisCommonLabelBase{scrextend}{%
      \DescPageRef{maincls.pagestyle.plain}}{%
      \DescPageRef{\LabelBase.pagestyle.plain}}.
  \end{Example}
\else
  \IfThisCommonLabelBase{scrextend}{%
    You can find an example for setting the page style of interleaf pages in
    \autoref{sec:\ThisCommonFirstLabelBase.emptypage},
    \PageRefxmpl{\ThisCommonFirstLabelBase.option.cleardoublepage}.%
    \iffalse% Umbruchvariante ohne Beispiel
  }{\csname iffalse\endcsname}
    \begin{Example}
      \phantomsection\xmpllabel{option.cleardoublepage}%
      Suppose you want interleaf pages that are empty except for the pagination,
      so they are created with the \IfThisCommonLabelBase{scrextend}{%
        \DescRef{maincls.pagestyle.plain}}{\DescRef{\LabelBase.pagestyle.plain}}
      page style. You can achieve this with
\begin{lstcode}
  \KOMAoptions{cleardoublepage=plain}
\end{lstcode}
      You can find more information about the
      \DescRef{maincls.pagestyle.plain} page style in
      \autoref{sec:maincls.pagestyle}, \DescPageRef{maincls.pagestyle.plain}.
    \end{Example}%
  \fi%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{clearpage}%
  \Macro{cleardoublepage}%
  \Macro{cleardoublepageusingstyle}\Parameter{page style}%
  \Macro{cleardoubleemptypage}%
  \Macro{cleardoubleplainpage}%
  \Macro{cleardoublestandardpage}%
  \Macro{cleardoubleoddpage}%
  \Macro{cleardoubleoddpageusingstyle}\Parameter{page style}%
  \Macro{cleardoubleoddemptypage}%
  \Macro{cleardoubleoddplainpage}%
  \Macro{cleardoubleoddstandardpage}%
  \Macro{cleardoubleevenpage}%
  \Macro{cleardoubleevenpageusingstyle}\Parameter{page style}%
  \Macro{cleardoubleevenemptypage}%
  \Macro{cleardoubleevenplainpage}%
  \Macro{cleardoubleevenstandardpage}
\end{Declaration}%
The\textnote{standard classes} {\LaTeX} kernel provides the \Macro{clearpage}
command, which ensures that all pending floats are output and then starts a
new page. There is also the \Macro{cleardoublepage} command, which works like
\Macro{clearpage} but which starts a new right-hand page in two-sided printing
(see the \Option{twoside} layout option in \autoref{sec:typearea.options},
\DescPageRef{typearea.option.twoside}). An empty left-hand page in the current
page style is output if necessary.

With\IfThisCommonLabelBase{maincls}{%
  \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
    \Class{scrartcl}}%
}{%
  \IfThisCommonLabelBase{scrlttr2}{%
    \ChangedAt{v3.00}{\Class{scrlttr2}}%
  }{}%
} \Macro{cleardoubleoddstandardpage}, {\KOMAScript}\textnote{\KOMAScript}
works as exactly in the way just described for the standard classess.  The
\Macro{cleardoubleoddplainpage}%
\important{\IfThisCommonLabelBase{scrextend}{%
    \DescRef{maincls.pagestyle.plain}}{\DescRef{\LabelBase.pagestyle.plain}}}
command, on the other hand, additionally changes the page style of the empty
left page to \IfThisCommonLabelBase{scrextend}{%
  \DescRef{maincls.pagestyle.plain}}{\DescRef{\LabelBase.pagestyle.plain}}%
\IndexPagestyle{plain} in order to suppress the
\IfThisCommonLabelBase{scrlttr2}{page header}{running title}.  Likewise, the
\Macro{cleardoubleoddemptypage}\important{%
  \IfThisCommonLabelBase{scrextend}{\DescRef{maincls.pagestyle.empty}}{%
    \DescRef{\LabelBase.pagestyle.empty}}} command uses the
\IfThisCommonLabelBase{scrextend}{\DescRef{maincls.pagestyle.empty}}{%
  \DescRef{\LabelBase.pagestyle.empty}}\IndexPagestyle{empty} page style to
suppress both \IfThisCommonLabelBase{scrlttr2}{page header and page footer}%
{running title and page number} on the empty left-hand side. The page is thus
completely empty. If you want to specify your own \PName{page style} for the
interleaf page, this should be given as an argument of
\Macro{cleardoubleoddusingpagestyle}. You can use any previously defined
\PName{page style} (see \autoref{cha:scrlayer-scrpage}).

\IfThisCommonLabelBase{scrlttr2}{}{%
  Sometimes\textnote{odd-side interleaf pages} you want chapters to start not
  on the right-hand but on the left-hand page. Although this layout contradicts
  classic typography, it can be appropriate if the double-page spread at the
  beginning of the chapter very specific contents. For this reason,
  \KOMAScript{} provides the \Macro{cleardoubleevenstandardpage} command,
  which is equivalent to the \Macro{cleardoubleoddstandardpage} command
  except that the next page is a left page. The same applies to the
  \Macro{cleardoubleevenplainpage}, \Macro{cleardoubleevenemptypage}, and
  \Macro{cleardoubleevenpageusingstyle} commands%
  \IfThisCommonLabelBase{maincls}{% Umbruchoptimierungsalternative
  , the last of which expects an argument}{}.%
}

The \Macro{cleardoublestandardpage}, \Macro{cleardoubleemptypage}, and
\Macro{cleardoubleplainpage} commands, and the single-argument
\Macro{cleardoublepageusingstyle} command, as well as the standard
\Macro{cleardoublepage} command, %
\IfThisCommonLabelBase{maincls}{%
  depend on the \DescRef{maincls.option.open}\IndexOption{open}%
  \important{\DescRef{maincls.option.open}} option explained in
  \autoref{sec:maincls.structure}, \DescPageRef{maincls.option.open} and,
  depending on that setting, correspond to one of the commands explained in
  the preceding paragraphs.  }{%
  correspond to the commands previously explained for the
  \IfThisCommonLabelBase{scrlttr2}{\Class{scrlttr2} class}{%
    \IfThisCommonLabelBase{scrextend}{\Package{scrextend} package}{%
      \InternalCommonFileUsageError}%
  }%
  \IfThisCommonLabelBase{scrlttr2}{. %
    The remaining commands are defined in \Class{scrlttr2} for completeness
    only. You can find more information on them in
    \autoref{sec:maincls.emptypage}, \DescPageRef{maincls.cmd.cleardoublepage}
    if necessary%
  }{%
    \ to transition to the next odd page%
  }.%
}%
\IfThisCommonLabelBaseOneOf{scrlttr2,scrextend}{\iffalse}{\csname
  iftrue\endcsname}
  \begin{Example}
    \phantomsection\xmpllabel{cmd.cleardoublepage}%
    Suppose you want to insert a double-page spread into your document with a
    picture on the left-hand page and a new chapter starting on the right-hand
    page. If the previous chapter ends with a left-hand page, an interleaf 
    page has to be added, which should be completely empty. The picture should
    be the same size as the text area without any header or footer. 
\iffalse% Umbruchkorrekturtext
      First of all,
\begin{lstcode}
  \KOMAoptions{cleardoublepage=empty}
\end{lstcode}
      ensures that interleaf pages use the
      \IfThisCommonLabelBase{scrextend}{\DescRef{maincls.pagestyle.empty}}{%
    	\DescRef{\LabelBase.pagestyle.empty}} page style. You can put this
      setting in the document preamble, or you can set it as an optional 
      argument of \DescRef{\ThisCommonLabelBase.cmd.documentclass}.
\fi

    At the relevant place in your document, write:
\begin{lstcode}
  \cleardoubleevenemptypage
  \thispagestyle{empty}
  \includegraphics[width=\textwidth,%
                   height=\textheight,%
                   keepaspectratio]%
                  {picture}
  \chapter{Chapter Heading}
\end{lstcode}
    The first of these lines switches to the next left-hand page. If needed it
    also adds a completely blank right-hand page. The second line makes sure
    that the following left-hand page will also be set using the 
    \IfThisCommonLabelBase{scrextend}{\DescRef{maincls.pagestyle.empty}}{%
    	\DescRef{\LabelBase.pagestyle.empty}} page style. The third through
    sixth lines load an image file named \File{picture} and scale it to the
    desired size without distorting it. This command requires the 
    \Package{graphicx}\IndexPackage{graphicx} package (see
    \cite{package:graphics}). The last line starts
    a new chapter on the next page, which will be a right-hand one.
  \end{Example}%
\fi%

In two-sided printing, \Macro{cleardoubleoddpage} always moves to the next
left-hand page and \Macro{cleardoubleevenpage} to the next right-hand
page. The style of the interleaf page to be inserted if necessary is defined
with the \DescRef{\LabelBase.option.cleardoublepage} option.%
\IfThisCommonLabelBase{scrextend}{\par%
  For an example that uses \Macro{cleardoubleevenemptypage}, see
  \autoref{sec:maincls.emptypage},
  \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.cleardoublepage}.%
}{}%
\EndIndexGroup
%
\EndIndexGroup

%%% Local Variables:
%%% mode: latex
%%% mode: flyspell
%%% coding: us-ascii
%%% ispell-local-dictionary: "en_GB"
%%% TeX-master: "../guide"
%%% End:

%  LocalWords:  mutatis mutandis Interleaf interleaf