--- nfo/perl/libs/Data/Transfer/Sync.pod	2003/01/19 02:03:48	1.1
+++ nfo/perl/libs/Data/Transfer/Sync.pod	2003/02/09 04:56:22	1.2
@@ -3,42 +3,92 @@
 
 =head1 NEWS
 
-=head4 2003-01-18  -  integration with Torus
 
-  please look at http://www.netfrag.org/horde/chora/cvs.php/perl/scripts/outlook2ldap/
+=head4 2003-02-09  -  backward compatibility with custom application
 
+  - Tangram <-> .csv
+  - Tangram <-> mysql
+  - Tangram <-> perl-code
+
+
+=head4 2003-01-18  -  start integration with Torus
+
+  - MAPI <-> LDAP
+  - please look at http://www.netfrag.org/horde/chora/cvs.php/perl/scripts/outlook2ldap/
+
+
+=head4 2002-10-10  -  initial commit
+
+  - Tangram <-> mysql
 
-=head4 2002-10-10  -  initial check-in
 
 
 =head1 DESCRIPTION
 
-Data::Transfer::Sync is a module providing a generic synchronization process
-across arbitrary/multiple storages based on a ident/checksum mechanism.
-It sits on top of Data::Storage.
+  Data::Transfer::Sync is a module providing a generic synchronization process
+  across arbitrary/multiple storages based on a ident/checksum mechanism.
+  It sits on top of Data::Storage.
+
 
 
 =head1 REQUIREMENTS
 
   For full functionality:
+    Data::Compare
     Data::Storage
     Data::Transform
-    Data::Compare
-    ... and all their dependencies
+    ... and all their dependencies.
 
 
-=head1 AUTHORS / COPYRIGHT
+=head1 AUTHORS / COPYRIGHT / LICENSE
 
-The Data::Storage module is Copyright (c) 2002 Andreas Motl.
-All rights reserved.
+  The Data::Transfer::Sync module is Copyright (c) 2002 Andreas Motl.
+  All rights reserved.
 
-You may distribute it under the terms of either the GNU General Public
-License or the Artistic License, as specified in the Perl README file.
+  Code contributions, suggestions, support and ideas by
+  Sebastian Utz <su@tunemedia.de> and Jan Hoffmann <jan@romain-volk.com>.
+  
+  You may distribute it under the terms of either the GNU General Public
+  License or the Artistic License, as specified in the Perl README file.
 
 
 =head1 SUPPORT / WARRANTY
 
-Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND.
+  Data::Transfer::Sync is free software. IT COMES WITHOUT WARRANTY OF ANY KIND.
+
+  Please feel free to contact me at <andreas.motl@ilo.de>.
+
+
+
+=head1 EXAMPLE OUTPUT CHUNKS
+
+=head2 Synchronizing orm objects against entries in a .csv file - 17 items modified
+
+  notice: PULL INTO backend NODE * TYPE Country SELECT NODE * TYPE [n/a] FROM base USING MODULE BizWorks::ResourceMapping;
+  notice: OEF::Script::AbstractFeeder:
+      - Loading data of type [n/a] and
+        filtered by * from the storage named base
+        to the storage named backend - filtered by *.
+      - Will attempt to convert the data to Country.
+  info: Data::Transfer::Sync::API->syncNodes: source=backend/* [Country] <- target=base/* []
+  :c:c:c:c:c:c:c:ctr:c:c:c:c:c:c:c:ctr:c:c:c:c:c:c:ctr:c:ctr:c:c:c:c:c:c:c:c:c:c:c:ctr:c:c:c:ctr:c:c:c:c:c:c:c:ctr:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c
+  :c:c:c:c:c:c:c:c:ctr:c:c:c:c:c:c:c:c:c:c:c:ctr:c:c:c:c:ctr:c:c:c:ctr:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:ctr:ctr:c:c:c:c:ctr:c:c:c:c:c:c:c
+  :c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:ctr:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:ctr:c:c:ctr:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c
+  info: Data::Transfer::Sync::Core->_startsync: statistics: in_sync: 180  /  total: 197  /  attempt_modify: 17  /  ok: 17
+
+=head2 Synchronizing orm objects against entries in a .csv file - in-sync
+  
+  notice: PULL INTO backend NODE * TYPE Country SELECT NODE * TYPE [n/a] FROM base USING MODULE BizWorks::ResourceMapping;
+  notice: OEF::Script::AbstractFeeder:
+      - Loading data of type [n/a] and
+        filtered by * from the storage named base
+        to the storage named backend - filtered by *.
+      - Will attempt to convert the data to Country.
+  info: Data::Transfer::Sync::API->syncNodes: source=backend/* [Country] <- target=base/* []
+  :c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c
+  :c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c
+  :c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c:c
+  info: Data::Transfer::Sync::Core->_startsync: statistics: in_sync: 197  /  total: 197
 
 
 
@@ -125,25 +175,25 @@
 
 =head1 TODO
 
-  - sub _resolveIdentProvider
-  - wrap _doModifySource and _doTransferTarget around a core function which can change virtually any type of node
-  - split this module up into Sync.pm, Sync/Core.pm, Sync/Compare.pm and Sync/Compare/Checksum.pm
-     - introduce _compareNodes as a core method and wrap it around methods in Sync/Compare/Checksum.pm
-  - introduce Sync/Compare/MyComparisonImplementation.pm
-  - some generic deferring method - e.g. "$self->defer(action)" - to be able to accumulate a bunch of actions for later processing
+  o sub _resolveIdentProvider
+  x wrap _doModifySource and _doTransferTarget around a core function which can change virtually any type of node
+  x split this module up into Sync.pm, Sync/Core.pm, Sync/Compare.pm and Sync/Compare/Checksum.pm
+  o introduce _compareNodes as a core method and wrap it around methods in Sync/Compare/Checksum.pm
+  x introduce Sync/Compare/MyComparisonImplementation.pm
+  o some generic deferring method - e.g. "$self->defer(action)" - to be able to accumulate a bunch of actions for later processing
      - this implies everything done is _really_ split up into generic actions - how else would we defer them???
      - example uses:
         - fetch whole checksum list from node
         - remember source ident retransmits
      - remember: this is convenient - and maybe / of course faster - but we'll loose "per-node-atomic" operations
-  - feature: mechanism to implicit inject checksum property to nodes (alter table / modify schema)
-  - expand statistics / keep track of:
+  o feature: mechanism to implicit inject checksum property to nodes (alter table / modify schema)
+  o expand statistics / keep track of:
     - touched/untouched nodes
-  - full sync
+  o full sync
     - just do a push and a pull for now but use stats for touched nodes in between to speed up things
-  - introduce some new metadata flags for a synchronization partner which is (e.g.) of "source" or "target":
+  o introduce some new metadata flags for a descent
     - isNewNodePropagator
-    - isWriteProtected
+    x isWriteProtected
 
 
 =cut