How to: start org outline navigation in special mode

[aspiwack]

When using org-goto (traditionally bound to C-c C-j) to navigate an Org document's outline, Boon immediately goes into command mode. However, the org-goto mode rebinds keys, in particular the arrows.

In order for the navigation mode to work well, I need to drop to insert mode. But really, it should open in special mode. Is there a way to make this outline navigation mode use the special mode ? If not, is there at least a way to make it start in insert mode?

[jyp]

I am away from computer at the moment. However if it is a major mode then you can customize the boon-special-modes variable. In fact, a PR would be appreciated. If it is not a major mode then I need some time to look at how to deal with that. Sent from my phone. -- JP

…

On Wed, Apr 25, 2018, 15:53 Arnaud Spiwack ***@***.***> wrote: When using org-goto (traditionally bound to C-c C-j) to navigate an Org document's outline, Boon immediately goes into command mode. However, the org-goto mode rebinds keys, in particular the arrows. In order for the navigation mode to work well, I need to drop to insert mode. But really, it should open in special mode. Is there a way to make this outline navigation mode use the special mode ? If not, is there at least a way to make it start in insert mode? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#34>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABsYxF9cRMpZHTz1ZFfn28jsw8BmeSgks5tsH_vgaJpZM4TjeEr> .

[aspiwack]

I don't think that it is a major mode, but I don't know how to check. If you can teach me what to look for, I'll do better next time :) .

[aspiwack]

All this is not urgent, of course.

[jyp]

If the buffer is not reloaded then it probably isn't a major mode. I am guessing that they have a minor mode which overloads the keys. This goes against Emacs convention and a transient keymap should be used instead. Anyway, I'll look at this in ten days when I am back to the computer.

…

On Wed, 25 Apr 2018, 16:38 Arnaud Spiwack, ***@***.***> wrote: All this is not urgent, of course. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#34 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABsYxyWNiSiUyxbkcnij1cjSD8nEiLSks5tsIqDgaJpZM4TjeEr> .

[aspiwack]

So. It seems to open a new buffer named org-goto. However, M-x describe-mode just tells me that the major mode is Org mode, and there is nothing specific in the minor mode list either.

[jyp]

org-goto is implemented using recursive edit https://www.gnu.org/software/emacs/manual/html_node/elisp/Recursive-Editing.html --- which is today discouraged. So the "proper" solution would be to reimplement org-goto using a transient keymap as I suggested above. Realistically this will never happen though.

A possible workaround would be to activate insert state whenever a recursive edit takes place. This would be roughly consistent with what happens with minibuffers.

[aspiwack]

Thanks for investigating. It was way over my head.

Going to the special state in recursive editing sounds reasonable in general.

What would be a good approach for it. It may be possible to add an advice to recursive-edit, but it sounds dangerous. Better is probably to check recursion-depth when editing starts, I suppose.

What is the portion of Boon which deals with choosing the mode and should be modified?

[jyp]

I am afraid that advising recursive-edit is the only sensible option. (One could perhaps instead use a post-command hook). In either case, one should call boon-set-state with the appropriate argument at the right places.

[aspiwack]

When entering org-goto from the edit state, we are sent into the command state again. So boon-set-state is called somewhere. Presumably by the function which is called on new buffers. A possibility would be to check recursion-depth there and if its non-zero, to set the state to special instead.

Here's a suggestion along these lines: modify boon-special-mode-p to always be true when recursion-depth is non-zero. Does it sound reasonable?

What is the recommended way to test a custom version of an emacs package. (there must be a way to start emacs with just said package, I just don't know how). So that I can test such change?

[jyp]

I am not sure if we should be using special state or insert state. In this case special state is better probably, but it may not be right in all cases. We could go for this and revisit the decision later (please add a comment to that effect).

Otherwise, I am guessing that this will not work, because the new buffer is probably be created before the recursive edit starts. You can try it, but I am pretty sure. If I am right then an advice or a command hook will be necessary.

To test a modified package, I usually just point use-package to my copy, but you may have to delete the copy in the .emacs.d/elpa directory.

[aspiwack]

Ok. So, I don't get what happens.

Entering org-goto triggers (boon-set-state 'command-state). And conversely exiting the recursive edit started by org-goto restores the state to the value it was before (including if I use exit-recursive-edit to exit).

However, when I call recursive-edit interactively, it doesn't change the state. And if I change the state in the recursive edit, then exit-recursive-edit, then the state isn't restored.

I don't know what can explain this difference.

[aspiwack]

Oh, I think I understand, now: a buffer named *org-goto* is built this way:

(make-indirect-buffer (current-buffer) "*org-goto*")

Is it reasonable to forget about recursive-edit and set it up so buffers name "org-mode" are boon-special-mode-p? (by adding list of buffer-names in addition to the list of modes?)

Otherwise, it's possible to build some trickery using advice on recursive-edit. But it feels a bit arbitrary, considering the fact that recursive-edit is a bit incidental here. I'm not sure what other use of recursive-edit there is out there (hopefully not many, as the manual explicitly says not to use it).

Anyway, I'm not sure which of these two alternatives is preferable. Or if there is a third option. Let me know what you think @jyp . I'll implement it.

[jyp]

Using the name of the buffer (with the stars) seems a good enough option. 👍

[jyp]

@aspiwack Perhaps you'll be better off simply using something like "counsel-org-goto" or similar.

[jyp]

The official way to go is using the 'cmap' package, which provide context-dependent functions, including navigation and tree-editing when on an org-mode heading. https://github.com/jyp/cmap