diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex | 1119 |
1 files changed, 549 insertions, 570 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex index f04590023ae..cee23e6fe5f 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex @@ -40,83 +40,82 @@ % % ---------------------------------------------------------------------- % -% Kapitel über scrpage2 in der KOMA-Script-Anleitung -% Verwaltet von Jens-Uwe Morawski (unterstützt von Markus Kohm) +% Kapitel über scrpage2 in der KOMA-Script-Anleitung +% Verwaltet von Jens-Uwe Morawski (unterstützt von Markus Kohm) % % ============================================================================ -\ProvidesFile{scrpage2.tex}[2006/07/01 KOMA-Script guide (chapter:scrpage2)] -% date of translated german file: 2004/08/10 +\ProvidesFile{scrpage2.tex}[2007/09/27 KOMA-Script guide (chapter:scrpage2)] +\translator{Jens-Uwe Morawski\and Karl-Heinz Zimmer\and Christoph Bier\and + Gernot Hassenpflug\and Markus Kohm} -\chapter{Adapt Head and Foot with \Package{scrpage2}} +% date of translated german file: 2005/08/10 + +\chapter{Adapting Page Headers and Footers with \Package{scrpage2}} \labelbase{scrpage} % \BeginIndex{Package}{scrpage2}% -% -In \autoref{cha:typearea} this guide referenced a package -to customise the head and foot lines of a document. -This package \Package{scrpage2}, the successor of \Package{scrpage}, -enables the user to create versatile head and foot layouts with -less effort, due to a simple but powerful user interface. While -\Package{scrpage} is obsolete since 2001, this documentation only describes -\Package{scrpage2}. +As already mentioned in the two previous chapters, {\KOMAScript} +includes a package to customise the document page header and footer. +As of 2001, this package is no longer \Package{scrpage} but the much +improved and enhanced successor \Package{scrpage2}. Therefore, this +documentation describes only \Package{scrpage2}. The package +\Package{scrpage} is obsolete. \begin{Explain} - The package's focus is its good integration into the whole - \KOMAScript{}-bundle, thus it extents the base functionality of - \KOMAScript{} perfectly. It is very flexible in either its layout and - usage, compared to other packages often to be seen like - \Package{fancyhdr}\cite{package:fancyhdr}. You don't need to use - \Package{scrpage2} with \KOMAScript{}, the package can be used in any other - document-class environment. + In place of \Package{scrpage2} you can of course make use of + \Package{fancyhdr} (see \cite{package:fancyhdr}). However, + \Package{scrpage2} integrated markedly better with the {\KOMAScript} + bundle. For this reason, and because at the time the forerunner to + \Package{fancyhdr} was missing many features, \Package{scrpage2} was + developed. Naturally, \Package{scrpage2} is not limited to use only + with the {\KOMAScript} classes, but can just as easily be used with + other document classes. \end{Explain} +Included as part of the basic functionality of \Package{scrpage2} are +various predefined and configurable page styles. \section{Basic Functionality}\label{sec:scrpage.basics} \begin{Explain}% Introduction to headings - \LaTeX{}'s head and foot mechanism is a little complicated, thus a - brief view in its depth is needed. - Basically the \LaTeX{} kernel defines the chief page styles - \PValue{empty} and \PValue{plain}. - The latter writes only a page number in the foot, in contrast - using \PValue{empty} results in blank head and foot. - Besides, many document classes provide the style - \PValue{headings}, which allows more complex style settings. - The \PValue{headings} style often has a subvariant, the - \emph{my}-variant. In contrast to the \PValue{headings} style - the \PValue{myheadings} switches off the automatic update - of the running head, thus it is the users task keeping headings - in sync with the current document content. - A more detailed discription can be found in - \autoref{sec:maincls.pageStyle}. - - Another important note is that some \LaTeX{} commands - switch to the pagestyle \PValue{plain} for the current page, - independent from what pagestyle was choosen by the author, - consequently the document needs an appropriate - \PValue{plain} pagestyle. + To understand the following description, an overview of {\LaTeX}'s + fairly involved header and footer mechanism is needed. The {\LaTeX} + kernel defines the page styles \PValue{empty}, which produces a + completely empty header and footer, and \PValue{plain}, which + produces usually only a page number in the footer and an empty + header. Apart from these, many document classes provide the style + \PValue{headings}, which allows more complex style settings and + running headings. The \PValue{headings} style often has a related + variant, \PValue{myheadings}, which is similar except for switching + off the running headings and reverting them to manual control by the + user. A more detailed description is given in + \autoref{sec:maincls.pageStyle} where it is also noted that some + {\LaTeX} commands automatically switch to the page style + \PValue{plain} for the current page, independent of what page style + was chosen by the author, and consequently a document needs an + appropriate \PValue{plain} page style. - Therefore \Package{scrpage2} defines its own \PValue{plain} - and \PValue{headings} page styles, named \PValue{scrplain} - and \PValue{scrheadings}. - The manual activation of \PValue{scrplain} is not necessary, - since the activation of \PValue{scrheadings} takes care of it - automatically. - Only if one wants to use his own page style in combination - with \PValue{scrplain}, the page style \PValue{scrplain} has to - be activated first, i.e. \Macro{pagestyle}\Parameter{scrplain}% + Therefore \Package{scrpage2} defines its own \PValue{plain} and + \PValue{headings} page styles, named \PValue{scrplain} and + \PValue{scrheadings}. The manual activation of \PValue{scrplain} is + not necessary, since the activation of \PValue{scrheadings} takes + care of it automatically. Only if one wants to use one's own page + style in combination with \PValue{scrplain} must the page style + \PValue{scrplain} be activated first, i.\,e., with + \Macro{pagestyle}\Parameter{scrplain}% \Macro{pagestyle}\Parameter{personalPagestyle}. \end{Explain} -The original \PValue{headings} page style of the document class is available -as \PValue{useheadings}. This re-definition is required since -\Package{scrpage2} uses another way to deal with automatic and manual -headings. This way is more flexible and allows configurations usually -difficult to implement for unexperienced users. The required commands to work -with the \Package{scrpage2} implementation are introduced at the end of -\autoref{sec:scrpage.basics.buildIn} and the begin of +The original \PValue{headings} page style of the document class is +available as \PValue{useheadings}. This re-definition is required +since \Package{scrpage2} uses a different way to deal with automatic +and manual headings. This way is more flexible and allows +configurations which would usually prove difficult to implement for +inexperienced users. The required commands to work with the +\Package{scrpage2} implementation are introduced at the end of +\autoref{sec:scrpage.basics.buildIn} and the beginning of \autoref{sec:scrpage.basics.mark}. \subsection{Predefined Page Styles}\label{sec:scrpage.basics.buildIn} @@ -129,57 +128,57 @@ with the \Package{scrpage2} implementation are introduced at the end of \PValue{scrplain} \end{Declaration}% \BeginIndex{Pagestyle}{scrheadings}\BeginIndex{Pagestyle}{scrplain}% -\Index{page style}% +\Index{page>style}% % -Package \Package{scrpage2} delivers an own pagestyle, named -\PValue{scrheadings}. -The command \Macro{pagestyle}\PParameter{scrheadings} activates -this page style, likewise -after activation an appropriate \PValue{plain} pagestyle -is available. -In this case \emph{appropriate} meens that the \PValue{plain} -page style is also configureable by the commands introduced in -\autoref{sec:scrpage.basics.format}, which, for example, -configure the head and foot width. -Neither the activation of \PValue{scrheadings} nor \PValue{scrplain} -influences the mode of manual or automatic headings, -see \autoref{sec:scrpage.basics.mark}. +Package \Package{scrpage2} delivers its own page style, named +\PValue{scrheadings}, which can be activated with the +\Macro{pagestyle}\PParameter{scrheadings}. When this page style is in +use, an appropriate \PValue{scrplain} page style is used for the +\PValue{plain} page style. In this case \emph{appropriate} means that +this new \PValue{plain} page style is also configureable by the +commands introduced in \autoref{sec:scrpage.basics.format}, which, for +example, configure the header and footer width. Neither the +activation of \PValue{scrheadings} nor the attendant change to the +\PValue{plain} page style influences the mode of manual or automatic +headings (see \autoref{sec:scrpage.basics.mark}). The +\PValue{scrplain} page style can also be activated directly with +\Macro{pagestyle}. \begin{Declaration} \Macro{lehead}% \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}\\ \Macro{cehead}% - \OParameter{scrplain-concentric-even}\Parameter{scrheadings-concentric-even}\\ + \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}\\ \Macro{rehead}% \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}\\ \Macro{lefoot}% \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}\\ \Macro{cefoot}% - \OParameter{scrplain-concentric-even}\Parameter{scrheadings-concentric-even}\\ + \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}\\ \Macro{refoot}% \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}\\ \Macro{lohead}% \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}\\ \Macro{cohead}% - \OParameter{scrplain-concentric-odd}\Parameter{scrheadings-concentric-odd}\\ + \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}\\ \Macro{rohead}% \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}\\ \Macro{lofoot}% \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}\\ \Macro{cofoot}% - \OParameter{scrplain-concentric-odd}\Parameter{scrheadings-concentric-odd}\\ + \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}\\ \Macro{rofoot}% \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}\\ \Macro{ihead}% \OParameter{scrplain-inside}\Parameter{scrheadings-inside}\\ \Macro{chead}% - \OParameter{scrplain-concentric}\Parameter{scrheadings-concentric}\\ + \OParameter{scrplain-centered}\Parameter{scrheadings-centered}\\ \Macro{ohead}% \OParameter{scrplain-outside}\Parameter{scrheadings-outside}\\ \Macro{ifoot}% \OParameter{scrplain-inside}\Parameter{scrheadings-inside}\\ \Macro{cfoot}% - \OParameter{scrplain-concentric}\Parameter{scrheadings-concentric}\\ + \OParameter{scrplain-centered}\Parameter{scrheadings-centered}\\ \Macro{ofoot}% \OParameter{scrplain-outside}\Parameter{scrheadings-outside} \end{Declaration}% @@ -190,11 +189,10 @@ see \autoref{sec:scrpage.basics.mark}. \BeginIndex{Cmd}{ifoot}\BeginIndex{Cmd}{cfoot}\BeginIndex{Cmd}{rfoot}% \BeginIndex{Cmd}{lofoot}\BeginIndex{Cmd}{cofoot}\BeginIndex{Cmd}{rofoot}% % -The page styles include three boxes either in head and foot. -The commands modifying the content of these boxes can be seen -in \autoref{fig:scrpage.leheadetall}. -Commands in the middle column modify the boxes content on both the odd -and even pages. +The page styles include three boxes in both the header and the footer. +The commands modifying the content of these boxes can be seen in +\autoref{fig:scrpage.leheadetall}. Commands in the middle column +modify the box contents on both odd and even pages. \begin{figure} \centering @@ -254,38 +252,39 @@ and even pages. \put(80,11){\makebox(0,0)[t]{\Macro{cofoot}}} \put(95,11){\makebox(0,0)[t]{\Macro{rofoot}}} \end{picture} - \caption[Commands for modification of - \Package{scrpage2}-pagestyles elements]% - {Commands for modification of pagestyles \PValue{scrheadings} and - \PValue{scrplain} and their association to head and foot elements} + \caption[Commands for modification of \Package{scrpage2} page styles + elements]% + {Commands for modification of page styles \PValue{scrheadings} and + \PValue{scrplain} and their relationship to header and footer + elements} \label{fig:scrpage.leheadetall} \end{figure} \begin{Example} If one wants the page number be placed in the middle of the -foot, then following can be used: +footer, then following can be used: \begin{lstlisting} \cfoot{\pagemark} \end{lstlisting} -The next example shows how to place both running head and -page number in the head; the running head inside and the page number -outside. +The next example shows how to place both running heading and page +number in the header; the running heading inside and the page number +outside: \begin{lstlisting} \ohead{\pagemark} \ihead{\headmark} \cfoot{} \end{lstlisting} -The command \Macro{cfoot}\PParameter{} is only required in order -to empty the item in middle of the foot, -which normally contains the page number. +The command \Macro{cfoot}\PParameter{} is only required in order to +empty the item in the middle of the footer, which normally contains +the page number. \end{Example} -Using the commands which are associated with only one item -allows more advanced settings. +The commands which are associated with only one item can be used for +more advanced settings. \begin{Example} -Assuming one has the order to write an annual report for his -company, he could use commands like this: +Assuming one has the order to write an annual report for one's +company, one could use commands like this: \begin{lstlisting} \ohead{\pagemark} \rehead{Annual Report 2001} @@ -293,26 +292,27 @@ company, he could use commands like this: \cefoot{TheCompanyName Inc.} \cofoot{Department: Development} \end{lstlisting} -In order to keep in sync the data in the foot with the content -of the document, the foot has to be updated using \Macro{cofoot} +In order to keep the data in the footer synchronized with the content +of the document, the footer has to be updated using \Macro{cofoot} when a new department is discussed in the report. \end{Example} -As mentioned above, there is an \PValue{plain}-pagestyle which corresponds to -\PValue{scrheadings}. Since it should also be possible to adapt this style, -the commands support an optional argument. Thus the contents of the -appropriate field of the \PValue{plain}-pagestyle can be modified. +As mentioned above, there is a new \PValue{plain} page style which +corresponds to \PValue{scrheadings}. Since it should also be possible +to customize this style, the commands support an optional argument +with which the contents of the appropriate fields of this +\PValue{plain} page style can be modified. \begin{Example} -The position of the page number for the pagestyle \PValue{scrheadings} +The position of the page number for the page style \PValue{scrheadings} can be declared as follows: \begin{lstlisting} \cfoot[\pagemark]{} \ohead[]{\pagemark} \end{lstlisting} -When now the command \Macro{chapter}, after it has started a new page, -switches to the \PValue{plain}-pagestyle, then the page number -is centered in the foot. +When the command \Macro{chapter}, after it has started a new page, now +switches to the \PValue{plain} page style, then the page number is +centered in the footer. \end{Example} % \EndIndex{Pagestyle}{scrheadings}\EndIndex{Pagestyle}{scrplain}% @@ -325,30 +325,29 @@ is centered in the foot. \BeginIndex{Cmd}{clearscrheadings}% \BeginIndex{Cmd}{clearscrplain}% \BeginIndex{Cmd}{clearscrheadfoot}% -If one wants to redefine both the page style \PValue{scrheadings} -and the \PValue{plain} page style, frequently one must delete -some already occupied page items. Since one fills all items -rarely with new contents, in most cases several -instruction with empty parameters are necessary. -With the help of these three instructions the deletion is fast and -thoroughly possible. -While \Macro{clearscrheadings} only deletes all fields of the -page style \PValue{scrheadings} and \Macro{clearscrplain} deletes -all fields of the appropriate \PValue{plain} page style, -\Macro{clearscrheadfoot} sets all fields of both page styles on -empty contents. +If one wants to redefine both the page style \PValue{scrheadings} and +the corresponding \PValue{plain} page style, frequently one must empty +some already occupied page elements. Since one rarely fills all items +with new content, in most cases several instructions with empty +parameters are necessary. With the help of these three instructions +the quick and thorough deletion is possible. While +\Macro{clearscrheadings} only deletes all fields of the page style +\PValue{scrheadings}, and \Macro{clearscrplain} deletes all fields of +the corresponding \PValue{plain} page style, \Macro{clearscrheadfoot} +sets all fields of both page styles to empty. \begin{Example} - If one wants to reset the page style to the default \KOMAScript{} settings, - independent from the actual configuration, only these three commands are - sufficient. + If one wants to reset the page style to the default {\KOMAScript} + settings, independent of the actual configuration, only these three + commands are sufficient: \begin{lstlisting} \clearscrheadfoot \ohead{\headmark} \ofoot[\pagemark]{\pagemark} \end{lstlisting} - Without the commands \Macro{clearscrheadfoot}, \Macro{clearscrheadings} and - \Macro{clearscrplain} 6 commands with 9 empty arguments are required. +Without the commands \Macro{clearscrheadfoot}, +\Macro{clearscrheadings} and \Macro{clearscrplain}, 6 commands with 9 +empty arguments would be required: \begin{lstlisting} \ihead[]{} \chead[]{} @@ -357,8 +356,8 @@ empty contents. \cfoot[]{} \ofoot[\pagemark]{\pagemark} \end{lstlisting} - Of course, assuming a special configuration some of them can - be dropped.% +Of course, for a specific configuration, some of them could be +dropped.% \end{Example}% % \EndIndex{Cmd}{clearscrheadings}% @@ -372,22 +371,21 @@ empty contents. \EndIndex{Cmd}{ifoot}\EndIndex{Cmd}{cfoot}\EndIndex{Cmd}{rfoot}% \EndIndex{Cmd}{lofoot}\EndIndex{Cmd}{cofoot}\EndIndex{Cmd}{rofoot}% -In previous examples two commands already have been used, which -haven't been introduced yet. Now, the description of these -commands shall follow. +In the previous examples two commands were used which have not been +introduced yet. The description of these commands follows. \begin{Declaration} \Macro{leftmark}\\ \Macro{rightmark} \end{Declaration}% \BeginIndex{Cmd}{leftmark}\BeginIndex{Cmd}{rightmark}% -These two instructions make it possible to access the running headlines, -which are normally meant for the left or for the right page. These two -instruction are not made available by scrpage or scrpage2, but directly -by the \LaTeX{} kernel. If in this section running headline of the -left side or the right page are mentioned, -then the contents of \Macro{leftmark} or \Macro{rightmark} -is meant. +These two instructions make it possible to access the running +headings, which are normally meant for the left or for the right +page. These two instruction are not made available by +\Package{scrpage2}, but directly by the {\LaTeX} kernel. When in this +section running headings of the left page or the right page are +mentioned, this refers to the contents of \Macro{leftmark} or +\Macro{rightmark}, respectively. % \EndIndex{Cmd}{leftmark}\EndIndex{Cmd}{rightmark}% @@ -395,9 +393,9 @@ is meant. \begin{Declaration} \Macro{headmark} \end{Declaration}% -This command gives access to the content of running heads. -In contrast to \Macro{leftmark} and \Macro{rightmark}, one -need not regard the proper assignment to left or right page. +This command gives access to the content of running headings. In +contrast to \Macro{leftmark} and \Macro{rightmark}, one need not +regard the proper assignment to left or right page. \EndIndex{Cmd}{headmark} \BeginIndex{Cmd}{pagemark} @@ -405,10 +403,11 @@ need not regard the proper assignment to left or right page. \Macro{pagemark} \end{Declaration}% This command returns the formatted page number. The formatting can be -controlled by \Macro{pnumfont} introduced in -\autoref{sec:scrpage.basics.format}, \autopageref{desc:scrpage.macro.pnumfont} -or by \Macro{setkomafont} if a newer version \KOMAScript{} is used, see -\autoref{sec:maincls.font}. +controlled by \Macro{pnumfont}, introduced in +\autoref{sec:scrpage.basics.format}, +\autopageref{desc:scrpage.macro.pnumfont}, which \Macro{pagemark} +heeds automatically. Alternatively, \Macro{setkomafont} can be used if +a {\KOMAScript} class is used (see \autoref{sec:maincls.font}). % the last describtion \setkomafont ... is only fill-text \EndIndex{Cmd}{pagemark} @@ -417,121 +416,119 @@ or by \Macro{setkomafont} if a newer version \KOMAScript{} is used, see \Option{useheadings} \end{Declaration}% \phantomsection\label{desc:scrpage.pagestyle.useheadings}% -The package \Package{scrpage2} is meant primarily for the fact that the -supplied styles are used or own styles are defined. However it can be -necessary to shift back also to the style provided by the document class. It -would be obvious to do this with \Macro{pagestyle}\PParameter{headings}, but -this has however the disadvantage that commands \Macro{automark} and -\Macro{manualmark} discussed in the following do not function as expected. -For this reason one should shift back to the original styles using -\Macro{pagestyle}\PParameter{useheadings}. Such a switching has then no -effect on it whether one operates with manual or automatic running headlines. +The package \Package{scrpage2} is meant primarily for use of the +supplied styles or for defining one's own styles. However, it may be +necessary to shift back also to a style provided by the document +class. It might appear that this should be done with \Macro{page + style}\PParameter{headings}, but this has the disadvantage that +commands \Macro{automark} and \Macro{manualmark}, to be discussed +shortly, do not function as expected. For this reason one should +shift back to the original styles using \Macro{page + style}\PParameter{useheadings}, which chooses the correct page +styles automatically for both manual and automatic running headings. % \EndIndex{Cmd}{pagestyle}\EndIndex{Pagestyle}{useheadings} -\subsection{Manual and Automatic Headings} +\subsection{Manual and Running Headings} \label{sec:scrpage.basics.mark} % \automark \manualmark % -Usually there is a \emph{my}-version of the \PValue{headings}-style. If such -a style is active, then the running headlines are updated no longer -automatically. With \Package{scrpage2} another path is taken. Whether the -running headlines are living or not, determines the instructions -\Macro{automark} and \Macro{manualmark}. The default can be also already -influenced while the loading of the package with the options \Option{automark} -and \Option{manualmark}, see \autoref{sec:scrpage.basics.options}, -\autopageref{desc:scrpage.option.automark}. +Usually there is a \emph{my}-version of the \PValue{headings} +page style. If such a page style is active, then the running headings +are no longer updated no longer automatically and become manual +headings. With \Package{scrpage2} a different path is taken. Whether +the headings are running or manual is determined by the instructions +\Macro{automark} and \Macro{manualmark}, respectively. The default +can be set already while loading of the package, with the options +\Option{automark} and \Option{manualmark} (see +\autoref{sec:scrpage.basics.options}, +\autopageref{desc:scrpage.option.automark}). \BeginIndex{Cmd}{manualmark} \begin{Declaration} \Macro{manualmark} \end{Declaration}% -As the name already clarifies, \Macro{manualmark} switches off the updating -of the running headlines. It is left to the user to provide for -updating or for contents of the running headlines. -For that purpose the instructions \Macro{markboth}\IndexCmd{markboth} -und \Macro{markright}\IndexCmd{markright} are available. +As the name suggests, \Macro{manualmark} switches off the updating of +the running headings and makes them manual. It is left to the user to +update and provide contents for the headings. For that purpose the +instructions \Macro{markboth}\IndexCmd{markboth} and +\Macro{markright}\IndexCmd{markright} are available. \EndIndex{Cmd}{manualmark} \BeginIndex{Cmd}{automark} \begin{Declaration} \Macro{automark}\OParameter{right page}\Parameter{left page} \end{Declaration}% -The macro \Macro{automark} however activates the automatic updating. -For the two parameters the designations of the document level -are to be used, whose title in appropriate place is to appear. -Valid values for the parameters are: +The macro \Macro{automark} activates the automatic updating, that is, +running headings. For the two parameters the designations of the +document sectioning level whose title is to appear in appropriate +place are to be used. Valid values for the parameters are: \PValue{part}\ChangedAt{2.2}{\Package{scrpage2}}, \PValue{chapter}, \PValue{section}, \PValue{subsection}, \PValue{subsubsection}, -\PValue{paragraph}, \PValue{subparagraph}. -For most of the classes usage of \PValue{part} will not produce -the expected results. So far only \KOMAScript\ classes from version~2.9s -up are known to support this value. - -The optional argument \PName{right page} is meant understandably only for -two-sided documents. -In the one-sided case you should normally not use it. -With the help of the option \Option{autooneside} one can also adjust -that the optional argument in one-sided mode is ignored automatically, -see \autoref{sec:scrpage.basics.options}, -\autopageref{desc:scrpage.option.autooneside}. +\PValue{paragraph}, and \PValue{subparagraph}. For most of the +classes use of \PValue{part} will not produce the expected result. So +far only {\KOMAScript} classes from version~2.9s up are known to +support this value. + +The optional argument \PName{right page} is understandably meant only +for two-sided documents. In the one-sided case one should normally not +use it. With the help of the option \Option{autooneside} one can also +set that the optional argument in one-sided mode is ignored +automatically (see \autoref{sec:scrpage.basics.options}, +\autopageref{desc:scrpage.option.autooneside}). % \begin{Example} -Assuming that the document uses a \emph{book} class, -which topmost section level is \emph{chapter}, -then after a preceding \Macro{manualmark} + Assuming that the document uses a \emph{book} class, whose topmost + section level is \emph{chapter}, then after a preceding + \Macro{manualmark} \begin{lstlisting} \automark[section]{chapter} \end{lstlisting} -restores the original behaviour. -If one prefers one of the lower section levels in running head -following can be used. +restores the original behaviour. If one prefers lower section levels +in running headings, the following can be used: \begin{lstlisting} \automark[subsection]{section} \end{lstlisting} How useful the last declaration is, everybody has to decide -for oneself. +for themselves. \end{Example} \begin{Explain} -The data of the headings is set by the command -\Macro{markboth}\IndexCmd{markboth} for the top-most -section levels, for the lower levels -\Macro{markright}\IndexCmd{markright} or -\Macro{markleft}\IndexCmd{markleft} are used. -These commands are called indirectly by the sectioning commands. -The macro \Macro{markleft} is provided by the package -\Package{scrpage2}. -Its definition is similar to \Macro{markright} originating from -the \LaTeX{} kernel. -Although \Macro{markleft} is not defined as an internal command, -the direct use is not recommended. + For the upper section level, the data of the headings is set by the + command \Macro{markboth}\IndexCmd{markboth}, while that for the + lower section level by \Macro{markright}\IndexCmd{markright} or + \Macro{markleft}\IndexCmd{markleft}. These commands are called + indirectly by the sectioning commands. The macro \Macro{markleft} + is provided by the package \Package{scrpage2} and is defined + similarly to \Macro{markright} in the {\LaTeX} kernel. Although + \Macro{markleft} is not defined as an internal command, the direct + use is not recommended. \end{Explain} \EndIndex{Cmd}{automark} -\subsection{Formatting of Heading and Footing} +\subsection{Formatting of Header and Footer} \label{sec:scrpage.basics.format} % \headfont \pnumfont % \setheadwidth \setfootwidth % \set(head|foot)(top|sep|bot)line -In the previous paragraph it concerned mainly contentwise things. Is -not sufficient naturally, in order to satisfy the formative -ambitions. Therefore it is to turn in this paragraph exclusive therefore. +The previous section concerned itself mainly with the contents of the +header and footer. This is of course not sufficient to satisfy +formative ambitions. Therefore we devote this section exclusively to +this topic. % \BeginIndex{Cmd}{headfont}\BeginIndex{Cmd}{pnumfont} \begin{Declaration} \Macro{headfont}\\ \Macro{pnumfont} \end{Declaration}% -The command \Macro{headfont} contains the commands -which determine the formatting of head and foot lines. -The style of the page number defines the command -\Macro{pnumfont}. +The command \Macro{headfont} contains the commands which determine the +font of header and footer lines. The style of the page number is +defined by the command \Macro{pnumfont}. \begin{Example} -If, for example, one wants the head and foot to be typeset in bold -sans-serif and the page number in a slanted style, then it can be -used the configuration: + If, for example, one wants the header and footer to be typeset in + bold sans serif, and the page number in a slanted serif style, then + one can use the following definitions: \begin{lstlisting} \renewcommand{\headfont}{\normalfont\sffamily\bfseries} \renewcommand{\pnumfont}{\normalfont\rmfamily\slshape} @@ -539,15 +536,15 @@ used the configuration: \end{Example} \EndIndex{Cmd}{headfont}\EndIndex{Cmd}{pnumfont} % -Since version 2.8p of the \KOMAScript{} classes a new -configuration scheme is implemented. -If \Package{scrpage2} is used together with these classes then -it is recommended to setup font attributes the way described -in \autoref{sec:maincls.font}. +From version 2.8p of the {\KOMAScript} classes a new unified user +interface scheme is implemented for font attributes. If +\Package{scrpage2} is used together with one of these classes, then it +is recommended to set up font attributes in the manner described in +\autoref{sec:maincls.font}. \begin{Example} -This interfaces implements the command \Macro{setkomafont} -in order to configure the font attributes. -The previous definition can then be written as: + Instead of \Macro{renewcommand} the command \Macro{setkomafont} + should be used to configure the font attributes. The previous + definitions can then be written as: \begin{lstlisting} \setkomafont{pagehead}\normalfont\sffamily\bfseries} \setkomafont{pagenumber}{\normalfont\rmfamily\slshape} @@ -559,14 +556,13 @@ The previous definition can then be written as: \Macro{setheadwidth}\OParameter{shift}\Parameter{width}\\ \Macro{setfootwidth}\OParameter{shift}\Parameter{width} \end{Declaration}% -Normally the widths of heading and footing line -correspond to the width of the text body. -The commands \Macro{setheadwidth} and \Macro{setfootwidth} enable the -user to adapt in a simple manner the widths to his needs. -The mandatory argument \PName{width} takes up the value for the width -of the page head or foot, -\PName{shift} is a longitudinal dimension for the shift of the -appropriate item toward the outside page edge. +Normally the widths of header and footer lines correspond to the width +of the text body. The commands \Macro{setheadwidth} and +\Macro{setfootwidth} enable the user to adapt in a simple manner the +widths to his needs. The mandatory argument \PName{width} takes the +value of the desired width of the page header or footer, while +\PName{shift} is a length parameter by which amount the appropriate +item is shifted toward the outside page edge. For the most common situations the mandatory argument \PName{width} accepts the following symbolic values: @@ -574,24 +570,25 @@ accepts the following symbolic values: \item[\PValue{paper}] the width of the paper \item[\PValue{page}] the width of the page \item[\PValue{text}] the width of the text body -\item[\PValue{textwithmarginpar}] the width of the text body including margin. -\item[\PValue{head}] the current head width -\item[\PValue{foot}] the current foot width +\item[\PValue{textwithmarginpar}] the width of the text body including margin +\item[\PValue{head}] the current header width +\item[\PValue{foot}] the current footer width \end{labeling} -The difference between \PValue{paper} and \PValue{page} is, that -\PValue{page} means the width of the paper less the binding correction. -This only applies if the package \Package{typearea}\IndexPackage{typearea} -is used (see \autoref{cha:typearea}). -Without \Package{typearea} both values are equal. +The difference between \PValue{paper} and \PValue{page} is that +\PValue{page} means the width of the paper less the binding correction +if the package \Package{typearea}\IndexPackage{typearea} is used (see +\autoref{cha:typearea}). Without \Package{typearea} both values are +identical. \begin{Example} -The layout of the \emph{\LaTeX\,Companion}, the head-line projects -into the margin, can be obtained with: + Assume that one wants a layout like that of \emph{The + {\LaTeX}\,Companion}, where the header projects into the + margin. This can be obtained with: \begin{lstlisting} \setheadwidth[0pt]{textwithmarginpar} \end{lstlisting} % -and looks on an odd page like this: +which appears like this on an odd page: % \begin{XmpTopPage} \XmpHeading{10,25}{85} @@ -600,33 +597,33 @@ and looks on an odd page like this: \XmpMarginNote{83,11.8} \end{XmpTopPage} % -If the foot-line shall have the same width and alignment, then -two ways are possible. The first simply repeats the settings -for the foot-line: +If the footer line should have the same width and alignment, then two +ways to set this up are possible. The first way simply repeats the +settings for the case of the footer line: \begin{lstlisting} \setfootwidth[0pt]{textwithmarginpar} \end{lstlisting} % In the second way the symbolic value \PValue{head} is used, since the -head has already the desired settings. +header already has the desired settings. \begin{lstlisting} \setfootwidth[0pt]{head} \end{lstlisting} \end{Example} -If no \PName{shift} is indicated, -i.e. without the optional argument, then -the heading or the foot appears symmetrically on the page arranged. -A value for the \PName{shift} is determined automatically, which -corresponds to the current page shape. +If no \PName{shift} is indicated, i.\,e., without the optional argument, +then the header or footer appears arranged symmetrically on the page. +In other words, a value for the \PName{shift} is determined +automatically to correspond to the current page shape. % \begin{Example} -According to the previous example the optional argument is abandoned: + Continuing with the previous example, we remove the optional + argument: \begin{lstlisting} \setheadwidth{textwithmarginpar} \end{lstlisting} % -and looks on an odd page like this: +which appears like this on an odd page: % \begin{XmpTopPage} \XmpHeading{5,25}{85} @@ -636,10 +633,9 @@ and looks on an odd page like this: \end{XmpTopPage} \end{Example} -As to be seen, the heading is now shifted inward, while the -heading width has not changed. -The shift is calculated in a way that the configuration of the typearea -become visible also here. +As can be seen, the header is now shifted inward, while the header +width has not changed. The shift is calculated in a way that the +configuration of the typearea become visible also here. % \EndIndex{Cmd}{setheadwidth}\EndIndex{Cmd}{setfootwidth} @@ -651,66 +647,66 @@ become visible also here. \Macro{setfootsepline}\OParameter{length}\Parameter{thickness}\OParameter{commands}\\ \Macro{setfootbotline}\OParameter{length}\Parameter{thickness}\OParameter{commands} \end{Declaration}% -According to the configuration of head and foot there are -commands to modify the lines above and below the head and foot. +Corresponding to the size configuration parameters of header and +footer there are commands to modify the lines above and below the +header and footer. \begin{labeling}[\,--]{\Macro{setfootsepline}} -\item[\Macro{setheadtopline}] configures the line above the head -\item[\Macro{setheadsepline}] configures the line below the head -\item[\Macro{setfootsepline}] configures the line above the foot -\item[\Macro{setfootbotline}] configures the line below the foot +\item[\Macro{setheadtopline}] configures the line above the header +\item[\Macro{setheadsepline}] configures the line below the header +\item[\Macro{setfootsepline}] configures the line above the footer +\item[\Macro{setfootbotline}] configures the line below the footer \end{labeling} -The mandatory argument \PName{thickness} determines, -how strongly the line is drawn. -The optional argument \PName{length} accepts the same symbolic values as -\PName{width} with \Macro{setheadwidth}, as also a normal length expression. -As long as in the document \PName{length} value was not assigned to the -optional argument, the appropriate line length adapts automatically -the width of the heading or the foot. - -Use \PValue{auto} in the length argument to restore this -automatism for the length of a line. - -The\ChangedAt{2.2}{\Package{scrpage2}} -optional argument \PName{commands} may be used to specify additional commands -to be executed before the respective line is drawn. -For example such commands could be used for changing the +The mandatory argument \PName{thickness} determines how strongly the +line is drawn. The optional argument \PName{length} accepts the same +symbolic values as \PName{width} for \Macro{setheadwidth}, as well as +also a normal length expression. As long as the optional argument +\PName{length} is not assigned a value, the appropriate line length +adapts automatically the width of the header or the footer. + +Use \PValue{auto} in the length argument to restore this automation +for the length of a line. + +The\ChangedAt{2.2}{\Package{scrpage2}} optional argument +\PName{commands} may be used to specify additional commands to be +executed before the respective line is drawn. For example, such +commands could be used for changing the color\Index{header>color}\Index{footer>color}\Index{color>in - header}\Index{color>in footer} of that line. -When using a \KOMAScript\ class you could also use -\Macro{setkomafont}\IndexCmd{setkomafont} to specify commands -for one of the elements + header}\Index{color>in footer} of the line. When using a +{\KOMAScript} class you could also use +\Macro{setkomafont}\IndexCmd{setkomafont} to specify commands for one +of the elements \FontElement{headtopline}\IndexFontElement{headtopline}, \FontElement{headsepline}\IndexFontElement{headsepline}, \FontElement{footsepline}\IndexFontElement{footsepline}, -\FontElement{footbottomline}\IndexFontElement{footbottomline}, -\FontElement{footbotline}\IndexFontElement{footbotline}. -These could be extended by adding \Macro{addtokomafont}\IndexCmd{addtokomafont}. -See \autoref{sec:maincls.font} for details on the \Macro{setkomafont} and -\Macro{addkomafont} commands. +\FontElement{footbottomline}\IndexFontElement{footbottomline}, or +\FontElement{footbotline}\IndexFontElement{footbotline}. These can +then be extended via \Macro{addtokomafont}\IndexCmd{addtokomafont}. +See \autoref{sec:maincls.font} for details on the \Macro{setkomafont} +and \Macro{addkomafont} commands. \begin{Declaration} \XMacro{setheadtopline}\OParameter{\upshape\PValue{auto}}\Parameter{\upshape\PValue{current}}\\ \XMacro{setheadtopline}\OParameter{\upshape\PValue{auto}}\Parameter{}\\ \XMacro{setheadtopline}\OParameter{\upshape\PValue{auto}}\Parameter{}\OParameter{} \end{Declaration}% -The arguments shown here for the command \Macro{setheadtopline}, -are of course valid for the other three configuration commands, too. +The arguments shown here for the command \Macro{setheadtopline} are of +course valid for the other three configuration commands too. If the mandatory parameter has the value \PValue{current} or has been -left empty then the line height is not changed. -This may be used to modify the length of the line without changing its height. +left empty, then the line thickness is not changed. This may be used +to modify the length of the line without changing its thickness. -\PName{commands} is an optional argument, if omitted all command setting -will remain active that might have been specified before, while using -an empty \PName{commands} argument will revoke any previously valid -commands. +If the optional argument \PName{commands} is omitted, then all command +settings that might have been specified before will remain active, +while an empty \PName{commands} argument will revoke any previously +valid commands. \begin{Example} -If the head for example is to be contrasted by a strong line of 2\,pt -above and a normal line of 0.4\,pt between head and body, it can be -achieved with: + If the header, for example, is to be contrasted by a strong line of + 2\,pt above and a normal line of 0.4\,pt between header and body, + one can achieve this with: \begin{lstlisting} \setheadtopline{2pt} \setheadsepline{.4pt} @@ -724,19 +720,19 @@ achieved with: \XmpMarginNote{83,11.8} \end{XmpTopPage} -To specify that this line is to be drawn also e.\,g. in red color you +To specify that this line is to be drawn also, e.\,g., in red color, you would change the commands like this: \begin{lstlisting} \setheadtopline{2pt}[\color{red}] \setheadsepline{.4pt}[\color{red}] \end{lstlisting} -In this sample as well as in the following one line color is activated -by applying the syntax of the \Package{color}\IndexPackage{color} package, -so this package must be loaded of course. Since \Package{scrpage2} comes -without built-in color handling any package providing color support -may be used. +In this example, as well as in the following one, line color is +activated by applying the syntax of the +\Package{color}\IndexPackage{color} package, so this package must of +course be loaded. Since \Package{scrpage2} comes without built-in +color handling, any package providing color support may be used. -\KOMAScript\ classes also support the following way of color specification: +{\KOMAScript} classes also support the following way of color specification: \begin{lstlisting} \setheadtopline{2pt} \setheadsepline{.4pt} @@ -744,7 +740,7 @@ may be used. \setkomafont{headsepline}[\color{red}] \end{lstlisting} -The automatic adjustment of the head and foot width is illustrated +The automatic adjustment to the header and footer width is illustrated in the following example: \begin{lstlisting} \setfootbotline{2pt} @@ -763,11 +759,11 @@ in the following example: \end{XmpBotPage} \end{Example} -Now not everybody will like the alignment of the line above -the foot, instead one will expect the line left-aligned. -This can only be achieved with a global package option, which -will be described together with other package option -in the next \autoref{sec:scrpage.basics.options}. +Now not everyone will like the alignment of the line above the footer; +instead, one would expect the line to be left-aligned. This can only +be achieved with a global package option, which will be described +together with other package options in the next +\autoref{sec:scrpage.basics.options}. \EndIndex{Cmd}{setheadtopline}\EndIndex{Cmd}{setheadsepline} \EndIndex{Cmd}{setfootseptline}\EndIndex{Cmd}{setfootbotline} @@ -786,15 +782,14 @@ in the next \autoref{sec:scrpage.basics.options}. \Option{footinclude}\\ \Option{footexclude} \end{Declaration}% -These options intend whether the page-header or that page-footing -are reckoned in with the page-body for the calculation of the type-area. -The adjustments necessary by the use of these parameters -are made by the package -\Package{typearea} (see \autoref{sec:typearea.options}), if this -package is loaded after \Package{scrpage2}. -Important is here that on use of a \KOMAScript{} class -these options must be indicated for the document class and not -for \Package{scrpage2}, in order to obtain an effect. +These options determine whether the page header or the page footer are +considered as part of the page body for the calculation of the type +area. The adjustments necessary by the use of these parameters are +made by the package \Package{typearea} (see +\autoref{sec:typearea.options}), if this package is loaded after +\Package{scrpage2}. Important here is that when using a {\KOMAScript} +class, these options must be given for the document class and not for +the package \Package{scrpage2}, in order to be effective. % \EndIndex{Option}{headinclude}\EndIndex{Option}{footinclude} \EndIndex{Option}{headexclude}\EndIndex{Option}{footexclude} @@ -804,40 +799,38 @@ for \Package{scrpage2}, in order to obtain an effect. \BeginIndex{Option}{footsepline}\BeginIndex{Option}{plainfootsepline} \BeginIndex{Option}{footbotline}\BeginIndex{Option}{plainfootbotline} \begin{Declaration} -\Option{headtopline} und \Option{plainheadtopline}\\ -\Option{headsepline} und \Option{plainheadsepline}\\ -\Option{footsepline} und \Option{plainfootsepline}\\ -\Option{footbotline} und \Option{plainfootbotline} +\Option{headtopline} and \Option{plainheadtopline}\\ +\Option{headsepline} and \Option{plainheadsepline}\\ +\Option{footsepline} and \Option{plainfootsepline}\\ +\Option{footbotline} and \Option{plainfootbotline} \end{Declaration}% -A basic adjustment for the lines under and over heading and footing -can be made with these options. -These adjustments are considered then as default to all -page styles defined with \Package{scrpage2}. -If one of these options is used, then a line thickness -is used by 0.4\,pt. - -Since there is an appropriate \PValue{plain}-style to the page style -\PValue{scrheadings}, with the \Option{plain\dots}-options also the -appropriate line of the plain style can be configured. -These \Option{plain}-options work however only, even if the -corresponding option without plain are activated. -Thus \Option{plainheadtopline} shows no effect without the +Basic adjustment of the lines under and over header and footer can be +made with these options. These adjustments are then considered the +default for all page styles defined with \Package{scrpage2}. If one +of these options is used, then a line thickness 0.4\,pt is set. + +Since there is a corresponding \PValue{plain} page style to the +page style \PValue{scrheadings}, the corresponding line in the plain +style can also be configured with the \Option{plain\dots} options. +These \Option{plain} options do however work only if the corresponding +options without \Option{plain} are activated. Thus, +\Option{plainheadtopline} shows no effect without the \Option{headtopline} option set. -With these options it is to be noted that the appropriate page part, -heading or footing, is reckoned in with the text-area -for the calculation of the type-area in case a line has been activated. -This means, if with \Option{headsepline} the separation-line -between heading and text is activated, then the packge \Package{typearea} -calculates the type-area in such a way that the page-header -is part of the text block automatically. - -The conditions for the options of the preceding paragraph, apply also to -this automatism. That means that the package \Package{typearea} -must be loaded to scrpage2, or that on use of a \KOMAScript{} class, -the options \Option{headinclude} and \Option{footinclude} -must be set explicitly with \Macro{documentclass} in order to -transfer heading or footing line in the text-area. +With these options, it is to be noted that the appropriate page part, +header or footer, is considered as a part of the text area for the +calculation of the type area in case a line has been activated. This +means that, if the separation line between header and text is +activated with \Option{headsepline}, then the package +\Package{typearea} calculates the type area in such a way that the +page header is part of the text block automatically. + +The conditions for the options of the preceding paragraph apply also +to this automation. That means that the package \Package{typearea} +must be loaded after \Package{scrpage2}, or that on use of a +{\KOMAScript} class, the options \Option{headinclude} and +\Option{footinclude} must be set explicitly with \Macro{documentclass} +in order to transfer header or footer line in the text area. % \EndIndex{Option}{headtopline}\EndIndex{Option}{plainheadtopline} \EndIndex{Option}{headsepline}\EndIndex{Option}{plainheadsepline} @@ -854,15 +847,14 @@ transfer heading or footing line in the text-area. \Option{olines} \end{Declaration}% % -The definition of the line lengths can lead to an -undesired adjustment, since -the line is centered in the heading or footing area. -With the package options presented here, this specification can be -modified for all page styles defined with \Package{scrpage2}. -The option \Option{ilines} sets the adjustment in such a -way that the lines align to the inside edge. -The option \Option{clines} behaves like the standard adjustment and -\Option{olines} aligns at the outside edge. +With the definition of the line lengths the case can arise where the +lengths are set correctly, but the justification is not as desired +because the line will be centered in the header or footer area. With +the package options presented here, this specification can be modified +for all page styles defined with \Package{scrpage2}. The option +\Option{ilines} sets the justification in such a way that the lines +align to the inside edge. The option \Option{clines} behaves like the +default justification, and \Option{olines} aligns at the outside edge. \begin{Example} The next example illustrates the influence of the @@ -875,8 +867,8 @@ The option \Option{clines} behaves like the standard adjustment and \setfootwidth[0pt]{textwithmarginpar} \end{lstlisting} - Only the use of the option \Option{ilines} leads to the different - result shown below: +The mere use of the option \Option{ilines} leads to the different +result shown below: \begin{XmpBotPage} \XmpHeading{10,18}{85} \thinlines\XmpRule{10,21}{70} @@ -884,8 +876,8 @@ The option \Option{clines} behaves like the standard adjustment and \XmpSetText[\XmpBotText]{10,33} \XmpMarginNote{83,24} \end{XmpBotPage} - In contrast to the default configuration the separation line - between text and foot is now left-aligned not centered.% +In contrast to the default configuration, the separation line between +text and footer is now left-aligned, not centered.% \end{Example}% \EndIndex{Option}{ilines}\EndIndex{Option}{clines}\EndIndex{Option}{olines}% @@ -896,51 +888,48 @@ The option \Option{clines} behaves like the standard adjustment and \Option{automark}\\ \Option{manualmark} \end{Declaration}% -These options set the adjustment at the beginning of the document -whether automatic updating of the running headlines takes place. -The option \Option{automark} switches the automatic updating on, -\Option{manualmark} deactivates it. -Without use of one of the two options the adjustment is preserved, -which was valid while the loading of the package. +These options set at the beginning of the document whether to use +running headings or manual ones. The option \Option{automark} +switches the automatic updating on, \Option{manualmark} deactivates +it. Without the use of one of the two options, the setting which was +valid when the package was loaded is preserved, . % \begin{Example} - One loads the package \Package{scrpage2} directly after the document class - \Class{scrreprt} without any package options. + You load the package \Package{scrpage2} directly after the document class + \Class{scrreprt} without any package options: \begin{lstlisting} \documentclass{scrreprt} \usepackage{scrpage2} \end{lstlisting} - Since the default page style of \Class{scrreprt} is \PValue{plain}, - this page style is also active yet. - Futhermore \PValue{plain} means manual headings. - If one now activates the page style \PValue{scrheadings} with +Since the default page style of \Class{scrreprt} is \PValue{plain}, +this page style is also now still active. Futhermore, \PValue{plain} +means manual headings. If one now activates the page style +\PValue{scrheadings} with \begin{lstlisting} \pagestyle{scrheadings} \end{lstlisting} - then the manual headings are always active. +then the manual headings are nevertheless still active. - If one uses the document class \Class{scrbook} instead, then after: +If you instead use the document class \Class{scrbook}, then after \begin{lstlisting} \documentclass{scrbook} \usepackage{scrpage2} \end{lstlisting} - the page style \PValue{headings} is active and the running headings - are updated automatically. - Switching to the page style \PValue{scrheadings} keeps this - setting present. - The marking-commands of \Class{scrbook} continue to be used. +the page style \PValue{headings} is active and the running headings are +updated automatically. Switching to the page style +\PValue{scrheadings} keeps this setting active. The marking commands +of \Class{scrbook} continue to be used. - However, the use of +However, the use of \begin{lstlisting} \usepackage[automark]{scrpage2} \end{lstlisting} - activates the automatic update of the running heading independent - from the used document class. - The option does not effect the used page style \PValue{plain} of - the class \Class{scrreprt}. - The headings are not visible until the page style has been changed to - \PValue{scrheadings}\IndexPagestyle{scrheadings}, - \PValue{useheadings} or another self-defined page style with headings.% +activates running headings independently of the used document class. +The option does not of course affect the used page style \PValue{plain} +of the class \Class{scrreprt}. The headings are not visible until the +page style is changed to +\PValue{scrheadings}\IndexPagestyle{scrheadings}, \PValue{useheadings} +or another user-defined page style with headings.% \end{Example}% \EndIndex{Option}{automark}\EndIndex{Option}{manualmark}% @@ -949,8 +938,8 @@ which was valid while the loading of the package. \Option{autooneside} \end{Declaration}% This option ensures that the optional parameter of -\Macro{automark}\IndexCmd{automark} will be ignored automatically -in one-side mode. See the explanation of the command +\Macro{automark}\IndexCmd{automark} will be ignored automatically in +one-sided mode. See also the explanation of the command \Macro{automark} in \autoref{sec:scrpage.basics.mark}, \autopageref{desc:scrpage.macro.automark}. \EndIndex{Option}{autooneside} @@ -960,17 +949,16 @@ in one-side mode. See the explanation of the command \Option{komastyle}\\ \Option{standardstyle} \end{Declaration}% -These options determine the kind of the pre-defined page style -\PValue{scrheadings}. -The option \Option{komastyle} takes up a configuration like -the \KOMAScript{} classes. -This is the default for \KOMAScript{} classes and can this way -also be set for other classes. - -A configuration expected from the standard classes can be -defined using option \Option{standardstyle}. -Automatically the option \Option{markuppercase} will be -activated, but only if option \Option{markusedcase} is not given. +These options determine the look of the predefined page style +\PValue{scrheadings}. The option \Option{komastyle} configures a look +like that of the {\KOMAScript} classes. This is the default for +{\KOMAScript} classes and can in this way also be set for other +classes. + +The option \Option{standardstyle} configures a page style as it is +expected by the standard classes. Furthermore, the option +\Option{markuppercase} will be activated automatically, but only if +option \Option{markusedcase} is not given. \EndIndex{Option}{komastyle}\EndIndex{Option}{standardstyle} \BeginIndex{Option}{markuppercase}\BeginIndex{Option}{markusedcase} @@ -978,48 +966,44 @@ activated, but only if option \Option{markusedcase} is not given. \Option{markuppercase}\\ \Option{markusedcase} \end{Declaration}% -The package \Package{scrpage2} has -to modify internal commands, which are used by document structuring -commands, in order to get the function of \Macro{automark} working. -Since some classes, in contrast to the \KOMAScript{} classes, -write the headings in uppercase letters, \Package{scrpage2} -has to know how the used document class represents the headings. - -Option \Option{markuppercase} shows \Package{scrpage2} that -the document class uses uppercase letters. -If the document class does not represent the headings in -uppercase letters the option \Option{markusedcase} should -be given. -These options are not suitable to force a representation, thus -unexpected effects may occur, if the given option does not match -the behaviour of the document class. +In order to achieve the functionality of \Macro{automark}, the package +\Package{scrpage2} modifies internal commands which are used by the +document structuring commands to set the running headings. Since some +classes, in contrast to the {\KOMAScript} classes, write the headings +in uppercase letters, \Package{scrpage2} has to know how the used +document class sets the headings. + +Option \Option{markuppercase} shows \Package{scrpage2} that the +document class uses uppercase letters. If the document class does not +set the headings in uppercase letters, then the option +\Option{markusedcase} should be given. These options are not suitable +to force a representation; thus, unexpected effects may occur if the +given option does not match the actual behaviour of the document +class. \EndIndex{Option}{markuppercase}\EndIndex{Option}{markusedcase} \begin{Declaration} \Option{nouppercase} \end{Declaration}% \BeginIndex{Option}{nouppercase}% -In the previous paragraph about \Option{markuppercase} and -\Option{markusedcase} it has been already stated that some -document classes represent the running headings\Index{heading} in -uppercase letters using the commands -\Macro{MakeUppercase} or \Macro{uppercase}. -Setting the option \Option{nouppercase} allows to disable these -both commands. -The option \Option{nouppercase} only is valid as long page styles -defined by \Package{scrpage2} are used, including -\PValue{scrheadings} and its appropriate \PValue{plain} page style. - -The applicated method is very brutal and can cause that desired -changes of normal letters to uppercase letters -\Index{uppercase letters} do not occur. -Since these cases appear not frequently the option \Option{nouppercase} -is a useful solution. +In the previous paragraph dealing with \Option{markuppercase} and +\Option{markusedcase}, it has been already stated that some document +classes set the running headings\Index{heading} in uppercase letters +using the commands \Macro{MakeUppercase} or \Macro{uppercase}. +Setting the option \Option{nouppercase} allows disabling both these +commands in the headers and footers. However, this is valid only for +page styles defined by \Package{scrpage2}, including +\PValue{scrheadings} and its corresponding \PValue{plain} page style. + +The applied method is very brutal and can cause that desired changes +of normal letters to uppercase letters \Index{uppercase letters} do +not occur. Since these cases do not occur frequently, the option +\Option{nouppercase} usually affords a useful solution. \begin{Example} -If a document uses the standard class \Class{book}\IndexClass{book}, -but the uppercase headings are not desired, then the preamble of -the document could start with: + Your document uses the standard class \Class{book}\IndexClass{book}, + but you do not want the uppercase headings but mixed case + headings. Then the preamble of your document could start with: \begin{lstlisting} \documentclass{book} \usepackage[nouppercase]{scrpage2} @@ -1033,7 +1017,7 @@ the document could start with: In some cases not only classes but also packages set the running headings in uppercase letters. Also in these cases the option \Option{nouppercase} should be able -to switch back to the normal non-uppercase headings. +to switch back to the normal mixed case headings. \EndIndex{Option}{nouppercase} \section{Defining Own Page Styles}\label{sec:scrpage.UI} @@ -1041,62 +1025,62 @@ to switch back to the normal non-uppercase headings. % \subsection{The Interface for Beginners}\label{sec:scrpage.UI.user} % \deftripstyle -\BeginIndex{Cmd}{deftripstyle}\Index{page style} +\BeginIndex{Cmd}{deftripstyle}\Index{page>style} -Now one would not always be bound only to the provided page styles, -but moreover there will be the wish to define own page styles. -Sometimes there will be a special need, since a specific -\emph{Corporate Identity} requires the declaration of own page styles. -The easiest way to deal with is: +Now one would not like to remain bound to only the provided page +styles, but may wish to define one's own page styles. Sometimes there +will be a special need, since a specific \emph{Corporate Identity} may +require the declaration of its own page styles. The easiest way to +deal with this is: \begin{Declaration} \Macro{deftripstyle}\Parameter{name}% \OParameter{LO}\OParameter{LI}% \Parameter{HI}\Parameter{HC}\Parameter{HO}% \Parameter{FI}\Parameter{FC}\Parameter{FO} \end{Declaration}% -The parameters have the following meaning: +The individual parameters have the following meanings: \begin{labeling}[\,--]{\PName{Name}} -\item[\PName{name}] the name of the page style, in order to activate them +\item[\PName{name}] the name of the page style, in order to activate it using the command \Macro{pagestyle}\Parameter{name} \item[\PName{LO}] the thickness of the outside lines, - i.e. the line above the head - and the line below the foot (optional) + i.\,e., the line above the header + and the line below the footer (optional) \item[\PName{LI}] the thickness of the separation lines, - i.e. the line below the head + i.\,e., the line below the header and the line above the foot (optional) -\item[\PName{HI}] contents of the inside box in the page head for two-side - layout or left for one-side layout -\item[\PName{HC}] contents of the centered box in the page head -\item[\PName{HO}] contents of the outside box in the page head for two-side - layout or right for one-side layout -\item[\PName{FI}] contents of the inside box in the page foot for two-side - layout or left for one-side layout -\item[\PName{FC}] contents of the centered box in the page foot -\item[\PName{FO}] contents of the outside box in the page foot for two-side - layout or right for one-side layout +\item[\PName{HI}] contents of the inside box in the page header for two-sided + layout or left for one-sided layout +\item[\PName{HC}] contents of the centered box in the page header +\item[\PName{HO}] contents of the outside box in the page header for two-sided + layout or right for one-sided layout +\item[\PName{FI}] contents of the inside box in the page footer for two-sided + layout or left for one-sided layout +\item[\PName{FC}] contents of the centered box in the page footer +\item[\PName{FO}] contents of the outside box in the page footer for two-sided + layout or right for one-sided layout \end{labeling} -The command \Macro{deftripstyle} surely represents the simplest -possibility of defining page styles. -Unfortunately also restrictions are connected with since in a -page range with one via deftripstyle defined page style -no modification of the lines above and below heading and footing -can take place. +The command \Macro{deftripstyle} definitely represents the simplest +possibility of defining page styles. Unfortunately, there are also +restrictions connected with this, since in a page range using a page +style defined via deftripstyle, no modification of the lines above and +below header and footer can take place. \begin{Example} -Assuming a two-side layout, where the running headings are placed inside. -Furthermore the document title, here "`Report"`, shall be placed outside -in the head, the page number is centered in the foot. + Assume a two-sided layout, where the running headings are placed on + the inside. Furthermore, the document title, here ``Report'', shall + be placed outside in the header, the page number shall be centered + in the footer. \begin{lstlisting} \deftripstyle{TheReport}% {\headmark}{}{Report}% {}{\pagemark}{} \end{lstlisting} -Shall moreover the lines above the head and below the foot be -drawn with a thickness of 2\,pt and the text body be separated ->from head and foot with 0.4\,pt lines, then the definition has to -be extended. +If moreover the lines above the header and below the footer shall be +drawn with a thickness of 2\,pt, and the text body be separated from +header and footer with 0.4\,pt lines, then the definition has to be +extended: \begin{lstlisting} \deftripstyle{TheReport}[2pt][.4pt]% {\headmark}{}{Report}% @@ -1142,110 +1126,107 @@ be extended. % \defpagestyle \newpagestyle \providepagestyle \renewpagestyle \BeginIndex{Cmd}{defpagestyle}\BeginIndex{Cmd}{newpagestyle} \BeginIndex{Cmd}{renewpagestyle}\BeginIndex{Cmd}{providepagestyle} -\Index{page style} -Simple page styles, how they can be defined with \Macro{deftripstyle}, -are rare according to experience. -Either a professor requires that the thesis looks in -such a way like its own, and who wants to contradict -it seriously, or a company would like that the half -financial department emerges in the page footing. -No problem, the solution is: +\Index{page>style} +Simple page styles, as they can be defined with \Macro{deftripstyle}, +are fairly rare according to experience. Either a professor requires +that the thesis looks like his or her own\,---\,and who seriously wants +to argue against such a wish?\,---\,or a company would like that half the +financial accounting emerges in the page footer. No problem, the +solution is: % \begin{Declaration} -\Macro{defpagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition}\\ -\Macro{newpagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition}\\ -\Macro{renewpagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition}\\ -\Macro{providepagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition} +\Macro{defpagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition}\\ +\Macro{newpagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition}\\ +\Macro{renewpagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition}\\ +\Macro{providepagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition} \end{Declaration}% These four commands give full access to the capabilities of -\Package{scrpage2} according to define page styles. -Their structure is indentical, they differ only the manner of working. +\Package{scrpage2} to define page styles. Their structure is +indentical, they differ only in the manner of working. \begin{labeling}[\,--]{\Macro{providepagestyle}} -\item[\Macro{defpagestyle}] defines always a new pagestyle. +\item[\Macro{defpagestyle}] defines a new page style. If a page style with this name already exists it will be overwritten. -\item[\Macro{newpagestyle}] defines a new pagestyle. +\item[\Macro{newpagestyle}] defines a new page style. If a page style with this name already exists a error message will be given. -\item[\Macro{renewpagestyle}] redefines a pagestyle. -If apage style with this name does not exist a error message will be given. -\item[\Macro{providepagestyle}] defines a new pagestyle, -but only if there is no page style with that name already present. +\item[\Macro{renewpagestyle}] redefines a page style. +If a page style with this name does not exist a error message will be given. +\item[\Macro{providepagestyle}] defines a new page style only if there is no page style with that name already present. \end{labeling} -The syntax of the four commands is explained on command -\Macro{defpagestyle} examplary. +Using \Macro{defpagestyle} as an example, the syntax of the four +commands is explained below. \begin{labeling}[\,--]{\PName{head definition}} \item[\PName{name}] the name of the page style for \Macro{pagestyle}\Parameter{name} -\item[\PName{head-definition}] the declaration of the heading consisting +\item[\PName{header definition}] the declaration of the header, consisting of five element; elements in round parenthesis are optional:\\ \AParameter{ALL,ALT}\Parameter{EP}\Parameter{OP}\Parameter{OS}\AParameter{BLL,BLT} -\item[\PName{foot-definition}] the declaration of the footing consisting +\item[\PName{footer definition}] the declaration of the footer, consisting of five element; elements in round parenthesis are optional:\\ \AParameter{ALL,ALT}\Parameter{EP}\Parameter{OP}\Parameter{OS}\AParameter{BLL,BLT} \end{labeling} -It can be seen, that head and foot declaration are identical. -The parameters have the following meaning: +As can be seen, header and footer declaration have identical +structure. The individual parameters have the following meanings: \begin{labeling}[\,--]{\PName{OLD}} -\item[\PName{ALL}] above line length: (head = outside, foot = separation line) +\item[\PName{ALL}] above line length: (header = outside, footer = separation line) \item[\PName{ALT}] above line thickness \item[\PName{EP}] definition for \emph{even} pages \item[\PName{OP}] definition for \emph{odd} pages -\item[\PName{OS}] definition for \emph{one-side} layout -\item[\PName{BLL}] below line length: (head = separation line, foot = outside) +\item[\PName{OS}] definition for \emph{one-sided} layout +\item[\PName{BLL}] below line length: (header = separation line, footer = outside) \item[\PName{BLT}] below line thickness \end{labeling} -If the optional line-parameters are omitted, then the line behaviour keeps -configurable by the commands introduced in +If the optional line-parameters are omitted, then the line behaviour +remains configurable by the commands introduced in \autoref{sec:scrpage.basics.format}, \autopageref{desc:scrpage.macro.setheadtopline}. -The three elements \PName{EP}, \PName{OP} and \PName{OS} are boxes with -the width of page head or foot respectively. -The definition occur on the left side in the box, thus the space between -two text elements has to be stretched using \Macro{hfill}, in order to -write the first text element on the left edge \emph{and} the second text -element on the right edge. +The three elements \PName{EP}, \PName{OP} and \PName{OS} are boxes +with the width of page header or footer, as appropriate. The +corresponding definitions are set left-justified in the boxes. To set +something left- and right-justified into the boxes, the space between +two text elements can be stretched using \Macro{hfill}, in order to +write the first text element on the left edge \emph{and}: % \begin{lstlisting} {\headmark\hfill\pagemark} \end{lstlisting} If one would like a third text-element centered in the box, then an -extended definition must be used. -The commands \Macro{rlap} and \Macro{llap} simply write the given -arguments, but for \LaTeX{} they take no horizontal space. -Only this way the middle text is really centered. +extended definition must be used. The commands \Macro{rlap} and +\Macro{llap} simply write the given arguments, but for {\LaTeX} they +take up no horizontal space. Only in this way is the middle text +really centered. % \begin{lstlisting} {\rlap{\headmark}\hfill centered text\hfill\llap{\pagemark}} \end{lstlisting} -This and more examples of the expert's interface and other commands -provided by \Package{scpage2} follow now in the final example. +This and the use of the expert interface in connection with other +commands provided by \Package{scpage2} follows now in the final +example. \begin{Example} -This examples uses the document class \Class{scrbook}, which -means that the default page layout is two-side. -While the loading of the package \Package{scrpage2} the -options \Option{automark} and \Option{headsepline} are -given. -The first switches on the automatic update of running -headings, the second determines that a separation line between -head and text-body is drawn in the \PValue{scrheadings} page style. + This examples uses the document class \Class{scrbook}, which means + that the default page layout is two-sided. The package + \Package{scrpage2} is loaded with options \Option{automark} and + \Option{headsepline}. The first switches on the automatic update of + running headings, the second determines that a separation line + between header and text body is drawn in the \PValue{scrheadings} + page style. \begin{lstlisting} \documentclass{scrbook} \usepackage[automark,headsepline]{scrpage2} \end{lstlisting} -The expert's interface is used to define two page styles. -The page style \PValue{withoutLines} does not define any -line parameters. -The second page style \PValue{withLines} defines -a line thicknes of 1\,pt for the line above the head -and 0\,pt for the separation-line between head and text. +The expert interface is used to define two page styles. The page +style \PValue{withoutLines} does not define any line parameters. The +second page style \PValue{withLines} defines a line thicknes of 1\,pt +for the line above the header and 0\,pt for the separation line +between header and text. \begin{lstlisting} \defpagestyle{withoutLines}{% @@ -1273,24 +1254,22 @@ and 0\,pt for the separation-line between head and text. } \end{lstlisting} -At the document's begin the page style \PValue{scrheadings} -is choosen. -The command \Macro{chapter} starts a new chapter and sets -automatically the page style for this page to \PValue{plain}. - -The command \Macro{chead} shows how running headings can -be represented even on a \PValue{plain} page. -Running headings on chapter start-pages are not usual, -since in this case the page looses its emphasis-character. -Basically it is more important to show that a new -chapter starts here than that a section of this page has -a special title. +Right at the beginning of the document the page style +\PValue{scrheadings} is activated. The command \Macro{chapter} starts +a new chapter and automatically sets the page rstyle for this page to +\PValue{plain}. Even though not a prime example, the command +\Macro{chead} shows how running headings can be created even on a +\PValue{plain} page. However, in principle running headings on +chapter start-pages are to be avoided, since otherwise the special +character of the \PValue{plain} page style is lost. It is more +important to indicate that a new chapter starts here than that a +section of this page has a special title. \begin{Explain}% not important, only to enhance the paragraph breaking Instead of \Macro{leftmark} one would expect the use of \Macro{rightmark} in the parameter of \Macro{chead}, since the chapter starts on an even -page. But, because of internal \LaTeX{} definitions, +page. But, because of internal {\LaTeX} definitions, this does not work. It only returns an empty string. \end{Explain} \begin{lstlisting} @@ -1301,7 +1280,7 @@ this does not work. It only returns an empty string. \chead[\leftmark]{} \section{Main Laws} - Every system has an extensive condition unit called + Every system has an extensive state quantity called Energy. In a closed system the energy is constant. \end{lstlisting} @@ -1310,39 +1289,37 @@ this does not work. It only returns an empty string. \put(10,17){\normalsize\textbf{\sffamily 1.Thermodynamics}} \put(10,12){\textbf{\sffamily 1.1 Main Laws}} \XmpSetText[% - Every System has an extensive condition unit]{10,9} + Every System has an extensive state quantity]{10,9} \end{XmpTopPage} -After starting a new page the page style \PValue{scrheadings} -is active and thus the separation line below the heading is -visible. +After starting a new page the page style \PValue{scrheadings} is +active and thus the separation line below the header is visible. \begin{lstlisting} - There is a condition unit of a system, called entropy, - which temporal alteration consits of entropy stream - and entropy generation. + There is a state quatity of a system, called entropy, whose temporal + change consists of entropy flow and entropy generation. \end{lstlisting} \begin{XmpTopPage} \XmpHeading[\textsl{1. Thermodynamics}\hfill]{20,27}{70} \thinlines\XmpRule{20,25}{70} \XmpSetText[% There is a condition unit of a system, called entropy, - which temporal alteration consits of entropy stream + whose temporal change consists of entropy flow and entropy generation.]{20,20} \end{XmpTopPage} -After switching to the next page, the automatic update of the -running headings is disabled using \Macro{manualmark}. -The page style \PValue{withoutLines} becomes active. -Since no line parameters are given in the definition of this -page style, the default configuration is used, which draws -a separation line between head and text-body. +After switching to the next page, the automatic update of the running +headings is disabled using \Macro{manualmark}, and the page style +\PValue{withoutLines} becomes active. Since no line parameters are +given in the definition of this page style, the default configuration +is used, which draws a separation line between header and text body +because \Package{scrpage2} was called with \Option{headsepline}. \begin{XmpTopPage} \XmpHeading[\slshape Energy Conversion\hfill without lines]{10,27}{70} \thinlines\XmpRule{10,25}{70} \XmpSetText[% \textbf{\sffamily 1.2 Exergy and Anergy}\\ - While the transition of a system to an equilibrium state - with its environment the maximum work gainable is called + During the transition of a system to an equilibrium state + with its environment, the maximum work gainable is called exergy.]{10,21} \end{XmpTopPage} @@ -1350,19 +1327,18 @@ a separation line between head and text-body. \manualmark \pagestyle{withoutLines} \section{Exergy and Anergy}\markright{Energy Conversion} - While the transition of a system to an equilibrium state - with its environment the maximum work gainable is called + During the transition of a system to an equilibrium state + with its environment, the maximum work gainable is called exergy. \end{lstlisting} -At the next page of the document the page style \PValue{withLines} -is activated. -The line settings of its definition are taken in account and the -lines are drawn accordingly. +At the next page of the document, the page style \PValue{withLines} is +activated. The line settings of its definition are taken in account +and the lines are drawn accordingly. \begin{lstlisting} \pagestyle{mitLinien} \renewcommand{\headfont}{\itshape\bfseries} - The portion of an energy not conversable in exergie + The portion of an energy not convertible in exergy is named anergy \Var{B}. \[ B = U + T (S_1 - S_u) - p (V_1 - V_u)\] \end{document} @@ -1371,7 +1347,7 @@ lines are drawn accordingly. \XmpHeading[\itshape\bfseries with lines\hfill 1. Thermodynamics]{20,27}{70} \thicklines\XmpRule{20,29}{70} \XmpSetText[% - The portion of an energy not conversable in exergie + The portion of an energy not convertible in exergy is named anergy $B$. \[ B = U + T (S_1 - S_u) - p (V_1 - V_u)\] ]{20,20} \end{XmpTopPage} @@ -1383,14 +1359,17 @@ lines are drawn accordingly. % scrpage.cfg \BeginIndex{File}{scrpage.cfg} Before long the work with different page styles will establish a -common set of employed page styles, depending on taste and tasks. -In order to make the management of page styles easier, -\Package{scrpage2} reads after initialisation the file \File{scrpage.cfg}. -This file can contain a set of user-defined page styles, which -many projects can share. +common set of employed page styles, depending on taste and tasks. In +order to make the management of page styles easier and avoid +time-consuming copy operations each time a new project is started, +\Package{scrpage2} reads the file \File{scrpage.cfg} after +initialisation. This file can contain a set of user-defined page +styles which many projects can share. \EndIndex{File}{scrpage.cfg} \EndIndex{Package}{scrpage2} + %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: ../guide" %%% End: |