###################################
TracBlockDiagPlugin README
###################################

Summery
########
This plugin allow you to embed diagram images generated by blockdiag series to Trac wiki pages.
See following URLs for detail information of blockdiag.
 * Block diagram:    http://blockdiag.com/en/blockdiag/index.html
 * Sequence diagram: http://blockdiag.com/en/seqdiag/index.html
 * Activity diagram: http://blockdiag.com/en/actdiag/index.html
 * Network diagram:  http://blockdiag.com/en/nwdiag/index.html

Installation
##############
 1. Install PIL(Python Imaging Library) and blockdiag, seqdiag, actdiag, nwdiag.
    http://blockdiag.com/en/blockdiag/introduction.html#setup

 2. Run this command in the tracblockdiagplugin folder.
    python setup.py bdist_egg

 3. Put dist/BlockDiagPlugin-*.egg into plugins folder of the trac envirionment.

Configuration
##############
This plugin can be configured by trac.ini.

| [blockdiag]
| default_type=png
| use_file_cache=True
| font=/usr/share/fonts/truetype/ipafont/ipagp.ttf

default_type:
  'png' or 'svg'. Default is 'png'
  this represents default image format.

use_file_cache:
  True or False. Default is False.
  If True, generated images are cached in $TEMP/tracblockdiag.cache.
  This should be True if you use multi process web server. (e.g. Apache[Prefork])

font:
  You can specify font path which is used by blockdiag.
  If you want use non-ascii charactors in the diagram, this must be specified.

Processor arguments(Only Trac 0.12 or lator)
#############################################

| {{{
| #!blockdiag(type=png, width="80%")
| {
|   A -> B -> C;
|        B -> D;
| }
| }}}

You can specify output image format by processor argument `type`.
Other arguments are regarded as attributes of IMG tag.