| blob | 65fb8617a097ea7fc76cfcded092a444afb46bdb |
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.04b
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 of the License, or
15 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the system to take fast notes with Org-mode.
29 ;; This system is used together with John Wiegleys `remember.el'.
31 ;;; Code:
48 "Options concerning interaction with remember.el."
53 "Non-nil means, `C-c C-c' stores remember note without further promts.
54 In this case, you need `C-u C-c C-c' to get the prompts for
55 note file and headline.
56 When this variable is nil, `C-c C-c' gives you the prompts, and
57 `C-u C-c C-c' triggers the fasttrack."
62 "The interface to be used for interactive filing of remember notes.
63 This is only used when the interactive mode for selecting a filing
64 location is used (see the variable `org-remember-store-without-prompt').
65 Allowed vaues are:
66 outline The interface shows an outline of the relevant file
67 and the correct heading is found by moving through
68 the outline or by searching with incremental search.
69 outline-path-completion Headlines in the current buffer are offered via
70 completion.
71 refile Use the refile interface, and offer headlines,
72 possibly from different buffers."
80 "The headline that should be the default location in the notes file.
81 When filing remember notes, the cursor will start at that position.
82 You can set this on a per-template basis with the variable
83 `org-remember-templates'."
88 "Templates for the creation of remember buffers.
89 When nil, just let remember make the buffer.
90 When non-nil, this is a list of 5-element lists. In each entry, the first
91 element is the name of the template, which should be a single short word.
92 The second element is a character, a unique key to select this template.
93 The third element is the template.
95 The fourth element is optional and can specify a destination file for
96 remember items created with this template. The default file is given
97 by `org-default-notes-file'. If the file name is not an absolute path,
98 it will be interpreted relative to `org-directory'.
100 An optional fifth element can specify the headline in that file that should
101 be offered first when the user is asked to file the entry. The default
102 headline is given in the variable `org-remember-default-headline'.
104 An optional sixth element specifies the contexts in which the user can
105 select the template. This element can be either a list of major modes
106 or a function. `org-remember' will first check whether the function
107 returns `t' or if we are in any of the listed major modes, and select
108 the template accordingly.
110 The template specifies the structure of the remember buffer. It should have
111 a first line starting with a star, to act as the org-mode headline.
112 Furthermore, the following %-escapes will be replaced with content:
114 %^{prompt} Prompt the user for a string and replace this sequence with it.
115 A default value and a completion table ca be specified like this:
116 %^{prompt|default|completion2|completion3|...}
117 %t time stamp, date only
118 %T time stamp with date and time
119 %u, %U like the above, but inactive time stamps
120 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
121 You may define a prompt like %^{Please specify birthday}t
122 %n user name (taken from `user-full-name')
123 %a annotation, normally the link created with org-store-link
124 %i initial content, the region active. If %i is indented,
125 the entire inserted text will be indented as well.
126 %c content of the clipboard, or current kill ring head
127 %^g prompt for tags, with completion on tags in target file
128 %^G prompt for tags, with completion all tags in all agenda files
129 %:keyword specific information for certain link types, see below
130 %[pathname] insert the contents of the file given by `pathname'
131 %(sexp) evaluate elisp `(sexp)' and replace with the result
132 %! Store this note immediately after filling the template
134 %? After completing the template, position cursor here.
136 Apart from these general escapes, you can access information specific to the
137 link type that is created. For example, calling `remember' in emails or gnus
138 will record the author and the subject of the message, which you can access
139 with %:author and %:subject, respectively. Here is a complete list of what
140 is recorded for each link type.
142 Link type | Available information
143 -------------------+------------------------------------------------------
144 bbdb | %:type %:name %:company
145 vm, wl, mh, rmail | %:type %:subject %:message-id
146 | %:from %:fromname %:fromaddress
147 | %:to %:toname %:toaddress
149 gnus | %:group, for messages also all email fields
150 w3, w3m | %:type %:url
151 info | %:type %:file %:node
152 calendar | %:type %:date"
181 "Non-nil means, stop the clock when exiting a clocking remember buffer.
182 This only applies if the clock is running in the remember buffer. If the
183 clock is not stopped, it continues to run in the storage location.
184 Instead of nil or t, this may also be the symbol `query' to prompt the
185 user each time a remember buffer with a running clock is filed away. "
196 ;;;###autoload
198 "Setup remember.el for use wiht Org-mode."
204 ;;;###autoload
206 "Return a link to the current location as an annotation for remember.el.
207 If you are using Org-mode files as target for data storage with
208 remember.el, then the annotations should include a link compatible with the
209 conventions in Org-mode. This function returns such a link."
213 "Select a destination location for the note.
214 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
215 RET on headline -> Store as sublevel entry to current headline
216 RET at beg-of-buf -> Append to file as level 2 headline
222 ;; Save the major mode of the buffer we called remember from
225 ;; Temporary store the buffer where remember was called from
240 ;; Protect the user-defined function from error
242 tpl)))
243 org-remember-templates))
244 ;; If no template at this point, add the default templates:
248 org-remember-templates)
249 pre-selected-templates))
250 ;; Then unconditionnally add template for any contexts
253 org-remember-templates)
265 org-force-remember-template-char)
268 org-force-remember-template-char))
286 char0))))))
290 "Get the value of the x clibboard, in a way that also works with XEmacs."
298 ;;;###autoload
300 "Initialize *remember* buffer with template, invoke `org-mode'.
301 This function should be placed into `remember-mode-hook' and in fact requires
302 to be run from that hook to function properly."
310 org-default-notes-file))
320 ;; `initial' and `annotation' are bound in `remember'
329 v-c)))
333 v-a))
336 org-time-was-given org-end-time-was-given x
337 prompt completions char time pos default histvar)
342 org-store-link-plist))
347 "## Filing location: Select interactively, default, or last used:
348 ## %s to select file and header location interactively.
359 ;; Simple %-escapes
370 t t))
372 ;; %[] Insert contents of a file.
383 filename error))))))
384 ;; %() embedded elisp
397 ;; From the property list
405 ;; Turn on org-mode in the remember buffer, set local variables
412 ;; Interactive template entries
425 "org-remember-template-prompt-history::"
436 'org-tags-completion-function nil nil nil
462 prompt))
471 completions nil nil nil histvar default)))))
485 "File remember note immediately.
486 This should be run in `post-command-hook' and will remove itself
487 from that hook."
494 "Finalize the remember process."
499 ;; the clock is running in this buffer.
510 ;;;###autoload
512 "Call `remember'. If this is already a remember buffer, re-apply template.
513 If there is an active region, make sure remember uses it as initial content
514 of the remember buffer.
516 When called interactively with a `C-u' prefix argument GOTO, don't remember
517 anything, just go to the file/headline where the selected template usually
518 stores its notes. With a double prefix arg `C-u C-u', go to the last
519 note stored by remember.
521 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
522 associated with a template in `org-remember-templates'."
528 ;; set temporary variables that will be needed in
529 ;; `org-select-remember-template'
549 "Go to the location where the last remember note was stored."
556 "Go to the target location of a remember template.
557 The user is queried for the template."
563 visiting)
578 nil t)
582 ;;;###autoload
584 "Store stuff from remember.el into an org file.
585 First prompts for an org file. If the user just presses return, the value
586 of `org-default-notes-file' is used.
587 Then the command offers the headings tree of the selected file in order to
588 file the text at a specific location.
589 You can either immediately press RET to get the note appended to the
590 file, or you can use vertical cursor motion and visibility cycling (TAB) to
591 find a better place. Then press RET or <left> or <right> in insert the note.
593 Key Cursor position Note gets inserted
594 -----------------------------------------------------------------------------
595 RET buffer-start as level 1 heading at end of file
596 RET on headline as sublevel of the heading at cursor
597 RET no heading at cursor position, level taken from context.
598 Or use prefix arg to specify level manually.
599 <left> on headline as same level, before current heading
600 <right> on headline as same level, after current heading
602 So the fastest way to store the note is to press RET RET to append it to
603 the default file. This way your current train of thought is not
604 interrupted, in accordance with the principles of remember.el.
605 You can also get the fast execution without prompting by using
606 C-u C-c C-c to exit the remember buffer. See also the variable
607 `org-remember-store-without-prompt'.
609 Before being stored away, the function ensures that the text has a
611 is constructed from the current date and some additional data.
613 If the variable `org-adapt-indentation' is non-nil, the entire text is
614 also indented so that it starts in the same column as the headline
615 \(i.e. after the stars).
617 See also the variable `org-reverse-note-order'."
629 org-remember-store-without-prompt))
633 org-refile-targets)
634 org-default-notes-file)
636 org-remember-previous-location))
643 spos exitcmd level reversed txt)
647 fastp t))
649 ;; Modify text so that it becomes a nice subtree which can be inserted
650 ;; into an org tree.
653 ;; remove empty lines at end
657 ;; add a headline
676 ;; Find the file
689 ;; Find the default location
695 nil t)
703 ;; Ask the User for a location, using the appropriate interface
709 org-remember-help)
716 exitcmd 'return
720 ; not handle this note
727 ;; sublevel of current
743 ;; before current
748 ;; after current
756 ;; Put it at the end, one level below level 1
766 ;; Put it at the start, as level 1
776 ;; Put it right there, with automatic level determined by
777 ;; org-paste-subtree or from prefix arg
780 txt)
795 "Call remember."
800 ;; arch-tag: 497f30d0-4bc3-4097-8622-2d27ac5f2698
802 ;;; org-remember.el ends here