todo-mode.el comment patch

todo-mode.el comment patch

[Jason Schroeder]

Hi.

lisp/calendar/todo-mode.el is missing some relevant comments.  The next new
user can avoid
reading the elisp code if the following was included in the comments.

This is an anonymous donation for all I care.

Jason Schroeder

--- todo-mode.el~	Tue Nov 13 04:12:45 2001
+++ todo-mode.el	Sun Mar 31 06:03:58 2002
@@ -69,6 +69,28 @@
 ;;      in order to initialise the file, but it is not necessary
 ;;      afterwards.
 ;;
+;;      TODO is designed to be used in conjunction with diary mode. This
+;;      indicates the purpose of the pattern "*/*" (aka todo-prefix below)
+;;      in the TODO files.  The following are diary specific
initializations
+;;      used to expose the TODO/diary functionality.
+;;
+;;      In the diary-file, you add the line:
+;;          #include "~/.todo-do"
+;;      (The file name is the same as todo-file-do.)
+;;
+;;      Also, you add the following in order to cause the diary include
+;;      include feature to work.
+;;          (add-hook 'diary-display-hook 'fancy-diary-display)
+;;          (add-hook 'list-diary-entries-hook 'include-other-diary-files)
+;;
+;;      And, when using the diary mode in conjunction with the calendar
mode,
+;;      the first turns that feature on and the second controls whether the
+;;      todo items are indicated on the calendar.  I do not suggest the use
+;;      of the diary marking feature in conjunction with TODO.
+;;
+;;          (add-hook 'diary-hook 'appt-make-list)
+;;          (add-hook 'mark-diary-entries-hook 'mark-included-diary-files)
+;;
 ;;      As these commands are quite long to type, I would recommend
 ;;      the addition of two bindings to your to your global keymap.  I
 ;;      personally have the following in my initialisation file: