summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/common-13.tex
blob: 6ac134d09d06e87f515f93e86e874e88fd9d4826 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
% ======================================================================
% common-13.tex
% Copyright (c) Markus Kohm, 2001-2012
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
% This work may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c of the license.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX 
% version 2005/12/01 or later and of this work.
%
% This work has the LPPL maintenance status "author-maintained".
%
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-13.tex
% Copyright (c) Markus Kohm, 2001-2012
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
% Die neuste Version dieser Lizenz ist
%   http://www.latex-project.org/lppl.txt
% und Version 1.3c ist Teil aller Verteilungen von LaTeX
% Version 2005/12/01 oder spaeter und dieses Werks.
%
% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
% (allein durch den Autor verwaltet).
%
% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
% 
% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
%
% Paragraphs that are common for several chapters of the KOMA-Script guide
% Maintained by Markus Kohm
%
% ----------------------------------------------------------------------
%
% Absätze, die mehreren Kapiteln der KOMA-Script-Anleitung gemeinsam sind
% Verwaltet von Markus Kohm
%
% ======================================================================

\ProvidesFile{common-13.tex}[2009/01/04 KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug}

\makeatletter
\@ifundefined{ifCommonmaincls}{\newif\ifCommonmaincls}{}%
\@ifundefined{ifCommonscrextend}{\newif\ifCommonscrextend}{}%
\@ifundefined{ifCommonscrlttr}{\newif\ifCommonscrlttr}{}%
\@ifundefined{ifIgnoreThis}{\newif\ifIgnoreThis}{}%
\makeatother


\section{Randnotizen}
\label{sec:\csname label@base\endcsname.marginNotes}%
\ifshortversion\IgnoreThisfalse\IfNotCommon{maincls}{\IgnoreThistrue}\fi%
\ifIgnoreThis
Es gilt sinngemäß, was in \autoref{sec:maincls.marginNotes} geschrieben
wurde.
\else
\BeginIndex{}{Randnotizen}%

Außer dem eigentlichen Textbereich, der normalerweise den Satzspiegel
ausfüllt, existiert in Dokumenten noch die so genannte Marginalienspalte. In
dieser können Randnotizen gesetzt werden. % Umbruchkorrekturtext
\IfNotCommon{scrlttr2}{In diesem \iffree{Dokument}{Buch} wird davon ebenfalls
  Gebrauch gemacht.}%
\fi
\IfCommon{scrlttr2}{Bei Briefen sind Randnotizen allerdings eher unüblich und
  sollten äußerst sparsam eingesetzt werden.}%
\ifIgnoreThis\else


\begin{Declaration}
  \Macro{marginpar}\OParameter{Randnotiz links}\Parameter{Randnotiz}\\
  \Macro{marginline}\Parameter{Randnotiz}
\end{Declaration}%
\BeginIndex{Cmd}{marginpar}%
\BeginIndex{Cmd}{marginline}%
Für Randnotizen\Index[indexmain]{Randnotizen} ist bei {\LaTeX} normalerweise die
Anweisung \Macro{marginpar} vorgesehen. Die Randnotizen werden dabei im
äußeren Rand gesetzt. Bei einseitigen Dokumenten wird der rechte Rand
verwendet. Zwar kann bei \Macro{marginpar} optional eine abweichende Randnotiz
angegeben werden, falls die Randnotiz im linken Rand landet, jedoch werden
Randnotizen immer im Blocksatz ausgegeben. Die Erfahrung zeigt, dass bei
Randnotizen statt des Blocksatzes oft je nach Rand linksbündiger oder
rechtsbündiger Flattersatz zu bevorzugen ist. {\KOMAScript} bietet hierfür
die Anweisung \Macro{marginline}.

\ifCommonscrlttr\else
\begin{Example}
  \phantomsection\label{desc:\csname
    label@base\endcsname.cmd.marginline.example}%
  In diesem Kapitel ist an einigen Stellen die %
  \IfCommon{maincls}{Klassenangabe \Class{scrartcl} }%
  \IfCommon{scrextend}{Paketangabe \Package{scrextend} }%
  im Rand zu finden. Diese kann mit:
\ifCommonmaincls
  \begin{lstcode}
  \marginline{\texttt{scrartcl}}
  \end{lstcode}
\else
  \begin{lstcode}
  \marginline{\texttt{scrextend}}
  \end{lstcode}
\fi
  erreicht werden.%
\iftrue % Umbruchkorrekturtext
  \footnote{Tatsächlich wurde nicht \Macro{texttt},
    sondern eine semantische Auszeichnung verwendet. Um nicht unnötig
    zu verwirren, wurde diese im Beispiel ersetzt.}%
\fi

  Statt \Macro{marginline} wäre auch die Verwendung von \Macro{marginpar}
  möglich gewesen. Tatsächlich wird bei obiger Anweisung intern nichts anders
  gemacht als:
\ifCommonmaincls
  \begin{lstcode}
  \marginpar[\raggedleft\texttt{scrartcl}]
    {\raggedright\texttt{scrartcl}}
  \end{lstcode}
\else
  \begin{lstcode}
  \marginpar[\raggedleft\texttt{scrextend}]
    {\raggedright\texttt{scrextend}}
  \end{lstcode}
\fi
  Letztlich ist \Macro{marginline} also nur eine abkürzende Schreibweise.
\end{Example}

Für Experten sind in \autoref{sec:maincls-experts.addInfos},
\autopageref{desc:maincls-experts.cmd.marginpar} Probleme bei der Verwendung
von \Macro{marginpar} dokumentiert. Diese gelten ebenso für
\Macro{marginline}.%
\fi%
\IfCommon{scrlttr2}{Ein ausführliches Beispiel hierzu finden Sie in
  \autoref{sec:maincls.marginNotes},
  \autopageref{desc:maincls.cmd.marginline.example}.}%
%
\EndIndex{Cmd}{marginpar}%
\EndIndex{Cmd}{marginline}%
%
\EndIndex{}{Randnotizen}%
\fi% IgnoreThis


%%% Local Variables:
%%% mode: latex
%%% coding: iso-latin-1
%%% TeX-master: "../guide"
%%% End: