From 8dd153995a118872b491d8589fa5e328793360b2 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:46:28 +0100
Subject: [PATCH] add todo documentation

---
 doc/wrappers/todo/.latexmkrc |  4 +++
 doc/wrappers/todo/Makefile   |  8 ++++++
 doc/wrappers/todo/todo.tex   | 54 ++++++++++++++++++++++++++++++++++++
 3 files changed, 66 insertions(+)
 create mode 100644 doc/wrappers/todo/.latexmkrc
 create mode 100644 doc/wrappers/todo/Makefile
 create mode 100644 doc/wrappers/todo/todo.tex

diff --git a/doc/wrappers/todo/.latexmkrc b/doc/wrappers/todo/.latexmkrc
new file mode 100644
index 0000000..4c81cd6
--- /dev/null
+++ b/doc/wrappers/todo/.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/todo/Makefile b/doc/wrappers/todo/Makefile
new file mode 100644
index 0000000..e174370
--- /dev/null
+++ b/doc/wrappers/todo/Makefile
@@ -0,0 +1,8 @@
+doc:
+	latexmk
+
+full:
+	latexmk -gg
+
+clean:
+	latexmk -C
diff --git a/doc/wrappers/todo/todo.tex b/doc/wrappers/todo/todo.tex
new file mode 100644
index 0000000..e1ea394
--- /dev/null
+++ b/doc/wrappers/todo/todo.tex
@@ -0,0 +1,54 @@
+\documentclass[full]{l3doc}
+
+\usepackage{mkessler-todo}
+
+\title{The \pkg{mkessler-todo} package}
+\author{Maximilian Ke\ss ler}
+
+\begin{document}
+
+\maketitle
+
+\begin{documentation}
+
+\begin{abstract}
+  A simple wrapper around the \pkg{todonotes} package
+  with some shortcut todos that the author uses often.
+\end{abstract}
+
+\section{Usage}
+
+We load the \pkg{todonotes} package and the \pkg{marginnote} package.
+
+By redefining \cs{marginpar} to \cs{marginnote} we ensure
+that the \cs{todo} macro will also be usable inside minipages properly.
+
+\begin{function}{\todoref}
+  Marks a missing reference.
+  Does \emph{not} require additional arguments.
+  \todoref
+\end{function}
+
+\begin{function}{\todoquestion}
+  Used for questions that arise during lectures.
+  Same syntax as \cs{todo}.
+  \todoquestion{Is this useful?}
+\end{function}
+
+\begin{function}{\todotex}
+  Used for marking tex-related todos.
+  Same syntax as \cs{todo}.
+  \todotex{Fix spacing}
+\end{function}
+
+\begin{function}{\todotypo}
+  Used for marking (possible) typos of the lecturer for later inspection.
+  Same syntax as \cs{todo}.
+  \todotypo{Was this misspelled?}
+\end{function}
+
+
+
+\end{documentation}
+
+\end{document}