From: thecashewtrader <thecashewtrader@protonmail.com>
To: emacs-orgmode@gnu.org
Cc: thecashewtrader <thecashewtrader@protonmail.com>
Subject: [PATCH] Document custom org agenda functions
Date: Tue, 05 Apr 2022 12:08:37 +0000 [thread overview]
Message-ID: <20220405120728.12871-1-thecashewtrader@protonmail.com> (raw)
---
org-tutorials/org-custom-agenda-commands.org | 40 +++++++++++++++++++-
1 file changed, 39 insertions(+), 1 deletion(-)
diff --git a/org-tutorials/org-custom-agenda-commands.org b/org-tutorials/org-custom-agenda-commands.org
index e54bcef3..5b55ebb5 100644
--- a/org-tutorials/org-custom-agenda-commands.org
+++ b/org-tutorials/org-custom-agenda-commands.org
@@ -64,7 +64,7 @@ command is a list consisting of the following:
(optional).
- 3) Type of search :: The desired agenda display/search. The options
include agenda, todo, search, tags, alltodo, tags-todo,
- todo-tree, tags-tree, occur-tree, or a user-defined function.
+ todo-tree, tags-tree, occur-tree, or a [[*User Defined Functions][user-defined function]].
- 4) Search term :: Depending on the type of search, this will be a
TODO keyword, a tag (or property), a word, or a
regular expression.
@@ -372,6 +372,44 @@ deadlines and nothing else.
Tip: if you want to exclude all agenda entry types, just set
=org-agenda-entry-types= to nil.
+* 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)~
+
+** Example
+This is a simple function to insert notes into the Agenda.
+
+*NOTE: This example is not fully complete as it doesn't respect =org-agenda-sticky=.*
+
+#+begin_src emacs-lisp
+
+(defun udf/org-agenda-notes (&optional arg)
+ (org-agenda-prepare "Notes")
+ (org-agenda--insert-overriding-header "Notes")
+ (let ((org-agenda-notes
+ (list "Note 1"
+ "Note 2"
+ "Note 3")))
+ (dolist (note org-agenda-notes)
+ (insert (format "- %s\n" note))))
+ (org-agenda-finalize)
+ (setq buffer-read-only t))
+
+#+end_src
+
+
* Other configuration ideas
This section is for additional ideas for configuring
--
2.35.1
reply other threads:[~2022-04-05 12:10 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20220405120728.12871-1-thecashewtrader@protonmail.com \
--to=thecashewtrader@protonmail.com \
--cc=emacs-orgmode@gnu.org \
--subject='Re: [PATCH] Document custom org agenda functions' \
/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
Code repositories for project(s) associated with this 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).