Changeset 2248 in products for quintagroup.plonegooglesitemaps

Timestamp:

Apr 30, 2010 1:37:49 PM (14 years ago)

Author:

mylan

Message:

#151: update documentations

Location:

quintagroup.plonegooglesitemaps/trunk

Files:

• README.txt (modified) (2 diffs)
• docs/INSTALL.txt (modified) (4 diffs)

quintagroup.plonegooglesitemaps/trunk/README.txt

@@ -6 +6 @@
 Plone Google Sitemaps product allows Plone websites to get better visibility for Google search engine
 by providing it with complete listing of URLs to website content.
-  
+
 Plone Google Sitemaps allows you to enable different kinds of Google Sitemaps on your Plone website. 
 Such Sitemaps help Google identify site URLs and the data under each site section. With Google Sitemaps
@@ -68 +68 @@
 * Nazar Ilchuk 
 * Mykola Kharechko
-
-

quintagroup.plonegooglesitemaps/trunk/docs/INSTALL.txt

@@ -22 +22 @@
     zcml =
         quintagroup.plonegooglesitemaps
-      
+        quintagroup.plonegooglesitemaps-overrides
+
 * Re-run buildout, e.g. with::
 
     $ ./bin/buildout
-    
+
 * Restart the Zope server, e.g with the following command in the terminal::
 
@@ -32 +33 @@
    
 * Install ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products) 
-        
-        
+
+
 Traditional Zope 2 instance
 ---------------------------
@@ -47 +48 @@
     <include package="quintagroup.plonegooglesitemaps" />
 
+* Create a file called ``quintagroup.plonegooglesitemaps-overrides.zcml`` in your instance's ``/etc/package-includes`` directory. The file
+should only contain this::
+
+    <include package="quintagroup.plonegooglesitemaps" file="overrides.zcml" />
+
 * Restart the Zope server, for example with the following command in the terminal::
 
@@ -57 +63 @@
 ---------
 
-* After installation portal_catalog rebuild needed.
-  By default catalog NOT rebuilded. You may rebuild catalog in 2 ways:
-   ** by hand: go to /<plone instance id>/portal_catalog/manage_catalogAdvanced
-       and push *Update* button.
-   ** allow catalog rebuilding on quintagroup.plonegooglesitemap installation.
-      For that - set *UPDATE_CATALOG* property to *True* in
-      quintagroup.plonegooglesitemaps.config python module.
+* *If you migrate* to quintagroup.plonegooglesitemaps >= v.1.2 - you MUST ADD overrides.zcml
+  slug to instance/buildout configuration, as mentioned in previous sections.
+
+* Catalog rebuilding:
+  ------------------
+  * For quintagroup.plonegooglesitemaps >= v.1.2:
+    catalog rebuilding will be made automatically, with updating *canonical_link*
+    metadata *only*.
+  * For quintagroup.plonegooglesitemaps < v.1.2:
+    after installation portal_catalog rebuild needed.
+    By default catalog NOT rebuilded. You may rebuild catalog in 2 ways:
+     ** by hand: go to /<plone instance id>/portal_catalog/manage_catalogAdvanced
+         and push *Update* button.
+     ** allow catalog rebuilding on quintagroup.plonegooglesitemap installation.
+        For that - set *UPDATE_CATALOG* property to *True* in
+        quintagroup.plonegooglesitemaps.config python module.
+
+