Introduction
============

This product depends on cmf.pt to automatically pull it and five.pt into an ERP5
instance without needing any further ZCML configuration.

Installation
============

Add "Products.ERP5Chameleon" to the list of eggs of the part that defines your
Zope instance and rerun 'buildout'. This should be all that is required to
activate the five.pt patches and accellerate Zope Page Templates.

No migration is needed.

To cache the results of Chameleon compilations, the following environment
variables should be defined:

  * "CHAMELEON_DEBUG=1"
  * "CHAMELEON_CACHE=/path/to/intended/cache"

This caching is useful to preserve the results of compilation between Zope
restarts. On a Cluster environment, this cache can be shared between Zope
instances, for example, with NFS.

In a buildout environment, the above configuration can be achieved by
specifying something like this in the "zc.recipe.egg" based part that generates
your instance scripts::

  initialization +=
    os.environ['CHAMELEON_DEBUG'] = '1'
    os.environ['CHAMELEON_CACHE'] = '${buildout:directory}/cache'

Notice that this step is **completely optional**. Also notice that if you are
developing any one of "Chameleon", "z3c.pt" or "five.pt", then you should
**wipe the cache** between restarts and test runs. The same applies if you
upgrade any of the packages above to newer versions.

Failure to wipe the cache will result in hard to understand errors where the old
behaviour of these packages is manifested even in the presence of new packages.

Removal
=======

Simply remove "Products.ERP5Chameleon" from the list of eggs of the part that
defines your Zope instance and rerun buildout. No migration is necessary.

This is useful if you suspect a ZPT bug is being caused by any of the Chameleon
packages.