{ "info": { "author": "Rafael Oliveira", "author_email": "rafaelbco@gmail.com", "bugtrack_url": null, "classifiers": [ "Framework :: Plone", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "rbco.wfdocumentator\n===================\n\n.. contents::\n\nOverview\n--------\n\nThis add-on for Zope and Plone aims to provide user-friendly automatically\ngenerated documentation about workflow definitions.\n\nCurrently the following Zope3-style views for\n``Products.DCWorkflow.interfaces.IDCWorkflowDefinition`` are provided:\n\n- ``@@wf-graph``: Render an image representing the workflow's states and\n transitions as a graph.\n\n- ``@@wf-doc``: Render an HTML page describing the workflow. This includes\n the graph mentioned above.\n\n- ``@@wf-doc-user-friendly``: Same as ``@@wf-doc`` but hides some roles and permissions and the\n \"acquire\" column.\n\n- ``@@wf-validate``: Validate the workflow according to a set of general rules.\n\nRequirements\n------------\n\n- Tested with Plone 4.3.x. However only Zope 2 is required (hopefuly).\n\n- Graphviz_. More precisely: there must be an executable called ``dot`` in the\n system path and the user running Zope must have execute permission on it.\n\n- Other requirements are pure Python packages registered on PyPI and distutils\n should handle them without problems.\n\n.. WARNING::\n It was not tested on Windows. I suspect it won't work because of the name\n of the executable, i.e ``dot`` != ``dot.exe``.\n\nInstallation\n------------\n\nThis package is easy_install'able. Just make it available in your Zope Instance\nand don't forget to load its ZCMLs. If you don't have any idea of what I'm\ntalking about please refer to `Installing an Add-on Product`_.\n\nUsage\n-----\n\nJust use the provided views on an workflow definition. Examples (type these\nURLs in your browser):\n\n- http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-graph\n- http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-doc\n\nYou can pass the following parameters to @@wf-graph in the query string:\n``hide_roles`` and ``hide_permissions``. These are lists of things to hide\nin the output, separated by \".\". Example:\n\n- http://localhost:8080/plone/portal_workflow/plone_workflow/@@wf-doc?hide_roles=Anonymous.Authenticated.Member&hide_permissions=Access+contents+information.List%20folder%20contents\n\nThere's also the ``hide_acquire`` parameter, which hides the \"acquired\" column.\n\nTo-do\n-----\n\n- Render an HTML image map, so the user can click on a state or transition\n and see its description.\n\n- Test and adapt for Windows.\n\n- Make the location of the ``dot`` executable configurable.\n\n- Write automatic tests.\n\nCredits\n-------\n\n- Author: Rafael Oliveira \n\n- The idea of using Zope3-style views to render information about workflow\n definitions and to do sanity check on workflows was inspired by Martin Aspeli's\n `collective.wtf`_.\n\nContribute and report bugs\n--------------------------\n\nHelp is welcome. Contact the author or file a ticket at the `Issue tracker`_.\n\nThanks\n------\n\n- To lucmult, for reporting the bug #2 (the one fixed in 0.0.3).\n\n.. References\n ----------\n\n.. _Graphviz: http://www.graphviz.org/\n.. _collective.wtf: http://pypi.python.org/pypi/collective.wtf/\n.. _`Issue tracker`: https://github.com/rafaelbco/rbco.wfdocumentator/issues\n.. _`Installing an Add-on Product`: http://plone.org/documentation/tutorial/third-party-products/installing\n\n\n\n\n\n\n\nHistory\n-------\n\n1.0.0 (2015-08-27)\n~~~~~~~~~~~~~~~~~~\n\n- Plone 4.3.x compatibility.\n- Workflow validation (``@@wf-validate`` view and correspondent function).\n\n\n0.0.4 (2011-06-13)\n~~~~~~~~~~~~~~~~~~\n\n- Implemented i18n.\n- Added z3c.autoinclude.plugin entry point.\n- Now @@wf-doc uses main_template.\n- Added @@wf-doc-user-friendly.\n\n\n0.0.3 (22-november-2009)\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Corrected packaging error: README.txt was not included in the released tarball :-(.\n\n0.0.2 (22-november-2009)\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Added \"acquired\" column to @@wf-doc.\n\n0.0.1 (03-june-2009)\n~~~~~~~~~~~~~~~~~~~~\n\n- First release.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/rafaelbco/rbco.wfdocumentator", "keywords": "plone workflow", "license": "GPL", "maintainer": null, "maintainer_email": null, "name": "rbco.wfdocumentator", "package_url": "https://pypi.org/project/rbco.wfdocumentator/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/rbco.wfdocumentator/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/rafaelbco/rbco.wfdocumentator" }, "release_url": "https://pypi.org/project/rbco.wfdocumentator/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "An add-on for Zope and Plone which aims to provide user-friendly automatically generated documentation about workflow definitions.", "version": "1.0.0" }, "last_serial": 1696183, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "2fa33d459c0bf4e1070628be7f28d206", "sha256": "fe5bb99b9ef04c7fc1a2653f069aa3f8847a899584b28ceab6bd6940cb1195a1" }, "downloads": -1, "filename": "rbco.wfdocumentator-0.0.1.zip", "has_sig": false, "md5_digest": "2fa33d459c0bf4e1070628be7f28d206", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17924, "upload_time": "2009-06-03T18:34:59", "url": "https://files.pythonhosted.org/packages/a2/27/381a337ea42b48feff39cff943684103c693619af7ba4131fc4b021106fa/rbco.wfdocumentator-0.0.1.zip" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "1a4c6de88d0b145c1da17f93a892e4d5", "sha256": "ecba21cd353d8ea62b51a891adc35e03a6b7908e7a8241a3bcf2347b6c952ba4" }, "downloads": -1, "filename": "rbco.wfdocumentator-0.0.2.zip", "has_sig": false, "md5_digest": "1a4c6de88d0b145c1da17f93a892e4d5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10414, "upload_time": "2009-11-22T13:46:42", "url": "https://files.pythonhosted.org/packages/19/66/c456ac6c83e664b9abee4e4f177a5b1b951885220843ba9e9c3906ce357e/rbco.wfdocumentator-0.0.2.zip" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "adf8a732d8e95096ba135733ace796bb", "sha256": "1b4e5f8f563c0f8c9a617d01ab212c47b315d6ab988f0679ff7aedb6bea8b813" }, "downloads": -1, "filename": "rbco.wfdocumentator-0.0.3.zip", "has_sig": false, "md5_digest": "adf8a732d8e95096ba135733ace796bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14301, "upload_time": "2009-11-22T19:54:40", "url": "https://files.pythonhosted.org/packages/12/3e/7e87eddd4247e8038b4e8506bb30496417e53f1aeffb6cdc24672c220662/rbco.wfdocumentator-0.0.3.zip" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "03fc2d2a1a215d320fda29c784ba210c", "sha256": "7972cd033db45fe6850e999c4081877c91353665c31d8c731a381bb4d92d742d" }, "downloads": -1, "filename": "rbco.wfdocumentator-0.0.4.zip", "has_sig": false, "md5_digest": "03fc2d2a1a215d320fda29c784ba210c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17222, "upload_time": "2011-06-17T15:21:48", "url": "https://files.pythonhosted.org/packages/04/a6/69d4f27cd0dbd14dbcf4275dd0ca75dc1f3bae2f077d85a55d24e9cae444/rbco.wfdocumentator-0.0.4.zip" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "fbcadb63818b40d79f87ea07ff71bb2b", "sha256": "4a487c4f3c9ccfce0e2cfac4a31d408697060025221162827cbd369cf4373cdd" }, "downloads": -1, "filename": "rbco.wfdocumentator-1.0.0.zip", "has_sig": false, "md5_digest": "fbcadb63818b40d79f87ea07ff71bb2b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19522, "upload_time": "2015-08-27T11:58:49", "url": "https://files.pythonhosted.org/packages/43/2f/afd70cc04863c3dde0b0a585f202955c29accdd3f7e787928ec7edceb0c7/rbco.wfdocumentator-1.0.0.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fbcadb63818b40d79f87ea07ff71bb2b", "sha256": "4a487c4f3c9ccfce0e2cfac4a31d408697060025221162827cbd369cf4373cdd" }, "downloads": -1, "filename": "rbco.wfdocumentator-1.0.0.zip", "has_sig": false, "md5_digest": "fbcadb63818b40d79f87ea07ff71bb2b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19522, "upload_time": "2015-08-27T11:58:49", "url": "https://files.pythonhosted.org/packages/43/2f/afd70cc04863c3dde0b0a585f202955c29accdd3f7e787928ec7edceb0c7/rbco.wfdocumentator-1.0.0.zip" } ] }