universemaster / explain-math

🧮 LaTeX package for writing readable and explained mathematics

explain-math

🧮 A handy LaTeX package for writing readable and explained mathematics

• explain-math
  • 🚀 Installation
  • ✨ Commands
    • \explain
    • \step
    • \eq
    • \formula
    • \statement
    • \variables
    • \var
    • \vart
    • \varu
    • \vartu
    • \sol
    • \msol
    • \bexplain
    • \aexplain

🚀 Installation

Copy the package file to /usr/local/texlive/texmf-local/tex/latex/local on your machine. This can be accomplished with the following commands:

sudo make install

If you need to uninstall just remove the file by running the following command:

sudo rm /usr/local/texlive/texmf-local/tex/latex/local/explain-math.sty

Once you have that you can just call the package:

\usepackage{explain-math}

✨ Commands

See an example of some commands in the example PDF

\explain

Description: Explain some math

Required parent environment: align or align*

Parameters:

1. Explanation (normal mode)
2. Math (math mode)

Example:

\begin{align*}
    \explain{Here is some math}{2 + 2 = 4}
    \explain{Here is some multiline math}{
        \step{ 2 + 2 = 4 }
        \step{ 10 - 10 = 0 }
    }
\end{align*}

\step

Description: A step inside the math section of the \explain environment

Required parent environment: None, but should be inside \explain arg #2

Parameters:

1. Math (math mode)

Example:

\begin{align*}
    \explain{Here is some multiline math}{
        \step{ 2 + 2 = 4 }
        \step{ 10 - 10 = 0 }
    }
\end{align*}

\eq

Description: Equation

Required parent environment: align or align*

Parameters:

1. Equation (math mode)

Example:

\begin{align*}
    \eq{c^2 = a^2 + b^2}
\end{align*}

\formula

Description: Formula

Required parent environment: align or align*

Parameters:

1. Formula (math mode)

Example:

\begin{align*}
    \formula{P = x + b}
\end{align*}

\statement

Description: Math statement

Required parent environment: align or align*

Parameters:

1. Math statement (math mode)

Example:

\begin{align*}
    \statement{-2(x + 2) = 6}
\end{align*}

\variables

Description: Define variables that should be plugged into a formula

Required parent environment: align or align*

Parameters:

1. Variables (math mode)

Example:

\begin{align*}
    \variables{a = 2}
    \varables{
        a = 10 \\
        b = 2 \\
        c = 10
    }
\end{align*}

\var

Description: Variable declaration

Required parent environment: align or align*

Parameters:

1. Name (math mode)
2. Value (math mode)

\var{x}{10}

\vart

Description: Variable declaration with name in text

Required parent environment: align or align*

Parameters:

1. Name (normal mode)
2. Value (math mode)

\vart{x}{10}

\varu

Description: Variable declaration with unit

Required parent environment: align or align*

Parameters:

1. Name (math mode)
2. Value (math mode)
3. Unit (normal mode)

\varu{x}{10}{cm}

\vartu

Description: Variable declaration with text and unit

Required parent environment: align or align*

Parameters:

1. Name (normal mode)
2. Value (math mode)
3. Unit (normal mode)

\vartu{x}{10}{cm}

\sol

Description: Solution to a problem

Required parent environment: None

Parameters:

1. Solution (normal mode)

Example:

\sol{All real numbers}

\msol

Description: Solution to a problem with math

Required parent environment: None

Parameters:

1. Solution (math mode)

Example:

\msol{x = 10}

\bexplain

Description: Braced explanation below some math

Required parent environment: Math environment

Parameters:

1. Note (normal mode)
2. Math (math mode)

Example:

$ \bexplain{This isn't true}{2 + 2 = 0} $

\aexplain

Description: Braced explanation above some math

Required parent environment: Math environment

Parameters:

1. Note (normal mode)
2. Math (math mode)

Example:

$ \aexplain{This is true}{2 + 2 = 4} $