branch: externals/org
commit 85ed5be60f38335a035e2e8752e7280a6e704cd4
Author: Ihor Radchenko <[email protected]>
Commit: Ihor Radchenko <[email protected]>
org-agenda-prefix-format: Describe accurately where format is evaluated
* lisp/org-agenda.el (org-agenda-prefix-format): Fix incorrect
explanation introduced in 67922b8c0. Rather than being evaluated in
agenda buffer all the time, the behavior is more subtle.
Link: https://orgmode.org/list/[email protected]
---
lisp/org-agenda.el | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 0e7cfa5d3d..7849637aa2 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -1761,10 +1761,14 @@ meaning:
%s Scheduling/Deadline information, a short string
%b show breadcrumbs, i.e., the names of the higher levels
%(expression) Eval EXPRESSION and replace the control string
- by the result. EXPRESSION is evaluated with point
- in agenda buffer, not in the Org buffer. Use
- `org-agenda-with-point-at-orig-entry' if you need to
- move point to entry's position in Org buffer.
+ by the result.
+
+EXPRESSION is evaluated with point and buffer associated with agenda
+entry/line being rendered. For example, heading lines will be
+evaluated with point in the Org buffer at that corresponding heading.
+However, diary records will not be evaluated in an Org buffer, but
+inside diary buffer. Auxiliary agenda lines like time grids will be
+evaluated with the point inside agenda buffer itself.
All specifiers work basically like the standard `%s' of `format', but
may contain two additional characters: a question mark just after the
