emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Suvayu Ali <fatkasuvayu+linux@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: User Defined Functions in Agenda Views
Date: Sun, 22 Sep 2013 11:03:48 +0200	[thread overview]
Message-ID: <20130922090348.GF28580@kuru.dyndns-at-home.com> (raw)
In-Reply-To: <6F30E9CD-36ED-4281-BD6F-0D3B623393B9@pobox.com>

Hi Mike,

On Sat, Sep 21, 2013 at 02:18:47PM -0400, Mike McLean wrote:
> Hello
> 
> I looked at the doc string for ~org-agenda-custom-commands~ and noticed that the you can use a user-defined function as a valid command type. I did not find anything in the documentation that describes how that user-defined function should work, what it should do, or how to write one. I looked at the code for other agenda types, such as ~tags-todo~ and ~occur-tree~ and have guessed at how to form one of these.
> 
> I can write documentation and samples if anyone want it (either to add to Org documentation or as a page on Worg), but want to ensure that I understand completely and correctly, first.
> 

My understanding of the Agenda is not great so I'll point you to a Worg
page:

<http://orgmode.org/worg/org-tutorials/org-custom-agenda-commands.html>

If you think you can add to it, please go ahead.  That said, I think it
would be worthwhile to add some information on the expected function
signature in the docstring instead of just – "A user-defined function".

Hope this helps,

-- 
Suvayu

Open source is the future. It sets us free.

      reply	other threads:[~2013-09-22  9:04 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-09-21 18:18 User Defined Functions in Agenda Views Mike McLean
2013-09-22  9:03 ` Suvayu Ali [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20130922090348.GF28580@kuru.dyndns-at-home.com \
    --to=fatkasuvayu+linux@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).