← Back to branch summary

~people-project/people-core/deep-refactoring

« back to all changes in this revision

Viewing changes to doc/design.txt

  • Committer: Ali Sabil
  • Date: 2007-12-18 23:38:45 UTC
  • Revision ID: ali.sabil@gmail.com-20071218233845-6mmfecoc0g53uy75
Initial import of the people source code.

Initial import of the people source code, the source is structured as follow:
    - doc: contains the various documentations/diagrams explaining the project
    - libbackend: defines the interfaces to be implemented by the backends
    - libpeople: people core library

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/design.txt
 
1
People design
 
2
=============
 
3
Ali Sabil علي سبيل <ali.sabil@gmail.com>
 
4
 
 
5
 
 
6
Abstract
 
7
--------
 
8
During the prototyping period of the project, various members came with
 
9
different and interesting approaches to the problems People is tring to solve.
 
10
This document summerizes them in order to try to combine ideas from the various
 
11
prototype into the final design.
 
12
 
 
13
 
 
14
Contact representation
 
15
----------------------
 
16
 
 
17
    Document based approach
 
18
    ~~~~~~~~~~~~~~~~~~~~~~~
 
19
     The idea behind this approach is to consider all the contacts as documents,
 
20
    basically as a set of nodes organized as a tree. This approach allows to
 
21
    have user defined fields and quite easy contact merging algorithms.
 
22
 
 
23
    The main problem with this approach is that it doesn't define how to handle
 
24
    backends that don't allow user defined fields. The second problem is that it
 
25
    doesn't define how *ephemeral fields* are handled.
 
26
 
 
27
    VCard based approach
 
28
    ~~~~~~~~~~~~~~~~~~~~
 
29
     VCard are the standard today that defines how contacts can be represented
 
30
    and which fields can be used, this is the exact opposite of the previous
 
31
    approach.
 
32
 
 
33
    The main problem is that it doesn't define how user defined fields are
 
34
    handled, as well as *ephemeral fields*.
 
35
 
 
36