summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/easy-todo/easy-todo.tex
blob: dfeddbacffb0bdc7f5965888032bd7a705791ccd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
\documentclass[a4paper]{article}
\usepackage{listings}
\usepackage[enabled,section]{easy-todo}

\begin{document}
	\title{The \texttt{easy-todo} package}
	\author{Juan Rada-Vilela}
	\date{November, 2013}
	
	\maketitle
	
	\begin{abstract}
		The \texttt{easy-todo} package allows to create TODO notes in a document and show the list of TODOs as an index with references. 
	\end{abstract}
	
	\section{Options}
	When including the package, the following options are available:
	
	\begin{description}
		\item [enabled] Shows the TODO notes as well as the index.
        \item [enable] Same as before.
		\item [disabled] Hides the TODO notes as well as the index. Useful for printing drafts without the TODO notes, but keeping them in the document.
        \item [disable] Same as before.
		\item [final] Same as disabled.
		\item [chapter] Prints the list of TODOs as a chapter.
		\item [section] Prints the list of TODOs as a section.
	\end{description}
	
	For example:
\lstset{language=TeX}
\begin{lstlisting}
\usepackage[enabled,section]{easy-todo}
\end{lstlisting}

	\section{Commands}
	\begin{description}
		\item [\textbackslash todo\{note\}] Creates a note with text ``\texttt{note}''.
        \item [\textbackslash todoi\{note-i\}] Creates an empty note with information ``\texttt{note-i}'' appearing only at the index.
        \item [\textbackslash todoii\{note-ii\}\{information\}] Creates a note with ``\texttt{note-ii}'' inplace and ``\texttt{information}'' at the index.
		\item [\textbackslash listoftodos] Creates the list of TODOs.
	\end{description}
    
    \section{Changelog}
        \begin{itemize}
            \item Added options \textbf{enable} and \textbf{disable}
            \item Added commands \textbf{todoi}, \textbf{todoii}
        \end{itemize}
	
	This is a todo \todo{note} that appears in full everywhere. This is a todoi \todoi{note i}  that appears as a number and the note at the index. This is a todoii \todoii{hint}{information} note that shows a hint at the place and the information at the index.
	
		\listoftodos
\end{document}