summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex137
1 files changed, 82 insertions, 55 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex
index 54d1873bec5..8f9fcbb9462 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-headfootheight.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-headfootheight.tex
-% Copyright (c) Markus Kohm, 2013-2017
+% Copyright (c) Markus Kohm, 2013-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-headfootheight.tex
-% Copyright (c) Markus Kohm, 2013-2017
+% Copyright (c) Markus Kohm, 2013-2018
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,82 +46,109 @@
% ============================================================================
\KOMAProvidesFile{common-headfootheight.tex}
- [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
+ [$Date: 2018-02-28 13:23:23 +0100 (Wed, 28 Feb 2018) $
KOMA-Script guide (common paragraph: Head and Foot Height)]
-\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne}
+\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne\and Karl Hagen}
-% Date of the translated German file: 2017-01-02
+% Date of the translated German file: 2018-01-16
-\section{Head and Foot Height}
+\section{Header and Footer Height}
\seclabel{height}
\BeginIndexGroup
-\BeginIndex{Package}{scrlayer}%
-\BeginIndex{}{page>head>height}%
-\BeginIndex{}{page>foot>height}%
-
+\BeginIndex{}{header>height}%
+\BeginIndex{}{footer>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
+ \begin{Explain}%
+ The \LaTeX{} standard classes do not use the footer much, 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.
+ itself does not have a well-defined footer height. Although the distance
+ between the last baseline of the text area and the baseline of the footer
+ is defined with \Length{footskip}\IndexLength[indexmain]{footskip}, 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
+ baseline 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.
+ Although the page header of the standard classes will also be put into a
+ horizontal box, and therefore is also a single text line, \LaTeX{} in fact
+ provides a length to set the height of the header. The reason for this may
+ be that this height is 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},
+ The header and footer of a page are central elements not just of a page
+ style. They can also serve to restrict layers using the appropriate 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.%
+ elements must be 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
+ The information in \autoref{sec:\ThisCommonFirstLabelBase.height} applies
+ equally to this chapter. So if you have already read and understood
+ \autoref{sec:\ThisCommonFirstLabelBase.height}, you can skip ahead to
\autoref{sec:\ThisCommonLabelBase.height.next},
\autopageref{sec:\ThisCommonLabelBase.height.next}.%
}
\begin{Declaration}
- \Length{footheight}%
+ \Length{footheight}
\Length{headheight}
+ \IfThisCommonLabelBase{scrlayer-scrpage}{%
+ \OptionVName{autoenlargeheadfoot}{simple switch}%
+ }{}%
\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
+The \Package{scrlayer} package introduces a new length, \Length{footheight},
+analogous to \Length{headheight}%
+\IfThisCommonLabelBase{scrlayer-scrpage}{}{of the \LaTeX{} kernel}.
+Additionally,
+\Package{scrlayer\IfThisCommonLabelBase{scrlayer-scrpage}{-scrpage}{}}
+interprets \Length{footskip} to be the distance from the last baseline of the
+text area to the first normal baseline of the footer. The
+\hyperref[cha:typearea]{\Package{typearea}}\IndexPackage{typearea}%
+\important{\hyperref[cha:typearea]{\Package{typearea}}} package interprets
+\Length{footheight} in the same way, so \Package{typearea}'s options for the
+footer height can also be used to set the values for the \Package{scrlayer}
+package. See the \DescRef{typearea.option.footheight} and
+\DescRef{typearea.option.footlines} options in
+\autoref{sec:typearea.typearea}, \DescPageRef{typearea.option.footheight})
+and option \DescRef{typearea.option.footinclude} on
\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.%
+If you do not use the \hyperref[cha:typearea]{\Package{typearea}}%
+\important{\hyperref[cha:typearea]{\Package{typearea}}} package, you should
+adjust the header and footer heights using appropriate values for the lengths
+where necessary. For the header, at least, the \Package{geometry} package, for
+example, provides similar settings.
+\IfThisCommonLabelBase{scrlayer-scrpage}{\par%
+ If you choose a header or footer height that is too small for the actual
+ content, \Package{scrlayer-scrpage} tries by default to adjust the lengths
+ appropriately. At the same time, it will issue a warning containing
+ suggestions for suitable settings. These automatic changes take effect
+ immediately after the need for them has been detected and are not
+ automatically reversed, for example, when the content of the header or
+ footer becomes smaller afterwards.
+ However,\ChangedAt{v3.25}{\Package{scrlayer-scrpage}}, this behaviour can be
+ changed by using the \Option{autoenlargeheadfoot} option. This option
+ recognizes the values for simple switches in \autoref{tab:truefalseswitch},
+ \autopageref{tab:truefalseswitch}. The option is activated by default. If it
+ is deactivated, the header and footer are no longer enlarged
+ automatically. Only a warning with hints for suitable settings is issued.%
+}{%
+ \IfThisCommonLabelBase{scrlayer}{\par%
+ If you choose a header or footer height that is too small for the actual
+ content, \Package{scrlayer} usually accepts this without issuing an error
+ message or a warning. The header then expands according to its height,
+ usually upwards, with the footer moved down accordingly. Information about
+ this change is not obtained automatically. However, packages like
+ \hyperref[cha:scrlayer-scrpage]{\Package{scrlayer-scrpage}}%
+ \important{\hyperref[cha:scrlayer-scrpage]{\Package{scrlayer-scrpage}}}%
+ \IndexPackage{scrlayer-scrpage} that build upon \Package{scrlayer} may
+ contain their own tests which can lead to their own actions (see
+ \DescRef{scrlayer-scrpage.length.headheight} and
+ \DescRef{scrlayer-scrpage.length.footheight} on
+ \DescPageRef{scrlayer-scrpage.length.headheight}).%
+ }{}%
+}%
\EndIndexGroup
%
\EndIndexGroup