| blob | ffde24a93082e734bf3c3a97491d4745638ce67f |
1 ;;; org-remember.el --- Fast note taking in Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 6.00pre-1
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
30 ;; This file contains the system to take fast notes with Org-mode.
31 ;; This system is used together with John Wiegleys `remember.el'.
33 ;;; Code:
50 "Options concerning interaction with remember.el."
55 "Non-nil means, `C-c C-c' stores remember note without further promts.
56 In this case, you need `C-u C-c C-c' to get the prompts for
57 note file and headline.
58 When this variable is nil, `C-c C-c' give you the prompts, and
59 `C-u C-c C-c' trigger the fasttrack."
64 "The interface to be used for interactive filing of remember notes.
65 This is only used when the interactive mode for selecting a filing
66 location is used (see the variable `org-remember-store-without-prompt').
67 Allowed vaues are:
68 outline The interface shows an outline of the relevant file
69 and the correct heading is found by moving through
70 the outline or by searching with incremental search.
71 outline-path-completion Headlines in the current buffer are offered via
72 completion.
73 refile Use the refile interface, and offer headlines,
74 possibly from different buffers."
82 "The headline that should be the default location in the notes file.
83 When filing remember notes, the cursor will start at that position.
84 You can set this on a per-template basis with the variable
85 `org-remember-templates'."
90 "Templates for the creation of remember buffers.
91 When nil, just let remember make the buffer.
92 When not nil, this is a list of 5-element lists. In each entry, the first
93 element is the name of the template, which should be a single short word.
94 The second element is a character, a unique key to select this template.
95 The third element is the template.
97 The fourth element is optional and can specify a destination file for
98 remember items created with this template. The default file is given
99 by `org-default-notes-file'. If the file name is not an absolute path,
100 it will be interpreted relative to `org-directory'.
102 An optional fifth element can specify the headline in that file that should
103 be offered first when the user is asked to file the entry. The default
104 headline is given in the variable `org-remember-default-headline'.
106 An optional sixth element specifies the contexts in which the user can
107 select the template. This element can be either a list of major modes
108 or a function. `org-remember' will first check whether the function
109 returns `t' or if we are in any of the listed major modes, and select
110 the template accordingly.
112 The template specifies the structure of the remember buffer. It should have
113 a first line starting with a star, to act as the org-mode headline.
114 Furthermore, the following %-escapes will be replaced with content:
116 %^{prompt} Prompt the user for a string and replace this sequence with it.
117 A default value and a completion table ca be specified like this:
118 %^{prompt|default|completion2|completion3|...}
119 %t time stamp, date only
120 %T time stamp with date and time
121 %u, %U like the above, but inactive time stamps
122 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
123 You may define a prompt like %^{Please specify birthday}t
124 %n user name (taken from `user-full-name')
125 %a annotation, normally the link created with org-store-link
126 %i initial content, the region active. If %i is indented,
127 the entire inserted text will be indented as well.
128 %c content of the clipboard, or current kill ring head
129 %^g prompt for tags, with completion on tags in target file
130 %^G prompt for tags, with completion all tags in all agenda files
131 %:keyword specific information for certain link types, see below
132 %[pathname] insert the contents of the file given by `pathname'
133 %(sexp) evaluate elisp `(sexp)' and replace with the result
134 %! Store this note immediately after filling the template
136 %? After completing the template, position cursor here.
138 Apart from these general escapes, you can access information specific to the
139 link type that is created. For example, calling `remember' in emails or gnus
140 will record the author and the subject of the message, which you can access
141 with %:author and %:subject, respectively. Here is a complete list of what
142 is recorded for each link type.
144 Link type | Available information
145 -------------------+------------------------------------------------------
146 bbdb | %:type %:name %:company
147 vm, wl, mh, rmail | %:type %:subject %:message-id
148 | %:from %:fromname %:fromaddress
149 | %:to %:toname %:toaddress
151 gnus | %:group, for messages also all email fields
152 w3, w3m | %:type %:url
153 info | %:type %:file %:node
154 calendar | %:type %:date"
185 ;;;###autoload
187 "Setup remember.el for use wiht Org-mode."
193 ;;;###autoload
195 "Return a link to the current location as an annotation for remember.el.
196 If you are using Org-mode files as target for data storage with
197 remember.el, then the annotations should include a link compatible with the
198 conventions in Org-mode. This function returns such a link."
202 "Select a destination location for the note.
203 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
204 RET on headline -> Store as sublevel entry to current headline
205 RET at beg-of-buf -> Append to file as level 2 headline
211 ;; Save the major mode of the buffer we called remember from
214 ;; Temporary store the buffer where remember was called from
229 ;; Protect the user-defined function from error
231 tpl)))
232 org-remember-templates))
233 ;; If no template at this point, add the default templates:
237 org-remember-templates)
238 pre-selected-templates))
239 ;; Then unconditionnally add template for any contexts
242 org-remember-templates)
254 org-force-remember-template-char)
257 org-force-remember-template-char))
275 char0))))))
281 ;;;###autoload
283 "Initialize *remember* buffer with template, invoke `org-mode'.
284 This function should be placed into `remember-mode-hook' and in fact requires
285 to be run from that hook to function properly."
293 org-default-notes-file))
305 ;; `initial' and `annotation' are bound in `remember'
313 v-a))
316 org-time-was-given org-end-time-was-given x
317 prompt completions char time pos default histvar)
322 org-store-link-plist))
327 "## Filing location: Select interactively, default, or last used:
328 ## %s to select file and header location interactively.
339 ;; Simple %-escapes
350 t t))
352 ;; %[] Insert contents of a file.
363 filename error))))))
364 ;; %() embedded elisp
377 ;; From the property list
385 ;; Turn on org-mode in the remember buffer, set local variables
392 ;; Interactive template entries
405 "org-remember-template-prompt-history::"
416 'org-tags-completion-function nil nil nil
428 prompt))
437 completions nil nil nil histvar default)))))
451 "File remember note immediately.
452 This should be run in `post-command-hook' and will remove itself
453 from that hook."
460 "Finalize the remember process."
465 ;; FIXME: test this, this is w/o notetaking!
472 ;;;###autoload
474 "Call `remember'. If this is already a remember buffer, re-apply template.
475 If there is an active region, make sure remember uses it as initial content
476 of the remember buffer.
478 When called interactively with a `C-u' prefix argument GOTO, don't remember
479 anything, just go to the file/headline where the selected template usually
480 stores its notes. With a double prefix arg `C-u C-u', go to the last
481 note stored by remember.
483 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
484 associated with a template in `org-remember-templates'."
490 ;; set temporary variables that will be needed in
491 ;; `org-select-remember-template'
508 "Go to the location where the last remember note was stored."
514 "Go to the target location of a remember template.
515 The user is queried for the template."
521 visiting)
536 nil t)
540 ;;;###autoload
542 "Store stuff from remember.el into an org file.
543 First prompts for an org file. If the user just presses return, the value
544 of `org-default-notes-file' is used.
545 Then the command offers the headings tree of the selected file in order to
546 file the text at a specific location.
547 You can either immediately press RET to get the note appended to the
548 file, or you can use vertical cursor motion and visibility cycling (TAB) to
549 find a better place. Then press RET or <left> or <right> in insert the note.
551 Key Cursor position Note gets inserted
552 -----------------------------------------------------------------------------
553 RET buffer-start as level 1 heading at end of file
554 RET on headline as sublevel of the heading at cursor
555 RET no heading at cursor position, level taken from context.
556 Or use prefix arg to specify level manually.
557 <left> on headline as same level, before current heading
558 <right> on headline as same level, after current heading
560 So the fastest way to store the note is to press RET RET to append it to
561 the default file. This way your current train of thought is not
562 interrupted, in accordance with the principles of remember.el.
563 You can also get the fast execution without prompting by using
564 C-u C-c C-c to exit the remember buffer. See also the variable
565 `org-remember-store-without-prompt'.
567 Before being stored away, the function ensures that the text has a
569 is constructed from the current date and some additional data.
571 If the variable `org-adapt-indentation' is non-nil, the entire text is
572 also indented so that it starts in the same column as the headline
573 \(i.e. after the stars).
575 See also the variable `org-reverse-note-order'."
588 org-remember-store-without-prompt))
592 org-refile-targets)
593 org-default-notes-file)
595 org-remember-previous-location))
602 spos exitcmd level indent reversed)
606 fastp t))
610 ;; Modify text so that it becomes a nice subtree which can be inserted
611 ;; into an org tree.
613 first)
616 ;; Is already a headline
618 ;; We need to add a headline: Use time and first buffer line
628 lines)))
635 ;; Put the modified text back into the remember buffer, for refile.
643 ;; Find the file
656 ;; Find the default location
662 nil t)
670 ;; Ask the User for a location, using the appropriate interface
676 org-remember-help)
683 exitcmd 'return
687 ; not handle this note
694 ;; sublevel of current
709 ;; before current
713 ;; after current
720 ;; Put it at the end, one level below level 1
729 ;; Put it at the start, as level 1
738 ;; Put it right there, with automatic level determined by
739 ;; org-paste-subtree or from prefix arg
743 txt)))
752 "Call remember."
757 ;;; org-remember.el ends here