Nested consult-outline?

[mekeor]

I love using outline-minor-mode, especially in personal projects, where I define outline-regexp and outline-heading-alist as directory-local variables, which allows for structuring files into hierarchical sections and navigating them via consult-outline. That Consult command features narrowing down the candidates to a level. I suggest to add two more features here:

1. Show the candidates as nesting paths, that is breadcrumbs, just like consult-org-heading. I'd suggest to do so when a univeral prefix argument (C-u) is given.
2. Allow the regular expressions in outline-heading-alist to extract the relevant part of the heading by using an explicitely numbered group with a certain number (see (info "(elisp) Regexp Backslash")). E.g. if your heading regular expression matches ;;; Title, then you could extract the Title with a ;;; \(?1:.*\)$ or so.

What do you think?

[minad]

Hi, thanks for the proposals. Regarding your second proposal - are groups commonly used and documented for outline-regexp? If not, we should not add this here. I think the first proposal somehow relies on the second one, since otherwise we get too much noise when displaying the nested header?

[mekeor]

are groups commonly used and documented for outline-regexp?

I don't think so.

I think the first proposal somehow relies on the second one, since otherwise we get too much noise when displaying the nested header?

Yes, I agree.

[mekeor]

Should we close this discussion? I guess, the feature should be implemented in a separate package, given the circumstances?

[IceAsteroid]

Can consult-org-heading be achieved to not show prefixed parents of a sub-level candidate instead, but show asterisks to indicate levels, and if the search matches its parent, its sub-level headings also shows below it

In case if "consult-outline" doesn't do this

[okamsn]

You might be interested in this command from the Selectrum wiki:

https://github.com/radian-software/selectrum/wiki/Useful-Commands#jumping-to-outline-headings

I modified it for Consult, but I don't think that I added it to the Consult wiki. I will do that in a while.

[minad]

Yes, I've not forgotten the motivation. It sounds reasonable to add reversing the header as an option to consult-org-heading. Adding the stars is also not a bad idea since one can see the level right away.

[IceAsteroid]

Thank you for the understanding, should I open a standalone issue, or a discussion?

My skills on elisp are very limited, I'm now in the process of trying to understand consult's code.

I have two more requests:

• Inherit headings' properties including the colors, the stars(since they are changed by the use of org-superstar. If possible, the ancestors prefixed in a candidate should also have their own corresponding colors as in the org file.
• Inherit overlays that are added to the headings in the org file(if possible), only for the current heading, not also for the ancestors in a candidate to prevent visual pollution.

If you're willing to do it, please do. Otherwise I'll do it, but it takes time.

[IceAsteroid]

@minad, what do you think?

[minad]

Feel free to create a patch. Inheriting properties is automatic (if Org uses buffer-substring for extraction, similar to consult-line), but inheriting overlays is out of scope.

[IceAsteroid]

OK, glad to hear that. Thank you for the great work and patience as always. Take care :)