Added the template pre-selection feature.
See the new docstring of `org-remember-templates' for details. Documented the template pre-selection feature in org.texi.
This commit is contained in:
Bastien Guerry
parent
8b527d4a6d
commit
187ab7d599
63
org.el
63
org.el
|
|
@ -1544,6 +1544,14 @@ element can specify the headline in that file that should be offered
|
|||
first when the user is asked to file the entry. The default headline is
|
||||
given in the variable `org-remember-default-headline'.
|
||||
|
||||
An optional sixth element can specify the context in which the user should
|
||||
be able to select this template. If this element is a list of major modes,
|
||||
the template will only be available while invoking `org-remember' from a
|
||||
buffer in one of these modes. If it is a function, the template will only
|
||||
be selected if the function returns `t'. A value of `t' means select
|
||||
this template in any context. When the element is `nil', the template
|
||||
will be selected by default, i.e. when all contextual checks failed.
|
||||
|
||||
The template specifies the structure of the remember buffer. It should have
|
||||
a first line starting with a star, to act as the org-mode headline.
|
||||
Furthermore, the following %-escapes will be replaced with content:
|
||||
|
|
@ -1588,7 +1596,7 @@ w3, w3m | %:type %:url
|
|||
info | %:type %:file %:node
|
||||
calendar | %:type %:date"
|
||||
:group 'org-remember
|
||||
:get (lambda (var) ; Make sure all entries have 5 elements
|
||||
:get (lambda (var) ; Make sure all entries have at least 5 elements
|
||||
(mapcar (lambda (x)
|
||||
(if (not (stringp (car x))) (setq x (cons "" x)))
|
||||
(cond ((= (length x) 4) (append x '("")))
|
||||
|
|
@ -1597,7 +1605,7 @@ calendar | %:type %:date"
|
|||
(default-value var)))
|
||||
:type '(repeat
|
||||
:tag "enabled"
|
||||
(list :value ("" ?a "\n" nil nil)
|
||||
(list :value ("" ?a "\n" nil nil nil)
|
||||
(string :tag "Name")
|
||||
(character :tag "Selection Key")
|
||||
(string :tag "Template")
|
||||
|
|
@ -1606,7 +1614,13 @@ calendar | %:type %:date"
|
|||
(const :tag "Prompt for file" nil))
|
||||
(choice
|
||||
(string :tag "Destination headline")
|
||||
(const :tag "Selection interface for heading")))))
|
||||
(const :tag "Selection interface for heading"))
|
||||
(choice
|
||||
(const :tag "Use by default" nil)
|
||||
(const :tag "Use in all contexts" t)
|
||||
(repeat :tag "Use only if in major mode"
|
||||
(symbol :tag "Major mode"))
|
||||
(function :tag "Perform a check against function")))))
|
||||
|
||||
(defcustom org-reverse-note-order nil
|
||||
"Non-nil means, store new notes at the beginning of a file or entry.
|
||||
|
|
@ -13581,13 +13595,45 @@ RET at beg-of-buf -> Append to file as level 2 headline
|
|||
(defvar org-remember-previous-location nil)
|
||||
(defvar org-force-remember-template-char) ;; dynamically scoped
|
||||
|
||||
;; Save the major mode of the buffer we called remember from
|
||||
(defvar org-select-template-temp-major-mode nil)
|
||||
|
||||
;; Temporary store the buffer where remember was called from
|
||||
(defvar org-select-template-original-buffer nil)
|
||||
|
||||
(defun org-select-remember-template (&optional use-char)
|
||||
(when org-remember-templates
|
||||
(let* ((templates (mapcar (lambda (x)
|
||||
(let* ((pre-selected-templates
|
||||
(mapcar
|
||||
(lambda (tpl)
|
||||
(let ((ctxt (nth 5 tpl))
|
||||
(mode org-select-template-temp-major-mode)
|
||||
(buf org-select-template-original-buffer))
|
||||
(if (or (and (functionp ctxt)
|
||||
(save-excursion
|
||||
(set-buffer buf)
|
||||
;; Protect the user-defined function from error
|
||||
(condition-case nil (funcall ctxt) (error nil))))
|
||||
(and ctxt (listp ctxt)
|
||||
(delq nil (mapcar (lambda(x) (eq mode x)) ctxt))))
|
||||
tpl)))
|
||||
org-remember-templates))
|
||||
;; If no template at this point, add the default templates:
|
||||
(pre-selected-templates1
|
||||
(if (not (delq nil pre-selected-templates))
|
||||
(mapcar (lambda(x) (if (not (nth 5 x)) x))
|
||||
org-remember-templates)
|
||||
pre-selected-templates))
|
||||
;; Then unconditionnally add template for any contexts
|
||||
(pre-selected-templates2
|
||||
(append (mapcar (lambda(x) (if (eq (nth 5 x) t) x))
|
||||
org-remember-templates)
|
||||
(delq nil pre-selected-templates1)))
|
||||
(templates (mapcar (lambda (x)
|
||||
(if (stringp (car x))
|
||||
(append (list (nth 1 x) (car x)) (cddr x))
|
||||
(append (list (car x) "") (cdr x))))
|
||||
org-remember-templates))
|
||||
(delq nil pre-selected-templates2)))
|
||||
(char (or use-char
|
||||
(cond
|
||||
((= (length templates) 1)
|
||||
|
|
@ -13827,6 +13873,10 @@ associated with a template in `org-remember-templates'."
|
|||
((equal goto '(4)) (org-go-to-remember-target))
|
||||
((equal goto '(16)) (org-remember-goto-last-stored))
|
||||
(t
|
||||
;; set temporary variables that will be needed in
|
||||
;; `org-select-remember-template'
|
||||
(setq org-select-template-temp-major-mode major-mode)
|
||||
(setq org-select-template-original-buffer (current-buffer))
|
||||
(if (memq org-finish-function '(remember-buffer remember-finalize))
|
||||
(progn
|
||||
(when (< (length org-remember-templates) 2)
|
||||
|
|
@ -13850,7 +13900,8 @@ associated with a template in `org-remember-templates'."
|
|||
"Go to the target location of a remember template.
|
||||
The user is queried for the template."
|
||||
(interactive)
|
||||
(let* ((entry (org-select-remember-template template-key))
|
||||
(let* (org-select-template-temp-major-mode
|
||||
(entry (org-select-remember-template template-key))
|
||||
(file (nth 1 entry))
|
||||
(heading (nth 2 entry))
|
||||
visiting)
|
||||
|
|
|
|||
45
org.texi
45
org.texi
|
|
@ -4584,6 +4584,29 @@ file (if not present or @code{nil}) defaults to
|
|||
@code{org-default-notes-file}, the heading to
|
||||
@code{org-remember-default-headline}.
|
||||
|
||||
An optional sixth element can specify the context in which the user
|
||||
wants to be able to select this template. This element can be a list
|
||||
of major modes, in case the template will be available while invoking
|
||||
@code{org-remember} from a buffer in one of these modes. If it is a
|
||||
function, the template will only be selected if the function returns
|
||||
@code{t}. If this element is @code{t}, then the template will be
|
||||
selected in any context and if it is @code{nil} the template will
|
||||
be selected by default -- i.e. when all contextual checks failed.
|
||||
|
||||
So for example:
|
||||
|
||||
@example
|
||||
(setq org-remember-templates
|
||||
'(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks" (emacs-lisp-mode))
|
||||
("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" my-check)
|
||||
("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas" t)))
|
||||
@end example
|
||||
|
||||
The first template will only be available when invoking @code{org-remember}
|
||||
from an buffer in @code{emacs-lisp-mode}. The second template will only be
|
||||
available when the function @code{my-check} returns @code{t}. The third
|
||||
template will be proposed in any context.
|
||||
|
||||
When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember
|
||||
something, org will prompt for a key to select the template (if you have
|
||||
more than one template) and then prepare the buffer like
|
||||
|
|
@ -7024,16 +7047,14 @@ the two following forms:
|
|||
|
||||
@end lisp
|
||||
|
||||
In both cases, projects are configured by specifying property values. A
|
||||
project defines the set of files that will be published, as well as the
|
||||
publishing configuration to use when publishing those files. When a
|
||||
project takes the second form listed above, the individual members of
|
||||
the ``components'' property are taken to be components of the project,
|
||||
which group together files requiring different publishing options. When
|
||||
you publish such a ``meta-project'' all the components will also be
|
||||
published.
|
||||
|
||||
For now, components are not allowed to have components themselves.
|
||||
In both cases, projects are configured by specifying property values.
|
||||
A project defines the set of files that will be published, as well as
|
||||
the publishing configuration to use when publishing those files. When
|
||||
a project takes the second form listed above, the individual members
|
||||
of the ``components'' property are taken to be components of the
|
||||
project, which group together files requiring different publishing
|
||||
options. When you publish such a ``meta-project'' all the components
|
||||
will also publish.
|
||||
|
||||
@node Sources and destinations, Selecting files, Project alist, Configuration
|
||||
@subsection Sources and destinations for files
|
||||
|
|
@ -7074,10 +7095,6 @@ extension.
|
|||
@item @code{:include}
|
||||
@tab List of files to be included regardless of @code{:base-extension}
|
||||
and @code{:exclude}.
|
||||
|
||||
@item @code{:recursive}
|
||||
@tab When non-@code{nil}, the @code{:base-directory} will be recursively
|
||||
published.
|
||||
@end multitable
|
||||
|
||||
@node Publishing action, Publishing options, Selecting files, Configuration
|
||||
|
|
|
|||
Loading…
Reference in New Issue