summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/snaptodo/snaptodo.sty
blob: 13bc847374519e5a385bfb1555e84fedae52d0ce (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

% # snaptodo
%
% Hsin-Po Wang
% mailto:a.simple.people@gmail.com 
% https://www.symbol.codes
%
% This is snaptodo.sty,
% an alternative to todonote.sty
% that differs in the following ways
%
% * Depending on where you call `\todo`,
%   the note is on the left or right margin,
%   whichever is closer.
% * The notes bump each other
%   so they never overlap;
%   the lines never overlap either
% * Aesthetic and customizable style.
%
% License = https://www.latex-project.org/lppl/lppl-1-3c/


\NeedsTeXFormat{LaTeX2e}[2021/06/01]

\ProvidesPackage{snaptodo}[2021/11/22]

\RequirePackage{tikzpagenodes}[2012/09/16]

\ifx\todo\snaptodo@undefined
\else
	\PackageWarning{snaptodo}{%
		Control sequence \protect\todo\space was defined.\MessageBreak
		I am going to override it anyways.
	}
\fi

\def\todo{%
	\snaptodo@initialize
	\global\let\todo\snaptodo@main
	\todo
}

\def\snaptodo@initialize{%
	\tikz[overlay]
		\node(snaptodo@margin@left){}
		node(snaptodo@margin@right){}
		coordinate(snaptodo@baseline@left){}
		coordinate(snaptodo@baseline@right){}
		coordinate(snaptodo@descent@left){}
		coordinate(snaptodo@descent@right){}
	;%
}

\def\snaptodo@main{%
	\pgfutil@ifnextchar[
	{\snaptodo@main@opt}
	{\snaptodo@main@opt[]}%]
}

\def\snaptodo@main@opt[#1]#2{%
	\tikz[remember picture,overlay]{
		\snaptodoset{#1}
		\snaptodo@remember@side
		\snaptodo@typeset@margin@block{#2}
		\snaptodo@dipict@call@chain
	}%
}

\def\snaptodo@remember@side{
	\pgfpointanchor{current page}{center}
	\ifdim\pgf@x>\std@chainbias
		\def\std@westeast{west}
		\def\std@eastwest{east}
		\def\std@leftright{left}
		\def\std@rightleft{right}
		\def\std@plusminus{+}
	\else
		\def\std@westeast{east}
		\def\std@eastwest{west}
		\def\std@leftright{right}
		\def\std@rightleft{left}
		\def\std@plusminus{-}
	\fi
}

\def\snaptodo@typeset@margin@block#1{
	\pgfpointanchor{current page text area}\std@westeast
	\xdef\std@descent@xpt{\the\pgf@x}
	\node(snaptodo@margin@\std@leftright)[
		/snaptodo/margin@block,
		/snaptodo/margin block/.try,
		/utils/exec={
			\let\tikz@transform=\snaptodo@margin@block@transform
		}
	]{#1};
}

\def\snaptodo@margin@block@transform{
	\pgftransformshift{\pgfpoint{\std@descent@xpt}0}
	\pgftransformshift{\pgfpoint{-\std@plusminus\marginparsep}0}
	\pgfpointanchor{snaptodo@baseline@\std@leftright}{center}
	\ifdim\pgf@y<0pt\else
		\pgfpointanchor{snaptodo@margin@\std@leftright}{south}
		\pgftransformshift{\pgfpoint0{min(
			\std@blockrise
			,
			\pgf@y
			-\ht\pgfnodeparttextbox
			-\dp\pgfnodeparttextbox
			-2*\pgfkeysvalueof{/pgf/inner ysep}
			-\std@blocksep
		)}}
	\fi
}

\def\snaptodo@dipict@call@chain{
	\pgfpointanchor{snaptodo@baseline@\std@leftright}{center}
	\ifdim\pgf@y<0pt
		\def\std@descent@y{0}
	\else
		\pgfpointanchor{snaptodo@descent@\std@leftright}{center}
		\pgfmathsetmacro\std@descent@y{min(\pgf@y-\std@chainsep,0)}
	\fi
	\snaptodo@dipict@call@chain@drawer
}

\def\snaptodo@dipict@call@chain@drawer{
	\draw[/snaptodo/call@chain,/snaptodo/call chain/.try]
		(0,\std@chainsep)--
		(0,0)coordinate(snaptodo@baseline@\std@leftright){}--
		(0,\std@descent@y pt)coordinate(snaptodo@descent@\std@leftright){}--
		(\std@descent@xpt,\std@descent@y pt)--
		(snaptodo@margin@\std@leftright.south \std@eastwest)--
		(snaptodo@margin@\std@leftright.south \std@westeast)
	;
}

\colorlet{snaptodo@chain}{yellow!50!black}
\colorlet{snaptodo@block}{red!50!black}

\def\snaptodoset{\pgfqkeys{/snaptodo}}

\snaptodoset{
	.unknown/.code={%
		\let\snaptodo@key\pgfkeyscurrentname%
		\pgfkeys{/pgf/\snaptodo@key/.try={#1}}%
	},
	block rise/.store in=\std@blockrise,
	block rise=0pt,
	block sep/.store in=\std@blocksep,
	block sep=\baselineskip,
	margin@block/.style={
		above \std@leftright,
		text width={\marginparwidth-2*\pgfkeysvalueof{/pgf/inner xsep}},
		align=flush \std@leftright,
		text=snaptodo@block,
	},
	chain bias/.store in=\std@chainbias,
	chain bias=0pt,
	chain sep/.store in=\std@chainsep,
	chain sep=0.5ex,
	call@chain/.style={
		draw=snaptodo@chain,
		blend mode=darken,
	}
}

\endinput