diff --git a/doc/math/faktor/.latexmkrc b/doc/math/faktor/.latexmkrc new file mode 100644 index 0000000..4c81cd6 --- /dev/null +++ b/doc/math/faktor/.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/faktor/Makefile b/doc/math/faktor/Makefile new file mode 100644 index 0000000..e174370 --- /dev/null +++ b/doc/math/faktor/Makefile @@ -0,0 +1,8 @@ +doc: + latexmk + +full: + latexmk -gg + +clean: + latexmk -C diff --git a/doc/math/faktor/faktor.tex b/doc/math/faktor/faktor.tex new file mode 100644 index 0000000..2c2aec5 --- /dev/null +++ b/doc/math/faktor/faktor.tex @@ -0,0 +1,59 @@ +\documentclass[full]{l3doc} + +\title{The \pkg{mkessler-faktor} package} +\author{Maximilian Keßler} + +\usepackage{mkessler-faktor} + +\begin{document} + +\maketitle + +\begin{abstract} + The \pkg{faktor} package provides a mechanism to produce fractions + for mathematical factors. + Its mechanism is, however, quite limited. + Inspired by the + \href{https://tex.stackexchange.com/}{Tex StackExchange} + answer of user + \href{https://tex.stackexchange.com/users/5764/werner}{Werner}, + that was given on + \href{https://tex.stackexchange.com/questions/27591/extending-the-faktor-package} + {https://tex.stackexchange.com/\allowbreak questions/\allowbreak 27591/extending-the-faktor-package} + we provide a simple package that wraps (and slightly modifies) + the given answer into a more general \cs{faktor} command. +\end{abstract} + +\begin{function}{\faktor} +\begin{function}{\faktor*} + \begin{syntax} + \cs{faktor}*\oarg{shift enumerator}\marg{enumerator}\oarg{shift denominator}\marg{denominator} + \end{syntax} + Produces a fraction with tilted \enquote{$\diagup$} symbol and the corresponding + \meta{enumerator} and \meta{denominator}. + The \enquote{$\diagup$} symbol is automatically scaled. + + The \meta{shift} parameters can be controlled to fine tune the vertical + placement of \meta{enumerator} and \meta{denominator}. + Their default values when not given are \texttt{0.5} and \texttt{-0.5}, + respectively. + + The \enquote{*} can be optionally given. This will make the \cs{faktor} + behave like the old \cs{faktor} command from the \cs{faktor} package, + that is, the \enquote{$\diagup$} won't scale. +\end{function} +\end{function} + +\begin{function}{\cofaktor} +\begin{function}{\cofaktor*} + \begin{syntax} + \cs{faktor}*\oarg{shift denominator}\marg{denominator}\oarg{shift enumerator}\marg{enumerator} + \end{syntax} + Behaves the same as \cs{faktor}, but produces a \cs{cofaktor}. +\end{function} +\end{function} + + +\PrintIndex + +\end{document}