Initial check-in 0.1
authorJoachim Breitner <mail@joachim-breitner.de>
Thu, 23 May 2013 19:50:37 +0000 (21:50 +0200)
committerJoachim Breitner <mail@joachim-breitner.de>
Thu, 23 May 2013 19:50:37 +0000 (21:50 +0200)
conteq.dtx [new file with mode: 0644]

diff --git a/conteq.dtx b/conteq.dtx
new file mode 100644 (file)
index 0000000..b36696a
--- /dev/null
@@ -0,0 +1,511 @@
+% \iffalse meta-comment
+% !TEX program  = pdfLaTeX
+%<*internal>
+\iffalse
+%</internal>
+%<*readme>
+----------------------------------------------------------------
+conteq --- continued equalities
+E-mail: mail@joachim-breitner.de
+Released under the LaTeX Project Public License v1.3c or later
+See http://www.latex-project.org/lppl.txt
+----------------------------------------------------------------
+
+This package allows you to write an continued equality such as
+
+    \begin{conteq}
+    e^{\pi\cdot i} \\
+    = -1 & Euler's formula \\
+    < 0 & this is an inequality \\ 
+    < \sqrt 3 \\
+    = \int e^{-x^2} dx & this is due to Gauss.
+    \end{conteq}
+
+in a declarative manner and easily switch between various layouts afterwards.
+%</readme>
+%<*internal>
+\fi
+\def\nameofplainTeX{plain}
+\ifx\fmtname\nameofplainTeX\else
+  \expandafter\begingroup
+\fi
+%</internal>
+%<*install>
+\input docstrip.tex
+\keepsilent
+\askforoverwritefalse
+\preamble
+----------------------------------------------------------------
+conteq --- continued equalities
+E-mail: mail@joachim-breitner.de
+Released under the LaTeX Project Public License v1.3c or later
+See http://www.latex-project.org/lppl.txt
+----------------------------------------------------------------
+
+\endpreamble
+\postamble
+
+Copyright (C) 2013 by Joachim Breitner <mail@joachim-breitner.de>
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License (LPPL), either
+version 1.3c of this license or (at your option) any later
+version.  The latest version of this license is in the file:
+
+http://www.latex-project.org/lppl.txt
+
+This work is "maintained" (as per LPPL maintenance status) by
+Joachim Breitner.
+
+This work consists of the file  conteq.dtx
+and the derived files           conteq.ins,
+                                conteq.pdf and
+                                conteq.sty.
+
+\endpostamble
+\usedir{tex/latex/conteq}
+\generate{
+  \file{\jobname.sty}{\from{\jobname.dtx}{package}
+                      \from{\jobname.dtx}{layouts}}
+}
+%</install>
+%<install>\endbatchfile
+%<*internal>
+\generate{
+  \file{\jobname.ins}{\from{\jobname.dtx}{install}}
+}
+\nopreamble\nopostamble
+\generate{
+  \file{README.txt}{\from{\jobname.dtx}{readme}}
+}
+\ifx\fmtname\nameofplainTeX
+  \expandafter\endbatchfile
+\else
+  \expandafter\endgroup
+\fi
+%</internal>
+%<package>\NeedsTeXFormat{LaTeX2e}
+%<package>\RequirePackage{expl3}
+%<package>\ProvidesExplPackage
+%<package>  {conteq}              % Package name
+%<package>  {2013/05/23}          % Release date
+%<package>  {0.1}                 % Release version
+%<package>  {Various layouts for continued equalities} % Description
+%
+%<*driver>
+\documentclass[full]{l3doc}
+\usepackage[T1]{fontenc}
+\usepackage{lmodern}
+\usepackage{conteq}
+%\usepackage[numbered]{hypdoc}
+\EnableCrossrefs
+\CodelineIndex
+\RecordChanges
+\begin{document}
+  \DocInput{\jobname.dtx}
+\end{document}
+%</driver>
+% \fi
+%
+% \GetFileInfo{\jobname.sty}
+%
+% \CheckSum{166}
+%
+%
+%\title{^^A
+%  \textsf{conteq} --- continued equalities\thanks{^^A
+%    This file describes version \fileversion, last revised \filedate.^^A
+%  }^^A
+%}
+%\author{Joachim Breitner\thanks{E-mail: mail@joachim-breitner.de}}
+%
+%\date{Released \filedate}
+%
+%\maketitle
+%
+%\changes{0.1}{2013/05/23}{Converted to DTX file}
+%
+%
+% \section{Introduction}
+%
+% 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.
+%
+% \section{Usage}
+%
+% \DescribeEnv{conteq}
+% Our running example is the following continued equality:
+% 
+% \begin{verbatim}
+% \begin{conteq}
+% e^{\pi\cdot i} \\
+% = -1 & Euler's formula \\
+% < 0 & this is an inequality \\ 
+% < \sqrt 3 \\
+% = \int e^{-x^2} dx & this is due to Gauss.
+% \end{conteq}
+% \end{verbatim}
+%
+% 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.
+% 
+% The result of the above code is
+% \begin{conteq}
+% e^{\pi\cdot i} \\
+% = -1 & Euler's formula \\
+% < 0 & this is an inequality \\ 
+% < \sqrt 3 \\
+% = \int e^{-x^2} dx & this is due to Gauss.
+% \end{conteq}
+%
+% 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 |\ConteqExplanationLayout|.
+
+% There are other layouts available, which you select with an optional parameter to |\begin{conteq}|, e.g.
+% \begin{verbatim}
+% \begin{conteq}[explline]
+% [..]
+% \end{conteq}
+% \end{verbatim}
+
+% The layouts defined by |conteq| are:
+
+% \paragraph{plain} The default layout, shown above.
+
+% \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.
+% \begin{conteq}[explline]
+% e^{\pi\cdot i} \\
+% = -1 & Euler's formula \\
+% < 0 & this is an inequality \\ 
+% < \sqrt 3 \\
+% = \int e^{-x^2} dx & this is due to Gauss.
+% \end{conteq}
+
+
+% \paragraph{headline} Like plain, but the first expression is also vertically aligned with the right-hand sides.
+% \begin{conteq}[headline]
+% e^{\pi\cdot i} \\
+% = -1 & Euler's formula \\
+% < 0 & this is an inequality \\ 
+% < \sqrt 3 \\
+% = \int e^{-x^2} dx & this is due to Gauss.
+% \end{conteq}
+
+% \paragraph{onecolumn} A combination of \textbf{explline} and \textbf{headline} that puts everything in one column, for maximum space efficiency.
+% \begin{conteq}[onecolumn]
+% e^{\pi\cdot i} \\
+% = -1 & Euler's formula \\
+% < 0 & this is an inequality \\ 
+% < \sqrt 3 \\
+% = \int e^{-x^2} dx & this is due to Gauss.
+% \end{conteq}
+
+% \paragraph{oneline} A layout, more for demonstrational purposes, that ignores the explanations and puts everything in one line.
+% \begin{conteq}[oneline]
+% e^{\pi\cdot i} \\
+% = -1 & Euler's formula \\
+% < 0 & this is an inequality \\ 
+% < \sqrt 3 \\
+% = \int e^{-x^2} dx & this is due to Gauss.
+% \end{conteq}
+
+% \DescribeMacro{\ConteqSetDefaultLayout} You can change the default layout using |\ConteqSetDefaultLayout|\marg{layout}
+
+% \section{Defining layouts}
+%
+% \DescribeMacro{\ConteqDefineLayout}
+% To define a new layout you use |\ConteqDefineLayout|, which takes seven arguments:
+% \begin{enumerate}
+% \item The name of the layout,
+% \item What to put before the continued equalities,
+% \item the left-hand side of the first equality,
+% \item the right-hand side of equalities without explanation,
+% \item the right-hand side of equalities with explanation,
+% \item the line separator and
+% \item what to put after the continued equalities.
+% \end{enumerate}
+%
+% For example the existing layouts are defined using
+% \iffalse
+%<*layouts>
+% \fi
+%    \begin{macrocode}
+
+\ConteqDefineLayout
+    {plain}
+    {\begin{align*}}
+    { #1 }
+    { & #1 }
+    { & #1 && #2 }
+    { \\ }
+    {\end{align*}}
+\ConteqSetDefaultLayout{plain}
+
+\ConteqDefineLayout
+    {explline}
+    {\begin{align*}}
+    { #1 }
+    { & #1 }
+    { & #1 \\ & \mathrel{\phantom{=}} #2 }
+    { \\ }
+    {\end{align*}}
+
+\ConteqDefineLayout
+    {headline}
+    {\begin{align*}}
+    { &\mathrel{\phantom{=}} #1 \\ }
+    { & #1 }
+    { & #1 && #2 }
+    { \\ }
+    {\end{align*}}
+\ConteqDefineLayout
+    {onecolumn}
+    {\begin{align*}}
+    { &\mathrel{\phantom{=}} #1 \\ }
+    { & #1 }
+    { & #1 \\ & \mathrel{\phantom{=}} #2 }
+    { \\ }
+    {\end{align*}}
+
+\ConteqDefineLayout
+    {oneline}
+    {\[}
+    { #1 }
+    { #1 }
+    { #1 }
+    {}
+    {\]}
+
+%    \end{macrocode}
+%
+% \section{Changing the explanation style}
+%
+% \DescribeMacro{\ConteqExplStyle}
+% The explanation is formatted using the macro |\ConteqExplStyle|\marg{explanation}, which is by default defined as
+%    \begin{macrocode}
+\newcommand{\ConteqExplStyle}[1]{\{~#1~\}}
+%    \end{macrocode}
+%
+% To change the style, simply redefine this macro using, for example:
+% \begin{verbatim}
+% \renewcommand{\ConteqExplStyle}{\textit{-- #1}}
+% \end{verbatim}
+%
+%
+% \section{Future work}
+%
+% 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.
+%
+% 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.
+%
+% \iffalse
+%</layouts>
+% \fi
+%
+%\StopEventually{^^A
+%  \PrintChanges
+%  \PrintIndex
+%}
+%
+
+%
+% \section{Implementation}
+%
+% \iffalse
+%<*package>
+% \fi
+%
+% \subsection{Package loading}
+% 
+%    \begin{macrocode}
+\RequirePackage{amsmath}
+\RequirePackage{environ}
+%    \end{macrocode}
+
+% \subsection{Defining Messages}
+%
+%    \begin{macrocode}
+\msg_new:nnn
+    {conteq}
+    {empty}
+    { \msg_warning_text:n{conteq}:~Empty~conteq~environment~\msg_line_context: }
+
+\msg_new:nnn
+    {conteq}
+    {ignoreddata}
+    { \msg_warning_text:n{conteq}:~Ignored~text~\msg_line_context: }
+
+\msg_new:nnn
+    {conteq}
+    {undefinedlayout}
+    { \msg_critical_text:n{conteq}:~Undefined~layout~``#1''~\msg_line_context: }
+%    \end{macrocode}
+
+% \subsection{Declaring local variables}
+%
+%    \begin{macrocode}
+\tl_new:N \l_conteq_default_layout_tl
+\tl_new:N \l_conteq_layout_tl
+\tl_new:N \l_conteq_body_tl
+\tl_new:N \l_conteq_lines_seq
+\tl_new:N \l_conteq_cells_seq
+\tl_new:N \l_conteq_head_tl
+\tl_new:N \l_conteq_lastline_tl
+\tl_new:N \l_conteq_rhs_tl
+\tl_new:N \l_conteq_expl_tl
+\tl_new:N \l_conteq_result_tl
+%    \end{macrocode}
+
+% \subsection{Layouts}
+%
+% \begin{macro}{\ConteqSetDefaultLayout}
+% The code to set the default layout.
+%    \begin{macrocode}
+\cs_new_protected:Nn \conteq_set_default_layout:n {
+  \tl_set:Nn \l_conteq_default_layout_tl {#1}
+}
+\cs_new_eq:NN \ConteqSetDefaultLayout \conteq_set_default_layout:n
+%    \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\ConteqDefineLayout}
+% The code to define new layouts.
+%    \begin{macrocode}
+\cs_new_protected:Nn \conteq_define_layout:nnnnnnn {
+  \cs_new_protected:cn {conteq_#1_begin:} { #2 }
+  \cs_new_protected:cn {conteq_#1_lhs:n} { #3 }
+  \cs_new_protected:cn {conteq_#1_rhs_only:n} { #4 }
+  \cs_new_protected:cn {conteq_#1_rhs_expl:nn} { #5 }
+  \cs_new_protected:cn {conteq_#1_nl:} { #6 }
+  \cs_new_protected:cn {conteq_#1_end:} { #7 }
+}
+\cs_new_eq:NN \ConteqDefineLayout \conteq_define_layout:nnnnnnn
+%    \end{macrocode}
+% \end{macro}
+%
+% \subsection{Expansion utility function}
+% 
+% \begin{macro}{\conteq_args_once:Nn, \conteq_args_once:NV, \conteq_args_once:Nnn, \conteq_args_once:NVV}
+% 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.
+%
+%    \begin{macrocode}
+\cs_new:Npn \conteq_args_once:Nn #1#2 {
+   \exp_not:o {#1 {#2}}
+}
+\cs_generate_variant:Nn \conteq_args_once:Nn {NV}
+
+\cs_new:Npn \conteq_args_once:Nnn #1#2#3 {
+   \exp_not:o {#1 {#2}{#3}}
+}
+\cs_generate_variant:Nn \conteq_args_once:Nnn {NVV}
+%    \end{macrocode}
+% \end{macro}
+%
+% \subsection{Main code}
+%
+% \begin{macro}{\conteq_print_line:nn}
+% This macro splits and prints one line of the table. The second argument is either |\\| or, for the last line of the table, empty.
+%    \begin{macrocode}
+\cs_new_protected:Npn \conteq_print_line:Nnn #1#2#3 {
+  \seq_set_split:Nnn \l_conteq_cells_seq { & } {#2}
+  \seq_pop_left:NN \l_conteq_cells_seq \l_conteq_rhs_tl
+  \tl_clear:N \l_conteq_expl_tl
+  \seq_if_empty:NF \l_conteq_cells_seq {
+    \seq_pop_left:NN \l_conteq_cells_seq \l_conteq_expl_tl
+  }
+  \tl_if_blank:VTF \l_conteq_expl_tl {
+    \tl_put_right:Nx #1 {
+      \conteq_args_once:NV \conteq_rhs_only:n \l_conteq_rhs_tl
+    }
+  }{
+    \tl_set:Nx \l_tmpa_tl {\exp_not:N \text {\exp_not:N \ConteqExplStyle {\exp_not:V \l_conteq_expl_tl}}}
+    \tl_put_right:Nx #1 {
+      \conteq_args_once:NVV \conteq_rhs_expl:nn \l_conteq_rhs_tl \l_tmpa_tl
+    }
+  }
+  \seq_if_empty:NF \l_conteq_cells_seq {
+    \msg_warning:nn{conteq}{ignoreddata}
+  }
+  \tl_put_right:Nn #1 {#3}
+}
+\cs_generate_variant:Nn \conteq_print_line:Nnn {Nno}
+\cs_generate_variant:Nn \conteq_print_line:Nnn {NVn}
+%    \end{macrocode}
+% \end{macro}
+
+%
+% \begin{environment}{conteq}
+%
+% The main environment of the package.
+%    \begin{macrocode}
+\NewEnviron{conteq}[1][\l_conteq_default_layout_tl]{
+  \tl_set:NV \l_conteq_body_tl \BODY
+  
+  \tl_if_blank:oT \l_conteq_body_tl{
+      \msg_warning:nn{conteq}{empty}
+  }
+%    \end{macrocode}
+
+% Figure out the layout to use\ldots
+%    \begin{macrocode}
+  \tl_set:Nn \l_conteq_layout_tl {#1}
+%    \end{macrocode}
+% and set the various functions accordingly, if the layout exists.
+%    \begin{macrocode}
+  \cs_if_exist:cTF {conteq_ \l_conteq_layout_tl _ begin:}{
+    \clist_map_inline:nn{begin:, lhs:n,rhs_only:n, rhs_expl:nn, nl:, end:}{
+      \cs_set_eq:cc {conteq_##1}{conteq_\l_conteq_layout_tl _##1}
+    }
+  }{
+    \msg_critical:nnx{conteq}{undefined layout}{\l_conteq_layout_tl}
+  }
+%    \end{macrocode}
+
+% Split the body into individual lines.
+%    \begin{macrocode}
+  \seq_set_split:NnV \l_conteq_lines_seq { \\ } \l_conteq_body_tl
+
+  \tl_clear:N \l_conteq_result_tl
+%    \end{macrocode}
+
+% If there is only one line, simply print it.
+%    \begin{macrocode}
+
+  \int_case:nnn {\seq_count:N \l_conteq_lines_seq}
+  {
+    {1} {
+      \tl_put_right:NV \l_conteq_result_tl \conteq_begin:
+      \tl_put_right:NV \l_conteq_result_tl \l_conteq_body_tl
+      \tl_put_right:NV \l_conteq_result_tl \conteq_end:
+    }
+  }{
+%    \end{macrocode}
+
+% Otherwise extract the head and the last line, and print each line using |\conteq_print_line:nn|
+%    \begin{macrocode}
+    \seq_pop_left:NN \l_conteq_lines_seq \l_conteq_head_tl
+    \seq_pop_right:NN \l_conteq_lines_seq \l_conteq_lastline_tl
+
+    \tl_put_right:NV \l_conteq_result_tl \conteq_begin:
+    \tl_put_right:Nx \l_conteq_result_tl {
+      \conteq_args_once:NV \conteq_lhs:n \l_conteq_head_tl
+    }
+    \seq_map_inline:Nn \l_conteq_lines_seq {
+      \conteq_print_line:Nno \l_conteq_result_tl {##1} {\conteq_nl:} 
+    }
+    \conteq_print_line:NVn \l_conteq_result_tl \l_conteq_lastline_tl {} 
+    \tl_put_right:No \l_conteq_result_tl \conteq_end:
+  }
+  % Use this for debugging
+  %\tl_show:N \l_conteq_result_tl
+  \tl_use:N \l_conteq_result_tl
+}
+\endinput
+%    \end{macrocode}
+%\end{environment}
+
+%
+% \iffalse
+%</package>
+% \fi
+%
+% \Finale
+\endinput