Guide to writing custom skip functions for agenda views using org-agenda-skip-function

Guide to writing custom skip functions for agenda views using org-agenda-skip-function

[Arunabha Ghosh]

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

Hi,
    Is there a guide on writing functions for implementing custom skip
criteria for agenda items using org-agenda-skip-function ? I understand the
basic premise behind org-agenda-skip-function but examples from other
people's configs don't make much sense.

What are the inputs to the skip function, there seem to be none. If so, how
do I figure out which entry is the skip function is being called on and how
do I evaluate predicates over that entry ? e.g. I'd like to have a skip
function that skips entries only if they are scheduled *in the future*. How
would I go about implementing such a function ?

Thanks,
Arunabha

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

Re: Guide to writing custom skip functions for agenda views using org-agenda-skip-function

[Sebastien Vauban]

Arunabha Ghosh wrote:
>     Is there a guide on writing functions for implementing custom skip
> criteria for agenda items using org-agenda-skip-function ? I understand the
> basic premise behind org-agenda-skip-function but examples from other
> people's configs don't make much sense.

Here some working examples extracted from my config:

--8<---------------cut here---------------start------------->8---
    ...
    (org-agenda-skip-function
     '(org-agenda-skip-entry-if 'notdeadline))
--8<---------------cut here---------------end--------------->8---

and

--8<---------------cut here---------------start------------->8---
    ...
    (org-agenda-skip-function
     '(org-agenda-skip-entry-when-regexp-matches))
    (org-agenda-skip-regexp "\\[#A\\]")))
--8<---------------cut here---------------end--------------->8---

A more complex one:

--8<---------------cut here---------------start------------->8---
  (add-to-list 'org-agenda-custom-commands
               `("r" "All active tasks, by due date"
                 ((agenda ""
                          ((org-agenda-overriding-header "Today")
                           ;; !FIXME! We don't see "timed" DEADLINE
                           (org-agenda-skip-function
                            (lambda ()
                              (let* ((dl (org-entry-get nil "DEADLINE")))
                                (if (or (not dl)
                                        (equal dl "")
                                        (org-time> dl (org-time-today)))
                                    (progn (outline-next-heading) (point))))))
                           (org-agenda-skip-scheduled-if-deadline-is-shown t)
                           (org-agenda-span 'day)
                           (org-deadline-warning-days 0))))))
--8<---------------cut here---------------end--------------->8---

Best regards,
  Seb

-- 
Sebastien Vauban