Bulk function documentation is missing

Bulk function documentation is missing

[Bernt Hansen]

Hi Puneeth,

I just ran across the new Bulk action feature which applies a function
to the marked entries in the agenda.  There is no documentation for this
feature that I can find other than in the commit itself.

This functionality was added by you in 5b1b94a (* org-agenda.el
(org-agenda-bulk-action): Allow the user to run a function., 2011-03-08)

Could you please also provide documentation in org.texi with an example
of how you use this?

Thanks,
Bernt

Re: Bulk function documentation is missing

[Bastien]

Hi Bernt,

Bernt Hansen <bernt@norang.ca> writes:

> I just ran across the new Bulk action feature which applies a function
> to the marked entries in the agenda.  There is no documentation for this
> feature that I can find other than in the commit itself.

Look for org-agenda-bulk-* in the info manual, maybe through the index
(with `i' from the manual).  Documentation for bulk action is in "Agenda
commands".  

This section is really huge, so no wonder that this information is not
easily found.  

Maybe we should split it wisely.  Patch welcome!

-- 
 Bastien

Bulk function documentation is missing

[Puneeth Chaganti]

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

Hi,

I'd sent it to Bernt alone, on the previous occasion. Re-sending to
everyone. Sorry for the re-post, Bernt.

Hi Bernt,

On Fri, Apr 8, 2011 at 8:52 AM, Bernt Hansen <bernt@norang.ca>
[..]
> Could you please also provide documentation in org.texi with an example
> of how you use this?

I have attached a patch that documents this function. Please feel free
to improve it.

Thanks,
Puneeth

[-- Attachment #2: 0001-Document-option-to-allow-applying-a-function-as-Bulk.patch.txt --]
[-- Type: text/plain, Size: 1476 bytes --]

From 007f723e5bfd11b1d3c0efbb89b32f1955264314 Mon Sep 17 00:00:00 2001
From: Puneeth Chaganti <punchagan@gmail.com>
Date: Fri, 8 Apr 2011 11:23:31 +0530
Subject: [PATCH] Document option to allow applying a function as Bulk Agenda
 action

* doc/org.texi (Agenda commands): Doc for function option to bulk action.
---
 doc/org.texi |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 5ab25b0..d5c7b7b 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -8075,6 +8075,21 @@ s  @r{Schedule all items to a new date.  To shift existing schedule dates}
 S  @r{Reschedule randomly by N days.  N will be prompted for.  With prefix}
    @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
 d  @r{Set deadline to a specific date.}
+f  @r{Apply a function to marked entries.}
+   @r{For example, the function below sets the CATEGORY property of the}
+   @r{entries to web.}
+   @r{(defun set-category ()}
+   @r{  (interactive "P")}
+   @r{  (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
+   @r{                     (org-agenda-error)))}
+   @r{            (buffer (marker-buffer marker)))}
+   @r{       (with-current-buffer buffer}
+   @r{         (save-excursion}
+   @r{           (save-restriction}
+   @r{             (widen)}
+   @r{             (goto-char marker)}
+   @r{             (org-back-to-heading t)}
+   @r{             (org-set-property "CATEGORY" "web"))))))}
 @end example
 
 
-- 
1.7.4.4

Re: Bulk function documentation is missing

[Bernt Hansen]

Puneeth Chaganti <punchagan@gmail.com> writes:

> I'd sent it to Bernt alone, on the previous occasion. Re-sending to
> everyone. Sorry for the re-post, Bernt.
>
> Hi Bernt,
>
> On Fri, Apr 8, 2011 at 8:52 AM, Bernt Hansen <bernt@norang.ca>
> [..]
>> Could you please also provide documentation in org.texi with an example
>> of how you use this?
>
> I have attached a patch that documents this function. Please feel free
> to improve it.
>
> Thanks,
> Puneeth

Thanks Puneeth,

I haven't had time to look at it yet and didn't notice it wasn't also
posted to the list.  Don't worry about the repost :)


Bastien <bzg@altern.org> writes:

> Bernt Hansen <bernt@norang.ca> writes:
>
>> I just ran across the new Bulk action feature which applies a function
>> to the marked entries in the agenda.  There is no documentation for this
>> feature that I can find other than in the commit itself.
>
> Look for org-agenda-bulk-* in the info manual, maybe through the index
> (with `i' from the manual).  Documentation for bulk action is in "Agenda
> commands".  
>
> This section is really huge, so no wonder that this information is not
> easily found.  
>
> Maybe we should split it wisely.  Patch welcome!

Hi Bastien,

I did find the section in the manual about Bulk actions - just didn't
see 'f' documented anywhere (but maybe I missed it).

Regards,
Bernt

Re: Bulk function documentation is missing

[Bernt Hansen]

Puneeth Chaganti <punchagan@gmail.com> writes:

> I have attached a patch that documents this function. Please feel free
> to improve it.

This patch looks good to me.  Thanks Puneeth!

Regards,
Bernt

[Accepted] Bulk function documentation is missing

[Bastien Guerry]

Patch 741 (http://patchwork.newartisans.com/patch/741/) is now "Accepted".

Maintainer comment: none

This relates to the following submission:

http://mid.gmane.org/%3CBANLkTimyjyj%2BF8a%3DknRvFhK6HYRvR1ndVg%40mail.gmail.com%3E

Here is the original message containing the patch:

> Content-Type: text/plain; charset="utf-8"
> MIME-Version: 1.0
> Content-Transfer-Encoding: 7bit
> Subject: [O] Bulk function documentation is missing
> Date: Fri, 08 Apr 2011 22:04:09 -0000
> From: Puneeth Chaganti <punchagan@gmail.com>
> X-Patchwork-Id: 741
> Message-Id: <BANLkTimyjyj+F8a=knRvFhK6HYRvR1ndVg@mail.gmail.com>
> To: Bernt Hansen <bernt@norang.ca>, emacs-orgmode <emacs-orgmode@gnu.org>,
> 	Bastien <bzg@altern.org>
> Cc: 
> 
> Hi,
> 
> I'd sent it to Bernt alone, on the previous occasion. Re-sending to
> everyone. Sorry for the re-post, Bernt.
> 
> Hi Bernt,
> 
> On Fri, Apr 8, 2011 at 8:52 AM, Bernt Hansen <bernt@norang.ca>
> [..]
> > Could you please also provide documentation in org.texi with an example
> > of how you use this?
> 
> I have attached a patch that documents this function. Please feel free
> to improve it.
> 
> Thanks,
> Puneeth
> >From 007f723e5bfd11b1d3c0efbb89b32f1955264314 Mon Sep 17 00:00:00 2001
> From: Puneeth Chaganti <punchagan@gmail.com>
> Date: Fri, 8 Apr 2011 11:23:31 +0530
> Subject: [PATCH] Document option to allow applying a function as Bulk Agenda
>  action
> 
> * doc/org.texi (Agenda commands): Doc for function option to bulk action.
> 
> ---
> doc/org.texi |   15 +++++++++++++++
>  1 files changed, 15 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/org.texi b/doc/org.texi
> index 5ab25b0..d5c7b7b 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -8075,6 +8075,21 @@ s  @r{Schedule all items to a new date.  To shift existing schedule dates}
>  S  @r{Reschedule randomly by N days.  N will be prompted for.  With prefix}
>     @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
>  d  @r{Set deadline to a specific date.}
> +f  @r{Apply a function to marked entries.}
> +   @r{For example, the function below sets the CATEGORY property of the}
> +   @r{entries to web.}
> +   @r{(defun set-category ()}
> +   @r{  (interactive "P")}
> +   @r{  (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
> +   @r{                     (org-agenda-error)))}
> +   @r{            (buffer (marker-buffer marker)))}
> +   @r{       (with-current-buffer buffer}
> +   @r{         (save-excursion}
> +   @r{           (save-restriction}
> +   @r{             (widen)}
> +   @r{             (goto-char marker)}
> +   @r{             (org-back-to-heading t)}
> +   @r{             (org-set-property "CATEGORY" "web"))))))}
>  @end example
>  
>  
> 

Re: Bulk function documentation is missing

[Bastien]

Puneeth Chaganti <punchagan@gmail.com> writes:

> I have attached a patch that documents this function. Please feel free
> to improve it.

Applied, thanks!

-- 
 Bastien