File: ol-bbdb.el.html
This file implements links to BBDB database entries from within Org.
Org mode loads this module by default - if this is not what you want,
configure the variable org-modules.
It also implements an interface (based on Ivar Rummelhoff's
bbdb-anniv.el) for those Org users, who do not use the diary
but who do want to include the anniversaries stored in the BBDB
into the org-agenda. If you already include the diary into the
agenda, you might want to prefer to include the anniversaries in
the diary using bbdb-anniv.el.
Put the following in /somewhere/at/home/diary.org and make sure
that this file is in org-agenda-files(var)/org-agenda-files(fun).
%%(org-bbdb-anniversaries)
For example my diary.org looks like:
* Anniversaries
#+CATEGORY: Anniv
%%(org-bbdb-anniversaries)
To add an anniversary to a BBDB record, press C-o in the record.
You will be prompted for the field name, in this case it must be
"anniversary". If this is the first time you are using this field,
you need to confirm that it should be created.
The format of an anniversary field stored in BBDB is the following
(items in {} are optional):
YYYY-MM-DD{ CLASS-OR-FORMAT-STRING}
{\nYYYY-MM-DD CLASS-OR-FORMAT-STRING}...
CLASS-OR-FORMAT-STRING is one of two things:
- an identifier for a class of anniversaries (e.g. birthday or
wedding) from org-bbdb-anniversary-format-alist which then
defines the format string for this class
- the (format) string displayed in the diary.
You can enter multiple anniversaries for a single BBDB record by
separating them with a newline character. At the BBDB prompt for
the field value, type C-q C-j to enter a newline between two
anniversaries.
If you omit the CLASS-OR-FORMAT-STRING entirely, it defaults to the
value of org-bbdb-default-anniversary-format ("birthday" by
default).
The substitutions in the format string are (in order):
- the name of the record containing this anniversary
- the number of years
- an ordinal suffix (st, nd, rd, th) for the year
See the documentation of org-bbdb-anniversary-format-alist for
further options.
Example
1973-06-22
20??-??-?? wedding
1998-03-12 %s created bbdb-anniv.el %d years ago
From Org's agenda, you can use C-c C-o to jump to the BBDB
link from which the entry at point originates.
Defined variables (7)
org-bbdb-anniv-hash | A hash holding anniversaries extracted from BBDB. |
org-bbdb-anniversary-field | The BBDB field which contains anniversaries. |
org-bbdb-anniversary-format-alist | How different types of anniversaries should be formatted. |
org-bbdb-default-anniversary-format | Default anniversary class. |
org-bbdb-extract-date-fun | How to retrieve ‘month date year’ from the anniversary field. |
org-bbdb-general-anniversary-description-after | When to switch anniversary descriptions to a more general format. |
org-bbdb-updated-p | This is non-nil if BBDB has been updated since we last built the hash. |
Defined functions (17)
org-bbdb-anniv-export-ical | () |
org-bbdb-anniv-extract-date | (TIME-STR) |
org-bbdb-anniv-split | (STR) |
org-bbdb-anniversaries | () |
org-bbdb-anniversaries-future | (&optional N) |
org-bbdb-anniversary-description | (AGENDA-DATE ANNIV-DATE) |
org-bbdb-complete-link | () |
org-bbdb-date-list | (D N) |
org-bbdb-describe-link | (LINK DESC) |
org-bbdb-export | (PATH DESC FORMAT _) |
org-bbdb-format-vevent | (KEY RECS) |
org-bbdb-make-anniv-hash | () |
org-bbdb-open | (NAME _) |
org-bbdb-open-new | (NAME) |
org-bbdb-open-old | (NAME) |
org-bbdb-store-link | (&optional INTERACTIVE?) |
org-bbdb-updated | (REC) |