diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-titles.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/common-titles.tex | 608 |
1 files changed, 328 insertions, 280 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-titles.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-titles.tex index 5f178c218c5..e0617438062 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-titles.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-titles.tex @@ -1,6 +1,6 @@ % ====================================================================== % common-titles.tex -% Copyright (c) Markus Kohm, 2001-2017 +% Copyright (c) Markus Kohm, 2001-2018 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -18,7 +18,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % common-titles.tex -% Copyright (c) Markus Kohm, 2001-2017 +% Copyright (c) Markus Kohm, 2001-2018 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -46,88 +46,94 @@ % ====================================================================== \KOMAProvidesFile{common-titles.tex} - [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $ + [$Date: 2018-03-30 09:37:06 +0200 (Fri, 30 Mar 2018) $ KOMA-Script guide (common paragraphs)] -\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi} +\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi\and + Karl Hagen} -% Date of the translated German file: 2017-01-02 +% Date of the translated German file: 2018-01-30 \section{Document Titles} \seclabel{titlepage}% \BeginIndexGroup \BeginIndex{}{title}% -\BeginIndex{}{document>title}% \IfThisCommonFirstRun{}{% - What is written in \autoref{sec:\ThisCommonFirstLabelBase.titlepage} - applies, mutatis mutandis. So if you have alread read and understood - \autoref{sec:\ThisCommonFirstLabelBase.titlepage} you can jump to - \autoref{sec:\ThisCommonLabelBase.titlepage.next} on + This information in \autoref{sec:\ThisCommonFirstLabelBase.titlepage} + largely applies to this chapter. So if you have already read and understood + \autoref{sec:\ThisCommonFirstLabelBase.titlepage}, you can skip to + \autoref{sec:\ThisCommonLabelBase.titlepage.next}, \autopageref{sec:\ThisCommonLabelBase.titlepage.next}.% }% \IfThisCommonLabelBase{scrextend}{\iftrue}{\csname iffalse\endcsname}% - \ But there's a difference: The\textnote{Attention!} document title - capabilities of \Package{scrextend} are part of the optional, advanced + \ However,\textnote{Attention!} the capabilities of \Package{scrextend} + for handling the document title are part of the optional, advanced features. Therfore they are only available, if - \OptionValueRef{\ThisCommonLabelBase}{extendedfeature}{title} has been + \OptionValueRef{\ThisCommonLabelBase}{extendedfeature}{title} is selected while loading the package (see \autoref{sec:\ThisCommonLabelBase.optionalFeatures}, \DescRef{\ThisCommonLabelBase.option.extendedfeature}). - Beyond that \Package{scrextend} cannot be used with a \KOMAScript{} - class together. Because of this + Furthermore, \Package{scrextend} cannot be used with a \KOMAScript{} + class. Because of this, you should replace \begin{lstcode} \documentclass{scrbook} \end{lstcode} - must be replaced by + with \begin{lstcode} \documentclass{book} \usepackage[extendedfeature=title]{scrextend} \end{lstcode} - at all examples from \autoref{sec:maincls.titlepage}, if \Package{scrextend} - should be used. + for all examples from \autoref{sec:maincls.titlepage}, if you want to + try them with \Package{scrextend}. \fi -In general we distinguish two kinds of document titles. First known are title -pages. In this case the document title will be placed together with additional -document information, like the author, on a page of its own. Besides the main -title page, several further title pages may exist, like the half-title or -bastard title, publisher data, dedication, or similar. The second known kind -of document title is the in-page title. In this case, the document title is -placed at the top of a page and specially emphasized, and may be accompanied -by some additional information too, but it will be followed by more material -in the same page, for instance by an abstract, or the table of contents, or -even a section. +In general, we distinguish two kinds of document titles. First, there are +title pages. These include title of the document, together with additional +information such as the author, on a separate page. In addition to the main +title page, there may be several other title pages, such as the half-title or +bastard title, publisher data, dedication, and so on. Second, there is the +in-page title. This kind of title appears at the top of a new page, usually +the first, and is specially emphasized. It too may be accompanied by +additional information, but it will be followed by more material on the same +page, for example by an abstract, the table of contents, or even a section. \begin{Declaration} \OptionVName{titlepage}{simple switch}% \OptionValue{titlepage}{firstiscover} + \Macro{coverpagetopmargin} + \Macro{coverpageleftmargin} + \Macro{coverpagerightmargin} + \Macro{coverpagebottommargin} \end{Declaration}% -Using \DescRef{\ThisCommonLabelBase.cmd.maketitle} (see -\DescPageRef{\ThisCommonLabelBase.cmd.maketitle}), this option% -\IfThisCommonLabelBase{maincls}{% - \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and - \Class{scrartcl}}% -}{} switches between document title pages\Index{title>pages} and in-page -title\Index{title>in-page}. For \PName{simple switch}, any value from -\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch} may be used. - -The option -\OptionValue{titlepage}{true}\important{\OptionValue{titlepage}{true}} -\IfThisCommonLabelBase{scrextend}{}{or \Option{titlepage} }makes {\LaTeX} use -separate pages for the titles. Command -\DescRef{\ThisCommonLabelBase.cmd.maketitle} sets these pages inside a -\DescRef{\ThisCommonLabelBase.env.titlepage} environment and the pages -normally have neither header nor footer. In comparison with standard {\LaTeX}, -{\KOMAScript} expands the handling of the titles significantly. - -The option +This option\IfThisCommonLabelBase{maincls}{% + \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and + \Class{scrartcl}}% +}{} determines whether to use document title pages\Index{title>pages} or +in-page titles\Index{title>in-page} when using +\DescRef{\ThisCommonLabelBase.cmd.maketitle} (see +\DescPageRef{\ThisCommonLabelBase.cmd.maketitle}). Any value from +\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch} can be used +for \PName{simple switch}. + +With the \OptionValue{titlepage}{true}% +\important{\OptionValue{titlepage}{true}} +\IfThisCommonLabelBase{scrextend}{}{or \Option{titlepage}} option, +invoking \DescRef{\ThisCommonLabelBase.cmd.maketitle} creates titles on +separate pages. These pages are set inside a +\DescRef{\ThisCommonLabelBase.env.titlepage} environment, and they +normally have neither header nor footer. Compared to standard {\LaTeX}, +{\KOMAScript} significantly expands the handling of the titles. These +additional elements can be found on the following pages. + +In contrast, with the \OptionValue{titlepage}{false}\important{\OptionValue{titlepage}{false}} -specifies that an \emph{in-page} title is used. This means that the title is -specially emphasized, but it may be followed by more material on the same -page, for instance by an abstract or a section.% +option, invoking \DescRef{\ThisCommonLabelBase.cmd.maketitle} creates an +\emph{in-page} title. This means that the title is specially emphasized, but +it may be followed by more material on the same page, for instance an abstract +or a section.% The third choice,% \IfThisCommonLabelBase{maincls}{% @@ -138,34 +144,27 @@ The third choice,% \ChangedAt{v3.12}{\Package{scrextend}}% }{\InternalCommonFileUseError}% } \OptionValue{titlepage}{firstiscover}% -\important{\OptionValue{titlepage}{firstiscover}} does not only select title -pages. It additionally prints the first title page of -\DescRef{\ThisCommonLabelBase.cmd.maketitle}\IndexCmd{maketitle}, this is -either the extra title or the main title, as a cover\Index{cover} page. Every -other setting of option \Option{titlepage} would cancel this setting. The -margins\important{% - \Macro{coverpagetopmargin}\\ - \Macro{coverpagebottommargin}\\ - \Macro{coverpageleftmargin}\\ - \Macro{coverpagerightmargin}} of the cover page are given by -\Macro{coverpagetopmargin}\IndexCmd[indexmain]{coverpagetopmargin}, -\Macro{coverpagebottommargin}\IndexCmd[indexmain]{coverpagebottommargin}, -\Macro{coverpageleftmargin}\IndexCmd[indexmain]{coverpageleftmargin} und -\Macro{coverpagerightmargin}\IndexCmd[indexmain]{coverpagerightmargin}. The -defaults of these depend on the lengths -\Length{topmargin}\IndexLength{topmargin} and -\Length{evensidemargin}\IndexLength{evensidemargin} and can be changed using -\Macro{renewcommand}. +\important{\OptionValue{titlepage}{firstiscover}} not only activates title +pages but also prints the first title page of +\DescRef{\ThisCommonLabelBase.cmd.maketitle}\IndexCmd{maketitle}, i.\,e. +either the half-title or the main title, as a cover\Index{cover} page. Any +other setting of the \Option{titlepage} option will cancel this setting. The +margins\important{\Macro{coverpage\dots margin}} of the cover page are given +by \Macro{coverpagetopmargin}, \Macro{coverpageleftmargin}, +\Macro{coverpagerightmargin}, and \Macro{coverpagebottommargin}. The defaults +of these depend on the lengths of \Length{topmargin}\IndexLength{topmargin} +and \Length{evensidemargin}\IndexLength{evensidemargin} and can be changed +with \Macro{renewcommand}. \IfThisCommonLabelBase{maincls}{% - The default of classes \Class{scrbook} and \Class{scrreprt} is usage of - title pages. Class \Class{scrartcl}, on the other hand, uses in-page titles - as default.% + The default of the \Class{scrbook} and \Class{scrreprt} classes is to use + title pages. The \Class{scrartcl} class, on the other hand, uses in-page + titles by default.% }{% \IfThisCommonLabelBase{scrextend}{% - The default depends on the used class and \Package{scrextend} handles it - compatible to the standard class. If a class does not set up a comparable - default, in-page title will be used.% + The default depends on the class used and \Package{scrextend} recognizes + it in a way that compatible with the standard class. If a class does not + set up a comparable default, it will be an in-page title.% }{\InternalCommonFileUsageError}% }% % @@ -175,16 +174,16 @@ defaults of these depend on the lengths \begin{Declaration} \begin{Environment}{titlepage}\end{Environment}% \end{Declaration}% -With the standard classes and with {\KOMAScript}, all title pages are defined -in a special environment, the \Environment{titlepage} environment. This -environment always starts a new page\,---\,in the two-sided layout a new right -page\,---\,and in single column mode. For this page, the style is changed by -\DescRef{maincls.cmd.thispagestyle}\PParameter{empty}, so that -neither page number nor running heading are output. At the end of the -environment the page is automatically shipped out. Should you not be able to -use the automatic layout of the title pages provided by -\DescRef{\ThisCommonLabelBase.cmd.maketitle}, that will be described next; it -is advisable to design a new one with the help of this environment. +The standard classes and {\KOMAScript} set all title pages in a special +environment: the \Environment{titlepage} environment. This environment always +starts a new page\,---\,in two-sided printing a new right-hand page\,---\,and +in single-column mode. For this page, the style is changed to +\DescRef{maincls.cmd.thispagestyle}% +\PParameter{\DescRef{maincls.pagestyle.empty}}, so that neither page number +nor running head is output. At the end of the environment, the page is +automatically shipped out. Should you not be able to use the automatic layout +of the title pages provided by \DescRef{\ThisCommonLabelBase.cmd.maketitle}, +described next, you should design a new one with the help of this environment. \IfThisCommonFirstRun{\iftrue}{% A simple example for a title page with \Environment{titlepage} is shown in @@ -194,7 +193,7 @@ is advisable to design a new one with the help of this environment. }% \begin{Example} \phantomsection\xmpllabel{env.titlepage} - Assume you want a title page on which only the word ``Me'' stands at + Suppose you want a title page on which only the word ``Me'' stands at the top on the left, as large as possible and in bold\,---\,no author, no date, nothing else. The following document creates just that: @@ -215,71 +214,79 @@ is advisable to design a new one with the help of this environment. \begin{Declaration} \Macro{maketitle}\OParameter{page number} \end{Declaration}% -While the the standard classes produce at least one title page that may have -the three items title, author, and date, with {\KOMAScript} the -\Macro{maketitle} command can produce up to six pages. In contrast to the -standard classes, the \Macro{maketitle} macro in {\KOMAScript} accepts an -optional numeric argument. If it is used, this number is made the page number -of the first title page. However, this page number is not output, but affects -only the numbering. You should choose an odd number, because otherwise the -whole count gets mixed up. In my opinion there are only two meaningful -applications for the optional argument. On the one hand, one could give to the -half-title\Index[indexmain]{half-title} the logical page number \(-\)1 in -order to give the full title page the number 1. On the other hand, it could be -used to start at a higher page number, for instance, 3, 5, or 7, to +While\textnote{\KOMAScript{} vs. standard classes} the standard classes +produce at most one title page that can have three items (title, author, and +date), with \KOMAScript{} \Macro{maketitle} can produce up to six pages. In +contrast to the standard classes, \Macro{maketitle} in {\KOMAScript} accepts +an optional numeric argument. If it is used, this number is the page number of +the first title page. This page number is not output, but it affects the +subsequent numbering. You should definitely choose an odd number, because +otherwise the whole count gets mixed up. In my opinion, there are only two +useful applications for the optional argument. On the one hand, you could give +the the logical page number -1 to the half-title\Index[indexmain]{half-title} +in order to give the full title page the number 1. On the other hand, you +could use it to start at a higher page number, for example, 3, 5, or 7, to accommodate other title pages added by the publishing house. The optional -argument is ignored for \emph{in-page} titles. However, the page style of such -a title page can be changed by redefining the -\DescRef{\ThisCommonLabelBase.cmd.titlepagestyle} macro. For that see -\autoref{sec:maincls.pagestyle}, \DescPageRef{maincls.cmd.titlepagestyle}. - -The following commands do not lead immediately to the ship-out of the -titles. The typesetting and ship-out of the title pages are always done by -\Macro{maketitle}. By the way, you should note that \Macro{maketitle} should -not be used inside a \DescRef{\ThisCommonLabelBase.env.titlepage} -environment. Like\textnote{Attention!} shown in the examples, one should use -either \Macro{maketitle} or \DescRef{\ThisCommonLabelBase.env.titlepage} only, -but not both. - -The commands explained below only define the contents of the title -pages. Because of this, they have to be used before \Macro{maketitle}. It is, -however, not necessary and, when using, e.\,g., the \Package{babel} -package\IndexPackage{babel}, not recommended to use these in the preamble -before \Macro{begin}\PParameter{document} (see \cite{package:babel}). Examples -can be found at the end of this section. +argument is ignored for \emph{in-page} titles. You can change the page style +of such a title page by redefining the +\DescRef{\ThisCommonLabelBase.cmd.titlepagestyle} macro (see +\autoref{sec:maincls.pagestyle}, \DescPageRef{maincls.cmd.titlepagestyle}). + +The following commands do not lead immediately to the ship-out of the titles. +The typesetting and ship-out of the title pages are always done by +\Macro{maketitle}. Note also that \Macro{maketitle} should not be used inside +a \DescRef{\ThisCommonLabelBase.env.titlepage} environment. +As\textnote{Attention!} shown in the examples, you should use either +\Macro{maketitle} or \DescRef{\ThisCommonLabelBase.env.titlepage}, but not +both. + +The following commands only define the contents of the title. Therefore they +must be used before \Macro{maketitle}. It is, however, not necessary and, when +using the \Package{babel} package\IndexPackage{babel} not recommended, to +include these in the preamble before \Macro{begin}\PParameter{document} (see +\cite{package:babel}). You can find examples +\IfThisCommonFirstRun{in the descriptions of the other commands in this + section}{in \autoref{sec:\ThisCommonFirstLabelBase.titlepage}, starting on + \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.extratitle}}. \begin{Declaration} \Macro{extratitle}\Parameter{half-title} + \Macro{frontispiece}\Parameter{frontispiece} \end{Declaration}% \begin{Explain}% - In earlier times the inner book was often not protected from dirt by a cover. - This task was then taken over by the first page of the book which - carried mostly a shortened title called the \emph{half-title}. - Nowadays the extra page is often applied before the real full title - and contains information about the publisher, series number and similar - information. + In earlier times the inner book was often not protected from dirt by a + cover. This function was then assumed by the first page of the book, which + usually had just a short title, known as the \emph{half-title}. Nowadays the + extra page often appears before the real main title and contains information + about the publisher, series number, and similar information. \end{Explain} -With {\KOMAScript} it is possible to include a page before the real title -page. The \PName{half-title} can be arbitrary text\,---\,even several -paragraphs. The contents of the \PName {half-title} are output by -{\KOMAScript} without additional formatting. Their organisation is completely -left to the user. The back of the half-title remains empty. The half-title -has its own title page even when \emph{in-page} titles are used. The output of -the half-title defined with \Macro{extratitle} takes place as part of the -titles produced by \DescRef{\ThisCommonLabelBase.cmd.maketitle}. +With {\KOMAScript}, it is possible to include a page before the real title +page. The \PName{half-title} can be arbitrary text\,---\,even several +paragraphs. The contents of the \PName{half-title} are output by {\KOMAScript} +without additional formatting. Their organisation is completely left to the +user. The verso of the half-title\IfThisCommonLabelBase{maincls}{% + \ChangedAt{v3.25}{\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}% +}{% + \IfThisCommonLabelBase{scrextend}{% + \ChangedAt{v3.25}{\Package{scrextend}}% + }{\ThisCommonLabelBaseFailure}% +} is the frontispiece. The half-title is set on its own page even when in-page +titles are used. The output of the half-title defined with \Macro{extratitle} +takes place as part of the title produced by +\DescRef{\ThisCommonLabelBase.cmd.maketitle}. \IfThisCommonFirstRun{\iftrue}{% - A simple example for a title page with extra title and main title is shown + An example of a simple title page with half-title and main title is shown in \autoref{sec:\ThisCommonFirstLabelBase.titlepage} on \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.extratitle}% \csname iffalse\endcsname% }% \begin{Example} \phantomsection\xmpllabel{cmd.extratitle} - Let's go back to the previous example and assume - that the spartan ``Me'' is the half-title. The full title should - still follow the half-title. One can proceed as follows: + Let's return to the previous example and suppose + that the Spartan ``Me'' is the half-title. The full title should + still follow the half-title. You can proceed as follows: \begin{lstcode} \documentclass{scrbook} \begin{document} @@ -288,7 +295,7 @@ titles produced by \DescRef{\ThisCommonLabelBase.cmd.maketitle}. \maketitle \end{document} \end{lstcode} - You can center the half-title horizontally and put it a little lower down + You can centre the half-title horizontally and put it a little lower down the page: \begin{lstcode} \documentclass{scrbook} @@ -318,84 +325,101 @@ titles produced by \DescRef{\ThisCommonLabelBase.cmd.maketitle}. \Macro{and}% \Macro{thanks}\Parameter{footnote} \end{Declaration}% -The contents of the full title page are defined by seven elements. The output -of the full title page occurs as part of the title pages of -\DescRef{\ThisCommonLabelBase.cmd.maketitle}, whereas the now listed elements -only define the corresponding elements. - -\BeginIndexGroup -\BeginIndex{FontElement}{titlehead}\LabelFontElement{titlehead}% -The\important{\Macro{titlehead}} \PName{title - head}\Index[indexmain]{title>head} is defined with the command -\Macro{titlehead}. It is typeset with the font of the homonymous element in -regular justification and full width at the top of the page. It can be freely -designed by the user.% +There are seven elements available for the content of the main title page. The +main title page is output as part of the title pages created by +\DescRef{\ThisCommonLabelBase.cmd.maketitle}, while the definitions given here +only apply to the respective elements. + +\BeginIndexGroup\BeginIndex{FontElement}{titlehead}% +\LabelFontElement{titlehead}% +The\important{\Macro{titlehead}} \PName{title head}% +\Index[indexmain]{title>head} is defined with the command +\Macro{titlehead}. It occupies the entire text width, at the top of the page, +in normal justification, and it can be freely designed by the user. It uses +the font element\important{\FontElement{titlehead}} with same name (see +\autoref{tab:\ThisCommonFirstLabelBase.mainTitle}, +\autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}).% \EndIndexGroup -\BeginIndexGroup -\BeginIndex{FontElement}{subject}\LabelFontElement{subject}% +\BeginIndexGroup\BeginIndex{FontElement}{subject}\LabelFontElement{subject}% The\important{\Macro{subject}} \PName{subject}\Index[indexmain]{subject} is -output with the font of the homonymous element immediately above the -\PName{title}.% +output with the font element\important{\FontElement{subject}} of the same name +immediately above the \PName{title}.% \EndIndexGroup -\BeginIndexGroup -\BeginIndex{FontElement}{title}\LabelFontElement{title}% -The\important{\Macro{title}} \PName{title} is output with a very large font -size. Beside\IfThisCommonLabelBase{maincls}{% +\BeginIndexGroup\BeginIndex{FontElement}{title}\LabelFontElement{title}% +The\important{\Macro{title}} \PName{title} is set in a very large font size. +Along\IfThisCommonLabelBase{maincls}{% \ChangedAt{v2.8p}{\Class{scrbook}\and \Class{scrreprt}\and - \Class{scrartcl}}}{} all other element the font size\textnote{Attention!} -is, however, not affected by the font switching element \FontElement{title} -(see \autoref{tab:\ThisCommonFirstLabelBase.mainTitle}, + \Class{scrartcl}}}{} with the font size, the font element +\FontElement{title}\IndexFontElement[indexmain]{title}% +\important{\FontElement{title}} is applied (see +\autoref{tab:\ThisCommonFirstLabelBase.mainTitle}, \autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}).% \EndIndexGroup -\BeginIndexGroup -\BeginIndex{FontElement}{subtitle}\LabelFontElement{subtitle}% +\BeginIndexGroup\BeginIndex{FontElement}{subtitle}\LabelFontElement{subtitle}% The\important{\Macro{subtitle}} \PName{subtitle}\IfThisCommonLabelBase{maincls}{% \ChangedAt{v2.97c}{\Class{scrbook}\and \Class{scrreprt}\and - \Class{scrartcl}}}{} is output with the font of the homonymous element -just below the title.% + \Class{scrartcl}}}{} is set just below the title using the font +element\important{\FontElement{subtitle}} of the same name (see +\autoref{tab:\ThisCommonFirstLabelBase.mainTitle}, +\autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}).% \EndIndexGroup -\BeginIndexGroup -\BeginIndex{FontElement}{author}\LabelFontElement{author}% +\BeginIndexGroup\BeginIndex{FontElement}{author}\LabelFontElement{author}% Below\important{\Macro{author}} the \PName{subtitle} appears the -\PName{author}\Index[indexmain]{author}. Several authors can be specified in -the argument of \Macro{author}. They should be separated by \Macro{and}. The -font of element \FontElement{author} is used for the output of the authors.% +\PName{author}\Index[indexmain]{author}. Several authors can be specified in +the argument of \Macro{author}. They should be separated by +\Macro{and}\important{\Macro{and}}. The output uses the font +element\important{\FontElement{author}} of the same name. (see +\autoref{tab:\ThisCommonFirstLabelBase.mainTitle}, +\autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}).% \EndIndexGroup -\BeginIndexGroup -\BeginIndex{FontElement}{date}\LabelFontElement{date}% +\BeginIndexGroup\BeginIndex{FontElement}{date}\LabelFontElement{date}% Below\important{\Macro{date}} the author or authors appears the -date\Index{date} in the font of the homonymous element. The default value is -the present date, as produced by \Macro{today}\IndexCmd{today}. The +date\Index{date} in the font of the element of the same name. The default +value is the current date, as produced by \Macro{today}\IndexCmd{today}. The \Macro{date} command accepts arbitrary information\,---\,even an empty -argument.% +argument. The output uses the font element\important{\FontElement{date}} of +the same name (see \autoref{tab:\ThisCommonFirstLabelBase.mainTitle}, +\autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}).% \EndIndexGroup -\BeginIndexGroup -\BeginIndex{FontElement}{publishers}\LabelFontElement{publishers}% +\BeginIndexGroup\BeginIndex{FontElement}{publishers}% +\LabelFontElement{publishers}% Finally\important{\Macro{publishers}} comes the \PName{publisher}\Index[indexmain]{publisher}. Of course this command can also -be used for any other information of little importance. If necessary, the +be used for any other information of minor importance. If necessary, the \Macro{parbox} command can be used to typeset this information over the full -page width like a regular paragraph instead of centering it. Then it is to be -considered equivalent to the title head. However, note that this field is put -above any existing footnotes. The font of element \FontElement{publishers} is -used for the output.% +page width like a regular paragraph instead of centring it. It should then be +considered equivalent to the title head. Note, however, that this field is +placed above any existing footnotes. The output uses the font +element\important{\FontElement{publishers}} of the same name (see +\autoref{tab:\ThisCommonFirstLabelBase.mainTitle}, +\autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}).% \EndIndexGroup Footnotes\important{\Macro{thanks}}\Index{footnotes} on the title page are produced not with \Macro{footnote}, but with \Macro{thanks}. They serve typically for notes associated with the authors. Symbols are used as footnote -markers instead of numbers. Note\textnote{Attention!}, that \Macro{thanks} has -to be used inside the argument of another command, e.\,g., at the argument -\PName{author} of the command \Macro{author}. - -While% +markers instead of numbers. Note\textnote{Attention!} that \Macro{thanks} has +to be used inside the argument of another command, such as in the +\PName{author} argument of the command \Macro{author}. +\IfThisCommonLabelBase{scrextend}{% + However, in order for the \DescRef{\ThisCommonLabelBase.fontelement.footnote} + element to be aware of the \Package{scrextend} package, not only does the + title extension need to be enabled, it must also be set to use footnotes + with this package (see the introduction to + \autoref{sec:\ThisCommonLabelBase.footnotes}, + \autopageref{sec:\ThisCommonLabelBase.footnotes}). Otherwise, the font + specified by the class or other packages used for the footnotes will be + used.% +}{}% + +For% \IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% @@ -403,104 +427,118 @@ While% \IfThisCommonLabelBase{scrextend}{% \ChangedAt{v3.12}{\Package{scrextend}}% }{\InternalCommonFileUsageError}% -} printing the title elements the equal named font switching elements will be -used for all them. The defaults, that may be found in -\autoref{tab:\ThisCommonFirstLabelBase.titlefonts}, % -\IfThisCommonFirstRun{}{% - \autopageref{tab:\ThisCommonFirstLabelBase.titlefonts}, % -}% -may be changed using the commands -\DescRef{\ThisCommonLabelBase.cmd.setkomafont} and -\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} (see +} the output of the title elements, the font\textnote{font} can be set using +the \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and +\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} command (see \autoref{sec:\ThisCommonLabelBase.textmarkup}, -\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}).% +\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}). The defaults are listed +in \autoref{tab:\ThisCommonFirstLabelBase.titlefonts}% +\IfThisCommonFirstRun{}{% + , \autopageref{tab:\ThisCommonFirstLabelBase.titlefonts}% +}.% \IfThisCommonFirstRun{% \begin{table} % \centering +% \caption \KOMAoptions{captions=topbeside}% \setcapindent{0pt}% -% \caption +% \addtokomafont{caption}{\raggedright}% \begin{captionbeside} [{Font defaults for the elements of the title}] {\label{tab:\ThisCommonLabelBase.titlefonts}% - Font defaults for the elements of the title} + \hspace{0pt plus 1ex}Font defaults for the elements of the title} [l] \begin{tabular}[t]{ll} \toprule Element name & Default \\ \midrule - \DescRef{\ThisCommonLabelBase.fontelement.author} & \Macro{Large} \\ - \DescRef{\ThisCommonLabelBase.fontelement.date} & \Macro{Large} \\ - \DescRef{\ThisCommonLabelBase.fontelement.dedication} & \Macro{Large} \\ - \DescRef{\ThisCommonLabelBase.fontelement.publishers} & \Macro{Large} \\ - \DescRef{\ThisCommonLabelBase.fontelement.subject} & - \Macro{normalfont}\Macro{normalcolor}\Macro{bfseries}\Macro{Large} \\ - \DescRef{\ThisCommonLabelBase.fontelement.subtitle} & - \Macro{usekomafont}\PParameter{title}\Macro{large} \\ - \DescRef{\ThisCommonLabelBase.fontelement.title} & \Macro{usekomafont}\PParameter{disposition} \\ - \DescRef{\ThisCommonLabelBase.fontelement.titlehead} & \\ + \FontElement{author} & \Macro{Large} \\ + \FontElement{date} & \Macro{Large} \\ + \FontElement{dedication} & \Macro{Large} \\ + \FontElement{publishers} & \Macro{Large} \\ + \FontElement{subject} & + \Macro{normalfont}\Macro{normalcolor}% + \Macro{bfseries}\Macro{Large} \\ + \FontElement{subtitle} & + \DescRef{\ThisCommonLabelBase.cmd.usekomafont}% + \PParameter{title}\Macro{large} \\ + \FontElement{title} & + \DescRef{\ThisCommonLabelBase.cmd.usekomafont}% + \PParameter{disposition} \\ + \FontElement{titlehead} & \\ \bottomrule \end{tabular} \end{captionbeside} \end{table}% -}{} - -With the exception of \PName{titlehead} and possible footnotes, all -the items are centered horizontally. The information is summarised in -\autoref{tab:\ThisCommonFirstLabelBase.mainTitle}% -\IfThisCommonFirstRun{}{% - , \autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}}. +}{}% + +With the exception of \PName{title head} and any footnotes, all output is +centred horizontally. % +\iffree{% + \IfThisCommonLabelBase{scrextend}{The formatting of each element is}{These + details are} briefly summarized in + \autoref{tab:\ThisCommonFirstLabelBase.mainTitle}\IfThisCommonFirstRun{}{% + , \autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}}.% +}{% + \IfThisCommonLabelBase{scrextend}{% + The alignment of individual elements can also be found in + \autoref{tab:\ThisCommonFirstLabelBase.mainTitle}\IfThisCommonFirstRun{}{% + , \autopageref{tab:\ThisCommonFirstLabelBase.mainTitle}}.% + }{% + For a summary, see \autoref{tab:\ThisCommonFirstLabelBase.mainTitle}.% + }% +}% \IfThisCommonFirstRun{% \begin{table} -% \centering + % \centering \KOMAoptions{captions=topbeside}% \setcapindent{0pt}% % \caption \begin{captionbeside}[Main title]{% - Font and horizontal positioning of the - elements in the main title page in the order of their vertical - position from top to bottom when typeset with - \DescRef{\ThisCommonLabelBase.cmd.maketitle}} + \hspace{0pt plus 1ex}% + Font and horizontal positioning of the elements in the main title page + in the order of their vertical position from top to bottom when + typeset with \DescRef{\ThisCommonLabelBase.cmd.maketitle}} [l] \setlength{\tabcolsep}{.85\tabcolsep}% Umbruchoptimierung \begin{tabular}[t]{llll} \toprule - Element & Command & Font & Orientation \\ + Element & Command & Font & Alignment \\ \midrule Title head & \Macro{titlehead} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{titlehead} & justified \\ - Subject & \Macro{subject} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{subject} & centered \\ - Title & \Macro{title} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{title}\Macro{huge} & centered \\ - Subtitle & \Macro{subtitle} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{subtitle} & centered \\ - Authors & \Macro{author} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{author} & centered \\ - Date & \Macro{date} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{date} & centered \\ - Publishers & \Macro{publishers} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{publishers} & centered \\ + Subject & \Macro{subject} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{subject} & centred \\ + Title & \Macro{title} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{title}\Macro{huge} & centred \\ + Subtitle & \Macro{subtitle} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{subtitle} & centred \\ + Authors & \Macro{author} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{author} & centred \\ + Date & \Macro{date} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{date} & centred \\ + Publishers & \Macro{publishers} & \DescRef{\ThisCommonLabelBase.cmd.usekomafont}\PParameter{publishers} & centred \\ \bottomrule \end{tabular} \end{captionbeside} \label{tab:maincls.mainTitle} \end{table} -}{} % -Please note\textnote{Attention!}, that for the main title \Macro{huge} will be -used after the font switching element +}{} + +Note\textnote{Attention!} that for the main title, \Macro{huge} will be used +after the font switching element \DescRef{\ThisCommonLabelBase.fontelement.title}\IndexFontElement{title}. So you cannot change the size of the main title using \DescRef{\ThisCommonLabelBase.cmd.setkomafont} or \DescRef{\ThisCommonLabelBase.cmd.addtokomafont}.% \IfThisCommonFirstRun{\iftrue}{% - An example for a title page with all elements provided by \KOMAScript{} for - the main title page is shown in - \autoref{sec:\ThisCommonFirstLabelBase.titlepage} on + An example for a title page using all the elements offered by \KOMAScript{} + is shown in \autoref{sec:\ThisCommonFirstLabelBase.titlepage} on \PageRefxmpl{\ThisCommonFirstLabelBase.maintitle}.% \csname iffalse\endcsname% }% \begin{Example} \phantomsection\xmpllabel{maintitle}% - Assume you are writing a dissertation. The title page should have the + Suppose you are writing a dissertation. The title page should have the university's name and address at the top, flush left, and the semester, - flush right. As usual, a title is to be used, including author and - delivery date. The adviser must also be indicated, together with the fact - that the document is a dissertation. This can be obtained as follows: + flush right. As usual, a title including author and submission date + should be given. The adviser must also be indicated, together with the + fact that the document is a dissertation. You can do this as follows: \begin{lstcode} \documentclass{scrbook} \usepackage[english]{babel} @@ -523,30 +561,31 @@ you cannot change the size of the main title using \fi \begin{Explain} - A frequent misunderstanding concerns the role of the full title page. It is - often erroneously assumed that the cover\Index{cover} or dust cover is - meant. Therefore, it is frequently expected that the title page does not - follow the normal page layout, but has equally large left and right margins. - - However, if one takes a book and opens it, one notices very quickly at least - one title page under the cover within the so-called inner book. Precisely + A common misconception concerns the function of the full title page. It is + often erroneously assumed to be the cover\Index{cover} or dust jacket. + Therefore, it is frequently expected that the title page will not follow the + normal layout for two-sided typesetting but will have equally large left and + right margins. + + But if you pick up a book and open it, you will quickly find at least one + title page inside the cover, within the so-called book block. Precisely these title pages are produced by \DescRef{\ThisCommonLabelBase.cmd.maketitle}. - As is the case with the half-title, the full title page belongs to the inner - book, and therefore should have the same page layout as the rest of the - document. A cover is actually something that should be created in a - separate document. The cover often has a very individual format. It can also - be designed with the help of a graphics or DTP program. A separate document - should also be used because the cover will be printed on a different medium, - possibly cardboard, and possibly with another printer. - - Nevertheless, since \KOMAScript~3.12 the first title page of - \DescRef{\ThisCommonLabelBase.cmd.maketitle} can be printed as a cover page - with different margins. For more information about this see the description - of option + As is the case with the half-title, the full title page belongs to the book + block, and therefore should have the same page layout as the rest of the + document. A cover is actually something that you should create in a + separate document. After all, it often has a very distinct format. It can + also be designed with the help of a graphics or DTP program. A separate + document should also be used because the cover will be printed on a + different medium, such as cardboard, and possibly with another printer. + + Nevertheless, since \KOMAScript~3.12 the first title page issued by + \DescRef{\ThisCommonLabelBase.cmd.maketitle} can be formatted as a cover + page with different margins. Changes to the margins on this page do not + affect the other margins. For more information about this option, see \OptionValueRef{\ThisCommonLabelBase}{titlepage}{firstiscover}% - \IndexOption{titlepage~=\PValue{firstiscover}} on + \IndexOption{titlepage~=\textKValue{firstiscover}} on \DescPageRef{\ThisCommonLabelBase.option.titlepage}. \end{Explain} % @@ -557,15 +596,15 @@ you cannot change the size of the main title using \Macro{uppertitleback}\Parameter{titlebackhead}% \Macro{lowertitleback}\Parameter{titlebackfoot} \end{Declaration}% -With the standard classes, the back of the title page of a double-side print -is left empty. However, with {\KOMAScript} the back of the full title page -can be used for other information. Exactly two elements which the user can -freely format are recognized: \PName -{titlebackhead}\Index{title>back}\Index{title>rear side}\Index{title>flipside} -and \PName {titlebackfoot}. The head can reach up to the foot and vice -versa. \iffree{If one takes this manual as an example, the exclusion of - liability was set with the help of the \Macro{uppertitleback} command.}{The - publishers information of this book. e.\,g., could have been set either with +In\textnote{\KOMAScript{} vs. standard classes} two-sided printing, the +standard classes leave the back (verso) of the title page empty. However, with +{\KOMAScript} the back of the full title page can be used for other +information. There are exactly two elements which the user can freely format: +\PName{titlebackhead}\Index{title>back}\Index{title>verso} and +\PName{titlebackfoot}. The header can extend to the footer and vice versa. +\iffree{Using this guide as an example, the legal disclaimer was set with the + help of the \Macro{uppertitleback} command.}{The publishers information of + this book, for example, could have been set either with \Macro{uppertitleback} or \Macro{lowertitleback}.}% % \EndIndexGroup @@ -574,18 +613,27 @@ versa. \iffree{If one takes this manual as an example, the exclusion of \begin{Declaration} \Macro{dedication}\Parameter{dedication} \end{Declaration}% -\BeginIndexGroup -\BeginIndex{FontElement}{dedication}\LabelFontElement{dedication}% -{\KOMAScript} provides a page for dedications. The -dedication\Index{dedication} is centered and uses a slightly larger type size -given by the font of the homonymous element. The font can be changed using -command \DescRef{\ThisCommonLabelBase.cmd.setkomafont} or -\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} (see +{\KOMAScript} offers its own dedication page. This +dedication\Index{dedication} is centred and set by default with a slightly +larger font\textnote{font}. +\BeginIndexGroup\BeginIndex{FontElement}{dedication}% +\LabelFontElement{dedication} +The% +\IfThisCommonLabelBase{maincls}{% + \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and + \Class{scrartcl}}% +}{% + \IfThisCommonLabelBase{scrextend}{% + \ChangedAt{v3.12}{\Package{scrextend}}% + }{\InternalCommonFileUseError}% +}\important{\FontElement{dedication}} exact font setting for the +\FontElement{dedication} element, which is taken from +\autoref{tab:\ThisCommonFirstLabelBase.titlefonts}, +\autopageref{tab:\ThisCommonFirstLabelBase.titlefonts}, can be changed with +the \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and +\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} commands (see \autoref{sec:\ThisCommonLabelBase.textmarkup}, -\autopageref{sec:\ThisCommonLabelBase.textmarkup}). The back is empty like -the back page of the half-title. The dedication page is produced by -\DescRef{\ThisCommonLabelBase.cmd.maketitle} and must therefore be defined -before this command is issued.% +\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}).% \EndIndexGroup \IfThisCommonFirstRun{\iftrue}{% @@ -596,8 +644,8 @@ before this command is issued.% }% \begin{Example} \phantomsection\xmpllabel{fulltitle}% - This time assume that you have written a poetry book and you want to - dedicate it to your wife. A solution would look like this: + Suppose you have written a book of poetry and want to + dedicate it to your spouse. A solution would look like this: \begin{lstcode} \documentclass{scrbook} \usepackage[english]{babel} @@ -608,14 +656,14 @@ before this command is issued.% \date{1412} \lowertitleback{This poem book was set with% the help of {\KOMAScript} and {\LaTeX}} - \uppertitleback{Selfmockery Publishers} - \dedication{To my treasure hazel-hen\\ + \uppertitleback{Self-mockery Publishers} + \dedication{To my treasured hazel-hen\\ in eternal love\\ from your dormouse.} \maketitle \end{document} \end{lstcode} - Please use your own favorite pet names. + Please use your own favourite pet names to personalize it. \end{Example}% \fi% \EndIndexGroup |