Progress bar based on current document review_state
Project description
A system that visually display a workflow percentage bar or a workflow steps trail in the publishing process of a document according with the workflow state in which the document is. It also define editing progress (document completion) of an item with customizable labels per field.
Contents
Main features
- Visually display editing progress (document completion) of an item.
- Visually display a workflow percentage bar/steps trail in the publishing process of a document according with the workflow state in which the document is.
- Visually display a computed workflow percentage bar for Collections according with the children / query results items progress
- Visually display workflow percentage bars for items within Collection tabular view
- Possibility to hide/exclude certain states in progress bar (by default hide all states with defined percentage lower than/equal 0, configurable via Site Setup > Progress Bar Settings)
Install
- Add eea.progressbar to your eggs section in your buildout and re-run buildout. You can download a sample buildout from https://github.com/eea/eea.progressbar/tree/master/buildouts/plone4
- Install EEA Progress Bar within Site Setup > Add-ons
Getting started
- Go to ZMI > portal_workflows > Contents Tab and select your workflow
- Click on Progress monitoring Tab and update % done for each state
- Go to Plone Site > Working space and add a Progress bar portlet
- Or add a Collection, add Progress column for tabular view and enable tabular view for this Collection.
- Or go to Site Setup > Progress Bar Settings > Edit and enable Progress Bar viewlets for your content-types.
- Go to Site Setup > Progress Bar Settings > Edit and Enable metadata progress viewlet for Page; Go to Site Setup > Progress Bar Settings > Document and customize your document completion strategy for this content-type and then see it in action within a Page.
Dependencies
- plone.app.collection >= 1.0.11
- eea.jquery >= 7.7
- eea.icons
Source code
- Latest source code (Plone 4 compatible): https://github.com/eea/eea.progressbar
Copyright and license
The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.
The EEA Progress Bar (the Original Code) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
More details under docs/License.txt
Changelog
3.6 - (2016-08-31)
- Bug fix: take into consideration that progress might return None in which case progress should be 0 [ichim-david refs #75314]
3.5 - (2016-05-19)
- Bug fix: Fix pylint warnings [ichim-david refs #71940]
3.4 - (2015-03-17)
- Change: Switched to curl in the jenkins build install script [olimpiurob refs #22402]
- Change: Changed fetch url for jenkins build install script to the install script from the main EEA CPB repository [olimpiurob refs #22402]
3.3 - (2015-01-22)
- Bug fix: Fixed anchors links for editing progress [olimpiurob refs #19754]
- Feature: added rdfexport of progressLevel if eea.rdfmarshaller is installed [ichim-david refs #21617]
3.2 - (2014-12-23)
- Change: Add the new widgets at the beginning of the list [olimpiurob refs #20470]
- Bug fix: Treat case where the widget’s condition could not be evaluated. The widget’s default condition has also been changed. [olimpiurob refs #20470]
- Feature: Added possibility to add custom cards via eea.progressbar control panel [olimpiurob refs #20470]
3.1 - (2014-08-12)
- Bug fix: Include i18n translations [avoinea]
- Bug fix: Fixed permissions on tool edit form [avoinea]
3.0 - (2014-05-13)
- Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA Progress Bar [voineali refs #17713]
- Feature: Added Editing progress (document completion) viewlet/portlet based on item schema fields completion [voineali refs #17713]
2.2 - (2014-01-22)
- Feature: Handle states with same percentage [olimpiu #17712]
- Bug fix: Fixed progressbar failing for Collections containing objects with no workflow. Default to ‘publish’ state for objects with no workflow. [olimpiu #17873]
- Bug fix: Fixed Workflow Steps Trail Progress bar failing for Collections [olimpiu #17873]
- Change: Added custom css classes for each state in Workflow Steps Trail Progress bar. [olimpiu #17711]
- Feature: Add font awesome icons for Workflow Steps Trail Progress Bar [olimpiu #17711]
- Bug fix: Refresh workflow steps trail when state is changed via AJAX [voineali fixes #17758]
- Change: updated docsting progress bar fields class [ghicaale refs #16666]
- Feature: adding Sphinx-generated documentation in Page Template format [batradav refs #9502]
2.1 - (2013-12-10)
- Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA Progress Bar
- Change: Replace cryptic workflow state id with state title within ZMI > Progress monitoring Tab [voineali refs #17669]
- Feature: Add title and description within Workflow Steps Trail Portlet on mouse hover [voineali refs #17669]
- Feature: Possibility to hide/exclude certain states in progress bar [voineali refs #17570]
- Bug fix: Name schema extender adapters in order to avoid overriding existing ones [avoinea]
- Bug fix: Cleanup portlets on uninstall [avoinea]
2.0 - (2013-11-22)
- Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA Progress Bar
- Feature: Added a new viewlet/portlet Workflow Steps Trail [voineali refs #17491]
- Change: Renamed viewlet/portlet Progress Bar to Workflow Percentage Bar [voineali refs #17491]
1.3 - (2013-09-23)
- Upgrade step: (optional) Manually update progressbar viewlet visibility per content-type within Site Setup > Progress Bar Settings [voineali refs #16759]
- Upgrade step: (optional) Manually reorder JS / CSS resources (++resource++eea.progressbar.js, ++resource++eea.progressbar.css) within ZMI > portal_javascripts / portal_css in order to optimize requests per page. [voineali refs #16721]
- Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for eea.progressbar [voineali refs #16721]
- Feature: Added possibility to show/hide progress bar viewlet per content-type via Plone ControlPanel and also to show/hide it per object instance via Plone edit form [voineali refs #16759]
- Feature: Hanlde eea.workflow async workflow change [voineali refs #16721]
- Bug fix: Use workflow state title instead of state id for progress bar labels and tooltips [voineali refs #16704]
1.1 - (2013-08-22)
- Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for eea.progressbar
- Feature: Added eea.progressbar viewlet near state menu [voineali refs #15662]
- Feature: Added uninstall profile in order to cleanly remove this add-on [voineali]
1.0 - (2013-08-14)
- Initial release [voineali refs #14901]: - Progress bar portlet for portal objects - Progress bar portlet for collections based on children/query results progress - Progress column for Collection table view
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size eea.progressbar-3.6.zip (728.9 kB) | File type Source | Python version None | Upload date | Hashes View |