Package: rbco.wfdocumentator
ContentsOverviewRequirementsInstallationUsageTo-doCreditsContribute and report bugsThanksHistory1.0.0 (2015-08-27)0.0.4 (2011-06-13)0.0.3 (22-november-2009)0.0.2 (22-november-2009)0.0.1 (03-june-2009)OverviewThis add-on for Zope and Plone aims to provide user-friendly automatically
generated documentation about workflow definitions.Currently the following Zope3-style views forProducts.DCWorkflow.interfaces.IDCWorkflowDefinitionare provided:@@wf-graph: Render an image representing the workflow’s states and
transitions as a graph.@@wf-doc: Render an HTML page describing the workflow. This includes
the graph mentioned above.@@wf-doc-user-friendly: Same as@@wf-docbut hides some roles and permissions and the
“acquire” column.@@wf-validate: Validate the workflow according to a set of general rules.RequirementsTested with Plone 4.3.x. However only Zope 2 is required (hopefuly).Graphviz. More precisely: there must be an executable calleddotin the
system path and the user running Zope must have execute permission on it.Other requirements are pure Python packages registered on PyPI and distutils
should handle them without problems.WarningIt was not tested on Windows. I suspect it won’t work because of the name
of the executable, i.edot!=dot.exe.InstallationThis package is easy_install’able. Just make it available in your Zope Instance
and don’t forget to load its ZCMLs. If you don’t have any idea of what I’m
talking about please refer toInstalling an Add-on Product.UsageJust use the provided views on an workflow definition. Examples (type these
URLs in your browser):http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-graphhttp://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-docYou can pass the following parameters to @@wf-graph in the query string:hide_rolesandhide_permissions. These are lists of things to hide
in the output, separated by “.”. Example:http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-doc?hide_roles=Anonymous.Authenticated.Member&hide_permissions=Access+contents+information.List%20folder%20contentsThere’s also thehide_acquireparameter, which hides the “acquired” column.To-doRender an HTML image map, so the user can click on a state or transition
and see its description.Test and adapt for Windows.Make the location of thedotexecutable configurable.Write automatic tests.CreditsAuthor: Rafael Oliveira <rafaelbco@gmail.com>The idea of using Zope3-style views to render information about workflow
definitions and to do sanity check on workflows was inspired by Martin Aspeli’scollective.wtf.Contribute and report bugsHelp is welcome. Contact the author or file a ticket at theIssue tracker.ThanksTo lucmult, for reporting the bug #2 (the one fixed in 0.0.3).History1.0.0 (2015-08-27)Plone 4.3.x compatibility.Workflow validation (@@wf-validateview and correspondent function).0.0.4 (2011-06-13)Implemented i18n.Added z3c.autoinclude.plugin entry point.Now @@wf-doc uses main_template.Added @@wf-doc-user-friendly.0.0.3 (22-november-2009)Corrected packaging error: README.txt was not included in the released tarball :-(.0.0.2 (22-november-2009)Added “acquired” column to @@wf-doc.0.0.1 (03-june-2009)First release.