diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/scrpage2.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/scrpage2.tex | 935 |
1 files changed, 393 insertions, 542 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/scrpage2.tex b/Master/texmf-dist/source/latex/koma-script/doc/scrpage2.tex index f6f57e0c497..7af7c1a32bd 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/scrpage2.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/scrpage2.tex @@ -1,6 +1,6 @@ % ====================================================================== % scrpage2.tex -% Copyright (c) Markus Kohm, 2001-2014 +% Copyright (c) Markus Kohm, 2001-2016 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -18,7 +18,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % scrpage2.tex -% Copyright (c) Markus Kohm, 2001-2014 +% Copyright (c) Markus Kohm, 2001-2016 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -84,7 +84,9 @@ \labelbase{scrpage-en} % +\BeginIndexGroup \BeginIndex{Package}{scrpage2}% +\BeginIndex{}{page>style} From \KOMAScript{} 3.12 the completely newly implemented package \Package{scrlayer-scrpage} replaces the old \Package{scrpage2}. The new package is a consequently developed extension of the design of @@ -114,19 +116,19 @@ information about \Package{scrlayer-scrpage} see the \KOMAScript{} manual. \begin{Explain}% Introduction to headings 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 \Pagestyle{empty}, which produces a completely empty header - and footer, and \Pagestyle{plain}, which produces usually only a page number + the page styles \PageStyle{empty}, which produces a completely empty header + and footer, and \PageStyle{plain}, which produces usually only a page number in the footer and an empty header. Apart from these, many document classes - provide the style \Pagestyle{headings}, which allows more complex style + provide the style \PageStyle{headings}, which allows more complex style settings and running headings\Index{headings>running}\Index{headings>automatic}. The - \Pagestyle{headings} style often has a related variant, - \Pagestyle{myheadings}, which is similar except for switching off the + \PageStyle{headings} style often has a related variant, + \PageStyle{myheadings}, which is similar except for switching off the running headings\Index{headings>manual} and reverting them to manual control by the user. A more detailed description is given in the page style section of the \KOMAScript{} manual where it is also noted that some {\LaTeX} commands automatically switch to another page style\,---\,usually page style - \Pagestyle{plain}\,---\,for the current page. + \PageStyle{plain}\,---\,for the current page. \end{Explain} @@ -147,83 +149,62 @@ configurable page styles. % \headmark \pagemark \begin{Declaration} - \Pagestyle{scrheadings}\\ - \Pagestyle{scrplain} + \PageStyle{scrheadings}% + \PageStyle{scrplain} \end{Declaration}% -\BeginIndex{Pagestyle}{scrheadings}% -\BeginIndex{Pagestyle}{scrplain}% -\Index{page>style}% -% Package \Package{scrpage2} delivers its own page style, named -\Pagestyle{scrheadings}, which can be activated with the +\PageStyle{scrheadings}, which can be activated with the \Macro{pagestyle}\PParameter{scrheadings}. When this page style is in use, an -appropriate \Pagestyle{scrplain} page style is used for the plain page style. +appropriate \PageStyle{scrplain} page style is used for the plain page style. In this case \emph{appropriate} means that this new plain page style is also configureable by the commands introduced in \autoref{sec:scrpage-en.basics.format}, which, for example, configure the header and footer width and complies within the basic layout. Neither the activation -of \Pagestyle{scrheadings} nor the attendant change to the appropriate plain -page style, \Pagestyle{scrplain}, influences the mode of manual or automatic +of \PageStyle{scrheadings} nor the attendant change to the appropriate plain +page style, \PageStyle{scrplain}, influences the mode of manual or automatic headings\Index{headings>automatic}\Index{headings>manual} (see -\autoref{sec:scrpage-en.basics.mark}). The \Pagestyle{scrplain} page style can +\autoref{sec:scrpage-en.basics.mark}). The \PageStyle{scrplain} page style can also be activated directly with \Macro{pagestyle}. + \begin{Declaration} \Macro{lehead}% - \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}\\ + \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}% \Macro{cehead}% - \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}\\ + \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}% \Macro{rehead}% - \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}\\ + \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}% \Macro{lefoot}% - \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}\\ + \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}% \Macro{cefoot}% - \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}\\ + \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}% \Macro{refoot}% - \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}\\ + \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}% \Macro{lohead}% - \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}\\ + \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}% \Macro{cohead}% - \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}\\ + \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}% \Macro{rohead}% - \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}\\ + \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}% \Macro{lofoot}% - \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}\\ + \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}% \Macro{cofoot}% - \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}\\ + \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}% \Macro{rofoot}% - \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}\\ + \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}% \Macro{ihead}% - \OParameter{scrplain-inside}\Parameter{scrheadings-inside}\\ + \OParameter{scrplain-inside}\Parameter{scrheadings-inside}% \Macro{chead}% - \OParameter{scrplain-centered}\Parameter{scrheadings-centered}\\ + \OParameter{scrplain-centered}\Parameter{scrheadings-centered}% \Macro{ohead}% - \OParameter{scrplain-outside}\Parameter{scrheadings-outside}\\ + \OParameter{scrplain-outside}\Parameter{scrheadings-outside}% \Macro{ifoot}% - \OParameter{scrplain-inside}\Parameter{scrheadings-inside}\\ + \OParameter{scrplain-inside}\Parameter{scrheadings-inside}% \Macro{cfoot}% - \OParameter{scrplain-centered}\Parameter{scrheadings-centered}\\ + \OParameter{scrplain-centered}\Parameter{scrheadings-centered}% \Macro{ofoot}% \OParameter{scrplain-outside}\Parameter{scrheadings-outside} \end{Declaration}% -\BeginIndex{Cmd}{lehead}% -\BeginIndex{Cmd}{cehead}% -\BeginIndex{Cmd}{rehead}% -\BeginIndex{Cmd}{ihead}% -\BeginIndex{Cmd}{chead}% -\BeginIndex{Cmd}{ohead}% -\BeginIndex{Cmd}{lohead}% -\BeginIndex{Cmd}{cohead}% -\BeginIndex{Cmd}{rohead}% -\BeginIndex{Cmd}{lefoot}% -\BeginIndex{Cmd}{cefoot}% -\BeginIndex{Cmd}{refoot}% -\BeginIndex{Cmd}{ifoot}% -\BeginIndex{Cmd}{cfoot}% -\BeginIndex{Cmd}{rfoot}% -\BeginIndex{Cmd}{lofoot}% -\BeginIndex{Cmd}{cofoot}% -\BeginIndex{Cmd}{rofoot}% The page style of \Package{scrpage2} are defined to have flexible configurable header and footer. To achieve this, the page styles include three boxes in both the header and the footer. The contents of these boxes may be modified @@ -231,17 +212,17 @@ easily. The commands modifying the content of these boxes can be seen in \autoref{fig:scrpage-en.leheadetall}. Commands in the middle column modify the box contents on both odd and even pages. All of the commands have an optional and a mandatory argument. The option Argument influences the content of -corresponding box of the plain page style, \Pagestyle{scrplain}. The mandatory +corresponding box of the plain page style, \PageStyle{scrplain}. The mandatory argument influences the content of the corresponding box of the page style -\Pagestyle{scrheadings}. +\PageStyle{scrheadings}. \begin{figure} % \centering \setcapindent{0pt}% \begin{captionbeside} [Commands for modification of \Package{scrpage2} page styles elements]% - {Commands for modification of page styles \Pagestyle{scrheadings} and - \Pagestyle{scrplain} and their relationship to header and footer + {Commands for modification of page styles \PageStyle{scrheadings} and + \PageStyle{scrplain} and their relationship to header and footer elements} [l] \setlength{\unitlength}{.95mm}\begin{picture}(100,65)(0,8)\small @@ -266,51 +247,51 @@ argument influences the content of the corresponding box of the page style % commands and arrow % for twoside % - \put(50,65){\makebox(0,0){\Macro{ihead}}} + \put(50,65){\makebox(0,0){\DescRef{scrpage-en.cmd.ihead}}} \put(44,65){\vector(-1,0){4}}\put(56,65){\vector(1,0){4}} - \put(50,58){\makebox(0,0){\Macro{chead}}} + \put(50,58){\makebox(0,0){\DescRef{scrpage-en.cmd.chead}}} \put(44,58){\line(-1,0){24}}\put(56,58){\line(1,0){24}} \put(20,58){\vector(0,1){4}}\put(80,58){\vector(0,1){4}} - \put(50,51){\makebox(0,0){\Macro{ohead}}} + \put(50,51){\makebox(0,0){\DescRef{scrpage-en.cmd.ohead}}} \put(44,51){\line(-1,0){40}}\put(56,51){\line(1,0){40}} \put(4,51){\vector(0,1){11}}\put(96,51){\vector(0,1){11}} % - \put(50,15){\makebox(0,0){\Macro{ifoot}}} + \put(50,15){\makebox(0,0){\DescRef{scrpage-en.cmd.ifoot}}} \put(56,15){\vector(1,0){4}}\put(44,15){\vector(-1,0){4}} - \put(50,22){\makebox(0,0){\Macro{cfoot}}} + \put(50,22){\makebox(0,0){\DescRef{scrpage-en.cmd.cfoot}}} \put(44,22){\line(-1,0){24}}\put(56,22){\line(1,0){24}} \put(20,22){\vector(0,-1){4}}\put(80,22){\vector(0,-1){4}} - \put(50,29){\makebox(0,0){\Macro{ofoot}}} + \put(50,29){\makebox(0,0){\DescRef{scrpage-en.cmd.ofoot}}} \put(44,29){\line(-1,0){40}}\put(56,29){\line(1,0){40}} \put(4,29){\vector(0,-1){11}}\put(96,29){\vector(0,-1){11}} % commands for oneside - \put(5,69){\makebox(0,0)[b]{\Macro{lehead}}} - \put(20,69){\makebox(0,0)[b]{\Macro{cehead}}} - \put(35,69){\makebox(0,0)[b]{\Macro{rehead}}} + \put(5,69){\makebox(0,0)[b]{\DescRef{scrpage-en.cmd.lehead}}} + \put(20,69){\makebox(0,0)[b]{\DescRef{scrpage-en.cmd.cehead}}} + \put(35,69){\makebox(0,0)[b]{\DescRef{scrpage-en.cmd.rehead}}} % - \put(65,69){\makebox(0,0)[b]{\Macro{lohead}}} - \put(80,69){\makebox(0,0)[b]{\Macro{cohead}}} - \put(95,69){\makebox(0,0)[b]{\Macro{rohead}}} + \put(65,69){\makebox(0,0)[b]{\DescRef{scrpage-en.cmd.lohead}}} + \put(80,69){\makebox(0,0)[b]{\DescRef{scrpage-en.cmd.cohead}}} + \put(95,69){\makebox(0,0)[b]{\DescRef{scrpage-en.cmd.rohead}}} % - \put(5,11){\makebox(0,0)[t]{\Macro{lefoot}}} - \put(20,11){\makebox(0,0)[t]{\Macro{cefoot}}} - \put(35,11){\makebox(0,0)[t]{\Macro{refoot}}} + \put(5,11){\makebox(0,0)[t]{\DescRef{scrpage-en.cmd.lefoot}}} + \put(20,11){\makebox(0,0)[t]{\DescRef{scrpage-en.cmd.cefoot}}} + \put(35,11){\makebox(0,0)[t]{\DescRef{scrpage-en.cmd.refoot}}} % - \put(65,11){\makebox(0,0)[t]{\Macro{lofoot}}} - \put(80,11){\makebox(0,0)[t]{\Macro{cofoot}}} - \put(95,11){\makebox(0,0)[t]{\Macro{rofoot}}} + \put(65,11){\makebox(0,0)[t]{\DescRef{scrpage-en.cmd.lofoot}}} + \put(80,11){\makebox(0,0)[t]{\DescRef{scrpage-en.cmd.cofoot}}} + \put(95,11){\makebox(0,0)[t]{\DescRef{scrpage-en.cmd.rofoot}}} \end{picture} \end{captionbeside} % \caption[Commands for modification of \Package{scrpage2} page styles % elements]% -% {Commands for modification of page styles \Pagestyle{scrheadings} and -% \Pagestyle{scrplain} and their relationship to header and footer +% {Commands for modification of page styles \PageStyle{scrheadings} and +% \PageStyle{scrplain} and their relationship to header and footer % elements} \label{fig:scrpage-en.leheadetall} \end{figure} \begin{Example} - If one wants the page number within \Pagestyle{scrheadings} be placed in the + If one wants the page number within \PageStyle{scrheadings} be placed in the middle of the footer, then following can be used: \begin{lstcode} \cfoot{\pagemark} @@ -347,42 +328,38 @@ more advanced settings. \end{Example} As mentioned above, there is a new plain page style which corresponds to -\Pagestyle{scrheadings}. Since it should also be possible to customize this +\PageStyle{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 plain page style can be modified. \begin{Example} - The position of the page number for the page style \Pagestyle{scrheadings} + The position of the page number for the page style \PageStyle{scrheadings} can be declared as follows: \begin{lstcode} \cfoot[\pagemark]{} \ohead[]{\pagemark} \end{lstcode} When the command \Macro{chapter}, after it has started a new page, now - switches to the page style \Pagestyle{plain}, then the page number is + switches to the page style \PageStyle{plain}, then the page number is centered in the footer. \end{Example} % -\EndIndex{Pagestyle}{scrheadings}% -\EndIndex{Pagestyle}{scrplain}% +\EndIndexGroup \begin{Declaration} - \Macro{clearscrheadings}\\ - \Macro{clearscrplain}\\ + \Macro{clearscrheadings}% + \Macro{clearscrplain}% \Macro{clearscrheadfoot} \end{Declaration}% -\BeginIndex{Cmd}{clearscrheadings}% -\BeginIndex{Cmd}{clearscrplain}% -\BeginIndex{Cmd}{clearscrheadfoot}% -If one wants to redefine both the page style \Pagestyle{scrheadings} and +If one wants to redefine both the page style \PageStyle{scrheadings} and the corresponding 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 -\Pagestyle{scrheadings}, and \Macro{clearscrplain} deletes all fields of +\PageStyle{scrheadings}, and \Macro{clearscrplain} deletes all fields of the corresponding plain page style, \Macro{clearscrheadfoot} sets all fields of both page styles to empty. \begin{Example} @@ -409,26 +386,18 @@ sets all fields of both page styles to empty. dropped.% \end{Example}% % -\EndIndex{Cmd}{clearscrheadings}% -\EndIndex{Cmd}{clearscrplain}% -\EndIndex{Cmd}{clearscrheadfoot}% +\EndIndexGroup % -\EndIndex{Cmd}{lehead}\EndIndex{Cmd}{cehead}\EndIndex{Cmd}{rehead}% -\EndIndex{Cmd}{ihead}\EndIndex{Cmd}{chead}\EndIndex{Cmd}{ohead}% -\EndIndex{Cmd}{lohead}\EndIndex{Cmd}{cohead}\EndIndex{Cmd}{rohead}% -\EndIndex{Cmd}{lefoot}\EndIndex{Cmd}{cefoot}\EndIndex{Cmd}{refoot}% -\EndIndex{Cmd}{ifoot}\EndIndex{Cmd}{cfoot}\EndIndex{Cmd}{rfoot}% -\EndIndex{Cmd}{lofoot}\EndIndex{Cmd}{cofoot}\EndIndex{Cmd}{rofoot}% +\EndIndexGroup + 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{leftmark}% \Macro{rightmark} \end{Declaration}% -\BeginIndex{Cmd}{leftmark}% -\BeginIndex{Cmd}{rightmark}% 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} @@ -436,88 +405,82 @@ 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}% +\EndIndexGroup \begin{Declaration} \Macro{headmark} \end{Declaration}% -\BeginIndex{Cmd}{headmark}% 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} +\EndIndexGroup \begin{Declaration} \Macro{pagemark} \end{Declaration}% -\BeginIndex{Cmd}{pagemark}% This command returns the formatted page number. The formatting can be -controlled by \Macro{pnumfont}, introduced in -\autoref{sec:scrpage-en.basics.format}, \autopageref{desc:scrpage-en.cmd.pnumfont}, +controlled by \DescRef{scrpage-en.cmd.pnumfont}, introduced in +\autoref{sec:scrpage-en.basics.format}, \DescPageRef{scrpage-en.cmd.pnumfont}, which \Macro{pagemark} heeds automatically.% % -\EndIndex{Cmd}{pagemark} +\EndIndexGroup \begin{Declaration} - \Pagestyle{useheadings} + \PageStyle{useheadings} \end{Declaration}% -\BeginIndex{Pagestyle}{useheadings} 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{pagestyle}\PParameter{headings}\IndexCmd{pagestyle}, but this has the -disadvantage that commands \Macro{automark} and \Macro{manualmark}, to be +disadvantage that commands \DescRef{scrpage-en.cmd.automark} and \DescRef{scrpage-en.cmd.manualmark}, to be discussed shortly, do not function as expected. For this reason one should shift back to the original styles using \Macro{pagestyle}\PParameter{useheadings}\IndexCmd{pagestyle}, which chooses the correct page styles automatically for both manual and automatic running headings.% % -\EndIndex{Pagestyle}{useheadings} +\EndIndexGroup \subsection{Manual and Running Headings} \label{sec:scrpage-en.basics.mark} % \automark \manualmark -% +\BeginIndexGroup \BeginIndex{}{headings>running}% \BeginIndex{}{headings>automatic}% \BeginIndex{}{headings>manual}% -Usually there is a \emph{my}-version of the \Pagestyle{headings} +Usually there is a \emph{my}-version of the \PageStyle{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 +\DescRef{scrpage-en.cmd.automark} and \DescRef{scrpage-en.cmd.manualmark}, respectively. The default can be set already while loading of the package, with the options -\Option{automark} and \Option{manualmark} (see +\DescRef{scrpage-en.option.automark} and \DescRef{scrpage-en.option.manualmark} (see \autoref{sec:scrpage-en.basics.options}, -\autopageref{desc:scrpage-en.option.automark}). +\DescPageRef{scrpage-en.option.automark}). \begin{Declaration} \Macro{manualmark} \end{Declaration}% -\BeginIndex{Cmd}{manualmark}% 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} +\EndIndexGroup \begin{Declaration} \Macro{automark}\OParameter{right page}\Parameter{left page} \end{Declaration}% -\BeginIndex{Cmd}{automark}% 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 @@ -530,15 +493,15 @@ classes from version~2.9s up are known to support this value. The optional argument \PName{right page} is understandably meant only for double-sided documents. In the single-sided case one should normally not use it. With the help of the option -\Option{autooneside}\IndexOption{autooneside}\important{\Option{autooneside}} +\DescRef{scrpage-en.option.autooneside}\IndexOption{autooneside}\important{\DescRef{scrpage-en.option.autooneside}} one can also set that the optional argument in single-sided mode is ignored automatically (see \autoref{sec:scrpage-en.basics.options}, -\autopageref{desc:scrpage-en.option.autooneside}). +\DescPageRef{scrpage-en.option.autooneside}). % \begin{Example} Assuming that the document uses a \emph{book} class, whose topmost section level is \emph{chapter}, then after a preceding - \Macro{manualmark} + \DescRef{scrpage-en.cmd.manualmark} \begin{lstcode} \automark[section]{chapter} \end{lstcode} @@ -555,17 +518,15 @@ automatically (see \autoref{sec:scrpage-en.basics.options}, 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. + \Macro{markleft}\IndexCmd[indexmain]{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}% +\EndIndexGroup % -\EndIndex{}{headings>manual}% -\EndIndex{}{headings>automatic}% -\EndIndex{}{headings>running}% +\EndIndexGroup \subsection{Formatting of Header and Footer} @@ -579,13 +540,10 @@ formative ambitions. Therefore we devote this section exclusively to this topic. \begin{Declaration} - \Macro{headfont}\\ - \Macro{footfont}\\ + \Macro{headfont}% + \Macro{footfont}% \Macro{pnumfont} \end{Declaration}% -\BeginIndex{Cmd}{headfont}% -\BeginIndex{Cmd}{footfont}% -\BeginIndex{Cmd}{pnumfont}% The command \Macro{headfont} contains the commands which determine the font of header and footer lines. Command \Macro{footfont} contains the difference of the footer to that. The difference for the style of the page number is defined @@ -600,9 +558,6 @@ by the command \Macro{pnumfont}. \renewcommand{\pnumfont}{\normalfont\rmfamily\slshape} \end{lstcode} \end{Example} -\EndIndex{Cmd}{headfont}% -\EndIndex{Cmd}{footfont}% -\EndIndex{Cmd}{pnumfont}% \BeginIndex{FontElement}{pagehead}% \BeginIndex{FontElement}{pagefoot}% @@ -621,17 +576,13 @@ attributes in the manner described in the \KOMAScript{} manual. \setkomafont{pagenumber}{\normalfont\rmfamily\slshape} \end{lstcode} \end{Example} -\EndIndex{FontElement}{pagenumber}% -\EndIndex{FontElement}{pagefoot}% -\EndIndex{FontElement}{pagehead}% +\EndIndexGroup \begin{Declaration} -\Macro{setheadwidth}\OParameter{shift}\Parameter{width}\\ +\Macro{setheadwidth}\OParameter{shift}\Parameter{width}% \Macro{setfootwidth}\OParameter{shift}\Parameter{width} \end{Declaration}% -\BeginIndex{Cmd}{setheadwidth}% -\BeginIndex{Cmd}{setfootwidth}% Normally the widths of header and footer lines correspond to the width of the text body. The commands \Macro{setheadwidth}\Index{header>width}\Index{head>width} and @@ -714,27 +665,26 @@ 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} +\EndIndexGroup + \begin{Declaration} \Macro{setheadtopline}\OParameter{length}\Parameter{thickness}% - \OParameter{commands}\\ + \OParameter{commands}% \Macro{setheadsepline}\OParameter{length}\Parameter{thickness}% - \OParameter{commands}\\ + \OParameter{commands}% \Macro{setfootsepline}\OParameter{length}\Parameter{thickness}% - \OParameter{commands}\\ + \OParameter{commands}% \Macro{setfootbotline}\OParameter{length}\Parameter{thickness}% \OParameter{commands} \end{Declaration}% -\BeginIndex{Cmd}{setheadtopline}\BeginIndex{Cmd}{setheadsepline}% -\BeginIndex{Cmd}{setfootseptline}\BeginIndex{Cmd}{setfootbotline}% Corresponding to the size configuration parameters of header and footer there are commands to modify the rules above and below the header and footer. But first of all the rules should be activated. See options -\Option{headtopline}, \Option{headsepline}, -\Option{footsepline}, and \Option{footbotline} in +\DescRef{scrpage-en.option.headtopline}, \DescRef{scrpage-en.option.headsepline}, +\DescRef{scrpage-en.option.footsepline}, and \DescRef{scrpage-en.option.footbotline} in \autoref{sec:scrpage-en.basics.options}, -\autopageref{desc:scrpage-en.option.headsepline} for this. +\DescPageRef{scrpage-en.option.headsepline} for this. \begin{labeling}[\,--]{\Macro{setfootsepline}} \item[\Macro{setheadtopline}] configures the line above the header @@ -745,7 +695,7 @@ header and footer. But first of all the rules should be activated. See options 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 +symbolic values as \PName{width} for \DescRef{scrpage-en.cmd.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. @@ -753,6 +703,7 @@ 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. +\BeginIndexGroup \BeginIndex{FontElement}{headtopline}% \BeginIndex{FontElement}{headsepline}% \BeginIndex{FontElement}{footsepline}% @@ -774,22 +725,21 @@ elements \FontElement{headtopline}\important[i]{\FontElement{headtopline}\\ \FontElement{footbotline}. These can then be extended via \Macro{addtokomafont}\IndexCmd{addtokomafont}. See the \KOMAScript{} manual for details on the \Macro{setkomafont} and \Macro{addtokomafont} commands. -\EndIndex{FontElement}{footbottomline}% -\EndIndex{FontElement}{footbotline}% -\EndIndex{FontElement}{footsepline}% -\EndIndex{FontElement}{headsepline}% -\EndIndex{FontElement}{headtopline}% +\EndIndexGroup \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{} + \labelsuffix[auto+current] + \Macro{setheadtopline}\POParameter{auto}% + \PParameter{current}% + \labelsuffix[auto] + \Macro{setheadtopline}\POParameter{auto}% + \Parameter{}% + \labelsuffix[auto+] + \Macro{setheadtopline}\POParameter{auto}% + \Parameter{}\OParameter{} \end{Declaration}% -The arguments shown here for the command \Macro{setheadtopline} are of +The arguments shown here for the command \DescRef{scrpage-en.cmd.setheadtopline} are of course valid for the other three configuration commands too. If the mandatory parameter has the value \PValue{current} or has been @@ -809,8 +759,8 @@ valid commands. \setheadtopline{2pt} \setheadsepline{.4pt} \end{lstcode} - Additionally\textnote{Attention!} the options \Option{headtopline} and - \Option{headsepline} have to be used preferably globally in the optional + Additionally\textnote{Attention!} the options \DescRef{scrpage-en.option.headtopline} and + \DescRef{scrpage-en.option.headsepline} have to be used preferably globally in the optional argument of \Macro{documentclass}. In this case the result may be the following. % @@ -867,8 +817,8 @@ be achieved with a global package option, which will be described together with other package options in the next \autoref{sec:scrpage-en.basics.options}.% % -\EndIndex{Cmd}{setheadtopline}\EndIndex{Cmd}{setheadsepline} -\EndIndex{Cmd}{setfootseptline}\EndIndex{Cmd}{setfootbotline} +\EndIndexGroup +\EndIndexGroup \subsection{Package Options} @@ -887,44 +837,37 @@ i.\,e. be part of the optional argument of \Macro{documentclass}, or package option, i.\,e. be part of the optional argument of \Macro{usepackage}. \begin{Declaration} -\Option{headinclude}\\ -\Option{headexclude}\\ -\Option{footinclude}\\ -\Option{footexclude} + \Option{headinclude}% + \Option{headexclude}% + \Option{footinclude}% + \Option{footexclude} \end{Declaration}% -\BeginIndex{Option}{headinclude}\BeginIndex{Option}{footinclude}% -\BeginIndex{Option}{headexclude}\BeginIndex{Option}{footexclude}% Since\textnote{Attention!} \KOMAScript~3\ChangedAt{v2.3}{\Package{scrpage2}} this options should not be passed to \Package{scrpage2} any longer using \Macro{PassOptionsToPackage} or the optional argument of \Macro{usepackage}. Only for compatibility reason \Package{scrpage2} still declares them and pass them as \Option{headinclude}, -\OptionValue{headinclude}{false}, \Option{footinclude} und -\OptionValue{footinclude}{false} to package \Package{typearea} weitergereicht. -\EndIndex{Option}{headinclude}\EndIndex{Option}{footinclude}% -\EndIndex{Option}{headexclude}\EndIndex{Option}{footexclude} +\OptionValue{headinclude}{false}, \Option{footinclude}, and +\OptionValue{footinclude}{false} to package \Package{typearea}. +\EndIndexGroup \begin{Declaration} - \Option{headtopline}\\ - \Option{plainheadtopline}\\ - \Option{headsepline}\\ - \Option{plainheadsepline}\\ - \Option{footsepline}\\ - \Option{plainfootsepline}\\ - \Option{footbotline}\\ + \Option{headtopline}% + \Option{plainheadtopline}% + \Option{headsepline}% + \Option{plainheadsepline}% + \Option{footsepline}% + \Option{plainfootsepline}% + \Option{footbotline}% \Option{plainfootbotline} \end{Declaration}% -\BeginIndex{Option}{headtopline}\BeginIndex{Option}{plainheadtopline}% -\BeginIndex{Option}{headsepline}\BeginIndex{Option}{plainheadsepline}% -\BeginIndex{Option}{footsepline}\BeginIndex{Option}{plainfootsepline}% -\BeginIndex{Option}{footbotline}\BeginIndex{Option}{plainfootbotline}% 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 plain page style to the -page style \Pagestyle{scrheadings}, the corresponding line in the plain +page style \PageStyle{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, @@ -942,23 +885,18 @@ page header is part of the text block automatically. The\textnote{Attention!} 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 +class, the options \DescRef{scrpage-en.option.headinclude} and \DescRef{scrpage-en.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} -\EndIndex{Option}{footsepline}\EndIndex{Option}{plainfootsepline} -\EndIndex{Option}{footbotline}\EndIndex{Option}{plainfootbotline} +\EndIndexGroup + \begin{Declaration} -\Option{ilines}\\ -\Option{clines}\\ +\Option{ilines}% +\Option{clines}% \Option{olines} \end{Declaration}% -\BeginIndex{Option}{ilines}% -\BeginIndex{Option}{clines}% -\BeginIndex{Option}{olines}% \Index{rule>alignment}\Index{line>alignment}% With the definition of the line lengths the case can arise where the lengths are set correctly, but the justification is not as desired @@ -972,7 +910,7 @@ default justification, and \Option{olines} aligns at the outside edge. \begin{Example} The next example illustrates the influence of the option \Option{ilines}. Please compare to the example for - \Macro{setfootsepline} on \autopageref{page:scrpage-en.autoLineLength}. + \DescRef{scrpage-en.cmd.setfootsepline} on \autopageref{page:scrpage-en.autoLineLength}. \begin{lstcode} \usepackage[ilines]{scrpage2} \setfootbotline{2pt} @@ -991,17 +929,13 @@ default justification, and \Option{olines} aligns at the outside edge. 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}% +\EndIndexGroup \begin{Declaration} -\Option{automark}\\ -\Option{manualmark} + \Option{automark}% + \Option{manualmark} \end{Declaration}% -\BeginIndex{Option}{automark}% -\BeginIndex{Option}{manualmark}% \BeginIndex{}{headings>automatic}% \BeginIndex{}{headings>manual}% These options set at the beginning of the document whether to use running @@ -1017,10 +951,10 @@ preserved. \documentclass{scrreprt} \usepackage{scrpage2} \end{lstcode} - Since the default page style of \Class{scrreprt} is \Pagestyle{plain}, - this page style is also now still active. Futhermore, \Pagestyle{plain} + Since the default page style of \Class{scrreprt} is \PageStyle{plain}, + this page style is also now still active. Futhermore, \PageStyle{plain} means manual headings. If one now activates the page style - \Pagestyle{scrheadings} with + \PageStyle{scrheadings} with \begin{lstcode} \pagestyle{scrheadings} \end{lstcode} @@ -1031,9 +965,9 @@ preserved. \documentclass{scrbook} \usepackage{scrpage2} \end{lstcode} - the page style \Pagestyle{headings} is active and the running headings are + the page style \PageStyle{headings} is active and the running headings are updated automatically. Switching to the page style - \Pagestyle{scrheadings} keeps this setting active. The marking commands + \PageStyle{scrheadings} keeps this setting active. The marking commands of \Class{scrbook} continue to be used. However, the use of @@ -1041,57 +975,51 @@ preserved. \usepackage[automark]{scrpage2} \end{lstcode} activates running headings independently of the used document class. - The option does not of course affect the used page style \Pagestyle{plain} + The option does not of course affect the used page style \PageStyle{plain} of the class \Class{scrreprt}. The headings are not visible until the page style is changed to - \Pagestyle{scrheadings}\IndexPagestyle{scrheadings}, \Pagestyle{useheadings} + \PageStyle{scrheadings}\IndexPagestyle{scrheadings}, \PageStyle{useheadings} or another user-defined page style with headings.% \end{Example}% -\EndIndex{Option}{automark}\EndIndex{Option}{manualmark}% +\EndIndexGroup + \begin{Declaration} \Option{autooneside} \end{Declaration}% -\BeginIndex{Option}{autooneside}% +\BeginIndex{}{headings>manual}% +\BeginIndex{}{headings>automatic}% This option ensures that the optional parameter of -\Macro{automark}\IndexCmd{automark} will be ignored automatically in +\DescRef{scrpage-en.cmd.automark}\IndexCmd{automark} will be ignored automatically in one-sided mode. See also the explanation of the command -\Macro{automark} in \autoref{sec:scrpage-en.basics.mark}, -\autopageref{desc:scrpage-en.cmd.automark}.% +\DescRef{scrpage-en.cmd.automark} in \autoref{sec:scrpage-en.basics.mark}, +\DescPageRef{scrpage-en.cmd.automark}.% % -\EndIndex{Option}{autooneside}% -% -\EndIndex{}{headings>manual}% -\EndIndex{}{headings>automatic}% +\EndIndexGroup \begin{Declaration} - \Option{komastyle}\\ + \Option{komastyle}% \Option{standardstyle} \end{Declaration}% -\BeginIndex{Option}{komastyle}% -\BeginIndex{Option}{standardstyle}% These options determine the look of the predefined page styles -\Pagestyle{scrheadings} and \Pagestyle{scrplain}. The option +\PageStyle{scrheadings} and \PageStyle{scrplain}. 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} +\DescRef{scrpage-en.option.markuppercase} will be activated automatically, but only if +option \DescRef{scrpage-en.option.markusedcase} is not given.% +\EndIndexGroup \begin{Declaration} -\Option{markuppercase}\\ -\Option{markusedcase} + \Option{markuppercase}% + \Option{markusedcase} \end{Declaration}% -\BeginIndex{Option}{markuppercase}% -\BeginIndex{Option}{markusedcase}% -In order to achieve the functionality of \Macro{automark}, the package +In order to achieve the functionality of \DescRef{scrpage-en.cmd.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 @@ -1104,22 +1032,21 @@ uppercase letters, then the option \Option{markusedcase} should be given. These\textnote{Attention!} 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} +\EndIndexGroup \begin{Declaration} \Option{nouppercase} \end{Declaration}% -\BeginIndex{Option}{nouppercase}% -In the previous paragraph dealing with \Option{markuppercase} and -\Option{markusedcase}, it has been already stated that some document classes +In the previous paragraph dealing with \DescRef{scrpage-en.option.markuppercase} and +\DescRef{scrpage-en.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}\IndexCmd{MakeUppercase}\important{\Macro{MakeUppercase}} or \Macro{uppercase}\IndexCmd{uppercase}\important{\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 \Pagestyle{scrheadings} and its +defined by \Package{scrpage2}, including \PageStyle{scrheadings} and its corresponding plain page style. The applied method is very brutal and can cause that desired changes @@ -1135,8 +1062,8 @@ not occur. Since these cases do not occur frequently, the option \usepackage[nouppercase]{scrpage2} \pagestyle{scrheadings} \end{lstcode} - The selection of the page style \Pagestyle{scrheadings} is necessary, - since otherwise the page style \Pagestyle{headings} is active, which + The selection of the page style \PageStyle{scrheadings} is necessary, + since otherwise the page style \PageStyle{headings} is active, which does not respect the settings made by option \Option{nouppercase}. \end{Example} @@ -1145,15 +1072,13 @@ headings in uppercase letters. Also in these cases the option \Option{nouppercase} should be able to switch back to the normal mixed case headings.% % -\EndIndex{Option}{nouppercase} +\EndIndexGroup \section{Defining Own Page Styles}\label{sec:scrpage-en.UI} -% -% + \subsection{The Interface for Beginners}\label{sec:scrpage-en.UI.user} % \deftripstyle -\BeginIndex{Cmd}{deftripstyle}\Index{page>style} 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 @@ -1161,10 +1086,10 @@ 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} + \Macro{deftripstyle}\Parameter{name}% + \OParameter{LO}\OParameter{LI}% + \Parameter{HI}\Parameter{HC}\Parameter{HO}% + \Parameter{FI}\Parameter{FC}\Parameter{FO} \end{Declaration}% The individual parameters have the following meanings: \begin{labeling}[\,--]{\PName{Name}} @@ -1266,13 +1191,12 @@ below header and footer can take place. \typeout{^^J--- Don't ignore underfull and overfull \string\hbox:^^J} \end{figure} \end{Example} -\EndIndex{Cmd}{deftripstyle} +\EndIndexGroup \subsection{The Interface for Experts}\label{sec:scrpage-en.UI.expert} % \defpagestyle \newpagestyle \providepagestyle \renewpagestyle -\Index{page>style} -Simple page styles, as they can be defined with \Macro{deftripstyle}, +Simple page styles, as they can be defined with \DescRef{scrpage-en.cmd.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 @@ -1280,13 +1204,11 @@ financial accounting emerges in the page footer. No problem, the solution is: % \begin{Declaration} -\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} + \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}% -\BeginIndex{Cmd}{defpagestyle}\BeginIndex{Cmd}{newpagestyle}% -\BeginIndex{Cmd}{renewpagestyle}\BeginIndex{Cmd}{providepagestyle}% These four commands give full access to the capabilities of \Package{scrpage2} to define page styles. Their structure is indentical, they differ only in the manner of working. @@ -1332,7 +1254,7 @@ structure. The individual parameters have the following meanings: If the optional line-parameters are omitted, then the line behaviour remains configurable by the commands introduced in \autoref{sec:scrpage-en.basics.format}, -\autopageref{desc:scrpage-en.cmd.setheadtopline}. +\DescPageRef{scrpage-en.cmd.setheadtopline}. 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 @@ -1363,10 +1285,10 @@ example. \begin{Example} 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 + \Package{scrpage2} is loaded with options \DescRef{scrpage-en.option.automark} and + \DescRef{scrpage-en.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 \Pagestyle{scrheadings} + between header and text body is drawn in the \PageStyle{scrheadings} page style. \begin{lstcode} @@ -1409,13 +1331,13 @@ example. \end{lstcode} Right at the beginning of the document the page style - \Pagestyle{scrheadings} is activated. The command \Macro{chapter} starts + \PageStyle{scrheadings} is activated. The command \Macro{chapter} starts a new chapter and automatically sets the page rstyle for this page to - \Pagestyle{plain}. Even though not a prime example, the command - \Macro{chead} shows how running headings can be created even on a + \PageStyle{plain}. Even though not a prime example, the command + \DescRef{scrpage-en.cmd.chead} shows how running headings can be created even on a plain page. However, in principle running headings on chapter start-pages are to be avoided, since otherwise the special - character of the \Pagestyle{plain} page style is lost. It is more + character of the \PageStyle{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. @@ -1437,7 +1359,7 @@ example. Every System has an extensive state quantity]{10,9} \end{XmpTopPage} - After starting a new page the page style \Pagestyle{scrheadings} is + After starting a new page the page style \PageStyle{scrheadings} is active and thus the separation line below the header is visible. \begin{lstcode} There is a state quatity of a system, called entropy, whose temporal @@ -1453,11 +1375,11 @@ example. \end{XmpTopPage} After switching to the next page, the automatic update of the running - headings is disabled using \Macro{manualmark}, and the page style + headings is disabled using \DescRef{scrpage-en.cmd.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}. + because \Package{scrpage2} was called with \DescRef{scrpage-en.option.headsepline}. \begin{lstcode} \manualmark \pagestyle{withoutLines} @@ -1496,8 +1418,7 @@ example. \[ B = U + T (S_1 - S_u) - p (V_1 - V_u)\] ]{20,20} \end{XmpTopPage} \end{Example} -\EndIndex{Cmd}{defpagestyle}\EndIndex{Cmd}{newpagestyle} -\EndIndex{Cmd}{renewpagestyle}\EndIndex{Cmd}{providepagestyle} +\EndIndexGroup \subsection{Managing Page Styles}\label{sec:scrpage-en.UI.cfgFile} @@ -1511,7 +1432,8 @@ time-consuming copy operations each time a new project is started, initialisation. This file can contain a set of user-defined page styles which many projects can share. \EndIndex{File}{scrpage.cfg} -\EndIndex{Package}{scrpage2} +\EndIndexGroup + % ============================================================================ @@ -1539,7 +1461,9 @@ styles which many projects can share. \chapter{Kopf- und Fußzeilen mit \Package{scrpage2}} \labelbase{scrpage-de} % +\BeginIndexGroup \BeginIndex{Package}{scrpage2}% +\BeginIndex{}{Seitenstil} Mit \KOMAScript~3.12 wurde das komplett neu implementierte Paket \Package{scrlayer-scrpage} vorgestellt, das eine konsequente Weiterführung des Designs von \Package{scrpage2} mit anderen Mitteln darstellt. Siehe dazu das @@ -1571,17 +1495,17 @@ Entwicklungsresourcen im Bereich Kopf- und Fußzeilen werden zukünftig in \begin{Explain} Um die nachfolgende Beschreibung zu verstehen, muss noch einiges zu \LaTeX{} gesagt werden. Im \LaTeX-Kern sind die Standardseitenstile - \Pagestyle{empty}, welcher eine völlig undekorierte Seite erzeugt, und - \Pagestyle{plain}, welcher meist nur die Seitenzahl enthält, definiert. In - vielen Klassen ist der Stil \Pagestyle{headings} zu finden, welcher eine + \PageStyle{empty}, welcher eine völlig undekorierte Seite erzeugt, und + \PageStyle{plain}, welcher meist nur die Seitenzahl enthält, definiert. In + vielen Klassen ist der Stil \PageStyle{headings} zu finden, welcher eine komplexe Seitendekoration mit automatischen Kolumnentitel\Index{Kolumnentitel>automatisch} erzeugt. Die Variante - \Pagestyle{myheadings} gleicht \Pagestyle{headings}. Die Kolumnentitel + \PageStyle{myheadings} gleicht \PageStyle{headings}. Die Kolumnentitel müssen dabei aber manuell\Index{Kolumnentitel>manuell} gesetzt werden. Ausführlicher wird das im Abschnitt über Seitenstile der \KOMAScript-Anleitung beschrieben. Dort wird auch erläutert, dass auf einigen Seiten der Seitenstil automatisch -- in der Regel zu - \Pagestyle{plain} -- wechselt. + \PageStyle{plain} -- wechselt. \end{Explain} Das Paket \Package{scrpage2} unterscheidet nicht mehr zwischen Seitenstilen @@ -1600,83 +1524,62 @@ vordefinierte, konfigurierbare Seitenstile. % \headmark \pagemark \begin{Declaration} - \Pagestyle{scrheadings}\\ - \Pagestyle{scrplain} + \PageStyle{scrheadings}% + \PageStyle{scrplain} \end{Declaration}% -\BeginIndex{Pagestyle}{scrheadings}% -\BeginIndex{Pagestyle}{scrplain}% -\Index{Seiten>Stil}% Das Paket \Package{scrpage2} liefert für Seiten mit Kolumnentitel einen -eigenen Seitenstil namens \Pagestyle{scrheadings}. Dieser Seitenstil kann +eigenen Seitenstil namens \PageStyle{scrheadings}. Dieser Seitenstil kann mittels \Macro{pagestyle}\PParameter{scrheadings} aktiviert werden. Wird dieser Seitenstil benutzt, dann wird gleichzeitig der plain-Stil durch den -dazu passenden Stil \Pagestyle{scrplain} ersetzt. Passend bedeutet, dass auch +dazu passenden Stil \PageStyle{scrplain} ersetzt. Passend bedeutet, dass auch der plain-Stil auf in \autoref{sec:scrpage-de.basics.format} vorgestellte Befehle, die beispielsweise die Kopfbreite ändern, reagiert und im Grundlayout -übereinstimmt. Die Aktivierung des Seitenstils \Pagestyle{scrheadings} oder -des zugehörigen plain-Stils, \Pagestyle{scrplain}, hat keine Auswirkung +übereinstimmt. Die Aktivierung des Seitenstils \PageStyle{scrheadings} oder +des zugehörigen plain-Stils, \PageStyle{scrplain}, hat keine Auswirkung darauf, ob mit manuellen oder automatischen Kolumnentiteln\Index{Kolumnentitel>automatisch}\Index{Kolumnentitel>manuell} gearbeitet wird (siehe \autoref{sec:scrpage-de.basics.mark}). Der Seitenstil -\Pagestyle{scrplain} kann auch direkt per \Macro{pagestyle} aktiviert werden. +\PageStyle{scrplain} kann auch direkt per \Macro{pagestyle} aktiviert werden. \begin{Declaration} \Macro{lehead}% - \OParameter{scrplain-links-gerade}\Parameter{scrheadings-links-gerade}\\ + \OParameter{scrplain-links-gerade}\Parameter{scrheadings-links-gerade}% \Macro{cehead}% - \OParameter{scrplain-mittig-gerade}\Parameter{scrheadings-mittig-gerade}\\ + \OParameter{scrplain-mittig-gerade}\Parameter{scrheadings-mittig-gerade}% \Macro{rehead}% - \OParameter{scrplain-rechts-gerade}\Parameter{scrheadings-rechts-gerade}\\ + \OParameter{scrplain-rechts-gerade}\Parameter{scrheadings-rechts-gerade}% \Macro{lefoot}% - \OParameter{scrplain-links-gerade}\Parameter{scrheadings-links-gerade}\\ + \OParameter{scrplain-links-gerade}\Parameter{scrheadings-links-gerade}% \Macro{cefoot}% - \OParameter{scrplain-mittig-gerade}\Parameter{scrheadings-mittig-gerade}\\ + \OParameter{scrplain-mittig-gerade}\Parameter{scrheadings-mittig-gerade}% \Macro{refoot}% - \OParameter{scrplain-rechts-gerade}\Parameter{scrheadings-rechts-gerade}\\ + \OParameter{scrplain-rechts-gerade}\Parameter{scrheadings-rechts-gerade}% \Macro{lohead}% - \OParameter{scrplain-links-ungerade}\Parameter{scrheadings-links-ungerade}\\ + \OParameter{scrplain-links-ungerade}\Parameter{scrheadings-links-ungerade}% \Macro{cohead}% - \OParameter{scrplain-mittig-ungerade}\Parameter{scrheadings-mittig-ungerade}\\ + \OParameter{scrplain-mittig-ungerade}\Parameter{scrheadings-mittig-ungerade}% \Macro{rohead}% - \OParameter{scrplain-rechts-ungerade}\Parameter{scrheadings-rechts-ungerade}\\ + \OParameter{scrplain-rechts-ungerade}\Parameter{scrheadings-rechts-ungerade}% \Macro{lofoot}% - \OParameter{scrplain-links-ungerade}\Parameter{scrheadings-links-ungerade}\\ + \OParameter{scrplain-links-ungerade}\Parameter{scrheadings-links-ungerade}% \Macro{cofoot}% - \OParameter{scrplain-mittig-ungerade}\Parameter{scrheadings-mittig-ungerade}\\ + \OParameter{scrplain-mittig-ungerade}\Parameter{scrheadings-mittig-ungerade}% \Macro{rofoot}% - \OParameter{scrplain-rechts-ungerade}\Parameter{scrheadings-rechts-ungerade}\\ + \OParameter{scrplain-rechts-ungerade}\Parameter{scrheadings-rechts-ungerade}% \Macro{ihead}% - \OParameter{scrplain-innen}\Parameter{scrheadings-innen}\\ + \OParameter{scrplain-innen}\Parameter{scrheadings-innen}% \Macro{chead}% - \OParameter{scrplain-zentriert}\Parameter{scrheadings-zentriert}\\ + \OParameter{scrplain-zentriert}\Parameter{scrheadings-zentriert}% \Macro{ohead}% - \OParameter{scrplain-außen}\Parameter{scrheadings-außen}\\ + \OParameter{scrplain-außen}\Parameter{scrheadings-außen}% \Macro{ifoot}% - \OParameter{scrplain-innen}\Parameter{scrheadings-innen}\\ + \OParameter{scrplain-innen}\Parameter{scrheadings-innen}% \Macro{cfoot}% - \OParameter{scrplain-zentriert}\Parameter{scrheadings-zentriert}\\ + \OParameter{scrplain-zentriert}\Parameter{scrheadings-zentriert}% \Macro{ofoot}% \OParameter{scrplain-außen}\Parameter{scrheadings-außen} \end{Declaration}% -\BeginIndex{Cmd}{lehead}% -\BeginIndex{Cmd}{cehead}% -\BeginIndex{Cmd}{rehead}% -\BeginIndex{Cmd}{ihead}% -\BeginIndex{Cmd}{chead}% -\BeginIndex{Cmd}{ohead}% -\BeginIndex{Cmd}{lohead}% -\BeginIndex{Cmd}{cohead}% -\BeginIndex{Cmd}{rohead}% -\BeginIndex{Cmd}{lefoot}% -\BeginIndex{Cmd}{cefoot}% -\BeginIndex{Cmd}{refoot}% -\BeginIndex{Cmd}{ifoot}% -\BeginIndex{Cmd}{cfoot}% -\BeginIndex{Cmd}{rfoot}% -\BeginIndex{Cmd}{lofoot}% -\BeginIndex{Cmd}{cofoot}% -\BeginIndex{Cmd}{rofoot}% Die Seitenstile von \Package{scrpage2} sind so definiert, dass ihr Kopf und Fuß flexibel angepasst werden kann. Hierzu sind sowohl im Kopf als auch im Fuß drei Felder vorhanden, deren Inhalt modifiziert werden kann. Die Befehle @@ -1685,8 +1588,8 @@ in der Mitte dargestellten Befehle modifizieren sowohl die Felder der linken als auch der rechten Seite. Alle Befehle haben sowohl ein optionales als auch ein obligatorisches Argument. Das optionale Argument bestimmt jeweils das durch den Befehl festgelegte Feld im plain-Seitenstil, -\Pagestyle{scrplain}. Das obligatorische Argument definiert das entsprechende -Feld im Seitenstil \Pagestyle{scrheadings}. +\PageStyle{scrplain}. Das obligatorische Argument definiert das entsprechende +Feld im Seitenstil \PageStyle{scrheadings}. \begin{figure} % \centering @@ -1695,7 +1598,7 @@ Feld im Seitenstil \Pagestyle{scrheadings}. [Befehle zur Manipulation der \Package{scrpage2}-Seitenstile]% {\hspace{0pt plus 1ex}% Zuord\-nung der Befehle zur Manipulation der beiden Seiten\-stile - \Pagestyle{scrheadings} und \Pagestyle{scrplain} zu den Feldern im + \PageStyle{scrheadings} und \PageStyle{scrplain} zu den Feldern im Kopf und Fuß der Seiten} [l] \setlength{\unitlength}{.95mm}\begin{picture}(100,65)(0,8)\small @@ -1720,50 +1623,50 @@ Feld im Seitenstil \Pagestyle{scrheadings}. % die Befehle und Pfeile % für beidseitig % - \put(50,65){\makebox(0,0){\Macro{ihead}}} + \put(50,65){\makebox(0,0){\DescRef{scrpage-de.cmd.ihead}}} \put(44,65){\vector(-1,0){4}}\put(56,65){\vector(1,0){4}} - \put(50,58){\makebox(0,0){\Macro{chead}}} + \put(50,58){\makebox(0,0){\DescRef{scrpage-de.cmd.chead}}} \put(44,58){\line(-1,0){24}}\put(56,58){\line(1,0){24}} \put(20,58){\vector(0,1){4}}\put(80,58){\vector(0,1){4}} - \put(50,51){\makebox(0,0){\Macro{ohead}}} + \put(50,51){\makebox(0,0){\DescRef{scrpage-de.cmd.ohead}}} \put(44,51){\line(-1,0){40}}\put(56,51){\line(1,0){40}} \put(4,51){\vector(0,1){11}}\put(96,51){\vector(0,1){11}} % - \put(50,15){\makebox(0,0){\Macro{ifoot}}} + \put(50,15){\makebox(0,0){\DescRef{scrpage-de.cmd.ifoot}}} \put(56,15){\vector(1,0){4}}\put(44,15){\vector(-1,0){4}} - \put(50,22){\makebox(0,0){\Macro{cfoot}}} + \put(50,22){\makebox(0,0){\DescRef{scrpage-de.cmd.cfoot}}} \put(44,22){\line(-1,0){24}}\put(56,22){\line(1,0){24}} \put(20,22){\vector(0,-1){4}}\put(80,22){\vector(0,-1){4}} - \put(50,29){\makebox(0,0){\Macro{ofoot}}} + \put(50,29){\makebox(0,0){\DescRef{scrpage-de.cmd.ofoot}}} \put(44,29){\line(-1,0){40}}\put(56,29){\line(1,0){40}} \put(4,29){\vector(0,-1){11}}\put(96,29){\vector(0,-1){11}} % Befehle für einseitig - \put(5,69){\makebox(0,0)[b]{\Macro{lehead}}} - \put(20,69){\makebox(0,0)[b]{\Macro{cehead}}} - \put(35,69){\makebox(0,0)[b]{\Macro{rehead}}} + \put(5,69){\makebox(0,0)[b]{\DescRef{scrpage-de.cmd.lehead}}} + \put(20,69){\makebox(0,0)[b]{\DescRef{scrpage-de.cmd.cehead}}} + \put(35,69){\makebox(0,0)[b]{\DescRef{scrpage-de.cmd.rehead}}} % - \put(65,69){\makebox(0,0)[b]{\Macro{lohead}}} - \put(80,69){\makebox(0,0)[b]{\Macro{cohead}}} - \put(95,69){\makebox(0,0)[b]{\Macro{rohead}}} + \put(65,69){\makebox(0,0)[b]{\DescRef{scrpage-de.cmd.lohead}}} + \put(80,69){\makebox(0,0)[b]{\DescRef{scrpage-de.cmd.cohead}}} + \put(95,69){\makebox(0,0)[b]{\DescRef{scrpage-de.cmd.rohead}}} % - \put(5,11){\makebox(0,0)[t]{\Macro{lefoot}}} - \put(20,11){\makebox(0,0)[t]{\Macro{cefoot}}} - \put(35,11){\makebox(0,0)[t]{\Macro{refoot}}} + \put(5,11){\makebox(0,0)[t]{\DescRef{scrpage-de.cmd.lefoot}}} + \put(20,11){\makebox(0,0)[t]{\DescRef{scrpage-de.cmd.cefoot}}} + \put(35,11){\makebox(0,0)[t]{\DescRef{scrpage-de.cmd.refoot}}} % - \put(65,11){\makebox(0,0)[t]{\Macro{lofoot}}} - \put(80,11){\makebox(0,0)[t]{\Macro{cofoot}}} - \put(95,11){\makebox(0,0)[t]{\Macro{rofoot}}} + \put(65,11){\makebox(0,0)[t]{\DescRef{scrpage-de.cmd.lofoot}}} + \put(80,11){\makebox(0,0)[t]{\DescRef{scrpage-de.cmd.cofoot}}} + \put(95,11){\makebox(0,0)[t]{\DescRef{scrpage-de.cmd.rofoot}}} \end{picture} \end{captionbeside} % \caption[Befehle zur Manipulation der \Package{scrpage2}-Seitenstile]% % {Zuordnung der Befehle zur Manipulation der Seitenstile -% \Pagestyle{scrheadings} und \Pagestyle{scrplain} zu den manipulierten +% \PageStyle{scrheadings} und \PageStyle{scrplain} zu den manipulierten % Seitenelementen} \label{fig:scrpage-de.leheadetall} \end{figure} \begin{Example} - Angenommen, man möchte bei \Pagestyle{scrheadings} zentriert im Seitenfuß + Angenommen, man möchte bei \PageStyle{scrheadings} zentriert im Seitenfuß die Seitenzahl dargestellt haben, dann benutzt man einfach: \begin{lstcode} \cfoot{\pagemark} @@ -1797,39 +1700,35 @@ anspruchsvollere Vorhaben genutzt werden. besprochen wird. \end{Example} -Wie oben dargestellt, gibt es einen zu \Pagestyle{scrheadings} +Wie oben dargestellt, gibt es einen zu \PageStyle{scrheadings} korrespondierenden plain-Seitenstil. Da es auch möglich sein soll, diesen Stil anzupassen, unterstüt"-zen die Befehle ein optionales Argument. Damit kann der Inhalt des entsprechenden Feldes im plain-Seitenstil modifiziert werden. \begin{Example} - Um für die Nutzung von \Pagestyle{scrheadings} die Position der Seitenzahlen + Um für die Nutzung von \PageStyle{scrheadings} die Position der Seitenzahlen festzulegen, kann man folgendes benutzen: \begin{lstcode} \cfoot[\pagemark]{} \ohead[]{\pagemark} \end{lstcode} - Wird anschließend der Stil \Pagestyle{plain} genutzt, beispielsweise weil + Wird anschließend der Stil \PageStyle{plain} genutzt, beispielsweise weil \Macro{chapter} eine neue Seite beginnt und darauf umschaltet, dann steht die Seitenzahl zentriert im Seitenfuß. \end{Example} % -\EndIndex{Pagestyle}{scrheadings}% -\EndIndex{Pagestyle}{scrplain}% +\EndIndexGroup % Die folgende Deklaration und Erklaerung wurde eingefuegt von % mjk 2001-08-18 \begin{Declaration} - \Macro{clearscrheadings}\\ - \Macro{clearscrplain}\\ + \Macro{clearscrheadings}% + \Macro{clearscrplain}% \Macro{clearscrheadfoot} \end{Declaration}% -\BeginIndex{Cmd}{clearscrheadings}% -\BeginIndex{Cmd}{clearscrplain}% -\BeginIndex{Cmd}{clearscrheadfoot}% -Will man sowohl den Seitenstil \Pagestyle{scrheadings} als auch den dazu +Will man sowohl den Seitenstil \PageStyle{scrheadings} als auch den dazu gehörenden plain-Seitenstil von Grund auf neu definieren, muss man häufig zusätzlich einige der bereits belegten Seitenelemente löschen. Da man selten alle Elemente mit neuem Inhalt füllt, sind @@ -1837,7 +1736,7 @@ dazu in den meisten Fällen mehrere Befehle mit leeren Parametern notwendig. Mit Hilfe dieser drei Befehle ist das Löschen schnell und gründlich möglich. Während \Macro{clearscrheadings} lediglich alle -Felder des Seitenstils \Pagestyle{scrheadings} und \Macro{clearscrplain} +Felder des Seitenstils \PageStyle{scrheadings} und \Macro{clearscrplain} alle Felder des zugehörigen plain-Seitenstils löscht, werden von \Macro{clearscrheadfoot} alle Felder beider Seitenstile auf leere Inhalte gesetzt. @@ -1865,16 +1764,10 @@ Inhalte gesetzt. konkreten Vorbelegung ausginge. \end{Example} % -\EndIndex{Cmd}{clearscrheadings}% -\EndIndex{Cmd}{clearscrplain}% -\EndIndex{Cmd}{clearscrheadfoot}% +\EndIndexGroup % -\EndIndex{Cmd}{lehead}\EndIndex{Cmd}{cehead}\EndIndex{Cmd}{rehead}% -\EndIndex{Cmd}{ihead}\EndIndex{Cmd}{chead}\EndIndex{Cmd}{ohead}% -\EndIndex{Cmd}{lohead}\EndIndex{Cmd}{cohead}\EndIndex{Cmd}{rohead}% -\EndIndex{Cmd}{lefoot}\EndIndex{Cmd}{cefoot}\EndIndex{Cmd}{refoot}% -\EndIndex{Cmd}{ifoot}\EndIndex{Cmd}{cfoot}\EndIndex{Cmd}{rfoot}% -\EndIndex{Cmd}{lofoot}\EndIndex{Cmd}{cofoot}\EndIndex{Cmd}{rofoot}% +\EndIndexGroup + % Satz leicht geaendert: mjk 2001-08-18 In den vorausgehenden Beispielen wurden schon zwei Befehle benutzt, die noch @@ -1883,11 +1776,9 @@ gar nicht besprochen wurden. Das soll jetzt nachgeholt werden. % Die folgende Deklaration und Erklaerung wurde eingefuegt von % mjk 2001-08-17 \begin{Declaration} - \Macro{leftmark}\\ + \Macro{leftmark}% \Macro{rightmark} \end{Declaration}% -\BeginIndex{Cmd}{leftmark}% -\BeginIndex{Cmd}{rightmark}% Diese beiden Befehle erlauben es, auf die Kolumnentitel zuzugreifen, die normalerweise für die linke bzw. die rechte Seite gedacht sind. Diese beiden Befehle werden nicht von \Package{scrpage2}, sondern direkt vom \LaTeX-Kern @@ -1895,74 +1786,70 @@ zur Verfügung gestellt. Wenn in diesem Kapitel vom Kolumnentitel der linken Seite oder vom Kolumnentitel der rechten Seite die Rede ist, dann ist damit eigentlich der Inhalt von \Macro{leftmark} und \Macro{rightmark} gemeint. % -\EndIndex{Cmd}{leftmark}% -\EndIndex{Cmd}{rightmark}% +\EndIndexGroup \begin{Declaration} \Macro{headmark} \end{Declaration}% -\BeginIndex{Cmd}{headmark}% Dieser Befehl ermöglicht es, auf die Inhalte der Kolumnentitel zuzugreifen. Im Gegensatz zu den originalen \LaTeX{}-Befehlen \Macro{leftmark} und \Macro{rightmark} braucht man nicht auf die richtige Zuordnung zur linken oder rechten Seite zu achten.% % -\EndIndex{Cmd}{headmark} +\EndIndexGroup \begin{Declaration} \Macro{pagemark} \end{Declaration}% -\BeginIndex{Cmd}{pagemark}% Dieser Befehl ermöglicht den Zugriff auf die Seitenzahl. Im -\autoref{sec:scrpage-de.basics.format}, \autopageref{desc:scrpage-de.cmd.pnumfont} -wird der Befehl \Macro{pnumfont} zur Formatierung der Seitenzahl vorgestellt, +\autoref{sec:scrpage-de.basics.format}, \DescPageRef{scrpage-de.cmd.pnumfont} +wird der Befehl \DescRef{scrpage-de.cmd.pnumfont} zur Formatierung der Seitenzahl vorgestellt, den \Macro{pagemark} automatisch berücksichtigt.% % -\EndIndex{Cmd}{pagemark} +\EndIndexGroup \begin{Declaration} - \Pagestyle{useheadings} + \PageStyle{useheadings} \end{Declaration}% -\BeginIndex{Pagestyle}{useheadings}% Das Paket \Package{scrpage2} ist in erster Linie dafür gedacht, dass die bereitgestellten Stile benutzt oder eigene Stile definiert werden. Jedoch kann es notwendig sein, auch auf einen von der Dokumentklasse zur Verfügung gestellten Stil zurückzuschalten. Es wäre nahe liegend, dieses mit \Macro{pagestyle}\PParameter{headings} vorzunehmen. Das hätte aber den -Nachteil, dass die nachfolgend besprochenen Befehle \Macro{automark} und -\Macro{manualmark} nicht wie erwartet funktionierten. Daher sollte mit +Nachteil, dass die nachfolgend besprochenen Befehle \DescRef{scrpage-de.cmd.automark} und +\DescRef{scrpage-de.cmd.manualmark} nicht wie erwartet funktionierten. Daher sollte mit \Macro{pagestyle}\PParameter{useheadings}\IndexCmd{pagestyle} auf die originalen Stile umgeschaltet werden. Eine solche Umschaltung hat dann keine Auswirkung darauf, ob mit manuellen oder automatischen Kolumnentiteln gearbeitet wird.% % -\EndIndex{Pagestyle}{useheadings} +\EndIndexGroup \subsection{Manuelle und automatische Kolumnentitel} \label{sec:scrpage-de.basics.mark} % \automark \manualmark % +\BeginIndexGroup \BeginIndex{}{Kolumnentitel>automatisch}% \BeginIndex{}{Kolumnentitel>manuell}% -Gewöhnlich\textnote{Achtung!} gibt es zu einem \Pagestyle{headings}-Stil eine +Gewöhnlich\textnote{Achtung!} gibt es zu einem \PageStyle{headings}-Stil eine \emph{my}-Variante. Ist ein solcher Stil aktiv, dann werden die Kolumnentitel nicht mehr automatisch aktualisiert. Bei \Package{scrpage2} wird ein anderer Weg beschritten. Ob die Kolumnentitel lebend sind oder nicht, bestimmen die -Befehle \Macro{automark} und \Macro{manualmark}. Die Voreinstellung kann auch -bereits beim Laden des Paketes über die Optionen \Option{automark} und -\Option{manualmark} beeinflusst werden (siehe +Befehle \DescRef{scrpage-de.cmd.automark} und \DescRef{scrpage-de.cmd.manualmark}. Die Voreinstellung kann auch +bereits beim Laden des Paketes über die Optionen \DescRef{scrpage-de.option.automark} und +\DescRef{scrpage-de.option.manualmark} beeinflusst werden (siehe \autoref{sec:scrpage-de.basics.options}, -\autopageref{desc:scrpage-de.option.automark}). +\DescPageRef{scrpage-de.option.automark}). \begin{Declaration} \Macro{manualmark} \end{Declaration}% -\BeginIndex{Cmd}{manualmark}% Wie der Name bereits verdeutlicht, schaltet \Macro{manualmark} die Aktualisierung der Kolumnentitel aus. Es bleibt somit dem Nutzer überlassen, für eine Aktualisierung bzw. für den Inhalt der Kolumnentitel zu sorgen. Dazu @@ -1971,14 +1858,13 @@ stehen die Befehle \Macro{markboth}\IndexCmd{markboth} und Anweisungen sind im Abschnitt über Seitenstile in der \KOMAScript-Anleitung erklärt.% % -\EndIndex{Cmd}{manualmark} +\EndIndexGroup % Ergaenzt mjk 2001-07-17 \begin{Declaration} \Macro{automark}\OParameter{rechte Seite}\Parameter{linke Seite} \end{Declaration}% -\BeginIndex{Cmd}{automark}% Die Anweisung \Macro{automark} aktiviert die automatische Aktualisierung des Kolumnentitels. Für die beiden Parameter sind die Bezeichnungen der Gliederungsebenen\Index{Gliederungsebenen} einzusetzen, deren Titel an @@ -1991,15 +1877,15 @@ nur von den \KOMAScript-Klassen ab Version~2.9s bekannt, dass dieser Wert unterstützt wird. Das optionale Argument \PName{rechte Seite} ist ver\-ständlicherweise nur für zweiseitigen Satz gedacht. Im einseitigen Satz sollten Sie normalerweise darauf verzichten. Mit Hilfe der Option -\Option{autooneside}\IndexOption{autooneside}\important{\Option{autooneside}} +\DescRef{scrpage-de.option.autooneside}\IndexOption{autooneside}\important{\DescRef{scrpage-de.option.autooneside}} können Sie auch einstellen, dass das optionale Argument im einseitigen\Index{einseitig} Satz automatisch ignoriert wird (siehe \autoref{sec:scrpage-de.basics.options}, -\autopageref{desc:scrpage-de.option.autooneside}). +\DescPageRef{scrpage-de.option.autooneside}). \begin{Example} Wird beispielsweise mit einer \emph{book}-Klasse gearbeitet, deren höch\-ste Gliederungsebene \emph{chapter} ist, dann stellt nach einem vorhergehenden - \Macro{manualmark} der Befehl + \DescRef{scrpage-de.cmd.manualmark} der Befehl \begin{lstcode} \automark[section]{chapter} \end{lstcode} @@ -2021,9 +1907,8 @@ einseitigen\Index{einseitig} Satz automatisch ignoriert wird (siehe definiert. Obwohl sie nicht als internes Makro definiert ist, wird von einem direkten Gebrauch abgeraten. \end{Explain} -\EndIndex{Cmd}{automark} -\EndIndex{}{Kolumnentitel>automatisch}% -\EndIndex{}{Kolumnentitel>manuell}% +\EndIndexGroup +\EndIndexGroup \subsection{Formatierung der Kopf- und Fußzeilen} @@ -2037,13 +1922,10 @@ befriedigen. Deshalb soll es sich in diesem Abschnitt ausschließlich darum drehen. \begin{Declaration} - \Macro{headfont}\\ - \Macro{footfont}\\ + \Macro{headfont}% + \Macro{footfont}% \Macro{pnumfont} \end{Declaration}% -\BeginIndex{Cmd}{headfont}% -\BeginIndex{Cmd}{footfont}% -\BeginIndex{Cmd}{pnumfont}% Die Schriftformatierung für den Seitenkopf und -fuß übernimmt der Befehl \Macro{headfont}, \Macro{footfont} die Abweichung davon für den Fuß und \Macro{pnumfont} wiederum die Abweichung davon für die Seitenzahl. @@ -2060,11 +1942,8 @@ Die Schriftformatierung für den Seitenkopf und -fuß übernimmt der Befehl \normalfont\rmfamily\slshape} \end{lstcode} \end{Example} -\EndIndex{Cmd}{pnumfont}% -\EndIndex{Cmd}{footfont}% -\EndIndex{Cmd}{headfont}% - +\BeginIndexGroup \BeginIndex{FontElement}{pagehead}% \BeginIndex{FontElement}{pagefoot}% \BeginIndex{FontElement}{pagenumber}% @@ -2085,17 +1964,14 @@ wie sie in der \KOMAScript-Anleitung beschrieben wird. \normalfont\rmfamily\slshape} \end{lstcode} \end{Example} -\EndIndex{FontElement}{pagenumber}% -\EndIndex{FontElement}{pagefoot}% -\EndIndex{FontElement}{pagehead}% +\EndIndexGroup +\EndIndexGroup \begin{Declaration} -\Macro{setheadwidth}\OParameter{Verschiebung}\Parameter{Breite}\\ +\Macro{setheadwidth}\OParameter{Verschiebung}\Parameter{Breite}% \Macro{setfootwidth}\OParameter{Verschiebung}\Parameter{Breite} \end{Declaration}% -\BeginIndex{Cmd}{setheadwidth}% -\BeginIndex{Cmd}{setfootwidth}% Normalerweise entsprechen die Breiten von Kopf- und Fußzeile der Breite des Textbereichs.\Index{Kopf>Breite}\Index{Fuss=Fuß>Breite} Die beiden Befehle \Macro{setheadwidth} und \Macro{setfootwidth} ermöglichen dem Anwender, auf @@ -2178,28 +2054,26 @@ der der aktuellen Seitengestalt entspricht. Wie zu sehen, ist der Kopf jetzt nach innen verschoben, wobei die Kopfbreite sich nicht geändert hat. Die Verschiebung ist so berechnet, dass die Seitenproportionen auch hier sichtbar werden. -\EndIndex{Cmd}{setheadwidth}\EndIndex{Cmd}{setfootwidth} +\EndIndexGroup \begin{Declaration} \Macro{setheadtopline}\OParameter{Länge}\Parameter{Dicke}% - \OParameter{Anweisungen}\\ + \OParameter{Anweisungen}% \Macro{setheadsepline}\OParameter{Länge}\Parameter{Dicke}% - \OParameter{Anweisungen}\\ + \OParameter{Anweisungen}% \Macro{setfootsepline}\OParameter{Länge}\Parameter{Dicke}% - \OParameter{Anweisungen}\\ + \OParameter{Anweisungen}% \Macro{setfootbotline}\OParameter{Länge}\Parameter{Dicke}% \OParameter{Anweisungen} \end{Declaration}% -\BeginIndex{Cmd}{setheadtopline}\BeginIndex{Cmd}{setheadsepline}% -\BeginIndex{Cmd}{setfootsepline}\BeginIndex{Cmd}{setfootbotline}% Entsprechend den Größenparametern für die Kopf- und Fußzeile gibt es auch Befehle, die die Dimensionen der Linien im Kopf und Fuß modifizieren können. Dazu sollten diese Linien aber zunächst erst einmal eingeschaltet -werden. Siehe hierzu die Optionen \Option{headtopline}, \Option{headsepline}, -\Option{footsepline}, \Option{footbotline} in +werden. Siehe hierzu die Optionen \DescRef{scrpage-de.option.headtopline}, \DescRef{scrpage-de.option.headsepline}, +\DescRef{scrpage-de.option.footsepline}, \DescRef{scrpage-de.option.footbotline} in \autoref{sec:scrpage-de.basics.options}, -\autopageref{desc:scrpage-de.option.headsepline}. +\DescPageRef{scrpage-de.option.headsepline}. \begin{labeling}[\ --]{\Macro{setfootsepline}} \item[\Macro{setheadtopline}] modifiziert die Parameter für die Linie @@ -2214,7 +2088,7 @@ unter dem Seitenfuß Das obligatorische Argument \PName{Dicke} bestimmt, wie stark die Linie gezeichnet wird. Das optionale Argument \PName{Länge} akzeptiert die gleichen -symbolischen Werte wie \PName{Breite} bei \Macro{setheadwidth}, also auch einen +symbolischen Werte wie \PName{Breite} bei \DescRef{scrpage-de.cmd.setheadwidth}, also auch einen normalen Längenausdruck. Solange im Dokument dem optionalen Argument \PName{Länge} kein Wert zugewiesen wurde, passt sich die entsprechende Linienlänge automatisch der Breite des Kopfes bzw. des Fußes an. @@ -2243,12 +2117,17 @@ gesetzt und mit \Macro{addtokomafont}\IndexCmd{addtokomafont} erweitert werden. Die beiden Anweisungen \Macro{setkomafont} und \Macro{addtokomafont} sind in der \KOMAScript-Anleitung näher beschrieben. + \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{} + \labelsuffix[auto+current]% + \Macro{setheadtopline}\POParameter{auto} + \PParameter{current}% + \labelsuffix[auto] + \Macro{setheadtopline}\POParameter{auto}\Parameter{}% + \labelsuffix[auto+] + \Macro{setheadtopline}\POParameter{auto}\Parameter{}\OParameter{} \end{Declaration}% -Die hier am Befehl \Macro{setheadtopline} illustrierten Argumente +Die hier am Befehl \DescRef{scrpage-de.cmd.setheadtopline} illustrierten Argumente sind natürlich auch für die anderen drei Längenbefehle gültig. Enthält das obligatorische Argument den Wert \PValue{current} oder wird @@ -2270,7 +2149,7 @@ Anweisungen wieder gelöscht. \setheadsepline{.4pt} \end{lstcode} Zusätzlich\textnote{Achtung!} sind unbedingt die Optionen -\Option{headtopline} und \Option{headsepline} vorzugsweise global im +\DescRef{scrpage-de.option.headtopline} und \DescRef{scrpage-de.option.headsepline} vorzugsweise global im optionalen Argument von \Macro{documentclass} zu setzen. Das Ergebnis könnte dann wie folgt aussehen. % @@ -2304,7 +2183,7 @@ dann wie folgt aussehen. verwendet werden. Die automatische Anpassung an die Kopf- und Fußbreiten illustriert folgendes - Beispiel, für das die Optionen \Option{footbotline} und \Option{footsepline} + Beispiel, für das die Optionen \DescRef{scrpage-de.option.footbotline} und \DescRef{scrpage-de.option.footsepline} gesetzt sein sollten: \begin{lstcode} \setfootbotline{2pt} @@ -2329,8 +2208,8 @@ linksbündig zum Text ist. Diese Einstellung kann nur global in Form einer Paketoption erfolgen und wird im folgenden \autoref{sec:scrpage-de.basics.options} mit anderen Optionen beschrieben.% % -\EndIndex{Cmd}{setheadtopline}\EndIndex{Cmd}{setheadsepline}% -\EndIndex{Cmd}{setfootsepline}\EndIndex{Cmd}{setfootbotline}% +\EndIndexGroup +\EndIndexGroup \subsection{Optionen beim Laden des Paketes} @@ -2349,13 +2228,11 @@ im optionalen Argument von \Macro{usepackage}, angegeben werden. % markuppercase markusecase % automark manualmark \begin{Declaration} -\Option{headinclude}\\ -\Option{headexclude}\\ -\Option{footinclude}\\ -\Option{footexclude} + \Option{headinclude}% + \Option{headexclude}% + \Option{footinclude}% + \Option{footexclude} \end{Declaration}% -\BeginIndex{Option}{headinclude}\BeginIndex{Option}{footinclude}% -\BeginIndex{Option}{headexclude}\BeginIndex{Option}{footexclude}% Diese\textnote{Achtung!} Optionen sollten bei Verwendung von \KOMAScript~3\ChangedAt{v2.3}{\Package{scrpage2}} nicht mehr beispielsweise per optionalem Argument von \Macro{usepackage} oder per @@ -2365,29 +2242,24 @@ werden. Lediglich aus Gründen der Kompatibilität sind sie noch in \OptionValue{headinclude}{false}, \Option{footinclude} und \OptionValue{footinclude}{false} an das Paket \Package{typearea} weitergereicht. -\EndIndex{Option}{headinclude}\EndIndex{Option}{footinclude}% -\EndIndex{Option}{headexclude}\EndIndex{Option}{footexclude} +\EndIndexGroup \begin{Declaration} -\Option{headtopline}\\ -\Option{plainheadtopline}\\ -\Option{headsepline}\\ -\Option{plainheadsepline}\\ -\Option{footsepline}\\ -\Option{plainfootsepline}\\ -\Option{footbotline}\\ -\Option{plainfootbotline} + \Option{headtopline}% + \Option{plainheadtopline}% + \Option{headsepline}% + \Option{plainheadsepline}% + \Option{footsepline}% + \Option{plainfootsepline}% + \Option{footbotline}% + \Option{plainfootbotline} \end{Declaration}% -\BeginIndex{Option}{headtopline}\BeginIndex{Option}{plainheadtopline}% -\BeginIndex{Option}{headsepline}\BeginIndex{Option}{plainheadsepline}% -\BeginIndex{Option}{footsepline}\BeginIndex{Option}{plainfootsepline}% -\BeginIndex{Option}{footbotline}\BeginIndex{Option}{plainfootbotline}% Eine Grundeinstellung für die Linien unter und über den Kopf- und Fußzeilen kann mit diesen Optionen vorgenommen werden. Diese Einstellungen gelten dann als Standard für alle mit \Package{scrpage2} definierten Seitenstile. Wird eine von diesen Optionen verwendet, dann wird eine Linienstärke von 0,4\,pt -eingesetzt. Da es zum Seitenstil \Pagestyle{scrheadings} einen entsprechenden +eingesetzt. Da es zum Seitenstil \PageStyle{scrheadings} einen entsprechenden plain-Stil gibt, kann mit den \Option{plain\dots}-Optionen auch die entsprechende Linie des plain-Stils konfiguriert werden. Diese \Option{plain}-Optionen wirken aber nur, wenn auch die korrespondierende @@ -2404,24 +2276,18 @@ Die\textnote{Achtung!} Bedingungen für die Optionen des vorhergehenden Abschnitts gelten auch für diesen Automatismus. Das bedeutet, dass das Paket \Package{typearea} nach \Package{scrpage2} geladen werden muss, beziehungsweise, dass bei Verwendung einer \KOMAScript{}-Klasse die Optionen -\Option{headinclude} und \Option{footinclude} explizit bei +\DescRef{scrpage-de.option.headinclude} und \DescRef{scrpage-de.option.footinclude} explizit bei \Macro{documentclass} gesetzt werden müssen, um Kopf- bzw. Fußzeile in den Textblock zu übernehmen.% % -\EndIndex{Option}{headtopline}\EndIndex{Option}{plainheadtopline}% -\EndIndex{Option}{headsepline}\EndIndex{Option}{plainheadsepline}% -\EndIndex{Option}{footsepline}\EndIndex{Option}{plainfootsepline}% -\EndIndex{Option}{footbotline}\EndIndex{Option}{plainfootbotline}% +\EndIndexGroup \begin{Declaration} -\Option{ilines}\\ -\Option{clines}\\ -\Option{olines} + \Option{ilines}% + \Option{clines}% + \Option{olines} \end{Declaration}% -\BeginIndex{Option}{ilines}% -\BeginIndex{Option}{clines}% -\BeginIndex{Option}{olines}% \Index{Linienausrichtung}% Bei der Festlegung der Linienlängen kann es vorkommen, dass die Linie zwar die gewünschte Länge, aber nicht die erwünschte Ausrichtung hat, da sie im Kopf- @@ -2433,7 +2299,7 @@ verhält sich wie die Standardeinstellung und \Option{olines} richtet am äußeren Rand aus. \begin{Example} - Hier gilt es, das Beispiel zu \Macro{setfootsepline} auf + Hier gilt es, das Beispiel zu \DescRef{scrpage-de.cmd.setfootsepline} auf \autopageref{page:scrpage-de.autoLineLength} mit dem folgenden zu vergleichen, um die Wirkung der Option \Option{ilines} zu sehen. \begin{lstcode} @@ -2459,16 +2325,14 @@ verhält sich wie die Standardeinstellung und \Option{olines} richtet am Die Trennlinie zwischen Text und Fuß wird bündig innen im Fußteil gesetzt und nicht wie bei der Standardeinstellung zentriert. \end{Example} -\EndIndex{Option}{ilines}\EndIndex{Option}{clines}\EndIndex{Option}{olines} +\EndIndexGroup % \phantomsection für hyperref-\pageref-Link jum-2001/11/24 \begin{Declaration} -\Option{automark}\\ -\Option{manualmark} + \Option{automark}% + \Option{manualmark} \end{Declaration}% -\BeginIndex{Option}{automark}% -\BeginIndex{Option}{manualmark}% \BeginIndex{}{Kolumnentitel>automatisch}% \BeginIndex{}{Kolumnentitel>manuell}% Diese Optionen bestimmen gleich zu Beginn des Dokuments, ob eine automatische @@ -2487,14 +2351,14 @@ erhalten, die beim Laden des Paketes gültig war. \documentclass{scrreprt} \usepackage{scrpage2} \end{lstcode} - Da bei \Class{scrreprt} der Seitenstil \Pagestyle{plain} voreingestellt + Da bei \Class{scrreprt} der Seitenstil \PageStyle{plain} voreingestellt ist, ist dies auch jetzt noch der Fall. Außerdem entspricht die - Voreinstellung \Pagestyle{plain} manuellen Kolumnentiteln. Wenn Sie + Voreinstellung \PageStyle{plain} manuellen Kolumnentiteln. Wenn Sie also anschließend mit \begin{lstcode} \pagestyle{scrheadings} \end{lstcode} - auf den Seitenstil \Pagestyle{scrheadings} umschalten, sind noch immer + auf den Seitenstil \PageStyle{scrheadings} umschalten, sind noch immer manuelle Kolumnentitel eingestellt. Verwenden Sie stattdessen die Dokumentklasse \Class{scrbook}, so @@ -2503,9 +2367,9 @@ erhalten, die beim Laden des Paketes gültig war. \documentclass{scrbook} \usepackage{scrpage2} \end{lstcode} - der Seitenstil \Pagestyle{headings} mit automatischen Kolumnentiteln + der Seitenstil \PageStyle{headings} mit automatischen Kolumnentiteln aktiviert. Bei anschließender Umschaltung auf den Seitenstil - \Pagestyle{scrheadings} bleiben automatische Kolumnentitel + \PageStyle{scrheadings} bleiben automatische Kolumnentitel eingeschaltet. Dabei werden dann weiterhin die Markierungsmakros von \Class{scrbook} verwendet. @@ -2517,13 +2381,13 @@ erhalten, die beim Laden des Paketes gültig war. Kolumnentitel umgeschaltet, wobei die Markierungsmakros von \Package{scrpage2} genutzt werden. Natürlich wirkt sich dies auf den Seitenstil - \Pagestyle{plain} von \Class{scrreprt} nicht aus. Die Kolumnentitel + \PageStyle{plain} von \Class{scrreprt} nicht aus. Die Kolumnentitel werden erst sichtbar, wenn auf den Seitenstil - \Pagestyle{scrheadings}\IndexPagestyle{scrheadings} oder - \Pagestyle{useheadings} oder einen selbst definierten Seitenstil mit + \PageStyle{scrheadings}\IndexPagestyle{scrheadings} oder + \PageStyle{useheadings} oder einen selbst definierten Seitenstil mit Kolumnentiteln umgeschaltet wird. \end{Example} -\EndIndex{Option}{automark}\EndIndex{Option}{manualmark}% +\EndIndexGroup % Folgende Deklaration und Erklaerung wurde eingefügt von @@ -2531,27 +2395,23 @@ erhalten, die beim Laden des Paketes gültig war. \begin{Declaration} \Option{autooneside} \end{Declaration}% -\BeginIndex{Option}{autooneside}% +\BeginIndex{}{Kolumnentitel>automatisch}% +\BeginIndex{}{Kolumnentitel>manuell}% Mit dieser Option wird das optionale Argument von -\Macro{automark}\IndexCmd{automark}\Index{Kolumnentitel>automatisch} im +\DescRef{scrpage-de.cmd.automark}\IndexCmd{automark}\Index{Kolumnentitel>automatisch} im einseitigen Satz automatisch ignoriert. Siehe hierzu auch die Erläuterung -zum Befehl \Macro{automark} in \autoref{sec:scrpage-de.basics.mark}, -\autopageref{desc:scrpage-de.cmd.automark}.% -% -\EndIndex{Option}{autooneside}% +zum Befehl \DescRef{scrpage-de.cmd.automark} in \autoref{sec:scrpage-de.basics.mark}, +\DescPageRef{scrpage-de.cmd.automark}.% % -\EndIndex{}{Kolumnentitel>automatisch}% -\EndIndex{}{Kolumnentitel>manuell}% +\EndIndexGroup \begin{Declaration} -\Option{komastyle}\\ -\Option{standardstyle} + \Option{komastyle}% + \Option{standardstyle} \end{Declaration}% -\BeginIndex{Option}{komastyle}% -\BeginIndex{Option}{standardstyle}% Diese Optionen bestimmen, wie die beiden vordefinierten Seitenstile -\Pagestyle{scrheadings} und \Pagestyle{scrplain} gestaltet sind. +\PageStyle{scrheadings} und \PageStyle{scrplain} gestaltet sind. Bei \Option{komastyle} wird eine Definition vorgenommen, wie sie den \KOMAScript{}-Klassen entspricht. Bei den \KOMAScript{}-Klassen ist dies die Voreinstellung und @@ -2559,19 +2419,16 @@ kann somit auch für andere Klassen gesetzt werden. Die Option \Option{standardstyle} definiert die beiden Seitenstile wie es von den Standardklassen erwartet wird. -Außerdem wird hier automatisch \Option{markuppercase} aktiviert, -es sei denn, \Option{markusedcase} wird ebenfalls als Option übergeben.% -\EndIndex{Option}{komastyle}% -\EndIndex{Option}{standardstyle} +Außerdem wird hier automatisch \DescRef{scrpage-de.option.markuppercase} aktiviert, +es sei denn, \DescRef{scrpage-de.option.markusedcase} wird ebenfalls als Option übergeben.% +\EndIndexGroup \begin{Declaration} -\Option{markuppercase}\\ -\Option{markusedcase} + \Option{markuppercase}% + \Option{markusedcase} \end{Declaration}% -\BeginIndex{Option}{markuppercase}% -\BeginIndex{Option}{markusedcase}% -Für die Funktionalität von \Macro{automark} modifiziert +Für die Funktionalität von \DescRef{scrpage-de.cmd.automark} modifiziert \Package{scrpage2} interne Befehle, die die Gliederungsbefehle benutzen, um die lebenden Kolumnentitel zu setzen. Da einige Klassen, im Gegensatz @@ -2586,15 +2443,15 @@ verwendet. Die\textnote{Achtung!} Optionen sind nicht geeignet, eine entsprechende Darstellung zu erzwingen. Es kann somit zu unerwünschten Effekten kommen, wenn die Angabe nicht dem Verhalten der Dokumentklasse entspricht.% -\EndIndex{Option}{markuppercase}\EndIndex{Option}{markusedcase} +\EndIndexGroup + % Die folgende Deklaration und Erklaerung wurde eingefuegt von % mjk 2001-08-18 \begin{Declaration} \Option{nouppercase} \end{Declaration}% -\BeginIndex{Option}{nouppercase}% -Wie in obiger Erklärung zu \Option{markuppercase} und \Option{markusedcase} +Wie in obiger Erklärung zu \DescRef{scrpage-de.option.markuppercase} und \DescRef{scrpage-de.option.markusedcase} bereits ausgeführt wurde, gibt es Klassen und auch Pakete, die beim Setzen der lebenden Kolumnentitel\Index{Kolumnentitel>automatisch} mit Hilfe einer der Anweisungen \Macro{uppercase}\IndexCmd{uppercase}\important{\Macro{uppercase}} @@ -2603,7 +2460,7 @@ oder den gesamten Eintrag in Großbuchstaben wandeln. Mit der Option \Option{nouppercase} können diese beiden Anweisungen im Kopf und im Fuß außer Kraft gesetzt werden. Das gilt aber nur für Seitenstile, die mit Hilfe von -\Package{scrpage2} definiert werden. Dazu zählen auch \Pagestyle{scrheadings} +\Package{scrpage2} definiert werden. Dazu zählen auch \PageStyle{scrheadings} und der zugehörige plain-Seitenstil. Die verwendete Methode ist äußerst brutal und kann dazu führen, dass @@ -2621,8 +2478,8 @@ meist eine brauchbare Lösung dar. \usepackage[nouppercase]{scrpage2} \pagestyle{scrheadings} \end{lstcode} - Die Umschaltung auf den Seitenstil \Pagestyle{scrheadings} ist - notwendig, weil sonst der Seitenstil \Pagestyle{headings} verwendet + Die Umschaltung auf den Seitenstil \PageStyle{scrheadings} ist + notwendig, weil sonst der Seitenstil \PageStyle{headings} verwendet wird, der von der Option \Option{nouppercase} nicht behandelt wird. \end{Example} @@ -2631,7 +2488,7 @@ lebende Kolumnentitel in Großbuchstaben. Auch in diesen Fällen hilft \Option{nouppercase} meist, um zu gemischter Schreibweise zurückzuschalten.% % -\EndIndex{Option}{nouppercase} +\EndIndexGroup \section{Seitenstile selbst gestalten}\label{sec:scrpage-de.UI} @@ -2640,19 +2497,17 @@ zurückzuschalten.% \subsection{Die Anwenderschnittstelle}\label{sec:scrpage-de.UI.user} % \deftripstyle -\Index{Seiten>Stil}% Nun möchte man ja nicht immer an die vorgegebenen Seitenstile gebunden sein, sondern auch seiner Kreativität freien Lauf lassen. Manchmal ist man auch dazu gezwungen, weil eine bestimmte \emph{Corporate Identity} einer Firma es verlangt. Der einfachste Weg damit umzugehen ist \begin{Declaration} -\Macro{deftripstyle}\Parameter{Name}% -\OParameter{LA}\OParameter{LI}% -\Parameter{KI}\Parameter{KM}\Parameter{KA}% -\Parameter{FI}\Parameter{FM}\Parameter{FA} + \Macro{deftripstyle}\Parameter{Name}% + \OParameter{LA}\OParameter{LI}% + \Parameter{KI}\Parameter{KM}\Parameter{KA}% + \Parameter{FI}\Parameter{FM}\Parameter{FA} \end{Declaration}% -\BeginIndex{Cmd}{deftripstyle}% Die einzelnen Felder haben folgende Bedeutung: \begin{labeling}[~--]{\PName{Name}} \item[\PName{Name}] die Bezeichnung des Seitenstils, die dann bei der @@ -2750,28 +2605,23 @@ Seitenstil keine Änderung der Kopf- und Fußlinien erfolgen kann. \typeout{^^J--- Don't ignore underfull and overfull \string\hbox:^^J}% \end{figure} \end{Example} -\EndIndex{Cmd}{deftripstyle} +\EndIndexGroup \subsection{Die Expertenschnittstelle}\label{sec:scrpage-de.UI.expert} % \defpagestyle \newpagestyle \providepagestyle \renewpagestyle -\Index{Seiten>Stil}% -Einfache Seitenstile, wie sie mit \Macro{deftripstyle} deklariert +Einfache Seitenstile, wie sie mit \DescRef{scrpage-de.cmd.deftripstyle} deklariert werden können, sind erfahrungsgemäß selten. Entweder verlangt ein Professor, dass die Diplomarbeit so aussieht wie seine eigene -- und wer will ihm da \emph{ernsthaft} widersprechen -- oder eine Firma möchte, dass die halbe Finanzbuchhaltung im Seitenfuß auf"|taucht. Alles kein Problem, denn es gibt noch: \begin{Declaration} -\Macro{defpagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition}\\ -\Macro{newpagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition}\\ -\Macro{renewpagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition}\\ -\Macro{providepagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition} + \Macro{defpagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition}% + \Macro{newpagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition}% + \Macro{renewpagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition}% + \Macro{providepagestyle}\Parameter{Name}\Parameter{Kopfdefinition}\Parameter{Fußdefinition} \end{Declaration}% -\BeginIndex{Cmd}{defpagestyle}% -\BeginIndex{Cmd}{newpagestyle}% -\BeginIndex{Cmd}{renewpagestyle}% -\BeginIndex{Cmd}{providepagestyle}% Dies sind die Befehle, die die volle Kontrolle über die Gestaltung eines Seitenstils ermöglichen. Der Aufbau ist bei allen vier Definitionen gleich, sie unterscheiden sich nur hinsichtlich @@ -2817,7 +2667,7 @@ einzelnen Parameter haben folgende Bedeutung: Werden die optionalen Linienargumente nicht gesetzt, dann bleibt das Verhalten weiterhin durch die in \autoref{sec:scrpage-de.basics.format}, -\autopageref{desc:scrpage-de.cmd.setheadtopline} vorgestellten Linienbefehle +\DescPageRef{scrpage-de.cmd.setheadtopline} vorgestellten Linienbefehle konfigurierbar. Die drei Felder \PName{GS}, \PName{US} und \PName{ES} entsprechen Boxen, die @@ -2849,7 +2699,7 @@ anderen Befehlen von \Package{scrpage2} nun als abschließendes Beispiel. Angenommen es wird die Dokumentklasse \Class{scrbook} genutzt. Damit liegt ein zweiseitiges Layout vor. Für das Paket \Package{scrpage2} wird festgelegt, dass mit automatisch aktualisierten Kolumnentiteln gearbeitet - wird und dass im Seitenstil \Pagestyle{scrheadings} eine Trennlinie zwischen + wird und dass im Seitenstil \PageStyle{scrheadings} eine Trennlinie zwischen Kopf und Text gezogen wird. \begin{lstcode} @@ -2889,10 +2739,10 @@ anderen Befehlen von \Package{scrpage2} nun als abschließendes Beispiel. } \end{lstcode} - Gleich zu Beginn wird der Seitenstil \Pagestyle{scrheadings} aktiviert. Mit + Gleich zu Beginn wird der Seitenstil \PageStyle{scrheadings} aktiviert. Mit \Macro{chapter} wird ein neues Kapitel begonnen. Weiterhin wird automatisch - durch \Macro{chapter} der Seitenstil für diese Seite auf \Pagestyle{plain} - gesetzt. Das folgende \Macro{chead} zeigt, wie durch Modifikation des + durch \Macro{chapter} der Seitenstil für diese Seite auf \PageStyle{plain} + gesetzt. Das folgende \DescRef{scrpage-de.cmd.chead} zeigt, wie durch Modifikation des plain-Stils ein Kolumnentitel erzeugt werden kann. Grundsätzlich sollte jedoch davon Abstand genommen werden, da sonst der Markierungscharakter der plain-Seite verloren geht. Es ist wichtiger anzuzeigen, dass hier ein neues @@ -2918,7 +2768,7 @@ anderen Befehlen von \Package{scrpage2} nun als abschließendes Beispiel. \linebreak]{10,9} \end{XmpTopPage} - Nach dem Seitenwechsel ist der Seitenstil \Pagestyle{scrheadings} + Nach dem Seitenwechsel ist der Seitenstil \PageStyle{scrheadings} aktiv, und somit auch die Trennlinie aus den Paketoptionen sichtbar. \begin{lstcode} Es existiert eine Zustandsgröße, genannt die @@ -2940,7 +2790,7 @@ anderen Befehlen von \Package{scrpage2} nun als abschließendes Beispiel. und der Seitenstil \PValue{ohneLinien} aktiviert. Da keine Linienargumente bei der Definition dieses Stils genutzt wurden, wird die Standard-Linien\-konfiguration verwendet. Diese zeichnet hier eine Linie - zwischen Kopf und Text, da \Option{headsepline} als Argument für + zwischen Kopf und Text, da \DescRef{scrpage-de.option.headsepline} als Argument für \Package{scrpage2} angegeben wurde.% \begin{lstcode} \manualmark @@ -2980,8 +2830,8 @@ anderen Befehlen von \Package{scrpage2} nun als abschließendes Beispiel. \vspace{-.5ex}\[ B = U + T (S_1 - S_u) - p (V_1 - V_u)\] ]{20,21} \end{XmpTopPage} \end{Example} -\EndIndex{Cmd}{defpagestyle}\EndIndex{Cmd}{newpagestyle} -\EndIndex{Cmd}{renewpagestyle}\EndIndex{Cmd}{providepagestyle} +\EndIndexGroup + \subsection{Seitenstile verwalten}\label{sec:scrpage-de.UI.cfgFile} % scrpage.cfg @@ -2995,7 +2845,8 @@ am Ende seiner Initialisierungsphase die Datei \File{scrpage.cfg} ein. In dieser Datei können dann Seitenstile definiert sein, die viele Projekte gemeinsam nutzen können. \EndIndex{File}{scrpage.cfg} -\EndIndex{Package}{scrpage2} +% +\EndIndexGroup \end{document} |