Canonical way to check if an org file is an agenda file?

Canonical way to check if an org file is an agenda file?

[Tassilo Horn]

Hi all,

I use org files for anything I once used plain text files, so that I can
use all org features.

Unfortunately, for my agenda files I do some additional work.  For
example, I export my agenda files to iCalendar and show them with
KOrganizer.  And I update the list of appointments.

To do that, I add some functions to `after-save-hook' in org-mode
buffers, if that file is an agenda file.  But the test that checks if
`buffer-file-name' is an agenda file is very fragile and only matches my
current setup (`org-agenda-files' is a list of exactly one directory).

So is there a canonical way to check if a file is an agenda file,
something like `org-agenda-file-p'?

Argh, after writing this, I've discovered the function
`org-agenda-files', which can be used to write such a predicate.  So how
about something like this?

--8<---------------cut here---------------start------------->8---
(defun org-agenda-file-p (&optional file)
  "Return non-nil, if FILE is an agenda file.
If FILE is omitted, use the file associated with the current
buffer."
  (member (or file (buffer-file-name))
          (org-agenda-files t)))
--8<---------------cut here---------------end--------------->8---

If we agree that this is useful, I can wrap up a git patch this evening.
Of course, you can also add that code on your own and add a meaningful
log entry.

Bye,
Tassilo

Re: Canonical way to check if an org file is an agenda file?

[Carsten Dominik]

On May 25, 2010, at 3:14 PM, Tassilo Horn wrote:

> Hi all,
>
> I use org files for anything I once used plain text files, so that I  
> can
> use all org features.
>
> Unfortunately, for my agenda files I do some additional work.  For
> example, I export my agenda files to iCalendar and show them with
> KOrganizer.  And I update the list of appointments.
>
> To do that, I add some functions to `after-save-hook' in org-mode
> buffers, if that file is an agenda file.  But the test that checks if
> `buffer-file-name' is an agenda file is very fragile and only  
> matches my
> current setup (`org-agenda-files' is a list of exactly one directory).
>
> So is there a canonical way to check if a file is an agenda file,
> something like `org-agenda-file-p'?
>
> Argh, after writing this, I've discovered the function
> `org-agenda-files', which can be used to write such a predicate.  So  
> how
> about something like this?
>
> --8<---------------cut here---------------start------------->8---
> (defun org-agenda-file-p (&optional file)
>  "Return non-nil, if FILE is an agenda file.
> If FILE is omitted, use the file associated with the current
> buffer."
>  (member (or file (buffer-file-name))
>          (org-agenda-files t)))
> --8<---------------cut here---------------end--------------->8---
>
> If we agree that this is useful, I can wrap up a git patch this  
> evening.
> Of course, you can also add that code on your own and add a meaningful
> log entry.

Sure, this would be useful.

- Carsten

>
> Bye,
> Tassilo
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

- Carsten