Commits

Fabrice Gabolde  committed 05d1c4b

Documentation.

  • Participants
  • Parent commits 2681d93

Comments (0)

Files changed (1)

+;;; anote.el -- basic annotations with tooltips
+
+;; -*- coding: utf-8 -*-
+
+;; Author: Fabrice Gabolde <fabrice.gabolde@gmail.com>
+;; Maintainer: Fabrice Gabolde <fabrice.gabolde@gmail.com>
+;; Created: 05 Dec 2011
+;; Version: 0.1
+;; Keywords: annotations, tooltips
+
+;; This file is not part of GNU Emacs.
+
+;; anote.el is free software: you can redistribute it and/or modify it
+;; under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; anote.el is distributed in the hope that it will be useful, but
+;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+;; General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with anote.el. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Requirements:
+
+;; + Emacs 23 (probably works in 22)
+;;
+;; + The `cl' package for a couple list operations
+
+;;; Installation:
+
+;; Copy anote.el to your LOAD-PATH.
+
+;;; Usage:
+
+;; To create a new annotation, do
+;;
+;; M-x anote/annotate-this MESSAGE RET
+;;
+;; This adds an overlay to the symbol at point, or the region if
+;; active.  The message entered will be displayed as a tool-tip
+;; whenever your mouse hovers over it, if you're running under X.  (If
+;; not, M-x anote/get-this-annotation will display it in the
+;; minibuffer.)
+;;
+;; M-x anote/unannotate-this RET
+;;
+;; removes the annotation at point, and
+;;
+;; M-x anote/edit-this-annotation MESSAGE RET
+;;
+;; lets you edit the annotation at point (an empty annotation is
+;; removed).
+;;
+;; No keybindings whatsoever are installed; make your own with
+;; `global-set-key'!
+;;
+;; Annotations are kept in a folder called .anote next to the file
+;; being annotated, and should still work through TRAMP.  This does
+;; require that you have the permission to create said folder.
+
+;;; Code:
+
 (require 'cl)
 
 (defface anote/annotation-face
                   (contents (match-string 4)))
               (with-current-buffer source-buffer-or-name
                 (anote/overlay-bounds index bound-left bound-right))))))))
+
+(provide 'anote)
+;;; anote.el ends here