Re: [DISCUSSION] "quick-help" popup for org-columns (column view)

[Sławomir Grochowski]

chad <yandros@gmail.com> writes:

> If you don't mind me asking:

Thank you for sharing your views. 

> What are your high-level goals and immediate needs for changing
> help-quick?

I want to reuse quick-help for functionality in org-mode - column view
package. See first email in this thread - there is even a screenshot.

> It looks like you may be trying to have multiple
> simultaneous quick-help buffers active at once?

Philip Kaludercic <philipk@posteo.net> writes:

> Is there a reason not to re-use the same buffer?  I am not sure if we
> need multiple quick-help buffer to co-exist at the same time.

Yes you are right. There is no need to create multiple quick-help
buffers. 

> The idea here was that some other function could rebind
> `help-quick-sections' dynamically.  That way you avoid the redundant
> arguments (which would all have to be documented).

Is this really a good practice?
Relying on global variables instead of passing variables as a parameters?

I tried like this:

+(defun org-columns-help-quick-toggle ()
+  (interactive)
+  (let ((help-quick-sections org-columns-help-quick-sections))
+    (help-quick-toggle)))

So passing a 'sections' data works.
But it doesn't read keymaps from `org-columns-map'.
Because as I understand it read keymaps available only in the created buffer
"*Quick Help*" not from the buffer with org-colview.

This is the line from function: `help-quick' where it happens:
+ (let* ((bind (where-is-internal (car ent) nil t))
Signature:
(where-is-internal DEFINITION &optional KEYMAP FIRSTONLY NOINDIRECT NO-REMAP)

So previously I was passing a keymap `org-columns-map' to function 
'where-is-internal'.

Eli Zaretskii <eliz@gnu.org> writes:
> In any case, we cannot change the signature of help-quick, since it's a
> public function.

If I can't modify the function `help-quick' how can I make it work?

I'm attaching the whole patch:

>From dcc5172c87f9f7acfc9ab3a72f7de8b363a05447 Mon Sep 17 00:00:00 2001
From: Slawomir Grochowski <slawomir.grochowski@gmail.com>
Date: Sun, 7 Apr 2024 01:13:27 +0200
Subject: [PATCH] lisp/org-colview.el: add help-quick sections for org-colview

---
 lisp/org-colview.el | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/lisp/org-colview.el b/lisp/org-colview.el
index d71c84a76..547f50df8 100644
--- a/lisp/org-colview.el
+++ b/lisp/org-colview.el
@@ -169,6 +169,7 @@ See `org-columns-summary-types' for details.")
   (org-cycle-overview)
   (org-cycle-content))
 
+(org-defkey org-columns-map "?"        #'org-columns-help-quick-toggle)
 (org-defkey org-columns-map "c"        #'org-columns-content)
 (org-defkey org-columns-map "o"        #'org-overview)
 (org-defkey org-columns-map "e"        #'org-columns-edit-value)
@@ -231,6 +232,46 @@ See `org-columns-summary-types' for details.")
     "--"
     ["Quit" org-columns-quit t]))
 
+(defvar org-columns-help-quick-sections
+  '(("Move"
+     (org-columns-move-up . "up")
+     (org-columns-move-down . "down")
+     (org-columns-move-cursor-left . "left")
+     (org-columns-move-cursor-right . "right"))
+    ("Move column & row"
+     (org-columns-move-row-up . "move row up")
+     (org-columns-move-row-down . "move row down")
+     (org-columns-move-left . "move column left")
+     (org-columns-move-right . "move column right"))
+    ("Add & delete column"
+     (org-columns-new . "add column")
+     (org-columns-delete . "delete column"))
+    ("Edit column"
+     (org-columns-narrow . "narrow")
+     (org-columns-widen . "widen")
+     (org-columns-edit-attributes . "attributes"))
+    ("Edit values"
+     (org-columns-edit-value . "edit value")
+     (org-columns-edit-allowed . "edit allowed value")
+     (org-columns-next-allowed-value . "next allowed value")
+     (org-columns-previous-allowed-value . "previous allowed value")
+     (org-columns-toggle-or-columns-quit . "toggle checkbox or quit")
+     (org-columns-todo . "change TODO state"))
+    ("View"
+     (org-columns-content . "show content")
+     (org-overview . "show overview")
+     (org-columns-show-value . "show value"))
+    ("Misc."
+     (org-columns-open-link . "open link")
+     (org-columns-redo . "redo")
+     (org-columns-help-quick-toggle . "toggle this help")
+     (org-columns-quit . "quit"))))
+
+(defun org-columns-help-quick-toggle ()
+  (interactive)
+  (let ((help-quick-sections org-columns-help-quick-sections))
+    (help-quick-toggle)))
+
 (defun org-columns--displayed-value (spec value &optional no-star)
   "Return displayed value for specification SPEC in current entry.
 
-- 
2.30.2

Regards,

-- 
Slawomir Grochowski