summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex63
1 files changed, 43 insertions, 20 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
index 65baf33bf8a..d0730d85b30 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
@@ -46,13 +46,13 @@
% ============================================================================
\KOMAProvidesFile{scrbookreportarticle.tex}
- [$Date: 2015-05-11 09:45:36 +0200 (Mon, 11 May 2015) $
+ [$Date: 2015-06-15 13:41:43 +0200 (Mon, 15 Jun 2015) $
KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm\and
Krickette Murabayashi\and Jana Schubert\and Jens H\"uhne}
-% Date of translated german file: 2015-05-11
+% Date of translated german file: 2015-06-15
\chapter{The Main Classes: \Class{scrbook}, \Class{scrreprt}, and
\Class{scrartcl}}
@@ -1162,10 +1162,12 @@ the part. Because of this, \Class{scrartcl} does not support this option.
\begin{Declaration}
\KOption{chapterprefix}\PName{simple switch}\\
- \KOption{appendixprefix}\PName{simple switch}
+ \KOption{appendixprefix}\PName{simple switch}\\
+ \Macro{IfChapterUsesPrefixLine}\Parameter{then code}\Parameter{else code}
\end{Declaration}%
\BeginIndex{Option}{chapterprefix~=\PName{simple switch}}%
\BeginIndex{Option}{appendixprefix~=\PName{simple switch}}%
+\BeginIndex{Cmd}{IfChapterUsesPrefixLine}%
With\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} the standard classes
\Class{book} and \Class{report}, a chapter
title\Index[indexmain]{chapter>title} consists of a line with the word
@@ -1190,7 +1192,15 @@ of an appendix\Index{appendix} to be preceded by a line with ``Appendix''
followed by the appendix letter. This is achieved by using the
\Option{appendixprefix} option (see \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}). Since this results in an inconsistent
-document layout, I advise against using this option.
+document layout, I advise against using this option. Final consequence of
+using the option is, that \Macro{appendix} changes setting of option
+\Option{chapterprefix}.
+
+You\ChangedAt{v3.18}{\Class{scrbook}\and \Class{scrreprt}} can execute code
+depending on the current setting for the chapter preceding line using
+\Macro{IfChapterUsesPrefixLine}. If \Option{chapterprefix} is currently
+active, the \PName{then code} will be executed, otherwise the \PName{else
+ code}.
The font style of the chapter number line using
\OptionValue{chapterprefix}{true} or \OptionValue{appendixprefix}{true} may be
@@ -1205,6 +1215,7 @@ changed with element
\autoref{tab:maincls.structureElementsFont},
\autopageref{tab:maincls.structureElementsFont}).%
%
+\EndIndex{Cmd}{IfChapterUsesPrefixLine}%
\EndIndex{Option}{appendixprefix~=\PName{simple switch}}%
\EndIndex{Option}{chapterprefix~=\PName{simple switch}}%
@@ -2086,6 +2097,7 @@ You may also redefine this using \Macro{renewcommand} too.
\Macro{subparagraphformat}\\
\Macro{othersectionlevelsformat}\Parameter{sectioning
name}\Parameter{}\Parameter{counter output}\\
+ \Macro{IfUsePrefixLine}\Parameter{then code}\Parameter{else code}\\
\Macro{autodot}
\end{Declaration}%
\BeginIndex{Cmd}{partformat}\Index{part>number}%
@@ -2096,6 +2108,7 @@ You may also redefine this using \Macro{renewcommand} too.
\BeginIndex{Cmd}{paragraphformat}%
\BeginIndex{Cmd}{subparagraphformat}%
\BeginIndex{Cmd}{othersectionlevelsformat}\Index{section>number}%
+\BeginIndex{Cmd}{IfUsePrefixLine}%
\BeginIndex{Cmd}{autodot}%
{\KOMAScript} has added a further logical level on top of
\Macro{the\PName{sectioning name}} to the output of the sectioning
@@ -2134,15 +2147,24 @@ are used by the {\KOMAScript} classes:
\begin{lstcode}
\newcommand*{\partformat}{\partname~\thepart\autodot}
\newcommand*{\chapterformat}{%
- \chapappifchapterprefix{\ }\thechapter\autodot\enskip}
- \newcommand*{\sectionformat}{%
- \csname thesection\endcsname\autodot\enskip
- }%
+ \mbox{\chapappifchapterprefix{\nobreakspace}\thechapter
+ \autodot\IfUsePrefixLine{}{\enskip}}}
+ \newcommand*{\sectionformat}{\thesection\autodot\enskip}
\newcommand*{\othersectionlevelsformat}[3]{%
#3\autodot\enskip}
\end{lstcode}
The definitions of the lower levels correspond to
-\Macro{sectionformat}.
+\Macro{sectionformat}.
+
+Because\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}} of
+\Macro{IfUsePrefixLine} command \Macro{chapterformat} should not be used
+outside of \Macro{chapter}. \Macro{IfUsePrefixLine} is only valid inside
+section commands of \KOMAScript{}. In this case, it executes the \PName{then
+ code} if a prefix line for the number is used, but \PName{else code}
+otherwise.
+
+Do\textnote{Attention!} not forget to change \Macro{newcommand} into
+\Macro{renewcommand} if you like to re-define one of the commands.
\begin{Example}
Assume that when using \Macro{part} you do not want the word
@@ -2179,6 +2201,7 @@ The definitions of the lower levels correspond to
\end{Example}
%
\EndIndex{Cmd}{autodot}%
+\EndIndex{Cmd}{IfUsePrefixLine}%
\EndIndex{Cmd}{othersectionlevelsformat}%
\EndIndex{Cmd}{paragraphformat}%
\EndIndex{Cmd}{subparagraphformat}%
@@ -2255,17 +2278,17 @@ Since chapters only exist in the classes \Class{scrbook} and
\Macro{chaptermarkformat}, \Macro{sectionmarkformat}, or
\Macro{subsectionmarkformat}.
- Because\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
- \Class{scrartcl}} \KOMAScript{} provides additional commands
- \Macro{addchap} and \Macro{addsec} to make headings without numbers, there
- also exist corresponding commands for making the running heads of those.
- Please note\textnote{Attention!}, that the predefined \Macro{addchapmark}
- and \Macro{addsecmark} use \Macro{chaptermark} and \Macro{sectionmark} while
- they set counter \Counter{secnumdepth} to -1 locally. You should pay
- attention for this exspecially if you redefine \Macro{chaptermark} or
- \Macro{sectionmark} (see \Macro{ifnumbered} on
- \autopageref{desc:maincls.cmd.ifnumbered}) or you should also redefine
- \Macro{addchapmark} and \Macro{addsecmark} suitable.
+ Please note\textnote{Attention!}, the running heads of
+ \Macro{addchap}\IndexCmd{addchap} and \Macro{addsec}\IndexCmd{addsec} are
+ also based on \Macro{chaptermark} and \Macro{addsecmark} but locally set
+ counter \Counter{secnumdepth} to a value that makes chapters respectively
+ sections not numbered. You should pay attention for this especially if you
+ redefine \Macro{chaptermark} or \Macro{sectionmark} (see \Macro{ifnumbered}
+ on \autopageref{desc:maincls.cmd.ifnumbered}). The star variants
+ \Macro{addchap*} and \Macro{addsec*} use additional commands
+ \Macro{addchapmark} and \Macro{addsecmark} that are defined also basing on
+ \Macro{chaptermark} and \Macro{sectionmark} with local changes of
+ \Counter{secnumdepth}.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course there is no command
\Macro{chaptermark} or \Macro{chaptermarkformat} in