README

   1 -*- mode: text -*-
   2 .* What's LSDB
   3
   4 LSDB (The Lovely Sister Database) is a rolodex-like database program
   5 for SEMI based MUA.  It's intended to be a lightweight relacement for
   6 BBDB (The Insidious Big Brother Database).  Unfortunately, it
   7 currently doesn't support the all features of BBDB.
   8
   9 .* Installation
  10
  11 .. (a) run in expanded place
  12
  13 If you don't want to install other directories, please do only
  14 following:
  15
  16         % make
  17
  18 You can specify the emacs command name, for example
  19
  20         % make install EMACS=xemacs
  21
  22 If `EMACS=...' is omitted, EMACS=emacs is used.
  23
  24 .. (b) make install
  25
  26 If you want to install other directories, please do following:
  27
  28         % make install
  29
  30 .. (c) install as a XEmacs package
  31
  32 If you want to install to XEmacs package directory, please do
  33 following:
  34
  35         % make install-package
  36
  37 .* MUA Specific Installation
  38
  39 There are the convenient ways to get the LSDB functions insinuate into
  40 some particular MUA.  Only Semi-gnus and Wanderlust are currently
  41 supported.
  42
  43 If you use Semi-gnus or its variant, put the following lines into your
  44 ~/.gnus and you will get the functions in this package autoloaded.
  45
  46 (autoload 'lsdb-gnus-insinuate "lsdb")
  47 (autoload 'lsdb-gnus-insinuate-message "lsdb")
  48 (add-hook 'gnus-startup-hook 'lsdb-gnus-insinuate)
  49 (add-hook 'message-setup-hook
  50           (lambda ()
  51              (define-key message-mode-map "\M-\t" 'lsdb-complete-name)))
  52
  53 If you use Wanderlust, put the following lines into your ~/.wl:
  54 (require 'lsdb)
  55 (lsdb-wl-insinuate)
  56 (add-hook 'wl-draft-mode-hook
  57           (lambda ()
  58              (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
  59
  60 .* Bug reports
  61 If you found bugs, please drop a note to the EMACS-MIME Mailing List:
  62
  63         emacs-mime-en@m17n.org  (English)
  64         emacs-mime-ja@m17n.org  (Japanese)
  65
  66 .* API
  67 The API are quite simple but not written in a way that maximizes
  68 flexibility.
  69
  70 .. Gathering Records
  71 . : lsdb-update-records<f>
  72 lsdb-update-records<f> is called from the buffer which contains raw
  73 contents of MIME entity.  Once it is called, it returns a list of
  74 records which could be gathered from the buffer.
  75
  76 .. Display Records
  77 . : lsdb-display-record<f>
  78 lsdb-display-record<f> takes only one record, pops up a window, and
  79 displays the formatted contents of the record within the window.
  80 If you want to multiple records such as search results at the same
  81 time, use lsdb-display-records<f> instead.
  82
  83 .. Internal Data Model
  84 . : lsdb-hash-table
  85 lsdb-hash-table is the variable which holds all the records in LSDB.
  86 We can operate on this variable in similar fashion to CL's hash-table.
  87
  88 lsdb-puthash for puthash, lsdb-gethash to gethash, lsdh-maphash to
  89 maphash are allowed to use.  For example, you can write the following
  90 expression to get the record for "Daiki Ueno":
  91
  92 (lsdb-gethash "Daiki Ueno" lsdb-hash-table)
  93
  94 =>
  95
  96 ((last-modified . "2002-04-23")
  97  (creation-date . "2002-04-26")
  98  (net "ueno@unixuser.org")
  99  (mailing-list "emacs-mime-ja")
 100  (attribution . "DU")
 101  (user-agent "T-gnus/6.15.6 (based on Oort Gnus v0.06) (revision 03)"))
 102
 103 .* Local emacs vars.
 104 The following `outline-layout' local variable setting:
 105   - closes all topics from the first topic to just before the third-to-last,
 106   - shows the children of the third to last (config vars)
 107   - and the second to last (code section),
 108   - and closes the last topic (this local-variables section).
 109 Local variables:
 110 outline-layout: (0 : -1 -1 0)
 111 End: