From 2a9ad90a629502d29dd78760753dd8a660801ea0 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:44:29 +0100
Subject: [PATCH] draf of documentation of categories. not fixed

---
 doc/math/categories/.latexmkrc         |  4 ++
 doc/math/categories/Makefile           |  8 +++
 doc/math/categories/categories_doc.tex | 82 ++++++++++++++++++++++++++
 3 files changed, 94 insertions(+)
 create mode 100644 doc/math/categories/.latexmkrc
 create mode 100644 doc/math/categories/Makefile
 create mode 100644 doc/math/categories/categories_doc.tex

diff --git a/doc/math/categories/.latexmkrc b/doc/math/categories/.latexmkrc
new file mode 100644
index 0000000..4c81cd6
--- /dev/null
+++ b/doc/math/categories/.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/categories/Makefile b/doc/math/categories/Makefile
new file mode 100644
index 0000000..e174370
--- /dev/null
+++ b/doc/math/categories/Makefile
@@ -0,0 +1,8 @@
+doc:
+	latexmk
+
+full:
+	latexmk -gg
+
+clean:
+	latexmk -C
diff --git a/doc/math/categories/categories_doc.tex b/doc/math/categories/categories_doc.tex
new file mode 100644
index 0000000..2755e05
--- /dev/null
+++ b/doc/math/categories/categories_doc.tex
@@ -0,0 +1,82 @@
+\documentclass[full]{l3doc}
+
+\title{The \pkg{mkessler-categories} package}
+\author{Maximilian Keßler}
+
+\usepackage{mkessler-categories}
+
+\begin{document}
+
+
+\maketitle
+
+\begin{abstract}
+  This is a ready-to-use package providing symbols of mathematical
+  categories with automatic indexing.
+
+  It is certainly plausible that you prefer to name your categories slightly
+  differently that the author.
+\end{abstract}
+
+\begin{documentation}
+
+\section{General notice}
+
+This package is based on the \pkg{mkessler-symbindex} package.
+We thus use \pkg{imakeindex} to generate the index file.
+
+\section{Functionality}
+
+\begin{function}{\category}
+  \begin{syntax}
+    \cs{category}\marg{category}
+  \end{syntax}
+
+  Makes the given argument \meta{category} behave like a math operator
+  and prints its name in bold.
+
+  This is just to ensure a unified style for printing categories,
+  if you don't like it, redefine this macro.
+\end{function}
+
+\begin{function}{\DeclareCategory}
+  \begin{syntax}
+    \cs{DeclareCategory}\oarg{key=value list}\marg{category}
+  \end{syntax}
+
+  Has the same syntax as \cs{DeclareSymbol} from the \pkg{mkessler-symbindex} package,
+  but adds the key \texttt{group = categories}.
+\end{function}
+
+\begin{function}{\DeclareSimpleCategory}
+  \begin{syntax}
+    \cs{DeclareSimpleCategory}\oarg{key=value list}\marg{category}\oarg{description}
+  \end{syntax}
+
+  Declares a \enquote{simple} category, i.e.~the category \cs{\meta{category}}
+  is declared and will expand to \enquote{\cs{category}\marg{category}}
+  when expanded.
+
+  The optional \meta{description} is shown in the index when present.
+\end{function}
+
+\begin{function}{\MakeCategoryIndex}
+  Prints the index of categories.
+\end{function}
+
+\section{Default categories}
+
+The package also provides default categories, these are (by now):
+
+\begin{gather*}
+  \Top, \hTop, \Set, \CHaus, \Grp, \Ab, \CRing, \Ring, \Vect, \\
+  \Cat, \Mod, \Alg, \Field, \AffVar_k, \Sch, \GrAb, \OrdCat
+\end{gather*}
+  
+\end{documentation}
+
+\MakeCategoryIndex
+
+\PrintIndex
+  
+\end{document}