bug#68824: treesitter support for outline-minor-mode

[Yuan Fu <casouri@gmail.com>]

> On Feb 11, 2024, at 11:22 AM, Eli Zaretskii <eliz@gnu.org> wrote:
> 
>> From: Juri Linkov <juri@linkov.net>
>> Cc: casouri@gmail.com,  68824@debbugs.gnu.org
>> Date: Sun, 11 Feb 2024 19:34:51 +0200
>> 
>>>>>> The problem is that the Info node in the ELisp manual would be too small.
>>>>>> I have no idea what to write in that node more than 10 lines from the
>>>>>> docstring of 'outline-search-function'.
>>>>> 
>>>>> Why does it have to be a separate node?  Why cannot we have a
>>>>> paragraph or two about this in "Tree-sitter Major Modes", for example,
>>>>> or in "Minor Modes"?
>>>> 
>>>> 'outline-search-function' is an internal detail of implementation
>>>> for 'treesit-outline-predicate'.  Here is the relevant part from the
>>>> previous patch that shows there is no place for 'outline-search-function:
>>> 
>>> Then maybe just move the text about outline-search-function to the
>>> place where you describe treesit-outline-predicate?
>> 
>> 'outline-search-function' is unsuitable for "Tree-sitter Major Modes".
> 
> All of this thread clearly indicates otherwise.

The real problem is probably that outline-minor-mode’s api wasn’t described in the Elisp manual (Imenu, OTOH, has a node in Elisp manual). I think we can create a node for outline in (elisp)Modes (that’s where the node for Imenu is). We can start out with only outline-search-function in there, and over time populate it with outline-level, outline-regexp, etc.

If in the future we add language-agnostic features similar to outline and imenu, which needs major mode integration, (elisp)Modes would be a good place to document them.

Yuan