rbco.wfdocumentator 1.0.0

概述

此Zope和Plone插件旨在提供关于工作流定义的用户友好型自动生成文档。

目前提供以下针对Products.DCWorkflow.interfaces.IDCWorkflowDefinition的Zope3风格视图

• @@wf-graph：以图形的形式呈现工作流的状态和转换。

• @@wf-doc：呈现描述工作流的HTML页面。这包括上面提到的图形。

• @@wf-doc-user-friendly：与@@wf-doc相同，但隐藏了一些角色和权限以及“获取”列。

• @@wf-validate：根据一组通用规则验证工作流。

需求

• 在Plone 4.3.x上测试过。然而，只需要Zope 2（希望如此）。

• Graphviz。更确切地说：系统路径中必须有名为dot的可执行文件，并且运行Zope的用户必须具有对其执行权限。

• 其他要求是PyPI上注册的纯Python包，distutils应该可以无问题处理它们。

安装

该软件包可以通过easy_install安装。只需将其添加到您的Zope实例中，并确保加载其ZCML文件。如果您对此一无所知，请参阅安装附加产品的教程。

使用

只需在工作流定义上使用提供的视图。示例（将这些URL输入您的浏览器）

• http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-graph

• http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-doc

您可以在查询字符串中传递以下参数给@@wf-graph： hide_roles 和 hide_permissions。这些是要在输出中隐藏的列表，用“.”分隔。例如

• http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-doc?hide_roles=Anonymous.Authenticated.Member&hide_permissions=Access+contents+information.List%20folder%20contents

还有一个名为 hide_acquire 的参数，它可以隐藏“acquired”列。

待办事项

• 渲染HTML图像映射，用户可以点击状态或转换并查看其描述。

• 对Windows进行测试和适配。

• 使 dot 可执行文件的位置可配置。

• 编写自动测试。

致谢

• 作者：Rafael Oliveira <rafaelbco@gmail.com>

• 使用Zope3风格的视图来渲染工作流定义信息并进行工作流合理性检查的想法受到了Martin Aspeli的collective.wtf的启发。

贡献和报告错误

欢迎提供帮助。请联系作者或在问题跟踪器中提交问题。

感谢

• 感谢lucmult报告了编号为2的bug（在0.0.3中已修复）。

历史