From 3e416a68ae085e2b945166573802a9ea37729a94 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= <git@maximilian-kessler.de>
Date: Sun, 30 Jan 2022 17:16:28 +0100
Subject: [PATCH] document mathsymb package

---
 doc/math/mathsymb/.latexmkrc   |  4 ++
 doc/math/mathsymb/Makefile     |  8 ++++
 doc/math/mathsymb/mathsymb.tex | 76 ++++++++++++++++++++++++++++++++++
 3 files changed, 88 insertions(+)
 create mode 100644 doc/math/mathsymb/.latexmkrc
 create mode 100644 doc/math/mathsymb/Makefile
 create mode 100644 doc/math/mathsymb/mathsymb.tex

diff --git a/doc/math/mathsymb/.latexmkrc b/doc/math/mathsymb/.latexmkrc
new file mode 100644
index 0000000..4c81cd6
--- /dev/null
+++ b/doc/math/mathsymb/.latexmkrc
@@ -0,0 +1,4 @@
+$makeindex = "makeindex -s gind.ist %O -o %D %S";
+$clean_ext .= ' glo';
+$clean_ext .= ' hd';
+$clean_ext .= ' ins';
diff --git a/doc/math/mathsymb/Makefile b/doc/math/mathsymb/Makefile
new file mode 100644
index 0000000..e174370
--- /dev/null
+++ b/doc/math/mathsymb/Makefile
@@ -0,0 +1,8 @@
+doc:
+	latexmk
+
+full:
+	latexmk -gg
+
+clean:
+	latexmk -C
diff --git a/doc/math/mathsymb/mathsymb.tex b/doc/math/mathsymb/mathsymb.tex
new file mode 100644
index 0000000..b89923b
--- /dev/null
+++ b/doc/math/mathsymb/mathsymb.tex
@@ -0,0 +1,76 @@
+\documentclass[full]{l3doc}
+
+\title{The \pkg{mkessler-mathsymb} package}
+\author{Maximilian Keßler}
+
+\usepackage{mkessler-mathsymb}
+
+\begin{document}
+
+\maketitle
+
+\begin{abstract}
+  Provides some selected symbols related to mathematics.
+
+  This is certainly a very specific, non-generic package,
+  heavily based on the authors use-cases.
+
+  Feel free to use this as well if you like the symbols.
+\end{abstract}
+
+\begin{documentation}
+  
+\begin{function}{\noloc}
+  An inverse \cs{colon} with the correct spacing.
+
+  The implementation is by user
+  \href{https://tex.stackexchange.com/users/4427/egreg}
+  on
+  \href{https://tex.stackexchange.com/}{Tex StackExchange}
+  question
+  \href{https://tex.stackexchange.com/questions/546713/spacing-in-colon}
+  {https://\allowbreak tex\allowbreak .stack\allowbreak exchange\allowbreak .com/\allowbreak questions/546713/spacing-in-colon}
+\end{function}
+
+
+\begin{function}{\contra}
+  Prints a contradiction symbol
+\end{function}
+
+\begin{function}{\Warning}
+  Prints a warning symbol
+\end{function}
+
+\begin{function}{\circled}
+  \begin{syntax}
+    \cs{circled}\marg{stuff}
+  \end{syntax}
+  Dynamically circles the \meta{stuff}.
+  The circle is adjusted in size.
+\end{function}
+
+\begin{function}{\chainbullet}
+  Synonym for \cs{bullet}.
+  Only existent for semantic reasons.
+\end{function}
+
+\begin{table}[htpb]
+  \centering
+  \caption{Symbol table}
+  \label{tab:symbols}
+  \begin{tabular}{c | c}
+    Macro & Result \\
+    \texttt{Y \cs{leftarrow} X \cs{noloc} f} & $Y \leftarrow X \noloc f$ \\
+    \cs{contra} & \contra \\
+    \cs{Warning} & \Warning \\
+    \cs{circled}\{1\} & \circled{1} \\
+    \cs{chainbullet} & $\chainbullet$
+  \end{tabular}
+\end{table}
+
+
+\end{documentation}
+
+\PrintIndex
+  
+\end{document}