View on GitHub

latex-equation-explanation

«Perfect» equation explanation for LaTeX

Пояснения к формулам в LaTeX

English

Пакет доступен на ctan.org.

Пакет доступен в Ubuntu в пакете texlive-science начиная с версии 19.4 Disco Dingo.

Пакет eqexpl был разработан как ответ на вопрос на StackExchange для того, чтобы обеспечить возможность давать формулам более осмысленные пояснения, оформление которых отличается от простого перечисления.

Eqexpl example

Требования к оформлению:

  1. Поясняемые переменные выравниваются по правому краю.
  2. Тире пояснения выравнивается по центру друг под другом.
  3. Пояснения выравниваются по ширине, последняя строка выравнивается по левому краю, при этом
    • если левый край пояснения занимает более одной строки, строки должны быть выровнены слева (например, как во втором пояснении).

Пакет добавляет новое окружение eqexpl, внутри которого команда перечисления \item имеет обязательный параметр — поясняемую переменную. Пояснение выше выполненяется следующим образом в преамбуле

\usepackage{eqexpl}
\eqexplSetDelim{=}

и в самом документе

\begin{eqexpl}[25mm]
\item{$H_s$}significant wave height, equal to the average of the
highest 1/3 of the waves
\item{$\Delta$}relative buoyant density, equal to $\rho_r / \rho_w -
1$, where $\rho_w$ is the water density
\item{$D_{n50}$}nominal diameter defined in Equation (2)
\end{eqexpl}

Ширина поля для поясняемых переменных может быть задана с помощью необязательного параметра окружения, по умолчанию 10 мм

\begin{eqexpl}[15mm]

Разделитель может быть задан командой \eqexplSetDelim{delimiter}

Вводное слово задаётся командой \eqexplSetIntro{где}, при этом вводное слово выводится только перед первой переменной.

Для того, чтобы использовать формулы в пояснении, их нужно заключить в строковое окружение формул

\item{$R_s$} суммарное сопротивление участка, Ом.