How do I define `org-agenda-cmp-user-defined'?

How do I define `org-agenda-cmp-user-defined'?

[Alan Schmitt]

Hello,

I'm working on a way to schedule reviews of projects, and I would like
to have them ordered by age in an agenda view. It seems that I want to
write my own `org-agenda-cmp-user-defined' function to do so.
Unfortunately I cannot find an example of such a function.

More precisely, given this:

,-----------------------------------------------------------------
| (defun org-review-schedule-compare (a b)                        
|   "Compares the date of scheduled review for the two agenda     
|   entries. Returns +1 if A has been scheduled for longer, nil if
|   they have been scheduled for the same length of time, and -1  
|   otherwise."                                                   
|   ())                                                           
`-----------------------------------------------------------------

how can I access a property of `a' and `b'? (The documentation tells me
they are "agenda entries", but it's not clear how I can access their
information.)

Thanks a lot,

Alan

Re: How do I define `org-agenda-cmp-user-defined'?

[Bastien]

Hi Alan,

Alan Schmitt <alan.schmitt@polytechnique.org> writes:

> More precisely, given this:
>
> ,-----------------------------------------------------------------
> | (defun org-review-schedule-compare (a b)                        
> |   "Compares the date of scheduled review for the two agenda     
> |   entries. Returns +1 if A has been scheduled for longer, nil if
> |   they have been scheduled for the same length of time, and -1  
> |   otherwise."                                                   
> |   ())                                                           
> `-----------------------------------------------------------------
>
> how can I access a property of `a' and `b'?

See how `org-cmp-alpha' works.

> (The documentation tells me they are "agenda entries", but it's not
> clear how I can access their information.)

You can access agenda entries information by text properties.

Create an agenda view, then C-u C-x = on some entry: you will see
the list of available text properties that you can manipulate.

-- 
 Bastien

Re: How do I define `org-agenda-cmp-user-defined'?

[Alan Schmitt]

On 2014-04-18 15:21, Bastien <bzg@gnu.org> writes:

> Hi Alan,
>
> Alan Schmitt <alan.schmitt@polytechnique.org> writes:
>
>> More precisely, given this:
>>
>> ,-----------------------------------------------------------------
>> | (defun org-review-schedule-compare (a b)                        
>> |   "Compares the date of scheduled review for the two agenda     
>> |   entries. Returns +1 if A has been scheduled for longer, nil if
>> |   they have been scheduled for the same length of time, and -1  
>> |   otherwise."                                                   
>> |   ())                                                           
>> `-----------------------------------------------------------------
>>
>> how can I access a property of `a' and `b'?
>
> See how `org-cmp-alpha' works.

Thank you for the suggestion, this is good inspiration.

>> (The documentation tells me they are "agenda entries", but it's not
>> clear how I can access their information.)
>
> You can access agenda entries information by text properties.
>
> Create an agenda view, then C-u C-x = on some entry: you will see
> the list of available text properties that you can manipulate.

Thanks a lot, I'm able to get the information I need, thanks to
`org-marker' and `org-entry-get'.

Alan