.* What's LSDB
LSDB (The Lovely Sister Database) is a rolodex-like database program
-for SEMI based MUA. It's intended to be a lightweight relacement for
+for SEMI based MUA. It intends to be a lightweight replacement for
BBDB (The Insidious Big Brother Database). Unfortunately, it
currently doesn't support the all features of BBDB.
.* Requirements
LSDB works under following environment at least:
- - Emacs 20.7
- - XEmacs 21.4 or later
+ * Emacs 20.7
+ * XEmacs 21.4 or later
You will also need the following libraries:
- - APEL 10.2 or later
- ftp://ftp.m17n.org/pub/mule/apel/
- - FLIM 1.12 or later
- ftp://ftp.m17n.org/pub/mule/flim/
+ * APEL 10.2 or later
+ * ftp://ftp.m17n.org/pub/mule/apel/
+ * FLIM 1.12 or later
+ * ftp://ftp.m17n.org/pub/mule/flim/
.* Installation
If you don't want to install other directories, please do only
following:
- % make
+ % make
You can specify the emacs command name, for example
- % make install EMACS=xemacs
+ % make install EMACS=xemacs
If `EMACS=...' is omitted, EMACS=emacs is used.
If you want to install other directories, please do following:
- % make install
+ % make install
.. (c) install as a XEmacs package
If you want to install to XEmacs package directory, please do
following:
- % make install-package
+ % make install-package
.* MUA Specific Installation
If you use Semi-gnus or its variant, put the following lines into your
~/.gnus and you will get the functions in this package autoloaded.
-(autoload 'lsdb-gnus-insinuate "lsdb")
-(autoload 'lsdb-gnus-insinuate-message "lsdb")
-(add-hook 'gnus-startup-hook 'lsdb-gnus-insinuate)
-(add-hook 'message-setup-hook
- (lambda ()
- (define-key message-mode-map "\M-\t" 'lsdb-complete-name)))
+ (autoload 'lsdb-gnus-insinuate "lsdb")
+ (autoload 'lsdb-gnus-insinuate-message "lsdb")
+ (add-hook 'gnus-startup-hook 'lsdb-gnus-insinuate)
+
+ ;; If you are using T-gnus 6.15.7 or later, type M-x
+ ;; customize-variable and set message-expand-name-function to
+ ;; lsdb-complete-name, instead of adding the following lines.
+ ;; (add-hook 'message-setup-hook
+ ;; (lambda ()
+ ;; (define-key message-mode-map "\M-\t" 'lsdb-complete-name)))
+
+ (add-hook 'gnus-summary-mode-hook
+ (lambda ()
+ (define-key gnus-summary-mode-map ":" 'lsdb-toggle-buffer)))
If you use Wanderlust, put the following lines into your ~/.wl:
-(require 'lsdb)
-(lsdb-wl-insinuate)
-(add-hook 'wl-draft-mode-hook
- (lambda ()
- (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
+
+ (require 'lsdb)
+ (lsdb-wl-insinuate)
+ (add-hook 'wl-draft-mode-hook
+ (lambda ()
+ (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
+ (add-hook 'wl-summary-mode-hook
+ (lambda ()
+ (define-key wl-summary-mode-map ":" 'lsdb-wl-toggle-buffer)))
If you use Mew, put the following lines into your ~/.mew:
-(autoload 'lsdb-mew-insinuate "lsdb")
-(add-hook 'mew-init-hook 'lsdb-mew-insinuate)
-(add-hook 'mew-draft-mode-hook
- (lambda ()
- (define-key mew-draft-header-map "\M-\t" 'lsdb-complete-name)))
+
+ (autoload 'lsdb-mew-insinuate "lsdb")
+ (add-hook 'mew-init-hook 'lsdb-mew-insinuate)
+ (add-hook 'mew-draft-mode-hook
+ (lambda ()
+ (define-key mew-draft-header-map "\M-I" 'lsdb-complete-name)))
+ (add-hook 'mew-summary-mode-hook
+ (lambda ()
+ (define-key mew-summary-mode-map "L" 'lsdb-toggle-buffer)))
If you use MU-CITE, put the following lines into your ~/.emacs:
-(autoload 'lsdb-mu-insinuate "lsdb")
-(eval-after-load "mu-cite"
- '(lsdb-mu-insinuate))
+
+ (autoload 'lsdb-mu-insinuate "lsdb")
+ (eval-after-load "mu-cite"
+ '(lsdb-mu-insinuate))
If you want to use x-face-e21 instead of the LSDB's builtin X-Face
functions, set lsdb-insert-x-face-function as follows:
-(setq lsdb-insert-x-face-function
- (lambda (x-face)
- (require 'x-face-e21)
- (insert-image (x-face-create-image x-face :scale-factor 0.5))))
-.* Bug reports
+ (setq lsdb-insert-x-face-function
+ (lambda (x-face)
+ (require 'x-face-e21)
+ (insert-image (x-face-create-image x-face :scale-factor 0.5))))
+
+.* Bug Reports
If you found bugs, please drop a note to the Lsdb-info Mailing List:
- lsdb-info@lists.sourceforge.jp
+ * lsdb-info@lists.sourceforge.jp
.* File Release
Latest version of LSDB can be found at:
- http://sourceforge.jp/projects/lsdb/files/
+ * http://sourceforge.jp/projects/lsdb/files/
.* API
-The API are quite simple but not written in a way that maximizes
-flexibility.
+The API is simple and not written in a way that maximizes flexibility.
.. Record Management
. : Gathering Records
. , lsdb-update-records<f>
lsdb-update-records<f> is called from the buffer which contains raw
-contents of MIME entity. Once it is called, it returns a list of
-records which could be gathered from the buffer.
+contents of MIME entity. It returns a list of records gathered from
+the buffer.
. : Display Records
. , lsdb-display-record<f>
-lsdb-display-record<f> takes only one record, pops up a window, and
-displays the formatted contents of the record within the window.
-If you want to multiple records such as search results at the same
-time, use lsdb-display-records<f> instead.
+lsdb-display-record<f> displays the formatted contents of the record
+within the popup window. If you want to display multiple records, use
+lsdb-display-records<f> instead.
.. Internal Data Model
. : Primary Hash Table
-lsdb-hash-table is the variable which holds all the records in LSDB.
-You can operate on this variable in similar fashion to CL's
-hash-table: lsdb-puthash for puthash, lsdb-gethash to gethash,
-lsdh-maphash to maphash are available to you. For example, you can
-write the following expression to get the record for "Daiki Ueno":
-
-(lsdb-gethash "Daiki Ueno" lsdb-hash-table)
-
-=>
-
-((last-modified . "2002-04-23")
- (creation-date . "2002-04-26")
- (net "ueno@unixuser.org")
- (mailing-list "emacs-mime-ja")
- (attribution . "DU")
- (user-agent "T-gnus/6.15.6 (based on Oort Gnus v0.06) (revision 03)"))
+There are two kinds of hash tables used in LSDB: a primary hash table
+and secondary hash tables. lsdb-hash-table is the primary hash table
+which holds mappings for names and record objects. You can operate on
+LSDB hash tables in similar fashion to CL's hash-table API:
+lsdb-puthash (for puthash), lsdb-gethash (for gethash), and
+lsdb-maphash (for maphash) are available.
+
+Here is an example to get the record object for "Daiki Ueno":
+
+ (lsdb-gethash "Daiki Ueno" lsdb-hash-table)
+
+ =>
+
+ ((last-modified . "2002-04-23")
+ (creation-date . "2002-04-26")
+ (net "ueno@unixuser.org")
+ (mailing-list "emacs-mime-ja")
+ (attribution . "DU")
+ (user-agent "T-gnus/6.15.6 (based on Oort Gnus v0.06) (revision 03)"))
. : Secondary Hash Tables
LSDB can also have one or more secondary hash tables. These hash
-tables are mainly used to hint lsdb-hash-table to gather additional
-relationship information between record name and entries. For
-example, lsdb-address-cache is a kind of secondary hash table which
-maintains the mapping of mail addresses to record names.
+tables are mainly used to define additional relationships between
+record objects and their entries. For example, lsdb-address-cache is
+one of secondary hash table which maintains mappings of mail addresses
+to record names.
-The variable lsdb-secondary-hash-tables holds a list where each
-element is corresponding to the name of global variable such as
-lsdb-address-cache. When the primary hash table is loaded or saved,
-the secondary hash tables will be handled automatically.
+The variable lsdb-secondary-hash-tables is a list of symbols for
+_maintained_ secondary hash tables. When the primary hash table is
+loaded or saved, these hash tables are updated automatically.
. , Operate on Secondary Hash Tables
You will need to follow the manner of the LSDB hooks.
. : cvs login (first time only)
% cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
-
CVS password: [CR] # NULL string
. : checkout
% cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout lsdb
- If you would like to join CVS based development, please send mail to
+If you would like to join CVS based development, please send mail to
cvs@cvs.m17n.org
We hope you will join the open development.
+
+.* Authors
+ * Daiki Ueno <ueno@unixuser.org>
+ * Hideyuki SHIRAI <shirai@meadowy.org> (support for Mew)
+ * Yuuichi Teranishi <teranisi@gohome.org>
+ * TSUCHIYA Masatoshi <tsuchiya@namazu.org>
+
.* Local emacs vars.
-The following `outline-layout' local variable setting:
+The following `allout-layout' local variable setting:
- closes all topics from the first topic to just before the third-to-last,
- shows the children of the third to last (config vars)
- and the second to last (code section),
- and closes the last topic (this local-variables section).
Local variables:
-outline-layout: (0 : -1 -1 0)
+allout-layout: (0 : -1 -1 0)
End:
projects / elisp / lsdb.git / blobdiff