summaryrefslogtreecommitdiff
path: root/lisp/textmodes
diff options
context:
space:
mode:
authorJuanma Barranquero <lekktu@gmail.com>2008-11-23 05:02:28 +0000
committerJuanma Barranquero <lekktu@gmail.com>2008-11-23 05:02:28 +0000
commit7ee68ed5a89108934e439ec6607fafd8c54fa39e (patch)
tree61e1cfa06d06abc329ecf9d5494fc87e6dafd728 /lisp/textmodes
parentfa40e63379bdca8bcc5a345db7aa1fe97bd00bb7 (diff)
downloademacs-7ee68ed5a89108934e439ec6607fafd8c54fa39e.tar.gz
* textmodes/remember.el (remember-region): Doc fix.
(remember-filter-functions, remember-handler-functions) (remember-save-after-remembering, remember-mailbox) (remember-default-priority, remember-data-file, remember-leader-text) (remember-diary-file): Remove * from defcustom docstrings. (remember-run-all-annotation-functions-flag) (remember-all-handler-functions): Reflow docstrings. (remember-store-in-mailbox): Fix typo in docstring. (remember-mode): Define with `define-derived-mode'. Doc fix.
Diffstat (limited to 'lisp/textmodes')
-rw-r--r--lisp/textmodes/remember.el41
1 files changed, 16 insertions, 25 deletions
diff --git a/lisp/textmodes/remember.el b/lisp/textmodes/remember.el
index e3ca61c912f..244cf265eeb 100644
--- a/lisp/textmodes/remember.el
+++ b/lisp/textmodes/remember.el
@@ -207,13 +207,13 @@
:group 'remember)
(defcustom remember-filter-functions nil
- "*Functions run to filter remember data.
+ "Functions run to filter remember data.
All functions are run in the remember buffer."
:type 'hook
:group 'remember)
(defcustom remember-handler-functions '(remember-append-to-file)
- "*Functions run to process remember data.
+ "Functions run to process remember data.
Each function is called with the current buffer narrowed to what the
user wants remembered.
If any function returns non-nil, the data is assumed to have been
@@ -226,8 +226,7 @@ recorded somewhere by that function. "
:group 'remember)
(defcustom remember-all-handler-functions nil
- "If non-nil every function in `remember-handler-functions' is
-called."
+ "If non-nil every function in `remember-handler-functions' is called."
:type 'boolean
:group 'remember)
@@ -237,7 +236,7 @@ called."
"The name of the remember data entry buffer.")
(defcustom remember-save-after-remembering t
- "*Non-nil means automatically save after remembering."
+ "Non-nil means automatically save after remembering."
:type 'boolean
:group 'remember)
@@ -260,8 +259,7 @@ called."
:group 'remember)
(defcustom remember-run-all-annotation-functions-flag nil
- "Non-nil means use all annotations returned by
-`remember-annotation-functions'."
+ "Non-nil means use all annotations returned by `remember-annotation-functions'."
:type 'boolean
:group 'remember)
@@ -342,19 +340,19 @@ With a prefix or a visible region, use the region as INITIAL."
;; Remembering to UNIX mailboxes
(defcustom remember-mailbox "~/Mail/remember"
- "*The file in which to store remember data as mail."
+ "The file in which to store remember data as mail."
:type 'file
:group 'remember)
(defcustom remember-default-priority "medium"
- "*The default priority for remembered mail messages."
+ "The default priority for remembered mail messages."
:type 'string
:group 'remember)
(defun remember-store-in-mailbox ()
"Store remember data as if it were incoming mail.
In which case `remember-mailbox' should be the name of the mailbox.
-Each piece of psuedo-mail created will have an `X-Todo-Priority'
+Each piece of pseudo-mail created will have an `X-Todo-Priority'
field, for the purpose of appropriate splitting."
(let ((who (read-string "Who is this item related to? "))
(moment
@@ -391,12 +389,12 @@ Subject: %s\n\n"
;; Remembering to plain files
(defcustom remember-data-file (convert-standard-filename "~/.notes")
- "*The file in which to store unprocessed data."
+ "The file in which to store unprocessed data."
:type 'file
:group 'remember)
(defcustom remember-leader-text "** "
- "*The text used to begin each remember item."
+ "The text used to begin each remember item."
:type 'string
:group 'remember)
@@ -426,7 +424,7 @@ that was entered.
If BEG and END are nil, the entire buffer will be remembered.
If you want to remember a region, supply a universal prefix to
-`remember' instead. For example: C-u M-x remember RET."
+`remember' instead. For example: \\[universal-argument] \\[remember] RET."
;; Sacha: I have no idea where remember.el gets this context information, but
;; you can just use remember-annotation-functions.
(interactive)
@@ -465,7 +463,7 @@ application."
;;; Diary integration
(defcustom remember-diary-file nil
- "*File for extracted diary entries.
+ "File for extracted diary entries.
If this is nil, then `diary-file' will be used instead."
:type 'file
:group 'remember)
@@ -524,25 +522,18 @@ If this is nil, then `diary-file' will be used instead."
(define-key map "\C-x\C-s" 'remember-finalize)
(define-key map "\C-c\C-c" 'remember-finalize)
(define-key map "\C-c\C-k" 'remember-destroy)
-
map)
"Keymap used in Remember mode.")
-(defun remember-mode ()
+(define-derived-mode remember-mode indented-text-mode "Remember"
"Major mode for output from \\[remember].
This buffer is used to collect data that you want to remember.
-
-Just hit `C-c C-c' when you're done entering, and it will file
+\\<remember-mode-map>
+Just hit \\[remember-finalize] when you're done entering, and it will file
the data away for latter retrieval, and possible indexing.
\\{remember-mode-map}"
- (interactive)
- (kill-all-local-variables)
- (indented-text-mode)
- (use-local-map remember-mode-map)
- (setq major-mode 'remember-mode
- mode-name "Remember")
- (run-hooks 'remember-mode-hook))
+ (set-keymap-parent remember-mode-map nil))
;; arch-tag: 59312a05-06c7-4da1-b6f7-5ea41c9d5577
;;; remember.el ends here