8bca80d4d807905cf8259ec1e39d80a219df6754
[conteq.git] / conteq.dtx
1 % \iffalse meta-comment
2 % !TEX program  = pdfLaTeX
3 %<*internal>
4 \iffalse
5 %</internal>
6 %<*readme>
7 ----------------------------------------------------------------
8 conteq --- continued equalities
9 E-mail: mail@joachim-breitner.de
10 Source repository: http://git.nomeata.de/?p=conteq.git
11 Source repository mirror: https://github.com/nomeata/conteq
12 Released under the LaTeX Project Public License v1.3c or later
13 See http://www.latex-project.org/lppl.txt
14 ----------------------------------------------------------------
15
16 This package allows you to write an continued equality such as
17
18     \begin{conteq}
19     e^{\pi\cdot i} \\
20     = -1 & Euler's formula \\
21     < 0 & this is an inequality \\ 
22     < \sqrt 3 \\
23     = \int e^{-x^2} dx & this is due to Gauss.
24     \end{conteq}
25
26 in a declarative manner and easily switch between various layouts afterwards.
27 %</readme>
28 %<*internal>
29 \fi
30 \def\nameofplainTeX{plain}
31 \ifx\fmtname\nameofplainTeX\else
32   \expandafter\begingroup
33 \fi
34 %</internal>
35 %<*install>
36 \input docstrip.tex
37 \keepsilent
38 \askforoverwritefalse
39 \preamble
40 ----------------------------------------------------------------
41 conteq --- continued equalities
42 E-mail: mail@joachim-breitner.de
43 Released under the LaTeX Project Public License v1.3c or later
44 See http://www.latex-project.org/lppl.txt
45 ----------------------------------------------------------------
46
47 \endpreamble
48 \postamble
49
50 Copyright (C) 2013 by Joachim Breitner <mail@joachim-breitner.de>
51
52 This work may be distributed and/or modified under the
53 conditions of the LaTeX Project Public License (LPPL), either
54 version 1.3c of this license or (at your option) any later
55 version.  The latest version of this license is in the file:
56
57 http://www.latex-project.org/lppl.txt
58
59 This work is "maintained" (as per LPPL maintenance status) by
60 Joachim Breitner.
61
62 This work consists of the file  conteq.dtx
63 and the derived files           conteq.ins,
64                                 conteq.pdf and
65                                 conteq.sty.
66
67 \endpostamble
68 \usedir{tex/latex/conteq}
69 \generate{
70   \file{\jobname.sty}{\from{\jobname.dtx}{package}
71                       \from{\jobname.dtx}{layouts}}
72 }
73 %</install>
74 %<install>\endbatchfile
75 %<*internal>
76 \generate{
77   \file{\jobname.ins}{\from{\jobname.dtx}{install}}
78 }
79 \nopreamble\nopostamble
80 \generate{
81   \file{README.txt}{\from{\jobname.dtx}{readme}}
82 }
83 \ifx\fmtname\nameofplainTeX
84   \expandafter\endbatchfile
85 \else
86   \expandafter\endgroup
87 \fi
88 %</internal>
89 %<package>\NeedsTeXFormat{LaTeX2e}
90 %<package>\RequirePackage{expl3}[2012/07/02]
91 %<package>\ProvidesExplPackage
92 %<package>  {conteq}              % Package name
93 %<package>  {2013/05/23}          % Release date
94 %<package>  {0.1}                 % Release version
95 %<package>  {Various layouts for continued equalities} % Description
96 %
97 %<*driver>
98 \documentclass[full]{l3doc}
99 \usepackage[T1]{fontenc}
100 \usepackage{lmodern}
101 \usepackage{conteq}
102 %\usepackage[numbered]{hypdoc}
103 \EnableCrossrefs
104 \CodelineIndex
105 \RecordChanges
106 \begin{document}
107   \DocInput{\jobname.dtx}
108 \end{document}
109 %</driver>
110 % \fi
111 %
112 % \GetFileInfo{\jobname.sty}
113 %
114 % \CheckSum{166}
115 %
116 %
117 %\title{^^A
118 %  \textsf{conteq} --- continued equalities\thanks{^^A
119 %    This file describes version \fileversion, last revised \filedate.^^A
120 %  }^^A
121 %}
122 %\author{Joachim Breitner\thanks{E-mail: mail@joachim-breitner.de}}
123 %
124 %\date{Released \filedate}
125 %
126 %\maketitle
127 %
128 %\changes{0.1}{2013/05/23}{Converted to DTX file}
129 %
130 %
131 % \section{Introduction}
132 %
133 % There are various ways to layout an continued equality that spans multiple lines and has explanations along some steps. Often, the best layout is not clear beforehand, as it depends on the sizes of the various elements, or implementing it adds too much noise to the actual formulas. This package provides an environment for continued equalities (or inequalities) that allows you to easily define and switch layouts.
134 %
135 % \section{Usage}
136 %
137 % \DescribeEnv{conteq}
138 % Our running example is the following continued equality:
139
140 % \begin{verbatim}
141 % \begin{conteq}
142 % e^{\pi\cdot i} \\
143 % = -1 & Euler's formula \\
144 % < 0 & this is an inequality \\ 
145 % < \sqrt 3 \\
146 % = \int e^{-x^2} dx & this is due to Gauss.
147 % \end{conteq}
148 % \end{verbatim}
149 %
150 % As you can see, the expressions of the continued equality are separated by |\\|, with equality signs (or other relations) at the beginning of all lines but the first. Some equalities also have explanations.
151
152 % The result of the above code is
153 % \begin{conteq}
154 % e^{\pi\cdot i} \\
155 % = -1 & Euler's formula \\
156 % < 0 & this is an inequality \\ 
157 % < \sqrt 3 \\
158 % = \int e^{-x^2} dx & this is due to Gauss.
159 % \end{conteq}
160 %
161 % The expressions are typeset in math mode, while the explanation is assumed to be regular text. The curly braces around the explanations come from the default |\ConteqExplStyle|.
162
163 % There are other layouts available, which you select with an optional parameter to |\begin{conteq}|, e.g.
164 % \begin{verbatim}
165 % \begin{conteq}[explline]
166 % [..]
167 % \end{conteq}
168 % \end{verbatim}
169
170 % The layouts defined by |conteq| are:
171
172 % \paragraph{plain} The default layout, shown above.
173
174 % \paragraph{explline} A layout that puts the explanations below the right-hand side of the equalty it is explaining. To be used when the explanations and righ-hand sides are long.
175 % \begin{conteq}[explline]
176 % e^{\pi\cdot i} \\
177 % = -1 & Euler's formula \\
178 % < 0 & this is an inequality \\ 
179 % < \sqrt 3 \\
180 % = \int e^{-x^2} dx & this is due to Gauss.
181 % \end{conteq}
182
183
184 % \paragraph{headline} Like plain, but the first expression is also vertically aligned with the right-hand sides.
185 % \begin{conteq}[headline]
186 % e^{\pi\cdot i} \\
187 % = -1 & Euler's formula \\
188 % < 0 & this is an inequality \\ 
189 % < \sqrt 3 \\
190 % = \int e^{-x^2} dx & this is due to Gauss.
191 % \end{conteq}
192
193 % \paragraph{onecolumn} A combination of \textbf{explline} and \textbf{headline} that puts everything in one column, for maximum space efficiency.
194 % \begin{conteq}[onecolumn]
195 % e^{\pi\cdot i} \\
196 % = -1 & Euler's formula \\
197 % < 0 & this is an inequality \\ 
198 % < \sqrt 3 \\
199 % = \int e^{-x^2} dx & this is due to Gauss.
200 % \end{conteq}
201
202 % \paragraph{oneline} A layout, more for demonstrational purposes, that ignores the explanations and puts everything in one line.
203 % \begin{conteq}[oneline]
204 % e^{\pi\cdot i} \\
205 % = -1 & Euler's formula \\
206 % < 0 & this is an inequality \\ 
207 % < \sqrt 3 \\
208 % = \int e^{-x^2} dx & this is due to Gauss.
209 % \end{conteq}
210
211 % \DescribeMacro{\ConteqSetDefaultLayout} You can change the default layout using |\ConteqSetDefaultLayout|\marg{layout}
212
213 % \section{Defining layouts}
214 %
215 % \DescribeMacro{\ConteqDefineLayout}
216 % To define a new layout you use |\ConteqDefineLayout|, which takes seven arguments:
217 % \begin{enumerate}
218 % \item The name of the layout,
219 % \item What to put before the continued equalities,
220 % \item the left-hand side of the first equality,
221 % \item the right-hand side of equalities without explanation,
222 % \item the right-hand side of equalities with explanation,
223 % \item the line separator and
224 % \item what to put after the continued equalities.
225 % \end{enumerate}
226 %
227 % For example the existing layouts are defined using
228 % \iffalse
229 %<*layouts>
230 % \fi
231 %    \begin{macrocode}
232
233 \ConteqDefineLayout
234     {plain}
235     {\begin{align*}}
236     { #1 }
237     { & #1 }
238     { & #1 && #2 }
239     { \\ }
240     {\end{align*}}
241 \ConteqSetDefaultLayout{plain}
242
243 \ConteqDefineLayout
244     {explline}
245     {\begin{align*}}
246     { #1 }
247     { & #1 }
248     { & #1 \\ & \mathrel{\phantom{=}} #2 }
249     { \\ }
250     {\end{align*}}
251
252 \ConteqDefineLayout
253     {headline}
254     {\begin{align*}}
255     { &\mathrel{\phantom{=}} #1 \\ }
256     { & #1 }
257     { & #1 && #2 }
258     { \\ }
259     {\end{align*}}
260  
261 \ConteqDefineLayout
262     {onecolumn}
263     {\begin{align*}}
264     { &\mathrel{\phantom{=}} #1 \\ }
265     { & #1 }
266     { & #1 \\ & \mathrel{\phantom{=}} #2 }
267     { \\ }
268     {\end{align*}}
269
270 \ConteqDefineLayout
271     {oneline}
272     {\[}
273     { #1 }
274     { #1 }
275     { #1 }
276     {}
277     {\]}
278
279 %    \end{macrocode}
280 %
281 % \section{Changing the explanation style}
282 %
283 % \DescribeMacro{\ConteqExplStyle}
284 % The explanation is formatted using the macro |\ConteqExplStyle|\marg{explanation}, which is by default defined as
285 %    \begin{macrocode}
286 \newcommand{\ConteqExplStyle}[1]{\{~#1~\}}
287 %    \end{macrocode}
288 %
289 % To change the style, simply redefine this macro using, for example:
290 % \begin{verbatim}
291 % \renewcommand{\ConteqExplStyle}{\textit{-- #1}}
292 % \end{verbatim}
293 %
294 %
295 % \section{Future work}
296 %
297 % This package is, at the time of writing, very new, so please le me know about problems you are having or features you are missing.
298 %
299 % One feature that I am considering is an auto-selection of layouts, so when you specify |\begin{conteq}[plain,explline,onecolumn]...\end{conteq}|, it will analyze the table and select, from your list of layouts, the first one that is ``ok'', where ``ok'' would be some layout-specific heuristic taking the size of the expressions and explanations as well as the current |\linewidth| into account. If you think that this would be useful to you, please let me know.
300 %
301 % You can follow the package's development at \url{http://git.nomeata.de/?p=conteq.git} or the mirror at \url{https://github.com/nomeata/conteq}.
302 %
303 % \iffalse
304 %</layouts>
305 % \fi
306 %
307 %\StopEventually{^^A
308 %  \PrintChanges
309 %  \PrintIndex
310 %}
311 %
312
313 %
314 % \section{Implementation}
315 %
316 % \iffalse
317 %<*package>
318 % \fi
319 %
320 % \subsection{Package loading}
321
322 %    \begin{macrocode}
323 \RequirePackage{amsmath}
324 \RequirePackage{environ}
325 %    \end{macrocode}
326
327 % \subsection{Defining Messages}
328 %
329 %    \begin{macrocode}
330 \msg_new:nnn
331     {conteq}
332     {empty}
333     { \msg_warning_text:n{conteq}:~Empty~conteq~environment~\msg_line_context: }
334
335 \msg_new:nnn
336     {conteq}
337     {ignoreddata}
338     { \msg_warning_text:n{conteq}:~Ignored~text~\msg_line_context: }
339
340 \msg_new:nnn
341     {conteq}
342     {undefinedlayout}
343     { \msg_critical_text:n{conteq}:~Undefined~layout~``#1''~\msg_line_context: }
344 %    \end{macrocode}
345
346 % \subsection{Declaring local variables}
347 %
348 %    \begin{macrocode}
349 \tl_new:N \l_conteq_default_layout_tl
350 \tl_new:N \l_conteq_layout_tl
351 \tl_new:N \l_conteq_body_tl
352 \tl_new:N \l_conteq_lines_seq
353 \tl_new:N \l_conteq_cells_seq
354 \tl_new:N \l_conteq_head_tl
355 \tl_new:N \l_conteq_lastline_tl
356 \tl_new:N \l_conteq_rhs_tl
357 \tl_new:N \l_conteq_expl_tl
358 \tl_new:N \l_conteq_result_tl
359 %    \end{macrocode}
360
361 % \subsection{Layouts}
362 %
363 % \begin{macro}{\ConteqSetDefaultLayout}
364 % The code to set the default layout.
365 %    \begin{macrocode}
366 \cs_new_protected:Nn \conteq_set_default_layout:n {
367   \tl_set:Nn \l_conteq_default_layout_tl {#1}
368 }
369 \cs_new_eq:NN \ConteqSetDefaultLayout \conteq_set_default_layout:n
370 %    \end{macrocode}
371 % \end{macro}
372 %
373 % \begin{macro}{\ConteqDefineLayout}
374 % The code to define new layouts.
375 %    \begin{macrocode}
376 \cs_new_protected:Nn \conteq_define_layout:nnnnnnn {
377   \cs_new_protected:cn {conteq_#1_begin:} { #2 }
378   \cs_new_protected:cn {conteq_#1_lhs:n} { #3 }
379   \cs_new_protected:cn {conteq_#1_rhs_only:n} { #4 }
380   \cs_new_protected:cn {conteq_#1_rhs_expl:nn} { #5 }
381   \cs_new_protected:cn {conteq_#1_nl:} { #6 }
382   \cs_new_protected:cn {conteq_#1_end:} { #7 }
383 }
384 \cs_new_eq:NN \ConteqDefineLayout \conteq_define_layout:nnnnnnn
385 %    \end{macrocode}
386 % \end{macro}
387 %
388 % \subsection{Expansion utility function}
389
390 % \begin{macro}{\conteq_args_once:Nn, \conteq_args_once:NV, \conteq_args_once:Nnn, \conteq_args_once:NVV}
391 % For ease of debugging(?) we construct a token list that contains exactly the tokens that a programmer would enter to create the layout manually. For that we need some fine-grained control over expansion.
392 %
393 %    \begin{macrocode}
394 \cs_new:Npn \conteq_args_once:Nn #1#2 {
395    \exp_not:o {#1 {#2}}
396 }
397 \cs_generate_variant:Nn \conteq_args_once:Nn {NV}
398
399 \cs_new:Npn \conteq_args_once:Nnn #1#2#3 {
400    \exp_not:o {#1 {#2}{#3}}
401 }
402 \cs_generate_variant:Nn \conteq_args_once:Nnn {NVV}
403 %    \end{macrocode}
404 % \end{macro}
405 %
406 % \subsection{Main code}
407 %
408 % \begin{macro}{\conteq_print_line:nn}
409 % This macro splits and prints one line of the table. The second argument is either |\\| or, for the last line of the table, empty.
410 %    \begin{macrocode}
411 \cs_new_protected:Npn \conteq_print_line:Nnn #1#2#3 {
412   \seq_set_split:Nnn \l_conteq_cells_seq { & } {#2}
413   \seq_pop_left:NN \l_conteq_cells_seq \l_conteq_rhs_tl
414   \tl_clear:N \l_conteq_expl_tl
415   \seq_if_empty:NF \l_conteq_cells_seq {
416     \seq_pop_left:NN \l_conteq_cells_seq \l_conteq_expl_tl
417   }
418   \tl_if_blank:VTF \l_conteq_expl_tl {
419     \tl_put_right:Nx #1 {
420       \conteq_args_once:NV \conteq_rhs_only:n \l_conteq_rhs_tl
421     }
422   }{
423     \tl_set:Nx \l_tmpa_tl {\exp_not:N \text {\exp_not:N \ConteqExplStyle {\exp_not:V \l_conteq_expl_tl}}}
424     \tl_put_right:Nx #1 {
425       \conteq_args_once:NVV \conteq_rhs_expl:nn \l_conteq_rhs_tl \l_tmpa_tl
426     }
427   }
428   \seq_if_empty:NF \l_conteq_cells_seq {
429     \msg_warning:nn{conteq}{ignoreddata}
430   }
431   \tl_put_right:Nn #1 {#3}
432 }
433 \cs_generate_variant:Nn \conteq_print_line:Nnn {Nno}
434 \cs_generate_variant:Nn \conteq_print_line:Nnn {NVn}
435 %    \end{macrocode}
436 % \end{macro}
437
438 %
439 % \begin{environment}{conteq}
440 %
441 % The main environment of the package.
442 %    \begin{macrocode}
443 \NewEnviron{conteq}[1][\l_conteq_default_layout_tl]{
444   \tl_set:NV \l_conteq_body_tl \BODY
445   
446   \tl_if_blank:oT \l_conteq_body_tl{
447       \msg_warning:nn{conteq}{empty}
448   }
449 %    \end{macrocode}
450
451 % Figure out the layout to use\ldots
452 %    \begin{macrocode}
453   \tl_set:Nn \l_conteq_layout_tl {#1}
454 %    \end{macrocode}
455 % and set the various functions accordingly, if the layout exists.
456 %    \begin{macrocode}
457   \cs_if_exist:cTF {conteq_ \l_conteq_layout_tl _ begin:}{
458     \clist_map_inline:nn{begin:, lhs:n,rhs_only:n, rhs_expl:nn, nl:, end:}{
459       \cs_set_eq:cc {conteq_##1}{conteq_\l_conteq_layout_tl _##1}
460     }
461   }{
462     \msg_critical:nnx{conteq}{undefined layout}{\l_conteq_layout_tl}
463   }
464 %    \end{macrocode}
465
466 % Split the body into individual lines.
467 %    \begin{macrocode}
468   \seq_set_split:NnV \l_conteq_lines_seq { \\ } \l_conteq_body_tl
469
470   \tl_clear:N \l_conteq_result_tl
471 %    \end{macrocode}
472
473 % If there is only one line, simply print it.
474 %    \begin{macrocode}
475
476   \int_case:nnn {\seq_count:N \l_conteq_lines_seq}
477   {
478     {1} {
479       \tl_put_right:NV \l_conteq_result_tl \conteq_begin:
480       \tl_put_right:NV \l_conteq_result_tl \l_conteq_body_tl
481       \tl_put_right:NV \l_conteq_result_tl \conteq_end:
482     }
483   }{
484 %    \end{macrocode}
485
486 % Otherwise extract the head and the last line, and print each line using |\conteq_print_line:nn|
487 %    \begin{macrocode}
488     \seq_pop_left:NN \l_conteq_lines_seq \l_conteq_head_tl
489     \seq_pop_right:NN \l_conteq_lines_seq \l_conteq_lastline_tl
490
491     \tl_put_right:NV \l_conteq_result_tl \conteq_begin:
492     \tl_put_right:Nx \l_conteq_result_tl {
493       \conteq_args_once:NV \conteq_lhs:n \l_conteq_head_tl
494     }
495     \seq_map_inline:Nn \l_conteq_lines_seq {
496       \conteq_print_line:Nno \l_conteq_result_tl {##1} {\conteq_nl:} 
497     }
498     \conteq_print_line:NVn \l_conteq_result_tl \l_conteq_lastline_tl {} 
499     \tl_put_right:No \l_conteq_result_tl \conteq_end:
500   }
501   % Use this for debugging
502   %\tl_show:N \l_conteq_result_tl
503   \tl_use:N \l_conteq_result_tl
504 }
505 %    \end{macrocode}
506 %\end{environment}
507 %
508 %    \begin{macrocode}
509 \endinput
510 %    \end{macrocode}
511
512 %
513 % \iffalse
514 %</package>
515 % \fi
516 %
517 % \Finale
518 \endinput