document mathfig package

This commit is contained in:
Maximilian Keßler 2022-01-30 18:40:44 +01:00
parent 0d5730b11e
commit b9d4a571de
3 changed files with 82 additions and 0 deletions

View file

@ -0,0 +1,4 @@
$makeindex = "makeindex -s gind.ist %O -o %D %S";
$clean_ext .= ' glo';
$clean_ext .= ' hd';
$clean_ext .= ' ins';

View file

@ -0,0 +1,8 @@
doc:
latexmk
full:
latexmk -gg
clean:
latexmk -C

View file

@ -0,0 +1,70 @@
\documentclass[full]{l3doc}
\title{The \pkg{mkessler-mathfig} package}
\author{Maximilian Ke\ss ler}
\usepackage{mkessler-mathfig}
\begin{document}
\maketitle
\begin{abstract}
This is just some small wrapper package for drawing mathematical figures.
\end{abstract}
\begin{documentation}
\section{Loaded packages}
We load \pkg{pgfplots}, \pkg{tikz}, \pkg{tikz-cd} and \pkg{xy}.
\section{Additional macros}
\begin{function}{\pushoutsymbol}
Denotes a pushoutsymbol used in category theory diagrams.
\end{function}
\begin{function}{\pullbacksymbol}
Denotes a pullbacksymbol used in category theory diagrams.
\end{function}
\begin{function}{\pushout}
\begin{syntax}
\cs{pushout}\oarg{path to bottom right corner}
\end{syntax}
Invoked inside a \env{tikzcd} environment.
This assumes being called in the top left corner of some
commutative square and marks this square as a pushout.
The \meta{path} consists of symbols \texttt{d}, \texttt{u}, \texttt{r}
and \texttt{l}, as in \pkg{tikz-cd}.
By default, it is \texttt{dr}, being usable for default squares.
A phantom arrow is drawn in the given direction that
gets a \cs{pushoutsymbol}.
\end{function}
\begin{function}{\pullback}
\begin{syntax}
\cs{pullback}\oarg{path to bottom right corner}
\end{syntax}
Invoked inside a \env{tikzcd} environment.
This assumes being called in the top left corner of some
commutative square and marks this square as a pullback.
The \meta{path} consists of symbols \texttt{d}, \texttt{u}, \texttt{r}
and \texttt{l}, as in \pkg{tikz-cd}.
By default, it is \texttt{dr}, being usable for default squares.
A phantom arrow is drawn in the given direction that
gets a \cs{pullbacksymbol}.
\end{function}
\end{documentation}
\PrintIndex
\end{document}