Cycling first N heading levels in outline

Cycling first N heading levels in outline

[Christopher Dimech]

It would be helpful to have outline show the first N heading levels using
a keybinding that changes N after every hit (from N to N+1), then reversing
when it reaches the last heading (from N to N-1).

Re: Cycling first N heading levels in outline

[Ihor Radchenko]

> It would be helpful to have outline show the first N heading levels using
> a keybinding that changes N after every hit (from N to N+1), then reversing
> when it reaches the last heading (from N to N-1).

Could you provide an example use-case? It does not sound very useful for
me.

Best,
Ihor

Cycling first N heading levels in outline

[Christopher Dimech]

[-- Attachment #1: Type: text/plain, Size: 1049 bytes --]

It is useful for mathematical and scientific classification work.

I attach a texinfo file, where @usec, @usubsec, @usubsubsec are defined as headings.

You can use "Show Branches", "Show Children", and "Show Subtree".  But they all force
the user to move point to a specific heading, i.e. there are no operations which are global
across the buffer.

And it becomes more problematic for "Phylogenetic Trees" and "Geological Trees", particularly
when lists are long.

Regards
Christopher


> Sent: Sunday, May 23, 2021 at 4:48 PM
> From: "Ihor Radchenko" <yantar92@gmail.com>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> > It would be helpful to have outline show the first N heading levels using
> > a keybinding that changes N after every hit (from N to N+1), then reversing
> > when it reaches the last heading (from N to N-1).
>
> Could you provide an example use-case? It does not sound very useful for
> me.
>
> Best,
> Ihor
>

[-- Attachment #2: mtk-classif.texi --]
[-- Type: application/x-texinfo, Size: 446247 bytes --]

Re: Cycling first N heading levels in outline

[Ihor Radchenko]

Christopher Dimech <dimech@gmx.com> writes:

> It is useful for mathematical and scientific classification work.
>
> I attach a texinfo file, where @usec, @usubsec, @usubsubsec are defined as headings.
>
> You can use "Show Branches", "Show Children", and "Show Subtree".  But they all force
> the user to move point to a specific heading, i.e. there are no operations which are global
> across the buffer.

Hmm. Have you tried org-shifttab (bound to S-<TAB>)? It operates
globally across the buffer.

Also, there is outline-hide-sublevels. When called with prefix argument,
it will display sublevels from level 1 up until the level equal to the
prefix argument.

Best,
Ihor

Cycling first N heading levels in outline

[Christopher Dimech]

---------------------
Christopher Dimech
General Administrator - Naiad Informatics - GNU Project (Geocomputation)
- Geophysical Simulation
- Geological Subsurface Mapping
- Disaster Preparedness and Mitigation
- Natural Resource Exploration and Production
- Free Software Advocacy


> Sent: Sunday, May 23, 2021 at 9:46 PM
> From: "Ihor Radchenko" <yantar92@gmail.com>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> Christopher Dimech <dimech@gmx.com> writes:
>
> > It is useful for mathematical and scientific classification work.
> >
> > I attach a texinfo file, where @usec, @usubsec, @usubsubsec are defined as headings.
> >
> > You can use "Show Branches", "Show Children", and "Show Subtree".  But they all force
> > the user to move point to a specific heading, i.e. there are no operations which are global
> > across the buffer.
>
> Hmm. Have you tried org-shifttab (bound to S-<TAB>)? It operates
> globally across the buffer.

I rather keep things to outline-minor-mode than apply org functionality.  Originally,
Was using org-mode as the major buffer but that removed programming highlighting.

Outline should take care of such things itself rather than workarounds with org
functionality.

> Also, there is outline-hide-sublevels. When called with prefix argument,
> it will display sublevels from level 1 up until the level equal to the
> prefix argument.

But LEVELS defaults to the level of the *current heading* or to 1 if the
*current line is not a heading*.  This means I got to go to a heading.

The problem occurs for long files, because I am forces to navigate the file.
If the heading level is deep, it is difficult to search through.


> Best,
> Ihor
>
>

Re: Cycling first N heading levels in outline

[Ihor Radchenko]

Christopher Dimech <dimech@gmx.com> writes:

>> Hmm. Have you tried org-shifttab (bound to S-<TAB>)? It operates
>> globally across the buffer.
>
> I rather keep things to outline-minor-mode than apply org functionality.  Originally,
> Was using org-mode as the major buffer but that removed programming highlighting.
> Outline should take care of such things itself rather than workarounds with org
> functionality.

Sorry, I actually mixed this message with org mailing list because of
the contents. I initially though that you referred to org.

As for highlighting issue, please report is as a bug if you think that
Org does something wrongly.

>> Also, there is outline-hide-sublevels. When called with prefix argument,
>> it will display sublevels from level 1 up until the level equal to the
>> prefix argument.
>
> But LEVELS defaults to the level of the *current heading* or to 1 if the
> *current line is not a heading*.  This means I got to go to a heading.
>
> The problem occurs for long files, because I am forces to navigate the file.
> If the heading level is deep, it is difficult to search through.

Yet, with *numeric* prefix argument it will forcefully show all the
levels between 1 and number passed as prefix argument.

Best,
Ihor

Re: Cycling first N heading levels in outline

[Ihor Radchenko]

Christopher Dimech <dimech@gmx.com> writes:
>> Hmm. Have you tried org-shifttab (bound to S-<TAB>)? It operates
>> globally across the buffer.
>
> I rather keep things to outline-minor-mode than apply org functionality.  Originally,
> Was using org-mode as the major buffer but that removed programming highlighting.
>
> Outline should take care of such things itself rather than workarounds with org
> functionality.

Also, I just checked with outline-mode on Emacs master. S-<TAB> is bound
to outline-cycle-buffer, which is the equivalent of org-shifttab, but
native in outline-mode.

Best,
Ihor

Cycling first N heading levels in outline

[Christopher Dimech]

How can I use the outline.el code from master without installing the master
version, to try outline-cycle-buffer?

> Sent: Sunday, May 23, 2021 at 10:23 PM
> From: "Ihor Radchenko" <yantar92@gmail.com>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> Christopher Dimech <dimech@gmx.com> writes:
> >> Hmm. Have you tried org-shifttab (bound to S-<TAB>)? It operates
> >> globally across the buffer.
> >
> > I rather keep things to outline-minor-mode than apply org functionality.  Originally,
> > Was using org-mode as the major buffer but that removed programming highlighting.
> >
> > Outline should take care of such things itself rather than workarounds with org
> > functionality.
>
> Also, I just checked with outline-mode on Emacs master. S-<TAB> is bound
> to outline-cycle-buffer, which is the equivalent of org-shifttab, but
> native in outline-mode.
>
> Best,
> Ihor
>

Re: Cycling first N heading levels in outline

[Jean Louis]

* Christopher Dimech <dimech@gmx.com> [2021-05-23 11:59]:
> It is useful for mathematical and scientific classification work.
> 
> I attach a texinfo file, where @usec, @usubsec, @usubsubsec are defined as headings.
> 
> You can use "Show Branches", "Show Children", and "Show Subtree".  But they all force
> the user to move point to a specific heading, i.e. there are no operations which are global
> across the buffer.
> 
> And it becomes more problematic for "Phylogenetic Trees" and "Geological Trees", particularly
> when lists are long.

I just don't know how is it Org related... ☻ 

Org is not same as outline-minor-mode

-- 
Jean

Take action in Free Software Foundation campaigns:
https://www.fsf.org/campaigns

Sign an open letter in support of Richard M. Stallman
https://stallmansupport.org/

Re: Cycling first N heading levels in outline

[Ihor Radchenko]

Christopher Dimech <dimech@gmx.com> writes:

> How can I use the outline.el code from master without installing the master
> version, to try outline-cycle-buffer?

Download the master version of outline.el from [1], add its location in
front of your load-path, and (require 'outline) early in your config.

[1]  http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/outline.el

Re: Cycling first N heading levels in outline

[Jean Louis]

* Christopher Dimech <dimech@gmx.com> [2021-05-23 16:11]:
> 
> How can I use the outline.el code from master without installing the master
> version, to try outline-cycle-buffer?

Just M-x load-file 


-- 
Jean

Take action in Free Software Foundation campaigns:
https://www.fsf.org/campaigns

Sign an open letter in support of Richard M. Stallman
https://stallmansupport.org/

Cycling first N heading levels in outline

[Christopher Dimech]

> Sent: Monday, May 24, 2021 at 2:14 AM
> From: "Jean Louis" <bugs@gnu.support>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: "Ihor Radchenko" <yantar92@gmail.com>, emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> * Christopher Dimech <dimech@gmx.com> [2021-05-23 16:11]:
> >
> > How can I use the outline.el code from master without installing the master
> > version, to try outline-cycle-buffer?
>
> Just M-x load-file

What would happen with outline.el installed with emacs when I call a command?

> --
> Jean
>
> Take action in Free Software Foundation campaigns:
> https://www.fsf.org/campaigns
>
> Sign an open letter in support of Richard M. Stallman
> https://stallmansupport.org/
>

Re: Cycling first N heading levels in outline

[Ihor Radchenko]

Jean Louis <bugs@gnu.support> writes:
> I just don't know how is it Org related... ☻ 

When you have a hammer... (and I rarely use outline-minor-mode).

Re: Cycling first N heading levels in outline

[Jean Louis]

* Christopher Dimech <dimech@gmx.com> [2021-05-23 17:34]:
> > Just M-x load-file
> 
> What would happen with outline.el installed with emacs when I call a
> command?

Functions are overwritten in memory with new functions. If there are
many changes things can happen.

Best way to find out is to try to load the file.

Save your data before doing it, for safety. 😇	

-- 
Jean

Take action in Free Software Foundation campaigns:
https://www.fsf.org/campaigns

Sign an open letter in support of Richard M. Stallman
https://stallmansupport.org/

Re: Cycling first N heading levels in outline

[Jean Louis]

* Ihor Radchenko <yantar92@gmail.com> [2021-05-23 17:31]:
> Jean Louis <bugs@gnu.support> writes:
> > I just don't know how is it Org related... ☻ 
> 
> When you have a hammer... (and I rarely use outline-minor-mode).

Especially for Org users the outline-minor-mode is universal and gives
similar concepts of outline in various other modes:

- editing Asciidoctor files? Fold levels and sublevels

- editing Emacs Lisp? Fold levels, sections, functions and open it. It
  gives visual index of functions, it becomes very easy to move them
  from place to place;

- editing any kind of files in any mode? Define your headings yourself
  and cycle, fold, unfold.


-- 
Jean

Take action in Free Software Foundation campaigns:
https://www.fsf.org/campaigns

Sign an open letter in support of Richard M. Stallman
https://stallmansupport.org/

Cycling first N heading levels in outline

[Christopher Dimech]

Hi Jean, do you know how to have subheadings for elisp using outline-minor-mode?

> Sent: Monday, May 24, 2021 at 5:57 AM
> From: "Jean Louis" <bugs@gnu.support>
> To: "Ihor Radchenko" <yantar92@gmail.com>
> Cc: "Christopher Dimech" <dimech@gmx.com>, emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> * Ihor Radchenko <yantar92@gmail.com> [2021-05-23 17:31]:
> > Jean Louis <bugs@gnu.support> writes:
> > > I just don't know how is it Org related... ☻ 
> > 
> > When you have a hammer... (and I rarely use outline-minor-mode).
> 
> Especially for Org users the outline-minor-mode is universal and gives
> similar concepts of outline in various other modes:
> 
> - editing Asciidoctor files? Fold levels and sublevels
> 
> - editing Emacs Lisp? Fold levels, sections, functions and open it. It
>   gives visual index of functions, it becomes very easy to move them
>   from place to place;
> 
> - editing any kind of files in any mode? Define your headings yourself
>   and cycle, fold, unfold.
> 
> 
> -- 
> Jean
> 
> Take action in Free Software Foundation campaigns:
> https://www.fsf.org/campaigns
> 
> Sign an open letter in support of Richard M. Stallman
> https://stallmansupport.org/
>

Re: Cycling first N heading levels in outline

[Tassilo Horn]

Christopher Dimech <dimech@gmx.com> writes:

> Hi Jean, do you know how to have subheadings for elisp using outline-minor-mode?

FWIW, I use these outline settings which gives me 8 levels of outlines
in any programming mode where the outline headings start with the
comment started of the mode followed by one or more asterisks.

--8<---------------cut here---------------start------------->8---
(defun th/outline-minor-mode-prefix-init ()
  "Set `outline-minor-mode-prefix' for the current mode."
  (let ((comment-starter (if comment-start
                             (replace-regexp-in-string
                              "[[:space:]]+" "" comment-start)
                           "")))
    (setq comment-starter (replace-regexp-in-string "*" "[*]" comment-starter))
    ;; Just because ;;* looks better than ;* and won't be indented.
    (when (string= comment-starter ";")
      (setq comment-starter ";;"))
    (when (eq major-mode 'bibtex-mode)
      (setq comment-starter (if (eq bibtex-dialect 'biblatex)
                                "%"
                              "")))
    (setq-local outline-minor-mode-prefix
                (concat "^\\(?:" (regexp-quote comment-starter) "\\)"))))

(defun th/outline-minor-mode-init ()
  (th/outline-minor-mode-prefix-init)
  (setq-local outline-regexp (concat outline-minor-mode-prefix "[*]+"))

  (font-lock-add-keywords
   nil
   `((,(concat outline-minor-mode-prefix "[*] .*$")                      0 'org-level-1 t)
     (,(concat outline-minor-mode-prefix "[*][*] .*$")                   0 'org-level-2 t)
     (,(concat outline-minor-mode-prefix "[*][*][*] .*$")                0 'org-level-3 t)
     (,(concat outline-minor-mode-prefix "[*][*][*][*] .*$")             0 'org-level-4 t)
     (,(concat outline-minor-mode-prefix "[*][*][*][*][*] .*$")          0 'org-level-5 t)
     (,(concat outline-minor-mode-prefix "[*][*][*][*][*][*] .*$")       0 'org-level-6 t)
     (,(concat outline-minor-mode-prefix "[*][*][*][*][*][*][*] .*$")    0 'org-level-7 t)
     (,(concat outline-minor-mode-prefix "[*][*][*][*][*][*][*][*] .*$") 0 'org-level-8 t))))

(add-hook 'outline-minor-mode-hook #'th/outline-minor-mode-init)

(defvar th/outline-minor-mode-modes
  '(c-mode c++-mode java-mode emacs-lisp-mode lisp-mode ruby-mode haskell-mode
           lua-mode clojure-mode python-mode sh-mode bibtex-mode restclient-mode
           TeX-mode LaTeX-mode))

(dolist (mode th/outline-minor-mode-modes)
  (add-hook (intern (concat (symbol-name mode) "-hook")) #'outline-minor-mode))
--8<---------------cut here---------------end--------------->8---

So in elisp I write:

;;* Top Level Heading
;;** 2nd Level Heading
;;*** 3rd Level Heading

Bye,
Tassilo

Re: Cycling first N heading levels in outline

[Stefan Monnier]

> Hi Jean, do you know how to have subheadings for elisp using outline-minor-mode?

The convention used in ELisp is:

   ;;; Section
   ;;;; Subsection
   ;;;;; Subsubsection
   ;;;;;; Subsubsubsection
   ;;;;;;; Subsubsubsubsection
   [...]


-- Stefan

Cycling first N heading levels in outline

[Christopher Dimech]

> Sent: Monday, May 24, 2021 at 7:55 AM
> From: "Stefan Monnier" <monnier@iro.umontreal.ca>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: "Jean Louis" <bugs@gnu.support>, "Ihor Radchenko" <yantar92@gmail.com>, emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> > Hi Jean, do you know how to have subheadings for elisp using outline-minor-mode?
>
> The convention used in ELisp is:
>
>    ;;; Section
>    ;;;; Subsection
>    ;;;;; Subsubsection
>    ;;;;;; Subsubsubsection
>    ;;;;;;; Subsubsubsubsection
>    [...]

The headings still look like comments, whereas they are supposed to get highlighted
according to the heading level.

Could we get that to work in said way?

Regards
Christopher

> -- Stefan
>
>

Cycling first N heading levels in outline

[Christopher Dimech]

I have looked at how functions are folded.  But if you call elisp code (which
always involves using parentheses) they also get to be interpreted as headings.

Can this be fixed please, so that only elisp structure constructs are interpreted
as headlines [e.g. "(defun" "(defvar"].

Regards
Christopher

> Sent: Monday, May 24, 2021 at 7:55 AM
> From: "Stefan Monnier" <monnier@iro.umontreal.ca>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: "Jean Louis" <bugs@gnu.support>, "Ihor Radchenko" <yantar92@gmail.com>, emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> > Hi Jean, do you know how to have subheadings for elisp using outline-minor-mode?
>
> The convention used in ELisp is:
>
>    ;;; Section
>    ;;;; Subsection
>    ;;;;; Subsubsection
>    ;;;;;; Subsubsubsection
>    ;;;;;;; Subsubsubsubsection
>    [...]
>
>
> -- Stefan
>
>

Re: Cycling first N heading levels in outline

[Kévin Le Gouguec]

Christopher Dimech <dimech@gmx.com> writes:

>> The convention used in ELisp is:
>>
>>    ;;; Section
>>    ;;;; Subsection
>>    ;;;;; Subsubsection
>>    ;;;;;; Subsubsubsection
>>    ;;;;;;; Subsubsubsubsection
>>    [...]
>
> The headings still look like comments, whereas they are supposed to get highlighted
> according to the heading level.
>
> Could we get that to work in said way?

On Emacs master, the outline-minor-mode-highlight option allows you to
customize how headings are fontified:

> When t, it puts outline faces only if there are no major mode’s faces
> on headings.  When ‘override’, it completely overwrites major mode’s
> faces with outline faces.  When ‘append’, it tries to append outline
> faces to major mode’s faces.

Cycling first N heading levels in outline

[Christopher Dimech]

I am using GNU Emacs 27.1 and that functionality is not present.  Have tried to install
the development version and am getting

checking for libXaw... configure: error: No X toolkit could be found.

> Sent: Monday, May 24, 2021 at 10:57 PM
> From: "Kévin Le Gouguec" <kevin.legouguec@gmail.com>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: "Stefan Monnier" <monnier@iro.umontreal.ca>, "Ihor Radchenko" <yantar92@gmail.com>, "Jean Louis" <bugs@gnu.support>, emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> Christopher Dimech <dimech@gmx.com> writes:
> 
> >> The convention used in ELisp is:
> >>
> >>    ;;; Section
> >>    ;;;; Subsection
> >>    ;;;;; Subsubsection
> >>    ;;;;;; Subsubsubsection
> >>    ;;;;;;; Subsubsubsubsection
> >>    [...]
> >
> > The headings still look like comments, whereas they are supposed to get highlighted
> > according to the heading level.
> >
> > Could we get that to work in said way?
> 
> On Emacs master, the outline-minor-mode-highlight option allows you to
> customize how headings are fontified:
> 
> > When t, it puts outline faces only if there are no major mode’s faces
> > on headings.  When ‘override’, it completely overwrites major mode’s
> > faces with outline faces.  When ‘append’, it tries to append outline
> > faces to major mode’s faces.
>

Re: Cycling first N heading levels in outline

[Stefan Monnier]

> I have looked at how functions are folded.  But if you call elisp code (which
> always involves using parentheses) they also get to be interpreted as headings.
> Can this be fixed please, so that only elisp structure constructs are interpreted
> as headlines [e.g. "(defun" "(defvar"].

This is not a bug but a feature.  If you want to group several ELisp
code entries together, you can wrap them in a `progn` (or something
else like Setup's `setup` macro, or `use-package`, ...).

In ELisp packages (as opposed to user config files), there pretty much
shouldn't be any function calls at top-level, since loading such a file
should have virtually no user-visible effect.


        Stefan

Cycling first N heading levels in outline

[Christopher Dimech]

> Sent: Tuesday, May 25, 2021 at 4:27 AM
> From: "Stefan Monnier" <monnier@iro.umontreal.ca>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: "Jean Louis" <bugs@gnu.support>, "Ihor Radchenko" <yantar92@gmail.com>, emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> > I have looked at how functions are folded.  But if you call elisp code (which
> > always involves using parentheses) they also get to be interpreted as headings.
> > Can this be fixed please, so that only elisp structure constructs are interpreted
> > as headlines [e.g. "(defun" "(defvar"].
>
> This is not a bug but a feature.  If you want to group several ELisp
> code entries together, you can wrap them in a `progn` (or something
> else like Setup's `setup` macro, or `use-package`, ...).
>
> In ELisp packages (as opposed to user config files), there pretty much
> shouldn't be any function calls at top-level, since loading such a file
> should have virtually no user-visible effect.

It is more of an assumption then.  User Config Files should then not be too
extensive, or otherwise organised into a number ofspecific functions.

What can one use to unfold and fold a specific function?

Cycling first N heading levels in outline

[Christopher Dimech]

I need some help on how to use "outline-minor-mode-highlight" option to customize 
the colours for headings because they are showing up as normal comments.

I am in emacs-lisp-mode. 


> Sent: Monday, May 24, 2021 at 10:57 PM
> From: "Kévin Le Gouguec" <kevin.legouguec@gmail.com>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: "Stefan Monnier" <monnier@iro.umontreal.ca>, "Ihor Radchenko" <yantar92@gmail.com>, "Jean Louis" <bugs@gnu.support>, emacs-devel@gnu.org
> Subject: Re: Cycling first N heading levels in outline
>
> Christopher Dimech <dimech@gmx.com> writes:
> 
> >> The convention used in ELisp is:
> >>
> >>    ;;; Section
> >>    ;;;; Subsection
> >>    ;;;;; Subsubsection
> >>    ;;;;;; Subsubsubsection
> >>    ;;;;;;; Subsubsubsubsection
> >>    [...]
> >
> > The headings still look like comments, whereas they are supposed to get highlighted
> > according to the heading level.
> >
> > Could we get that to work in said way?
> 
> On Emacs master, the outline-minor-mode-highlight option allows you to
> customize how headings are fontified:
> 
> > When t, it puts outline faces only if there are no major mode’s faces
> > on headings.  When ‘override’, it completely overwrites major mode’s
> > faces with outline faces.  When ‘append’, it tries to append outline
> > faces to major mode’s faces.
>

Re: Cycling first N heading levels in outline

[Ihor Radchenko]

Jean Louis <bugs@gnu.support> writes:

> Especially for Org users the outline-minor-mode is universal and gives
> similar concepts of outline in various other modes:

Thanks for pointing this out. A long time ago, before I knew about
outline-minor-mode, I started using hideshow package with similar
functionality. Now, comparing the two, I can see how outline-minor-mode
can be sometimes better (not always though).

> - editing Emacs Lisp? Fold levels, sections, functions and open it. It
>   gives visual index of functions, it becomes very easy to move them
>   from place to place;

outline-minor-mode is definitely very nice when handling Elisp file
sections. Yet, it unfortunately cannot fold sexps inside functions
independently, unlike hideshow (correct me if I am wrong). I ended up
using both outline-minor-mode and hs-minor-mode for the time being. The
former for folding top-level defuns and comments and the latter for
folding sexps inside defuns.

Best,
Ihor