1 ;;; bookmark+.el --- Bookmark+: extensions to standard library `bookmark.el'.
3 ;; Filename: bookmark+.el
4 ;; Description: Bookmark+: extensions to standard library `bookmark.el'.
5 ;; Author: Drew Adams, Thierry Volpiatto
6 ;; Maintainer: Drew Adams (concat "drew.adams" "@" "oracle" ".com")
7 ;; Copyright (C) 2000-2011, Drew Adams, all rights reserved.
8 ;; Copyright (C) 2009, Thierry Volpiatto, all rights reserved.
9 ;; Created: Fri Sep 15 07:58:41 2000
10 ;; Last-Updated: Mon Aug 1 08:59:18 2011 (-0700)
13 ;; URL: http://www.emacswiki.org/cgi-bin/wiki/bookmark+.el
14 ;; Keywords: bookmarks, bookmark+, placeholders, annotations, search, info, url, w3m, gnus
15 ;; Compatibility: GNU Emacs: 20.x, 21.x, 22.x, 23.x
17 ;; Features that might be required by this library:
19 ;; `bookmark', `bookmark+-1', `bookmark+-bmu', `bookmark+-key',
20 ;; `bookmark+-lit', `bookmark+-mac', `dired', `dired-aux',
21 ;; `dired-x', `ffap', `pp', `pp+'.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;; Bookmark+: extensions to standard library `bookmark.el'.
29 ;; The Bookmark+ libraries are these:
31 ;; `bookmark+.el' - main (driver) library (this file)
32 ;; `bookmark+-mac.el' - Lisp macros
33 ;; `bookmark+-lit.el' - (optional) code for highlighting bookmarks
34 ;; `bookmark+-bmu.el' - code for the `*Bookmark List*' (bmenu)
35 ;; `bookmark+-1.el' - other required code (non-bmenu)
36 ;; `bookmark+-key.el' - key and menu bindings
38 ;; `bookmark+-doc.el' - documentation (comment-only file)
39 ;; `bookmark+-chg.el' - change log (comment-only file)
41 ;; The documentation (in `bookmark+-doc.el') includes how to
42 ;; byte-compile and install Bookmark+. The documentation is also
43 ;; available in these ways:
45 ;; 1. From the bookmark list (`C-x r l'):
46 ;; Use `?' to show the current bookmark-list status and general
47 ;; help, then click link `Doc in Commentary' or link `Doc on the
50 ;; 2. From the Emacs-Wiki Web site:
51 ;; http://www.emacswiki.org/cgi-bin/wiki/BookmarkPlus.
53 ;; 3. From the Bookmark+ group customization buffer:
54 ;; `M-x customize-group bookmark-plus', then click link
57 ;; (The commentary links in #1 and #3 work only if you have library
58 ;; `bookmark+-doc.el' in your `load-path'.)
63 ;; On 2010-06-18, I changed the prefix used by package Bookmark+
64 ;; from `bookmarkp-' to `bmkp-'. THIS IS AN INCOMPATIBLE CHANGE.
65 ;; I apologize for the inconvenience, but the new prefix is
66 ;; preferable for a number of reasons, including easier
67 ;; distinction from standard `bookmark.el' names.
69 ;; This change means that YOU MUST MANUALLY REPLACE ALL
70 ;; OCCURRENCES of `bookmarkp-' by `bmkp-' in the following
71 ;; places, if you used Bookmark+ prior to this change:
73 ;; 1. In your init file (`~/.emacs') or your `custom-file', if
74 ;; you have one. This is needed if you customized any
75 ;; Bookmark+ features.
77 ;; 2. In your default bookmark file, `bookmark-default-file'
78 ;; (`.emacs.bmk'), and in any other bookmark files you might
81 ;; 3. In your `*Bookmark List*' state file,
82 ;; `bmkp-bmenu-state-file' (`~/.emacs-bmk-bmenu-state.el').
84 ;; 4. In your `*Bookmark List*' commands file,
85 ;; `bmkp-bmenu-commands-file' (`~/.emacs-bmk-bmenu-commands.el'),
88 ;; You can do this editing in a virgin Emacs session (`emacs
89 ;; -Q'), that is, without loading Bookmark+.
91 ;; Alternatively, you can do this editing in an Emacs session
92 ;; where Bookmark+ has been loaded, but in that case you must
93 ;; TURN OFF AUTOMATIC SAVING of both your default bookmark file
94 ;; and your `*Bookmark List*' state file. Otherwise, when you
95 ;; quit Emacs your manually edits will be overwritten.
97 ;; To turn off this automatic saving, you can use `M-~' and `M-l'
98 ;; in buffer `*Bookmark List*' (commands
99 ;; `bmkp-toggle-saving-bookmark-file' and
100 ;; `bmkp-toggle-saving-menu-list-state' - they are also in the
101 ;; `Bookmark+' menu).
104 ;; Again, sorry for this inconvenience.
107 ;; Commands defined here:
111 ;; Internal variables defined here:
113 ;; `bmkp-version-number'.
115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
117 ;; This program is free software; you can redistribute it and/or modify
118 ;; it under the terms of the GNU General Public License as published by
119 ;; the Free Software Foundation; either version 3, or (at your option)
120 ;; any later version.
122 ;; This program is distributed in the hope that it will be useful,
123 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
124 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
125 ;; GNU General Public License for more details.
127 ;; You should have received a copy of the GNU General Public License
128 ;; along with this program; see the file COPYING. If not, write to
129 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth
130 ;; Floor, Boston, MA 02110-1301, USA.
132 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
136 ;;;;;;;;;;;;;;;;;;;;;;;
138 (require 'bookmark) ; Vanilla Emacs.
139 (require 'bookmark+-mac) ; Lisp macros.
140 (require 'bookmark+-lit nil t) ; Optional (soft require) - no error if not found. If you do
141 ; not want to use `bookmark+-lit.el' then simply do not put
142 ; it in your `load-path'.
143 (require 'bookmark+-bmu) ; `*Bookmark List*' stuff.
144 (require 'bookmark+-1) ; Rest of Bookmark+ required stuff, except keys & menus.
145 (require 'bookmark+-key) ; Keys & menus.
147 ;;;;;;;;;;;;;;;;;;;;;;;
150 (defconst bmkp-version-number "3.2.2")
153 (defun bmkp-version ()
154 "Show version number of library `bookmark+.el'."
156 (message "Bookmark+, version %s" bmkp-version-number))
158 ;;;;;;;;;;;;;;;;;;;;;;;
162 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
163 ;;; bookmark+.el ends here