diff options
| author | Glenn Morris | 2014-02-19 00:34:45 -0800 |
|---|---|---|
| committer | Glenn Morris | 2014-02-19 00:34:45 -0800 |
| commit | 95160c901a9bc780f30982002b9fcded5b436308 (patch) | |
| tree | 66a2cf9041f19d4e00e74b1e134d10baf90ffed3 /lisp/textmodes | |
| parent | 6cdb34f31fcccb19e0a9e5f2853c1d5fffc87a11 (diff) | |
| download | emacs-95160c901a9bc780f30982002b9fcded5b436308.tar.gz emacs-95160c901a9bc780f30982002b9fcded5b436308.zip | |
Some remember doc
* doc/misc/remember.texi: Copyedits.
(Quick Start): No need for manual autoloads. Mention remember-notes.
(Function Reference): Update arguments. Add new commands.
* lisp/textmodes/remember.el: Set maintainer to emacs-devel
according to remember.texi.
Move provide statement to end.
(remember-mode-map, remember-notes-mode-map, remember-notes-mode)
(remember-notes): Doc fixes.
Diffstat (limited to 'lisp/textmodes')
| -rw-r--r-- | lisp/textmodes/remember.el | 59 |
1 files changed, 31 insertions, 28 deletions
diff --git a/lisp/textmodes/remember.el b/lisp/textmodes/remember.el index a9eb7ad4ec8..089f5b2d889 100644 --- a/lisp/textmodes/remember.el +++ b/lisp/textmodes/remember.el | |||
| @@ -3,6 +3,7 @@ | |||
| 3 | ;; Copyright (C) 1999-2001, 2003-2014 Free Software Foundation, Inc. | 3 | ;; Copyright (C) 1999-2001, 2003-2014 Free Software Foundation, Inc. |
| 4 | 4 | ||
| 5 | ;; Author: John Wiegley <johnw@gnu.org> | 5 | ;; Author: John Wiegley <johnw@gnu.org> |
| 6 | ;; Maintainer: emacs-devel@gnu.org | ||
| 6 | ;; Created: 29 Mar 1999 | 7 | ;; Created: 29 Mar 1999 |
| 7 | ;; Version: 2.0 | 8 | ;; Version: 2.0 |
| 8 | ;; Keywords: data memory todo pim | 9 | ;; Keywords: data memory todo pim |
| @@ -178,8 +179,6 @@ | |||
| 178 | 179 | ||
| 179 | ;;; Code: | 180 | ;;; Code: |
| 180 | 181 | ||
| 181 | (provide 'remember) | ||
| 182 | |||
| 183 | (defconst remember-version "2.0" | 182 | (defconst remember-version "2.0" |
| 184 | "This version of remember.") | 183 | "This version of remember.") |
| 185 | 184 | ||
| @@ -230,6 +229,8 @@ recorded somewhere by that function." | |||
| 230 | :type 'boolean | 229 | :type 'boolean |
| 231 | :group 'remember) | 230 | :group 'remember) |
| 232 | 231 | ||
| 232 | ;; See below for more user variables. | ||
| 233 | |||
| 233 | ;;; Internal Variables: | 234 | ;;; Internal Variables: |
| 234 | 235 | ||
| 235 | (defvar remember-buffer "*Remember*" | 236 | (defvar remember-buffer "*Remember*" |
| @@ -553,7 +554,7 @@ If this is nil, then `diary-file' will be used instead." | |||
| 553 | (define-key map "\C-c\C-c" 'remember-finalize) | 554 | (define-key map "\C-c\C-c" 'remember-finalize) |
| 554 | (define-key map "\C-c\C-k" 'remember-destroy) | 555 | (define-key map "\C-c\C-k" 'remember-destroy) |
| 555 | map) | 556 | map) |
| 556 | "Keymap used in Remember mode.") | 557 | "Keymap used in `remember-mode'.") |
| 557 | 558 | ||
| 558 | (define-derived-mode remember-mode indented-text-mode "Remember" | 559 | (define-derived-mode remember-mode indented-text-mode "Remember" |
| 559 | "Major mode for output from \\[remember]. | 560 | "Major mode for output from \\[remember]. |
| @@ -599,10 +600,14 @@ If this is nil, use `initial-major-mode'." | |||
| 599 | (let ((map (make-sparse-keymap))) | 600 | (let ((map (make-sparse-keymap))) |
| 600 | (define-key map "\C-c\C-c" 'remember-notes-save-and-bury-buffer) | 601 | (define-key map "\C-c\C-c" 'remember-notes-save-and-bury-buffer) |
| 601 | map) | 602 | map) |
| 602 | "Keymap used in remember-notes mode.") | 603 | "Keymap used in `remember-notes-mode'.") |
| 603 | 604 | ||
| 604 | (define-minor-mode remember-notes-mode | 605 | (define-minor-mode remember-notes-mode |
| 605 | "Minor mode for the `remember-notes' buffer." | 606 | "Minor mode for the `remember-notes' buffer. |
| 607 | This sets `buffer-save-without-query' so that `save-some-buffers' will | ||
| 608 | save the notes buffer without asking. | ||
| 609 | |||
| 610 | \\{remember-notes-mode-map}" | ||
| 606 | nil nil nil | 611 | nil nil nil |
| 607 | (cond | 612 | (cond |
| 608 | (remember-notes-mode | 613 | (remember-notes-mode |
| @@ -612,29 +617,25 @@ If this is nil, use `initial-major-mode'." | |||
| 612 | 617 | ||
| 613 | ;;;###autoload | 618 | ;;;###autoload |
| 614 | (defun remember-notes (&optional switch-to) | 619 | (defun remember-notes (&optional switch-to) |
| 615 | "Creates notes buffer and switches to it if called interactively. | 620 | "Return the notes buffer, creating it if needed, and maybe switch to it. |
| 616 | 621 | This buffer is for notes that you want to preserve across Emacs sessions. | |
| 617 | If a notes buffer created by a previous invocation of this | 622 | The notes are saved in `remember-data-file'. |
| 618 | function already exist, it will be returned. Otherwise a new | 623 | |
| 619 | buffer will be created whose content will be read from file | 624 | If a buffer is already visiting that file, just return it. |
| 620 | pointed by `remember-data-file'. If a buffer visiting this file | 625 | |
| 621 | already exist, that buffer will be used instead of creating a new | 626 | Otherwise, create the buffer, and rename it to `remember-notes-buffer-name', |
| 622 | one (see `find-file-noselect' function for more details). | 627 | unless a buffer of that name already exists. Set the major mode according |
| 623 | 628 | to `remember-notes-initial-major-mode', and enable `remember-notes-mode' | |
| 624 | Name of the created buffer is taken from `remember-notes-buffer-name' | 629 | minor mode. |
| 625 | variable and if a buffer with that name already exist (but was not | 630 | |
| 626 | created by this function), it will be first killed. | 631 | Use \\<remember-notes-mode-map>\\[remember-notes-save-and-bury-buffer] to save and bury the notes buffer. |
| 627 | \\<remember-notes-mode-map> | 632 | |
| 628 | `remember-notes-mode' is active in the notes buffer which by default | 633 | Interactively, or if SWITCH-TO is non-nil, switch to the buffer. |
| 629 | contains only one \\[save-and-bury-buffer] binding which saves and | 634 | Return the buffer. |
| 630 | buries the buffer. | 635 | |
| 631 | 636 | Set `initial-buffer-choice' to `remember-notes' to visit your notes buffer | |
| 632 | Function returns notes buffer. When called interactively, | 637 | when Emacs starts. Set `remember-notes-buffer-name' to \"*scratch*\" |
| 633 | switches to it as well. | 638 | to turn the *scratch* buffer into your notes buffer." |
| 634 | |||
| 635 | Notes buffer is meant for keeping random notes which you'd like to | ||
| 636 | preserve across Emacs restarts. The notes will be stored in the | ||
| 637 | `remember-data-file'." | ||
| 638 | (interactive "p") | 639 | (interactive "p") |
| 639 | (let ((buf (or (find-buffer-visiting remember-data-file) | 640 | (let ((buf (or (find-buffer-visiting remember-data-file) |
| 640 | (with-current-buffer (find-file-noselect remember-data-file) | 641 | (with-current-buffer (find-file-noselect remember-data-file) |
| @@ -662,4 +663,6 @@ is non-nil, bury it and return nil; otherwise return t." | |||
| 662 | nil) | 663 | nil) |
| 663 | t)) | 664 | t)) |
| 664 | 665 | ||
| 666 | (provide 'remember) | ||
| 667 | |||
| 665 | ;;; remember.el ends here | 668 | ;;; remember.el ends here |