Add documentation link to pragmatic emacs blog

[visible-mark] / visible-mark.el

diff --git a/visible-mark.el b/visible-mark.el
index a21e9bd6d9b24799f5188a496b5c73328e99bfb4..cf14098328976cf640aa995852a130e5b35366e5 100644 (file)
--- a/visible-mark.el
+++ b/visible-mark.el
@@ -2,7 +2,17 @@
 
 ;; Copyright (C) 2014 by Ian Kelling
 
-;; Author: Several people, most recently Ian Kelling <ian@iankelling.org>
+;; Maintainer: Ian Kelling <ian@iankelling.org>
+;; Mailing list: https://lists.iankelling.org/listinfo/visible-mark
+;; Author: Ian Kelling <ian@iankelling.org>
+;; Author: Yann Hodique
+;; Author: MATSUYAMA Tomohiro <t.matsuyama.pub@gmail.com>
+;; Author: John Foerch <jjfoerch@earthlink.net>
+;; Keywords: marking color faces
+;; URL: https://gitlab.com/iankelling/visible-mark
+;; Created: 2008-02-21
+
+;;; License:
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -24,6 +34,9 @@
 ;;
 ;; Allows setting the number of marks to display, and the faces to display them.
 ;;
+;; A good blog post was written introducing this package:
+;; http://pragmaticemacs.com/emacs/regions-marks-and-visual-mark/
+;;
 ;; Example installation:
 ;;
 ;; 1. Put this file in Emacs's load-path
@@ -39,27 +52,13 @@
 ;;   '((((type tty) (class mono)))
 ;;     (t (:background "magenta"))) "")
 ;; (setq visible-mark-max 2)
-;; (setq visible-mark-faces `(visible-mark-face1 my-visible-mark-face2))
+;; (setq visible-mark-faces `(visible-mark-face1 visible-mark-face2))
 ;; 
 ;;
 ;; Additional useful functions like unpoping the mark are at
 ;; http://www.emacswiki.org/emacs/MarkCommands
 ;; and http://www.emacswiki.org/emacs/VisibleMark
 
-;;; Pre-git history:
-;;
-;; 2008-02-21  MATSUYAMA Tomohiro <t.matsuyama.pub@gmail.com>
-;;
-;;      * visible-mark.el: Added function to inhibit trailing overlay.
-;;
-;; 2008-01-31  MATSUYAMA Tomohiro <t.matsuyama.pub@gmail.com>
-;;
-;;      * visible-mark.el: Create formal emacs lisp file from
-;;        http://www.emacswiki.org/cgi-bin/wiki/VisibleMark.
-;;        Yann Hodique and Jorgen Schäfer are original authors.
-;;        Added function to make multiple marks visible.
-;;
-;;
 ;; Known bugs
 ;;
 ;; Observed in circe, when the buffer has a right margin, and there
@@ -67,7 +66,7 @@
 ;; gets styled with the mark's face. May also happen for left margins, but
 ;; haven't tested yet.
 ;;
-;; Patches / pull requests welcome.
+;; Patches / pull requests / feedback welcome.
 
 ;;; Code:
 
@@ -234,6 +233,7 @@ the last defined face will be reused."
          (t t))
     (visible-mark-mode t)))
 
+;;;###autoload
 (define-minor-mode visible-mark-mode
   "A mode to make the mark visible."
   nil nil nil
@@ -246,6 +246,7 @@ the last defined face will be reused."
     (setq visible-mark-overlays nil)
     (remove-hook 'post-command-hook 'visible-mark-move-overlays t)))
 
+;;;###autoload
 (define-global-minor-mode
   global-visible-mark-mode visible-mark-mode visible-mark-mode-maybe
   :group 'visible-mark)