emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Jan Rehders <jan@sheijk.net>
To: emacs-orgmode@gnu.org
Cc: Ihor Radchenko <yantar92@posteo.net>
Subject: Re: Contributing org-menu (using transient) to Orgmode?
Date: Mon, 25 Nov 2024 00:28:29 +0800	[thread overview]
Message-ID: <84EE7FC0-B04F-4413-9930-67C7BCF3B9F6@sheijk.net> (raw)
In-Reply-To: <87serh99dr.fsf@localhost>

> Your package appears somewhat similar to
> https://github.com/kickingvegas/casual-suite

Yes, only the speed commands like functionality seems to be less common for the casual packages. I even considered renaming it to casual-org before I saw that all the casual packages are by the same person

> Maybe. I am not 100% sure about generic menu functionality, but we do
> have something similar for org-goto (help window) and org-speed-commands
> (org-speed-command-help). Using transient instead of these ad-hoc help
> menus could be beneficial. In particular, integration with
> org-speed-commands can be very helpful.
> 
> More generally, we have previously discussed the idea of generic help
> menu for major modes. See https://list.orgmode.org/orgmode/87a5oayblv.fsf@gmail.com/
> I personally like the idea of some kind of help menu, but I have doubts
> that transient is best-suited for the task. Ideally, help menus should
> help with the existing key bindings rather than introducing brand
> new. AFAIK, transient _always_ introduces new bindings.

I think which-key has been added to Emacs, that one seems like a good fit

>> - should something in Orgmode also have the modal editing part
>>  integrated? For me that part is the most useful as I can use the
>>  transient for nearly all editing tasks and the move into the tasks
>>  for commands whose shortcuts I keep forgetting
> 
> org-speed-commands

org-menu works on many more elements than headings. Table cells, list items, dates, normal text formatting, etc. See the transient-insert-suffix 'org-menu at the end of the file following :if blocks for conditional enabling commands for various elements. This is as ad-hoc as Orgmodes keybinding overloads depending on context (which might also be a good thing to generalise it, like some commercial text editors did/do)

> 
>> - would this need to be made more modular and extensible so it's
>>  different parts could be moved into the respective Orgmode parts
>>  (like column view features, etc.)?
> 
> I do not have a full picture of what you have in mind wrt integration
> with Org upstream and about the structure of your package. So, I cannot
> tell much on this.

This is more or less what I want to find out. It mostly depends on what Orgmode maintainers think is most useful or how this should change.

I imagine splitting it into several files which follow Org’s existing structure might make sense as well as making it easier to add new parts to it. I don’t know how to best do that, yet.

> wrt column view, I have doubts that transient can be very useful -
> column view uses overlay keymaps while transients are global.

org-menu has support for column view. It’s the only way I’ve ever succeeded in using it w/o having to look up all the bindings, again.

>> I'd be open to contributing this to Emacs/Orgmode but I'd also be
>> happy to keep maintaining it as a separate package. Only thing I
>> would like to avoid would be to strip parts of it's functionality as
>> then I'd need to fork my own package
> 
> This part is not fully clear to me. Do you mean that you are only
> willing to upstream the whole package, but not parts of it?

I’m willing to upstream it in any way. But w/o the speed keys functionality I think I would kind of fork it again for my personal use. Or better yet use to be added extension hooks to re-add it



  reply	other threads:[~2024-11-24 16:29 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-17 13:33 Contributing org-menu (using transient) to Orgmode? Jan Rehders
2024-11-23 16:56 ` Ihor Radchenko
2024-11-24 16:28   ` Jan Rehders [this message]
  -- strict thread matches above, loose matches on Subject: below --
2024-11-18  8:40 Dilip via General discussions about Org-mode.
2024-11-18  8:45 Dilip via General discussions about Org-mode.

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=84EE7FC0-B04F-4413-9930-67C7BCF3B9F6@sheijk.net \
    --to=jan@sheijk.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@posteo.net \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public 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).