diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-footnotes.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/common-footnotes.tex | 525 |
1 files changed, 286 insertions, 239 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-footnotes.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-footnotes.tex index a99f9abb53d..c08b203b298 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-footnotes.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-footnotes.tex @@ -1,6 +1,6 @@ % ====================================================================== % common-footnotes.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-footnotes.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,11 +46,11 @@ % ====================================================================== \KOMAProvidesFile{common-footnotes.tex} - [$Date: 2017-04-13 09:48:05 +0200 (Thu, 13 Apr 2017) $ + [$Date: 2018-03-30 09:37:06 +0200 (Fri, 30 Mar 2018) $ KOMA-Script guide (common paragraphs: Footnotes)] -\translator{Markus Kohm\and Krickette Murabayashi} +\translator{Markus Kohm\and Krickette Murabayashi\and Karl Hagen} -% Date of the translated German file: 2017-04-13 +% Date of the translated German file: 2018-01-29 \section{Footnotes} \seclabel{footnotes}% @@ -58,40 +58,69 @@ \BeginIndex{}{footnotes}% \IfThisCommonFirstRun{}{% - All of what is described in - \autoref{sec:\ThisCommonFirstLabelBase.footnotes} is generally - applicable. So if you have alread read and understood - \autoref{sec:\ThisCommonFirstLabelBase.footnotes} you can switch to - \autoref{sec:\ThisCommonLabelBase.footnotes.next}, + The information in \autoref{sec:\ThisCommonFirstLabelBase.footnotes} applies + equally to this chapter. So if you have already read and understood + \autoref{sec:\ThisCommonFirstLabelBase.footnotes}, you can skip ahead to + \autopageref{sec:\ThisCommonLabelBase.footnotes.next}, \autopageref{sec:\ThisCommonLabelBase.footnotes.next}.% + \IfThisCommonLabelBase{scrlttr2}{ % + If you do not use a \KOMAScript{} class, \Package{scrletter}% + \OnlyAt{\Package{scrletter}} relies on the + \hyperref[cha:scrextend]{\Package{scrextend}}\IndexPackage{scrextend}% + \important{\hyperref[cha:scrextend]{\Package{scrextend}}} package. + Therefore, see also \autoref{sec:scrextend.footnotes}, + \autopageref{sec:scrextend.footnotes} when using \Package{scrletter}.% + \iffalse% Umbruchkorrekturtext + \ Note in particular that in this case some typical \KOMAScript{} + extensions are not active by default\textnote{default}. Instead, the + footnotes make use of the class used, or the \LaTeX{} kernel.% + \fi% + }{}% } \IfThisCommonLabelBase{maincls}{% - \KOMAScript{}, unlike the standard classes, provides features for - configuration of the footnote block format.% + Unlike\textnote{\KOMAScript{} vs. standard classes} the standard classes, + \KOMAScript{} offers the ability to configure the format of the footnote + block.% }{% \IfThisCommonLabelBase{scrlttr2}{% - The commands for setting footnotes may be found at each introduction into - \LaTeX, e.\,g., at \cite{lshort}. \KOMAScript{} provides additional - features to change the footnote block format.% + You can find the basic commands to set footnotes in any introduction to + \LaTeX, for example \cite{lshort}. \KOMAScript{}% + \textnote{\KOMAScript{} vs. standard classes} provides additional features + to change the format of the footnote block. % + \iffalse % Umbruchoptimierung + + Whether footnotes should be allowed for letters depends very much on the + type of letter and its layout. For example, you should not allow + footnotes to overlap visually with the letterhead footer or be confused + with the courtesy-copy list. Doing so is the responsibility of the + user.% + + Since footnotes are rarely used in letters, examples in this section have + been omitted. If you need examples, you can find them in + \autoref{sec:\ThisCommonFirstLabelBase.footnotes}, + \autopageref{sec:\ThisCommonFirstLabelBase.footnotes}.% + \fi% }{% \IfThisCommonLabelBase{scrextend}{% - Package \Package{scrextend} supports all the footnote features of the - \KOMAScript{} classes. Nevertheless, by default the footnotes are under - full control of the used class. This changes as soon as command - \DescRef{\ThisCommonLabelBase.cmd.deffootnote} (see - \DescPageRef{\ThisCommonLabelBase.cmd.deffootnote}) has been used. - - Package \Package{scrextend} does not provide settings for the separation - line above the footnotes.% + The footnote capabilities of the \KOMAScript{} classes are also + provided by \Package{scrextend}. By default, the formatting of + footnotes is left to the class used. This changes as soon as you + issue the \DescRef{\ThisCommonLabelBase.cmd.deffootnote} command, + which is explained in detail on + \DescPageRef{\ThisCommonLabelBase.cmd.deffootnote}. + + The options for adjusting the dividing line above footnotes, however, + are not provided by \Package{scrextend}.% }{\InternalCommonFileUsageError}% }% -} +}% \begin{Declaration} \OptionVName{footnotes}{setting} + \Macro{multfootsep} \end{Declaration} -\IfThisCommonLabelBase{scrextend}{At several classes footnotes }{% +\IfThisCommonLabelBase{scrextend}{Many classes mark footnotes }{% Footnotes % \IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and @@ -101,49 +130,55 @@ \ChangedAt{v3.00}{\Class{scrlttr2}}% }{}% }% + are marked % }% -will be marked with a tiny superscript number in text by default. If more than -one footnote falls at the same place, one may think that it is only one -footnote with a very large number instead of multiple footnotes (i.\,e., -footnote 12 instead of footnotes 1 and 2). Using -\important{\OptionValue{footnotes}{multiple}} -\OptionValue{footnotes}{multiple}\IndexOption{footnotes=~multiple} will -separate multiple footnotes immediately next to each other by a separator -string. The predefined separator at -\DescRef{\ThisCommonLabelBase.cmd.multfootsep}\IndexCmd{multfootsep}\important{\DescRef{\ThisCommonLabelBase.cmd.multfootsep}} -is a single comma without space. The whole mechanism is compatible with -package -\Package{footmisc}\IndexPackage{footmisc}\important{\Package{footmisc}}, -Version~5.3d (see \cite{package:footmisc}). It is related not only to -footnotes placed using -\DescRef{\ThisCommonLabelBase.cmd.footnote}\IndexCmd{footnote}, but -\DescRef{\ThisCommonLabelBase.cmd.footnotemark}\IndexCmd{footnotemark} too. +by default in the text with a small superscript number. If several footnotes +appear in succession at the same point, it gives the impression that there is +one footnote with a large number rather than multiple footnotes (e.\,g. +footnote 12 instead of footnotes 1 and 2). +With\important{\OptionValue{footnotes}{multiple}} +\OptionValue{footnotes}{multiple}\IndexOption{footnotes=~multiple}, footnotes +that follow each other directly are separated with a delimiter instead. The +default delimiter in \Macro{multfootsep}\important{\Macro{multfootsep}} is +defined as a comma without a space: +\begin{lstcode} + \newcommand*{\multfootsep}{,} +\end{lstcode} +This can be redefined. -Command \DescRef{\ThisCommonLabelBase.cmd.KOMAoptions} or -\DescRef{\ThisCommonLabelBase.cmd.KOMAoption} may be used to switch back to -the default \OptionValue{footnotes}{nomultiple} at any time. If any problems -using another package that influences footnotes occur, it is recommended not -to use the option anywhere and not to change the \PName{setting} anywhere +The whole mechanism is compatible with the +\Package{footmisc}\IndexPackage{footmisc}\important{\Package{footmisc}} +package, version~5.3d to 5.5b (see \cite{package:footmisc}). It affects +footnote markers placed using +\DescRef{\ThisCommonLabelBase.cmd.footnote}\IndexCmd{footnote}, as well as +those placed directly with +\DescRef{\ThisCommonLabelBase.cmd.footnotemark}\IndexCmd{footnotemark}. + +You can switch back to the default +\OptionValue{footnotes}{nomultiple} at any time using the +\DescRef{\ThisCommonLabelBase.cmd.KOMAoptions} or +\DescRef{\ThisCommonLabelBase.cmd.KOMAoption} command. However, if you +encounter any problems using another package that alters the footnotes, you +should not use this option, nor should you change the \PName{setting} anywhere inside the document. -A summary of the available \PName{setting} values of \Option{footnotes} may -be found at \autoref{tab:\ThisCommonFirstLabelBase.footnotes}% +A summary of the available \PName{setting} values of \Option{footnotes} can +be found in \autoref{tab:\ThisCommonFirstLabelBase.footnotes}% \IfThisCommonFirstRun{% . \begin{table} - \caption[{Available values for option \Option{footnotes}}] - {Available values for option \Option{footnotes} setting up footnotes} + \caption[{Available values for the \Option{footnotes} option}] + {Available values for the \Option{footnotes} option to configure footnotes} \label{tab:\ThisCommonLabelBase.footnotes} \begin{desctabular} \pventry{multiple}{% - At sequences of immediately following footnote marks, consecutive - marks will be separated by + Consecutive footnote marks will be separated by \DescRef{\ThisCommonLabelBase.cmd.multfootsep}\IndexCmd{multfootsep}.% - \IndexOption{footnotes~=\PValue{multiple}}}% + \IndexOption{footnotes~=\textKValue{multiple}}}% \pventry{nomultiple}{% - Immediately following footnotes will be handled like single footnotes - and not separated from each other.% - \IndexOption{footnotes~=\PValue{nomultiple}}}% + Consecutive footnote marks will be handled like single footnotes + and not separated from each other.% + \IndexOption{footnotes~=\textKValue{nomultiple}}}% \end{desctabular} \end{table}% }{, @@ -158,15 +193,14 @@ be found at \autoref{tab:\ThisCommonFirstLabelBase.footnotes}% \Macro{footnotemark}\OParameter{number}% \Macro{footnotetext}\OParameter{number}\Parameter{text}% \Macro{multiplefootnoteseparator}% - \Macro{multfootsep} \end{Declaration}% -Similar to the standard classes, footnotes in {\KOMAScript} are produced with -the \Macro{footnote} command, or alternatively the paired usage of the -commands \Macro{footnotemark} and \Macro{footnotetext}. As in the standard -classes, it is possible that a page break occurs within a footnote. Normally -this happens if the footnote mark is placed so near the bottom of a page as to -leave {\LaTeX} no choice but to break the footnote onto the next page. -\KOMAScript% +Footnotes in \KOMAScript{} are produced, as they are in the standard classes, +with the \Macro{footnote} command, or alternatively the pair of commands +\Macro{footnotemark} and \Macro{footnotetext}. As in the standard classes, +it is possible for a page break to occur within a footnote. Normally this +happens if the footnote mark is placed so near the bottom of a page as to +leave \LaTeX{} no choice but to move the footnote to the next page. +Unlike\textnote{\KOMAScript{} vs. standard classes} \IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% @@ -175,95 +209,89 @@ leave {\LaTeX} no choice but to break the footnote onto the next page. \ChangedAt{v3.00}{\Class{scrlttr2}}% }{}% } % -, unlike the standard classes, can recognize and separate consecutive -footnotes -automatically. See\important{\DescRef{\ThisCommonLabelBase.option.footnote}} -the previously documented option -\DescRef{\ThisCommonLabelBase.option.footnotes} for this. +the standard classes, \KOMAScript{} can recognize and separate consecutive +footnotes automatically. +See\important{\DescRef{\ThisCommonLabelBase.option.footnotes}} the previously +documented option \DescRef{\ThisCommonLabelBase.option.footnotes}. -If you want to set the separator manually, you may use -\Macro{multiplefootnoteseparator}. Note that this command should not be -redefined, because it has been defined not only to be the separator string but -also the type style, i.\,e., font size and superscript. The separator string -without type style may be found at \Macro{multfootsep}. The predefined default -is -\begin{lstcode} - \newcommand*{\multfootsep}{,} -\end{lstcode} -and may be changed by redefining the command. +If instead you want to place this delimiter manually, you can do so by calling +\Macro{multiplefootnoteseparator}. However, users should not redefine this +command, as it contains not only the delimiter but also the delimiter's +formatting, for example the font size selection and the superscript. The +delimiter itself is stored in the previously described +\DescRef{\ThisCommonLabelBase.cmd.multfootsep}% +\important{\DescRef{\ThisCommonLabelBase.cmd.multfootsep}}% +\IndexCmd{multfootsep} command. -\IfThisCommonLabelBase{scrlttr2}{% - Examples and additional information may be found at +\IfThisCommonFirstRun{\iftrue}{% + You can find examples and additional hints in \autoref{sec:\ThisCommonFirstLabelBase.footnotes} from - \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.footnote} onward.% - \iffalse% -}{\csname iftrue\endcsname}% + \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.footnote}.% + \csname iffalse\endcsname }% \begin{Example} \phantomsection\xmpllabel{cmd.footnote}% - Assume you want to place two footnotes following a single word. First you - may try + Suppose you want to put two footnotes after a single word. First you try \begin{lstcode} Word\footnote{1st footnote}\footnote{2nd footnote} \end{lstcode} - for this. Assume that the footnotes will be numbered with 1 and 2. Now the - reader may think it's a single footnote 12, because the 2 - immediately follows the 1. You may change this using + Let's assume that the footnotes are numbered 1 and 2. Since the two + footnote numbers follow each other directly, it creates the impression + that the word has only one footnote numbered 12. You can change this + behaviour by using \begin{lstcode} \KOMAoptions{footnotes=multiple} \end{lstcode} - which would switch on the automatic recognition of footnote sequences. As - an alternative you may use + to enable the automatic recognition of footnote sequences. Alternatively, + you can use \begin{lstcode} - Word\footnote{1st footnote}% + word\footnote{Footnote 1}% \multiplefootnoteseparator - \footnote{2nd footnote} + \footnote{Footnote 2} \end{lstcode} - This should give you the wanted result even if the automatic solution - would fail or could not be used. - - Further, assume you want the footnotes separated not only by a single - comma, but by a comma and a white space. In this case you may redefine + This should give you the desired result even if automatic detection + fails or cannot be used for some reason. + + Now suppose you also want the footnote numbers to be separated not just by + a comma, but by a comma and a space. In this case, write \begin{lstcode} \renewcommand*{\multfootsep}{,\nobreakspace} \end{lstcode} - at the document preamble. \Macro{nobreakspace}\IndexCmd{nobreakspace} - instead of a usual space character has been used in this case to avoid - paragraph or at least page breaks within footnote sequences. + in the preamble of your document. + \Macro{nobreakspace}\IndexCmd{nobreakspace} was used here instead of a + normal space to avoid paragraph or page breaks within the sequence of + footnotes. \end{Example}% \fi% +% \EndIndexGroup \begin{Declaration} \Macro{footref}\Parameter{reference} \end{Declaration} -Sometimes% -\IfThisCommonLabelBase{maincls}{% +Sometimes\IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% }{% \IfThisCommonLabelBase{scrlttr2}{% \ChangedAt{v3.00}{\Class{scrlttr2}}% - }{}% -} % -there are single footnotes to multiple text passages. The least sensible way -to typeset this would be to repeatedly use -\DescRef{\ThisCommonLabelBase.cmd.footnotemark} with the same manually set -number. The disadvantages of this method would be that you have to know the -number and manually fix all the -\DescRef{\ThisCommonLabelBase.cmd.footnotemark} commands, and if the number -changes because of adding or removing a footnote before, each -\DescRef{\ThisCommonLabelBase.cmd.footnotemark} would have to be -changed. Because of this, \KOMAScript{} provides the use of the -\Macro{label}\IndexCmd{label}\important{\Macro{label}} mechanism in such -cases. After simply setting a \Macro{label} inside the footnote, -\Macro{footref} may be used to mark all the other text passages with the same -footnote mark. -\IfThisCommonLabelBase{scrlttr2}{\iffalse}{\csname iftrue\endcsname}% + }{}} you have a footnote in a document to which there are several references +in the text. An inconvenient way to typeset this would be to use +\DescRef{\ThisCommonLabelBase.cmd.footnotemark} to set the number directly. +The disadvantage of this method is that you need to know the number and +manually set every \DescRef{\ThisCommonLabelBase.cmd.footnotemark} command. +And if the number changes because you add or remove an earlier footnote, you +will have to change each \DescRef{\ThisCommonLabelBase.cmd.footnotemark}. +\KOMAScript{} thefore offers the \Macro{label}\IndexCmd{label}% +\important{\Macro{label}} mechanism to handle such cases. After placing a +\Macro{label} inside the footnote, you can use \Macro{footref} to set all the +other marks for this footnote in the text. +\IfThisCommonFirstRun{\iftrue}{\csname iffalse\endcsname}% \begin{Example} \phantomsection\xmpllabel{cmd.footref}% - Maybe you have to mark each trade name with a footnote which states that - it is a registered trade name. You may write, e.\,g., + You are writing a text in which you must create a footnote each time a + brand name occurs, indicating that it is a registered trademark. You can + write, for example, \begin{lstcode} Company SplishSplash\footnote{This is a registered trade name. All rights are reserved.\label{refnote}} @@ -277,16 +305,20 @@ footnote mark. commands. The footnote text will be produced by \DescRef{\ThisCommonLabelBase.cmd.footnote}. \end{Example} -\fi -Because of setting the additional footnote marks using the \Macro{label} -mechanism, changes of the footnote numbers will need at least two \LaTeX{} -runs to ensure correct numbers for all \Macro{footref} marks.% -\IfThisCommonLabelBase{scrlttr2}{ % - An example for the usage \Macro{footref} can be found in - \autoref{sec:\ThisCommonFirstLabelBase.footnotes} on - \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.footref}.% -}{}% -% + \fi When setting footnote marks with the \Macro{label} mechanism, any + changes to the footnote numbers will require at least two \LaTeX{} runs to + ensure correct numbers for all \Macro{footref} marks.% + \IfThisCommonLabelBaseOneOf{scrlttr2,scrextend}{\par% + You can find an example of how to use \Macro{footref} in + \autoref{sec:\ThisCommonFirstLabelBase.footnotes} on + \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.footref}.% + }{} \IfThisCommonLabelBase{scrlttr2}{}{% + \par + Note\textnote{Attention!} that statements like \Macro{ref}\IndexCmd{ref} + or \Macro{pageref}\IndexCmd{pageref} are fragile and therefore you should + put \Macro{protect}\IndexCmd{protect} in front of them if they appear in + moving arguments such as headings.% + }% \EndIndexGroup @@ -296,37 +328,48 @@ runs to ensure correct numbers for all \Macro{footref} marks.% \Macro{deffootnotemark}\Parameter{definition}% \Macro{thefootnotemark} \end{Declaration}% -Footnotes are formatted slightly differently in {\KOMAScript} to in the -standard classes. As in the standard classes the footnote mark in the text is -depicted using a small superscripted number. The same formatting is used in -the footnote itself. The mark in the footnote is type-set right-aligned in a -box with width \PName{mark width}. The first line of the footnote follows -directly. +\IfThisCommonLabelBase{maincls}{The \KOMAScript{} classes set}{\KOMAScript{} + sets}\textnote{\KOMAScript{} vs. standard classes} footnotes slightly +differently than the standard classes do. As in the standard classes, the +footnote mark in the text is rendered with small, superscript numbers. The +same formatting is used in the footnote itself. The mark in the footnote is +typeset right-justified in a box with a width of \PName{mark width}. The first +line of the footnote follows directly. -All following lines will be indented by the length of \PName{indent}. If the +All subsequent lines will be indented by the length of \PName{indent}. If the optional parameter \PName{mark width} is not specified, it defaults to -\PName{indent}. If the footnote consists of more than one paragraph, then the -first line of a paragraph is indented, in addition to \PName{indent}, by the -value of \PName{parindent}. +\PName{indent}. If the footnote consists of more than one paragraph, the first +line of each paragraph is indented by the value of \PName{parindent}. -\hyperref[fig:maincls.deffootnote]{Figure~\ref*{fig:maincls.deffootnote}} % -\IfThisCommonFirstRun{at \autopageref{fig:maincls.deffootnote} }% -illustrates the layout parameters. The default configuration of the -{\KOMAScript} classes is: +\autoref{fig:\ThisCommonFirstLabelBase.deffootnote} % +\IfThisCommonFirstRun{}{on + \autopageref{fig:\ThisCommonFirstLabelBase.deffootnote} }{}% +shows the different parameters% +\IfThisCommonLabelBase{maincls}{ again}{}% +. The default configuration of the \KOMAScript{} classes is as follows: +\IfThisCommonLabelBase{scrextend}{\iftrue}{\csname iffalse\endcsname}% +\begin{lstcode} + \deffootnote[1em]{1.5em}{1em}{% + \textsuperscript{\thefootnotemark}} +\end{lstcode} +\else \begin{lstcode} - \deffootnote[1em]{1.5em}{1em} - {\textsuperscript{\thefootnotemark}} + \deffootnote[1em]{1.5em}{1em}{% + \textsuperscript{\thefootnotemark}% + } \end{lstcode} +\fi% \DescRef{\ThisCommonLabelBase.cmd.textsuperscript} controls both the -superscript and the smaller font size. Command \Macro{thefootnotemark} is the -current footnote mark without any formatting.% +superscript and the smaller font size. The command \Macro{thefootnotemark} +contains the current footnote mark without any formatting.% \IfThisCommonLabelBase{scrextend}{ % - Package \Package{scrextend} in contrast to this does not change the default - footnote settings of the used class. Loading the package does not change any - type style of footnote marks or footnote text in general. You have to copy - the above shown source to use the default settings of the \KOMAScript{} - classes with \Package{scrextend}. This may be done immediately after loading - package \Package{scrextend}.% + The \Package{scrextend} package, by contrast, does not change the default + footnote settings of the class you are using. Simply loading the package, + therefore, should not lead to any changes in the formatting of footnote + marks or footnote text. To use the default settings of the \KOMAScript{} + classes with \Package{scrextend}, you must change the settings above + yourself. For example, you can insert the line of code above immediately + after loading the \Package{scrextend} package.% }{}% \IfThisCommonLabelBase{maincls}{% @@ -385,81 +428,76 @@ current footnote mark without any formatting.% \BeginIndexGroup \BeginIndex{FontElement}{footnote}\LabelFontElement{footnote}% \BeginIndex{FontElement}{footnotelabel}\LabelFontElement{footnotelabel}% -The% -\IfThisCommonLabelBase{maincls}{% +The footnote\IfThisCommonLabelBase{maincls}{% \ChangedAt{v2.8q}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}% -}{}} font element \FontElement{footnote}\important{\FontElement{footnote}} -determines the font of the footnote including the footnote mark. Using the -element \FontElement{footnotelabel}\important{\FontElement{footnotelabel}} the -font of the footnote mark can be changed separately with the commands +}}{}, including the footnote mark, uses the font specified in the +\FontElement{footnote}\important{\FontElement{footnote}} element. You can +change the font of the footnote mark separately using the \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and -\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} (see +\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} commands (see \autoref{sec:\ThisCommonLabelBase.textmarkup}, -\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}). Please refer also to -\autoref{tab:\ThisCommonLabelBase.fontelements}, +\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}) +for the \FontElement{footnotelabel}\important{\FontElement{footnotelabel}} +element. See also \autoref{tab:\ThisCommonLabelBase.fontelements}, \autopageref{tab:\ThisCommonLabelBase.fontelements}. -Default setting is no change in the font.% +The default setting is no change to the font.% \IfThisCommonLabelBase{scrextend}{ % - With \Package{scrextend} the elements may change the fonts only if the - footnotes are handled by the package, i.\,g., after using + However, with \Package{scrextend} these elements will only change the fonts + if footnotes are handled by the package, that is, after using \Macro{deffootnote}.% -}{} Please don't misuse the element for other purpose, i.e., to use ragged -right footnotes (see also \DescRef{\LabelBase.cmd.raggedfootnote}, +}{} Please don't misuse this element for other purposes, for example to set +the footnotes ragged right (see also \DescRef{\LabelBase.cmd.raggedfootnote}, \DescPageRef{\LabelBase.cmd.raggedfootnote}). \BeginIndex{FontElement}{footnotereference}% \LabelFontElement{footnotereference}% The footnote mark in the text is defined separately from the mark in front of the actual footnote. This is done with -\Macro{deffootnotemark}. Default setting is: +\Macro{deffootnotemark}. The default setting is: \begin{lstcode} \deffootnotemark{% \textsuperscript{\thefootnotemark}} \end{lstcode} -In the above% -\IfThisCommonLabelBase{maincls}{% +With\IfThisCommonLabelBase{maincls}{% \ChangedAt{v2.8q}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% -}{} the font for the element -\FontElement{footnotereference}\important{\FontElement{footnotereference}} is -applied (see \autoref{tab:\ThisCommonLabelBase.fontelements}, -\autopageref{tab:\ThisCommonLabelBase.fontelements}). Thus the footnote marks -in the text and in the footnote itself are identical. The font can be changed +}{} this default, the font for the +\FontElement{footnotereference}\important{\FontElement{footnotereference}} +element is used (see \autoref{tab:\ThisCommonLabelBase.fontelements}, +\autopageref{tab:\ThisCommonLabelBase.fontelements}). Thus, the footnote marks +in the text and in the footnote itself are identical. You can change the font with the commands \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and \DescRef{\ThisCommonLabelBase.cmd.addtokomafont} (see \autoref{sec:\ThisCommonLabelBase.textmarkup}, \DescPageRef{\ThisCommonLabelBase.cmd.setkomafont})% -\IfThisCommonLabelBase{scrextend}{ after usage of \Macro{deffootnotemark}}{}. +\IfThisCommonLabelBase{scrextend}{ after \Macro{deffootnotemark} is used}{}. -\IfThisCommonLabelBase{scrlttr2}{% - Examples may be found at \autoref{sec:\ThisCommonFirstLabelBase.footnotes}, - from \DescPageRef{\ThisCommonFirstLabelBase.cmd.deffootnote} onwards.% - \iffalse% -}{\csname iftrue\endcsname}% +\IfThisCommonFirstRun{\iftrue}{\csname iffalse\endcsname}% \begin{Example} - \phantomsection\xmpllabel{cmd.deffootnote}% - A\textnote{Hint!} feature often asked for is footnote marks which are - neither in superscript nor in a smaller font size. They should not touch - the footnote text but be separated by a small space. This can be - accomplished as follows: + \phantomsection + \xmpllabel{cmd.deffootnote}% + One\textnote{Hint!} feature that is often requested is footnote marks + which are neither in superscript nor in a smaller font. They should not + touch the footnote text but be separated by a small space. You can + accomplish this as follows: \begin{lstcode} \deffootnote{1em}{1em}{\thefootnotemark\ } \end{lstcode} - The footnote mark and the following space are therefore set - right-aligned into a box of width 1\Unit{em}. The following lines of - the footnote text are also indented by 1\Unit{em} from the left - margin. - - Another\textnote{Hint!} often requested footnote layout is left-aligned - footnote marks. These can be obtained with: + This will set the footnote mark and subsequent space right-aligned in a + box of width 1\Unit{em}. The lines of the footnote text that follow are + also indented by 1\Unit{em} from the left margin. + + Another\textnote{Hint!} layout that is often requested is footnote marks + that are left-aligned. You can obtain them with the following + definition: \begin{lstcode} \deffootnote{1.5em}{1em}{% \makebox[1.5em][l]{\thefootnotemark}} \end{lstcode} - If you want however only to change the font for all footnotes, for example - to sans serif, you can solve this problem simply by using the commands + If, however you want to change the font for all footnotes, for example + to sans serif, this can easily be done with the commands \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and \DescRef{\ThisCommonLabelBase.cmd.addtokomafont} (see \autoref{sec:\ThisCommonLabelBase.textmarkup}, @@ -469,21 +507,23 @@ with the commands \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and \end{lstcode} \end{Example}% \IfThisCommonLabelBase{scrextend}{}{% - As demonstrated with the examples above, the simple user interface of - {\KOMAScript} provides a great variety of different footnote - formattings.% + As the examples show, {\KOMAScript} allows a wide variety of different + footnote formats with this simple user interface.% }% \fi% +\IfThisCommonFirstRun{}{% + For examples, see \autoref{sec:\ThisCommonFirstLabelBase.footnotes}, + \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.deffootnote}.% +}{}% % \EndIndexGroup \EndIndexGroup - +\IfThisCommonLabelBase{scrextend}{\iffalse}{\csname iftrue\endcsname} \begin{Declaration} \Macro{setfootnoterule}\OParameter{thickness}\Parameter{length}% \end{Declaration}% -Generally% -\IfThisCommonLabelBase{maincls}{% +Generally,\IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.06}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% }{% @@ -494,22 +534,20 @@ Generally% \ChangedAt{v3.06}{\Package{scrextend}}% }{}% }% -} % -a horizontal rule will be placed between the text area and the footnote -area. But normally this rule is not as long as the width of the typing -area. With Command \Macro{setfootnoterule} you may change the thickness and -the width of that rule. Thereby the parameters \PName{thickness} and -\PName{length} will be evaluated not at definition time but when setting the -rule itself. If optional argument \PName{thickness} ha been omitted the -thickness of the rule will not be changed. Empty arguments \PName{thickness} -or \PName{length} are also allowed and do not change the corresponding -parameter. Using implausible values may result in warning messages not only -setting the arguments but also when \KOMAScript{} uses the parameters. +} a horizontal rule is set between the text area and the footnote area, but +normally this rule does not extend the full width of the type area. With +\Macro{setfootnoterule}, you can set the exact thickness and length of the +rule. In this case, the parameters \PName{thickness} and \PName{length} are +only evaluated when setting the rule itself. If the optional argument +\PName{thickness} has been omitted, the thickness of the rule will not be +changed. Empty arguments for \PName{thickness} or \PName{length} are also +allowed and do not change the corresponding parameters. Using absurd values +will result in warning messages both when setting and when using the +parameters. \BeginIndexGroup \BeginIndex{FontElement}{footnoterule}\LabelFontElement{footnoterule}% -With element \FontElement{footnoterule}\important{\FontElement{footnoterule}} -the color% +You can% \IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.07}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% @@ -522,21 +560,23 @@ the color% }{}% }% } % -of the rule may be changed using the commands -\DescRef{\ThisCommonLabelBase.cmd.setkomafont} and -\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} for element -\FontElement{footnoterule} (see \autoref{sec:\ThisCommonLabelBase.textmarkup}, -\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}). Default is no change of -font or color. For color changes a color package like -\Package{xcolor}\IndexPackage{xcolor}\important{\Package{xcolor}} would be -needed.% +change the colour of the rule with the +\FontElement{footnoterule}\important{\FontElement{footnoterule}} element using +the \DescRef{\ThisCommonLabelBase.cmd.setkomafont} and +\DescRef{\ThisCommonLabelBase.cmd.addtokomafont} commands (see +\autoref{sec:\ThisCommonLabelBase.textmarkup}, +\DescPageRef{\ThisCommonLabelBase.cmd.setkomafont}). The default is no change +of font or colour. In order to change the colour, you must also load a colour +package like +\Package{xcolor}\IndexPackage{xcolor}\important{\Package{xcolor}}.% \EndIndexGroup \EndIndexGroup +\fi \begin{Declaration} \Macro{raggedfootnote} \end{Declaration} -The default% +By default% \IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.23}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% @@ -549,24 +589,31 @@ The default% }{}% }% } % -for the alignment of footnotes in \KOMAScript{} is justified, same as the -default in the standard classes. But \KOMAScript{} provides -\Macro{raggedfootnote} to change this default. Valid definitions of -\Macro{raggedfootnote} would be \Macro{raggedright}\IndexCmd{raggedright}, +\KOMAScript{} justifies footnotes just as in the standard classes. +But\textnote{\KOMAScript{} vs. standard classes} you can also change the +justification separately from the rest of the document by redefining +\Macro{raggedfootnote}. Valid definitions are +\Macro{raggedright}\IndexCmd{raggedright}, \Macro{raggedleft}\IndexCmd{raggedleft}, -\Macro{centering}\IndexCmd{centering}, \Macro{relax}\IndexCmd{relax} or the -empty definition, which is the default. You can also use the alignment -commands of package \Package{ragged2e}\IndexPackage{ragged2e} (see -\cite{package:ragged2e}). - -\begin{Example} - Assuming you are using footnotes only to show informations with very large - links that cannot be printed justified accommdatingly. You can use +\Macro{centering}\IndexCmd{centering}, \Macro{relax}\IndexCmd{relax} or an +empty definition, which is the default. The alignment commands of the +\Package{ragged2e}\IndexPackage{ragged2e} package are also valid (see +\cite{package:ragged2e}). \IfThisCommonLabelBase{scrextend}{% + You can find a suitable example in + \autoref{sec:\ThisCommonFirstLabelBase.footnotes}, + \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.raggedfootnote}.% + \iffalse }{\csname iftrue\endcsname}% + \begin{Example} + \phantomsection\xmpllabel{cmd.raggedfootnote}% + Suppose you are using footnotes only to provide references to very long + links, where line breaks would produce poor results if justified. You can + use \begin{lstcode} \let\raggedfootnote\raggedright \end{lstcode} - in your document preamble to switch to ragged-right footnotes. -\end{Example}% + in your document's preamble to switch to ragged-right footnotes. + \end{Example}% +\fi \EndIndexGroup % \EndIndexGroup |