summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/todonotes
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-07-14 22:39:42 +0000
committerKarl Berry <karl@freefriends.org>2014-07-14 22:39:42 +0000
commitf8522389318f96d3e2a98ffb9dbc44d8821d0f90 (patch)
tree045ad9e4a6f6f95e12cd70ef2a26bcf4a2ed5132 /Master/texmf-dist/source/latex/todonotes
parent91e62921c8f6d17fb3a1b701c0b5f99cfeadd408 (diff)
todonotes (14jul14)
git-svn-id: svn://tug.org/texlive/trunk@34606 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/todonotes')
-rw-r--r--Master/texmf-dist/source/latex/todonotes/todonotes.dtx71
1 files changed, 62 insertions, 9 deletions
diff --git a/Master/texmf-dist/source/latex/todonotes/todonotes.dtx b/Master/texmf-dist/source/latex/todonotes/todonotes.dtx
index 182369d8727..c0d3f152051 100644
--- a/Master/texmf-dist/source/latex/todonotes/todonotes.dtx
+++ b/Master/texmf-dist/source/latex/todonotes/todonotes.dtx
@@ -28,10 +28,11 @@
%<*driver>
\documentclass{ltxdoc}
\usepackage{wrapfig}
-\usepackage[colorlinks, linkcolor=black]{hyperref}
+\usepackage[colorlinks, linkcolor=black, urlcolor=blue]{hyperref}
\usepackage[colorinlistoftodos, shadow]{todonotes}[2012/07/25]
\usepackage{amsmath}
\usepackage{setspace}
+\usepackage{soul}
\setcounter{tocdepth}{2}
\EnableCrossrefs
\CodelineIndex
@@ -46,7 +47,7 @@
%</driver>
% \fi
%
-% \CheckSum{570}
+% \CheckSum{577}
%
% \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
@@ -172,6 +173,11 @@
% \changes{1.0.1}{2012/11/24}{Fix spacing issues reported by Jonathan Zachhuber and
% Brent Longborough.
% Added figheight option to the missingfigure command as suggested by Kim Albertsson.}
+% \changes{1.0.2}{2014/07/14}{Added Swedish translation by Emil Lundberg.
+% Added usecase by Tobias Winchen.
+% Mentioned that default arguments can be set using the presetkeys command.
+% Updated list of alternatives to the todonotes package.
+% Draw borders around coloured boxes in the list of todos, patch by Ze Loff.}
% \GetFileInfo{todonotes.dtx}
%
% \DoNotIndex{\newcommand,\newenvironment}
@@ -210,9 +216,20 @@
%
% Some alternatives for the todonotes package are:
% \begin{itemize}
-% \item \href{http://www.ctan.org/tex-archive/macros/latex/contrib/easy-todo}{easy-todo}
-% \item \href{http://www.ctan.org/tex-archive/macros/latex/contrib/fixme}{fixme}
+% \item \href{http://www.ctan.org/tex-archive/macros/latex/contrib/easy-todo}{easy-todo}\\
+% Depends on |color|, |tocloft| and |ifthen|, small feature set.
+% \item \href{http://www.ctan.org/pkg/fixmetodonotes}{fixmetodonotes}\\
+% Depends on |graphicx|, |color|, |transparent|, |watermark|,|fix-cm|, |ulem| and |tocloft|, small feature set.
+% \item \href{http://www.ctan.org/tex-archive/macros/latex/contrib/todo}{todo}\\
+% Depends on |amssymb|, medium feature set.
+% \item \href{http://www.ctan.org/tex-archive/macros/latex/contrib/fixme}{fixme}\\
+% Large package with a lot of features.
% \end{itemize}
+% The main reason for considering other packages is that the todonotes
+% package is quire large and relies heavily on tikz.
+% This can slow down compilation of large documents significantly.
+% The mentioned alternatives have a different feature set and does not
+% rely on tikz, which makes them require less ressoureces.
%
%
% \subsection{Usage}
@@ -281,7 +298,7 @@
% The option |obeyFinal| does something similar, except that the
% todonotes package is only disabled if the |final| option given.
%
-% \DescribeMacro{danish, german, ngerman, french}
+% \DescribeMacro{danish, german, ngerman, french, swedish}
% \DescribeMacro{spanish, catalan, italian}
% \DescribeMacro{portuguese, dutch}
% Use translations of the text strings
@@ -296,8 +313,9 @@
% german,
% ngerman,
% italian,
-% portuguese and
-% spanish.
+% portuguese,
+% spanish and
+% swedish.
%
% \DescribeMacro{colorinlistoftodos}
% Adds a small colored square in front of all items in the Todo
@@ -365,6 +383,11 @@
% There are several options that can be given to the |\todo|
% command. All the options are described here and often I have
% included examples of the change in visual appearance.
+% Default values for these options can be set using the presetkeys
+% command.
+% \begin{verbatim}
+% \presetkeys{todonotes}{fancyline, color=blue!30}{}
+% \end{verbatim}
%
% \DescribeMacro{disable}
% The |disable| option can be given directly to the todo command.
@@ -585,6 +608,14 @@
%\usepackage{menukeys}
% \end{verbatim}
%
+% \subsubsection{Spacing around inserted notes}
+% Inserted todo commands will eat the white space after the command.
+% \begin{verbatim}
+%Testing\todo{Does this eat the space?} testing
+% \end{verbatim}
+%
+% Testing\todo{Does this eat the space?}testing
+%
% \subsubsection{Wrapping of long lines in list of todos}
% When a document is compiled with latex (and not pdflatex) long
% items in the list of todos are not wrapped into several lines, and
@@ -1027,7 +1058,7 @@
% 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:
+% She uses the code:
% \sstodo{Smart notes with links back to the list of todos.}
%
% \begin{verbatim}
@@ -1068,6 +1099,21 @@
% \newcommand{\ruggedtodo}[2][]{\tikzexternaldisable\todo[#1]{#2}\tikzexternalenable}
% \end{verbatim}
%
+%
+% \subsubsection{Highligt text to fix}
+% Tobias Winchen provides the following example on how to highlight
+% text related to the inserted todonote.
+% \newcommand{\hlfix}[2]{\texthl{#1}\todo{#2}}
+% Example \hlfix{wrong text}{fix text}~continues here.
+% Notice that the code relies on the \verb!soul! package.
+% \begin{verbatim}
+% \newcommand{\hlfix}[2]{\texthl{#1}\todo{#2}}
+% Example \hlfix{wrong text}{fix text}~continues here.
+% \end{verbatim}
+%
+%
+%
+%
%
% \iffalse
% \StopEventually{\PrintChanges\PrintIndex}
@@ -1187,6 +1233,12 @@
\@todonotes@SetMissingFigureUp{Figura}%
\@todonotes@SetMissingFigureDown{pendiente}%
}
+\DeclareOptionX{swedish}{%
+ \@todonotes@SetTodoListName{Att g\"{o}ra-lista}%
+ \@todonotes@SetMissingFigureText{Figur}%
+ \@todonotes@SetMissingFigureUp{Figur}%
+ \@todonotes@SetMissingFigureDown{saknas}%
+}
% \end{macrocode}
% Create a counter, for storing the number of inserted todos.
% \begin{macrocode}
@@ -1568,7 +1620,8 @@
\newcommand{\@todonotes@addElementToListOfTodos}{%
\if@todonotes@colorinlistoftodos%
\addcontentsline{tdo}{todo}{%
- \colorbox{\@todonotes@currentbackgroundcolor}%
+ \fcolorbox{\@todonotes@currentbordercolor}%
+ {\@todonotes@currentbackgroundcolor}%
{\textcolor{\@todonotes@currentbackgroundcolor}{o}}%
\ \@todonotes@caption}%
\else%