emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] Document custom org agenda functions


From: Ihor Radchenko
Subject: Re: [PATCH] Document custom org agenda functions
Date: Mon, 07 Nov 2022 08:13:36 +0000

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 via email to

[Prev in Thread] Current Thread [Next in Thread]