summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/annotate-equations
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-04-05 22:04:48 +0000
committerKarl Berry <karl@freefriends.org>2022-04-05 22:04:48 +0000
commitf6cee698af202074ee2bb63775baedacac5db628 (patch)
tree0519bb8dd292bb4c9001fe521d9350e0a52beddd /Master/texmf-dist/doc/latex/annotate-equations
parentb4f60b899d673f4fd4be385d5e0e73f78f201fe2 (diff)
annotate-equations (29mar22)
git-svn-id: svn://tug.org/texlive/trunk@62932 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/annotate-equations')
-rw-r--r--Master/texmf-dist/doc/latex/annotate-equations/LICENSE21
-rw-r--r--Master/texmf-dist/doc/latex/annotate-equations/README.md73
-rw-r--r--Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.pdfbin0 -> 124665 bytes
-rw-r--r--Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.tex282
4 files changed, 376 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/annotate-equations/LICENSE b/Master/texmf-dist/doc/latex/annotate-equations/LICENSE
new file mode 100644
index 00000000000..8a436817533
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/annotate-equations/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ST John, https://github.com/st--/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Master/texmf-dist/doc/latex/annotate-equations/README.md b/Master/texmf-dist/doc/latex/annotate-equations/README.md
new file mode 100644
index 00000000000..ca25cd8b0ba
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/annotate-equations/README.md
@@ -0,0 +1,73 @@
+# Annotate equations in LaTeX using TikZ
+
+This package provides commands that make it easy to highlight terms in equations & add annotation labels (based on TikZ).
+Should work with pdflatex as well as lualatex.
+
+Inspired by Sibin Mohan's https://github.com/synercys/annotated_latex_equations/
+
+Please report any bugs, issues, contribute changes & improvements on https://github.com/st--/annotate-equations/ :)
+
+Package author: ST John, http://www.infinitecuriosity.org/
+
+License: [MIT](LICENSE)
+
+[Documentation](annotate-equations.pdf)
+
+## A package with reusable commands
+
+![rendering of annotated equation](examples/example_annotation_package.png)
+
+Using [`annotate-equations.sty`](https://github.com/st--/annotate-equations/blob/main/annotate-equations.sty), an equation can easily be annotated as follows:
+```latex
+\begin{equation*}
+ \mathcal{O}\big(
+ (
+ \eqnmarkbox[NavyBlue]{p1}{p}
+ \eqnmarkbox[OliveGreen]{k1}{\kappa}^3 % note that we have the ^3 outside the \eqnmark/\tikzmarknode arguments
+ )
+ \eqnmarkbox[WildStrawberry]{T1}{T}
+ +
+ (
+ \eqnmarkbox[NavyBlue]{p2}{p} % tikz nodes need distinct names!
+ \eqnmark[OliveGreen]{k2}{\kappa}
+ )
+ (
+ \eqnmarkbox[WildStrawberry]{T2}{T}^2
+ \tikzmarknode{Is}{|\mathcal{I}^*|} % manual \tikzmarknode works, too
+ \eqnmarkbox[Plum]{Nb}{N_b}
+ \eqnmark[RoyalPurple]{M}{M}
+ )
+ \big)
+\end{equation*}
+\annotatetwo[yshift=1em]{above}{p1}{p2}{\# of nodes}
+\annotatetwo[yshift=-1em,xshift=0.2ex]{below}{T1}{T2}{\# of graphs in $\hat{\mathcal{G}}_T$}
+\annotatetwo[yshift=-2em]{below}{k1}{k2}{max.\ indegree in $\hat{\mathcal{G}}_T$}
+\annotate[yshift=3em]{above,left}{Is}{size of set of allowed interventions}
+\annotate[yshift=1em]{above}{Nb}{\# of samples per batch}
+\annotate[yshift=-1em]{below}{M}{\# of samples for $\mathbb{E}_y$}
+```
+
+More details are in the [user manual](annotate-equations.pdf).
+Should work with both pdflatex and lualatex.
+
+## How to do it from scratch: annotated examples
+
+![rendering of annotated equation](examples/example_annotation.png)
+
+Inspired by Sibin Mohan's https://github.com/synercys/annotated_latex_equations/, but with significantly simplified TikZ code, and with lots of comments to explain what is going on.
+
+Two versions, one [as Beamer slides with transitions](https://github.com/st--/annotate-equations/blob/main/examples/demo_manual_annotate_beamer.tex), one [as an article](https://github.com/st--/annotate-equations/blob/main/examples/demo_manual_annotate_article.tex). For further examples, see https://github.com/synercys/annotated_latex_equations/.
+
+### Giving all highlight boxes the same height
+
+Simply add a `\mathstrut` within the colorbox:
+```diff
+-\newcommand{\highlight}[2]{\colorbox{#1!17}{$#2$}}
++\newcommand{\highlight}[2]{\colorbox{#1!17}{$\mathstrut #2$}}
+```
+
+![rendering of annotated equation with equal-height highlights](examples/example_annotation_equal_height.png)
+
+## Much more information...
+
+...in the answers to [this TeX StackExchange question](https://tex.stackexchange.com/q/254844/171664).
diff --git a/Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.pdf b/Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.pdf
new file mode 100644
index 00000000000..984daaf8ade
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.tex b/Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.tex
new file mode 100644
index 00000000000..2b492a36e49
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/annotate-equations/annotate-equations.tex
@@ -0,0 +1,282 @@
+\documentclass{article}
+\usepackage[a4paper, margin=1in]{geometry}
+
+\usepackage[dvipsnames]{xcolor}
+
+%%% standard math packages for equations:
+\usepackage{amsmath}
+\usepackage{amssymb}
+\usepackage{mathtools}
+
+\usepackage{hyperref}
+\usepackage{cleveref}
+
+\usepackage{annotate-equations}
+
+%\usepackage{showexpl} % LTXexample
+\usepackage[skins,listings]{tcolorbox}
+\newtcblisting{LTXexample}[1][]{%
+ colframe=black!20,
+ colback=black!10,
+ coltitle=red!50!yellow!3!white,
+ bicolor,colbacklower=white,
+ fonttitle=\sffamily\bfseries,
+% listing options={escapeinside=\`\`},
+ %sidebyside,
+ text above listing,
+ #1}
+
+\title{\texttt{annotate-equations.sty}}
+\author{ST John}
+\date{\url{https://github.com/st--/annotate-equations}}
+
+\begin{document}
+
+\maketitle
+
+\section{Introduction}
+
+This package is there to make it easier to make annotated equations in \LaTeX, such as in this example:
+\begin{LTXexample}[]
+\vspace{4em}
+\renewcommand{\eqnhighlightheight}{\vphantom{\hat{H}}\mathstrut}
+\begin{equation*}
+ i \tikzmarknode{hbar}{\mathstrut\hbar} \frac{\partial}{\partial t} \eqnmarkbox[blue]{Psi1}{\Psi(x, t)} = \eqnmark[red]{Hhat}{\hat{H}} \eqnmarkbox[blue]{Psi2}{\Psi(x, t)}
+\end{equation*}
+\annotate[yshift=3em]{above}{hbar}{$\hbar = \frac{h}{2\pi}$, reduced Planck constant}
+\annotate[yshift=1em]{above}{Hhat}{Hamilton operator}
+\annotatetwo[yshift=-1em]{below}{Psi1}{Psi2}{Wave function}
+\vspace{1em}
+\end{LTXexample}
+There is still a bit of manual tweaking required (such as adding vertical space before/after the equation), but hopefully this package will already make it a bit more inviting to annotate your equations!
+
+\section{Marking annotation targets within your equation}
+
+\newcommand{\cmdoption}[1]{$\langle$\textit{#1}$\rangle$}
+
+Use
+\verb|\eqnmarkbox[|\cmdoption{color}\verb|]{|\cmdoption{node name}\verb|}{|\cmdoption{equation term(s)}\verb|}|
+or
+\verb|\eqnmark[|\cmdoption{color}\verb|]{|\cmdoption{node name}\verb|}{| \cmdoption{equation term(s)}\verb|}|
+to define the target of an annotation within your equation. \verb|\eqnmarkbox| adds background shading, whereas \verb|\eqnmark| changes the text color.
+(You can also use
+\verb|\tikzmarknode{|\cmdoption{node name}\verb|}{|\cmdoption{equation term(s)}\verb|}|,
+but this is likely to end up with the arrow tip too close to the target.)
+%
+\begin{LTXexample}[text outside listing,lefthand width=1in]
+\begin{equation*}
+ \eqnmarkbox[blue]{node1}{e_q^n}
+ \eqnmark[red]{node2}{f(x)}
+ \tikzmarknode{node3}{kT}
+\end{equation*}
+\end{LTXexample}
+\noindent
+
+\section{Simple annotations}
+\label{sec:annotate}
+
+Once you have defined nodes within your equations, you can annotate them using
+\verb|\annotate[|\cmdoption{tikz options}\verb|]{|\cmdoption{annotate keys}\verb|}{|\cmdoption{node name[,\dots]}\verb|}{|\cmdoption{annotation text}\verb|}|.
+%
+\cmdoption{tikz options} is passed through to the options for the TikZ node defining the annotation; its most important use is to set the \texttt{yshift}.
+For \cmdoption{annotate keys}, see \cref{sec:annotate-keys}.
+\cmdoption{node name} is the same name you used to mark the node within the equation, e.g.\ using \verb|\eqnmarkbox|.
+\cmdoption{annotation text} is the text of the annotation itself.
+%
+\begin{LTXexample}[text outside listing,lefthand width=1in]
+\begin{equation*}
+ \eqnmarkbox[blue]{node1}{e_q^n}
+ \eqnmark[red]{node2}{f(x)}
+ \tikzmarknode{node3}{kT}
+\end{equation*}
+\annotate[yshift=1em]{}{node1,node2}{my annotation text}
+\end{LTXexample}
+\noindent
+%
+\label{sec:tikz-options}
+You generally need to manually adjust the \texttt{yshift} to move the annotations to an appropriate distance above (or negative values for below) the equation.
+(You can also adjust \texttt{xshift} if needed, also positive or negative.)
+
+The annotation picks the same text color as given to \verb|\eqnmarkbox| or \verb|\eqnmark|, but you can also override it using \texttt{color} option.
+
+One annotation can point to multiple targets, and multiple annotations can point to the same target.
+
+\subsection{Annotation options}
+\label{sec:annotate-keys}
+
+\cmdoption{annotate keys} can be empty, or contain one or more of:
+\begin{itemize}
+ \item \texttt{above} (default) or \texttt{below},
+ \item \texttt{right} (default) or \texttt{left},
+ \item \texttt{label above} (default) or \texttt{label below}.
+
+ Note: currently only works for \verb|\annotatetwo| (\cref{sec:annotatetwo}).
+\end{itemize}
+%
+\begin{LTXexample}[text outside listing,lefthand width=1in]
+\begin{equation*}
+ \eqnmarkbox[blue]{node1}{e_q^n}
+ \eqnmark[red]{node2}{f(x)}
+ \tikzmarknode{node3}{kT}
+\end{equation*}
+\annotate[yshift=1em]{left}{node1}{my}
+\annotate[yshift=-0.5em]{below,left}{node2}{annotation}
+\annotate[yshift=-1em]{below}{node3}{text}
+\end{LTXexample}
+\noindent
+%
+
+\section{Double annotations}
+\label{sec:annotatetwo}
+
+\verb|\annotatetwo[|\cmdoption{tikz options}\verb|]{|\cmdoption{annotate keys}\verb|}{|\cmdoption{first node name}\verb|}{|\cmdoption{second node name}\verb|}{|\cmdoption{annotation text}\verb|}|.
+\cmdoption{tikz options} and \cmdoption{annotate keys} are as described above in \cref{sec:tikz-options,sec:annotate-keys}. Note that \cmdoption{annotate keys} \texttt{left}/\texttt{right} have no effect in \verb|\annotatetwo|.
+
+\begin{LTXexample}[text outside listing,lefthand width=1in]
+\begin{equation*}
+ \eqnmarkbox[red]{a1}{a} \eqnmarkbox[blue]{b1}{b} = \eqnmarkbox[green]{b2}{b} \eqnmarkbox{a2}{a}
+\end{equation*}
+\annotatetwo[yshift=1.5em]{above, label below}{a1}{a2}{var 1}
+\annotatetwo[yshift=0.5em]{above}{b1}{b2}{var 2}
+\annotatetwo[yshift=-0.5em]{below}{b2}{b1}{var 2}
+\end{LTXexample}
+\noindent
+%
+Color is picked from the first of the two nodes.
+
+\section{Package options}
+
+\subsection{Size of highlight: shrink to content or always full height}
+
+\verb|\eqnhighlightheight| is inserted into every \verb|\eqnhighlight|, \verb|\eqncolor|, \verb|\eqnmark|, and \verb|\eqnmarkbox| and by redefining it you can specify the minimum height for the corresponding box:
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\renewcommand{\eqnhighlightheight}{} % package default
+\begin{equation*}
+ \eqnmarkbox[red]{hbar}{\hbar} \eqnmarkbox[blue]{q}{q}
+\end{equation*}
+\end{LTXexample}
+\noindent
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\renewcommand{\eqnhighlightheight}{\mathstrut} % 0-width "constant" height
+\begin{equation*}
+ \eqnmarkbox[red]{hbar}{\hbar} \eqnmarkbox[blue]{q}{q}
+\end{equation*}
+\end{LTXexample}
+\noindent
+%
+\verb|\eqnhighlightheight| is used in math mode.
+
+
+Note that in some cases \verb|\mathstrut| might not be enough, as in the introductory example:
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\renewcommand{\eqnhighlightheight}{\mathstrut} % 0-width "constant" height
+\begin{equation*}
+ \eqnmarkbox[red]{Hhat}{\hat{H}} \eqnmarkbox[blue]{Psi}{\Psi}
+\end{equation*}
+\end{LTXexample}
+\noindent
+%
+You can create custom 0-width characters using \verb|\vphantom|:
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\renewcommand{\eqnhighlightheight}{\vphantom{\hat{H}}\mathstrut} % custom 0-width height
+\begin{equation*}
+ \eqnmarkbox[red]{Hhat}{\hat{H}} \eqnmarkbox[blue]{Psi}{\Psi}
+\end{equation*}
+\end{LTXexample}
+\noindent
+%
+(It looks more balanced if you still include the \verb|\mathstrut|.)
+
+\subsection{Amount of shading of mark highlight}
+
+\verb|\eqnhighlightshade| defines the percentage of the specified color to take:
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\renewcommand{\eqnhighlightshade}{17} % package default
+\begin{equation*}
+ \eqnmarkbox[red]{hbar}{\hbar} \eqnmarkbox[blue]{q}{q}
+\end{equation*}
+\end{LTXexample}
+\noindent
+%
+By redefining this command, you can change the ``alpha'' value of the highlight:
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\renewcommand{\eqnhighlightshade}{47} % 0 is white, 100 is solid color
+\begin{equation*}
+ \eqnmarkbox[red]{hbar}{\hbar} \eqnmarkbox[blue]{q}{q}
+\end{equation*}
+\end{LTXexample}
+\noindent
+
+\subsection{Default formatting of annotation labels}
+
+\verb|\eqnannotationtext| is a one-argument command that gets the annotation text as an argument and can be used to have consistent formatting:
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+% package default:
+\renewcommand{\eqnannotationtext}[1]{\sffamily\footnotesize#1\strut}
+
+\begin{equation*}
+ \eqnmarkbox[blue]{v}{v}
+\end{equation*}
+\annotate[yshift=-0.5em]{below}{v}{velocity}
+\vspace{1em}
+\end{LTXexample}
+\noindent
+%
+(The \verb|\strut| has a similar effect to \verb|\mathstrut| in \verb|\eqnhighlightheight|.)
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\renewcommand{\eqnannotationtext}[1]{\bfseries\small#1}
+
+\begin{equation*}
+ \eqnmarkbox[blue]{v}{v}
+\end{equation*}
+\annotate[yshift=-0.5em]{below}{v}{velocity}
+\vspace{1em}
+\end{LTXexample}
+\noindent
+%
+
+\section{Recommendations, tips \& tricks}
+
+\subsection{Use \texttt{\textbackslash{}colorlet} for consistent, easily changeable colors}
+
+\subsection{Line breaks within annotations}
+\label{sec:multiline}
+
+Possible, but a bit annoying. By default, the formatting only covers the first line:
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\begin{equation*}
+ \eqnmarkbox[blue]{h}{h}
+\end{equation*}
+\annotate[yshift=-0.5em]{below}{h}{Planck\\constant}
+\vspace{1em}
+\end{LTXexample}
+\noindent
+%
+Here is a manual work-around:
+%
+\begin{LTXexample}[text outside listing,lefthand width=0.5in]
+\begin{equation*}
+ \eqnmarkbox[blue]{h}{h}
+\end{equation*}
+\annotate[yshift=-0.5em]{below}{h}{Planck\\\sffamily\footnotesize constant}
+\vspace{1em}
+\end{LTXexample}
+\noindent
+
+\section{Known issues}
+
+\begin{itemize}
+ \item \texttt{label above}/\texttt{label below} not implemented for \verb|\annotate|.
+
+ \item Formatting only covers first line in multi-line annotation texts (see \cref{sec:multiline}).
+\end{itemize}
+
+\end{document}