TracBlockdiag is a trac plugin that integrate blockdiag series into wiki pages. It's provide wiki macros for blockdiag, seqdiag, actdiag, nwdiag and rackdiag.
This software is available under the MIT license.
TracBlockdiag has several features.
If you need all features, you must use Trac 0.12 or later.
First, clone the repository. ::
$ git clone https://github.com/yosisa/TracBlockdiag.git $ cd TracBlockdiag
Then, you can install globally ::
or install to a specific Trac environment. ::
$ python setup.py bdist_egg $ cp dist/*.egg /path/to/tracenv/plugins
Moreover, you must install blockdiag series which you want to integrate. For example, below command will install all blockdiag series (rackdiag is currently included in nwdiag). ::
$ pip install blockdiag seqdiag actdiag nwdiag
Optionally, you can use blockdiag plugins. If you need a plugin, you simply install it. For example, below command will install new shapes. ::
$ pip install blockdiagcontrib-cisco
If you are not familiar with blockdiag, you should read the blockdiag documentation <http://blockdiag.com/en/blockdiag/>_ first.
Macro synopsis like this::
{{{#!(block|seq|act|nw|rack)diag [type=(png|svg)] [IMG_TAG_ATTR=VALUE ...] *DIAG_SOURCE_TEXT }}}
You can write blockdiag source text as a wiki macro like below. ::
{{{#!blockdiag { A -> B -> C; B -> D; } }}}
You can specify output format and width. ::
{{{#!blockdiag type=svg width=800px { A -> B -> C; B -> D; } }}}
Macro synopsis like this::
{{{
*DIAG_SOURCE_TEXT }}}
In Trac 0.11, macro arguments is not supported. So, all diagrams are generated with the format specified in default_type option.
You can write blockdiag source text as a wiki macro like below. ::
{{{
{ A -> B -> C; B -> D; } }}}
TracBlockdiag has several configuration parameters.
These parameters are specify in [tracblockdiag] section of the trac.ini config file.
These parameters are defined as follows.
+--------------+--------------+---------+--------------------------------------------------------------------------+ | name | type | default | description | +==============+==============+=========+==========================================================================+ | font | string array | (auto) | Paths to font file which are used in PNG generation. | +--------------+--------------+---------+--------------------------------------------------------------------------+ | cachetime | int | 300 | Time in seconds which the plugin caches a generated diagram in. | +--------------+--------------+---------+--------------------------------------------------------------------------+ | gc_interval | int | 100 | The number of diagram generation. | | | | | Unused cache is cleared every this count. | +--------------+--------------+---------+--------------------------------------------------------------------------+ | default_type | string | svg | Default diagram type to generate. | +--------------+--------------+---------+--------------------------------------------------------------------------+ | syntax_check | bool | True | Check syntax of source text and show error insted of 500 response. | | | | | Note that when using syntax check, the performance is slightly down. | +--------------+--------------+---------+--------------------------------------------------------------------------+ | fallback | bool | False | Fallback to png image when a browser is not support svg. | | | | | Note that using fallback causes double image generation because | | | | | major browsers request png image whether svg rendering succeeded or not. | | | | | So, enabling this option may causes high load. | +--------------+--------------+---------+--------------------------------------------------------------------------+
0.2.1 (2012-02-26)
0.2.0 (2012-01-21)
0.1.1 (2012-01-12)
0.1.0 (2012-01-11)