andros/emacs-gpu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

remember.texi: Remove mentions of things outside of Emacs

Browse source
This commit is contained in:
Michael Olson 2007-10-30 13:57:17 +00:00
parent e06280609c
commit bec9b2f506
2 changed files with 63 additions and 125 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/misc/ChangeLog
View file

@ -1,3 +1,10 @@
2007-10-30 Michael Olson <mwolson@gnu.org>
* remember.texi (Copying): Remove.
(Mailbox): Update with non-BBDB instructions.
(Diary, Org): Add.
(Bibliography, Planner Page): Remove.
2007-10-30 Juanma Barranquero <lekktu@gmail.com>
* makefile.w32-in (INFO_TARGETS): Add remember.

181
doc/misc/remember.texi
View file

@ -58,10 +58,6 @@ Free Documentation License''.
* Function Reference:: Interactive functions in remember.el.
* Keystrokes:: Keystrokes bound in Remember Mode.
* Backends:: Backends for saving notes.
* Copying:: The GNU General Public License gives you
permission to redistribute Remember on
certain terms; it also explains that
there is no warranty.
* GNU Free Documentation License:: The license for this documentation.
* Concept Index:: Search for terms.
@ -71,9 +67,9 @@ Free Documentation License''.
Backends
* Text File:: Saving to a text file.
* Diary:: Saving to a Diary file.
* Mailbox:: Saving to a mailbox.
* Bibliography:: Saving to a bibliography.
* Planner Page:: Saving to a Planner page.
* Org:: Saving to an Org Mode file.
@end detailmenu
@end menu
@ -162,15 +158,14 @@ want to bind this to an easily accessible keystroke, like @kbd{C-x
M-r}), slam in your text however you like, and then hit @kbd{C-c C-c}.
It will file the data away for later retrieval, and possibly indexing.
Indexing is to data what ``studying'' is in the real world. What you
do when you study (or lucubrate, for some of us) is to realize certain
Indexing is to data what ``studying'' is in the real world. What you do
when you study (or lucubrate, for some of us) is to realize certain
relationships implicit in the data, so that you can make use of those
relationships. Expressing that a certain quote you remembered was a
religious quote, and that you want the ability to pull up all quotes
of a religious nature, is what studying does. This is a more labor
intensive task than the original remembering of the data, and it's
typical in real life to set aside a special period of time for doing
this work.
literary quote, and that you want the ability to pull up all quotes of a
literary nature, is what studying does. This is a more labor intensive
task than the original remembering of the data, and it's typical in real
life to set aside a special period of time for doing this work.
``Remember'' works in the same way. When you enter data, either by
typing it into a buffer, or using the contents of the selected region,
@ -240,12 +235,6 @@ very accessible keystrokes facilities using the mode:
(define-key global-map (kbd "<f9> R") 'remember-region)
@end lisp
Check out the Planner package
(@uref{http://www.emacswiki.org/cgi-bin/wiki/PlannerMode}) for plenty
of annotation functions you can use with Remember. If you use Planner,
you can easily publish your remembered notes as HTML and RSS.
(@pxref{Planner Page})
By default, remember uses the first annotation returned by
@code{remember-annotation-functions}. To include all of the annotations,
set @code{remember-run-all-annotation-functions-flag} to non-nil.
@ -319,7 +308,7 @@ Remember the contents of the current buffer.
@end table
@node Backends, Copying, Keystrokes, Top
@node Backends, GNU Free Documentation License, Keystrokes, Top
@comment node-name, next, previous, up
@chapter Backends
@ -327,138 +316,80 @@ You can save remembered notes to a variety of backends.
@menu
* Text File:: Saving to a text file.
* Diary:: Saving to a Diary file.
* Mailbox:: Saving to a mailbox.
* Bibliography:: Saving to a bibliography.
* Planner Page:: Saving to a Planner page.
* Org:: Saving to an Org Mode file.
@end menu
@node Text File, Mailbox, Backends, Backends
@node Text File, Diary, Backends, Backends
@comment node-name, next, previous, up
@section Saving to a Text File
@cindex text file
@cindex outline
@cindex text file, saving to
This backend comes with Emacs.
@subheading Insinuation
@lisp
(setq remember-handler-functions '(remember-append-to-file))
@end lisp
@subheading Options
@defopt remember-data-file
The file in which to store unprocessed data.
@end defopt
@defopt remember-leader-text
The text used to begin each remember item.
@end defopt
@node Mailbox, Bibliography, Text File, Backends
@section Saving to a Mailbox
@cindex mailbox, saving to a
@node Diary, Mailbox, Text File, Backends
@comment node-name, next, previous, up
@section Saving to a Diary file
@cindex diary, integration
@subheading Insinuation
@lisp
(setq remember-handler-functions '(remember-store-in-mailbox))
(require 'remember-diary)
(add-to-list 'remember-handler-functions 'remember-diary-extract-entries)
@end lisp
@subheading Options
@defopt remember-diary-file
File for extracted diary entries.
@end defopt
@node Mailbox, Org, Diary, Backends
@comment node-name, next, previous, up
@section Saving to a Mailbox
@cindex mailbox, saving to
@subheading Insinuation
@lisp
(add-to-list 'remember-handler-functions 'remember-store-in-mailbox)
@end lisp
@subheading Options
@defopt remember-mailbox
Name of mailbox to save messages to.
The file in which to store remember data as mail.
@end defopt
This backend does not come with Emacs. To get it, download the latest
version of Remember from @url{http://download.gna.org/remember-el/}.
@defopt remember-default-priority
The default priority for remembered mail messages.
@end defopt
If you want to use BBDB to associate remembered snippets with entries
in your contact database, use the following code snippet:
@lisp
(require 'remember-bbdb)
(setq remember-handler-functions '(remember-bbdb-store-in-mailbox))
@end lisp
@node Bibliography, Planner Page, Mailbox, Backends
@section Saving to a Bibliography
This backend does not come with Emacs. To get it, download the latest
version of Remember from @url{http://download.gna.org/remember-el/}.
Bibl-mode is a major mode for maintaining bibliography files. You can
get bibl-mode from:
@uref{http://ftp.azc.uam.mx/mirrors/gnu/emacs-lisp/bosullivan-packages/bibl-mode/}.
@lisp
(require 'remember-bibl)
@end lisp
@defun remember-url
Remember a URL in @code{bibl-mode} that is being visited with w3.
@end defun
@defun remember-location
Remember a bookmark location in `bibl-mode'.
@end defun
You can use this in addition to your normal remember backend.
@node Planner Page, , Bibliography, Backends
@node Org, , Mailbox, Backends
@comment node-name, next, previous, up
@section Saving to a Planner Page
@cindex @file{remember-planner.el}, using
@cindex remember-el, using with PlannerMode
@section Saving to an Org Mode file
@cindex org mode, integration
This backend does not come with Emacs. To get it, download the latest
version of Remember from @url{http://download.gna.org/remember-el/}.
For instructions on how to integrate Remember with Org Mode,
consult @ref{Remember, , , org}.
If you are using PlannerMode, depending on your configuration, notes
made using remember-el may actually be saved to a project and/or day
plan page.
@file{remember-planner.el} makes the notes you save with remember have
more context information associated with them, in the way that
PlannerMode tasks do.
To use remember-planner, place this in your @file{.emacs}:
@lisp
(require 'remember-planner)
(setq remember-handler-functions '(remember-planner-append))
@end lisp
To take advantage of PlannerMode's annotation functions, add the
following code as well:
@lisp
(setq remember-annotation-functions planner-annotation-functions)
@end lisp
Then, type @kbd{M-x remember} to remember new text, @kbd{M-x
remember-region} to remember the current region, or @kbd{C-u M-x
remember} to remember the current region but have an opportunity to
edit it before it is saved.
@defopt remember-planner-xref-p
Non-nil means cross-reference new entries with plan pages. Plan pages
are useful for gathering related information. If you don't want a note
associated with a plan page, you can press RET to accept the default
(just today's page) or specify nil at the prompt.
@end defopt
@defopt remember-planner-copy-on-xref-flag
Non-nil means copy note text instead of moving it to the plan page. If
nil, move the note body to the plan page, leaving a cross-reference
link on the day page. This results in shorter day pages but may be
harder for people to read.
@end defopt
@defopt remember-planner-timestamp-format
Format of timestamp for remember entries.
@end defopt
@file{remember-planner.el} does not define any interactive functions
or keybindings.
@node Copying, GNU Free Documentation License, Backends, Top
@comment node-name, next, previous, up
@appendix GNU GENERAL PUBLIC LICENSE
@include gpl.texi
@node GNU Free Documentation License, Concept Index, Copying, Top
@node GNU Free Documentation License, Concept Index, Backends, Top
@appendix GNU Free Documentation License
@include doclicense.texi