collective.wfautodoc 1.2.0

Generates a Graphviz file (or directly creates an SVG) from a Zope/CMF DCWorkflow defintion.

Automatic Workflow Documentation

Generates a Graphviz file (or directly creates an SVG) from a Zope/CMF DCWorkflow defintion.

Usage:

• in ZMI got to the workflow which you want to document.

• there are two additional tabs one for raw DOT data file, one for a rendered SVG file.

Features:

• generation of Graphviz file with states and transitions.

• each state shows a permissions-table

• each transition shows its guards.

Todo:

• add views to control_panel

Installation

Just depend in your buildout on the egg collective.wfautodoc. When used within Plone ZCML is loaded automagically with `z3c.autoinclude`. Otherwise add the package to buildout section `instance` `zcml` variable.

This package is written for Plone but works also in a pure Zope2/CMF environment.

Source Code and Contributions

If you want to help with the development (improvement, update, bug-fixing, …) of collective.wfautodoc this is a great idea!

The code is located in the github collective.

You can clone it or get access to the github-collective and work directly on the project.

Maintainer is Jens Klein and the BlueDynamics Alliance developer team. We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us dev@bluedynamics dot com

Contributors

• Jens W. Klein <[e-mail]>

History

1.2.0 (2021-07-07)

• Some code-style and make it work with Python 3/ Zope 4. [jensens]

• Fix bug with special characters in review states. [cedricmessiant]

1.1

• not zipsafe, removes superfluos generic setup references. thx to SyZn for contribution. [jensens, 2013-12-03]

1.0

• make it work [jensens, 2012-03-01]