[CMF-checkins] CVS: CMF - README.txt:1.2

Jeffrey Shell jeffrey@digicool.com
Wed, 2 May 2001 19:10:33 -0400 (EDT)


Update of /cvs-repository/CMF/CMFTopic
In directory korak:/home/jeffrey/InstanceHomes/cmf-dev/CMF/CMFTopic

Modified Files:
	README.txt 
Log Message:
Added information on Updating CMF Topic setups.



--- Updated File README.txt in package CMF --
--- README.txt	2001/04/11 18:39:31	1.1
+++ README.txt	2001/05/02 23:10:31	1.2
@@ -1,18 +1,40 @@
 Installing CMF Topic into a CMF Site
 
- Since the CMF allows site by site configuration, just having CMF
- Topic installed into your Zope does not mean that any CMF Site
- instance will know what to do with it.  To get CMF Topic installed
- and registered, you need to go to the root of the CMF Site (aka
- *Portal* instance) that you want CMF Topic to be registered in and add an 
- External Method with the following configuration:
-
-   **id** -- 'install_topic'
-   **title** -- *Install Topic*
-   **module name** -- 'CMFTopic.Install'
-   **function name** -- 'install'
-
- Then go to the management screen for the newly added external method
- and click the 'Try it' tab.  The install function will execute and give
- information about the steps it took to register and install the CMF Topic
- into the CMF Site instance.
+  Since the CMF allows site by site configuration, just having CMF
+  Topic installed into your Zope does not mean that any CMF Site
+  instance will know what to do with it.  To get CMF Topic installed
+  and registered, you need to go to the root of the CMF Site (aka
+  *Portal* instance) that you want CMF Topic to be registered in and add an 
+  External Method with the following configuration:
+
+    **id** -- 'install_topic'
+    **title** -- *Install Topic*
+    **module name** -- 'CMFTopic.Install'
+    **function name** -- 'install'
+
+  Then go to the management screen for the newly added external method
+  and click the 'Try it' tab.  The install function will execute and give
+  information about the steps it took to register and install the CMF Topic
+  into the CMF Site instance.
+
+Updating CMF Topic in a CMF Site
+
+  Since default settings may change from time to time in CMF Topic,
+  you may need to update your Topic types tool (and other) settings.
+  This is done similarly to installing by adding an External Method
+  to your CMF Site instance with the following configuration::
+
+    **id** -- 'update_topic'
+    **title** -- *Update Topic*
+    **module name** -- 'CMFTopic.Update'
+    **function name** -- 'update'
+
+  Go to the management screen for the newly added external method and
+  click the 'Try it' tab.  The update function will execute and give
+  information about the steps it took to register and update CMF Topic 
+  site information.
+
+  *Note: This update script should **only** change values that are
+  still at their default, such as changing an action from 'topic_edit' 
+  to 'topic_edit_form'.  If you changed that action to 'mytopic_edit', 
+  the script should pass that by and not change your settings.*