add documentation

This commit is contained in:
Maximilian Keßler 2022-01-30 18:07:51 +01:00
parent 97eb9f034c
commit f4e1f01f39

View File

@ -1,12 +1,17 @@
\documentclass[full]{l3doc} \documentclass[full]{l3doc}
\title{The \pkg{mkessler-categories} package} \title{The \pkg{mkessler-categories} package}
\author{Maximilian Keßler} \author{Maximilian Ke\ss ler}
\usepackage{mkessler-categories} \usepackage{mkessler-categories}
\begin{document}
\NewDocumentCommand{\ShowCategory}{m}
{
\cs{#1} & $\csname #1\endcsname$ \\
}
\begin{document}
\maketitle \maketitle
@ -64,19 +69,51 @@ We thus use \pkg{imakeindex} to generate the index file.
Prints the index of categories. Prints the index of categories.
\end{function} \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} \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}.
\begin{gather*} You can view their appearance in the index and their descriptions in the
\Top, \hTop, \Set, \CHaus, \Grp, \Ab, \CRing, \Ring, \Vect, \\ index of this documentation.
\Cat, \Mod, \Alg, \Field, \AffVar_k, \Sch, \GrAb, \OrdCat Unfortunately, the index is not (yet) compatible with the \texttt{l3doc} class
\end{gather*} 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}
\end{documentation} \end{documentation}
\MakeCategoryIndex
\PrintIndex \PrintIndex
\end{document} \end{document}