manipulating the agenda from elisp?

manipulating the agenda from elisp?

[Filippo A. Salustri]

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

Hi,
I'm thinking I might like to try some programming to do things to the agenda
from an elisp function.
I tried 'apropos agenda' but I didn't really see the kind of thing I'm
looking for.
What I'm hoping is for some way to iterate over each item in the agenda, and
be able to access the content of the item in some structured way.
I think I've seen functions that can pull info like TODO state and priority
from the item under the cursor, so it's the iteration part that I'm really
interested in.

Any advice?
Cheers.
Fil

-- 
Filippo A. Salustri, Ph.D., P.Eng.
Mechanical and Industrial Engineering
Ryerson University
350 Victoria St, Toronto, ON
M5B 2K3, Canada
Tel: 416/979-5000 ext 7749
Fax: 416/979-5265
Email: salustri@ryerson.ca
http://deseng.ryerson.ca/~fil/

[-- Attachment #2: Type: text/html, Size: 1035 bytes --]

Re: manipulating the agenda from elisp?

[Bernt Hansen]

"Filippo A. Salustri" <salustri@ryerson.ca> writes:

> Hi,
> I'm thinking I might like to try some programming to do things to the
> agenda from an elisp function.
> I tried 'apropos agenda' but I didn't really see the kind of thing
> I'm looking for.
> What I'm hoping is for some way to iterate over each item in the
> agenda, and be able to access the content of the item in some
> structured way.
> I think I've seen functions that can pull info like TODO state and
> priority from the item under the cursor, so it's the iteration part
> that I'm really interested in.
>
> Any advice?

Hi Fil,

I just found the B f code to execute an arbitrary function on marked
entries in the agenda.  Maybe this will help?

This following code visits the marked entries and just displays the
heading for the task.

Mark multiple entries in the agenda with 'm' and then 'B f bh/test RET'
should display the heading of each marked task in the *Messages* buffer.

--8<---------------cut here---------------start------------->8---
(defun bh/test ()
  (interactive)
  (let* ((marker (or (org-get-at-bol 'org-marker)
		     (org-agenda-error)))
	 (buffer (marker-buffer marker))
	 (pos (marker-position marker)))
    (with-current-buffer buffer
      (if (org-mode-p)
	  (save-excursion
	    (goto-char pos)
	    (message "%s" (nth 4 (org-heading-components))))))))
--8<---------------cut here---------------end--------------->8---

Depending on what you want to do you can either act on marked entries or
create a custom agenda skip function that can visit the tasks as the
agenda is built.

HTH,
Bernt

Re: manipulating the agenda from elisp?

[Filippo A. Salustri]

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

That's a good start!  Thanks!
Cheers.
Fil

On 7 April 2011 23:34, Bernt Hansen <bernt@norang.ca> wrote:

> "Filippo A. Salustri" <salustri@ryerson.ca> writes:
>
> > Hi,
> > I'm thinking I might like to try some programming to do things to the
> > agenda from an elisp function.
> > I tried 'apropos agenda' but I didn't really see the kind of thing
> > I'm looking for.
> > What I'm hoping is for some way to iterate over each item in the
> > agenda, and be able to access the content of the item in some
> > structured way.
> > I think I've seen functions that can pull info like TODO state and
> > priority from the item under the cursor, so it's the iteration part
> > that I'm really interested in.
> >
> > Any advice?
>
> Hi Fil,
>
> I just found the B f code to execute an arbitrary function on marked
> entries in the agenda.  Maybe this will help?
>
> This following code visits the marked entries and just displays the
> heading for the task.
>
> Mark multiple entries in the agenda with 'm' and then 'B f bh/test RET'
> should display the heading of each marked task in the *Messages* buffer.
>
> --8<---------------cut here---------------start------------->8---
> (defun bh/test ()
>  (interactive)
>  (let* ((marker (or (org-get-at-bol 'org-marker)
>                     (org-agenda-error)))
>         (buffer (marker-buffer marker))
>         (pos (marker-position marker)))
>    (with-current-buffer buffer
>      (if (org-mode-p)
>          (save-excursion
>            (goto-char pos)
>            (message "%s" (nth 4 (org-heading-components))))))))
> --8<---------------cut here---------------end--------------->8---
>
> Depending on what you want to do you can either act on marked entries or
> create a custom agenda skip function that can visit the tasks as the
> agenda is built.
>
> HTH,
> Bernt
>



-- 
Filippo A. Salustri, Ph.D., P.Eng.
Mechanical and Industrial Engineering
Ryerson University
350 Victoria St, Toronto, ON
M5B 2K3, Canada
Tel: 416/979-5000 ext 7749
Fax: 416/979-5265
Email: salustri@ryerson.ca
http://deseng.ryerson.ca/~fil/

[-- Attachment #2: Type: text/html, Size: 2843 bytes --]

Re: Re: manipulating the agenda from elisp?

[Nick Dokos]

Filippo A. Salustri <salustri@ryerson.ca> wrote:

> That's a good start!  Thanks!
> Cheers.
> Fil
> 
> On 7 April 2011 23:34, Bernt Hansen <bernt@norang.ca> wrote:
> 
>     "Filippo A. Salustri" <salustri@ryerson.ca> writes:
>    
>     > Hi,
>     > I'm thinking I might like to try some programming to do things to the
>     > agenda from an elisp function.
>     > I tried 'apropos agenda' but I didn't really see the kind of thing
>     > I'm looking for.
>     > What I'm hoping is for some way to iterate over each item in the
>     > agenda, and be able to access the content of the item in some
>     > structured way.
>     > I think I've seen functions that can pull info like TODO state and
>     > priority from the item under the cursor, so it's the iteration part
>     > that I'm really interested in.
>     >
>     > Any advice?
>    

Be sure to read the "Hacking" appendix in the org manual, in particular
"Using the property API" and "Using the mapping API".

Nick

>     Hi Fil,
>    
>     I just found the B f code to execute an arbitrary function on marked
>     entries in the agenda.  Maybe this will help?
>    
>     This following code visits the marked entries and just displays the
>     heading for the task.
>    
>     Mark multiple entries in the agenda with 'm' and then 'B f bh/test RET'
>     should display the heading of each marked task in the *Messages* buffer.
>    
>     --8<---------------cut here---------------start------------->8---
>     (defun bh/test ()
>      (interactive)
>      (let* ((marker (or (org-get-at-bol 'org-marker)
>                         (org-agenda-error)))
>             (buffer (marker-buffer marker))
>             (pos (marker-position marker)))
>        (with-current-buffer buffer
>          (if (org-mode-p)
>              (save-excursion
>                (goto-char pos)
>                (message "%s" (nth 4 (org-heading-components))))))))
>     --8<---------------cut here---------------end--------------->8---
>    
>     Depending on what you want to do you can either act on marked entries or
>     create a custom agenda skip function that can visit the tasks as the
>     agenda is built.
>    
>     HTH,
>     Bernt
> 
> --
> Filippo A. Salustri, Ph.D., P.Eng.
> Mechanical and Industrial Engineering
> Ryerson University
> 350 Victoria St, Toronto, ON
> M5B 2K3, Canada
> Tel: 416/979-5000 ext 7749
> Fax: 416/979-5265
> Email: salustri@ryerson.ca
> http://deseng.ryerson.ca/~fil/
> 
> 
> ----------------------------------------------------
> Alternatives:
> 
> ----------------------------------------------------

Re: Re: manipulating the agenda from elisp?

[Filippo A. Salustri]

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

Yup; I'd noticed those sections and noted them for future study.
Thanks.
Cheers.
Fil

On 8 April 2011 01:00, Nick Dokos <nicholas.dokos@hp.com> wrote:

> Filippo A. Salustri <salustri@ryerson.ca> wrote:
>
> > That's a good start!  Thanks!
> > Cheers.
> > Fil
> >
> > On 7 April 2011 23:34, Bernt Hansen <bernt@norang.ca> wrote:
> >
> >     "Filippo A. Salustri" <salustri@ryerson.ca> writes:
> >
> >     > Hi,
> >     > I'm thinking I might like to try some programming to do things to
> the
> >     > agenda from an elisp function.
> >     > I tried 'apropos agenda' but I didn't really see the kind of thing
> >     > I'm looking for.
> >     > What I'm hoping is for some way to iterate over each item in the
> >     > agenda, and be able to access the content of the item in some
> >     > structured way.
> >     > I think I've seen functions that can pull info like TODO state and
> >     > priority from the item under the cursor, so it's the iteration part
> >     > that I'm really interested in.
> >     >
> >     > Any advice?
> >
>
> Be sure to read the "Hacking" appendix in the org manual, in particular
> "Using the property API" and "Using the mapping API".
>
> Nick
>
> >     Hi Fil,
> >
> >     I just found the B f code to execute an arbitrary function on marked
> >     entries in the agenda.  Maybe this will help?
> >
> >     This following code visits the marked entries and just displays the
> >     heading for the task.
> >
> >     Mark multiple entries in the agenda with 'm' and then 'B f bh/test
> RET'
> >     should display the heading of each marked task in the *Messages*
> buffer.
> >
> >     --8<---------------cut here---------------start------------->8---
> >     (defun bh/test ()
> >      (interactive)
> >      (let* ((marker (or (org-get-at-bol 'org-marker)
> >                         (org-agenda-error)))
> >             (buffer (marker-buffer marker))
> >             (pos (marker-position marker)))
> >        (with-current-buffer buffer
> >          (if (org-mode-p)
> >              (save-excursion
> >                (goto-char pos)
> >                (message "%s" (nth 4 (org-heading-components))))))))
> >     --8<---------------cut here---------------end--------------->8---
> >
> >     Depending on what you want to do you can either act on marked entries
> or
> >     create a custom agenda skip function that can visit the tasks as the
> >     agenda is built.
> >
> >     HTH,
> >     Bernt
> >
> > --
> > Filippo A. Salustri, Ph.D., P.Eng.
> > Mechanical and Industrial Engineering
> > Ryerson University
> > 350 Victoria St, Toronto, ON
> > M5B 2K3, Canada
> > Tel: 416/979-5000 ext 7749
> > Fax: 416/979-5265
> > Email: salustri@ryerson.ca
> > http://deseng.ryerson.ca/~fil/
> >
> >
> > ----------------------------------------------------
> > Alternatives:
> >
> > ----------------------------------------------------
>



-- 
Filippo A. Salustri, Ph.D., P.Eng.
Mechanical and Industrial Engineering
Ryerson University
350 Victoria St, Toronto, ON
M5B 2K3, Canada
Tel: 416/979-5000 ext 7749
Fax: 416/979-5265
Email: salustri@ryerson.ca
http://deseng.ryerson.ca/~fil/

[-- Attachment #2: Type: text/html, Size: 4438 bytes --]

Re: Re: manipulating the agenda from elisp?

[Carsten Dominik]

On 8.4.2011, at 05:34, Bernt Hansen wrote:

> "Filippo A. Salustri" <salustri@ryerson.ca> writes:
> 
>> Hi,
>> I'm thinking I might like to try some programming to do things to the
>> agenda from an elisp function.
>> I tried 'apropos agenda' but I didn't really see the kind of thing
>> I'm looking for.
>> What I'm hoping is for some way to iterate over each item in the
>> agenda, and be able to access the content of the item in some
>> structured way.
>> I think I've seen functions that can pull info like TODO state and
>> priority from the item under the cursor, so it's the iteration part
>> that I'm really interested in.
>> 
>> Any advice?
> 
> Hi Fil,
> 
> I just found the B f code to execute an arbitrary function on marked
> entries in the agenda.  Maybe this will help?
> 
> This following code visits the marked entries and just displays the
> heading for the task.
> 
> Mark multiple entries in the agenda with 'm' and then 'B f bh/test RET'
> should display the heading of each marked task in the *Messages* buffer.
> 
> --8<---------------cut here---------------start------------->8---
> (defun bh/test ()
>  (interactive)
>  (let* ((marker (or (org-get-at-bol 'org-marker)
> 		     (org-agenda-error)))
> 	 (buffer (marker-buffer marker))
> 	 (pos (marker-position marker)))
>    (with-current-buffer buffer
>      (if (org-mode-p)
> 	  (save-excursion
> 	    (goto-char pos)
> 	    (message "%s" (nth 4 (org-heading-components))))))))
> --8<---------------cut here---------------end--------------->8---

Also useful can be

      (org-entry-properties marker)

Kind of slow for *many* entries, but perfectly good for a limited number...

- Carsten

Re: Re: manipulating the agenda from elisp?

[Filippo A. Salustri]

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

Thanks to everyone for the hints and tips.  It's much appreciated.
Cheers.
Fil

On 8 April 2011 12:59, Carsten Dominik <carsten.dominik@gmail.com> wrote:

>
> On 8.4.2011, at 05:34, Bernt Hansen wrote:
>
> > "Filippo A. Salustri" <salustri@ryerson.ca> writes:
> >
> >> Hi,
> >> I'm thinking I might like to try some programming to do things to the
> >> agenda from an elisp function.
> >> I tried 'apropos agenda' but I didn't really see the kind of thing
> >> I'm looking for.
> >> What I'm hoping is for some way to iterate over each item in the
> >> agenda, and be able to access the content of the item in some
> >> structured way.
> >> I think I've seen functions that can pull info like TODO state and
> >> priority from the item under the cursor, so it's the iteration part
> >> that I'm really interested in.
> >>
> >> Any advice?
> >
> > Hi Fil,
> >
> > I just found the B f code to execute an arbitrary function on marked
> > entries in the agenda.  Maybe this will help?
> >
> > This following code visits the marked entries and just displays the
> > heading for the task.
> >
> > Mark multiple entries in the agenda with 'm' and then 'B f bh/test RET'
> > should display the heading of each marked task in the *Messages* buffer.
> >
> > --8<---------------cut here---------------start------------->8---
> > (defun bh/test ()
> >  (interactive)
> >  (let* ((marker (or (org-get-at-bol 'org-marker)
> >                    (org-agenda-error)))
> >        (buffer (marker-buffer marker))
> >        (pos (marker-position marker)))
> >    (with-current-buffer buffer
> >      (if (org-mode-p)
> >         (save-excursion
> >           (goto-char pos)
> >           (message "%s" (nth 4 (org-heading-components))))))))
> > --8<---------------cut here---------------end--------------->8---
>
> Also useful can be
>
>       (org-entry-properties marker)
>
> Kind of slow for *many* entries, but perfectly good for a limited number...
>
> - Carsten
>
>


-- 
Filippo A. Salustri, Ph.D., P.Eng.
Mechanical and Industrial Engineering
Ryerson University
350 Victoria St, Toronto, ON
M5B 2K3, Canada
Tel: 416/979-5000 ext 7749
Fax: 416/979-5265
Email: salustri@ryerson.ca
http://deseng.ryerson.ca/~fil/

[-- Attachment #2: Type: text/html, Size: 3132 bytes --]

Re: manipulating the agenda from elisp?

[Bastien]

Hi Filippo,

"Filippo A. Salustri" <salustri@ryerson.ca> writes:

> I'm thinking I might like to try some programming to do things to the
> agenda from an elisp function.
> I tried 'apropos agenda' but I didn't really see the kind of thing
> I'm looking for.
> What I'm hoping is for some way to iterate over each item in the
> agenda, and be able to access the content of the item in some
> structured way.
> I think I've seen functions that can pull info like TODO state and
> priority from the item under the cursor, so it's the iteration part
> that I'm really interested in.

In an agenda, try `C-u C-x =' to see all the text properties at point.
You can grab a lot of information from these properties.

HTH,

-- 
 Bastien