Metadata-Version: 1.1
Name: collective.revisionmanager
Version: 0.6
Summary: Manage CMFEditions Histories
Home-page: https://pypi.python.org/pypi/collective.revisionmanager
Author: tschorr
Author-email: t_schorr@gmx.de
License: GPL version 2
Description: .. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
           If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html
           This text does not appear on pypi or github. It is a comment.
        
        ==============================================================================
        collective.revisionmanager
        ==============================================================================
        
        .. image:: http://img.shields.io/pypi/v/collective.revisionmanager.svg
            :target: https://pypi.python.org/pypi/collective.revisionmanager
        
        .. image:: https://img.shields.io/travis/collective/collective.revisionmanager/master.svg
            :target: http://travis-ci.org/collective/collective.revisionmanager
        
        .. image:: https://img.shields.io/coveralls/collective/collective.revisionmanager/master.svg
            :target: https://coveralls.io/r/collective/collective.revisionmanager
        
        collective.revisionmanager is a Plone add-on that lets you manage Products.CMFEditions histories. It can be used with Plone 5.0 and Plone 4.3. You will need Products.CMFEditions version >= 2.2.16.
        
        Features
        --------
        
        - Sorted listing of histories storage (portal_historiesstorage) contents. Sort by: history id, number of versions, history size, size state, portal type or path
        - Purge revisions or delete entire histories
        - Maintain a cache for the statistics
        - Plone controlpanel interface for portal_purgepolicy
        
        Translations
        ------------
        
        Brazilian Portuguese, German and Spanish translations are available.
        
        Installation
        ------------
        
        Install collective.revisionmanager by adding it to your buildout::
        
            [buildout]
        
            ...
        
            eggs =
                collective.revisionmanager
        
        and then running ``bin/buildout``. During installation, ``collective.revisionmanager`` will check wether the ``cmf_uid`` catalog index is there - if not, the index will be added and indexed. This step may require a considerable amount of time depending on the number of objects and object revisions in your database. Also, a cache for the statistics will be created.
        
        After installation, you will have to calculate the statistics initially before you can see anything. Statistics calculation was done automatically during installation in earlier releases, but for sites with large databases and limited memory it may be necessary to configure subtransactions prior to updating the cache.
        
        Calculating Statistics
        ----------------------
        
        Before you can use `collective.revisionmanager` you need to fill its history statistics cache. You can do so by visting Plone Control Panel -> Addon Configuration -> Manage Revisions and then clicking on the ``Recalculate Statistics`` button. Calculation may take a lot of time if you have lots of objects and object revisions in your database.
        
        You will have to recalculate statistics from time to time to keep them up to date at intervals depending on database activity.
        
        **Dealing with catalog inconsistencies**
        
        If the installation fails with an ``AttributeError`` in ``Products.ZCatalog.CatalogBrains``, your ``portal_catalog`` is inconsistent and you need to `rebuild <http://docs.plone.org/develop/plone/searching_and_indexing/catalog.html>`_ it. As a quick workaround, you can also simply clear (or even delete) the ``cmf_uid`` catalog index - ``collective.revisionmanager`` will rebuild it during installation. But be aware that your ``portal_catalog`` is still inconsistent and needs rebuilding.
        
        Contribute
        ----------
        
        - Issue Tracker: https://github.com/collective/collective.revisionmanager/issues
        - Source Code: https://github.com/collective/collective.revisionmanager
        - Documentation: tbd
        
        License
        -------
        
        The project is licensed under the GPLv2.
        
        Contributors
        ============
        
        - tschorr, t_schorr@gmx.de
        - Hector Velarde
        
        Changelog
        =========
        
        0.6 (2016-11-04)
        ----------------
        
        - Add Brazilian Portuguese and Spanish translations.
          [hvelarde]
        
        - Fix package uninstall.
          [hvelarde]
        
        - Fix package dependencies.
          Remove needless dependency on z3c.jbot.
          [hvelarde]
        
        
        0.5 (2016-04-29)
        ----------------
        
        - do not calculate statistics during installation. This allows to
          configure subtransactions (and thereby memory consumption) before
          calculating statistics initially
        - add more german translations
        - more work on i18n
        - fix KeyError when sorting by portal_type
        - add button to delete all histories without working copy at once
        
        0.4 (2016-04-19)
        ----------------
        
        - introducing subtransactions to save memory
        - more work on german translations
        
        0.3 (2016-04-06)
        ----------------
        
        - add some german translations
        - handle POSKeyError when accessing inconsistent histories storage
        
        0.2 (2016-03-02)
        ----------------
        
        - revisions controlpanel now works in Plone 5
        - Replace Update Statistics View by a button in controlpanel
        - Travis testing for Plone 4.3.x and 5.0.x
        - check for marker file in post install step
        
        0.1 (2016-03-01)
        ----------------
        
        - Initial release.
        
        
Keywords: Python Plone
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Framework :: Plone :: 5.0
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
