From 0f6a9d112e5526939d1ad1991edea058ee57a908 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= <git@maximilian-kessler.de>
Date: Sun, 30 Jan 2022 19:34:46 +0100
Subject: [PATCH] document enumerate package

---
 doc/wrappers/enumerate/.latexmkrc    |  4 ++
 doc/wrappers/enumerate/Makefile      |  8 ++++
 doc/wrappers/enumerate/enumerate.tex | 69 ++++++++++++++++++++++++++++
 3 files changed, 81 insertions(+)
 create mode 100644 doc/wrappers/enumerate/.latexmkrc
 create mode 100644 doc/wrappers/enumerate/Makefile
 create mode 100644 doc/wrappers/enumerate/enumerate.tex

diff --git a/doc/wrappers/enumerate/.latexmkrc b/doc/wrappers/enumerate/.latexmkrc
new file mode 100644
index 0000000..4c81cd6
--- /dev/null
+++ b/doc/wrappers/enumerate/.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/wrappers/enumerate/Makefile b/doc/wrappers/enumerate/Makefile
new file mode 100644
index 0000000..e174370
--- /dev/null
+++ b/doc/wrappers/enumerate/Makefile
@@ -0,0 +1,8 @@
+doc:
+	latexmk
+
+full:
+	latexmk -gg
+
+clean:
+	latexmk -C
diff --git a/doc/wrappers/enumerate/enumerate.tex b/doc/wrappers/enumerate/enumerate.tex
new file mode 100644
index 0000000..4a23081
--- /dev/null
+++ b/doc/wrappers/enumerate/enumerate.tex
@@ -0,0 +1,69 @@
+\documentclass[full]{l3doc}
+
+\title{The \pkg{mkessler-enumerate} package}
+\author{Maximilian Ke\ss ler}
+
+\begin{document}
+
+\maketitle
+
+\begin{documentation}
+
+\begin{abstract}
+  This is some small wrapper around the package \pkg{enumerate}
+  that provides some additional tweaks.
+\end{abstract}
+
+We load \pkg{enumitem} with the \texttt{shortlabels} option.
+  
+
+\begin{function}{\setItemnumber, \SetItemNumber}
+  \begin{syntax}
+    \cs{SetItemNumber}\marg{numeric expression}
+  \end{syntax}
+
+  Sets the item number in the current enumeration.
+
+  The \cs{setItemnumber} is deprecated, use \cs{SetItemNumber}
+  instead if you can.
+\end{function}
+
+
+We now provide for standard variants for enumerations:
+\begin{function}{circled, propery, equivalent, holds}
+\begin{description}
+  \item[circled]
+    This circles the (arabic) item numbers
+
+  \item[property]
+    This numbers as \enquote{(\cs{roman}*)},
+    i.e.~\enquote{i)}, \enquote{ii)},\ldots
+
+  \item[equivalent]
+    This numbers as \enquote{(\cs{arabic}*)},
+    i.e.~\enquote{(1)},\enquote{(2)},\ldots
+
+  \item[holds]
+    This numbers as \enquote{\cs{arabic}*)}.,
+    i.e.~\enquote{1)},\enquote{2)},\ldots
+\end{description}
+\end{function}
+
+All of these are available as
+\begin{description}
+  \item[ShortLabel]
+    Specify \texttt{c}, \texttt{p}, \texttt{e} or \texttt{h}
+    as the first option to \env{enumerate}.
+
+  \item[Label Value]
+    Specify \texttt{label = circled } and similar.
+
+  \item[Key]
+
+    Just specify \texttt{circled} as an option directly and similar.
+\end{description}
+
+
+\end{documentation}
+
+\end{document}