#243: Replace workflow history viewlet with content history viewlet

Contents
  1. Definitions
  2. Motivation
  3. Assumptions
  4. Proposal
  5. Implementation
  6. Deliverables
  7. Risks
  8. Progress log
  9. Participants
by Wichert Akkerman — last modified Jan 21, 2010 07:28 AM

Plone stores both workflow history and versioning history for objects. Only workflow history is shown in a viewlet in current Plone versions. I propose to show all history data.

Proposed by
Wichert Akkerman
Seconded by
Danny Bloemeldaal
Proposal type
User interface
Assigned to release
State
completed

Definitions

 

Motivation

The 'history' list in a document view does not show the full history of an object but only the workflow history. We are hiding versioning history information behind a (painfully ugly) history form. This can be confusing, and makes it harder to access versioning information.

 

Assumptions

 

Proposal

I propose two things:

  1. instead of the workflow history viewlet use the content history viewlet that is already in plone.app.layout trunk. This viewlet mixes workflow and versioning information in a single overview and has convenient options to get more information about versioning changes.
  2. remove the history content action and use the content history viewlet as a way to access the history information.

Implementation

Most of the implementation is already done. Ask DannyB for a demonstration if you are at the conference or attending the UI sprint :)

Deliverables

 

Risks

 

Progress log

 

Participants

 

Comments (6)

Martijn Pieters Oct 26, 2008 05:10 PM
+1
Danny Bloemendaal Oct 27, 2008 03:57 PM
+1 of course :)
Andreas Zeidler Oct 27, 2008 10:05 PM
+1
Tom Lazar Oct 28, 2008 10:31 AM
+1 (Love how obvious the solution seems in hindsight ;-) good one, wiggy!
Tom Lazar Jan 30, 2009 07:36 PM
PLIP 243 framework review #1 by Tom Lazar (tomster), 2009-01-30
===============================================================

review steps
------------

the bundle was reviewed on OSX 10.5.6 doing the following:

  * bundle checkout, buildout etc

  * visual review of code changes in `plone.app.layout`__

  * test runs for `Products.CMFPlone` and `plone.app.layout`

  * manual function tests to verify things work as intended

.. __: http://dev.plone.org/plone/[…]243-content-history%4024379

notes and observations
----------------------

Running test for `Products.CMFPlone` and `plone.app.layout` resulted in several failures
for CMFPlone but none for `plone.app.layout`.

After adding a Plone instance visiting its front-page resulted in the following error (which also
occurred multiple times during the test runs):

    TypeError: ulocalized_time() got multiple values for keyword argument 'domain'

The manual test had to be aborted.

conclusion
----------

While I still support the goal of the PLIP the errors mentioned aboved are a clear -1.
I'm confident that this issue can be resolved during the second review period.
Tom Lazar Feb 02, 2009 07:17 PM
Second review after fixes (2009-02-02)
--------------------------------------

After fixes by Wichert and Danny the picture looks much prettier :-)

 * All but two tests passed. One is explicitely related to another ticket and irrelevant to this PLIP.

 * The other simply failed due to the changes made by this PLIP, so I took the liberty of `fixing it
    on the spot<https://dev.plone.org/plone/changeset/24828>`_

 * Manual tests worked fine without anything unexpected.

 * I do think the icons look too different from the rest of Plone's default look but that's just
   my personal taste, no showstopper.

conclusion (updated)
--------------------

After the recent changes I am now +1 on merging.