rbco.wfdocumentator 1.0.0

内容

• Overview
• Requirements
• Installation
• Usage
• To-do
• Credits
• Contribute and report bugs
• Thanks
• History
  • 1.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)

Overview

这个zope和plone的附加组件旨在自动提供用户友好的 生成了有关工作流定义的文档。

当前的以下zope3样式视图 Products.DCWorkflow.interfaces.IDCWorkflowDefinition提供：

• @@wf-graph：呈现表示工作流状态和 转换为图形。
• @@wf-doc：呈现描述工作流的html页面。这包括 上面提到的图表。
• @@wf-doc-user-friendly：与@@wf-doc相同，但隐藏了一些角色和权限以及 “获取”列。
• @@wf-validate：根据一组常规规则验证工作流。

Requirements

• 用plone 4.3.x测试，但是只需要zope 2（希望如此）。
• Graphviz。更准确地说：在 系统路径和运行zope的用户必须对其具有执行权限。
• 其他需求是在pypi和distutils上注册的纯python包。 应该毫无问题地处理它们。

Installation

这个软件包很容易安装。只需在zope实例中使用它 别忘了加载它的zcmls。如果你不知道我是什么 请参考Installing an Add-on Product来讨论。

Usage

只需在工作流定义上使用提供的视图。示例（键入这些 浏览器中的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”列。

To-do

• 呈现HTML图像映射，以便用户可以单击状态或转换 看看它的描述。
• 测试并适应Windows。
• 使dot可执行文件的位置可配置。
• 编写自动测试。

Credits

• 作者：Rafael Oliveira<；rafaelbco@gmail.com>；
• 使用zope3样式视图呈现工作流信息的思想 定义和对工作流进行健全检查的灵感来自于martin aspeli的 collective.wtf。

Contribute and report bugs

欢迎帮助。请与作者联系或在Issue tracker处提交票证。

Thanks

• 向lucmult报告bug 2（在0.0.3中修复的bug）。

History