From: Eric Abrahamsen <eric@ericabrahamsen.net>
To: David Masterson <dsmasterson@outlook.com>
Cc: "35261@debbugs.gnu.org" <35261@debbugs.gnu.org>
Subject: bug#35261: 26.1; EBDB Documentation
Date: Thu, 18 Apr 2019 13:33:11 -0700 [thread overview]
Message-ID: <87zhonf3zs.fsf@ericabrahamsen.net> (raw)
In-Reply-To: <BYAPR07MB5734D30833766700B0211969A5250@BYAPR07MB5734.namprd07.prod.outlook.com> (David Masterson's message of "Wed, 17 Apr 2019 03:41:47 +0000")
On 04/17/19 03:41 AM, David Masterson wrote:
> Eric Abrahamsen <eric@ericabrahamsen.net> writes:
>
>> Here's what the new version looks like:
>>
>> * Getting Started
>> EBDB is a contact management package: it records information about
>> people and organizations, and integrates with other Emacs software
>> packages, mostly those concerned with sending and reading mail. The
>> principle parts of EBDB are records, which represent people and
>> organizations; fields, representing detailed data about records; and
>> databases, which hold and persist records.
>>
>> There are a large number of configuration options listed in this
>> manual, but the only one you might want to tweak in advance is
>> ~ebdb-sources~ (see [The EBDB Database]), which controls where EBDB
>> stores its records.
>>
>> ** Starting a New Database
>> If you have no records you want to migrate from other contact
>> management software, start by calling the command ~ebdb-open~. This
>> will open a new buffer in ~ebdb-mode~, and prompt you to create a
>> database, if one doesn't already exist. From there, you can use
>> {{{kbd(c)}}} to make new records (see [Creating Records]).
>
> Otherwise, you'll want to migrate your data from other contact
> management software as described in the sections below. Currently, EBDB
> only knows about migrating from BBDB and Org Contacts.
Okay, sounds good.
> ====
>
> Beyond this, I can see that lots of documentation (and, I assume,
> functionality) is still needed:
>
> 1. Installation details of EBDB and related tools.
> 2. Details on what type of records a database is composed of.
> 3. Details on the fields of a record.
> 4. Details on the type of a field.
> 5. Import/Export functionality
> 6. Hooks for add-ons
>
> * By 'details', I mean some Emacs Elisp and not just English to give us
> real reference information.
EBDB is only just stabilizing (the export stuff went through some big
refactoring just recently) and I'm a little hesitant to lay all this
stuff out in the manual. One of the long-term goals is definitely to
make EBDB programmable and integratable with other packages, but I'm
dragging my feet a little bit until I'm more confident that the API
won't change. It'll get there, though.
Eric
next prev parent reply other threads:[~2019-04-18 20:33 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-13 21:26 bug#35261: 26.1; EBDB Documentation David Masterson
2019-04-14 1:50 ` Eric Abrahamsen
2019-04-15 3:50 ` David Masterson
2019-04-15 5:07 ` Eric Abrahamsen
2019-04-15 20:56 ` David Masterson
2019-04-16 18:54 ` Eric Abrahamsen
2019-04-17 3:14 ` David Masterson
2019-04-18 19:51 ` Eric Abrahamsen
2019-04-19 22:22 ` David Masterson
2019-04-16 21:10 ` Eric Abrahamsen
2019-04-17 3:41 ` David Masterson
2019-04-18 20:33 ` Eric Abrahamsen [this message]
2019-04-19 22:31 ` David Masterson
2019-04-20 0:00 ` Eric Abrahamsen
2019-04-21 2:08 ` David Masterson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zhonf3zs.fsf@ericabrahamsen.net \
--to=eric@ericabrahamsen.net \
--cc=35261@debbugs.gnu.org \
--cc=dsmasterson@outlook.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.