{ "info": { "author": "Yoshihisa Tanaka", "author_email": "yt.hisa@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Plugins", "Framework :: Trac", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Programming Language :: Python" ], "description": "Introduction\n============\nTracBlockdiag is a trac plugin that integrate blockdiag series into wiki pages.\nIt's provide wiki macros for blockdiag, seqdiag, actdiag, nwdiag and rackdiag.\n\nThis software is available under the MIT license.\n\nFeatures\n========\nTracBlockdiag has several features.\n\n- Support almost blockdiag features (fontmap is not supported).\n- Support PNG/SVG output (SVG support is Trac 0.12 only).\n- Fastest wiki rendering.\n- Multi thread/process safe.\n- Check installed blockdiag series and provide only supported macros.\n- Don't create temporary file.\n\nRequirements\n============\n- Python >= 2.5\n- Trac >= 0.11\n\nIf you need all features, you must use Trac 0.12 or later.\n\nInstall\n=======\nFirst, clone the repository. ::\n\n $ git clone https://github.com/yosisa/TracBlockdiag.git\n $ cd TracBlockdiag\n\nThen, you can install globally ::\n\n # python setup.py install\n\nor install to a specific Trac environment. ::\n\n $ python setup.py bdist_egg\n $ cp dist/*.egg /path/to/tracenv/plugins\n\nMoreover, you must install blockdiag series which you want to integrate.\nFor example, below command will install all blockdiag series\n(rackdiag is currently included in nwdiag). ::\n\n $ pip install blockdiag seqdiag actdiag nwdiag\n\nOptionally, you can use blockdiag plugins.\nIf you need a plugin, you simply install it.\nFor example, below command will install new shapes. ::\n\n $ pip install blockdiagcontrib-cisco\n\nUsage\n=====\nIf you are not familiar with blockdiag, you should read the `blockdiag documentation `_ first.\n\nfor Trac 0.12 or later\n----------------------\nMacro synopsis like this::\n\n {{{#!(block|seq|act|nw|rack)diag [type=(png|svg)] [IMG_TAG_ATTR=VALUE ...]\n *DIAG_SOURCE_TEXT\n }}}\n\nYou can write blockdiag source text as a wiki macro like below. ::\n\n {{{#!blockdiag\n {\n A -> B -> C;\n B -> D;\n }\n }}}\n\nYou can specify output format and width. ::\n\n {{{#!blockdiag type=svg width=800px\n {\n A -> B -> C;\n B -> D;\n }\n }}}\n\nfor Trac 0.11\n-------------\nMacro synopsis like this::\n\n {{{\n #!(block|seq|act|nw|rack)diag\n *DIAG_SOURCE_TEXT\n }}}\n\n**In Trac 0.11, macro arguments is not supported.\nSo, all diagrams are generated with the format specified in default_type option.**\n\nYou can write blockdiag source text as a wiki macro like below. ::\n\n {{{\n #!blockdiag\n {\n A -> B -> C;\n B -> D;\n }\n }}}\n\nOptions\n=======\nTracBlockdiag has several configuration parameters.\nThese parameters are specify in `[tracblockdiag]` section of the `trac.ini` config file.\nThese parameters are defined as follows.\n\n+--------------+--------------+---------+--------------------------------------------------------------------------+\n| name | type | default | description |\n+==============+==============+=========+==========================================================================+\n| font | string array | (auto) | Paths to font file which are used in PNG generation. |\n+--------------+--------------+---------+--------------------------------------------------------------------------+\n| cachetime | int | 300 | Time in seconds which the plugin caches a generated diagram in. |\n+--------------+--------------+---------+--------------------------------------------------------------------------+\n| gc_interval | int | 100 | The number of diagram generation. |\n| | | | Unused cache is cleared every this count. |\n+--------------+--------------+---------+--------------------------------------------------------------------------+\n| default_type | string | svg | Default diagram type to generate. |\n+--------------+--------------+---------+--------------------------------------------------------------------------+\n| syntax_check | bool | True | Check syntax of source text and show error insted of 500 response. |\n| | | | Note that when using syntax check, the performance is slightly down. |\n+--------------+--------------+---------+--------------------------------------------------------------------------+\n| fallback | bool | False | Fallback to png image when a browser is not support svg. |\n| | | | Note that using fallback causes double image generation because |\n| | | | major browsers request png image whether svg rendering succeeded or not. |\n| | | | So, enabling this option may causes high load. |\n+--------------+--------------+---------+--------------------------------------------------------------------------+\n\nHistory\n=======\n0.2.1 (2012-02-26)\n - fix issue on setup from PyPI\n\n0.2.0 (2012-01-21)\n - change default type from png to svg\n - add option for default type\n - add option to enable syntax checking for detailed error\n - support fallback to png if a browser doesn't support svg\n - fix bug which generating incorrect diagram when there are multiple diagrams in one page\n\n0.1.1 (2012-01-12)\n - fix bug when source text contains unicode\n - fix bug which drawing incorrect font while png rendering\n\n0.1.0 (2012-01-11)\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/yosisa/TracBlockdiag", "keywords": "trac,macro,blockdiag", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "TracBlockdiag", "package_url": "https://pypi.org/project/TracBlockdiag/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/TracBlockdiag/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/yosisa/TracBlockdiag" }, "release_url": "https://pypi.org/project/TracBlockdiag/0.2.1/", "requires_dist": null, "requires_python": null, "summary": "Integrate blockdiag series into Trac wiki", "version": "0.2.1" }, "last_serial": 785832, "releases": { "0.2.1": [ { "comment_text": "", "digests": { "md5": "056fa9bbf6cf9da01a82c53e51c273fa", "sha256": "ab0e9dfb0821760896dcf003c758ae150314f30ef2a686860e09b35db79b9fde" }, "downloads": -1, "filename": "TracBlockdiag-0.2.1.tar.gz", "has_sig": false, "md5_digest": "056fa9bbf6cf9da01a82c53e51c273fa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6722, "upload_time": "2012-02-26T03:10:22", "url": "https://files.pythonhosted.org/packages/db/a3/9871a47abb6328e728530bb8db1409f4a88cf282e0801fbc115c6ba5de22/TracBlockdiag-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "056fa9bbf6cf9da01a82c53e51c273fa", "sha256": "ab0e9dfb0821760896dcf003c758ae150314f30ef2a686860e09b35db79b9fde" }, "downloads": -1, "filename": "TracBlockdiag-0.2.1.tar.gz", "has_sig": false, "md5_digest": "056fa9bbf6cf9da01a82c53e51c273fa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6722, "upload_time": "2012-02-26T03:10:22", "url": "https://files.pythonhosted.org/packages/db/a3/9871a47abb6328e728530bb8db1409f4a88cf282e0801fbc115c6ba5de22/TracBlockdiag-0.2.1.tar.gz" } ] }