diff options
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.tex | 265 |
1 files changed, 149 insertions, 116 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 8a9866560bb..7d616a945e0 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 @@ -1,6 +1,6 @@ % ====================================================================== % scrbookreportarticle.tex -% Copyright (c) Markus Kohm, 2001-2014 +% Copyright (c) Markus Kohm, 2001-2015 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -18,7 +18,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % scrbookreportarticle.tex -% Copyright (c) Markus Kohm, 2001-2014 +% Copyright (c) Markus Kohm, 2001-2015 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -46,13 +46,13 @@ % ============================================================================ \KOMAProvidesFile{scrbookreportarticle.tex} - [$Date: 2014-12-22 08:58:28 +0100 (Mon, 22 Dec 2014) $ + [$Date: 2015-04-13 10:01:12 +0200 (Mon, 13 Apr 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: 2014-06-26 +% Date of translated german file: 2015-04-13 \chapter{The Main Classes: \Class{scrbook}, \Class{scrreprt}, and \Class{scrartcl}} @@ -155,10 +155,21 @@ hyphenation, optimizing page breaks, and the placement of tables and figures. this kind of vertical adjustment\Index{adjustment>vertical}. \end{Explain} -Using double-sided typesetting with option \Option{twoside} (see -\autoref{sec:typearea.options}, -\autopageref{desc:typearea.option.twoside}) switches on vertical -adjustment also. Alternatively, vertical adjustment may be switched on +Using double-sided typesetting with option +\Option{twoside}\IndexOption{twoside}\important{\Option{twoside}} (see +\autoref{sec:typearea.options}, \autopageref{desc:typearea.option.twoside}) or +two-column typesetting with option +\Option{twocolumn}\IndexOption{twocolumn}\important{\Option{twocolumn}} (see +\autopageref{desc:typearea.option.twocolumn}) switches on vertical adjustment +also. But\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}\and + \Class{scrartcl}} with compatibility selection to a \KOMAScript{} version +prior to 3.17 (see \autoref{sec:maincls.compatibilityOptions}, +\autopageref{desc:maincls.option.version}, option +\Option{version}\IndexOption{version}\important{\OptionValue{version}{3.17}}) +this is not the case, if you use \Macro{KOMAoption} or \Macro{KOMAoptions} to +change the setting of these options. + +Alternatively, vertical adjustment may be switched on at any time valid from the current page using \Macro{flushbottom}. \Macro{raggedbottom} would have the opposite effect, switching off vertical adjustment from the current page @@ -194,7 +205,7 @@ class.% \LoadCommon{14} %\section{Document Titles} \section{Abstract} -\label{sec:maincls.abstract} +\seclabel{abstract} \BeginIndex{}{summary}% \BeginIndex{}{abstract}% @@ -271,7 +282,7 @@ abstract should not be indented, this indent may be disabled using \section{Table of Contents} -\label{sec:maincls.toc} +\seclabel{toc} \BeginIndex{}{table of contents} The table of contents is normally set after the document title and an @@ -612,7 +623,7 @@ units required extra or less and then, as in the above example, use \section{Head and Foot Using Predefined Page Styles} -\label{sec:maincls.pagestyle} +\seclabel{pagestyle} \BeginIndex{}{page>style} One of the general characteristics of a document is the page style. In @@ -772,7 +783,7 @@ The default settings can be found in \end{table} % \begin{Example} - \leavevmode\phantomsection\label{sec:maincls.pagestyle.example}% + \leavevmode\phantomsection\exlabel{pagestyle}% Assume that you want to set header and footer in a smaller type size and in italics. However, the page number should not be set in italics but bold. Apart from the fact that the result will look @@ -1001,7 +1012,7 @@ the next page which {\TeX} outputs will have the number 1 in the style \LoadCommon{9}% \section{Footnotes} \section[Demarcation]{Demarcation\protect\OnlyAt{\Class{scrbook}}} -\label{sec:maincls.separation} +\seclabel{separation} \BeginIndex{}{front matter}% \BeginIndex{}{main matter}% @@ -1084,7 +1095,7 @@ the command \Macro{pagenumbering} from \autoref{sec:maincls.pagestyle}, \section{Structuring of Documents} -\label{sec:maincls.structure} +\seclabel{structure} Structuring of documents means to divide them into parts, chapters, sections, and several other structural elements. @@ -1094,65 +1105,55 @@ and several other structural elements. \end{Declaration}% \BeginIndex{Option}{open~=\PName{method}}% \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}% -\KOMAScript{} classes \Class{scrbook} and \Class{scrreprt} give you -the choice of where to start\Index{chapter>start} a new chapter with -double-sided printing. By default \Class{scrreprt} starts a new -chapter at the next page. This is like \PName{method} -\PValue{any}. However, \Class{scrbook} starts new chapters at the next -right-hand page. This is like \PName{method} \PValue{right} and is -usually used in books. But sometimes chapters should start at the -left-hand page of a double-page spread. This would be accomplished -with \PName{method} \PValue{left}\ChangedAt{v3.00}{\Class{scrbook}\and - \Class{scrreprt}}. An overview of the supported methods may be found -at \autoref{tab:maincls.open}. +\KOMAScript{} classes \Class{scrbook} and \Class{scrreprt} give you the choice +of where to start\Index{chapter>start} a new chapter with double-sided +printing. By default \Class{scrreprt} starts a new chapter at the next +page. This is like \PName{method} \PValue{any}. However, \Class{scrbook} +starts new chapters at the next right-hand page. This is like \PName{method} +\PValue{right} and is usually used in books. But sometimes chapters should +start at the left-hand page of a double-page spread. This would be +accomplished with \PName{method} +\PValue{left}\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}}. An +overview of the supported methods may be found at +\autoref{tab:maincls.open}. The table also describes the effect on +\Macro{cleardoublepage}, \Macro{cleardoublepageusingstyle}, +\Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, and +\Macro{cleardoubleemptypage} (see \autoref{sec:maincls.emptypage}, +\autopageref{desc:maincls.cmd.cleardoublepage}). \begin{table} \caption[{Available values for option \Option{open}}]{Available values for - option \Option{open} to select page breaks with interleaf pages} + option \Option{open} to select page breaks with interleaf pages using + \Class{scrbook} or \Class{scrreprt}} \begin{desctabular} - \pventry{any}{Commands - \Macro{cleardoublepageusingstyle}, - \Macro{cleardoublestandardpage}, - \Macro{cleardoubleplainpage}, - \Macro{cleardoubleemptypage}, - and - \Macro{cleardoublepage} - result in a single page break and therefor are same like - \Macro{clearpage}.% + \pventry{any}{% + Parts, chapter, index, and back matter use \Macro{clearpage} instead of + \Macro{cleardoublepage};% + \Macro{cleardoublepageusingstyle}, \Macro{cleardoublestandardpage}, + \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and + \Macro{cleardoublepage} behaves same like using + \OptionValue{open}{right}.% \IndexOption{open~=\PValue{any}}}% - \pventry{left}{Commands - \Macro{cleardoublepageusingstyle}, - \Macro{cleardoublestandardpage}, - \Macro{cleardoubleplainpage}, - \Macro{cleardoubleemptypage}, - and - \Macro{cleardoublepage} - result in a page break and add an interleaf page\Index{page>interleaf} - if needed to reach the next left-hand page.% + \pventry{left}{% + Part, chapter, index and back matter use \Macro{cleardoublepage};% + \Macro{cleardoublepageusingstyle}, \Macro{cleardoublestandardpage}, + \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and + \Macro{cleardoublepage} result in a page break and add an interleaf + page\Index{page>interleaf} if needed to reach the next left-hand page.% \IndexOption{open~=\PValue{left}}}% - \pventry{right}{Commands - \Macro{cleardoublepageusingstyle}, - \Macro{cleardoublestandardpage}, - \Macro{cleardoubleplainpage}, - \Macro{cleardoubleemptypage}, - and - \Macro{cleardoublepage} - result in a page break and add an interleaf page\Index{page>interleaf} - if needed to reach the next right-hand page.% + \pventry{right}{% + Part, chapter, index and back matter use \Macro{cleardoublepage};% + \Macro{cleardoublepageusingstyle}, \Macro{cleardoublestandardpage}, + \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and + \Macro{cleardoublepage} result in a page break and add an interleaf + page\Index{page>interleaf} if needed to reach the next right-hand page.% \IndexOption{open~=\PValue{right}}}% \end{desctabular} \label{tab:maincls.open} \end{table} -Besides the implicit usage of \Macro{cleardoublepage} at chapter -starts, the option influences also the explicit usage of the commands -\Macro{cleardoublepage}, \Macro{cleardoublepageusingstyle}, -\Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, and -\Macro{cleardoubleemptypage}. See \autoref{sec:maincls.pagestyle}, -\autopageref{desc:maincls.cmd.cleardoublepage} for more information -about these. Since \LaTeX{} does not differentiate between left-hand -and right-hand pages in single-sided printing, the option does not have -any influence in that case. +Since \LaTeX{} does not differentiate between left-hand and right-hand pages +in single-sided printing, the option does not have any influence in that case. In class \Class{scrartcl} the section is the first structural element below the part. Because of this, \Class{scrartcl} does not support this option. @@ -1226,7 +1227,16 @@ font size defined by the allow for smaller title font sizes. The font sizes for headings resulting from these options for \Class{scrbook} and \Class{scrreprt} are shown in \autoref{tab:maincls.structureElementsFont}, -\autopageref{tab:maincls.structureElementsFont}. For \Class{scrartcl}, smaller +\autopageref{tab:maincls.structureElementsFont}. Respectively, the fonts of +the elements \FontElement{chapter}\IndexFontElement{chapter}, +\FontElement{section}\IndexFontElement{section}, +\FontElement{subsection}\IndexFontElement{subsection}, +\FontElement{subsubsection}\IndexFontElement{subsubsection}, +\FontElement{paragraph}\IndexFontElement{paragraph}, and +\FontElement{subparagraph}\IndexFontElement{subparagraph} will be reset to +these default. + +For \Class{scrartcl}, smaller font sizes are generally used. \OnlyAt{\Class{scrbook}\and \Class{scrreprt}}The spacing before and after chapter titles is also influenced by these options. @@ -1301,6 +1311,10 @@ description of the structural commands. Chapter headings will be set like other headings too.% }% \pventry{openany}{% + The commands \Macro{cleardoublepageusingstyle}, + \Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, + \Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} behave same like + using \OptionValue{headings}{openright}.% Parts, chapter, index, and back matter use \Macro{clearpage} instead of \Macro{cleardoublepage}.% \IndexOption{headings~=\PValue{openany}}}% @@ -1309,16 +1323,16 @@ description of the structural commands. \Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} generate a page break and if needed insert an interleaf page to reach the next left-hand - page at double-page printing. Part, chapter, index and back matter use - \Macro{cleardoublepage}.% + page at double-page printing.% + Part, chapter, index and back matter use \Macro{cleardoublepage}.% \IndexOption{headings~=\PValue{openleft}}}% \pventry{openright}{% The commands \Macro{cleardoublepageusingstyle}, \Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} generate a page break and if needed insert an interleaf page to reach the next right-hand - page at double-page printing. Part, chapter, index and back matter use - \Macro{cleardoublepage}.% + page at double-page printing.% + Part, chapter, index and back matter use \Macro{cleardoublepage}.% \IndexOption{headings~=\PValue{openright}}}% \pventry{optiontohead}{% The\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and @@ -1356,8 +1370,8 @@ description of the structural commands. \entry{\PValue{twolinechapter}, \PValue{chapterprefix}, \PValue{chapterwithprefix}, \PValue{chapterwithprefixline}% \IndexOption{headings~=\PValue{twolinechapter}}}{% - Chapters will be set with a number line with the contents - of \Macro{chapterformat}\IndexCmd{chapterformat}.% + Chapters will be set with a number line with the contents of + \Macro{chapterformat}\IndexCmd{chapterformat}.% }% \end{desclist} % @@ -1671,7 +1685,7 @@ The default font size for the specific elements depends on the options structuring in \Class{scrbook} and \Class{scrreprt}}[l] \begin{tabular}[t]{lll} \toprule - class option & element & default\\ + Class Option & Element & Default\\ \midrule \OptionValue{headings}{big} & \FontElement{part}\IndexFontElement{part} @@ -2065,20 +2079,31 @@ You may also redefine this using \Macro{renewcommand} too. \begin{Declaration} \Macro{partformat}\\ \Macro{chapterformat}\\ + \Macro{sectionformat}\\ + \Macro{subsectionformat}\\ + \Macro{subsubsectionformat}\\ + \Macro{paragraphformat}\\ + \Macro{subparagraphformat}\\ \Macro{othersectionlevelsformat}\Parameter{sectioning name}\Parameter{}\Parameter{counter output}\\ \Macro{autodot} \end{Declaration}% \BeginIndex{Cmd}{partformat}\Index{part>number}% \BeginIndex{Cmd}{chapterformat}\Index{chapter>number}% +\BeginIndex{Cmd}{sectionformat}% +\BeginIndex{Cmd}{subsectionformat}% +\BeginIndex{Cmd}{subsubsectionformat}% +\BeginIndex{Cmd}{paragraphformat}% +\BeginIndex{Cmd}{subparagraphformat}% \BeginIndex{Cmd}{othersectionlevelsformat}\Index{section>number}% \BeginIndex{Cmd}{autodot}% {\KOMAScript} has added a further logical level on top of \Macro{the\PName{sectioning name}} to the output of the sectioning numbers. The counters for the respective heading are not merely output. They -are formatted using the commands \Macro{partformat}, \Macro{chapterformat}, -and the command \Macro{othersectionlevelsformat} that expect three -arguments. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course the command +are formatted using the commands \Macro{partformat}, \Macro{chapterformat} +down to \Macro{subparagraphformat}\ChangedAt{v3.17}{\Class{scrbook}\and + \Class{scrreprt}\and \Class{scrartcl}}. +\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course the command \Macro{chapterformat} like \Macro{thechapter} does not exist in the class \Class{scrartcl} but only in the classes \Class{scrbook} and \Class{scrreprt}. @@ -2086,25 +2111,22 @@ As described for option \Option{numbers}\important{\Option{numbers}} at the beginning of this section (see \autopageref{desc:maincls.option.numbers}), periods in section numbers should be handled for the German-speaking region according to the rules given in \cite{DUDEN}. The command \Macro{autodot} in -{\KOMAScript} ensures that these rules are being followed. In all levels +{\KOMAScript} ensures that these rules are followed. In all levels except for \Macro{part}, a dot is followed by a further \Macro{enskip}. This corresponds to a horizontal skip of 0.5\Unit{em}. -The command \Macro{othersectionlevelsformat} takes as first parameter the -name of the section level, such as \PValue{section}, -\PValue{subsection}, \PValue{subsection}, -\PValue{subsubsection}, \PValue{paragraph}, and \PValue{subparagraph}. The -third parameter should be the output of the corresponding counter, usually -\Macro{thesection}, \Macro{thesubsection}, \Macro{thesubsubsection}, -\Macro{theparagraph}, or \Macro{thesubparagraph}. - -Per default, therefore, only the levels -\Macro{part} and \Macro{chapter} have formatting commands of their -own, while all other section levels are covered by one general -formatting command. This has historical reasons. At the time that -Werner Lemberg suggested a suitable extension of {\KOMAScript} for his -\Package{CJK} package, only this differentiation was needed. Users should -ignore the third argument of \Macro{othersectionlevelsformat} completely. +Since \KOMAScript~3.17\ChangedAt{v3.17}{\Class{scrbook}\and + \Class{scrreprt}\and \Class{scrartcl}} the command +\Macro{othersectionlevelsformat} is used only in rare circumstances, i.\,e., +if the corresponding format command to a section command does not exist or is +\Macro{relax}. This should not happen for all section commands defined by +\KOMAScript{} itself. Therefore the command is not officially documented any +longer. Nevertheless, if a compatibility level prior to 3.17 (see option +\Option{version}, \autoref{sec:maincls.compatibilityOptions}, +\autopageref{desc:maincls.option.version}) has been selected, commands +\Macro{sectionformat} down to \Macro{subparagraphformat} are ignored by +\KOMAScript{}. In this case \Macro{othersectionlevelsformat} indeed will be +used. The formatting commands can be redefined using \Macro{renewcommand} to fit them to your personal needs. The following original definitions @@ -2113,9 +2135,14 @@ are used by the {\KOMAScript} classes: \newcommand*{\partformat}{\partname~\thepart\autodot} \newcommand*{\chapterformat}{% \chapappifchapterprefix{\ }\thechapter\autodot\enskip} + \newcommand*{\sectionformat}{% + \csname thesection\endcsname\autodot\enskip + }% \newcommand*{\othersectionlevelsformat}[3]{% #3\autodot\enskip} \end{lstcode} +The definitions of the lower levels correspond to +\Macro{sectionformat}. \begin{Example} Assume that when using \Macro{part} you do not want the word @@ -2136,25 +2163,30 @@ are used by the {\KOMAScript} classes: left margin in such a way that the heading text is left aligned with the surrounding text. This can be accomplished with: \begin{lstcode} - \renewcommand*{\othersectionlevelsformat}[3]{% - \llap{\#3\autodot\enskip}} -\end{lstcode} - The little known {\TeX} command \Macro{llap} in the definition above - puts its argument left of the current position without changing the - position thereby. A much better {\LaTeX} solution would be: -\begin{lstcode} - \renewcommand*{\othersectionlevelsformat}[3]{% - \makebox[0pt][r]{% - #3\autodot\enskip}} + \renewcommand*{\sectionformat}{% + \makebox[0pt][r]{\thesection\autodot\enskip}} + \renewcommand*{\subsectionformat}{% + \makebox[0pt][r]{\thesubsection\autodot\enskip}} + \renewcommand*{\subsubsectionformat}{% + \makebox[0pt][r]{\thesubsubsection\autodot\enskip}} + \renewcommand*{\paragraphformat}{% + \makebox[0pt][r]{\theparagraph\autodot\enskip}} + \renewcommand*{\paragraphformat}{% + \makebox[0pt][r]{\thesubparagraph\autodot\enskip}} \end{lstcode} See \cite{latex:usrguide} for more information about the optional arguments of \Macro{makebox}. \end{Example} % -\EndIndex{Cmd}{partformat}% -\EndIndex{Cmd}{chapterformat}% -\EndIndex{Cmd}{othersectionlevelsformat}% \EndIndex{Cmd}{autodot}% +\EndIndex{Cmd}{othersectionlevelsformat}% +\EndIndex{Cmd}{paragraphformat}% +\EndIndex{Cmd}{subparagraphformat}% +\EndIndex{Cmd}{subsubsectionformat}% +\EndIndex{Cmd}{subsectionformat}% +\EndIndex{Cmd}{sectionformat}% +\EndIndex{Cmd}{chapterformat}% +\EndIndex{Cmd}{partformat}% \begin{Declaration} @@ -2242,13 +2274,13 @@ Since chapters only exist in the classes \Class{scrbook} and \Class{scrartcl}. This changes when you use the \Package{scrlayer-scrpage} package (see \autoref{cha:scrlayer-scrpage}).\par \end{Explain} -Similar to \Macro{chapterformat} and \Macro{othersectionlevelsformat}, -the commands \Macro{chaptermarkformat} (not in \Class{scrartcl}), -\Macro{sectionmarkformat}, and \Macro{subsectionmarkformat} (only in -\Class{scrartcl}) define the formatting of the sectioning numbers in -the automatic running heads. They can be adapted to your personal -needs with \Macro{renewcommand}. The original definitions for the -{\KOMAScript} classes are: +Similar to \Macro{partformat} down to \Macro{subparagraphformat} for +formatting the numbers in the headings, the commands \Macro{chaptermarkformat} +(not in \Class{scrartcl}), \Macro{sectionmarkformat}, and +\Macro{subsectionmarkformat} (only in \Class{scrartcl}) define the formatting +of the sectioning numbers in the automatic running heads. They can be adapted +to your personal needs with \Macro{renewcommand}. The original definitions for +the {\KOMAScript} classes are: \begin{lstcode} \newcommand*{\chaptermarkformat}{% \chapappifchapterprefix{\ }\thechapter\autodot\enskip} @@ -2484,7 +2516,7 @@ this.% \section{Math} -\label{sec:maincls.math}% +\seclabel{math}% \BeginIndex{}{equations}% \BeginIndex{}{formulas}% \BeginIndex{}{mathematics}% @@ -2538,7 +2570,7 @@ and would not react on run-time changes of the option. \section{Floating Environments of Tables and Figures} -\label{sec:maincls.floats} +\seclabel{floats} \BeginIndex{}{floats}% \BeginIndex{}{tables}% \BeginIndex{}{figures}% @@ -3170,7 +3202,8 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}. \end{figure} The total width is thus the currently available width \PValue{\Macro{linewidth}}. However, this width is shifted - \PValue{2em} to the outside. The caption text or description is + $\Length{marginparwidth} + + \Length{marginparsep}$ to the outside. The caption text or description is placed on the inner side beside the figure. The figure itself is shifted 2\Unit{em} into the outer margin. @@ -3768,7 +3801,7 @@ immediately after the table of contents.% \section{Appendix} -\label{sec:maincls.appendix} +\seclabel{appendix} \BeginIndex{}{appendix} The appendix of a document contains mainly the enclosures to the @@ -3808,7 +3841,7 @@ argument. Chapters and sections in the appendix uses \Macro{chapter} and \section{Bibliography} -\label{sec:maincls.bibliography} +\seclabel{bibliography} \BeginIndex{}{bibliography} The bibliography opens up external resources. Mainly bibliographies will be @@ -4018,7 +4051,7 @@ be used (see \autoref{sec:maincls-experts.coexistence}, \section{Index} -\label{sec:maincls.index} +\seclabel{index} \BeginIndex{}{index} For general information about making an index see \cite{lshort}, @@ -4113,4 +4146,4 @@ environments.% %%% TeX-master: "../guide" %%% End: -% LocalWords: endnotes +% LocalWords: endnotes interleaf |