Re: [O] Fixes for org-capture-templates-contexts
Hi Paul, Paul Sexton writes: > Bastien altern.org> writes: > >> If you can send a patch against master for this, I'd be happy to apply >> it! Thanks again for pointing to these problems, >> > > Below are patches against org.el and org-capture.el. I implemented the ability to check contexts against buffer names. Thanks for triggering this, -- Bastien
Re: [O] Fixes for org-capture-templates-contexts
Hi Paul,
Paul Sexton writes:
> Below are patches against org.el and org-capture.el.
it really helps to send patches with git format-patch, and to add a
ChangeLog... at least it speeds up the patch reviewing process for me!
> Are you sure it works correctly?
Yes -- please re-read the docstring:
'(("c" ((in-mode . "message-mode"
^^^^
Notice the parentheses here. Please have a go with this syntaxe and
let me know, but I tested again and it works for me.
If that's okay for you, I'm fine with just adding the
in-buffer/not-in-buffer feature.
Thanks!
--
Bastien
Re: [O] Fixes for org-capture-templates-contexts
Bastien altern.org> writes:
> If you can send a patch against master for this, I'd be happy to apply
> it! Thanks again for pointing to these problems,
>
Below are patches against org.el and org-capture.el.
Are you sure it works correctly? The following setting for the variable
does causes an error for me out of the box, but does work with the changes
in the patch.
(setq org-capture-templates-contexts
'(("f" (not-in-file . "\\(espanol\\|verbs\\|nouns\\)\\.org"))
("t" (not-in-file . "\\(espanol\\|verbs\\|nouns\\)\\.org"))
("e" (in-file . "\\(espanol\\|verbs\\|nouns\\)\\.org"))
("m" (in-file . "maths.*\\.org"))
("M" (in-file . "med\\.org"
Also, very important. I updated to master in order to make the patch and found
the current orgmode does not compile or even load. This is because
ob-eval.el uses 'declare-function' which is undefined (it is defined in
org-macs.el but ob-eval.el does not require that file).
--- ./org.el2013-01-15 10:54:43.0 +1300
+++ /Users/paul/org.el 2013-01-15 11:17:01.0 +1300
@@ -8682,9 +8682,11 @@
(while (setq c (pop a))
(let (vrules repl)
(cond
-((not (assoc (car c) contexts))
+((and (not (assoc (car c) contexts))
+ (not (assoc (string (elt (car c) 0)) contexts)))
(push c r))
-((and (assoc (car c) contexts)
+((and (or (assoc (car c) contexts)
+ (assoc (string (elt (car c) 0)) contexts))
(setq vrules (org-contextualize-validate-key
(car c) contexts)))
(mapc (lambda (vr)
@@ -8712,27 +8714,49 @@
(defun org-contextualize-validate-key (key contexts)
"Check CONTEXTS for agenda or capture KEY."
- (let (r rr res)
-(while (setq r (pop contexts))
- (mapc
- (lambda (rr)
-(when
- (and (equal key (car r))
- (if (functionp rr) (funcall rr)
-(or (and (eq (car rr) 'in-file)
- (buffer-file-name)
- (string-match (cdr rr) (buffer-file-name)))
-(and (eq (car rr) 'in-mode)
- (string-match (cdr rr) (symbol-name major-mode)))
-(when (and (eq (car rr) 'not-in-file)
- (buffer-file-name))
- (not (string-match (cdr rr) (buffer-file-name
-(when (eq (car rr) 'not-in-mode)
- (not (string-match (cdr rr) (symbol-name
major-mode)))
- (push r res)))
- (car (last r
+ (let (clause context res)
+(while (setq clause (pop contexts))
+ (let ((context-key (first clause))
+ (old-key (second clause))
+ (context-list (cddr clause)))
+(mapc
+ (lambda (context)
+ (when
+ (cond
+((and (>= (length context-key) (length key))
+ (not (equal key context-key)))
+ nil)
+((and (< (length context-key) (length key))
+ (not (string-prefix-p context-key key)))
+ nil)
+((functionp context)
+ (funcall context))
+(t
+ (let ((context-spec (first context))
+ (context-arg (rest context)))
+ (or (and (eq context-spec 'in-file)
+(buffer-file-name)
+(string-match context-arg
+ (buffer-file-name)))
+ (and (eq context-spec 'in-buffer)
+(string-match context-arg
+ (buffer-name)))
+ (and (eq context-spec 'in-mode)
+(eq context-arg major-mode))
+ (when (and (eq context-spec 'not-in-file)
+ (buffer-file-name))
+ (not (string-match context-arg
+(buffer-file-name
+ (and (eq context-spec 'not-in-buffer)
+(not (string-match context-arg
+ (buffer-name
+ (when (eq context-spec 'not-in-mode)
+ (not (eq context-arg major-mode)))
+ (push clause res)))
+ context-list)))
(delete-dups (delq nil res
+
(defun org-context-p (&rest contexts)
"Check if local context is any of CONTEXTS.
Possible values in the list of contexts are `table', `headline', and `item'."
--- ./org-capture.el2013-01-15 10:54:42.0 +1300
+++ /Users/paul/org-capture.el 2013-01-15 11:17:45.0 +1300
@@ -449,31 +449,63 @@
(defcustom org-capture-templates-contexts nil
"Alist of capture templates and valid contexts.
+Each entry in the alist takes the form:
+
Re: [O] Fixes for org-capture-templates-contexts
Hi Darlan,
Darlan Cavalcante Moreira writes:
> By a great coincidence I just discovered org-capture-templates-contexts
> yesterday but could not make it work yet (didn't have much time to
> investigate it).
Please try to customize `org-capture-templates-contexts' using the
customize interface. The docstring was giving wrong direction (it
is fixed in latest git though.)
> Is it possible to have capture templates that do not
> appear in any buffer but can be called from lisp?
(setq org-capture-templates-contexts
'(("c" ((not-in-mode . "emacs-lisp-mode")
> ps: this rule affecting all sub-templates will also be very userful.
+1!
HTH,
--
Bastien
Re: [O] Fixes for org-capture-templates-contexts
Hi Paul, Paul Sexton writes: > org-capture-templates-contexts currently appears not to work. Actually it works, but the docstring where misleading, I fixed them. > - new context specifiers in-buffer and not-in-buffer > - in-mode and not-in-mode expect a symbol, not a regexp. > - if a rule specifies a template that has 'sub-templates', those sub-templates > will also be affected by the rule. For example if you have templates 't', > 'ta', 'tb' and 'tc', you can specify a rule for 't' which will affect > all of them. If you can send a patch against master for this, I'd be happy to apply it! Thanks again for pointing to these problems, -- Bastien
Re: [O] Fixes for org-capture-templates-contexts
Hi Paul, Paul Sexton writes: > org-capture-templates-contexts currently appears not to work. The structure > that the function 'org-contextualize-validate-key' expects to find in the > variable seems quite different from the structure described in the docstring. indeed, there are some bugs here -- thanks for looking into this, and I'm glad people use/test capture templates. May I ask you to send me two patches, one with the fix and one with the new feature(e)? Also, please don't use destructuring-bind, I'd rather not use cl.el functions. Thanks for the (renewed) effort if you can, otherwise just let me know and I'll fix things myself. Best, -- Bastien
Re: [O] Fixes for org-capture-templates-contexts
By a great coincidence I just discovered org-capture-templates-contexts yesterday but could not make it work yet (didn't have much time to investigate it). Is it possible to have capture templates that do not appear in any buffer but can be called from lisp? The idea is that I'm implementing some org-capture templates right now that I only intend to call via "(org-capture nil 'some letter')" and never via "C-c c". Maybe today is my luck day and it is exactly this new "not-in-buffer" context you have just added? ps: this rule affecting all sub-templates will also be very userful. -- Darlan At Thu, 10 Jan 2013 21:04:54 + (UTC), Paul Sexton wrote: > > org-capture-templates-contexts currently appears not to work. The structure > that the function 'org-contextualize-validate-key' expects to find in the > variable seems quite different from the structure described in the docstring. > > Here are fixed versions of the functions 'org-contextualize-validate-key' > and 'org-contextualize-keys', both from org.el. I have also added some > functionality: > - new context specifiers in-buffer and not-in-buffer > - in-mode and not-in-mode expect a symbol, not a regexp. > - if a rule specifies a template that has 'sub-templates', those sub-templates > will also be affected by the rule. For example if you have templates 't', > 'ta', 'tb' and 'tc', you can specify a rule for 't' which will affect > all of them. > > I have also rewritten the docstring for org-capture-templates-contexts, > from org-capture.el. > > > > > (defcustom org-capture-templates-contexts nil > "Alist of capture templates and valid contexts. > > Each entry in the alist takes the form: >(KEY [USUAL-KEY] CONTEXT [CONTEXT...]) > > Where: >KEY :: a string of one or more letters, identifying a >capture template. >USUAL-KEY :: if supplied, this is the string that identifies >the capture template in `org-capture-templates', while KEY >becomes the string which will be used to select the >template only in the present context (see below). >CONTEXT :: a context definition. > > Each context definition (CONTEXT) takes the form: >FUNCTION >or (SPECIFIER . ARGUMENT) > > Where: >FUNCTION :: either a lambda form or a symbol naming a function. > The function must take no arguments. >SPECIFIER :: a symbol matching one of the context specifiers listed > below. >ARGUMENT :: either a string regular expression (for in-file and > in-buffer), or a symbol (for in-mode). > > Here are the available context specifiers: > > in-file: command displayed in files matching regex > in-buffer: command displayed in buffers matching regex > in-mode: command displayed if major mode matches symbol > not-in-file: command not displayed in files matching regex > not-in-buffer: command not displayed in buffers matching regex > not-in-mode: command not displayed when major mode matches symbol > > For example, if you have a capture template \"c\" and you want > this template to be accessible only from `message-mode' buffers, > use this: > >'((\"c\" (in-mode . message-mode))) > > If you include several context definitions, the agenda command > will be accessible if at least one of them is valid. > > If the template specified by KEY has sub-templates, they will also > be affected by the rule (unless they have their own rules). For > example, if you have a template `t' and sub-templates `ta', `tb' > and `tc', then a rule for `t' will affect whether all of those > contexts are accessible. > > You can also bind a key to another agenda custom command > depending on contextual rules. > > '((\"c\" \"d\" (in-file . \"\\.el$\") (in-buffer \"scratch\"))) > > Here it means: in files ending in `.el' and in buffers whose > name contains `scratch', use \"c\" as the > key for the capture template otherwise associated with \"d\". > \(The template originally associated with \"q\" is not displayed > to avoid duplicates.)" > :version "24.3" > :group 'org-capture > :type '(repeat (list :tag "Rule" > (string :tag "Capture key") > (string :tag "Replace by template") > (repeat :tag "Available when" > (choice > (cons :tag "Condition" >(choice > (const :tag "In file" in-file) > (const :tag "Not in file" not-in-file) > (const :tag "In mode" in-mode) > (const :tag "Not in mode" not-in-mode)) >(regexp)) > (function :tag "Custom function")) > > > (defun org-contextualize-validate-key (key contexts) > "Check CONTEXTS for agenda or capture KEY." > (let (clause context res) >
[O] Fixes for org-capture-templates-contexts
org-capture-templates-contexts currently appears not to work. The structure that the function 'org-contextualize-validate-key' expects to find in the variable seems quite different from the structure described in the docstring. Here are fixed versions of the functions 'org-contextualize-validate-key' and 'org-contextualize-keys', both from org.el. I have also added some functionality: - new context specifiers in-buffer and not-in-buffer - in-mode and not-in-mode expect a symbol, not a regexp. - if a rule specifies a template that has 'sub-templates', those sub-templates will also be affected by the rule. For example if you have templates 't', 'ta', 'tb' and 'tc', you can specify a rule for 't' which will affect all of them. I have also rewritten the docstring for org-capture-templates-contexts, from org-capture.el. (defcustom org-capture-templates-contexts nil "Alist of capture templates and valid contexts. Each entry in the alist takes the form: (KEY [USUAL-KEY] CONTEXT [CONTEXT...]) Where: KEY :: a string of one or more letters, identifying a capture template. USUAL-KEY :: if supplied, this is the string that identifies the capture template in `org-capture-templates', while KEY becomes the string which will be used to select the template only in the present context (see below). CONTEXT :: a context definition. Each context definition (CONTEXT) takes the form: FUNCTION or (SPECIFIER . ARGUMENT) Where: FUNCTION :: either a lambda form or a symbol naming a function. The function must take no arguments. SPECIFIER :: a symbol matching one of the context specifiers listed below. ARGUMENT :: either a string regular expression (for in-file and in-buffer), or a symbol (for in-mode). Here are the available context specifiers: in-file: command displayed in files matching regex in-buffer: command displayed in buffers matching regex in-mode: command displayed if major mode matches symbol not-in-file: command not displayed in files matching regex not-in-buffer: command not displayed in buffers matching regex not-in-mode: command not displayed when major mode matches symbol For example, if you have a capture template \"c\" and you want this template to be accessible only from `message-mode' buffers, use this: '((\"c\" (in-mode . message-mode))) If you include several context definitions, the agenda command will be accessible if at least one of them is valid. If the template specified by KEY has sub-templates, they will also be affected by the rule (unless they have their own rules). For example, if you have a template `t' and sub-templates `ta', `tb' and `tc', then a rule for `t' will affect whether all of those contexts are accessible. You can also bind a key to another agenda custom command depending on contextual rules. '((\"c\" \"d\" (in-file . \"\\.el$\") (in-buffer \"scratch\"))) Here it means: in files ending in `.el' and in buffers whose name contains `scratch', use \"c\" as the key for the capture template otherwise associated with \"d\". \(The template originally associated with \"q\" is not displayed to avoid duplicates.)" :version "24.3" :group 'org-capture :type '(repeat (list :tag "Rule" (string :tag "Capture key") (string :tag "Replace by template") (repeat :tag "Available when" (choice (cons :tag "Condition" (choice (const :tag "In file" in-file) (const :tag "Not in file" not-in-file) (const :tag "In mode" in-mode) (const :tag "Not in mode" not-in-mode)) (regexp)) (function :tag "Custom function")) (defun org-contextualize-validate-key (key contexts) "Check CONTEXTS for agenda or capture KEY." (let (clause context res) (while (setq clause (pop contexts)) (destructuring-bind (context-key old-key . context-list) clause (mapc (lambda (context) (when (cond ((and (>= (length context-key) (length key)) (not (equal key context-key))) nil) ((and (< (length context-key) (length key)) (not (string-prefix-p context-key key))) nil) ((functionp context) (funcall context)) (t (destructuring-bind (context-spec . context-arg) context (message "Considering context %s" context) (or (and (eq context-spec 'in-file) (buffer-file-name) (string-match contex
