aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Olson2007-10-30 13:57:17 +0000
committerMichael Olson2007-10-30 13:57:17 +0000
commitbec9b2f50688ad46deec2b76332cc7289be85940 (patch)
tree2fe269284d0224cc9ce75b2c25697b565e1e8d9d /doc
parente06280609cd58d9513e70662f4900a200f561f4a (diff)
downloademacs-bec9b2f50688ad46deec2b76332cc7289be85940.tar.gz
emacs-bec9b2f50688ad46deec2b76332cc7289be85940.zip
remember.texi: Remove mentions of things outside of Emacs
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/ChangeLog7
-rw-r--r--doc/misc/remember.texi163
2 files changed, 54 insertions, 116 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 4040d2d1bc0..489e4ec29e7 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,10 @@
12007-10-30 Michael Olson <mwolson@gnu.org>
2
3 * remember.texi (Copying): Remove.
4 (Mailbox): Update with non-BBDB instructions.
5 (Diary, Org): Add.
6 (Bibliography, Planner Page): Remove.
7
12007-10-30 Juanma Barranquero <lekktu@gmail.com> 82007-10-30 Juanma Barranquero <lekktu@gmail.com>
2 9
3 * makefile.w32-in (INFO_TARGETS): Add remember. 10 * makefile.w32-in (INFO_TARGETS): Add remember.
diff --git a/doc/misc/remember.texi b/doc/misc/remember.texi
index a904a7a467a..1153d4b5679 100644
--- a/doc/misc/remember.texi
+++ b/doc/misc/remember.texi
@@ -58,10 +58,6 @@ Free Documentation License''.
58* Function Reference:: Interactive functions in remember.el. 58* Function Reference:: Interactive functions in remember.el.
59* Keystrokes:: Keystrokes bound in Remember Mode. 59* Keystrokes:: Keystrokes bound in Remember Mode.
60* Backends:: Backends for saving notes. 60* Backends:: Backends for saving notes.
61* Copying:: The GNU General Public License gives you
62 permission to redistribute Remember on
63 certain terms; it also explains that
64 there is no warranty.
65* GNU Free Documentation License:: The license for this documentation. 61* GNU Free Documentation License:: The license for this documentation.
66* Concept Index:: Search for terms. 62* Concept Index:: Search for terms.
67 63
@@ -71,9 +67,9 @@ Free Documentation License''.
71Backends 67Backends
72 68
73* Text File:: Saving to a text file. 69* Text File:: Saving to a text file.
70* Diary:: Saving to a Diary file.
74* Mailbox:: Saving to a mailbox. 71* Mailbox:: Saving to a mailbox.
75* Bibliography:: Saving to a bibliography. 72* Org:: Saving to an Org Mode file.
76* Planner Page:: Saving to a Planner page.
77 73
78@end detailmenu 74@end detailmenu
79@end menu 75@end menu
@@ -162,15 +158,14 @@ want to bind this to an easily accessible keystroke, like @kbd{C-x
162M-r}), slam in your text however you like, and then hit @kbd{C-c C-c}. 158M-r}), slam in your text however you like, and then hit @kbd{C-c C-c}.
163It will file the data away for later retrieval, and possibly indexing. 159It will file the data away for later retrieval, and possibly indexing.
164 160
165Indexing is to data what ``studying'' is in the real world. What you 161Indexing is to data what ``studying'' is in the real world. What you do
166do when you study (or lucubrate, for some of us) is to realize certain 162when you study (or lucubrate, for some of us) is to realize certain
167relationships implicit in the data, so that you can make use of those 163relationships implicit in the data, so that you can make use of those
168relationships. Expressing that a certain quote you remembered was a 164relationships. Expressing that a certain quote you remembered was a
169religious quote, and that you want the ability to pull up all quotes 165literary quote, and that you want the ability to pull up all quotes of a
170of a religious nature, is what studying does. This is a more labor 166literary nature, is what studying does. This is a more labor intensive
171intensive task than the original remembering of the data, and it's 167task than the original remembering of the data, and it's typical in real
172typical in real life to set aside a special period of time for doing 168life to set aside a special period of time for doing this work.
173this work.
174 169
175``Remember'' works in the same way. When you enter data, either by 170``Remember'' works in the same way. When you enter data, either by
176typing it into a buffer, or using the contents of the selected region, 171typing it into a buffer, or using the contents of the selected region,
@@ -240,12 +235,6 @@ very accessible keystrokes facilities using the mode:
240(define-key global-map (kbd "<f9> R") 'remember-region) 235(define-key global-map (kbd "<f9> R") 'remember-region)
241@end lisp 236@end lisp
242 237
243Check out the Planner package
244(@uref{http://www.emacswiki.org/cgi-bin/wiki/PlannerMode}) for plenty
245of annotation functions you can use with Remember. If you use Planner,
246you can easily publish your remembered notes as HTML and RSS.
247(@pxref{Planner Page})
248
249By default, remember uses the first annotation returned by 238By default, remember uses the first annotation returned by
250@code{remember-annotation-functions}. To include all of the annotations, 239@code{remember-annotation-functions}. To include all of the annotations,
251set @code{remember-run-all-annotation-functions-flag} to non-nil. 240set @code{remember-run-all-annotation-functions-flag} to non-nil.
@@ -319,7 +308,7 @@ Remember the contents of the current buffer.
319 308
320@end table 309@end table
321 310
322@node Backends, Copying, Keystrokes, Top 311@node Backends, GNU Free Documentation License, Keystrokes, Top
323@comment node-name, next, previous, up 312@comment node-name, next, previous, up
324@chapter Backends 313@chapter Backends
325 314
@@ -327,138 +316,80 @@ You can save remembered notes to a variety of backends.
327 316
328@menu 317@menu
329* Text File:: Saving to a text file. 318* Text File:: Saving to a text file.
319* Diary:: Saving to a Diary file.
330* Mailbox:: Saving to a mailbox. 320* Mailbox:: Saving to a mailbox.
331* Bibliography:: Saving to a bibliography. 321* Org:: Saving to an Org Mode file.
332* Planner Page:: Saving to a Planner page.
333@end menu 322@end menu
334 323
335@node Text File, Mailbox, Backends, Backends 324@node Text File, Diary, Backends, Backends
325@comment node-name, next, previous, up
336@section Saving to a Text File 326@section Saving to a Text File
337@cindex text file 327@cindex text file, saving to
338@cindex outline
339 328
340This backend comes with Emacs. 329@subheading Insinuation
341 330
342@lisp 331@lisp
343(setq remember-handler-functions '(remember-append-to-file)) 332(setq remember-handler-functions '(remember-append-to-file))
344@end lisp 333@end lisp
345 334
335@subheading Options
336
346@defopt remember-data-file 337@defopt remember-data-file
338The file in which to store unprocessed data.
347@end defopt 339@end defopt
348 340
349@defopt remember-leader-text 341@defopt remember-leader-text
342The text used to begin each remember item.
350@end defopt 343@end defopt
351 344
352@node Mailbox, Bibliography, Text File, Backends 345@node Diary, Mailbox, Text File, Backends
353@section Saving to a Mailbox 346@comment node-name, next, previous, up
354@cindex mailbox, saving to a 347@section Saving to a Diary file
355 348@cindex diary, integration
356@lisp
357(setq remember-handler-functions '(remember-store-in-mailbox))
358@end lisp
359
360@defopt remember-mailbox
361Name of mailbox to save messages to.
362@end defopt
363
364This backend does not come with Emacs. To get it, download the latest
365version of Remember from @url{http://download.gna.org/remember-el/}.
366 349
367If you want to use BBDB to associate remembered snippets with entries 350@subheading Insinuation
368in your contact database, use the following code snippet:
369 351
370@lisp 352@lisp
371(require 'remember-bbdb) 353(require 'remember-diary)
372(setq remember-handler-functions '(remember-bbdb-store-in-mailbox)) 354(add-to-list 'remember-handler-functions 'remember-diary-extract-entries)
373@end lisp 355@end lisp
374 356
375@node Bibliography, Planner Page, Mailbox, Backends 357@subheading Options
376@section Saving to a Bibliography
377
378This backend does not come with Emacs. To get it, download the latest
379version of Remember from @url{http://download.gna.org/remember-el/}.
380
381Bibl-mode is a major mode for maintaining bibliography files. You can
382get bibl-mode from:
383@uref{http://ftp.azc.uam.mx/mirrors/gnu/emacs-lisp/bosullivan-packages/bibl-mode/}.
384 358
385@lisp 359@defopt remember-diary-file
386(require 'remember-bibl) 360File for extracted diary entries.
387@end lisp 361@end defopt
388
389@defun remember-url
390Remember a URL in @code{bibl-mode} that is being visited with w3.
391@end defun
392
393@defun remember-location
394Remember a bookmark location in `bibl-mode'.
395@end defun
396
397You can use this in addition to your normal remember backend.
398 362
399@node Planner Page, , Bibliography, Backends 363@node Mailbox, Org, Diary, Backends
400@comment node-name, next, previous, up 364@comment node-name, next, previous, up
401@section Saving to a Planner Page 365@section Saving to a Mailbox
402@cindex @file{remember-planner.el}, using 366@cindex mailbox, saving to
403@cindex remember-el, using with PlannerMode
404
405This backend does not come with Emacs. To get it, download the latest
406version of Remember from @url{http://download.gna.org/remember-el/}.
407
408If you are using PlannerMode, depending on your configuration, notes
409made using remember-el may actually be saved to a project and/or day
410plan page.
411
412@file{remember-planner.el} makes the notes you save with remember have
413more context information associated with them, in the way that
414PlannerMode tasks do.
415
416To use remember-planner, place this in your @file{.emacs}:
417
418@lisp
419(require 'remember-planner)
420(setq remember-handler-functions '(remember-planner-append))
421@end lisp
422 367
423To take advantage of PlannerMode's annotation functions, add the 368@subheading Insinuation
424following code as well:
425 369
426@lisp 370@lisp
427(setq remember-annotation-functions planner-annotation-functions) 371(add-to-list 'remember-handler-functions 'remember-store-in-mailbox)
428@end lisp 372@end lisp
429 373
430Then, type @kbd{M-x remember} to remember new text, @kbd{M-x 374@subheading Options
431remember-region} to remember the current region, or @kbd{C-u M-x
432remember} to remember the current region but have an opportunity to
433edit it before it is saved.
434
435@defopt remember-planner-xref-p
436Non-nil means cross-reference new entries with plan pages. Plan pages
437are useful for gathering related information. If you don't want a note
438associated with a plan page, you can press RET to accept the default
439(just today's page) or specify nil at the prompt.
440@end defopt
441 375
442@defopt remember-planner-copy-on-xref-flag 376@defopt remember-mailbox
443Non-nil means copy note text instead of moving it to the plan page. If 377The file in which to store remember data as mail.
444nil, move the note body to the plan page, leaving a cross-reference
445link on the day page. This results in shorter day pages but may be
446harder for people to read.
447@end defopt 378@end defopt
448 379
449@defopt remember-planner-timestamp-format 380@defopt remember-default-priority
450Format of timestamp for remember entries. 381The default priority for remembered mail messages.
451@end defopt 382@end defopt
452 383
453@file{remember-planner.el} does not define any interactive functions 384@node Org, , Mailbox, Backends
454or keybindings.
455
456@node Copying, GNU Free Documentation License, Backends, Top
457@comment node-name, next, previous, up 385@comment node-name, next, previous, up
458@appendix GNU GENERAL PUBLIC LICENSE 386@section Saving to an Org Mode file
459@include gpl.texi 387@cindex org mode, integration
388
389For instructions on how to integrate Remember with Org Mode,
390consult @ref{Remember, , , org}.
460 391
461@node GNU Free Documentation License, Concept Index, Copying, Top 392@node GNU Free Documentation License, Concept Index, Backends, Top
462@appendix GNU Free Documentation License 393@appendix GNU Free Documentation License
463@include doclicense.texi 394@include doclicense.texi
464 395