Mercurial > emacs
comparison lisp/calendar/todo-mode.el @ 92547:3c802ca7a7fa
Remove leading `*' from defcustom doc-strings.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Fri, 07 Mar 2008 04:42:53 +0000 |
parents | 0c4a74c24677 |
children | f90cefa62737 |
comparison
equal
deleted
inserted
replaced
92546:0ef74aab4b13 | 92547:3c802ca7a7fa |
---|---|
268 :link '(emacs-commentary-link "todo-mode") | 268 :link '(emacs-commentary-link "todo-mode") |
269 :version "21.1" | 269 :version "21.1" |
270 :group 'calendar) | 270 :group 'calendar) |
271 | 271 |
272 (defcustom todo-prefix "*/*" | 272 (defcustom todo-prefix "*/*" |
273 "*TODO mode prefix for entries. | 273 "TODO mode prefix for entries. |
274 | 274 |
275 This is useful in conjunction with `calendar' and `diary' if you use | 275 This is useful in conjunction with `calendar' and `diary' if you use |
276 | 276 |
277 #include \"~/.todo-do\" | 277 #include \"~/.todo-do\" |
278 | 278 |
283 show and mark todo entries for today, but may slow down processing of | 283 show and mark todo entries for today, but may slow down processing of |
284 the diary file somewhat." | 284 the diary file somewhat." |
285 :type 'string | 285 :type 'string |
286 :group 'todo) | 286 :group 'todo) |
287 (defcustom todo-file-do "~/.todo-do" | 287 (defcustom todo-file-do "~/.todo-do" |
288 "*TODO mode list file." | 288 "TODO mode list file." |
289 :type 'file | 289 :type 'file |
290 :group 'todo) | 290 :group 'todo) |
291 (defcustom todo-file-done "~/.todo-done" | 291 (defcustom todo-file-done "~/.todo-done" |
292 "*TODO mode archive file." | 292 "TODO mode archive file." |
293 :type 'file | 293 :type 'file |
294 :group 'todo) | 294 :group 'todo) |
295 (defcustom todo-mode-hook nil | 295 (defcustom todo-mode-hook nil |
296 "*TODO mode hooks." | 296 "TODO mode hooks." |
297 :type 'hook | 297 :type 'hook |
298 :group 'todo) | 298 :group 'todo) |
299 (defcustom todo-edit-mode-hook nil | 299 (defcustom todo-edit-mode-hook nil |
300 "*TODO Edit mode hooks." | 300 "TODO Edit mode hooks." |
301 :type 'hook | 301 :type 'hook |
302 :group 'todo) | 302 :group 'todo) |
303 (defcustom todo-insert-threshold 0 | 303 (defcustom todo-insert-threshold 0 |
304 "*TODO mode insertion accuracy. | 304 "TODO mode insertion accuracy. |
305 | 305 |
306 If you have 8 items in your TODO list, then you may get asked 4 | 306 If you have 8 items in your TODO list, then you may get asked 4 |
307 questions by the binary insertion algorithm. However, you may not | 307 questions by the binary insertion algorithm. However, you may not |
308 really have a need for such accurate priorities amongst your TODO | 308 really have a need for such accurate priorities amongst your TODO |
309 items. If you now think about the binary insertion halving the size | 309 items. If you now think about the binary insertion halving the size |
317 :type 'integer | 317 :type 'integer |
318 :group 'todo) | 318 :group 'todo) |
319 (defvar todo-edit-buffer " *TODO Edit*" | 319 (defvar todo-edit-buffer " *TODO Edit*" |
320 "TODO Edit buffer name.") | 320 "TODO Edit buffer name.") |
321 (defcustom todo-file-top "~/.todo-top" | 321 (defcustom todo-file-top "~/.todo-top" |
322 "*TODO mode top priorities file. | 322 "TODO mode top priorities file. |
323 | 323 |
324 Not in TODO format, but diary compatible. | 324 Not in TODO format, but diary compatible. |
325 Automatically generated when `todo-save-top-priorities' is non-nil." | 325 Automatically generated when `todo-save-top-priorities' is non-nil." |
326 :type 'string | 326 :type 'string |
327 :group 'todo) | 327 :group 'todo) |
328 | 328 |
329 (defcustom todo-print-function 'ps-print-buffer-with-faces | 329 (defcustom todo-print-function 'ps-print-buffer-with-faces |
330 "*Function to print the current buffer." | 330 "Function to print the current buffer." |
331 :type 'symbol | 331 :type 'symbol |
332 :group 'todo) | 332 :group 'todo) |
333 (defcustom todo-show-priorities 1 | 333 (defcustom todo-show-priorities 1 |
334 "*Default number of priorities to show by \\[todo-top-priorities]. | 334 "Default number of priorities to show by \\[todo-top-priorities]. |
335 0 means show all entries." | 335 0 means show all entries." |
336 :type 'integer | 336 :type 'integer |
337 :group 'todo) | 337 :group 'todo) |
338 (defcustom todo-print-priorities 0 | 338 (defcustom todo-print-priorities 0 |
339 "*Default number of priorities to print by \\[todo-print]. | 339 "Default number of priorities to print by \\[todo-print]. |
340 0 means print all entries." | 340 0 means print all entries." |
341 :type 'integer | 341 :type 'integer |
342 :group 'todo) | 342 :group 'todo) |
343 (defcustom todo-remove-separator t | 343 (defcustom todo-remove-separator t |
344 "*Non-nil to remove category separators in\ | 344 "Non-nil to remove category separators in\ |
345 \\[todo-top-priorities] and \\[todo-print]." | 345 \\[todo-top-priorities] and \\[todo-print]." |
346 :type 'boolean | 346 :type 'boolean |
347 :group 'todo) | 347 :group 'todo) |
348 (defcustom todo-save-top-priorities-too t | 348 (defcustom todo-save-top-priorities-too t |
349 "*Non-nil makes `todo-save' automatically save top-priorities in `todo-file-top'." | 349 "Non-nil makes `todo-save' automatically save top-priorities in `todo-file-top'." |
350 :type 'boolean | 350 :type 'boolean |
351 :group 'todo) | 351 :group 'todo) |
352 | 352 |
353 ;; Thanks for the ISO time stamp format go to Karl Eichwalder <ke@suse.de> | 353 ;; Thanks for the ISO time stamp format go to Karl Eichwalder <ke@suse.de> |
354 ;; My format string for the appt.el package is "%3b %2d, %y, %02I:%02M%p". | 354 ;; My format string for the appt.el package is "%3b %2d, %y, %02I:%02M%p". |
355 ;; | 355 ;; |
356 (defcustom todo-time-string-format | 356 (defcustom todo-time-string-format |
357 "%:y-%02m-%02d %02H:%02M" | 357 "%:y-%02m-%02d %02H:%02M" |
358 "*TODO mode time string format for done entries. | 358 "TODO mode time string format for done entries. |
359 For details see the variable `time-stamp-format'." | 359 For details see the variable `time-stamp-format'." |
360 :type 'string | 360 :type 'string |
361 :group 'todo) | 361 :group 'todo) |
362 | 362 |
363 (defcustom todo-entry-prefix-function 'todo-entry-timestamp-initials | 363 (defcustom todo-entry-prefix-function 'todo-entry-timestamp-initials |
364 "*Function producing text to insert at start of todo entry." | 364 "Function producing text to insert at start of todo entry." |
365 :type 'symbol | 365 :type 'symbol |
366 :group 'todo) | 366 :group 'todo) |
367 (defcustom todo-initials (or (getenv "INITIALS") (user-login-name)) | 367 (defcustom todo-initials (or (getenv "INITIALS") (user-login-name)) |
368 "*Initials of todo item author." | 368 "Initials of todo item author." |
369 :type 'string | 369 :type 'string |
370 :group 'todo) | 370 :group 'todo) |
371 | 371 |
372 (defun todo-entry-timestamp-initials () | 372 (defun todo-entry-timestamp-initials () |
373 "Prepend timestamp and your initials to the head of a TODO entry." | 373 "Prepend timestamp and your initials to the head of a TODO entry." |