From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Gabriel Santos Newsgroups: gmane.emacs.devel,gmane.emacs.orgmode Subject: Re: [RFC] The best way to choose an "action" at point: context-menu-mode, transient, which-key or embark? Date: Fri, 13 Dec 2024 19:09:21 -0300 Message-ID: <87a5cz8cby.fsf@disroot.org> References: <8734m28l9a.fsf@gmail.com> <871pzte929.fsf@localhost> <87v7x548ri.fsf@gmail.com> <87y120daue.fsf@localhost> <874j4m9ep6.fsf@gmail.com> <87h68gfqj1.fsf@localhost> <87pln3f3cc.fsf@localhost> <87jzd9ojj0.fsf@localhost> <87cyj0ajm9.fsf@gmail.com> <87zfm4s50x.fsf@localhost> <87wmh8s358.fsf@localhost> <87y11nwp9z.fsf@gmail.com> <87v7wd9a2h.fsf@localhost> <878qt7fbki.fsf@gmail.com> <87o71jwdxz.fsf@localhost> <87wmg6edr0.fsf@gmail.com> <87msgzh1dh.fsf@localhost> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1577"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org, emacs-orgmode@gnu.org To: Ihor Radchenko Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Dec 13 23:10:33 2024 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tMDrl-0000H0-1M for ged-emacs-devel@m.gmane-mx.org; Fri, 13 Dec 2024 23:10:33 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tMDqt-00017L-DZ; Fri, 13 Dec 2024 17:09:39 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tMDqq-00016f-R2; Fri, 13 Dec 2024 17:09:37 -0500 Original-Received: from layka.disroot.org ([178.21.23.139]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tMDqo-0004V3-8R; Fri, 13 Dec 2024 17:09:36 -0500 Original-Received: from mail01.disroot.lan (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id C69E4251E0; Fri, 13 Dec 2024 23:09:29 +0100 (CET) X-Virus-Scanned: SPAM Filter at disroot.org Original-Received: from layka.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavis, port 10024) with ESMTP id NyI2q0CjqHOK; Fri, 13 Dec 2024 23:09:25 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1734127765; bh=FzeoN4lYtOuLTVggljcVVNSjrDTdyhf2E0tukL9eFnM=; h=From:To:Cc:Subject:In-Reply-To:References:Date; b=e3Givu/SZRMopS3nKqVVGQhjBKxdSTFBGkwI3wDX9TDJFZH9z6jDokd971jxqulOm 8FVMTTZPvocnaoZ9VmVMt3Zx1sY57hiAxsH0xwBYm/LUzEYUGgYnBKVzAJG6Kb1Jc1 DEmAsy2J2mcR2X0vCeqO58ZlREY3i/BBhRIkMcfa9cJ197F6Huftz2vd8LfE4rAuoR yhvHrvyfaxSzueJOEyQ86Vwp2vRdIaLHHLIery8sWlLFi5ltQaQpfQu671Moa0Ib71 Wb92yFkdGDSxQj7QdsuY5AT7kciCynrQowFb5Y7w+AuLZrN0lnFI4lURHDsEN3KUqw Gm92L3z4u+I1w== In-Reply-To: <87msgzh1dh.fsf@localhost> (Ihor Radchenko's message of "Fri, 13 Dec 2024 18:41:14 +0000") Received-SPF: pass client-ip=178.21.23.139; envelope-from=gabrielsantosdesouza@disroot.org; helo=layka.disroot.org X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:326460 gmane.emacs.orgmode:164125 Archived-At: --=-=-= Content-Type: text/plain Content-Disposition: inline Greetings, I'll go through the examples found on this e-mail and suggest the menu command I find best for the proposed scenarios. Below is how I think these options could be used. context-menu-mode No particular target, should mostly be used for actions on the whole buffer or on a region, or all particular elements defined. Example: Org -> Headings -> Demote Headings transient Also no particular target, but should be used for commands that would require a menu for interaction, such as exporting and capturing. Example 1: org-export-*dispatch* -> transient menu Example 2: org-capture -> transient menu Example 3: org-attach -> transient menu which-key On a target, list actions that could be performed on it. embark Can be used to replace which-key in customization. But, despite saying this, I have it configured to use which-key as its menu. Ihor Radchenko writes: > I have raised the topic of refactoring Org mode menu systems during > EmacsConf in I saw the talk live, really excited for the future of Org! > The initial idea was replacing the self-written menu code in Org with > built-in transient.el. > > Later, during OrgMeetup a number of people raised concerns that > transient may sometimes be an overkill, and that some people may prefer > alternative UIs. In particular, embark and context-menu-mode were > mentioned. Personally, I'd prefer for built-in packages/functionality to be considered first. The consideration for context-menu for me is particularly intriguing, as there's a lot of functionality already included in Org's context menu. > (I am CCing the discussion participants and potentially interested > maintainers) Hope to see their responses to this. I'm just a common user, so my opinions should be taken with a grain of salt. > In Org mode (although not only in Org mode, looking at the success of > embark.el), we often have a UI model where users call an "action" > command (like org-ctrl-c-ctrl-c or org-open-at-point) followed by > interactive selection among multiple actions. I don't often use org-ctrl-c-ctrl-c, but now that I've seen the interaction menu for properties as an example, I'd say the best option for it would be which-key, as it's a simpler menu. > For example, org-open-at-point on a heading with multiple links inside > will raise a section buffer listing all the links - pressing a number > will open the corresponding link. I'd consider which-key again for this. > Another example (see the example patch below), which is a > work-in-progress patch for Org citation system, is "following" a > citation. To "follow" citation may mean multiple things including but > not limited to: (1) going to citation record in the bibliography file; > (2) following URL; (3) downloading .pdf file for a citation; etc. > **The list of "follow" actions may be customized by users** This is similar to the functions available in the following package: It also allows for opening the bibliography, links, notes, and files connected to the citation. I use it with embark: > The general UI flow in these scenarios will be: > > 1. User calls "action" with cursor at certain syntax element > 2. Action menu is displayed, showing the available actions/targets (dynamically built) > 3. User selects the action/target I'm not sure what the best option would be for displaying targets, but which-key should be able to cover most cases that would require "simpler" menus for actions. I'd also add in that it could be considered over transient if its dynamically built. I tend to associate transient with "static" options. > This UI flow can be implemented using context menus, which-key popups, > transient menus, and also using embark (where the way menu is displayed > can be customized). > > All the 4 approaches represent different UI models with various > strengths and weaknesses: > > - transient has a very flexible layout builder where the menu items can > be arranged granularly, but intercepts the main loop disrupting > certain keyboard-based workflows > - which-key does not stand on the way and integrates well into Emacs' > key binding model, but provides little flexibility for menu layout It has options for setting the pop-up type and position. Could this help with flexibility? > - embark stays in the middle between which-key and transient, making use > of transient keymaps and allowing a custom menu renderer > - context-menu-mode provides mouse experience > > I am wondering if we can work out some universal API to plug the > described action->menu->selection model into the UI that user prefers. I'd say that this is the best options out of all of them, but, as you said: > "I am wondering if we can work out [...]" This would require considerable work. > Tentatively, I am thinking about the following: > > For a given Emacs "prefix" command (e.g. org-open-at-point), we define a > set of customizations: > > 1. List of possible actions: ((name1 . action1 props) (name2 . action2 ...) ...) > PROPS is a plist defining extra properties like key-binding, display > string, maybe something else to be used in the future. > 2. Menu interface to use (transient, context-menu, embark, which-key) > 3. Layout settings for the specific interfaces. For example, transient > layout definition. > > WDYT? > > Best, > Ihor On this described state (list of actions), which-key would be the best option according to my definition. But, on the current state of org-open-at-point (shows more targets), as I commented previously, there's no menu that I associate with: "Act on target, display a list of other targets." Maybe context-menu would be the closest one, but I wouldn't consider which-key or embark, these are more related to functions. Regards, -- *Gabriel Santos* --=-=-=--