-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patheqexpl.tex
296 lines (208 loc) · 6.24 KB
/
eqexpl.tex
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
\documentclass{article}
\usepackage[T2A,T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{hyperref}
\usepackage{eqexpl}
\begin{document}
\title{eqexpl v. 1.1.1}
\author{Konstantin Morenko}
\maketitle
The package is licenced under Creative Commons Attribution-ShareAlike
4.0 International (CC BY-SA 4.0)
The package uses \href{https://semver.org/}{semantic versioning}.
\section{The aim of the package}
The package was developed as an answer to the question \href{https://tex.stackexchange.com/q/95838/119485}{on tex.stackexchange.com}
The package was developed in order to give the tool to make the <<perfect>> explanation
for equations, not just the enumeration.
This package allows to describe equation's variables in unified manner through
the document.
\section{Similar packages}
Nomencl: \href{http://ctan.org/pkg/nomencl}{http://ctan.org/pkg/nomencl}
\section{Contributors}
Konstantin Morenko \href{mailto:me@konstantin-morenko.ru}{me@konstantin-morenko.ru}
The package is currently hosted on GitHub:
\href{https://github.com/konstantin-morenko/latex-equation-explanation}{https://github.com/konstantin-morenko/latex-equation-explanation}
\section{Architecture}
The list consist of few lengths:
\begin{itemize}
\item width of <<intro>> section (default is empty, 0pt);
\item width of spaces between elements (default is 2mm);
\item width of item block (default is 5mm);
\item width of separator (default is '---');
\item the rest of the width of the text block (used to align left side of the
explanation text).
\end{itemize}
\section{Usage}
First, include the package into preamble with
\begin{verbatim}
\usepackage{eqexpl}
\end{verbatim}
Then write an equation and describe the variables
\begin{equation}
E = m c^2
\end{equation}
\begin{eqexpl}
\item{$E$} equivalent energy
\item{$m$} mass
\item{$c$} speed of light ($ c \approx 3 \times 10^8 m/s$)
\end{eqexpl}
using
\begin{verbatim}
\begin{equation}
E = m c^2
\end{equation}
\begin{eqexpl}
\item{$E$} equivalent energy
\item{$m$} mass
\item{$c$} speed of light ($ c \approx 3 \times 10^8 m/s$)
\end{eqexpl}
\end{verbatim}
\section{Configure and examples}
\subsection{Test list}
\newcommand{\testList}{
\item{U} voltage at the section, V;
\item{Rs} total section resistance, Ohm.
\item{$Very^{46}$}very very very very very very very very very very very
very very very very very very very very very very very very very
very very very very very very very very very very very very very
very very very very very very very very very long line;
}
This list is used for next examples:
\begin{eqexpl}
\testList
\end{eqexpl}
\subsection{eqexplSetSpace}
\noindent Set \verb+\eqexplSetSpace{0mm}+
\eqexplSetSpace{0mm}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetSpace{}+ (default 2mm)
\eqexplSetSpace{}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetSpace{10mm}+
\eqexplSetSpace{10mm}
\begin{eqexpl}
\testList
\end{eqexpl}
\eqexplSetSpace{}
\subsection{eqexplSetIntro}
\noindent Set \verb+\eqexplSetIntro{where}+
\eqexplSetIntro{where}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetIntro{in this equation}+
\eqexplSetIntro{in this equation}
\begin{eqexpl}
\testList
\end{eqexpl}
\eqexplSetIntro{}
\subsection{eqexplSetDelim}
\noindent Set \verb+\eqexplSetDelim{---}+ (default)
\eqexplSetDelim{---}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetDelim{=}+
\eqexplSetDelim{=}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetDelim{$\to$}+
\eqexplSetDelim{$\to$}
\begin{eqexpl}
\testList
\end{eqexpl}
\eqexplSetDelim{---}
\subsection{eqexplSetItemWidth}
\noindent Set \verb+\eqexplSetItemWidth{5mm}+ (default)
\eqexplSetItemWidth{5mm}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetItemWidth{10mm}+
\eqexplSetItemWidth{10mm}
\begin{eqexpl}
\testList
\end{eqexpl}
\eqexplSetItemWidth{5mm}
\subsection{Item width for 'begin-end' block}
When we have a long variable name (for example \verb+very-very-long+),
it could lead us to overhelming the variable name as in the example below
\begin{eqexpl}
\item{$long$} just variable
\item{$very-long$} just variable
\item{$very-very-long$} just variable
\end{eqexpl}
User can set a parameter to the specific environment to use custom item width for
current block in opposition to setting it before block to new value
and unsetting it to default after the end of the block. For this
purpose use \verb+\begin{eqexpl}[width]+.
\noindent Set \verb+\begin{eqexpl}[10mm]+
\begin{eqexpl}[10mm]
\item{$long$} just variable
\item{$very-long$} just variable
\item{$very-very-long$} just variable
\end{eqexpl}
\vspace{5mm}
\noindent Test for backing to default in next block
\begin{eqexpl}
\item{$long$} just variable
\item{$very-long$} just variable
\item{$very-very-long$} just variable
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\begin{eqexpl}[20mm]+
\begin{eqexpl}[20mm]
\item{$long$} just variable
\item{$very-long$} just variable
\item{$very-very-long$} just variable
\end{eqexpl}
\vspace{5mm}
\noindent Test for backing to default in next block
\begin{eqexpl}
\item{$long$} just variable
\item{$very-long$} just variable
\item{$very-very-long$} just variable
\end{eqexpl}
\subsection{eqexplItemAlign}
\noindent Set \verb+\eqexplSetItemAlign{r}+ (default)
\eqexplSetItemAlign{r}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetItemAlign{l}+
\eqexplSetItemAlign{l}
\begin{eqexpl}
\testList
\end{eqexpl}
\vspace{5mm}
\noindent Set \verb+\eqexplSetItemAlign{c}+
\eqexplSetItemAlign{c}
\begin{eqexpl}
\testList
\end{eqexpl}
\eqexplSetItemAlign{r}
\subsection{Custom delimiter for individual items}
\noindent Setting \verb+\item{U}[=]...+ and
\verb+\item[$\to$]{Rs}...+.
\begin{eqexpl}
\item{U}[=] voltage at the section, V;
\item{Rs}[$\to$] total section resistance, Ohm.
\item{$Very^{46}$}[$\propto$] very very very very very very very
very very very very very very very very very very very very very
very very very very very very very very very very very very very
very very very very very very very very very very very very very
long line;
\end{eqexpl}
\end{document}