diff options
| author | Michael Olson | 2007-10-30 01:53:49 +0000 |
|---|---|---|
| committer | Michael Olson | 2007-10-30 01:53:49 +0000 |
| commit | 7d3f6f1a283cf9ce4c54f5e479c1eefe7dd66d5c (patch) | |
| tree | 00b0f34986aed038973f3680db028a5cc8c91fec | |
| parent | 47cca554170c006e864bb707012546720b216158 (diff) | |
| download | emacs-7d3f6f1a283cf9ce4c54f5e479c1eefe7dd66d5c.tar.gz emacs-7d3f6f1a283cf9ce4c54f5e479c1eefe7dd66d5c.zip | |
Reorganize chapters in Remember Manual
| -rw-r--r-- | doc/misc/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/misc/remember.texi | 111 |
2 files changed, 63 insertions, 53 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 1c6edbf22dc..ed38f66f726 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,6 +1,9 @@ | |||
| 1 | 2007-10-30 Michael Olson <mwolson@gnu.org> | 1 | 2007-10-30 Michael Olson <mwolson@gnu.org> |
| 2 | 2 | ||
| 3 | * remember.texi: New file containing the Remember Mode Manual. | 3 | * remember.texi: New file containing the Remember Mode Manual. Shuffle |
| 4 | chapters around after initial import. | ||
| 5 | (Function Reference): Split Keystrokes into separate chapter. | ||
| 6 | (Keystrokes): Document C-c C-k. | ||
| 4 | 7 | ||
| 5 | 2007-10-29 Michael Albinus <michael.albinus@gmx.de> | 8 | 2007-10-29 Michael Albinus <michael.albinus@gmx.de> |
| 6 | 9 | ||
diff --git a/doc/misc/remember.texi b/doc/misc/remember.texi index 39f8b1e0d49..b65fb021a90 100644 --- a/doc/misc/remember.texi +++ b/doc/misc/remember.texi | |||
| @@ -55,8 +55,9 @@ Free Documentation License''. | |||
| 55 | * Installation:: How to install Remember. | 55 | * Installation:: How to install Remember. |
| 56 | * Implementation:: How Remember came into existence. | 56 | * Implementation:: How Remember came into existence. |
| 57 | * Quick Start:: Get started using Remember. | 57 | * Quick Start:: Get started using Remember. |
| 58 | * Backends:: Backends for saving notes. | ||
| 59 | * Function Reference:: Interactive functions in remember.el. | 58 | * Function Reference:: Interactive functions in remember.el. |
| 59 | * Keystrokes:: Keystrokes bound in Remember Mode. | ||
| 60 | * Backends:: Backends for saving notes. | ||
| 60 | * Copying:: The GNU General Public License gives you | 61 | * Copying:: The GNU General Public License gives you |
| 61 | permission to redistribute Remember on | 62 | permission to redistribute Remember on |
| 62 | certain terms; it also explains that | 63 | certain terms; it also explains that |
| @@ -188,7 +189,7 @@ rather than requiring a billion keystrokes to reorganize your | |||
| 188 | hierarchy. Well, as the future arrives, hopefully experience and user | 189 | hierarchy. Well, as the future arrives, hopefully experience and user |
| 189 | feedback will help to make this as intuitive a tool as possible. | 190 | feedback will help to make this as intuitive a tool as possible. |
| 190 | 191 | ||
| 191 | @node Quick Start, Backends, Implementation, Top | 192 | @node Quick Start, Function Reference, Implementation, Top |
| 192 | @comment node-name, next, previous, up | 193 | @comment node-name, next, previous, up |
| 193 | @chapter Quick Start | 194 | @chapter Quick Start |
| 194 | 195 | ||
| @@ -266,7 +267,61 @@ remember-annotation-functions. For example: | |||
| 266 | (call-interactively 'remember))) | 267 | (call-interactively 'remember))) |
| 267 | @end lisp | 268 | @end lisp |
| 268 | 269 | ||
| 269 | @node Backends, Function Reference, Quick Start, Top | 270 | @node Function Reference, Keystrokes, Quick Start, Top |
| 271 | @comment node-name, next, previous, up | ||
| 272 | @chapter Function Reference | ||
| 273 | |||
| 274 | @file{remember.el} defines the following interactive functions: | ||
| 275 | |||
| 276 | @defun remember initial | ||
| 277 | Remember an arbitrary piece of data. With a prefix, it will use the | ||
| 278 | region as @var{initial}. | ||
| 279 | @end defun | ||
| 280 | |||
| 281 | @defun remember-region beg end | ||
| 282 | If called from within the remember buffer, @var{beg} and @var{end} are | ||
| 283 | ignored, and the entire buffer will be remembered. If called from any | ||
| 284 | other buffer, that region, plus any context information specific to | ||
| 285 | that region, will be remembered. | ||
| 286 | @end defun | ||
| 287 | |||
| 288 | @defun remember-clipboard | ||
| 289 | Remember the contents of the current clipboard. This is most useful | ||
| 290 | for remembering things from Netscape or other X Windows applications. | ||
| 291 | @end defun | ||
| 292 | |||
| 293 | @defun remember-buffer | ||
| 294 | Remember the contents of the current buffer. | ||
| 295 | @end defun | ||
| 296 | |||
| 297 | @defun remember-mode | ||
| 298 | This enters the major mode for output from @command{remember}. This | ||
| 299 | buffer is used to collect data that you want remember. Just hit | ||
| 300 | @kbd{C-c C-c} when you're done entering, and it will go ahead and file | ||
| 301 | the data for latter retrieval, and possible indexing. | ||
| 302 | @end defun | ||
| 303 | |||
| 304 | @node Keystrokes, Backends, Function Reference, Top | ||
| 305 | @comment node-name, next, previous, up | ||
| 306 | @chapter Keystroke Reference | ||
| 307 | |||
| 308 | @file{remember.el} defines the following keybindings by default: | ||
| 309 | |||
| 310 | @table @kbd | ||
| 311 | |||
| 312 | @item C-c C-c (`remember-buffer') | ||
| 313 | Remember the contents of the current buffer. | ||
| 314 | |||
| 315 | @item C-c C-k (`remember-destroy') | ||
| 316 | Destroy the current *Remember* buffer. | ||
| 317 | |||
| 318 | @item C-x C-s (`remember-buffer') | ||
| 319 | Remember the contents of the current buffer. | ||
| 320 | |||
| 321 | @end table | ||
| 322 | |||
| 323 | @node Backends, Copying, Keystrokes, Top | ||
| 324 | @comment node-name, next, previous, up | ||
| 270 | @chapter Backends | 325 | @chapter Backends |
| 271 | 326 | ||
| 272 | You can save remembered notes to a variety of backends. | 327 | You can save remembered notes to a variety of backends. |
| @@ -399,55 +454,7 @@ Format of timestamp for remember entries. | |||
| 399 | @file{remember-planner.el} does not define any interactive functions | 454 | @file{remember-planner.el} does not define any interactive functions |
| 400 | or keybindings. | 455 | or keybindings. |
| 401 | 456 | ||
| 402 | @node Function Reference, Copying, Backends, Top | 457 | @node Copying, GNU Free Documentation License, Backends, Top |
| 403 | @comment node-name, next, previous, up | ||
| 404 | @chapter Function Reference | ||
| 405 | |||
| 406 | @subheading Interactive functions | ||
| 407 | |||
| 408 | @file{remember.el} defines the following interactive functions: | ||
| 409 | |||
| 410 | @defun remember initial | ||
| 411 | Remember an arbitrary piece of data. With a prefix, it will use the | ||
| 412 | region as @var{initial}. | ||
| 413 | @end defun | ||
| 414 | |||
| 415 | @defun remember-region beg end | ||
| 416 | If called from within the remember buffer, @var{beg} and @var{end} are | ||
| 417 | ignored, and the entire buffer will be remembered. If called from any | ||
| 418 | other buffer, that region, plus any context information specific to | ||
| 419 | that region, will be remembered. | ||
| 420 | @end defun | ||
| 421 | |||
| 422 | @defun remember-clipboard | ||
| 423 | Remember the contents of the current clipboard. This is most useful | ||
| 424 | for remembering things from Netscape or other X Windows applications. | ||
| 425 | @end defun | ||
| 426 | |||
| 427 | @defun remember-buffer | ||
| 428 | Remember the contents of the current buffer. | ||
| 429 | @end defun | ||
| 430 | |||
| 431 | @defun remember-mode | ||
| 432 | This enters the major mode for output from @command{remember}. This | ||
| 433 | buffer is used to collect data that you want remember. Just hit | ||
| 434 | @kbd{C-c C-c} when you're done entering, and it will go ahead and file | ||
| 435 | the data for latter retrieval, and possible indexing. | ||
| 436 | @end defun | ||
| 437 | |||
| 438 | @subheading Keystrokes | ||
| 439 | |||
| 440 | @file{remember.el} defines the following keybindings by default: | ||
| 441 | |||
| 442 | @table @kbd | ||
| 443 | |||
| 444 | @item C-x C-s (`remember-buffer') | ||
| 445 | |||
| 446 | @item C-c C-c (`remember-buffer') | ||
| 447 | |||
| 448 | @end table | ||
| 449 | |||
| 450 | @node Copying, GNU Free Documentation License, Function Reference, Top | ||
| 451 | @comment node-name, next, previous, up | 458 | @comment node-name, next, previous, up |
| 452 | @appendix GNU GENERAL PUBLIC LICENSE | 459 | @appendix GNU GENERAL PUBLIC LICENSE |
| 453 | @include gpl.texi | 460 | @include gpl.texi |