= !PloneGoogleSitemaps Installation =

[[PageOutline]]

== quintagroup.plonegooglesitemaps 1.2 version and up  ==

=== Buildout === 

To install quintagroup.plonegooglesitemaps to your buildout-based project:

 * Add '''quintagroup.plonegooglesitemaps''' to the list of eggs to install:
{{{
    [buildout]
    ...
    eggs =
        ...
        quintagroup.plonegooglesitemaps
}}}
       
 * Tell the plone.recipe.zope2instance recipe to install a ZCML slug:
{{{
    [instance]
    recipe = plone.recipe.zope2instance
    ...
    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::

{{{
   $ ./bin/instance restart
}}}   

 * Install ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products) 

=== Traditional Zope 2 instance ===

To install quintagroup.plonegooglesitemaps into the global Python environment (or a workingenv), using a traditional Zope 2 instance, you can do this:

 * Copy '''quintagroup''' folder to your instance's '''/lib/python''' directory.

 * Create a file called '''quintagroup.plonegooglesitemaps-configure.zcml''' in your instance's '''/etc/package-includes''' directory. The file should only contain this:

{{{
    <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:

{{{
   $ ./bin/zopectl restart
}}}

=== IMPORTANT ===

'''Migration'''

If you migrate to quintagroup.plonegooglesitemaps >= v.1.2 - you MUST ADD '''overrides.zcml''' slug to instance/buildout configuration

'''Upgrade'''

If you want to upgrade to newer version:
 * Perform all steps but last one from *Buildout* or *Traditional Zope 2 instance* sections
 * '''Reinstall''' Plone Google Sitemaps with Quickinstaller in Plone (Site Setup -> Add/Remove Products)

'''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.
   * Install '''Plone Google Sitemaps''' with Quickinstaller in Plone (Site Setup -> Add/Remove Products) 

== quintagroup.plonegooglesitemaps 1.0 - 1.1.2 versions ==

=== Buildout === 

To install quintagroup.plonegooglesitemaps to your buildout-based project:

 * Add '''quintagroup.plonegooglesitemaps''' to the list of eggs to install:
{{{
    [buildout]
    ...
    eggs =
        ...
        quintagroup.plonegooglesitemaps
}}}
       
 * Tell the plone.recipe.zope2instance recipe to install a ZCML slug:
{{{
    [instance]
    recipe = plone.recipe.zope2instance
    ...
    zcml =
        quintagroup.plonegooglesitemaps
}}}
      
 * Re-run buildout, e.g. with:

{{{
    $ ./bin/buildout
}}}   
 
 * Restart the Zope server, e.g with the following command in the terminal::

{{{
   $ ./bin/instance restart
}}}   

 * Install ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products) 
        
	
=== Traditional Zope 2 instance ===

To install quintagroup.plonegooglesitemaps into the global Python environment (or a workingenv), using a traditional Zope 2 instance, you can do this:

 * Copy '''quintagroup''' folder to your instance's '''/lib/python''' directory.

 * Create a file called '''quintagroup.plonegooglesitemaps-configure.zcml''' in your instance's '''/etc/package-includes''' directory. The file should only contain this:

{{{
    <include package="quintagroup.plonegooglesitemaps" />
}}}

 * Restart the Zope server, for example with the following command in the terminal:

{{{
   $ ./bin/zopectl restart
}}}

 * Install '''Plone Google Sitemaps''' with Quickinstaller in Plone (Site Setup -> Add/Remove Products) 

== qPloneGoogleSitemaps up to 0.8.5 version ==

qPloneGoogleSitemaps can be installed as old-type Plone product.

 1. Download product package archive from http://plone.org/products/qplonegooglesitemaps/ (e.g. 'qPloneGoogleSitemaps-0.8.5.tar.gz') 
 2. Unpack it to get '''qPloneGoogleSitemaps''' folder.

    * For buildout-based instance
      * Put '''qPloneGoogleSitemaps''' folder into the '''products''' folder of your instance (this is a place for old-style Zope products to be added)
      * Re-run buildout
      * Restart Zope server

    * For traditional instance
      * Put '''qPloneGoogleSitemaps''' folder into the '''Products''' folder of your instance
      * Restart Zope server

 3. Click on the link of the '''Site Setup''' in the top right corner of your Plone site
 1. choose '''Add/Remove Products''' item in the Plone Configuration list
 1. select the product '''qPloneGoogleSitemaps''' among products available for installation
 1. press the '''install''' button below the table and make sure the product appeared in the right column of installed products