55 lines
1.2 KiB
TeX
55 lines
1.2 KiB
TeX
|
\documentclass[full]{l3doc}
|
||
|
|
|
||
|
|
\usepackage{mkessler-todo}
|
||
|
|
|
||
|
|
\title{The \pkg{mkessler-todo} package}
|
||
|
|
\author{Maximilian Ke\ss ler}
|
||
|
|
|
||
|
|
\begin{document}
|
||
|
|
|
||
|
|
\maketitle
|
||
|
|
|
||
|
|
\begin{documentation}
|
||
|
|
|
||
|
|
\begin{abstract}
|
||
|
|
A simple wrapper around the \pkg{todonotes} package
|
||
|
|
with some shortcut todos that the author uses often.
|
||
|
|
\end{abstract}
|
||
|
|
|
||
|
|
\section{Usage}
|
||
|
|
|
||
|
|
We load the \pkg{todonotes} package and the \pkg{marginnote} package.
|
||
|
|
|
||
|
|
By redefining \cs{marginpar} to \cs{marginnote} we ensure
|
||
|
|
that the \cs{todo} macro will also be usable inside minipages properly.
|
||
|
|
|
||
|
|
\begin{function}{\todoref}
|
||
|
|
Marks a missing reference.
|
||
|
|
Does \emph{not} require additional arguments.
|
||
|
|
\todoref
|
||
|
|
\end{function}
|
||
|
|
|
||
|
|
\begin{function}{\todoquestion}
|
||
|
|
Used for questions that arise during lectures.
|
||
|
|
Same syntax as \cs{todo}.
|
||
|
|
\todoquestion{Is this useful?}
|
||
|
|
\end{function}
|
||
|
|
|
||
|
|
\begin{function}{\todotex}
|
||
|
|
Used for marking tex-related todos.
|
||
|
|
Same syntax as \cs{todo}.
|
||
|
|
\todotex{Fix spacing}
|
||
|
|
\end{function}
|
||
|
|
|
||
|
|
\begin{function}{\todotypo}
|
||
|
|
Used for marking (possible) typos of the lecturer for later inspection.
|
||
|
|
Same syntax as \cs{todo}.
|
||
|
|
\todotypo{Was this misspelled?}
|
||
|
|
\end{function}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
\end{documentation}
|
||
|
|
|
||
|
|
\end{document}
|