[Checkins] SVN: GenericSetup/trunk/ - improved docs

[Yvo Schubbe]

Log message for revision 68165:
  - improved docs

Changed:
  U   GenericSetup/trunk/CHANGES.txt
  U   GenericSetup/trunk/README.txt
  U   GenericSetup/trunk/doc/profiles.txt

-=-
Modified: GenericSetup/trunk/CHANGES.txt
===================================================================
--- GenericSetup/trunk/CHANGES.txt	2006-05-17 11:03:12 UTC (rev 68164)
+++ GenericSetup/trunk/CHANGES.txt	2006-05-17 11:08:32 UTC (rev 68165)
@@ -2,11 +2,11 @@
 
   GenericSetup 1.2 (unreleased)
 
+    - docs: Added 'Registering Profiles' section to profiles.txt.
+
     - Added support for PageTemplate import/export, modeled closely after
       existing PythonScript support
 
-  GenericSetup 1.1 (2006/04/16)
-
     - The dependency sorting was highly reliant on steps being added in the
       right order to work. If import step A depends on import step B which 
       depends on step C, and step C gets processed early, and they were 
@@ -14,6 +14,8 @@
       incorrect. This is now fixed by keeping tack of steps with unresolved
       dependencies, and trying again after inserting everything else.
 
+  GenericSetup 1.1 (2006/04/16)
+
     - ZCatalog handler: Implemented the 'remove' directive for indexes.
       This allows to write extension profiles that remove or replace indexes.
 
@@ -23,7 +25,6 @@
 
     No changes - tag created to coincide with CMF 2.0.0-beta2
 
-
   GenericSetup 1.1-beta (2006/03/08)
 
     - Allowed subclasses of DAVAwareFileAdapter to override the filename

Modified: GenericSetup/trunk/README.txt
===================================================================
--- GenericSetup/trunk/README.txt	2006-05-17 11:03:12 UTC (rev 68164)
+++ GenericSetup/trunk/README.txt	2006-05-17 11:08:32 UTC (rev 68165)
@@ -26,6 +26,15 @@
     Third-party products extend the tool by registering handlers for
     import / export of their unique tools.
 
+    See doc/handlers.txt for a step by step how-to.
+
+  Providing Profiles
+
+    GenericSetup doesn't ship with any profile. They have to be provided by
+    third-party products and depend on the registered handlers.
+
+    See doc/profiles.txt for more details.
+
   Glossary
 
     Site --

Modified: GenericSetup/trunk/doc/profiles.txt
===================================================================
--- GenericSetup/trunk/doc/profiles.txt	2006-05-17 11:03:12 UTC (rev 68164)
+++ GenericSetup/trunk/doc/profiles.txt	2006-05-17 11:08:32 UTC (rev 68165)
@@ -10,6 +10,30 @@
     can't export extension profiles. Snapshots and exports always represent
     the merged settings.
 
+  Registering Profiles
+
+    By convention profiles are stored in a 'profiles' directory within a Zope
+    product. They have to be registered explicitly with a registerProfile call
+    in the __init__.py of the product.
+
+    Here is example code for MyProduct that extends BaseProduct::
+
+      from Products.BaseProduct.interfaces import IBaseRoot
+      from Products.GenericSetup import EXTENSION
+      from Products.GenericSetup import profile_registry
+
+      def initialize(context):
+          profile_registry.registerProfile(
+                  name='install',
+                  title='Install MyProduct Extension',
+                  description='Adds local settings necessary for MyProduct.',
+                  path='profiles/install',
+                  product='MyProduct',
+                  profile_type=EXTENSION,
+                  for_=IBaseRoot)
+
+    See IProfileRegistry.registerProfile for further details.
+
   Update Directives
 
     For some XML elements there are additional attributes and values to