https://github.com/imio/imio.history
Manage object history using a table and highlight history link when necessary
https://github.com/imio/imio.history
Last synced: 5 months ago
JSON representation
Manage object history using a table and highlight history link when necessary
- Host: GitHub
- URL: https://github.com/imio/imio.history
- Owner: IMIO
- License: gpl-2.0
- Created: 2015-03-24T19:23:02.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T09:10:29.000Z (over 1 year ago)
- Last Synced: 2024-12-19T10:25:12.372Z (over 1 year ago)
- Language: Python
- Size: 174 KB
- Stars: 0
- Watchers: 16
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE.rst
Awesome Lists containing this project
README
.. image:: https://github.com/IMIO/imio.history/actions/workflows/main.yml/badge.svg?branch=master
:target: https://github.com/IMIO/imio.history/actions/workflows/main.yml
.. image:: https://coveralls.io/repos/IMIO/imio.history/badge.svg
:target: https://coveralls.io/r/IMIO/imio.history
.. image:: http://img.shields.io/pypi/v/imio.history.svg
:alt: PyPI badge
:target: https://pypi.org/project/imio.history
imio.history
============
Manage object history using a table and highlight history link when necessary
The goal is to be able to manage several histories for various needs on a content and display it together, merged in the same view.
Adapters implementing the `IImioHistory` interface
--------------------------------------------------
To do this, we must ensure that the histories use same structure. We base the work on the `workflow_history`, though a custom history may have additional keys if necessary.
The workflow_history could looks like :
.. code-block:: python
{'my_custom_workflow': (
{'action': None, 'review_state': 'private', 'actor': 'user_id1',
'comments': '', 'time': DateTime('2018/03/27 09:51:55.303708 GMT+2')},
{'action': 'publish', 'review_state': 'published',
'comments': '', 'actor': 'user_id1', 'time': DateTime('2018/03/29 15:35:24.646745 GMT+2')},
{'action': 'retract', 'review_state': 'private',
'comments': 'My comments', 'actor': 'admin', 'time': DateTime('2018/03/29 15:35:27.246169 GMT+2')})}
Histories are made available thru a named adapter that implements the `IImioHistory` interface.
By default, adapters are provided for the `workflow_history` (`ImioWfHistoryAdapter`) and revisions history (`ImioRevisionHistoryAdapter`).
The `@@historyview`
-------------------
The `@@historyview` will display the histories as a table with each information in a column : action, author, date/time, comments.
You define in the `histories_to_handle` attribute of the view, what histories (named adapters) it should display.
Every histories are sorted together on the `time` key as it uses the same structure.
Translations
------------
This product has been translated into
- French.
- Spanish.
You can contribute for any message missing or other new languages, join us at `PloneGov iMiO Team `_ into *Transifex.net* service with all world Plone translators community.