summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/common-marginpar.tex
blob: ff57abce7620af18a0520be1d0c2fc387cb5261a (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
% ======================================================================
% common-marginpar.tex
% Copyright (c) Markus Kohm, 2001-2017
%
% 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-marginpar.tex
% Copyright (c) Markus Kohm, 2001-2017
%
% 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
%
% ----------------------------------------------------------------------
%
% Absaetze, die mehreren Kapiteln der KOMA-Script-Anleitung gemeinsam sind
% Verwaltet von Markus Kohm
%
% ======================================================================

\KOMAProvidesFile{common-marginpar.tex}
                 [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
                  KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Markus Kohm}

% Date of the translated German file: 2017-01-02

\section{Margin Notes}
\seclabel{marginNotes}%
\BeginIndexGroup
\BeginIndex{}{margin>notes}%

\IfThisCommonFirstRun{}{%
  All of what is described in
  \autoref{sec:\ThisCommonFirstLabelBase.marginNotes} is generally
  applicable. So if you have alread read and understood
  \autoref{sec:\ThisCommonFirstLabelBase.marginNotes} you can switch to
  \autoref{sec:\ThisCommonLabelBase.marginNotes.next},
  \autopageref{sec:\ThisCommonLabelBase.marginNotes.next}.%
}

Aside from the text area, that normally fills the typing area, usually a
marginalia column may be found. Margin notes will be printed at this area.
\IfThisCommonLabelBase{scrlttr2}{%
  Nevertheless, margin notes are unusual at letters and should be used
  seldomly.%
}{%
  At lot of them may be found in this \iffree{manual}{book}.%
}%


\begin{Declaration}
  \Macro{marginpar}\OParameter{margin note left}\Parameter{margin note}%
  \Macro{marginline}\Parameter{margin note}
\end{Declaration}%
Usually margin notes\Index[indexmain]{margin>notes} in {\LaTeX} are
inserted with the command \Macro{marginpar}. They are placed in the
outer margin.  In documents with one-sided layout the right border is
used. Though \Macro{marginpar} can take an optional different margin
note argument in case the output is in the left margin, margin notes
are always set in justified layout.  However, experience has shown
that many users prefer left- or right-aligned margin notes instead.
To facilitate this, {\KOMAScript} offers the command
\Macro{marginline}.

\IfThisCommonFirstRun{%
  \iftrue%
}{%
  An example for this may be found in
  \autoref{sec:\ThisCommonFirstLabelBase.marginNotes} at
  \PageRefxmpl{\ThisCommonFirstLabelBase.cmd.marginline}.%
  \csname iffalse\endcsname%
}%
  \begin{Example}
    \phantomsection\xmpllabel{cmd.marginline}%
    In this \iffree{document}{book}, sometimes, the class name
    \Class{scrartcl} can be found in the margin. This can be produced with:%
    \iffalse% Umbruchkorrekturtext
      \footnote{In fact, instead of \Macro{texttt}, a semantic highlighting
        was used. To avoid confusion this was replaced in the example.}%
    \fi
\begin{lstcode}
  \marginline{\texttt{scrartcl}}
\end{lstcode}

  Instead of \Macro{marginline} you could have used \Macro{marginpar}. In fact
  the first command is implemented internally as:
\begin{lstcode}
  \marginpar[\raggedleft\texttt{scrartcl}]
    {\raggedright\texttt{scrartcl}}
\end{lstcode}
  Thus \Macro{marginline} is really only an abbreviated writing of the
  code above.%
\end{Example}%
\fi

Experts\textnote{Attention!} and advanced users may find information about
problems using \Macro{marginpar} at \autoref{sec:maincls-experts.addInfos},
\DescPageRef{maincls-experts.cmd.marginpar}. These are valid for
\Macro{marginline} also.%
%
\EndIndexGroup
%
\EndIndexGroup

%%% Local Variables:
%%% mode: latex
%%% coding: us-ascii
%%% TeX-master: "../guide"
%%% End: