jump next previous - tag bookmark or search

jump next previous - tag bookmark or search

[Adam]

My file of code is long and getting longer. So I would like to jump either
forward or backward to the next or previous section start, with a single
keystroke, such as F7 (previous) and F8 (next). 

I would be happy to comment each section start with a signifier-comment,
such as  ;; **    whereas all other comments would start ;;; or ; 

So, which would be more applicable to bind to F7 F8 for this ?  

Tags,  where it would be handy I suppose to collect the comment text on just
that line. 

Bookmarks,  although the need for an individual Bookmark name is
undesirable. 

or a backward or forwards search for ";;** " 

While it would seem the Search method most appropriate, I would be
interested in hearing any thoughts, comments or recommendations. 

Re: jump next previous - tag bookmark or search

[Albert Reiner]

[Adam <nospam@example.com>, Mon, 29 May 2006 03:36:44 +1200]:
> My file of code is long and getting longer. So I would like to jump either
> forward or backward to the next or previous section start, with a single
> keystroke, such as F7 (previous) and F8 (next). 
> 
> I would be happy to comment each section start with a signifier-comment,
> such as  ;; **    whereas all other comments would start ;;; or ; 

This sounds like a case for outline-mode or outline-minor-mode to me.
You probably have to adjust some regexp to recognize your sections.

Albert.

RE: jump next previous - tag bookmark or search

[Drew Adams]

    I would like to jump either forward or backward to the next or
    previous section start, with a single keystroke, such as F7 and F8.

    I would be happy to comment each section start with a signifier-comment,
    such as  ;; **    whereas all other comments would start ;;; or ;
    So, which would be more applicable to bind to F7 F8 for this ?

    - Tags,  where it would be handy I suppose to collect the comment
      text on just that line.
    - Bookmarks,  although the need for an individual Bookmark name is
      undesirable.
    - or a backward or forwards search for ";;** "

Libraries commonly use a page separator (^L) for major sections. Then, you
can navigate among pages using `C-x ]' (forward-page) and `C-x ['
(backward-page). You can of course bind F7 and F8 to these commands.

To insert a Control-L character (^L), use `C-q C-l'.

Be aware that a page separator can also affect printing.

Re: jump next previous - tag bookmark or search

[Bastien]

Adam <nospam@example.com> writes:

> I would be happy to comment each section start with a signifier-comment,
> such as  ;; **    whereas all other comments would start ;;; or ; 
>
> So, which would be more applicable to bind to F7 F8 for this ?  

Maybe you just need to add a page break with `C-q C-l' then jump from
one page to another with `C-x ]'.

-- 
Bastien

Re: jump next previous - tag bookmark or search

[Stefan Monnier]

> My file of code is long and getting longer.  So I would like to jump
> either forward or backward to the next or previous section start, with
> a single keystroke, such as F7 (previous) and F8 (next).

Checkout outline-minor-mode.

> I would be happy to comment each section start with a signifier-comment,
> such as  ;; **    whereas all other comments would start ;;; or ; 

The Elisp coding conventions say that ";;;" starts a section heading (which
is recognized by outline-minor-mode).  I.e. normal comments should use ";;"
or ";" but not ";;;".


        Stefan

Re: jump next previous

[Adam]

Adam wrote:


Thank you very much, folks.  

RE: jump next previous - tag bookmark or search

[Adam]

Thank you Drew.

Your page-break is probably what I'm looking for, as its quick and simple,
and print formatting is not an issue now. 

I'm only just getting used to outline-minor-mode, C-c @ c-t,  C-c @ c-a,
etc, as per 30.8 of the Emacs manual. 

Invoking outline-minor-mode by itself seems to switch off the highlighting
of Lisp-mode.  There are no equivalent outline functions in slime-mode. So
I have been turning lisp-mode back on after initiating outline-minor-mode. 

Perhaps something like this would be necessary for a local variables list,
at the top of my page; 

     ;;; Local Variables: ***
     ;;; mode:outline-minor ***
     ;;; mode:slime ***
     ;;; mode:lisp ***
     ;;; End: *** 



> Libraries commonly use a page separator (^L) for major sections. Then, you
> can navigate among pages using `C-x ]' (forward-page) and `C-x ['
> (backward-page). You can of course bind F7 and F8 to these commands.
> 
> To insert a Control-L character (^L), use `C-q C-l'.
> 
> Be aware that a page separator can also affect printing.

Re: jump next previous - tag bookmark or search

[Stefan Monnier]

>      ;;; Local Variables: ***
>      ;;; mode:outline-minor ***
>      ;;; mode:slime ***
>      ;;; mode:lisp ***
>      ;;; End: *** 

Use only ";;" rather than ";;;" since ";;;" is used for outline headings.


        Stefan

Re: jump next previous - tag bookmark or search

[Adam]

Thanks Stefan, good point. 

This is how they are presented in 57.3.4 Local Variables in Files in the Gnu
Emacs Manual, although that section takes some reading for me to somewhat
understand. Like; 

- The Local Variables list goes later in the document, or at the end; so as
not to interfere with other programs expectations about contents of the
first few lines, and

- in 57.3.4 example, comment-start and comment-end have been defined as ;;;
and ***  but probably just for example. Hence your reply.    
  

However my point was that, turning on outline-minor-mode seems to deselect
Lisp-mode (the high-lighting goes), I'm uncertain what happens to
Slime-mode, and it would seem that a specific order for turning on the
three modes seems necessary. In this case; 
- outline-minor-mode (first)
- slime-mode
- lisp-mode

And that just seems strange to me. Suddenly almost requiring a Local
Variables list. It appears these modes can alter or switch off each other,
depending upon which order they're initiated. 

Thanks for your comment.  I'll keep plugging away. 




Stefan Monnier wrote:

>>      ;;; Local Variables: ***
>>      ;;; mode:outline-minor ***
>>      ;;; mode:slime ***
>>      ;;; mode:lisp ***
>>      ;;; End: ***
> 
> Use only ";;" rather than ";;;" since ";;;" is used for outline headings.
> 
> 
>         Stefan

Re: jump next previous - tag bookmark or search

[Stefan Monnier]

> Thanks Stefan, good point.
> This is how they are presented in 57.3.4 Local Variables in Files in the
> Emacs Manual,

Very good point.  I've just fixed the manual so as not to give such bad
advice any more (in the past the use of ;;; for normal commments was
considered OK, even though it clashed with outline-minor-mode and lisp-mnt,
this has only been adjusted recently).

But note that my remark wasn't just about convention: since the local
variables are used to set the outline-minor-mode, clearly you want to follow
outline's conventions and thus avoid ";;;" even if such comments were
usually considered perfectly acceptable.

> However my point was that, turning on outline-minor-mode seems to deselect
> Lisp-mode (the high-lighting goes), I'm uncertain what happens to
> Slime-mode, and it would seem that a specific order for turning on the
> three modes seems necessary. In this case; 
> - outline-minor-mode (first)
> - slime-mode
> - lisp-mode

> And that just seems strange to me. Suddenly almost requiring a Local
> Variables list. It appears these modes can alter or switch off each other,
> depending upon which order they're initiated.

Yes, the `mode' settings was mostly meant for major modes, not minor modes.
Activating a major mode resets most minor modes, so the order is important:
lisp-mode should be activated first (which seems to be obtained
unintuitively by placing it at the end).


        Stefan

Re: jump next previous - tag bookmark or search

[Adam]

Very many thanks,  Stefan. 

This query came about as an Emacs novice just wishing to quickly jump
between particular points in his code. Points or positions which; 

- are not pagebreaks (although they can be)

- are not Tags as such, 

- can be tagged by a special comment line (and this is probably preferable)

- it would be handy to see in hide-body of outline mode (if thats easily
done). 

- it would be wise to observe a consistent Commenting format for


So the replies have given me good options to look at and try. 

Thanks for the change to the Manual, and keeping it alive. 

OT:  Even a key-binding to switch into those particular modes, in that
particular order, might not be such a bad option. 

Thank you again, 

Adam.