From f4e1f01f3941c421dbf56e5d689afe39e07e642b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Sun, 30 Jan 2022 18:07:51 +0100 Subject: [PATCH] add documentation --- .../{categories_doc.tex => categories.tex} | 57 +++++++++++++++---- 1 file changed, 47 insertions(+), 10 deletions(-) rename doc/math/categories/{categories_doc.tex => categories.tex} (59%) diff --git a/doc/math/categories/categories_doc.tex b/doc/math/categories/categories.tex similarity index 59% rename from doc/math/categories/categories_doc.tex rename to doc/math/categories/categories.tex index 2755e05..3d30685 100644 --- a/doc/math/categories/categories_doc.tex +++ b/doc/math/categories/categories.tex @@ -1,12 +1,17 @@ \documentclass[full]{l3doc} \title{The \pkg{mkessler-categories} package} -\author{Maximilian Keßler} +\author{Maximilian Ke\ss ler} \usepackage{mkessler-categories} -\begin{document} +\NewDocumentCommand{\ShowCategory}{m} +{ + \cs{#1} & $\csname #1\endcsname$ \\ +} + +\begin{document} \maketitle @@ -64,19 +69,51 @@ We thus use \pkg{imakeindex} to generate the index file. Prints the index of categories. \end{function} +\section{Language integration} + +This package uses \pkg{translator} to translate the package descriptions. +Currently, only English and German are supported. + \section{Default categories} -The package also provides default categories, these are (by now): +The package also provides default categories. +These are shown in \autoref{tab:provided-categories}. + +You can view their appearance in the index and their descriptions in the +index of this documentation. +Unfortunately, the index is not (yet) compatible with the \texttt{l3doc} class +which is used for this documentation, so ignore everything before the +\enquote{@} characters. + +\begin{table}[htpb] + \centering + \begin{tabular}{c | c} + Macro & Result \\ + \hline + \ShowCategory{Top} + \ShowCategory{hTop} + \ShowCategory{Set} + \ShowCategory{CHaus} + \ShowCategory{Grp} + \ShowCategory{Ab} + \ShowCategory{CRing} + \ShowCategory{Ring} + \ShowCategory{Vect} + \ShowCategory{Cat} + \ShowCategory{Mod} + \ShowCategory{Alg} + \ShowCategory{Field} + \ShowCategory{AffVar} + \ShowCategory{Sch} + \ShowCategory{GrAb} + \ShowCategory{OrdCat} + \end{tabular} + \caption{caption} + \label{tab:provided-categories} +\end{table} -\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}