summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex
blob: 54d1873bec510dbfebf61a7a93ad771d89046a33 (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
% ======================================================================
% common-headfootheight.tex
% Copyright (c) Markus Kohm, 2013-2017
%
% 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-headfootheight.tex
% Copyright (c) Markus Kohm, 2013-2017
%
% 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.
% ======================================================================
%
% Text that is common for several chapters of the KOMA-Script guide
% Maintained by Markus Kohm
%
% ----------------------------------------------------------------------
%
% Absaetze, die mehreren Kapitels in der KOMA-Script-Anleitung gemeinsam sind
% Verwaltet von Markus Kohm
%
% ============================================================================

\KOMAProvidesFile{common-headfootheight.tex}
                 [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
                  KOMA-Script guide (common paragraph: Head and Foot Height)]
\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne}

% Date of the translated German file: 2017-01-02

\section{Head and Foot Height}
\seclabel{height}
\BeginIndexGroup
\BeginIndex{Package}{scrlayer}%
\BeginIndex{}{page>head>height}%
\BeginIndex{}{page>foot>height}%

\IfThisCommonLabelBase{scrlayer-scrpage}{%
  \begin{Explain}
    The \LaTeX{} standard classes do not use the page footer a lot and if they
    do use it, they put the contents into a \Macro{mbox} which results in the
    footer being a single text line. This is probably the reason that \LaTeX{}
    itself does not have a well-defined foot height. Actually there is
    \Length{footskip}\IndexLength{footskip} giving the distance between the
    last base line of the text area and the base line of the footer. However,
    if the footer consists of more than one text line, there is no definite
    statement whether this length should be the distance to the first or the
    last base line of the footer.

    Despite the fact that the page header of the standard classes will also be
    put into a horizontal box and therefore is a single text line too,
    \LaTeX{} indeed has a length to setup the height of the page header. The
    reason for this may be that the height will be needed to determine the
    start of the text area.
  \end{Explain}%
}{%
  Page head and footer are the main elements not only of a page style. Layer
  can also be restricted to these using corresponding options (see
  \autoref{tab:scrlayer.layerkeys},
  \autopageref{tab:scrlayer.layerkeys}). Therefore the heights of these
  elements are very important and have to be well defined.%
}

\IfThisCommonFirstRun{}{%
  All of what is described in
  \autoref{sec:\ThisCommonFirstLabelBase.height} is generally
  applicable. So if you have alread read and understood
  \autoref{sec:\ThisCommonFirstLabelBase.height} you can switch to
  \autoref{sec:\ThisCommonLabelBase.height.next},
  \autopageref{sec:\ThisCommonLabelBase.height.next}.%
}

\begin{Declaration}
  \Length{footheight}%
  \Length{headheight}
\end{Declaration}
The package \Package{scrlayer} introduces \Length{footheight} as a new length
similar to \Length{headheight} of the \LaTeX{} kernel. Additionally
\Package{scrlayer-scrpage} interprets \Length{footskip} to be the distance
from the last possible base line of the text area to the first normal base
line of the footer. Package \Package{typearea}\IndexPackage{typearea}
interprets \Package{footheight} in the same way. So \Package{typearea}'s foot
height options may also be used to setup the values for packages
\Package{scrlayer} and \Package{scrlayer-scrpage}. See option
\DescRef{typearea.option.footheight} and \DescRef{typearea.option.footlines}
in \autoref{sec:typearea.typearea},
\DescPageRef{typearea.option.footheight}) and option
\DescRef{typearea.option.footinclude} at
\DescPageRef{typearea.option.footinclude} of the same section.

If you do not use package \Package{typearea}, you should setup the head and
foot height using the lengths directly where necessary. At least for the head
package \Package{geometry} provides similar settings. If you setup a head or
foot height that is too small for the effective content,
\Package{scrlayer-scrpage} will try to adjust the corresponding lengths
properly. Furthermore, it will warn you and give you additional information
about the changes and proper settings you may use yourself. The automatic
changes will become valid immediately after the need for them has been
detected.  They will never be removed automatically, however, even if content
with a lower height requirement should be detected at a later point in time.%
\EndIndexGroup
%
\EndIndexGroup

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