summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/todonotes
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-09-14 22:51:45 +0000
committerKarl Berry <karl@freefriends.org>2010-09-14 22:51:45 +0000
commit5e7679b3fae60cad87c935a8753cbc929b337f22 (patch)
tree5a78745e456e6925c1a8655862a3472970f3c196 /Master/texmf-dist/source/latex/todonotes
parentca2936971d98ba223ed79ff34e97515aced1ec13 (diff)
todonotes 0.9.3 (13sep10)
git-svn-id: svn://tug.org/texlive/trunk@19729 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/todonotes')
-rw-r--r--Master/texmf-dist/source/latex/todonotes/todonotes.dtx99
1 files changed, 88 insertions, 11 deletions
diff --git a/Master/texmf-dist/source/latex/todonotes/todonotes.dtx b/Master/texmf-dist/source/latex/todonotes/todonotes.dtx
index 12a3f268e8e..a90f2f5cca9 100644
--- a/Master/texmf-dist/source/latex/todonotes/todonotes.dtx
+++ b/Master/texmf-dist/source/latex/todonotes/todonotes.dtx
@@ -22,14 +22,14 @@
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{todonotes}
%<*package>
- [2009/12/25 .dtx Todonotes source and documentation.]
+ [2010/09/13 .dtx Todonotes source and documentation.]
%</package>
%
%<*driver>
\documentclass{ltxdoc}
\usepackage{wrapfig}
\usepackage[colorlinks, linkcolor=black]{hyperref}
-\usepackage[colorinlistoftodos, shadow]{todonotes}[2009/12/25]
+\usepackage[colorinlistoftodos, shadow]{todonotes}[2010/09/13]
\usepackage{amsmath}
\usepackage{setspace}
\setcounter{tocdepth}{2}
@@ -46,7 +46,7 @@
%</driver>
% \fi
%
-% \CheckSum{430}
+% \CheckSum{451}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -148,6 +148,11 @@
% bug reported by Oscar Gustafsson. Explained why the placement
% of todonotes in the margin fails in certain custom document classes.}
% \changes{0.8.9}{2009/12/25}{Added a dutch translation by Ruben Ruben Vermeersch.}
+% \changes{0.9.0}{2010/09/13}{Added a english option as suggested by Marco Berghoff.}
+% \changes{0.9.1}{2010/09/13}{Added the todototoc command by idea from Sven Augustin.}
+% \changes{0.9.2}{2010/09/13}{Use chapter (if available) for the list of todos heading.}
+% \changes{0.9.3}{2010/09/13}{Make an internal definition of the todo command,
+% for easing redefinition of the command behaviour.}
%
% \GetFileInfo{todonotes.dtx}
%
@@ -228,7 +233,12 @@
% current document. |\listoftodos| takes no arguments.
% For this document the list of to--do's looks like.
% \listoftodos
+% \vspace{0.5cm}
%
+% \DescribeMacro{\todototoc}
+% The |\todototoc| command adds an entry to the table of contents for
+% list of todos. The command should be placed right before the
+% |\listoftodos| command.
%
% \subsection{Package options}
% \label{subsecPackageOptions}
@@ -829,7 +839,7 @@
% % Increment counter
% \addtocounter{todoListItems}{1}
% \todo[%
-% caption={\protect\hypertarget{todo\thetodoListItems}{} Translation},
+% caption={\protect\hypertarget{todo\thetodoListItems}{}Translation},
% #1]
% {
% #2 \hfill
@@ -842,7 +852,7 @@
% \newcommand{\todoTrans}[2][ ]{
% \addtocounter{todoListItems}{1}
% \todo[
-% caption={\protect\hypertarget{todo\thetodoListItems}{} Translation},
+% caption={\protect\hypertarget{todo\thetodoListItems}{}Translation},
% #1]{
% #2 \hfill
% \hyperlink{todo\thetodoListItems}{$\uparrow$}
@@ -862,7 +872,47 @@
% \todoTrans[inline]{damplokomotiv}
%
%
+% \pagebreak[4]
+% \subsubsection{Numbered todonotes}
+%
+% The inserted todonotes can be argumented with the current subsubsection number.
+% The code is shown below.
+% \newcommand{\ntodo}[2][]{\todo[#1]{\thesubsubsection{}. #2}}
+% \begin{verbatim}
+% \newcommand{\ntodo}[2][]{\todo[#1]{\thesubsubsection{}. #2}}
+% \end{verbatim}
+% By changing |\thesubsubsection| to |\thesection|, the current section number
+% can be inserted instead of the subsubsection number.
+% The result looks \ntodo{A numbered todo.} like.
+% Which were generated by the code
+% \begin{verbatim}
+% \ntodo{A subsection numbered todo.}.
+% \end{verbatim}
+%
%
+% \subsubsection{Combining several modifications}
+%
+% \newcommand{\sstodo}[2][]
+% {\addtocounter{todoListItems}{1}
+% \todo[caption={\protect\hypertarget{todo\thetodoListItems}{}\thesection. #2}, #1]
+% {\begin{spacing}{1} \hfill \hyperlink{todo\thetodoListItems}{#2} \end{spacing} }}
+%
+% Manduca have combined several of the modifications above into a highly specialized
+% todo command.
+% \sstodo{Small notes with links back to the list of todos.}
+% He uses the code:
+% \sstodo{Smart notes with links back to the list of todos.}
+%
+% \begin{verbatim}
+% \newcounter{todoListItems}
+% \newcommand{\sstodo}[2][]
+% {\addtocounter{todoListItems}{1}
+% \todo[caption={\protect\hypertarget{todo\thetodoListItems}{}\thesection. #2}, #1]
+% {\begin{spacing}{1} \hfill \hyperlink{todo\thetodoListItems}{#2} \end{spacing} }}
+% \end{verbatim}
+%
+% Using this approach it is possible to customize the behavior of the inserted notes
+% to a very high degree.
%
%
% \iffalse
@@ -875,7 +925,7 @@
%
% Identifies the package and loads the packages dependences.
% \begin{macrocode}
-\ProvidesPackage{todonotes}[2009/04/02]
+\ProvidesPackage{todonotes}[2010/09/13]
\RequirePackage{ifthen}
\RequirePackage{xkeyval}
\RequirePackage{xcolor}
@@ -938,6 +988,12 @@
\@todonotes@SetMissingFigureUp{Ontbrekende}%
\@todonotes@SetMissingFigureDown{figuur}%
}
+\DeclareOptionX{english}{%
+ \@todonotes@SetTodoListName{Todo list}%
+ \@todonotes@SetMissingFigureText{Figure}%
+ \@todonotes@SetMissingFigureUp{Missing}%
+ \@todonotes@SetMissingFigureDown{figure}%
+}
\DeclareOptionX{french}{%
\@todonotes@SetTodoListName{Liste des points \`a traiter}%
\@todonotes@SetMissingFigureText{Figure}%
@@ -1173,7 +1229,7 @@
% \begin{macrocode}
\if@todonotes@disabled%
\newcommand{\listoftodos}[1][]{}
- \newcommand{\todo}[2][]{\ignorespaces}
+ \newcommand{\@todo}[2][]{\ignorespaces}
\newcommand{\missingfigure}[2][]{}
\else % \if@todonotes@disabled
% \end{macrocode}
@@ -1181,7 +1237,7 @@
% appearance of the list of todos.
% \begin{macrocode}
\newcommand{\listoftodos}[1][\@todonotes@todolistname]
- {\section*{#1} \@starttoc{tdo}}
+ {\ifdefined\chapter\chapter*{#1}\else\section*{#1}\fi \@starttoc{tdo}}
\newcommand{\l@todo}
{\@dottedtocline{1}{0em}{2.3em}}
% \end{macrocode}
@@ -1215,10 +1271,10 @@
text width=\linewidth - 1.6 ex - 1 pt]
% \end{macrocode}
%
-% \begin{macro}{\todo}
-% Define the todo command
+% \begin{macro}{\@todo}
+% Define the |\@todo| command
% \begin{macrocode}
-\newcommand{\todo}[2][]{%
+\newcommand{\@todo}[2][]{%
% \end{macrocode}
% Use the global value for determining the default prepend behavior.
% \begin{macrocode}
@@ -1374,6 +1430,27 @@
\fi % Ending \@todonotes@ifdisabled
% \end{macrocode}
% \end{macro}
+% \begin{macro}{\todototoc}
+% Inserts a reference to the list of todos in the table of contents. If |chapter| is defined,
+% |chapter| is used as level otherwise will |section| be used.
+% The |\todototoc| command respects the disable option.
+% \begin{macrocode}
+\newcommand{\todototoc}
+{
+ \if@todonotes@disabled
+ \else
+ \addcontentsline{toc}{\@ifundefined{chapter}{section}{chapter}}{\@todonotes@todolistname}
+ \fi
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\todo}
+% Define the |\todo| command as a redirection to |\@todo|.
+% \begin{macrocode}
+\newcommand{\todo}[2][]{\@todo[#1]{#2}}
+% \end{macrocode}
+% \end{macro}
%
% \Finale
\endinput