[patch] capture property table-line-pos can be a function

[patch] capture property table-line-pos can be a function

[Thomas Holst]

[-- Attachment #1: Type: text/plain, Size: 657 bytes --]

Hi,

for quite a while I have this patch in my local org-mode branch. Now I
find the time to share it.

Given a table with several sections and a capture template for entries
in this table. The sections are dynamic, so a static value for
table-line-pos does not help. With this patch table-line-pos can be:

- a string like "II-2"
- a varialbe containing a string
- or a function
  The function has to return a string which qualifies for table-line-pos

This serves me well and I am using it for more than one year now.

If you find it usefull then feel free to use it. I marked it as
TINYCHANGE, but I have signed FSF papers.

--
Bis neulich ...
  Thomas


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch for table-line-pos --]
[-- Type: text/x-diff, Size: 1138 bytes --]

From e5f906f20b796326e50057fa4fc21599368bd347 Mon Sep 17 00:00:00 2001
From: Thomas Holst <Thomas_Holst@gmx.de>
Date: Sat, 15 Mar 2014 16:22:44 +0100
Subject: [PATCH 1/2] capture: property `:table-line-pos' can be a function
 name, a string or a variable

* org-capture.el: If the value of `:table-line-pos' is a function name,
  its return valeue is used to determine the position inside the table.
  Return value must be a string like "II-3". Else `:table-line-pos' is
  'eval'ed.

  TINYCHANGE
---
 lisp/org-capture.el | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index e7f5e20..cf6c9e2 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -1149,6 +1149,9 @@ may have been stored before."
     ;; Check if the template is good
     (if (not (string-match org-table-dataline-regexp txt))
 	(setq txt "| %?Bad template |\n"))
+    (if (functionp table-line-pos)
+	(setq table-line-pos (funcall table-line-pos))
+      (setq table-line-pos (eval table-line-pos)))
     (cond
      ((and table-line-pos
 	   (string-match "\\(I+\\)\\([-+][0-9]\\)" table-line-pos))
-- 
1.7.9.5

Re: [patch] capture property table-line-pos can be a function

[Bastien]

Hi Thomas,

Thomas Holst <Thomas_Holst@gmx.de> writes:

> Given a table with several sections and a capture template for entries
> in this table. The sections are dynamic, so a static value for
> table-line-pos does not help. With this patch table-line-pos can be:
>
> - a string like "II-2"
> - a varialbe containing a string
> - or a function
>   The function has to return a string which qualifies for table-line-pos
>
> This serves me well and I am using it for more than one year now.

This sounds useful.  Could you also provide a patch for the
documentation?

Thanks in advance!

-- 
 Bastien

Re: [patch] capture property table-line-pos can be a function

[Thomas Holst]

Hi Bastien,

· Bastien <bzg@gnu.org> wrote:
> Thomas Holst <Thomas_Holst@gmx.de> writes:
>
>> Given a table with several sections and a capture template for entries
>> in this table. The sections are dynamic, so a static value for
>> table-line-pos does not help. With this patch table-line-pos can be:
>>
>> - a string like "II-2"
>> - a varialbe containing a string
>> - or a function
>>   The function has to return a string which qualifies for table-line-pos
>>
>> This serves me well and I am using it for more than one year now.
>
> This sounds useful.  Could you also provide a patch for the
> documentation?
>
> Thanks in advance!

thanks for looking into this. I will try to provide a patch for the
documentation in the next days.

-- 
Bis neulich ...
  Thomas

Re: [patch] capture property table-line-pos can be a function

[Thomas Holst]

[-- Attachment #1: Type: text/plain, Size: 736 bytes --]

Hi,
> Hi Bastien,
>
> · Bastien <bzg@gnu.org> wrote:
>> Thomas Holst <Thomas_Holst@gmx.de> writes:
>>
>>> Given a table with several sections and a capture template for entries
>>> in this table. The sections are dynamic, so a static value for
>>> table-line-pos does not help. With this patch table-line-pos can be:
>>>
>>> - a string like "II-2"
>>> - a varialbe containing a string
>>> - or a function
>>>   The function has to return a string which qualifies for table-line-pos
>>>
>>> This serves me well and I am using it for more than one year now.
>>
>> This sounds useful.  Could you also provide a patch for the
>> documentation?
>>
>> Thanks in advance!

ok here is the patch for documentation.

-- 
Bis neulich ...
  Thomas

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch for new fatures for table-line-pos --]
[-- Type: text/x-diff, Size: 1150 bytes --]

From 436e5adb0a9d0bc9ac37352bd90018c973dfdabf Mon Sep 17 00:00:00 2001
From: Thomas Holst <Thomas_Holst@gmx.de>
Date: Mon, 17 Mar 2014 09:01:40 +0100
Subject: [PATCH] docu change for table-line-pos new feature

* org.texi: document new features of `table-line-pos' in capture
templates
---
 doc/org.texi |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index b53b668..2bebae4 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -7095,9 +7095,10 @@ narrow it so that you only see the new material.
 
 @item :table-line-pos
 Specification of the location in the table where the new line should be
-inserted.  It should be a string like @code{"II-3"} meaning that the new
-line should become the third line before the second horizontal separator
-line.
+inserted. It can be a string, a variable holding a string or a function
+returning a string. The string should look like @code{"II-3"} meaning that
+the new line should become the third line before the second horizontal
+separator line.
 
 @item :kill-buffer
 If the target file was not yet visited when capture was invoked, kill the
-- 
1.7.9

Re: [patch] capture property table-line-pos can be a function

[Bastien]

Hi Thomas,

Thomas Holst <Thomas_Holst@gmx.de> writes:

> ok here is the patch for documentation.

Thanks -- can you read this page?
http://orgmode.org/worg/org-contribute.html#sec-5

There are advice on how to format the Changelog entry.

See in particular this list:

- Variables and functions names are quoted like `this' (backquote and
  single quote).
- Sentences should be separated by two spaces.
- Sentences should start with an uppercase letter.
- Avoid the passive form: i.e., use "change" instead of "changed". 

I know it's boring, but even more boring to fix this when we merge
Org with Emacs :)

Thanks in advance,

-- 
 Bastien

Re: [patch] capture property table-line-pos can be a function

[Thomas Holst]

[-- Attachment #1: Type: text/plain, Size: 890 bytes --]

Hi Bastien,

· Bastien <bzg@gnu.org> wrote:

> Thomas Holst <Thomas_Holst@gmx.de> writes:
>
>> ok here is the patch for documentation.
>
> Thanks -- can you read this page?
> http://orgmode.org/worg/org-contribute.html#sec-5
>
> There are advice on how to format the Changelog entry.
>
> See in particular this list:
>
> - Variables and functions names are quoted like `this' (backquote and
>   single quote).
> - Sentences should be separated by two spaces.
> - Sentences should start with an uppercase letter.
> - Avoid the passive form: i.e., use "change" instead of "changed". 
>
> I know it's boring, but even more boring to fix this when we merge
> Org with Emacs :)
>
> Thanks in advance,

I am sorry, I used =git format-patch= for the patches assuming all will
go well. Here are both patches with rewritten commit messages. Hopefully
I made them well.

-- 
Bis neulich ...
  Thomas

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch for :table-line-pos --]
[-- Type: text/x-diff, Size: 1229 bytes --]

From e5f906f20b796326e50057fa4fc21599368bd347 Mon Sep 17 00:00:00 2001
From: Thomas Holst <Thomas_Holst@gmx.de>
Date: Sat, 15 Mar 2014 16:22:44 +0100
Subject: [PATCH 1/2] capture: property `:table-line-pos' can be a function
 name, a string or a variable

org-capture.el: Implement new features for capture templates

* lisp/org-capture.el (org-capture-place-table-line): If the value of
`:table-line-pos' is a function name, its return value is used to
determine the position inside the table. Return value must be a string
like "II-3". Else `:table-line-pos' is 'eval'ed.

  TINYCHANGE
---
 lisp/org-capture.el | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index e7f5e20..cf6c9e2 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -1149,6 +1149,9 @@ may have been stored before."
     ;; Check if the template is good
     (if (not (string-match org-table-dataline-regexp txt))
 	(setq txt "| %?Bad template |\n"))
+    (if (functionp table-line-pos)
+	(setq table-line-pos (funcall table-line-pos))
+      (setq table-line-pos (eval table-line-pos)))
     (cond
      ((and table-line-pos
 	   (string-match "\\(I+\\)\\([-+][0-9]\\)" table-line-pos))
-- 
1.7.9.5


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: docu patch for :table-line-pos --]
[-- Type: text/x-diff, Size: 1212 bytes --]

From 436e5adb0a9d0bc9ac37352bd90018c973dfdabf Mon Sep 17 00:00:00 2001
From: Thomas Holst <Thomas_Holst@gmx.de>
Date: Mon, 17 Mar 2014 09:01:40 +0100
Subject: [PATCH] docu change for table-line-pos new feature

org.texi: Document new features for capture templates

* doc/org.texi: Document new features of `:table-line-pos' in capture
templates.

---
 doc/org.texi |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index b53b668..2bebae4 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -7095,9 +7095,10 @@ narrow it so that you only see the new material.
 
 @item :table-line-pos
 Specification of the location in the table where the new line should be
-inserted.  It should be a string like @code{"II-3"} meaning that the new
-line should become the third line before the second horizontal separator
-line.
+inserted. It can be a string, a variable holding a string or a function
+returning a string. The string should look like @code{"II-3"} meaning that
+the new line should become the third line before the second horizontal
+separator line.
 
 @item :kill-buffer
 If the target file was not yet visited when capture was invoked, kill the
-- 
1.7.9

Re: [patch] capture property table-line-pos can be a function

[Bastien]

Hi Thomas,

Thomas Holst <Thomas_Holst@gmx.de> writes:

> I am sorry, I used =git format-patch= for the patches assuming all will
> go well. Here are both patches with rewritten commit messages. Hopefully
> I made them well.

No problem -- the game now is to find the small differences between
your original patches and the ones I just committed :)

http://orgmode.org/cgit.cgi/org-mode.git/commit/?id=176125c3
http://orgmode.org/cgit.cgi/org-mode.git/commit/?id=599ccd1c

Thanks for this,

-- 
 Bastien

Re: [patch] capture property table-line-pos can be a function

[Thomas Holst]

Hi Bastien,
· Bastien <bzg@gnu.org> wrote:
> Hi Thomas,
>
> Thomas Holst <Thomas_Holst@gmx.de> writes:
>
>> I am sorry, I used =git format-patch= for the patches assuming all will
>> go well. Here are both patches with rewritten commit messages. Hopefully
>> I made them well.
>
> No problem -- the game now is to find the small differences between
> your original patches and the ones I just committed :)
>
> http://orgmode.org/cgit.cgi/org-mode.git/commit/?id=176125c3
> http://orgmode.org/cgit.cgi/org-mode.git/commit/?id=599ccd1c
>
> Thanks for this,
ok noticed the differences. Next time I'll be better :-)

Thank you for accepting the patch. Now my local branch in org-mode is
empty.

-- 
Bis neulich ...
  Thomas