fix removing dash from xfields, add docs
[bbdb-csv-import] / bbdb-csv-import.el
index a5c2b595543a213d914d435e6b6fa4a63d1a7cec..62dd12b53654d74b832bf11f560741ceeadb2cdd 100644 (file)
@@ -9,6 +9,7 @@
 ;; Package-Requires: ((pcsv "1.3.3") (dash "2.5.0") (bbdb "20140412.1949"))
 ;; Keywords: csv, util, bbdb
 ;; Homepage: https://gitlab.com/iankelling/bbdb-csv-import
+;; Mailing-List: https://lists.iankelling.org/listinfo/bbdb-csv-import
 
 ;; 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
@@ -45,6 +46,9 @@
 ;;
 ;; Simply M-x `bbdb-csv-import-buffer' or `bbdb-csv-import-file'.
 ;; When called interactively, they prompt for file or buffer arguments.
+;;
+;; Then view your bbdb records: M-x bbdb .* RET
+;; If the import looks good save the bbdb database: C-x s (bbdb-save)
 
 ;;; Advanced usage / notes:
 ;;
@@ -56,7 +60,7 @@
 ;; chance it will work out of the box. If it doesn't, you can try to fix it as
 ;; described below, or the maintainer will be happy to help, just anonymize your
 ;; csv data using the M-x bbdb-csv-anonymize-current-buffer (make sure csv
-;; buffer is the current one) and attach it to an email.
+;; buffer is the current one) and attach it to an email to the mailing list.
 ;;
 ;; Duplicate contacts (according to email address) are skipped if
 ;; bbdb-allow-duplicates is nil (default). Any duplicates found are echoed at
 ;;; Custom mapping of csv fields
 ;;
 ;; If a field is handled wrong or you want to extend the program to handle a new
-;; kind of csv format, you need to setup a custom field mapping variable. It
-;; should not be too hard, but you can also  Use the existing tables as an example. By default, we
-;; use a combination of most predefined mappings, and look for all of their
-;; fields, but it is probably best to avoid that kind of table when setting up
-;; your own as it is an unnecessary complexity in that case. If you have a
-;; problem with data from a supported export program, start by testing its
-;; specific mapping table instead of the combined one. Here is a handy template
-;; to set each of the predefined mapping tables if you would rather avoid the
-;; configure interface:
+;; kind of csv format, you need to setup a custom field mapping variable. Use
+;; the existing tables as an example. By default, we use a combination of most
+;; predefined mappings, and look for all of their fields, but it is probably
+;; best to avoid that kind of table when setting up your own as it is an
+;; unnecessary complexity in that case. If you have a problem with data from a
+;; supported export program, start by testing its specific mapping table instead
+;; of the combined one. Here is a handy template to set each of the predefined
+;; mapping tables if you would rather avoid the configure interface:
 ;; 
 ;; (setq bbdb-csv-import-mapping-table bbdb-csv-import-combined)
 ;; (setq bbdb-csv-import-mapping-table bbdb-csv-import-thunderbird)
 ;; mapping table. Please send any new tables to the maintainer listed in this
 ;; file. The maintainer should be able to help with any issues and may create a
 ;; new mapping table given sample data.
+;;
+;; Mapping table tips:
+;; * The repeat keyword expands numbered field names, based on the first
+;;   subsequent field, as many times as they exist in the csv data.
+;; * All mapping fields are optional. A simple mapping table could be
+;;   (setq bbdb-csv-import-mapping-table '((:mail "Primary Email")))
+;; * xfields uses the field name to create custom fields in bbdb. It downcases
+;;   the field name, and replaces spaces with "-".
+;; * For example, if you had a csv data for bbdb's mail-alias, you could add to :xfields
+;;   a csv field name would become "mail-alias", like "Mail Alias" or "Mail-alias"
 
 ;;; Misc tips/troubleshooting:
 ;;
 ;;
 ;; Patches and bugs are very welcome via https://gitlab.com/iankelling/bbdb-csv-import
 ;; 
-;; Questions, feedback, etc are very welcome via email to Ian Kelling
-;; <ian@iankelling.org>. I will add any useful questions, answers, etc. to this
-;; file. The scope/userbase of this project doesn't justify a mailing list, but if
-;; it ever did I would start a mailman or discourse to act as a mailing list
-;; and forum.
+;; Questions, feedback, or anything is very welcome at to the bbdb-csv-import mailing list
+;; https://lists.iankelling.org/listinfo/bbdb-csv-import, no subscription needed to post via
+;; bbdb-csv-import@lists.iankelling.org
+
 
 
 ;;; Code:
 (require 'bbdb-com)
 (eval-when-compile (require 'cl))
 
-
 (defconst bbdb-csv-import-thunderbird
   '((:namelist "First Name" "Last Name")
     (:name "Display Name")
@@ -322,10 +333,13 @@ See the commentary section of this file for more details."
 
 
 (defun  bbdb-csv-import-expand-repeats (csv-fields list)
-  "Return new list where elements from LIST in form (repeat elem1 ...)
-become ((elem1 ...) [(elem2 ...)] ...) for as many repeating
-numbered fields exist in the csv fields. elem can be a string or
-a tree (a list with lists inside it)"
+  "Return new list where elements from LIST in form (repeat elem1
+...)  become ((elem1 ...) [(elem2 ...)] ...) for as many fields
+exist in the csv fields. elem can be a string or a tree (a list
+with lists inside it). We use the first element as a template,
+and increase its number by one, and check if it exists, and then
+increment any other elements from the repeat list which have
+numbers in them."
   (cl-flet ((replace-num (num string)
                          ;; in STRING, replace all groups of numbers with NUM
                          (replace-regexp-in-string "[0-9]+"
@@ -453,8 +467,6 @@ BUFFER-OR-NAME is a buffer or name of a buffer, or the current buffer if nil."
                            (map-bbdb :address)))
               (xfields (rd (lambda (list)
                              (let ((e (car list)))
-                               (while (string-match "-" e)
-                                 (setq e (replace-match "" nil nil e)))
                                (while (string-match " +" e)
                                  (setq e (replace-match "-" nil nil e)))
                                (setq e (make-symbol (downcase e)))