thanhvg / ipa.el

In Place Annotation

ipa.el — In-place annotations

Emacs pacakge

Forked from https://github.com/IdoMagal/ipa.el

Original Author: Tamas Patrovics Updated 2012 Ido Magal

Info: https://www.emacswiki.org/emacs/InPlaceAnnotations

Intro

With this package you can add annotations to your files without modifying them. Each file can have multiple annotations at various buffer positions. The annotation texts are not parts of the files, they are stored separately.

All annotations are stored in a common file, so searching annotations is trivial.

Install

Manual

(require 'ipa)

ipa comes with a minor mode ipad-mode that you need to enable. For example:

(add-hook 'find-file-hook 'ipa-mode)

Spacemacs layer

https://github.com/thanhvg/spacemacs-eos

Commands

ipa-insert:

insert annotation at point

ipa-edit:

edit the first annotation after point with universal argument: before point

ipa-next:

goes to the next annotation in the buffer

ipa-previous:

goes to the previous annotation in the buffer

ipa-move:

move the first annotation after point with universal argument: before point

ipa-show:

show all saved annotations for the current file

in the storage buffer you can press Enter on any annotation to go to its location

ipa-jump:

jump to any annotation with id completion Annotations can optionally have ids in their text with the following format: [id]annotation-text

If an annotation has an id, but no other text then it is effectively the same as a usual bookmark in emacs.

Only annotations appearing in ipa-file can be jumped to, so unsaved annotations does not count. If there are more annotations defined with the same id then the first one found in ipa-file is used.

ipa-refresh

refresh annotations for current buffer

ipa-delete

delete the first annotation after point with universal argument: before point