ghoshi / annot Goto Github PK

Sorry, I did not see a way to enter this question in the Wiki tab page.
So I hope it is OK to ask this question here.

The scenario is after annotating a source code file, it would be nice if I
can see the same annotations from another machine, so long as I can copy the
.annot directory.

Thanks,

When creating a multi-line annotation, there's no way to hide or collapse it, 
to get it out of the way, when I'm interested in seeing only the underlying 
source material.

* What steps will reproduce the problem?

1. Create a new annotation that's several lines long (use C-j or C-m to add new 
lines).
2. Verify that the annotation spans multiple lines.
3. Verify that the annotation cannot be collapsed to a single line, or hidden.

* What version of the product are you using? On what operating system?

Revision 45, Cygwin.

What steps will reproduce the problem?
1. (require 'annot)
2. Try to use various keybindings that use C-x r or C-x a as a prefix
3. annot.el keybinding short circuits those keybindings.

C-x r is the prefix for all register, rectangular editing, and bookmarking 
commands.

C-x a is the prefix for abbreviation commands.

You can check to see if a prefix is in use by typing PREFIX C-h. E.g. C-x r C-h.

Please see this link which documents emacs keybinding conventions:
http://www.gnu.org/software/emacs/elisp/html_node/Key-Binding-Conventions.html

For minor modes the best thing to do is usually to either follow those 
conventions or don't bind any keys by default. The user has keybindings of the 
form:

C-c a
C-c b
...
C-c z

reserved for his own use (i.e. modes aren't supposed to use those).

Here is a complete list of commands blocked by annot.el.

C-x r C-@       point-to-register
C-x r SPC       point-to-register
C-x r +         increment-register
C-x r N         rectangle-number-lines
C-x r b         bookmark-jump
C-x r c         clear-rectangle
C-x r d         delete-rectangle
C-x r f         frame-configuration-to-register
C-x r g         insert-register
C-x r i         insert-register
C-x r j         jump-to-register
C-x r k         kill-rectangle
C-x r l         bookmark-bmenu-list
C-x r m         bookmark-set
C-x r n         number-to-register
C-x r o         open-rectangle
C-x r r         copy-rectangle-to-register
C-x r s         copy-to-register
C-x r t         string-rectangle
C-x r w         window-configuration-to-register
C-x r x         copy-to-register
C-x r y         yank-rectangle
C-x r C-SPC     point-to-register

C-x a C-a       add-mode-abbrev
C-x a '         expand-abbrev
C-x a +         add-mode-abbrev
C-x a -         inverse-add-global-abbrev
C-x a e         expand-abbrev
C-x a g         add-global-abbrev
C-x a i         Prefix Command
C-x a l         add-mode-abbrev
C-x a n         expand-jump-to-next-slot
C-x a p         expand-jump-to-previous-slot

C-x a i g       inverse-add-global-abbrev
C-x a i l       inverse-add-mode-abbrev

I was wondering if you've given thought to having this as a minor-mode?  It 
could be done such that there is a global option, too, much like font-lock 
(local or global).  I'd be happy to help out in adapting it.

annot.el would be really nice for making reviews of files. For the review 
meeting it would be nice if one could have an overview of all annotations over 
different files. For this purpose it would be really nice to have an annotation 
browser, which shows the file name, the line number and the annotation (or a 
preview of the annotation in case it is a multiline one). Easiest case it could 
use grep-mode ...

Nice mode otherwise, thanks!

Daniel

Hi, just found this great package. But what I wanted was a tool to convert a 
section of text into an annotation (the idea is, I can add random notes in a 
file, then before checking it in convert them to annotations so they don't 
bother other people).

Couldn't find an existing way to do that, so ere's my quick hack:


(defun annot-convert (start end)
  "Convert region to annotation"
  (interactive "r")
  (let ((annot (buffer-substring start end)))
    (kill-region start end)
    (annot-create-overlay (point) annot)))

I like the annotation style of amazon kindle.
Could you implement it in future version?

With Best Regards.
jingtao.

Is there any command - to toggle the show/un-show the annotations ?

Also, the summary of annotations may also be interesting to have.