https://github.com/eea/eea.progressbar
Workflow/editing progress tools for Plone
https://github.com/eea/eea.progressbar
Last synced: about 1 year ago
JSON representation
Workflow/editing progress tools for Plone
- Host: GitHub
- URL: https://github.com/eea/eea.progressbar
- Owner: eea
- Created: 2013-07-23T13:33:41.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T15:07:04.000Z (over 3 years ago)
- Last Synced: 2025-03-25T04:51:12.183Z (about 1 year ago)
- Language: Python
- Homepage: http://eea.github.com/docs/eea.progressbar
- Size: 684 KB
- Stars: 2
- Watchers: 51
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
================
EEA Progress Bar
================
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.progressbar/develop
:target: https://ci.eionet.europa.eu/job/eea/job/eea.progressbar/job/develop/display/redirect
:alt: develop
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.progressbar/master
:target: https://ci.eionet.europa.eu/job/eea/job/eea.progressbar/job/master/display/redirect
:alt: master
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.
.. image:: https://eea.github.io/_images/eea.progressbar.cover.png
:target: http://www.youtube.com/watch?v=a_U0tmw-4As&list=PLVPSQz7ahsBwUHixUt_s0kh-vaik_NCtO&feature=share
Contents
========
.. 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
===============
1. Go to *ZMI > portal_workflows > Contents Tab* and select your workflow
2. Click on *Progress monitoring Tab* and update *% done* for each state
3. Go to Plone Site > Working space and add a Progress bar portlet
4. Or add a Collection, add Progress column for tabular view and enable tabular
view for this Collection.
5. Or go to *Site Setup > Progress Bar Settings > Edit* and enable Progress Bar
viewlets for your content-types.
6. 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
Live demos
==========
- `Editing progress `_
- `Workflow Steps and Workflow percentage bar `_
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
Funding
=======
EEA_ - European Environment Agency (EU)
.. _EEA: https://www.eea.europa.eu/