[CMF-checkins] SVN: CMF/trunk/ - documentation file updates, corrections and cleanups

Jens Vagelpohl jens at dataflake.org
Sun Jan 15 06:08:20 EST 2006 

Log message for revision 41318:
  - documentation file updates, corrections and cleanups
  

Changed:
  U   CMF/trunk/CMFCalendar/CREDITS.txt
  U   CMF/trunk/CMFCore/README.txt
  U   CMF/trunk/CMFDefault/README.txt
  U   CMF/trunk/COPYRIGHT.txt
  U   CMF/trunk/GenericSetup/README.txt
  U   CMF/trunk/INSTALL.txt
  U   CMF/trunk/INSTALL_SVN.txt

-=-
Modified: CMF/trunk/CMFCalendar/CREDITS.txt
===================================================================
--- CMF/trunk/CMFCalendar/CREDITS.txt	2006-01-15 11:07:40 UTC (rev 41317)
+++ CMF/trunk/CMFCalendar/CREDITS.txt	2006-01-15 11:08:20 UTC (rev 41318)
@@ -1,12 +1,12 @@
 -- CREDITS.TXT --
 
-Orignal Event meta_type and CMFCalendar by Zope Corporation.
+Original Event meta_type and CMFCalendar by Zope Corporation.
 
 The implementation of the calendar and the calendar_tool was
 completed by Andy Dawkins (New Information Paradigms Ltd)
 
-Andy originally implemented the Calendar design in plone
-(www.plone.org) with help from the plone development team
+Andy originally implemented the Calendar design in Plone
+(www.plone.org) with help from the Plone development team
 (Alexander Limi, Vidar Andersen and Alan Runyan)
 
 CalendarTool was converted to a CMF Tool by Alan Runyan.

Modified: CMF/trunk/CMFCore/README.txt
===================================================================
--- CMF/trunk/CMFCore/README.txt	2006-01-15 11:07:40 UTC (rev 41317)
+++ CMF/trunk/CMFCore/README.txt	2006-01-15 11:08:20 UTC (rev 41318)
@@ -1,5 +1,4 @@
 CMFCore
 
   This product declares the key framework services for the Zope
-  Content Management Framework (CMF).  Please see the CMF
-  "dogbowl site":http://cmf.zope.org, for more details.
+  Content Management Framework (CMF).

Modified: CMF/trunk/CMFDefault/README.txt
===================================================================
--- CMF/trunk/CMFDefault/README.txt	2006-01-15 11:07:40 UTC (rev 41317)
+++ CMF/trunk/CMFDefault/README.txt	2006-01-15 11:08:20 UTC (rev 41318)
@@ -2,5 +2,4 @@
 
   This product declares basic content objects and provides
   default implementation of some of the framework services for
-  the Zope Content Management Framework (CMF).  Please see the
-  CMF "dogbowl site":http://cmf.zope.org, for more details.
+  the Zope Content Management Framework (CMF).

Modified: CMF/trunk/COPYRIGHT.txt
===================================================================
--- CMF/trunk/COPYRIGHT.txt	2006-01-15 11:07:40 UTC (rev 41317)
+++ CMF/trunk/COPYRIGHT.txt	2006-01-15 11:08:20 UTC (rev 41318)
@@ -1,4 +1,4 @@
-Copyright (c) 2004 Zope Corporation (TM) and Contributors.
+Copyright (c) 2006 Zope Corporation (TM) and Contributors.
 All Rights Reserved.
 
 This software is subject to the provisions of the Zope Public License,

Modified: CMF/trunk/GenericSetup/README.txt
===================================================================
--- CMF/trunk/GenericSetup/README.txt	2006-01-15 11:07:40 UTC (rev 41317)
+++ CMF/trunk/GenericSetup/README.txt	2006-01-15 11:08:20 UTC (rev 41318)
@@ -2,11 +2,6 @@
 
   Overview
 
-    This product is a "cut-down" version of the CMFSetup product, shipped
-    with CMF 1.5.x:  it removes all CMF dependencies.  In the ideal world,
-    CMFSetup would depend on this product, and supply the CMF-specific bits
-    (handlers for actions, types, workflows, etc.).
-
     This product provides a mini-framework for expressing the configured
     state of a Zope Site as a set of filesystem artifacts.  These artifacts
     consist of declarative XML files, which spell out the configuration

Modified: CMF/trunk/INSTALL.txt
===================================================================
--- CMF/trunk/INSTALL.txt	2006-01-15 11:07:40 UTC (rev 41317)
+++ CMF/trunk/INSTALL.txt	2006-01-15 11:08:20 UTC (rev 41318)
@@ -1,27 +1,23 @@
-Installing CMF 1.5.0beta
+Installing CMF 2.0
 
   Requirements
 
-    - Zope v. 2.8.2 or later
+    - Zope v. 2.9.0 or later
 
-    - Five v. 1.2 or later (installing a newer version of Five in
-      $INSTANCE_HOME/Products is sufficient to "shadow" the version which
-      ships with Zope).
-
   Assumptions
 
     - New installation
 
     - Zope configured using INSTANCE_HOME, /var/zope, and
-      SOFTWARE_HOME, /usr/local/zope/Zope-2.7.0
+      SOFTWARE_HOME, /usr/local/zope/Zope-2.9.0
 
   Procedure
 
-    1. Unpack the CMF-1.5.0beta.tar.gz tarball into a working
+    1. Unpack the CMF-2.X.tar.gz tarball into a working
        directory. For instance::
 
         $ cd /usr/local/zope
-        $ tar xzf /tmp/CMF-1.5.0beta.tar.gz
+        $ tar xzf /tmp/CMF-2.X.tar.gz
 
        Note for Windows users:  if you are using WinZip to unpack
           the file, be *sure* to disable the "TAR file smart CR/LF
@@ -34,19 +30,21 @@
        For instance::
 
         $ cd /var/zope/Products  # /var/zope is INSTANCE_HOME
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMFCore .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMFDefault .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMFTopic .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMFActionIcons .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMFCalendar .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMFSetup .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMFUid .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/DCWorkflow .
+        $ ln -s /usr/local/zope/CMF-2.X/CMFCore .
+        $ ln -s /usr/local/zope/CMF-2.X/CMFDefault .
+        $ ln -s /usr/local/zope/CMF-2.X/CMFTopic .
+        $ ln -s /usr/local/zope/CMF-2.X/CMFActionIcons .
+        $ ln -s /usr/local/zope/CMF-2.X/CMFCalendar .
+        $ ln -s /usr/local/zope/CMF-2.X/CMFSetup .
+        $ ln -s /usr/local/zope/CMF-2.X/CMFUid .
+        $ ln -s /usr/local/zope/CMF-2.X/DCWorkflow .
+        $ ln -s /usr/local/zope/CMF-2.x/GenericSetup .
 
        or, as a shortcut::
 
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/CMF* .
-        $ ln -s /usr/local/zope/CMF-1.5.0beta/DCWorkflow .
+        $ ln -s /usr/local/zope/CMF-2.X/CMF* .
+        $ ln -s /usr/local/zope/CMF-2.X/DCWorkflow .
+        $ ln -s /usr/local/zope/CMF-2.x/GenericSetup .
 
        Since linking doesn't apply on Windows, you will need
        to cut or copy the files from the place where you unpacked
@@ -58,51 +56,17 @@
     4. Create a CMF Site object. join, and begin adding content.
        Enjoy!
 
-    5. If you want to use CMFCalendar: Build and run the installation
-       ExternalMethod as described in CMFCalendar/INSTALL.txt.
+    5. If you want to use addon functionalities such as CMFCalendar, CMFTopic
+       or CMFUid choose the extension when you set up the CMF site object,
+       or apply the extension from the portal_setup tool at any time after 
+       site creation.
 
-Installing Internationalization (I18N) Support for CMF
 
-  Requirements
-
-    - "Localizer":http://www.localizer.org
-
-    - "TranslationService":http://www.zope.org/Members/efge/TranslationService
-
-    - If you don't have the right language files (.po), you have to translate
-      the messages yourself!
-
-  Assumptions
-
-    - CMF is installed as described above.
-
-  Procedure
-
-    1. From the ZMI of your CMFSite, select "Localizer" from the Add list. Use
-       the default values.
-
-    2. From the "Contents" tab of Localizer, select "MessageCatalog" from the
-       Add list. Use 'CMFMessages' as id.
-
-    3. Use the "Languages" tab of CMFMessages to select the languages you want
-       to support.
-
-    4. From the ZMI of your CMFSite, select "Translation Service" from the Add
-       list. Use the default id.
-
-    5. Use the "Configuration" tab of translation_service to set the
-       MessageCatalog for the default domain to 'Localizer/CMFMessages'.
-
-    6. Go again to the MessageCatalog 'CMFMessages'. If you have the right .po
-       files, import them using the "Import/Export" tab.
-       If you have no .po files, collect the message ids by using your site.
-       Use the 'Messages' tab to translate the collected messages.
-
 Upgrading from Earlier Versions
 
   Install the New Software.
 
-    0. "Download":CMF-1.5.0beta.tar.gz the tarball.
+    0. "Download":CMF-2.X.tar.gz the tarball.
 
     1. Copy your "working" products off to one side (in case
        you need / choose to revert).
@@ -115,6 +79,7 @@
 
   Follow additionnal version-specific information below.
 
+
 Upgrading from versions earlier than CMF 1.3
 
   Add New Metadata: "portal_type"
@@ -139,28 +104,3 @@
       "(Default)" value from the input fields for the "Folder" and
       "Topic" types and click "Change".
 
-Upgrading from CMF 1.0
-
-  Create and Configure New tools
-
-    'portal_metadata' tool
-
-      1. From the ZMI of your CMFSite, select "CMFDefault Tool"
-         from the Add list.  Select "Default Metadata Tool" and
-         click "Add".
-
-      2. Configure the "Elements" tab, particularly the "Subject"
-         element (give it "suggested" subjects, perhaps by
-         looking at the values on the search page).
-
-    'portal_syndication'
-
-      1. From the ZMI of your CMFSite, select "CMFDefault Tool"
-         from the Add list.  Select "Default Syndication Tool"
-         and click "Add".
-
-      2. Use the "Properties" tab to enable syndication for the
-         site (if desired), and then to configure the "sitewide"
-         policies for outbound syndication.  Once enabled, you
-         will be able to toggle syndication and policies for
-         individual folders as well.

Modified: CMF/trunk/INSTALL_SVN.txt
===================================================================
--- CMF/trunk/INSTALL_SVN.txt	2006-01-15 11:07:40 UTC (rev 41317)
+++ CMF/trunk/INSTALL_SVN.txt	2006-01-15 11:08:20 UTC (rev 41318)
@@ -11,11 +11,8 @@
     - See the note below [1] if you want to export or check out
       the sources for a specific version from Subversion.
 
- * Please note that the trunk version of the CMF requires Zope 
-   2.8.2 or later, as well as a more recent version of the Five product
-   (1.2. or later) than the one which sships with Zope.  Installing the
-   later version of Five in $INSTANCE_HOME/Products is sufficient to
-   "shadow" the older version in $SOFTWARE_HOME/Products.
+  * Please note that the trunk version of the CMF requires Zope 
+    2.9.0 or later.
 
   * For help with Subversion in general, see "Version Control with 
     Subversion" at http://svnbook.red-bean.com/
@@ -75,8 +72,6 @@
 
       - GenericSetup
 
-      - CMFSetup
-
       - CMFActionIcons
 
       - CMFUID
@@ -88,8 +83,8 @@
   4. Create a CMF Site:
 
      From the management interface, somewhere in the "main" section of your 
-     site (*not* the Control_Panel!), select "Configured CMF Site" from the 
-     add list.  Fill out the constructor form, and click the "Add" button.
+     site (*not* the Control_Panel!), select "CMF Site" from the add list.  
+     Fill out the constructor form, and click the "Add" button.
 
 Refreshing your Checkout

More information about the CMF-checkins mailing list