Is there a simple way to add todo notes to LaTeX documents ?

I would like to have these notes in red in the generated pdf and a simple syntax to write them.

  • 9
    todonotes package or marginpar? – Seamus Jan 27 '11 at 13:28
  • In six years nobody mention the package changes ? – Fran May 2 at 8:30
up vote 156 down vote accepted

There is a todonotes package that makes adding notes easy enough. They appear in the margins by default.

A simpler version, if you just want red text in the body of the text as notes is just to define a command \mynotes that makes its argument red.

\documentclass{article}
\usepackage{xcolor}
\newcommand\myworries[1]{\textcolor{red}{#1}}
\begin{document}
Here is some text.
\myworries{But I'm worried about the text}
\end{document}

And then if you want to hide the comments, just add the line \renewcommand\myworries[1]{} below the \newcommand. This will hide all your notes.

A third option is to use LaTeX's own \marginpar command to put a paragraph in the margin. It's not great, but for little notes to yourself it's adequate.

Alan Munn, in the comments, has made me aware of another package todo that seems to be simpler than todonotes but a little more powerful than \marginpar. Though I've not used it so I don't know for sure.

  • 8
    There's also the todo package, which works well. – Alan Munn Jan 27 '11 at 13:52
  • @Seamus Thanks it is perfect, just one thing: is there a way to move the notes on the left side ? – aneuryzm Jan 27 '11 at 13:53
  • 2
    @Patrick For the todonotes package. For marginpar do: \marginpar[I'm on one side]{I'm on the other!} So if you want just notes on the left side: \marginpar[note goes here]{} Note the empty braces. – Seamus Jan 27 '11 at 14:16
  • it is also possible to have margin notes with different text on both sides at the same time – Herbert Jan 27 '11 at 15:33
  • @Seamus I actually get notes on right side (and not inline) by using the \todo command. \todo{this is on right side} and the next line of text is underlined – aneuryzm Jan 28 '11 at 8:19

The todonotes package mentioned above can be customized to show various types of notes. It is also possible to create a summary of all notes, for example at the end of the document. Here is an example:

\documentclass{article}
\usepackage{lipsum}                     % Dummytext
\usepackage{xargs}                      % Use more than one optional parameter in a new commands
\usepackage[pdftex,dvipsnames]{xcolor}  % Coloured text etc.
% 
\usepackage[colorinlistoftodos,prependcaption,textsize=tiny]{todonotes}
\newcommandx{\unsure}[2][1=]{\todo[linecolor=red,backgroundcolor=red!25,bordercolor=red,#1]{#2}}
\newcommandx{\change}[2][1=]{\todo[linecolor=blue,backgroundcolor=blue!25,bordercolor=blue,#1]{#2}}
\newcommandx{\info}[2][1=]{\todo[linecolor=OliveGreen,backgroundcolor=OliveGreen!25,bordercolor=OliveGreen,#1]{#2}}
\newcommandx{\improvement}[2][1=]{\todo[linecolor=Plum,backgroundcolor=Plum!25,bordercolor=Plum,#1]{#2}}
\newcommandx{\thiswillnotshow}[2][1=]{\todo[disable,#1]{#2}}
%
\begin{document}
\pagestyle{empty}
\todo[inline]{The original todo note withouth changed colours.\newline Here's another line.}
\lipsum[11]\unsure{Is this correct?}\unsure{I'm unsure about also!}
\lipsum[11]\change{Change this!}
\lipsum[11]\info{This can help me in chapter seven!}
\lipsum[11]\improvement{This really needs to be improved!\newline\newline What was I thinking?!}
\lipsum[11]
\thiswillnotshow{This is hidden since option `disable' is chosen!}
\improvement[inline]{The following section needs to be rewritten!}
\lipsum[11]
\newpage
\listoftodos[Notes]
\end{document}

This outputs the following text with notes:

The text with notes

And here is the summary page:

The summary

Notice the \thiswillnotshow note which is disabled using the disable option in the header. This can be used to turn off each type of note globally. Todonotes can also be used in the caption of tables and figures, though only provided that the inline option is used with these notes.

  • 2
    You can also add a todo note with an incrementing counter for each note, using the following code: \newcounter{todocounter} \newcommandx{\todocount}[2][1=]{\stepcounter{todocounter}\todo[linecolor=YellowGreen,backgroundcolor=YellowGreen!25,bordercolor=YellowGreen,#1]{\thetodocounter: #2}} – MLC Oct 31 '16 at 13:53
  • Thanks for the answer, but what's "\newcommandx"? I only know \newcommand{...} – Someguy Jul 16 at 13:16

see package cooltooltips. When the cursor is over "This text" the blue window pops up.

enter image description here

The source code for this example:

\documentclass{article}

\usepackage{cooltooltips}
\usepackage{graphicx}
\usepackage{color}
\usepackage{hyperref}

\def\cool{\texttt{cool}}
\begin{document}

The \cool\ package enables a document to contain hyperlinks that pop
up a brief tooltip when the mouse moves over them and also open a
small window containing additional text.  \cool\ works only with
pdf\LaTeX\@.  Furthermore, the tooltips that \cool\ produces are much
less cool when viewed under older versions of Acrobat~($<7.0$) or the
current version of xpdf~(3.00) because they don't pop up the extra,
small window.  
\cooltooltip[0 0 1]{Example}{This is an example of a cool tooltip.  
Pretty cool, eh?}{http://www.ctan.org/}{Visit CTAN on the Web}{This text\strut} 
%
is an example of a cool tooltip (assuming
you're viewing this document with a sufficiently capable \textsc{pdf}
reader).  Move your mouse pointer over it and watch what happens.
Then, click on the link.  If your \textsc{pdf} reader is properly
configured it should launch a Web browser and send it to the
\textsc{ctan} home page.

\end{document}

Another possibility is the fixme package. It supports several ways of outputting the notes. You can have them directly inside the text, in the page margin, or as a list at the end of the document. You can even combine the methods.

It comes with support for different authors and different levels of severity. "Notes" and "comments" will simply be ignored if you compile the document with final option, while "errors" will produce compilation errors. In draft mode they will all be printed with different markup. Every author gets his/her own prefix, that is added to the note.

  • 1
    I use the fixme package and have defined several types of notes e. g. in red for important changes (missing content or content of document to check) and light green for "cosmetic changes" (text alignment could be better, etc.) - all in all I find the fixme package extremely useful – MostlyHarmless Apr 4 '11 at 21:39

To avoid the risk to submit the paper with the todo notes, I throw a warning, so that each todo appears as a warning when I compile. The command is

\newcommand{\todo}[1]{\textcolor{red}{TODO: #1}\PackageWarning{TODO:}{#1!}}
  • 1
    FYI \textcolor requires \usepackage{color} (or xcolor) – Emma Strubell Oct 31 '17 at 20:50
  • ^so you can replace \textcolor{red}{TODO: #1} with {\color{red}TODO: #1} – JHBonarius Jan 18 at 13:49
  • Note that for some reason for me this crashes rubber when the TODO has a certain length. – Sebastian Graf Oct 18 at 9:08

If you want the notes directly in PDF you may want to use PDF annotations with the pdfcomment package.

Take a look at the screenshots

The todonotes package suggested by MLC has colour built in. The \todo command can take several options, including color. This voids the need for making own commands if you just want to quickly colour your notes. The list of options can be found here: PDF

Examples:

\documentclass{article}
\usepackage{todonotes}
\begin{document}
\todo{default to-do}This is text that needs some attention.\\
\todo[inline]{Default inline to-do}
\todo[inline, color=green]{Green inline to-do}
\todo[inline, color=green!40]{Light green inline to-do}
\todo[inline, color=red]{Red inline to-do}
\todo[inline, color=red!40]{Light red inline to-do}
\end{document}

Output:

todo latex colours

Check out easy-todo on http://www.ctan.org/tex-archive/macros/latex/contrib/easy-todo

  • I am using this package due to its simplicity, although I have some minor issues with it. Just a notice: If you have strange issues with the content of your index. Uncomment the \usepackage{easy-todo} command for testing, if your issues are gone. It caused in my document class provided by my university, that index, table index and figure index got not displayed in the index. The creator of the document class said, it my may not be compatible with koma script. Once I don't use the easy-todo package, everything is fine. So I dont have to worry. – OneWorld Sep 12 '12 at 16:31

https://github.com/kkew3/todo-tex

A Python3 solution that parses TODO notes in LaTeX source comments and outputs them on the terminal.

Sample from the GitHub page:

% myfile.tex
\documentclass{article}
\begin{document}
Superchiasmatic neucleus is the primary clock % continue later: forgot what to write now
\end{document}

$ todo-tex -lm prints

./myfile.tex
    [TODO] line 3: forgot what to write now

Supported TODO tags are todo, TODO, question, problem, continue here, continue later, continue ....

That list can easily be extended by editing the python script.

  • Welcome to TeX.SE. Hyperlinks can and eventually do break. Please edit your posting to convey (a) the gist of your answer and to point out (b) strengths of your solution as well as (c) any shortcomings or caveats. That way, readers of this site will be far more inclined to follow the link you've provided. – Mico Nov 18 '17 at 20:32
  • @Mico, I will edit Kevin's answer as I find it super helpful. – llinfeng Feb 3 at 17:49

Your Answer

 

By clicking "Post Your Answer", you acknowledge that you have read our updated terms of service, privacy policy and cookie policy, and that your continued use of the website is subject to these policies.

Not the answer you're looking for? Browse other questions tagged or ask your own question.