diff options
author | Karl Berry <karl@freefriends.org> | 2009-02-05 01:03:47 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-02-05 01:03:47 +0000 |
commit | 4041df693bc0b66ecdf77e891e5ff1a60f1497fc (patch) | |
tree | 8da6e887021ad342c9f907cfedb671a7597ccd54 /Master/texmf-dist/source | |
parent | 490c97f400f9eb79dd939d02357dd0dd0c70600b (diff) |
todonotes update (4feb09)
git-svn-id: svn://tug.org/texlive/trunk@12086 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source')
-rw-r--r-- | Master/texmf-dist/source/latex/todonotes/todonotes.dtx | 161 |
1 files changed, 134 insertions, 27 deletions
diff --git a/Master/texmf-dist/source/latex/todonotes/todonotes.dtx b/Master/texmf-dist/source/latex/todonotes/todonotes.dtx index c0137594767..3ab1952f8f1 100644 --- a/Master/texmf-dist/source/latex/todonotes/todonotes.dtx +++ b/Master/texmf-dist/source/latex/todonotes/todonotes.dtx @@ -30,7 +30,9 @@ \usepackage{wrapfig} \usepackage[colorlinks, linkcolor=black]{hyperref} \usepackage[colorinlistoftodos, shadow]{todonotes}[2009/01/09] +\usepackage{amsmath} \usepackage{setspace} +\setcounter{tocdepth}{2} \EnableCrossrefs \CodelineIndex \RecordChanges @@ -44,7 +46,7 @@ %</driver> % \fi % -% \CheckSum{386} +% \CheckSum{398} % % \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 @@ -123,8 +125,15 @@ % textstring ''Figure'' in the source. Added a figwidth % option to the missingfigure command, patch by Paul % Ivanov.} +% \changes{0.8.1}{2009/01/12}{Added a space between the colored +% square and the text in the list of todos. Added a new +% usecase for marking old / new sections. Made the name +% of listoftodos changeable.} +% \changes{0.8.2}{2009/02/04}{Italian translation by Gustavo +% Cevolani. Removed the dependence on the hyperref +% package.} % -% \GetFileInfo{todonotes.dtx} +% \GetFileInfo{todonotes.dtx} % % \DoNotIndex{\newcommand,\newenvironment} % @@ -166,7 +175,7 @@ % % \DescribeMacro{\todo} % My \index{\todo}most common usage of the todonotes package, is to -% insert an uncustomized todonotes somewhere in a latex document. +% insert an todonotes somewhere in a latex document. % An example of this usage is the command % % |\todo{Make a cake \ldots}|, @@ -214,7 +223,7 @@ % all inserted notes are removed. % % \DescribeMacro{danish, german, french} -% \DescribeMacro{spanish, catalan} +% \DescribeMacro{spanish, catalan, italian} % Use the danish or german translations of the text strings % ''List of todos'' and ''Missing figure''. % The default is to use none of these options, which results in @@ -224,7 +233,7 @@ % Adds a small colored square in front of all items in the Todo % list. The color of the square is the same as the fill color of the % inserted todonote. -% This can be usefull if there are different types of todos +% This can be useful if there are different types of todos % (insert reference, explain in detail, \ldots) where the color of % the inserted todonote marks the type of todo. % @@ -251,7 +260,7 @@ % \DescribeMacro{textsize} % |textsize=value| sets the default text size of the inserted % todonotes to the given value. -% Value is the ''name'' of the used fontsize, eg. if the desired +% Value is the ''name'' of the used font size, eg. if the desired % fontsize is |\tiny| use |textsize=tiny|. The default value is % |textsize=normalsize|. % @@ -325,7 +334,7 @@ % % \DescribeMacro{inline / noinline} % It is possible to place a todonote inside the text instead of -% placing it in the margin, this could be desireable if the text in +% placing it in the margin, this could be desirable if the text in % the note has a considerable length. % |\todo[inline]{A todonote placed in the text}| % \todo[inline]{A todonote placed in the text} @@ -357,11 +366,11 @@ % \DescribeMacro{size} % |size=val| changes the size of the text inside the todonote. % The commands used to create the notes below are \\ \noindent -% |\todo[size=\Large]{A note with a large fontsize.}| +% |\todo[size=\Large]{A note with a large font size.}| % and \\ \noindent -% |\todo[inline, size=\tiny]{Note with very small fontsize.}|. -% \todo[size=\Large]{A note with a large fontsize.} -% \todo[inline, size=\footnotesize]{Note with very small fontsize.} +% |\todo[inline, size=\tiny]{Note with very small font size.}|. +% \todo[size=\Large]{A note with a large font size.} +% \todo[inline, size=\footnotesize]{Note with very small font size.} % % \DescribeMacro{list / nolist} % When the option |nolist| is given, the todo item will not appear in @@ -403,6 +412,8 @@ % inserted by the |\missingfigure| command. % The default value is |\textwidth|. % +% +% % \subsection{Options for the missingfigure command} % % \DescribeMacro{figwidth} @@ -431,9 +442,17 @@ % \end{wrapfigure} % \end{verbatim} % +% +% % \subsection{Options for the listoftodos command} -% Currently the listoftodos command takes no optional arguments. +% The |\listoftodos| command takes one optional argument, that +% defines the name of the inserted list of todos. +% \begin{verbatim} +% \listoftodos[I can be called anything] +% \end{verbatim} % +% +% % \subsection{Known issues} % \subsubsection{Package loading order} % The todonotes package requires the following packages. @@ -441,7 +460,6 @@ % \begin{itemize} % \item ifthen % \item xkeyval -% \item hyperref % \item xcolor % \item tikz % \item calc @@ -457,15 +475,43 @@ % package, otherwise you will get an ''Option clash'' error when % latex works on the document. % +% % \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 % do instead continue to the right out of the page. +% +% +% \subsubsection{Conflicts with the amsart documentclass} +% The |amsart| document class redefines some internal commands that +% is used by the todonotes package, this will cause an malfunctioning +% |\listoftodos| command. +% The following code to circumvent the problem was given by Dan +% Luecking on comp.text.tex +% \begin{verbatim} +% \makeatletter +% \providecommand\@dotsep{5} +% \makeatother +% \listoftodos\relax +% \end{verbatim} % % +% \subsubsection{Unknown option ''remember picture''} +% If latex throws the error +% \begin{verbatim} +% Package tikz Error: I do not know what to do with the option ``remember picture''. +% \end{verbatim} +% It probably means that your latex installation is outdated, as +% only newer versions of latex driver for tikz supports the +% |remember picture| option. +% For additional info consult +% ''Section 9.2.2 Producing PDF Output'' in the tikz manual. +% \url{http://www.ctan.org/tex-archive/graphics/pgf/base/doc/generic/pgf/pgfmanual.pdf} +% +% % \subsection{Things to improve} % This is a list of things I consider to improve sometime in the -% future. I havent been done yet as I lack the time or skills to +% future. It have not been done yet as I lack the time or skills to % implement them. % Patches with implementations of these tasks will be appreciated % and might be included in the package if it will improve the @@ -534,7 +580,7 @@ % % Thomas Arildsen has mailed me this use case. Check the % documentation for the |fixme| package, as the code below relies -% directly on it (the |\FDUser| command is augumented when +% directly on it (the |\FDUser| command is augmented when % |\begin{document}| is reached). % \begin{verbatim} % \usepackage[user,nomargin]{fixme} @@ -544,7 +590,7 @@ % % % -% \subsubsection{Altering the linespacing of todonotes} +% \subsubsection{Altering the line spacing of todonotes} % % The |setspace| package lets you alter the line spacing of smaller % sections of your document. The primary construct is the @@ -590,9 +636,9 @@ % % \subsubsection{Comments ''a la Word''} % -% Fabrice Niessen sent me the following usecase. +% Fabrice Niessen sent me the following use case. % The idea is to define a new command |\mycomment| which adds a -% counter and optionally the initials of the auther to the inserted +% counter and optionally the initials of the author to the inserted % todonote. % % \begin{verbatim} @@ -622,12 +668,57 @@ % \mycomment[HSM]{Testing second time.}% % % +% \subsubsection{Marking new / old sections} +% Sometimes a whole section has to be marked by some means. You +% might want to try the following. +% \begin{verbatim} +% \todo[inline, caption={Some text}]{ +% \begin{minipage}{\linewidth} +% Some text that might differ from the text given to the caption +% option. +% \end{minipage} +% } +% \end{verbatim} +% It is important to add the |caption={text}| option, otherwise +% latex will try to embed a minipage in the table of contents which +% triggers an error. +% Inside the minipage environment almost anything could be placed, +% except for other todo commands. +% \begin{verbatim} +% \todo[inline, caption={Examine this new section}]{ +% \begin{minipage}{\linewidth} +% Some text. +% \begin{align} +% \sin(\theta)^2 + \cos(\theta)^2 = 1 +% \end{align} +% A formula and a list +% \begin{itemize} +% \item An item +% \end{itemize} +% \end{minipage} +% } +% \end{verbatim} +% The example above renders like +% \todo[inline, caption={Examine this new section}]{ +% \begin{minipage}{\linewidth} +% Some text. +% \begin{align} +% \sin(\theta)^2 + \cos(\theta)^2 = 1 +% \end{align} +% A formula and a list +% \begin{itemize} +% \item An item +% \end{itemize} +% \end{minipage} +% } +% % % \iffalse % \StopEventually{\PrintChanges\PrintIndex} % \fi % \StopEventually{\PrintChanges} % +% \newpage % \section{Implementation} % % Identifies the package and loads the packages dependences. @@ -635,7 +726,6 @@ \ProvidesPackage{todonotes}[2009/01/09] \RequirePackage{ifthen} \RequirePackage{xkeyval} -\RequirePackage{hyperref} \RequirePackage{xcolor} \RequirePackage{tikz} \RequirePackage{calc} @@ -650,6 +740,13 @@ \newcommand{\@todonotes@textsize}{\normalsize} \newcommand{\@todonotes@figwidth}{\textwidth} % \end{macrocode} +% \begin{macrocode} +\AtBeginDocument{ +\ifx\undefined\phantomsection +\newcommand{\phantomsection}{} +\fi +} +% \end{macrocode} % % \subsection{Declaration of options for the package} % In this part the various options for @@ -662,10 +759,14 @@ \newcommand{\@todonotes@MissingFigureText}{Figure} \newcommand{\@todonotes@MissingFigureUp}{Missing} \newcommand{\@todonotes@MissingFigureDown}{figure} -\newcommand{\@todonotes@SetTodoListName}[1]{\renewcommand{\@todonotes@todolistname}{#1}} -\newcommand{\@todonotes@SetMissingFigureText}[1]{\renewcommand{\@todonotes@MissingFigureText}{#1}} -\newcommand{\@todonotes@SetMissingFigureUp}[1]{\renewcommand{\@todonotes@MissingFigureUp}{#1}} -\newcommand{\@todonotes@SetMissingFigureDown}[1]{\renewcommand{\@todonotes@MissingFigureDown}{#1}} +\newcommand{\@todonotes@SetTodoListName}[1] + {\renewcommand{\@todonotes@todolistname}{#1}} +\newcommand{\@todonotes@SetMissingFigureText}[1] + {\renewcommand{\@todonotes@MissingFigureText}{#1}} +\newcommand{\@todonotes@SetMissingFigureUp}[1] + {\renewcommand{\@todonotes@MissingFigureUp}{#1}} +\newcommand{\@todonotes@SetMissingFigureDown}[1] + {\renewcommand{\@todonotes@MissingFigureDown}{#1}} \newif{\if@todonotes@reverseMissingFigureTriangle} \DeclareOptionX{danish}{% \@todonotes@SetTodoListName{G\o{}rem\aa{}lsliste}% @@ -698,6 +799,12 @@ \@todonotes@SetMissingFigureUp{Figura}% \@todonotes@SetMissingFigureDown{pendient}% } +\DeclareOptionX{italian}{ + \@todonotes@SetTodoListName{Elenco delle cose da fare}% + \@todonotes@SetMissingFigureText{Figura}% + \@todonotes@SetMissingFigureUp{Figura}% + \@todonotes@SetMissingFigureDown{mancante}% +} % \end{macrocode} % Create a counter, for storing the number of inserted todos. % \begin{macrocode} @@ -874,7 +981,7 @@ % define empty commands. % \begin{macrocode} \if@todonotes@disabled% - \newcommand{\listoftodos}{} + \newcommand{\listoftodos}[1][]{} \newcommand{\todo}[2][]{\ignorespaces} \newcommand{\missingfigure}[2]{} \else % \if@todonotes@disabled @@ -882,8 +989,8 @@ % Define the |\listoftodos| command and define the % appearance of the list of todos. % \begin{macrocode} -\newcommand{\listoftodos} - {\section*{\@todonotes@todolistname} \@starttoc{tdo}} +\newcommand{\listoftodos}[1][\@todonotes@todolistname] + {\section*{#1} \@starttoc{tdo}} \newcommand{\l@todo} {\@dottedtocline{1}{0em}{2.3em}} % \end{macrocode} @@ -951,7 +1058,7 @@ \addcontentsline{tdo}{todo}{\protect{% \colorbox{\@todonotes@currentbackgroundcolor}% {\textcolor{\@todonotes@currentbackgroundcolor}{o}}% - \@todonotes@caption}}% + \ \@todonotes@caption}}% \else% \addcontentsline{tdo}{todo}{\protect{\@todonotes@caption}}% \fi% |