summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/mhequ/example.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/mhequ/example.tex')
-rw-r--r--macros/latex/contrib/mhequ/example.tex48
1 files changed, 36 insertions, 12 deletions
diff --git a/macros/latex/contrib/mhequ/example.tex b/macros/latex/contrib/mhequ/example.tex
index c0eca63f65..e839a9d89a 100644
--- a/macros/latex/contrib/mhequ/example.tex
+++ b/macros/latex/contrib/mhequ/example.tex
@@ -1,4 +1,5 @@
\documentclass{article}
+\usepackage{amsmath}
\usepackage{mhequ}
\def\eref#1{(\ref{#1})}
@@ -11,25 +12,45 @@
\begin{document}
-\title{Using the mhequ package}
+\title{Using the \texttt{mhequ} package}
\author{Martin Hairer}
-\date{Version 1.7, \today}
+\date{Version 1.71, \today}
\maketitle
\thispagestyle{empty}
-\label{mySec}
+
+This package provides two environments: \texttt{equ} for single-line equations
+and \texttt{equs} for multi-line equations. They behave similarly to the built-in
+\texttt{equation} and \texttt{amsmath}'s \texttt{align} environments and can essentially
+be used as drop-in replacements. The main difference is that equation numbers are
+handled differently: equations are numbered if and only if they have a \verb|\label|,
+so there is no need for starred versions. This also applies to individual lines in
+a multiline equation. Also, the \texttt{equs} environment supports blocks of equation
+with more
+
+Since \texttt{mhequ} redefines the \verb|\tag| and \verb|\intertext| commands, it should
+always be loaded \textit{after} the \texttt{amsmath} package. However, these
+two commands should still behave correctly inside the \texttt{amsmath} environments.
+The rest of this document demonstrates the usage of the \texttt{mhequ} package,
+it is easiest to just read the source code of this document to see how it works.
+See also the description given at the start of the file \texttt{mhequ.sty}.
+
Here is a simple labelled equation:
\begin{equ}[onelab]
- \sum_{i=1}^5 X_i^j X^j_i = y^j \;.
+ e^{i\pi} + 1 = 0 \;.
\end{equ}
Removing or adding the label does not require a change of environment:
\begin{equ}
- \sum_{i=1}^5 X_i^j X^j_i = y^j \;.
+ e^{i\pi} + 1 = 0 \;.
\end{equ}
However, if the option \texttt{numberall} is set, then every single
equation is numbered.
A simple list of equations can be displayed either with one number
per equation
+\begin{align}
+ f(x) &= \sin(x) + 1\;, \label{e:equ1}\\
+ h(x) &= f(x) + g(x) -3\;, \label{e:equ3}
+\end{align}
\begin{equs}
f(x) &= \sin(x) + 1\;, \label{e:equ1}\\
h(x) &= f(x) + g(x) -3\;, \label{e:equ3}
@@ -37,14 +58,15 @@ per equation
or with one number for the whole list
\begin{equs}[e:block]
f(x) &= \sin(x) + 1\;, \\
- h(x) &= f(x) + g(x) -3\;,
+ h(x) &= f(x) + g(x) -3\;.
\end{equs}
-using only a very small modification in the syntax. Of course, it can also have no number at all:
+Of course, it can also have no number at all:
\begin{equs}
f(x) &= \sin(x) + 1\;, \\
h(x) &= f(x) + g(x) -3\;.
\end{equs}
-Let us make a first group:
+The command \verb|\minilab{label_name}| allows us to create a counter for the lines
+in a block of equations.
\minilab{otherlabel}
\begin{equs}
f(x) &= \sin(x) + 1\;, \label{e:f}\\
@@ -53,11 +75,12 @@ Let us make a first group:
\end{equs}
One can refer to the whole block \eref{otherlabel} or to one
line, like \eref{e:f} for example.
-It is possible to use any tag one likes with the \texttt{\string\tag}
+It is possible to use any tag one likes with the \verb|\tag{displayed_tag}|
command
\begin{equ}[mylabel]
- x = y\;. \tag{$\star$}
+ x = y\;, \tag{$\star$}
\end{equ}
+which in this case was used as \verb|\tag{$\star$}|.
Such an equation can be referred to as usual: \eref{mylabel}.
Of course, \texttt{mhequ} can be used in conjunction with the usual \texttt{equation} environment,
but \texttt{mhequ} is great, so why would you want to do this?
@@ -75,7 +98,8 @@ with awkward names:
\intertext{and also (this is some \texttt{\string\intertext})}
x&=y+z &\qquad a&= (b+c)^2 - 5 &\qquad \ell&= m\label{labb}
\end{equs}
-We can even extend the block \eref{otherlabel} much later like
+We can even extend the block \eref{otherlabel} much later
+using the \verb|\minilab{label_name}| command:
\minilab{otherlabel}
\begin{equs}
x&=y+z &\quad x&=y+z &\quad f(x)&= b\label{e:x1}\\
@@ -83,7 +107,7 @@ We can even extend the block \eref{otherlabel} much later like
\multicol{6}{\sin^2 x + \cos^2 x = 1} \label{e:x3}
\end{equs}
It is possible to change the type of subnumbering and to use the
-\texttt{\string\text} command without having to load \texttt{amstext}, like so
+\texttt{\string\text} command without having to load \texttt{amstext}:
\setlabtype{Alph}
\minilab{alab}
\begin{equs}