emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: thecashewtrader <thecashewtrader@protonmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Document custom org agenda functions
Date: Mon, 07 Nov 2022 08:13:36 +0000	[thread overview]
Message-ID: <87mt93xjv3.fsf@localhost> (raw)
In-Reply-To: <20220405120728.12871-1-thecashewtrader@protonmail.com>

thecashewtrader <thecashewtrader@protonmail.com> writes:

> +* User Defined Functions
> +** Function Signature
> +User defined functions should:
> +
> +- Optionally accept one parameter i.e. the =match= variable. The Org agenda dispatch function will call the user-defined function with one parameter representing the =match= component from the agenda definition. In other words, ~(udf/test "Hello")~ in =org-agenda-custom-commands= will result in a function call of ~udf/test~ with an argument of ="Hello"=.
> +
> +- Prepare a buffer to write the agenda information to using ~org-agenda-prepare~.
> +
> +- Handle setting a unique buffer name for the cases where =org-agenda-sticky= has a value of =t=.
> +
> +- Honor the setting of =org-agenda-overriding-header= and insert that text into the agenda buffer. This can be done using the macro ~org-agenda--insert-overriding-header~.
> +
> +- Insert into the buffer the desired contents, accounting for also setting text properties.
> +
> +- Call ~org-agenda-finalize~ and ~(setq buffer-read-only t)~

Thanks for the patch, and sorry for the late reply.

I am not sure if this explanation is useful.

Yes, it kind of works and also inserts text into agenda. However, the
inserted text will not allow the usual agenda interaction. One would
also need to set various text properties pointing to an Org heading in
order to make the inserted lines interactive.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>


      reply	other threads:[~2022-11-07  8:14 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-05 12:08 [PATCH] Document custom org agenda functions thecashewtrader
2022-11-07  8:13 ` Ihor Radchenko [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=87mt93xjv3.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=thecashewtrader@protonmail.com \
    /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).