From 2717d0fe451cea4e239315a39487ea999a06c507 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 1 Jul 2019 21:12:25 +0000 Subject: eqexpl (1jul19) git-svn-id: svn://tug.org/texlive/trunk@51524 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/eqexpl/README.md | 8 +-- Master/texmf-dist/doc/latex/eqexpl/README.ru.md | 4 +- Master/texmf-dist/doc/latex/eqexpl/eqexpl.pdf | Bin 87920 -> 106451 bytes Master/texmf-dist/doc/latex/eqexpl/eqexpl.tex | 66 +++++++++++++++++++++--- Master/texmf-dist/tex/latex/eqexpl/eqexpl.sty | 10 ++-- 5 files changed, 71 insertions(+), 17 deletions(-) diff --git a/Master/texmf-dist/doc/latex/eqexpl/README.md b/Master/texmf-dist/doc/latex/eqexpl/README.md index f7459febc42..5154494a41d 100644 --- a/Master/texmf-dist/doc/latex/eqexpl/README.md +++ b/Master/texmf-dist/doc/latex/eqexpl/README.md @@ -1,13 +1,13 @@ -Explanation of the formulas in LaTeX +Align explanation for formulas in LaTeX ======== The package is licenced under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). -The package was developed as an answer to question [on tex.stackexchange.com](https://tex.stackexchange.com/q/95838/119485) +The package was developed as an answer to the question on [tex.stackexchange.com](https://tex.stackexchange.com/q/95838/119485) -Package `eqexpl` was developed to give the tool to make «perfect» -explanation to formulas, not just the enumeration. +The package `eqexpl` was developed to give the tool to make «perfect» +explanation for formulas, not just the enumeration. I = U / Rs, (1) diff --git a/Master/texmf-dist/doc/latex/eqexpl/README.ru.md b/Master/texmf-dist/doc/latex/eqexpl/README.ru.md index fe2d720aea7..7d60a4da60a 100644 --- a/Master/texmf-dist/doc/latex/eqexpl/README.ru.md +++ b/Master/texmf-dist/doc/latex/eqexpl/README.ru.md @@ -1,10 +1,10 @@ -Пояснения к формулам в LaTeX +Выравнивание пояснений к формулам в LaTeX ======== Пакет распространяется по лицензии Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). -Пакет был разработан в качестве ответа на вопрос [на tex.stackexchange.com](https://tex.stackexchange.com/q/95838/119485) +Пакет был разработан в качестве ответа на вопрос на [tex.stackexchange.com](https://tex.stackexchange.com/q/95838/119485) Пакет `eqexpl` был разработан для того, чтобы обеспечить возможность давать формулам более осмысленные пояснения, оформление которых diff --git a/Master/texmf-dist/doc/latex/eqexpl/eqexpl.pdf b/Master/texmf-dist/doc/latex/eqexpl/eqexpl.pdf index d732f6ec105..33184744bb8 100644 Binary files a/Master/texmf-dist/doc/latex/eqexpl/eqexpl.pdf and b/Master/texmf-dist/doc/latex/eqexpl/eqexpl.pdf differ diff --git a/Master/texmf-dist/doc/latex/eqexpl/eqexpl.tex b/Master/texmf-dist/doc/latex/eqexpl/eqexpl.tex index 98fbce150d0..ece2fab947a 100644 --- a/Master/texmf-dist/doc/latex/eqexpl/eqexpl.tex +++ b/Master/texmf-dist/doc/latex/eqexpl/eqexpl.tex @@ -6,7 +6,7 @@ \begin{document} -\title{eqexpl} +\title{eqexpl v. 1.1} \author{Konstantin Morenko} \maketitle @@ -14,13 +14,18 @@ The package is licenced under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) +The package use \href{https://semver.org/}{semantic versioning}. + \section{The aim of the package} -The package was developed as an answer to question \href{https://tex.stackexchange.com/q/95838/119485}{on tex.stackexchange.com} +The package was developed as an answer to the question \href{https://tex.stackexchange.com/q/95838/119485}{on tex.stackexchange.com} Package was developed to give the tool to make <> explanation for formulas, not just the enumeration. +This package allows to describe formula's variables in unified through +the document manner. + \section{Similar packages} Nomencl: \href{http://ctan.org/pkg/nomencl}{http://ctan.org/pkg/nomencl} @@ -44,7 +49,39 @@ The list consist of few lengths: explanation text). \end{itemize} -\section{Test list} +\section{Usage} + +First, include package into preamble with + +\begin{verbatim} + \usepackage{eqexpl} +\end{verbatim} + +Then write a formula and describe the parameters + +\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; @@ -55,13 +92,11 @@ The list consist of few lengths: very very very very very very very very very long line; } -This list used for all examples: +This list is used for next examples: \begin{eqexpl} \testList \end{eqexpl} -\section{Configure and examples} - \subsection{Setting eqexplSetSpace} \noindent Set \verb+\eqexplSetSpace{0mm}+ @@ -102,9 +137,9 @@ This list used for all examples: \vspace{5mm} -\noindent Set \verb+\eqexplSetIntro{where we have}+ +\noindent Set \verb+\eqexplSetIntro{in this equation}+ -\eqexplSetIntro{where we have} +\eqexplSetIntro{in this equation} \begin{eqexpl} \testList \end{eqexpl} @@ -243,4 +278,19 @@ purpose use \verb+\begin{eqexpl}[width]+. \eqexplSetItemAlign{r} +\subsection{Setting 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} diff --git a/Master/texmf-dist/tex/latex/eqexpl/eqexpl.sty b/Master/texmf-dist/tex/latex/eqexpl/eqexpl.sty index e07d7d9797b..dfdd46779c0 100644 --- a/Master/texmf-dist/tex/latex/eqexpl/eqexpl.sty +++ b/Master/texmf-dist/tex/latex/eqexpl/eqexpl.sty @@ -1,5 +1,9 @@ -\ProvidesPackage{eqexpl}[2018/11/11 v.1] +%% The package is licenced under Creative Commons Attribution-ShareAlike +%% 4.0 International (CC BY-SA 4.0) + +\ProvidesPackage{eqexpl}[2019/05/15 v. 1.1] \RequirePackage{etoolbox} +\RequirePackage{xparse} \RequirePackage{calc} %% Spaces between elements @@ -47,7 +51,7 @@ \eqexplSpaceWidth}% \newtoggle{eqexplFirstItem}% \toggletrue{eqexplFirstItem}% - \renewcommand{\item}[1]{% + \RenewDocumentCommand{\item}{ m O{\eqexplDelim}}{% \olditem \makebox[\leftSideWidth]{% \ifdefempty{\eqexplIntro}{}{ \makebox[\widthof{\eqexplIntro}][l]{\iftoggle{eqexplFirstItem}{\eqexplIntro}{}}% @@ -55,7 +59,7 @@ } \makebox[\itemWidth][\eqexplItemAlign]{##1}% \hspace{\eqexplSpaceWidth}% - \makebox[\widthof{\eqexplDelim}][c]{\eqexplDelim}% + \makebox[\widthof{##2}][c]{##2}% \hspace{\eqexplSpaceWidth}% }% \togglefalse{eqexplFirstItem}% -- cgit v1.2.3