document mathsymb package

This commit is contained in:
Maximilian Keßler 2022-01-30 17:16:28 +01:00
parent aef9318118
commit 3e416a68ae
3 changed files with 88 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,76 @@
\documentclass[full]{l3doc}
\title{The \pkg{mkessler-mathsymb} package}
\author{Maximilian Keßler}
\usepackage{mkessler-mathsymb}
\begin{document}
\maketitle
\begin{abstract}
Provides some selected symbols related to mathematics.
This is certainly a very specific, non-generic package,
heavily based on the authors use-cases.
Feel free to use this as well if you like the symbols.
\end{abstract}
\begin{documentation}
\begin{function}{\noloc}
An inverse \cs{colon} with the correct spacing.
The implementation is by user
\href{https://tex.stackexchange.com/users/4427/egreg}
on
\href{https://tex.stackexchange.com/}{Tex StackExchange}
question
\href{https://tex.stackexchange.com/questions/546713/spacing-in-colon}
{https://\allowbreak tex\allowbreak .stack\allowbreak exchange\allowbreak .com/\allowbreak questions/546713/spacing-in-colon}
\end{function}
\begin{function}{\contra}
Prints a contradiction symbol
\end{function}
\begin{function}{\Warning}
Prints a warning symbol
\end{function}
\begin{function}{\circled}
\begin{syntax}
\cs{circled}\marg{stuff}
\end{syntax}
Dynamically circles the \meta{stuff}.
The circle is adjusted in size.
\end{function}
\begin{function}{\chainbullet}
Synonym for \cs{bullet}.
Only existent for semantic reasons.
\end{function}
\begin{table}[htpb]
\centering
\caption{Symbol table}
\label{tab:symbols}
\begin{tabular}{c | c}
Macro & Result \\
\texttt{Y \cs{leftarrow} X \cs{noloc} f} & $Y \leftarrow X \noloc f$ \\
\cs{contra} & \contra \\
\cs{Warning} & \Warning \\
\cs{circled}\{1\} & \circled{1} \\
\cs{chainbullet} & $\chainbullet$
\end{tabular}
\end{table}
\end{documentation}
\PrintIndex
\end{document}