{ "info": { "author": "Therp BV,Odoo Community Association (OCA)", "author_email": "support@odoo-community.org", "bugtrack_url": null, "classifiers": [ "Framework :: Odoo", "License :: OSI Approved :: GNU Affero General Public License v3", "Programming Language :: Python" ], "description": "========================\nMermaid flowchart widget\n========================\n\n.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github\n :target: https://github.com/OCA/web/tree/10.0/web_widget_mermaid\n :alt: OCA/web\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_widget_mermaid\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png\n :target: https://runbot.odoo-community.org/runbot/162/10.0\n :alt: Try me on Runbot\n\n|badge1| |badge2| |badge3| |badge4| |badge5| \n\nThis module adds a basic widget for rendering text fields as flowcharts using\n`mermaid `_.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nUsage\n=====\n\nPut a ``widget=\"mermaid\"`` attribute in relevant field tags in the view\ndeclaration::\n\n \n\nOptionally, use an ``options`` attribute to pass a JSON object with\n`mermaid configuration `_::\n\n \n\nThe syntax for creating diagrams is described in\n`mermaid's documentation `_.\n\nAs an example, this text::\n\n graph LR\n 10.0 --> 11.0\n 11.0 --> 12.0\n 12.0 -.-> 13.0\n\nProduces this flowchart:\n\n.. image:: https://raw.githubusercontent.com/OCA/web/10.0/web_widget_mermaid/static/description/flowchart_example.png\n :alt: Flowchart\n\nDemonstration\n=============\n\nIn demo mode, the addon adds a flowchart field to users so you can try it. This shows up in Runbot instances.\n\nUpgrading Mermaid\n=================\n\nThis information is only relevant for the development of this addon, not for users.\n\nThis addon uses a slightly tweaked build of Mermaid that works in older browsers. To reproduce it, take the following steps:\n\n- Clone ``https://github.com/knsv/mermaid/``\n- Checkout the version you want to upgrade to (e.g. ``git checkout 8.4.0``)\n- In ``webpack.config.base.js``, in ``const jsRule = ...``, remove the ``include`` key (so all dependencies are transpiled)\n- In ``babel.config.js``, in ``targets``, add some browsers besides ``node: 'current'``. I arbitrarily went with this::\n\n targets: {\n node: 'current',\n ie: '11',\n edge: '20',\n firefox: '35',\n chrome: '45',\n safari: '9',\n }\n\n- Run ``yarn install``\n- Run ``yarn build``\n- The completed file is now in ``dist/mermaid.js``. Try running ``grep 'let ' dist/mermaid.js`` to make sure everything was transpiled. The only output should be from comments.\n- Copy ``dist/mermaid.js`` to ``web_widget_mermaid/static/lib/mermaid/mermaid.js``.\n- Bump the version number in ``__manifest__.py`` to match the Mermaid version.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues `_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us smashing it by providing a detailed and welcomed\n`feedback `_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* Therp BV\n\nContributors\n~~~~~~~~~~~~\n\n* Jan Verbeek \n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/web `_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/OCA/web", "keywords": "", "license": "AGPL-3", "maintainer": "", "maintainer_email": "", "name": "odoo10-addon-web-widget-mermaid", "package_url": "https://pypi.org/project/odoo10-addon-web-widget-mermaid/", "platform": "", "project_url": "https://pypi.org/project/odoo10-addon-web-widget-mermaid/", "project_urls": { "Homepage": "https://github.com/OCA/web" }, "release_url": "https://pypi.org/project/odoo10-addon-web-widget-mermaid/10.0.8.4.0.99.dev1/", "requires_dist": [ "odoo (<10.1dev,>=10.0)" ], "requires_python": "~=2.7", "summary": "Render mermaid markdown flowcharts", "version": "10.0.8.4.0.99.dev1", "yanked": false, "yanked_reason": null }, "last_serial": 6021606, "releases": { "10.0.8.4.0.99.dev1": [ { "comment_text": "", "digests": { "md5": "51a65e3157608105d4ac4d0d54077aa8", "sha256": "1f1605c3dfd633dd6c9dca3d8f7b82f7072fc32b3acea4341168cf4cba8fa1b9" }, "downloads": -1, "filename": "odoo10_addon_web_widget_mermaid-10.0.8.4.0.99.dev1-py2-none-any.whl", "has_sig": false, "md5_digest": "51a65e3157608105d4ac4d0d54077aa8", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": "~=2.7", "size": 650135, "upload_time": "2019-10-24T04:38:55", "upload_time_iso_8601": "2019-10-24T04:38:55.201452Z", "url": "https://files.pythonhosted.org/packages/cb/a3/579035c995f8b55f076375e90aa4c41bd43793bcafc50f379b981189ce48/odoo10_addon_web_widget_mermaid-10.0.8.4.0.99.dev1-py2-none-any.whl", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "51a65e3157608105d4ac4d0d54077aa8", "sha256": "1f1605c3dfd633dd6c9dca3d8f7b82f7072fc32b3acea4341168cf4cba8fa1b9" }, "downloads": -1, "filename": "odoo10_addon_web_widget_mermaid-10.0.8.4.0.99.dev1-py2-none-any.whl", "has_sig": false, "md5_digest": "51a65e3157608105d4ac4d0d54077aa8", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": "~=2.7", "size": 650135, "upload_time": "2019-10-24T04:38:55", "upload_time_iso_8601": "2019-10-24T04:38:55.201452Z", "url": "https://files.pythonhosted.org/packages/cb/a3/579035c995f8b55f076375e90aa4c41bd43793bcafc50f379b981189ce48/odoo10_addon_web_widget_mermaid-10.0.8.4.0.99.dev1-py2-none-any.whl", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }