.. 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:: https://img.shields.io/pypi/v/collective.revisionmanager.svg
:target: https://pypi.python.org/pypi/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 6.0, 5.2, 5.1, 5.0 (untested) and Plone 4.3.
You will need Products.CMFEditions version >= 2.2.16.
This is available by default in the latest bugfix releases of all supported Plone versions.
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 <https://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.
Always make sure the ``cmf_uid`` index is consistent because it is used to determine the working copy of a history. Incorrectly indexed content will show up as having no working copy in the histories list!
Contribute
----------
- Issue Tracker: https://github.com/collective/collective.revisionmanager/issues
- Source Code: https://github.com/collective/collective.revisionmanager
- Documentation: https://github.com/collective/collective.revisionmanager/README.rst
License
-------
The project is licensed under the GPLv2.
Contributors
============
- Thomas Schorr, t_schorr@gmx.de
- Hector Velarde
Changelog
=========
1.2.3 (2025-07-15)
------------------
- Internal: create a universal wheel and use setuptools<69 for releasing. [maurits]
1.2.2 (2022-09-16)
------------------
- Added Dutch translations. [jladage]
- Use Bootstrap classes on buttons to look nicer in Plone 6. [jladage]
1.2.1 (2022-07-05)
------------------
- Let the histories table look nicer in Plone 6. [maurits]
- Fixed link to Site Setup to work in all supported Plone versions. [maurits]
1.2.0 (2021-10-28)
------------------
- Allow all Managers to use the full control panel.
Until now, for some parts you needed to be Manager in the Zope root.
Fixes `issue 30 <https://github.com/collective/collective.revisionmanager/issues/30>`_.
[maurits]
- Test with Plone 6 (still also on 4.3, 5.1, 5,2) and on GitHub Actions.
[maurits]
1.1.0 (2021-09-16)
------------------
- Fixes a bug in Plone 5.2 ('RequestContainer' object has no attribute
'translate')
[pysailor]
- Drop CMFQuickInstaller dependency. [pbauer]
1.0.0 (2020-08-18)
------------------
- Add support for Python 3.
[pbauer,maurits,tschorr]
0.9 (2019-10-07)
----------------
- Fixed deleting orphans in Plone 5.1+ (CMFEditions 3).
Fixes `issue #19 <https://github.com/collective/collective.revisionmanager/issues/19>`_. [maurits]
- Fixed startup error by loading the CMFCore zcml. [maurits]
0.8 (2017-08-31)
----------------
- Do not fail on ``BrokenModified`` while calculating storage statistics.
[pbauer]
- UX-Improvements: Display size in a human-readable format, allow to increase the batch-size with a query-string, allow selecting all items.
[pbauer]
- In addition to the overall number of revisions, also display the number of purged revisions (fixes `#14 <https://github.com/collective/collective.revisionmanager/issues/14>`_).
[tschorr]
- Decrease log level for logging processing of each history (fixes `#15 <https://github.com/collective/collective.revisionmanager/issues/15>`_).
[tschorr]
- Add script to rebuild i18n stuff and update translations.
[hvelarde]
0.7 (2016-11-29)
----------------
- Do not fail on ``POSKeyError`` while calculating storage statistics (fixes `#9 <https://github.com/collective/collective.revisionmanager/issues/9>`_).
[tschorr]
- Storage statistics calculation now works behind a proxy (fixes `#8 <https://github.com/collective/collective.revisionmanager/issues/8>`_).
[tschorr]
- Fix a typo. This requires to run an update step (see `#10 <https://github.com/collective/collective.revisionmanager/issues/10>`_).
[tschorr]
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.
Raw data
{
"_id": null,
"home_page": "https://pypi.python.org/pypi/collective.revisionmanager",
"name": "collective.revisionmanager",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Python Plone",
"author": "Thomas Schorr",
"author_email": "t_schorr@gmx.de",
"download_url": "https://files.pythonhosted.org/packages/fa/de/1f3baa01b70df9b2f12d118c1db45d40c0cd358b045935bdbd83b3efc62f/collective.revisionmanager-1.2.3.tar.gz",
"platform": null,
"description": ".. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html\n This text does not appear on pypi or github. It is a comment.\n\n==============================================================================\ncollective.revisionmanager\n==============================================================================\n\n.. image:: https://img.shields.io/pypi/v/collective.revisionmanager.svg\n :target: https://pypi.python.org/pypi/collective.revisionmanager\n\n.. image:: https://img.shields.io/coveralls/collective/collective.revisionmanager/master.svg\n :target: https://coveralls.io/r/collective/collective.revisionmanager\n\ncollective.revisionmanager is a Plone add-on that lets you manage Products.CMFEditions histories.\nIt can be used with Plone 6.0, 5.2, 5.1, 5.0 (untested) and Plone 4.3.\nYou will need Products.CMFEditions version >= 2.2.16.\nThis is available by default in the latest bugfix releases of all supported Plone versions.\n\nFeatures\n--------\n\n- Sorted listing of histories storage (portal_historiesstorage) contents. Sort by: history id, number of versions, history size, size state, portal type or path\n- Purge revisions or delete entire histories\n- Maintain a cache for the statistics\n- Plone controlpanel interface for portal_purgepolicy\n\nTranslations\n------------\n\nBrazilian Portuguese, German and Spanish translations are available.\n\nInstallation\n------------\n\nInstall collective.revisionmanager by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n collective.revisionmanager\n\nand 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.\n\nAfter 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.\n\nCalculating Statistics\n----------------------\n\nBefore 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.\n\nYou will have to recalculate statistics from time to time to keep them up to date at intervals depending on database activity.\n\n**Dealing with catalog inconsistencies**\n\nIf the installation fails with an ``AttributeError`` in ``Products.ZCatalog.CatalogBrains``, your ``portal_catalog`` is inconsistent and you need to `rebuild <https://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.\n\nAlways make sure the ``cmf_uid`` index is consistent because it is used to determine the working copy of a history. Incorrectly indexed content will show up as having no working copy in the histories list!\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.revisionmanager/issues\n- Source Code: https://github.com/collective/collective.revisionmanager\n- Documentation: https://github.com/collective/collective.revisionmanager/README.rst\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\nContributors\n============\n\n- Thomas Schorr, t_schorr@gmx.de\n- Hector Velarde\n\nChangelog\n=========\n\n1.2.3 (2025-07-15)\n------------------\n\n- Internal: create a universal wheel and use setuptools<69 for releasing. [maurits]\n\n\n1.2.2 (2022-09-16)\n------------------\n\n- Added Dutch translations. [jladage]\n\n- Use Bootstrap classes on buttons to look nicer in Plone 6. [jladage]\n\n\n1.2.1 (2022-07-05)\n------------------\n\n- Let the histories table look nicer in Plone 6. [maurits]\n\n- Fixed link to Site Setup to work in all supported Plone versions. [maurits]\n\n\n1.2.0 (2021-10-28)\n------------------\n\n- Allow all Managers to use the full control panel.\n Until now, for some parts you needed to be Manager in the Zope root.\n Fixes `issue 30 <https://github.com/collective/collective.revisionmanager/issues/30>`_.\n [maurits]\n\n- Test with Plone 6 (still also on 4.3, 5.1, 5,2) and on GitHub Actions.\n [maurits]\n\n\n1.1.0 (2021-09-16)\n------------------\n\n- Fixes a bug in Plone 5.2 ('RequestContainer' object has no attribute\n 'translate')\n [pysailor]\n\n- Drop CMFQuickInstaller dependency. [pbauer]\n\n\n1.0.0 (2020-08-18)\n------------------\n\n- Add support for Python 3.\n [pbauer,maurits,tschorr]\n\n\n0.9 (2019-10-07)\n----------------\n\n- Fixed deleting orphans in Plone 5.1+ (CMFEditions 3).\n Fixes `issue #19 <https://github.com/collective/collective.revisionmanager/issues/19>`_. [maurits]\n\n- Fixed startup error by loading the CMFCore zcml. [maurits]\n\n\n0.8 (2017-08-31)\n----------------\n\n- Do not fail on ``BrokenModified`` while calculating storage statistics.\n [pbauer]\n\n- UX-Improvements: Display size in a human-readable format, allow to increase the batch-size with a query-string, allow selecting all items.\n [pbauer]\n\n- In addition to the overall number of revisions, also display the number of purged revisions (fixes `#14 <https://github.com/collective/collective.revisionmanager/issues/14>`_).\n [tschorr]\n\n- Decrease log level for logging processing of each history (fixes `#15 <https://github.com/collective/collective.revisionmanager/issues/15>`_).\n [tschorr]\n\n- Add script to rebuild i18n stuff and update translations.\n [hvelarde]\n\n\n0.7 (2016-11-29)\n----------------\n\n- Do not fail on ``POSKeyError`` while calculating storage statistics (fixes `#9 <https://github.com/collective/collective.revisionmanager/issues/9>`_).\n [tschorr]\n\n- Storage statistics calculation now works behind a proxy (fixes `#8 <https://github.com/collective/collective.revisionmanager/issues/8>`_).\n [tschorr]\n\n- Fix a typo. This requires to run an update step (see `#10 <https://github.com/collective/collective.revisionmanager/issues/10>`_).\n [tschorr]\n\n\n0.6 (2016-11-04)\n----------------\n\n- Add Brazilian Portuguese and Spanish translations.\n [hvelarde]\n\n- Fix package uninstall.\n [hvelarde]\n\n- Fix package dependencies.\n Remove needless dependency on z3c.jbot.\n [hvelarde]\n\n\n0.5 (2016-04-29)\n----------------\n\n- do not calculate statistics during installation. This allows to\n configure subtransactions (and thereby memory consumption) before\n calculating statistics initially\n- add more german translations\n- more work on i18n\n- fix KeyError when sorting by portal_type\n- add button to delete all histories without working copy at once\n\n0.4 (2016-04-19)\n----------------\n\n- introducing subtransactions to save memory\n- more work on german translations\n\n0.3 (2016-04-06)\n----------------\n\n- add some german translations\n- handle POSKeyError when accessing inconsistent histories storage\n\n0.2 (2016-03-02)\n----------------\n\n- revisions controlpanel now works in Plone 5\n- Replace Update Statistics View by a button in controlpanel\n- Travis testing for Plone 4.3.x and 5.0.x\n- check for marker file in post install step\n\n0.1 (2016-03-01)\n----------------\n\n- Initial release.\n\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Manage CMFEditions Histories",
"version": "1.2.3",
"project_urls": {
"Homepage": "https://pypi.python.org/pypi/collective.revisionmanager"
},
"split_keywords": [
"python",
"plone"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f1de93ef863e7016136bd83f7d4cfd08a6dd9580d0e575e82b5a7b3784fe9ce1",
"md5": "3759c147e58a4fc921356ecd01ef7a7d",
"sha256": "4b8a763852297bacb5af3f812f0ff2d518cea752c6eff482f7a755c376bca6a7"
},
"downloads": -1,
"filename": "collective.revisionmanager-1.2.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3759c147e58a4fc921356ecd01ef7a7d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 62064,
"upload_time": "2025-07-15T19:00:44",
"upload_time_iso_8601": "2025-07-15T19:00:44.563684Z",
"url": "https://files.pythonhosted.org/packages/f1/de/93ef863e7016136bd83f7d4cfd08a6dd9580d0e575e82b5a7b3784fe9ce1/collective.revisionmanager-1.2.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fade1f3baa01b70df9b2f12d118c1db45d40c0cd358b045935bdbd83b3efc62f",
"md5": "d4fd1054ec1ea551a9e802494cc97b0d",
"sha256": "32c764d878a1d7518c5e2c21d1b6265909da4b0f35bdda0507a04569c5d596c4"
},
"downloads": -1,
"filename": "collective.revisionmanager-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "d4fd1054ec1ea551a9e802494cc97b0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43699,
"upload_time": "2025-07-15T19:00:45",
"upload_time_iso_8601": "2025-07-15T19:00:45.908844Z",
"url": "https://files.pythonhosted.org/packages/fa/de/1f3baa01b70df9b2f12d118c1db45d40c0cd358b045935bdbd83b3efc62f/collective.revisionmanager-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-15 19:00:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collective.revisionmanager"
}
JSON