diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-parmarkup.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/common-parmarkup.tex | 209 |
1 files changed, 112 insertions, 97 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-parmarkup.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-parmarkup.tex index dad2091a6f1..647d09dde34 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-parmarkup.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-parmarkup.tex @@ -1,6 +1,6 @@ % ====================================================================== % common-parmarkup.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-parmarkup.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,94 +46,107 @@ % ====================================================================== \KOMAProvidesFile{common-parmarkup.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 paragraph: Paragraph Markup)] -\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-31 -\section{Paragraph Markup} +\section{Marking Paragraphs} \seclabel{parmarkup}% \BeginIndexGroup -\BeginIndex{}{paragraph>markup}% +\BeginIndex{}{paragraph>marking}% \IfThisCommonLabelBase{maincls}{% The\textnote{paragraph indent vs. paragraph spacing} standard classes normally set paragraphs\Index[indexmain]{paragraph} indented and without any - vertical inter-paragraph space. This is the best solution when using a - regular page layout, like the ones produced with the \Package{typearea} + vertical, inter-paragraph space. This is the best solution when using a + regular page layout like the ones produced with the \Package{typearea} package. If neither indentation nor vertical space is used, only the length - of the last line would give the reader a reference point. In extreme cases, - it is very difficult to detect whether a line is full or not. Furthermore, - it is found that a marker at the paragraph's end tends to be easily - forgotten by the start of the next line. A marker at the paragraph's - beginning is more easily remembered. Inter-paragraph spacing has the + of the last line would give the reader a guide to the paragraph break. In + extreme cases, it is very difficult to tell whether a line is full or not. + Furthermore, typographers find that a signal given at the paragraph's end is + easily forgotten by the start of the next line. A signal at the paragraph's + beginning is more easily remembered. Inter-paragraph spacing has the drawback of disappearing in some contexts. For instance, after a displayed formula it would be impossible to detect if the previous paragraph continues - or if a new one begins. Also, when starting to read at the top of a new page - it might be necessary to look at the previous page in order determine if a - new paragraph has been started or not. All these problems disappear when - using indentation. A combination of indentation and vertical inter-paragraph - spacing is extremely redundant and therefore should be avoided. The - indentation\Index[indexmain]{indentation} is perfectly sufficient by - itself. The only drawback of indentation is the reduction of the line - length. The use of inter-paragraph spacing\Index{paragraph>spacing} is - therefore justified when using short lines, for instance in a newspaper.% + or a new one begins. Also, at the top of a new page, it might be necessary + to look at the previous page to determine if a new paragraph has been + started or not. All these problems disappear when using indentation. A + combination of indentation and vertical inter-paragraph spacing is redundant + and therefore should be avoided. Indentation\Index[indexmain]{indentation} + alone is sufficient. The only drawback of indentation is that it shortens + the line length. The use of inter-paragraph spacing\Index{paragraph>spacing} + is therefore justified when using short lines, such as in a newspaper.% }{% \IfThisCommonLabelBase{scrlttr2}{% - In the preliminaries of \autoref{sec:maincls.parmarkup}, - \autopageref{sec:maincls.parmarkup} it was argued why paragraph indent is - preferred over paragraph spacing. But the elements the argumentation - depends on, i.\,e., figures, tables, lists, equations, and even new pages, - are rare. Often letters are not so long that an oversighted paragraph will - have serious consequences to the readability of the document. Because of - this, the arguments are less serious for standard letters. This may be one - reason that in letters you often encounter paragraphs marked not with - indentation of the first line, but with a vertical skip between them. But - there may be still some advantages of the paragraph indent. One may be - that such a letter is highlighted in the mass of letters. Another may be - that the \emph{corporate identity} need not be broken for letters only.% + The preliminaries of \autoref{sec:maincls.parmarkup}, + \autopageref{sec:maincls.parmarkup} explain why paragraph indentation is + preferred to paragraph spacing. But the elements to which this explanation + refers, for example figures, tables, lists, equations, and even new pages, + are rare in normal letters. Letters are usually not so long that an + unrecognised paragraph will have serious consequences to the readability + of the document. The arguments for indentation, therefore, are less + consequential for standard letters. This may be one reason that you often + find paragraphs in letters marked with vertical spacing. But two + advantages of paragraph indentation remain. One is that such a letter + stands out from the crowd. Another is that it maintains the \emph{brand + identity}, that is the uniform appearance, of all documents from a single + source.% }{\InternalCommonFileUsageError}% } % \IfThisCommonFirstRun{}{% - Apart from these suggestions, everything that has been written at + Apart from these suggestions, the information described in \autoref{sec:\ThisCommonFirstLabelBase.parmarkup} for the other - \KOMAScript{} classes is valid for letters too. So if you have alread read + \KOMAScript{} classes is valid for letters too. So if you have already read and understood \autoref{sec:\ThisCommonFirstLabelBase.parmarkup} you can - jump to \autoref{sec:\ThisCommonLabelBase.parmarkup.next} on + skip ahead to \autoref{sec:\ThisCommonLabelBase.parmarkup.next} on \autopageref{sec:\ThisCommonLabelBase.parmarkup.next}.% + \IfThisCommonLabelBase{scrlttr2}{ % + This also applies if you work not with the + \Class{scrlttr2}\OnlyAt{scrlttr2} class but with the \Package{scrletter} + package. The package does not provide its own settings for paragraph + formatting but relies entirely on the class being used.% + }{}% } \begin{Declaration} - \OptionVName{parskip}{manner} + \OptionVName{parskip}{method} \end{Declaration} \IfThisCommonLabelBase{maincls}{% - Once in a while there are requests for a document layout with vertical - inter-paragraph spacing instead of indentation. The \KOMAScript{} classes - provide with option \Option{parskip}\ChangedAt{v3.00}{\Class{scrbook}\and - \Class{scrreprt}\and \Class{scrartcl}} several capabilities to use - inter-paragraph spacing instead of paragraph indent.% + Once in a while you may require a document layout with vertical + inter-paragraph spacing instead of indentation. The \KOMAScript{} classes + provide several ways to accomplish this with the + \Option{parskip}\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and + \Class{scrartcl}} option.% }{% \IfThisCommonLabelBase{scrlttr2}{% - Especially in letters you often encounter paragraphs marked not with - indentation of the first line, but with a vertical skip between - them. \KOMAScript{} class \Class{scrlttr2} provides several capabilities for - this.% + In letters, you often encounter paragraphs marked not by indentation of + the first line but by a vertical space between them. The \KOMAScript{} + class \Class{scrlttr2}\OnlyAt{scrlttr2} provides ways to accomplish this + with the \Option{parskip} option.% }{\InternalCommonFileUsageError}% } % -The \PName{manner} consists of two elements. The first element is either -\PValue{full} or \PValue{half}, meaning the space amount of one line or only -half of a line. The second element is ``\PValue{*}'', ``\PValue{+}'', or -``\PValue{-}'', and may be omitted. Without the second element the last line -of a paragraph will end with white space of at least 1\Unit{em}. With the plus -character as second element the white space amount will be a third, and with -the asterisk a fourth, of the width of a normal line. The minus variant does -not take care about the white space at the end of the last line of a -paragraph. +The \PName{method} consists of two elements. The first element is either +\PValue{full}\important{\OptionValue{parskip}{full}\\ + \OptionValue{parskip}{half}} or \PValue{half}, where \PValue{full} stands +for a paragraph spacing of one line and \PValue{half} stands for a paragraph +spacing of half a line. The second element consists of one of the characters +``\PValue{*}'', ``\PValue{+}'', or ``\PValue{-}'' and can be omitted. Without +the second element\important{\OptionVName{parskip}{distance}}, the final line +of a paragraph will end with a white space of at least 1\Unit{em}. With the +plus character as the second element% +\important{\OptionValue{parskip}{\PName{distance}+}}, the white space will be +at least one third\,---\,and with the +asterisk\important{\OptionValue{parskip}{\PName{distance}*}} one +fourth\,---\,the width of a normal line. With the minus variant% +\important{\OptionValue{parskip}{\PName{Abstand}-}}, no provision is made for +white space in the last line of a paragraph. -The setting may be changed at any place inside the document. In this case the -command \Macro{selectfont}\IndexCmd{selectfont}% +You can change the setting at any time. If you change it inside the document, +the \Macro{selectfont}\IndexCmd{selectfont}% \IfThisCommonLabelBase{maincls}{% \ChangedAt{v3.08}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% @@ -144,19 +157,20 @@ command \Macro{selectfont}\IndexCmd{selectfont}% \InternalComonFileUsageError% }% } % -will be called implicitly. The change will be valid and may be seen from the -next paragraph. +command will be called implicitly. Changes to paragraph spacing within a +paragraph will not be visible until the end of the paragraph. -Besides the resulting eight possible combinations for \PName{manner}, the values -for simple switches shown at \autoref{tab:truefalseswitch}, -\autopageref{tab:truefalseswitch} may be used. Switching on the option would -be the same as using \PValue{full} without annex and therefore will result in -inter-paragraph spacing of one line with at least 1\Unit{em} white space at -the end of the last line of each paragraph. Switching off the options would -reactivate the default of 1\Unit{em} indent at the first line of the -paragraph instead of paragraph spacing. All the possible values of option -\Option{parskip} are shown in -\autoref{tab:\ThisCommonFirstLabelBase.parskip}% +In addition to the resulting eight combinations for \PName{method}, you can +use the values for simple switches shown in \autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Activating the option% +\important{\Option{parskip}\\\OptionValue{parskip}{true}} corresponds to using +\PValue{full} with no second element and therefore results in inter-paragraph +spacing of one line with at least 1\Unit{em} white space at the end of the +last line of each paragraph. Deactivating% +\important{\OptionValue{parskip}{false}} the option re-activates the default +indentation of 1\Unit{em} at the first line of the paragraph instead of +paragraph spacing. A summary of all possible values for \PName{method} are +shown in \autoref{tab:\ThisCommonFirstLabelBase.parskip}% \IfThisCommonFirstRun{.% \begin{desclist} % Umbruchkorrektur @@ -165,54 +179,55 @@ paragraph instead of paragraph spacing. All the possible values of option % \begin{table} \desccaption % \caption - [{Possible values of option \Option{parskip}}]{% - Possible values of option \Option{parskip} to select - the paragraph mark\label{tab:\ThisCommonFirstLabelBase.parskip}% + [{Available values of option \Option{parskip}}]{% + Available values of option \Option{parskip} to select + how paragraph are + distinguished\label{tab:\ThisCommonFirstLabelBase.parskip}% }% {% - Possible values of option \Option{parskip} (\emph{continuation})% + Available values of option \Option{parskip} (\emph{continuation})% }% % \begin{desctabular} \entry{\PValue{false}, \PValue{off}, \PValue{no}% - \IndexOption{parskip~=\PValue{false}}}{% + \IndexOption{parskip~=\textKValue{false}}}{% paragraph indentation instead of vertical space; the last line of a - paragraph may be arbitrarily filled}% + paragraph can be arbitrarily filled}% \entry{\PValue{full}, \PValue{true}, \PValue{on}, \PValue{yes}% - \IndexOption{parskip~=\PValue{full}}% + \IndexOption{parskip~=\textKValue{full}}% }{% one line vertical space between paragraphs; there must be at least 1\Unit{em} free space in the last line of a paragraph}% \pventry{full-}{% one line vertical space between paragraphs; the last line of a paragraph - may be arbitrarily filled\IndexOption{parskip~=\PValue{full-}}}% + can be arbitrarily filled\IndexOption{parskip~=\textKValue{full-}}}% \pventry{full+}{% one line vertical space between paragraphs; there must be at least a third - of a line free space at the end of a - paragraph\IndexOption{parskip~=\PValue{full+}}}% + of a line of free space at the end of a + paragraph\IndexOption{parskip~=\textKValue{full+}}}% \pventry{full*}{% one line vertical space between paragraphs; there must be at least a - quarter of a line free space at the end of a - paragraph\IndexOption{parskip~=\PValue{full*}}}% + quarter of a line of free space at the end of a + paragraph\IndexOption{parskip~=\textKValue{full*}}}% \pventry{half}{% half a line vertical space between paragraphs; there must be at least 1\Unit{em} free space in the last line of a - paragraph\IndexOption{parskip~=\PValue{half}}}% + paragraph\IndexOption{parskip~=\textKValue{half}}}% \pventry{half-}{% one line vertical space between - paragraphs\IndexOption{parskip~=\PValue{half-}}}% + paragraphs\IndexOption{parskip~=\textKValue{half-}}}% \pventry{half+}{% half a line vertical space between paragraphs; there must be at least a - third of a line free space at the end of a - paragraph\IndexOption{parskip~=\PValue{half+}}}% + third of a line of free space at the end of a + paragraph\IndexOption{parskip~=\textKValue{half+}}}% \pventry{half*}{% half a line vertical space between paragraphs; there must be at least a - quarter of a line free space at the end of a - paragraph\IndexOption{parskip~=\PValue{half+}}}% + quarter of a line of free space at the end of a + paragraph\IndexOption{parskip~=\textKValue{half*}}}% \pventry{never}{% there% \IfThisCommonLabelBase{maincls}{% - \ChangedAt{v3.08}{\Class{scrbook}\and - \Class{scrreprt}\and \Class{scrartcl}}% + \ChangedAt{v3.08}{\Class{scrbook}\and \Class{scrreprt}\and + \Class{scrartcl}}% }{% \IfThisCommonLabelBase{scrlttr2}{% \ChangedAt{v3.08}{\Class{scrlttr2}}% @@ -221,7 +236,7 @@ paragraph instead of paragraph spacing. All the possible values of option will be no inter-paragraph spacing even if additional vertical spacing is needed for the vertical adjustment with \Macro{flushbottom}\IndexCmd{flushbottom}% - \IndexOption{parskip~=\PValue{never}}}% + \IndexOption{parskip~=\textKValue{never}}}% % \end{desctabular} % \end{table}% \end{desclist}% @@ -229,17 +244,17 @@ paragraph instead of paragraph spacing. All the possible values of option All\textnote{Attention!} eight \PValue{full} and \PValue{half} option values also change the spacing before, after, and inside list environments. This -avoids the problem of these environments or the paragraphs inside them having -a larger separation than the separation between the paragraphs of normal text.% +prevents these environments or the paragraphs inside them from having +a larger separation than that between the paragraphs of normal text.% \IfThisCommonLabelBase{maincls}{ % Additionally, these options ensure that the table of contents and the lists of figures and tables are set without any additional spacing.% }{ % - Several element of the first letter page will be set without inter-paragraph - spacing always.% + Several elements of the letterhead are always set without inter-paragraph + spacing.% }% -The default behaviour of {\KOMAScript} follows +The default\textnote{default} behaviour of \KOMAScript{} is \OptionValue{parskip}{false}. In this case, there is no spacing between paragraphs, only an indentation of the first line by 1\Unit{em}.% % |