[Checkins] SVN: Products.GenericSetup/trunk/docs/ Documentation fixups.

[Tres Seaver]

Log message for revision 93834:
  Documentation fixups.

Changed:
  U   Products.GenericSetup/trunk/docs/handlers.rst
  U   Products.GenericSetup/trunk/docs/index.rst
  U   Products.GenericSetup/trunk/docs/profiles.rst

-=-
Modified: Products.GenericSetup/trunk/docs/handlers.rst
===================================================================
--- Products.GenericSetup/trunk/docs/handlers.rst	2008-12-10 01:36:37 UTC (rev 93833)
+++ Products.GenericSetup/trunk/docs/handlers.rst	2008-12-10 01:36:55 UTC (rev 93834)
@@ -3,24 +3,24 @@
 How-to: Writing setup handlers for ``Products.GenericSetup``
 ============================================================
 
-If your products subclass existing tools or provide new tools (or new
-sub-object classes) they might need their own setup handlers in order to
-make use of GenericSetup.
+If your product subclasses existing tools or provides new tools (or new
+sub-object classes), it might need to supply its own setup handlers in
+order to support exporting / importing tool settings using GenericSetup.
 
 Step 1:
 -------
 
 Identify those classes in your product that need their own setup handlers.
 In theory you don't need your own handlers for classes which implement a
-CMF tool interface that already has a setup adapter. In practice the
+CMF tool interface that already has a setup adapter.  In practice the
 adapters shipped with the CMF sometimes use methods that are not part of
-the interface, so you have to verify they really work for your classes.
+the interface, so you have to verify that they really work for your classes.
 
 Step 2:
 -------
 
 Make sure those classes that need setup handlers have Zope3 style
-interfaces. Later you will write setup adapters for those interfaces.
+interfaces.  Later you will write setup adapters for those interfaces.
 
 Step 3:
 -------
@@ -49,9 +49,8 @@
    need this kind of adapter.
 
 import and export steps
-   Top level handlers that can be registered as import step or export step
-   and call the body adapters. Maybe these will become obsolete for tools,
-   but currently they are required.
+   Top level handlers can be registered to manage import steps and / or export
+   steps and call the body adapters. 
 
 If you use the base classes from :mod:`Products.GenericSetup.utils`, XML and
 node adapters are implemented in a very similar way. Both can mix in
@@ -96,4 +95,11 @@
 Now you are done. To ship default settings with your product, make your
 settings through the ZMI (or set your stuff up the old way if you have old
 setup code like an ``Install.py``) and export your settings using the setup
-tool.
+tool.  Unpack the exported tarball into a ``profiles`` subdirectory of your
+product, and then add ``gs:registerProfile`` entries to its ``configure.zcml``
+file to register that directory as a :term:`base profile` or
+:term:`extension profile`.
+
+.. seealso::
+
+    See :ref:`about-profiles` for more details.

Modified: Products.GenericSetup/trunk/docs/index.rst
===================================================================
--- Products.GenericSetup/trunk/docs/index.rst	2008-12-10 01:36:37 UTC (rev 93833)
+++ Products.GenericSetup/trunk/docs/index.rst	2008-12-10 01:36:55 UTC (rev 93834)
@@ -7,9 +7,7 @@
 settings for each "tool" in the site , and supporting scripts / templates,
 in their "canonical" filesystem representations.
 
-.. contents::
 
-
 Configurations Included
 -----------------------
 

Modified: Products.GenericSetup/trunk/docs/profiles.rst
===================================================================
--- Products.GenericSetup/trunk/docs/profiles.rst	2008-12-10 01:36:37 UTC (rev 93833)
+++ Products.GenericSetup/trunk/docs/profiles.rst	2008-12-10 01:36:55 UTC (rev 93834)
@@ -18,7 +18,7 @@
 By convention profiles are stored in a ``profiles`` directory within a
 Zope2 product. They have to be registered explicitly using either the
 :meth:`Products.GenericSetup.profile_registry.registerProfile` API or the
-equivalent ``genericsetup::registerProfile`` ZCML directive.
+equivalent ``genericsetup:registerProfile`` ZCML directive.
 
 Here is example ZCML for a Zope2 product, ``MyProduct``, which extends
 another product, ``BaseProduct``::
@@ -33,8 +33,8 @@
 
 .. seealso::
 
-   See :class:`Products.GenericSetup.zcml.IRegisterProfileDirective` for
-   further details.
+   :class:`Products.GenericSetup.zcml.IRegisterProfileDirective` defines
+   the API for this directive.
 
 Alternatively, profiles can be registered by calling the
 :func:`Products.GenericSetup.profile_registry.registerProfile` API.