search

bastibe / annotate.el

Annotate.el
Other
388 stars 20 forks source link

- added an annotation summary window #44

Closed cage2 closed 5 years ago

cage2 commented 5 years ago

the command 'annotate-show-annotation-summary' popup a window containing a textual description of the annotations found in the annotation file (like ~/.emacs/annotations) with the format:

  -------

/path/of/an/annotated/file

Each annotation text is a link that, if activated (via a mouse click, for example), opens a buffer showing the annotated file at the position of the annotated text (the underlined one) linked to annotation.

Bye!! C.

cage2 commented 5 years ago

That's really cool! I love it!

Could you post a screenshot of what it looks like, when rendered in your Emacs?

Sure, no problem!

What are your thoughts on including an entire (truncated) source line instead of just the annotated text?

yes, this would be a nice improvements, any idea of the layout to accomodate this text?

Something like that, for example?


/path/of/an/annotated/file

 *  annotated text snippet 
    - annotation text
    - annotation text
 *  another annotated text snippet 
    -   annotation text

and so on

Again, thank you very much!

You're welcome! I feel i am starting to learning a little more about emacs and elisp!

Bye! C.

bastibe commented 5 years ago

What are your thoughts on including an entire (truncated) source line instead of just the annotated text?

yes, this would be a nice improvements, any idea of the layout to accommodate this text?

Good question. Possibly something like

/path/to/file
* this is a line containing an {annotated text snippet} and some more...
  - annotation text

We could highlight the annotated text either with ascii characters, or with overlays, just like annotate.el itself does it.

Come to think of it, the coolest solution would be an occur-edit-mode style buffer that lists the original, editable, source lines with their true annotations. But frankly, I have no idea whatsoever how to accomplish that, or if it is even possible.

cage2 commented 5 years ago

What are your thoughts on including an entire (truncated) source line instead of just the annotated text?

yes, this would be a nice improvements, any idea of the layout to accommodate this text?

Good question. Possibly something like

/path/to/file
* this is a line containing an {annotated text snippet} and some more...
  - annotation text

We could highlight the annotated text either with ascii characters, or with overlays, just like annotate.el itself does it.

I discovered (probably re-discovered) outline-mode and this is what i got so far:

https://www.autistici.org/interzona/img/misc/annotate-summary-example.png

I think this is close to what you asked, i have added some more empty lines here and there just according to my very personal task, but you could have different opinion about that of course! :)

Come to think of it, the coolest solution would be an occur-edit-mode style buffer that lists the original, editable, source lines with their true annotations. But frankly, I have no idea whatsoever how to accomplish that, or if it is even possible.

This is a very ambitious goal for sure, i do not even know where to start to accomplish that, to be honest! :)

Bye!

bastibe commented 5 years ago

This looks really cool!

Why are the annotation texts list items? Do you commonly use multiple annotations of the same text? I would have expected each text to have exactly one annotation, which would not require a list.

cage2 commented 5 years ago

This looks really cool!

Thank you! :)

Why are the annotation texts list items? Do you commonly use multiple annotations of the same text? I would have expected each text to have exactly one annotation, which would not require a list.

Sorry, the list bullet was just wrong, left there only because i forgot to remove it. Now I changed it with just spaces.

Bye! C.

bastibe commented 5 years ago

Thank you very very much for all your work on this!

The pull request looks good to me, now! Would you like me to merge it?

cage2 commented 5 years ago

On Tue, Oct 08, 2019 at 12:40:32AM -0700, Bastian Bechtold wrote:

Hi Bastibe!

Thank you very very much for all your work on this!

My pleasure!

The pull request looks good to me, now! Would you like me to merge it?

I you are positive: sure!

Moreover i have (almost) ready a couple of pull requests unrelated to this one but i think i need your help to understand if they are a good idea or not! :)

Bye! C.

cage2 commented 5 years ago

Is there time for a last minute fix? ;-)

bastibe commented 5 years ago

I'll merge when you tell me you're ready. There's no rush.

Moreover i have (almost) ready a couple of pull requests unrelated to this one but i think i need your help to understand if they are a good idea or not! :)

Just open a pull request and I'll have a look!

Thank you for putting so much work into this project!

cage2 commented 5 years ago

On Wed, Oct 09, 2019 at 01:21:57AM -0700, Bastian Bechtold wrote:

Hi!

I'll merge when you tell me you're ready. There's no rush.

Ok, i am fine with merging after the last commit! :) I think we could even made this mode global now.

Bye!! C.

cage2 commented 5 years ago

On Thu, Oct 10, 2019 at 12:51:36AM -0700, Bastian Bechtold wrote:

Merged #44 into master.

Thank you!

C.