Add class-option to control todos

Closes #27Signed-off-by: Adrian C. Hinrichs <adrian.hinrichs@rwth-aachen.de>

homeworkassignment/homeworkassignment.cls

@@ -69,10 +69,11 @@
 \DeclareBoolOption[false]{listings}
 \DeclareBoolOption[true]{twoside}
 \DeclareComplementaryOption{oneside}{twoside}
-\DeclareBoolOption[true]{twocolumn}
+\DeclareBoolOption[false]{twocolumn}
 \DeclareComplementaryOption{onecolumn}{twocolumn}
 \DeclareBoolOption[false]{punchmark}
 \DeclareStringOption[all]{hlines}
+\DeclareStringOption[all]{todos}
 \ifxetex
 \DeclareBoolOption[true]{unicodemath}
 \else
@@ -91,6 +92,28 @@
 \fi
 \LoadClass{article}
 
+\newboolean{hwa@todos@inplace}
+\newboolean{hwa@todos@list}
+\setboolean{hwa@todos@inplace}{true}
+\setboolean{hwa@todos@list}{true}
+\ifthenelse{\equal{\hwa@todos}{all}}{
+}{
+  \ifthenelse{\equal{\hwa@todos}{nolist}}{
+      \ClassWarning{homeworkassignment}{You specified todos=none,
+        there will be no list of TODO}
+      \setboolean{hwa@todos@list}{false}
+  }{
+    \ifthenelse{\equal{\hwa@todos}{none}}{
+      \ClassWarning{homeworkassignment}{You specified todos=none,
+        there will be no TODOs printed in the final document}
+      \setboolean{hwa@todos@list}{false}
+      \setboolean{hwa@todos@inplace}{false}
+    }{
+      \ClassError{homeworkassignment}{\hwa@todos is not a valid value
+        for the option `todos`}
+    }
+  }
+}
 \RequirePackage{hyperref}
 \ifhwa@listings
 \RequirePackage{listings}
@@ -395,14 +418,17 @@
 \newcommand{\bigforall}{\mbox{\raisebox{-2pt}[\height][\depth]{\Large $\mathsurround4pt\forall$}}}
 \newcommand{\bigexists}{\mbox{\raisebox{-2pt}[\height][\depth]{\Large $\mathsurround4pt\exists$}}}
 \DeclareDocumentCommand\todo{G{}}{
+  \ifthenelse{\boolean{hwa@todos@inplace}}{
     {\color{red}\textbf{~\label{TODO\alph{todoNum}}TODO~}#1~}
     \xdef\hwa@todoList@aux{\hwa@todoList@aux
       \string\item\string\hyperref[TODO\alph{todoNum}]{TODO #1}
     }
     \stepcounter{todoNum}
+  }{}
 }
 \newcounter{todoNum} \setcounter{todoNum}{1}
 \DeclareDocumentCommand\hwa@tableOfTodos{}{
+  \ifthenelse{\boolean{hwa@todos@list}}{
     \ifthenelse{\equal{\hwa@tableOfTodos}{}}{%Nothing
     }{
       {\color{red}
@@ -411,6 +437,7 @@
           \hwa@todoList
         \end{itemize}}
     }
+  }{}
 }
 \DeclareDocumentCommand\addToGradingTable{m g}{
   \edef\hwa@gradingtbl@aux@defs{\hwa@gradingtbl@aux@defs|p{\hwa@pointboxsize}}

homeworkassignment/homeworkassignment.dtx

@@ -267,6 +267,13 @@
 %    \begin{macrocode}
 \DeclareStringOption[all]{hlines}
 %    \end{macrocode}
+% \DescribeMacro{todos=<1>}
+% KeyValue-option. Takes which ToDos shall be displayed.  Available are
+% \texttt{all} (default),\texttt{nolist},\texttt{none}.  See
+% \autoref{cmd:TODOs} for explanation of the levels.
+%    \begin{macrocode}
+\DeclareStringOption[all]{todos}
+%    \end{macrocode}
 % \DescribeMacro{unicode-math} Loads the unicode--math--package and
 % overwrites the damn \texttt{\textbackslash QED}--Command unicode--math
 % introduces, that creates a filled out box and only works in
@@ -312,6 +319,28 @@
 \fi
 \LoadClass{article}
 
+\newboolean{hwa@todos@inplace}
+\newboolean{hwa@todos@list}
+\setboolean{hwa@todos@inplace}{true}
+\setboolean{hwa@todos@list}{true}
+\ifthenelse{\equal{\hwa@todos}{all}}{
+}{
+  \ifthenelse{\equal{\hwa@todos}{nolist}}{
+      \ClassWarning{homeworkassignment}{You specified todos=none,
+        there will be no list of TODO}
+      \setboolean{hwa@todos@list}{false}
+  }{
+    \ifthenelse{\equal{\hwa@todos}{none}}{
+      \ClassWarning{homeworkassignment}{You specified todos=none,
+        there will be no TODOs printed in the final document}
+      \setboolean{hwa@todos@list}{false}
+      \setboolean{hwa@todos@inplace}{false}
+    }{
+      \ClassError{homeworkassignment}{\hwa@todos is not a valid value
+        for the option `todos`}
+    }
+  }
+}
 %    \end{macrocode}
 % Load Hyperref (breaks if it is loaded before article
 %    \begin{macrocode}
@@ -949,7 +978,7 @@
 \newcommand{\bigexists}{\mbox{\raisebox{-2pt}[\height][\depth]{\Large $\mathsurround4pt\exists$}}}
 %    \end{macrocode}
 % \end{macro}
-% \subsubsection{ToDos}
+% \subsubsection{ToDos\label{cmd:TODOs}}
 % Utility for the Documentation of ToDos
 % \begin{macro}{\todo}
 % Creates a todo at the location of the command, highlighted in red.
@@ -957,11 +986,13 @@
 % |todos=nolist| or |todos=none| is specified.
 %    \begin{macrocode}
 \DeclareDocumentCommand\todo{G{}}{
+  \ifthenelse{\boolean{hwa@todos@inplace}}{
     {\color{red}\textbf{~\label{TODO\alph{todoNum}}TODO~}#1~}
     \xdef\hwa@todoList@aux{\hwa@todoList@aux
       \string\item\string\hyperref[TODO\alph{todoNum}]{TODO #1}
     }
     \stepcounter{todoNum}
+  }{}
 }
 %    \end{macrocode}
 % Uses the internal |hwa@todo|-counter
@@ -973,6 +1004,7 @@
 %   Prints all ToDos
 %    \begin{macrocode}
 \DeclareDocumentCommand\hwa@tableOfTodos{}{
+  \ifthenelse{\boolean{hwa@todos@list}}{
     \ifthenelse{\equal{\hwa@tableOfTodos}{}}{%Nothing
     }{
       {\color{red}
@@ -981,6 +1013,7 @@
           \hwa@todoList
         \end{itemize}}
     }
+  }{}
 }
 %    \end{macrocode}
 % \end{macro}