增加bbdb v3的配置说明

Author: lujun9972

bbdb简单使用教程.org

@@ -126,8 +126,333 @@ This may also be applied to multiple records at once by *.
 
 交换光标所在的field与上一行field的位置
 
-交换的field必须在同一条记录中,且具有相同的类型
+若带参数0执行该命令,则光标所在的域与mark标记的域进行交换
 
 With non-zero numeric argument ARG, the previous field is moved past ARG fields. 
 
-With argument 0, the field indicated by point is interchanged with the one indicated by mark.
+交换的field必须在同一条记录中,且具有相同的类型
+
+*** n (bbdb-next-record)/ p (bbdb-prev-record)
+
+移动到下一个/上一个记录,若带前缀参数N,则下移/上移N条记录
+
+*** t (bbdb-toggle-records-layout)
+
+
+切换是否显示记录中具体域的说明. 
+
+若带参数0调用该函数,则强制光标所在记录不显示记录域说明,此时,所有的域信息都压缩到一行内显示.
+
+当待其他参数调用该函数时,则强制光标所在记录显示记录中的域说明时,此时,当前记录使用多行样式显示.
+
+若使用`*t'而不是`t',则buffer内所有的记录都同时切换显示样式
+
+*** T (bbdb-display-record-completely)
+
+谢换是否展示当前记录的所有域,这时平时隐藏不显示的`creation-date'和`timestamp'都会显示出来.
+
+*** o (bbdb-omit-record)
+
+隐藏当前记录,但并不会将当前记录从BBDB数据库中删除掉.
+
+若带参数N执行该命令,则会隐藏下面N条记录,N可以为负数
+
+*** m (bbdb-mail)
+
+发送电子邮件給当前的联系人. 默认邮件地址为记录中的第一个email地址.
+
+若带参数N调用该函数,则表示邮件地址使用记录周公的第N个email地址
+
+若使用`*m'而不是`m',则表示給该buffer中的所有联系人发送电子邮件
+
+*** s /C-x C-s (bbdb-save)
+
+保存BBDB数据库到文件中
+
+*** M-d (bbdb-dial)
+
+该命令会尝试着去拨打光标所在的数字. 若光标处于一条记录的开头,则会拨打第一个phone域.
+
+具体原理不明...
+
+*** q (quit-window)
+
+退出bbdb窗口,但不会kill bbdb buffer
+
+*** ? (bbdb-help)
+
+在minibuffer中显示简易帮助信息
+
+*** h (bbdb-info)
+
+显示bbdb的info文档
+
+若bbdb的info文档没有安装在标准的info目录下,可以通过设置`bbdb-info-file'变量来明确指明bbdb info文件的路径
+
+*** (bbdb-print)
+
+将BBDB记录导出到Tex文件中.
+
+*** c (bbdb-create)
+
+创建新记录保存新的联系人信息
+
+*** C (bbdb-copy-records-as-kill)
+
+将当前记录拷贝到kill ring中
+
+若使用`* C'则拷贝buffer中的所有记录到kill ring中
+
+*** b (bbdb)
+
+重新查询bbdb数据库
+
+*** / m (bbdb-search-mail)
+
+搜索mail域
+
+*** / a (bbdb-search-address)
+
+搜索address域
+
+*** / c (bbdb-search-changed)
+
+搜索至上次保存后,改变过的bbdb记录
+
+*** / d (bbdb-search-duplicates)
+
+搜索具有相同域的记录
+
+*** / n (bbdb-search-name)
+
+搜索name域
+
+*** / o (bbdb-search-organization)
+
+搜索organization域
+
+*** / p (bbdb-search-phone)
+
+搜索phone域
+
+*** / x (bbdb-search-xfields)
+
+搜索xfield域(该域存什么?我也不知道...)
+
+*** * (bbdb-do-all-records)
+
+该命令用于修改紧接之后的命令的作用域,让其作用于buffer中的所有记录.(Command prefix for operating on all records currently displayed.)
+
+但只对某些特定的命令有效
+
+* 配置
+
+** 配置项
++ bbdb-file
+  
+  bbdb数据库的存储路径,默认为`~/.bbdb'
+
++ bbdb-default-area-code
+
+  当输入新电话好吗时,使用的默认区号. 
+
+  该变量的值也会影响到拨打电话时的行为
+
++ bbdb-address-format-list
+
+  用于编辑/显示BBDB地址信息时的规则列表.
+
++ bbdb-continental-postcode-regexp
+
+  该正则表达式决定了BBDB的address是否为欧洲格式的地址.
+
+  若address域的值匹配该正则表达式,则表示该address为欧洲格式的地址,否则认为是美国格式的地址
+
++ bbdb-case-fold-search
+
+  当使用bbdb系列的搜索命令进行搜索时,是否大小写敏感
+
++ bbdb-auto-revert
+
+  若在Emacs中没有修改bbdb buffer中的信息,而此时,bbdb-file发生了改变,则自动重新加载bbdb-file的新内容
+
++ bbdb-pop-up-layout
+
+  pop-up BBDB buffer时使用的默认布局(mail,news...). 默认为'pop-up-multi-line
+
++ bbdb-pop-up-window-size
+
+  pop-up BBDB buffer时的高度.
+
+  若为整数N,则表示高度为N行
+
+  若为一个介于0到1之间的小数N,则拆分拥有最高高度的window,并且BBDB buffer占据N倍的高度
+
+  若为t,则表示使用 `display-buffer'/`pop-to-buffer' 创建BBDB window??(貌似会占据next-window来显示BBDB buffer)
+
++ bbdb-completion-list
+
+  控制`bbdb-complete-mail'的补全方式. 该函数用于在mail buffer中补全联系人信息
+
+  该值可以为一个symbol list,用来指明补全哪些域的值. 这些symbol可以是:
+
+  - fl-name :: first and last name
+
+  - lf-name :: last and first name
+
+  - organization :: 
+
+  - aka :: 
+
+  - mail :: all email address of each record
+
+  - primary :: first email address of each record
+
+  该值也可以为t,表示所有上面symbol的集合
+
+  若该值为nil,则表示不提供补全
+
++ bbdb-complete-mail-allow-cycling
+
+  当调用`bbdb-complete-mail'补全email地址时,是否允许循环展示补全项
+
++ bbdb-user-mail-address
+
+  该变量的值为一个正则表达式,该正则表达式用于标识某email地址是否是用户自己的email地址.
+
+  多数BBDB的命令根据变量`bbdb-message-headers'从消息中抽取出发送方和接收方的email地址. 但若发送方的email地址匹配上了`bbdb-user-mail-address-re',则该email地址依然被认为是接收方的email地址.
+
+  改变量的默认值为`(user-login-name)'
+
++ bbdb-add-mails
+
+  该变量指明了当收到某个联系人从新的email地址发来的消息后,是否增加该新email到联系人信息中.
+
+  可选值有:
+
+  - t :: 自动添加该新的email地址
+
+  - query :: 询问用户是否添加该新的email地址
+
+  - nil :: 忽略新的email地址
+
+  - 数字N :: 在N秒内,BBDB显示该新的email地址,但只在当前session有效
+
+  - 函数fn :: 使用record和新email地址作为参数来调用fn,fn需要返回t,'query,nil或一个数字
+
+  - 正则表达式re :: 若新的email地址符合该正则,则忽略该新的email地址,否则询问用户是否添加该email地址
+
++ bbdb-new-mails-primary
+
+  为联系人新增email地址时,该新email地址是否作为primary mail address(即该新email地址排在其他email地址的前面). 
+
+  可选值为:
+
+  - t :: 让该新增的email地址自动称为primary mail address
+
+  - query :: 询问用户是否作为primary mail address
+
+  - nil :: 不作为primary mail address,会将新email地址放到列表最后面.
+
+  - 函数fn :: 该函数接收两个参数:record和新email地址. 该函数需要返回t,'query或nil
+
+  - 正则表达式re :: 若新email地址匹配该re,则不作为primary mail address,否则询问用户是否作为primary mail address
+
++ bbdb-ignore-redundant-mails
+
+  当增加新mail地址时,若联系人中的旧mail地址是新mail地址的更一般形式(例如,已有的mail地址为[email protected],而新mail地址为[email protected])时,是否覆盖原mail地址.
+
+  可选的值为为:
+
+  - t :: 自动忽略新email地址
+
+  - query :: 询问用户是否忽略新email地址
+
+  - nil :: 使用新email地址,覆盖原email地址
+
+  - 数字N :: 在接下来的N秒内,保留新email地址
+
+  - 函数fn :: fn接收两个参数:record及新email地址,fn需要返回t,'query,nil或数字
+
+  - 正则表达式re :: 符合该正则表达式的email地址会替代原email地址,否则询问用户是否忽略新email地址
+
++ bbdb-check-auto-save-file
+
+  若值为t,则BBDB会检查它的auto-save file,若auto-save file比`bbdb-file'要新,则BBDB会恢复auto-save file
+
++ bbdb-ignore-message-alist
+
+  描述哪些message不允许触发自动新建BBDB联系人记录.
+
++ bbdb-accept-message-alist
+
+  描述哪些message允许触发自动新建BBDB联系人记录.
+
++ bbdb-mua-auto-update-p
+
+  决定了`bbdb-mua-auto-update'如何自动更新BBDB记录. 可选值:
+  
+  - nil :: 什么也不做
+
+  - search :: 搜索匹配ADDRESS的记录
+
+  - update :: 搜索匹配ADDRESS的记录,如有必要,会更新name和mail域
+
+  - query :: 搜索匹配ADDRESS的记录,若记录不存在,提示用户是否创建新记录
+
+  - create :: 搜索匹配ADDRESS的记录,若记录不存在,则创建新记录
+
+  - t :: 搜索匹配ADDRESS的记录,若记录不存在,则创建新记录
+
+  - 函数fn :: bbdb调用该函数,该函数需要返回nil,search,update,query,create或t
+
+** hooks
+
+| hook                             | 调用hook的时机                                     | 调用hook时的参数                       | 其他说明                                                          |
+|----------------------------------+----------------------------------------------------+----------------------------------------+-------------------------------------------------------------------|
+| bbdb-display-hook                | 展示*BBDB* buffer后                                |                                        |                                                                   |
+| bbdb-create-hook                 | 在BBDB创建新联系人记录前                           | 新增的record                           | bbdb-change-hook也会被触发                                        |
+| bbdb-change-hook                 | *BBDB* buffer发生改变前                            | 修改的record                           |                                                                   |
+| bbdb-mode-hook                   | 进入bbdb mode后                                    |                                        |                                                                   |
+| bbdb-notice-record-hook          | 当发现message中的email地址包含在某个联系人记录中后 | 包含message中email的联系人记录         | 若某message中包含同一联系人的多个email地址,该hook也只会被触发一次 |
+| bbdb-notice-mail-hook            | 当发现message中的email地址包含在某个联系人记录中后 | 包含message中email的联系人记录         | 若某message中包含同一联系人的多个email地址,该hook也会被触发多次   |
+| bbdb-after-read-db-hook          | 当`bbdb-file'被读取之后                            |                                        | 当BBDB buffer revert之后还会再次触发该hook                        |
+| bbdb-initialize-hook             | BBDB的初始化函数`bbdb-initialize'被调用之后        |                                        |                                                                   |
+| bbdb-canonicalize-mail-functioin | 当BBDB notice a message后                          | message中的corresponding email address | 该函数用于对message中的对应email地址作一次转换,转换后的结果才拿来与BBDB中的记录进行对比,或添加入BBDB. 若该函数返回nil,则BBDB认为该message中无email address |
+
+* hacks
+** 函数
+*** (bbdb-display-records records )
+
+在bbdb buffer中显示records中的记录
+
+** 变量
+*** bbdb-records
+
+该变量的值为当前bbdb buffer中的record列表
+
+*** 
+* FAQ
+
+** 如何修改BBDB创建联系人的流程
+
+使用`bbdb-create'新建联系人时,会以此提示你输入一系列的联系人的信息,包括姓名,所属机构,电子邮件,地址,电话,备注. 但若想让BBDB在创建联系人时也提示你输入其他额外的信息该如何作呢?
+
+下面是一个例子,它让`bbdb-create'新建联系人时,还会提示你输入生日信息:
+#+BEGIN_SRC emacs-lisp
+  ;; 该例子抄至sachachua的博客
+  ;; 该例子为bbdb v2的例子,有待改成bbdb v3
+  (defadvice bbdb-read-new-record (after wicked activate)
+    "Prompt for the birthdate as well."
+    (bbdb-record-putprop ad-return-value 'birthdate
+                         (bbdb-read-string "Birthdate (YYYY.MM.DD): ")))
+
+#+END_SRC
+
+** 如何将bbdb中保存的联系人信息导入到手机中
+
+最简单的方法,就是使用"bbdb-to-outlook.el"将bbdb导出为.csv文件. 然后在手机上导入该.csv文件
+
+1. 加载"bbdb-to-outlook.el"
+2. 使用`bbdb'显示bbdb联系人信息
+3. 键入`O'会运行`bbdb-to-outlook'命令,输入保存的csv文件路径即可.