Ditaa-Plugin

Ditaa-Plugin

Compatible with DokuWiki

2012-01-25 "Angua" unknown
2011-05-25 "Rincewind" unknown
2010-11-07 "Anteater" yes

Converts ASCII-Flowcharts to png-Graphics using ditaa

Last updated on: 2010-11-24
Provides: Syntax
Repository: Source

Similar to diagram, graphviz, svgedit

Tagged with diagram, images, java, media

By Andreas Gohr

Previous author: Dennis Ploeger

Ditaa is a tool to convert ASCII-Art flowcharts and diagrams into their graphical equivalents. This Plugin integrates this feature into DokuWiki. See the ditaa homepage for details about ditaa.

Download and Installation

Download and install the plugin using the Plugin Manager using the URL given above. Refer to Plugins on how to install plugins manually.

Changes

fixed URL in README (2011/02/05 11:39)
README added (2011/02/05 11:34)
upped version (2010/11/24 18:23)
align="..." will now be set correctly in xhtml mode (2010/11/24 17:22)
streamlined code with graphviz plugin (2010/11/15 20:26)
now works with large graphs. fixes #4 (2010/08/29 21:36)
Correctly use UTF-8 for locally generated diagrams. Closes #2 (2010/06/07 21:20)
Merge branch 'master' of github.com:splitbrain/dokuwiki-plugin-ditaa (2010/06/07 21:09)

The plugin provides a configuration setting in the config manager to specify the path to your Java interpreter. When set, the tool will run ditaa locally on your server to create the graphics. The ditaa jar file is included in the plugin, you do not need to download it separately.

When you do not provide a Java interpreter path in the config, the plugin will use the webservice at ditaa.org to create the images. Having Java available on your server is now completely optional!

Syntax

The syntax wraps any ditaa formatted ASCII flowchart into <ditaa></ditaa> tags. The opening tag can have several additional optional parameters (see below).

<ditaa [optional parameters]>
 
... (some ditaa-code) ...
 
</ditaa>

Parameters

Parameter	Default	Description
width=<num>	width=0	Rescale the final image to this width. When set to 0, diita will choose the needed width and no rescaling is done.
height=<num>	height=0	Same as above but for height. Only works when a width is given as well
<num>x<num>	0x0	Combines the above parameters into one. That's a lowercase x!
<float>X	1.0X	Tells ditaa to scale the image. Eg. 2.0X makes the final image twice as big. That's an uppercase X
(no)round	noround	Enable or disable round corners for all boxes
(no)shadow	shadow	Enable or disable box shadows
(no)antialias	antialias	Enable or disable antialiasing
(no)edgesep	edgesep	Enable or disabling the separation of box edges where boxes directly touch
left center right		Align the image to the left, center or right. Default does no alignment (inline)

Possible tags

Not all shape selector tags are documented on the ditaa site. A quick source scan revealed:

tag	Description
{c}	decision(Choice)
{d}	document
{io}	input/output, parallelogram
{mo}	manual operation
{o}	ellipse, circle
{s}	storage
{tr}	trapezoid (looks like an inverted {mo} )

Example

Ditaa Example

<ditaa round noedgesep right>
    +--------+   +-------+    +-------+
    |        | --+ ditaa +--> |       |
    |  Text  |   +-------+    |diagram|
    |Document|   |!magic!|    |       |
    |     {d}|   |  c978 |    |       |
    +---+----+   +-------+    +-------+
        |                         ^
        |       Lots of work      |
        +------------+------------+
                     |
                     |
                     OK
</ditaa>

Discussion

Would it be possible to embed active dokuwiki links, or even implement an imagemap for the rendered png, so the boxes can become active links - a bit like flowchartwiki ? – LS 20120111

Bugs

Ditaa don't understand non-latin characters. For example: Cyrillic.