summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/sidenotes/sidenotes.dtx
blob: 5a12e994e07418ddf5672e92c8db2505142a1d5d (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
% \iffalse meta-comment
%
% Copyright (C) 2011 by Andy Thomas <andy.thomas(at)uni.bielefeld.de>
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
% http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2003/12/01 or later.
% 
% The author of this work is Andy Thomas
%
%<*driver>
\ProvidesFile{sidenotes.dtx}[%
%</driver>
%<package>\ProvidesPackage{sidenotes}[%
%<*driver|package>
  2011/08/21 v0.2 footnotes in the margin for LaTeX]
%</driver|package>
%<package>\RequirePackage{marginnote} % puts the stuff in the margin and provides an offset option instead of a float
%<package>\RequirePackage{caption} % handles the figure caption (in the margin)
%<package>\RequirePackage{environ} % to define new environments more easily
%<package>\RequirePackage{xifthen} % provide an if command 
%<package>\RequirePackage{twoopt} % cite in the biblatex package has 2 optional arguments
%<*driver>
\documentclass{ltxdoc}
\EnableCrossrefs         
\CodelineIndex
\RecordChanges
\begin{document}
  \DocInput{sidenotes.dtx}
  \PrintChanges
  \PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{0}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
%
% \changes{v0.2}{2011/08/21}{Initial version}
%
% \GetFileInfo{sidenotes.dtx}
%
% \DoNotIndex{\newcommand,\newenvironment}
% 
%
% \title{The \textsf{sidenotes} package\thanks{This document
%   corresponds to \textsf{sidenotes}~\fileversion, dated \filedate.}}
% \author{Andy Thomas\\ \texttt{andy.thomas(at)uni-bielefeld.de}\\ \\Oliver Schebaum }
%
% \maketitle
%
% \begin{abstract}
% This package tries to allow typesetting of texts with notes,
% figures, citations, captions and tables in the margin. This is common
% in science textbooks such as Feyman's \textit{Lectures on Physics}.
% \end{abstract}
%
% \tableofcontents
%
% \section{Usage}
%
% \DescribeMacro{\sidenote}
% The macro \verb+\sidenote+ is the main feature of the package. The macro is very similar to
% the footnote macro and tries to emulate its behavior. But like the name
% says, the note is put in the margin, hence the name sidenote. It has the
% same parameters as footnote plus an additional, optional offset:
% \verb+\sidenote[number]{text}[offset]+. If no offset is given, the sidenote moves up or down (floats)
% to not overlap with other floats in the margin. If you use the offset
% (e.g. \verb+\sidenote{foo}[10pt]+) the sidenote is shifted 10pt down in the margin.
% It might overlap with other floats now. This means, omitting the offset and [0pt] do
% not lead to the same result, but you will only notice if there are a moderate number
% of sidenotes or other marginals. 
% \DescribeMacro{\sidenotemark} 
% Sidenote tries to mimic the footnote behavior,
% so you can also use \verb+\sidenotemark[number]+ and \verb+\sidenotetext[number]{text}+ commands.
% \DescribeMacro{\sidenotetext}
% This is especially useful, if your are in an environment that does not allow to evoke foot- or sidenote macros. 
% \DescribeMacro{\sidestyle}
% You can use \verb+\renewcommand{\sidestyle}{something}+ 
% if you want to change the font, text size, text color or something else of the sidenotes.
% It it initialized with \verb+\footnotesize+. 
%
% \DescribeMacro{\sidecite}
% The macro \verb+\sidecite+ puts a citation in the margin. It uses the biblatex package
% so you have to go with biblatex instead of bibtex to use this feature. Therefore, the
% macro has the same set of parameters plus the offset: 
% \verb+\sidecite[prenote][postnote]{key}[offset]+.
% The behavior is the same as in \verb+\sidenote+, no offset means auto floating. If an offset
% value is given the position is fixed at a certain place, even if it overlaps with other text or objects.
%
%\DescribeMacro{\sidecaption}
% The \verb+\sidecaption+ macro can be used if the caption of a figure or table 
% is supposed to be in the margin. Please note, that the formatting is done by the 
% caption package. If the object is referenced by the use of \verb+\label{somelabel}+
% the label should go in the sidecaption macro: For example
% \verb+\sidecaption{I am a figure\label{fig:1}}+.
%
% \DescribeEnv{sidefigure}
% The sidefigure environment puts a figure and its caption in the margin. Instead of 
% \verb+\begin{figure}[htb]+ use \verb+\begin{sidefigure}[offset]+. Please note, that 
% the use of caption before \verb+\includegraphics+ or such puts the caption on top
% and the use after puts it below the actual figure.
%
% \DescribeEnv{sidetable}
% The sidetable environment works similarly, use \verb+\begin{sidetable}[offset]+ instead
% of \verb+\begin{table}+.
%
% \section{Technical notes and further macros}
%
% \DescribeMacro{\marginnote}
% \DescribeMacro{\marginpar}
% Sometimes it is useful to put text in the margin without the mark in the text. This can be achieved
% with \verb+\marginnote{text}[offset]+ or \verb+\marginpar{text}+. This feature is not provided 
% by this package, but by the
% marginnote package by Markus Kohm. The sidenotes package heavily uses the marginnote package.
% Technically, every time something is evoked with an offset, \verb+\marginnote+ is called. If it is called without
% an offset, it calls the normal \LaTeX{} macro \verb+\marginpar+. This is not true for the sidecaption, since
% the caption has to be adjacent to the figure or table. In that case, \verb+\marginnote+ is always used.
% The package also relies on the caption package by Harald Axel Sommerfeldt.
% The formatting of the figure and table captions
% has to be done through the caption package.
%
% Right now, the package also requires the packages twoopt, environ and xifthen as well. At least the dependence
% on twoopt and environ should be omitted in the next versions.
% 
% When writing the package, we tried to be as general as possible. Someone can e.g.\ use sidenotes mixed with
% footnotes. Also, the package tries to provide only functionality and does not know anything about formatting
% such as margin text size, color or anything else. Only \verb+\sidestyle+ was added for convinience. If you are
% looking for a package that provides formatting defaults as well you might want to look into the tufte-latex packages.
% \StopEventually{}
%
% \section{Implementation}
%
% \begin{macro}{\sidestyle}
% This macro changes the text formatting of the sidenotes.
% Initially it just sets the text size to the footnote text size.
%    \begin{macrocode}
\newcommand*{\sidestyle}{\footnotesize}
%    \end{macrocode}
% \end{macro}
% We need a counter similar to the footnote counter and we want to 
% have a buffer. 
% \begin{macrocode}
\newcounter{sidenote} % make counter
\newcounter{@sidenotes@buffer}
\setcounter{sidenote}{1} % init counter 
%    \end{macrocode}

% \begin{macro}{\sidenote}
% Introduce the sidenote macro with an additional optional argument postfix to set the offset.
%    \begin{macrocode}
\newcommand*{\sidenote}[2][]{%
	\begingroup%
	\@ifnextchar [{\@sidenotes@sidenote[{#1}]{#2}}{\@sidenotes@sidenote[{#1}]{#2}[]}%
}

\newcommand{\@sidenotes@sidenote}{}
\def\@sidenotes@sidenote[#1]#2[#3]{%
	\endgroup%
	\@sidenotes@@sidenote[{#1}]{#2}[{#3}]%
}

\newcommand{\@sidenotes@@sidenote}{}
\def\@sidenotes@@sidenote[#1]#2[#3]{%
	\ifthenelse{\isempty{#1}}%
		{\sidenotemark%
		\sidenotetext{#2}[#3]}%
		{\sidenotemark[#1]%
		\sidenotetext[#1]{#2}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\sidenotemark}
% Sidenotemark is supposed to work similarly to footnotemark.
%    \begin{macrocode}
\newcommand{\sidenotemark}[1][]{%
	\nobreak\hspace{0.1pt}\nobreak%
	\ifthenelse{\isempty{#1}}%
		{\textsuperscript{\thesidenote}%
		\refstepcounter{sidenote}}% if no argument is given use sidenote counter%
		% else
		{\setcounter{@sidenotes@buffer}{\value{sidenote}}%
		\setcounter{sidenote}{#1}%
		\textsuperscript{\thesidenote}% print out the argument otherwise
		\setcounter{sidenote}{\value{@sidenotes@buffer}}}%
		\ignorespaces%
}%
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\sidenotetext}
% Sidenotetext is supposed to work similarly to footnotetext. The additional, optional argument postfix sets the offset.
%    \begin{macrocode}
\newcommand*{\sidenotetext}[2][]{%
	\begingroup%
	\@ifnextchar [{\@sidenotes@sidenotetext[{#1}]{#2}}{\@sidenotes@sidenotetext[{#1}]{#2}[]}%
}

\newcommand{\@sidenotes@sidenotetext}{}
\def\@sidenotes@sidenotetext[#1]#2[#3]{%
	\endgroup%
	\@sidenotes@@sidenotetext[{#1}]{#2}[{#3}]%
}

\newcommand{\@sidenotes@@sidenotetext}{}
\def\@sidenotes@@sidenotetext[#1]#2[#3]{%
	\ifthenelse{\isempty{#1}}{% sitenotemark given?
		\addtocounter{sidenote}{-1}%
		\ifthenelse{\isempty{#3}}{% offset?
			\marginpar{\textsuperscript{\thesidenote}{} \sidestyle#2}}% no offset
			{\marginnote{\textsuperscript{\thesidenote}{} \sidestyle#2}[#3]} % with offest
		\addtocounter{sidenote}{1}}%
		% else
		{\ifthenelse{\isempty{#3}}% offset?
			{\marginpar{\textsuperscript{#1} \sidestyle#2}}% no offset
			{\marginnote{\textsuperscript{\thesidenote}{} \sidestyle#2}}% with offset
		}% fi
}%
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\sidecite}
% Sidecite puts the citation in the margin. The additional, optional argument postfix sets the offset. 
% Please note, that it only works with biblatex and uses its syntax.
%    \begin{macrocode}
\newcommandtwoopt{\sidecite}[3][][]{%
	\begingroup%
	\@ifnextchar [{\@sidenotes@sidecite[{#1}][{#2}]{#3}}{\@sidenotes@sidecite[{#1}][{#2}]{#3}[]}%
}
\newcommand{\@sidenotes@sidecite}{}
\def\@sidenotes@sidecite[#1][#2]#3[#4]{%
	\endgroup%
	\@sidenotes@@sidecite[{#1}][{#2}]{#3}[{#4}]%
}

\newcommand{\@sidenotes@@sidecite}{}
\def\@sidenotes@@sidecite[#1][#2]#3[#4]{%
	\sidenote{\fullcite[#1][#2]{#3}}[#4]%
}%
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\sidecaption}
% Sidecaption puts the caption in the margin. The additional, optional argument postfix sets the offset. 
% It never floats with the other text in the margin, it has to be next to the figure.
%    \begin{macrocode}
\newcommand{\sidecaption}[2][]{%
	\ifthenelse{\isempty{#1}}%
		{\marginnote{\caption{#2}}}%
		% else
		{\marginnote{\caption[#1]{#2}}}%
}%
%    \end{macrocode}
% \end{macro}
%
% \begin{environment}{sidefigure}
% The sidefigure is similar to the figure environment. But the figure is put in the margin and the positioning
% is not h or b, but rather an offset, e.g.\ 10pt.\
%    \begin{macrocode}
\NewEnviron{sidefigure}[1][]{%
	\ifthenelse{\isempty{#1}} % offset?
		{\marginpar{\captionsetup{type=figure}\BODY}} % no offset
		{\marginnote{\captionsetup{type=figure}\BODY}[#1]} % with offset
}%
%    \end{macrocode}
% \end{environment}
%
% \begin{environment}{sidetable}
% The sidetable is similar to the table environment. But the table is put in the margin and the positioning
% is not h or b, but rather an offset, e.g.\ 10pt.\
%    \begin{macrocode}
\NewEnviron{sidetable}[1][]{%
	\ifthenelse{\isempty{#1}} % offset?
		{\marginpar{\captionsetup{type=table}\sidestyle\BODY}} % no offset
		{\marginnote{\captionsetup{type=table}\sidestyle\BODY}[#1]} % with offset
}%
%    \end{macrocode}
% \end{environment}
%
% \Finale
\endinput