====== Ditaa-Plugin ======

---- plugin ----
description: Converts ASCII-Flowcharts to png-Graphics using ditaa
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : syntax
lastupdate : 2016-06-24
compatible : Lemming, Anteater, Rincewind, Angua, Weatherwax, Adora Belle, Hrun, Detritus
depends    : 
conflicts  : 
similar    : Graphviz, diagram, a2s
tags       : media, images, diagram, java

downloadurl: https://github.com/splitbrain/dokuwiki-plugin-ditaa/zipball/master
bugtracker : https://github.com/splitbrain/dokuwiki-plugin-ditaa/issues
sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-ditaa/
----

Previous author: [[develop@dieploegers.de|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 [[http://ditaa.sourceforge.net/|ditaa homepage]] for details about ditaa.

===== Download and Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Changes ====

{{rss>https://github.com/splitbrain/dokuwiki-plugin-ditaa/commits/master.atom date}}

===== Configuration =====

The plugin provides a configuration setting in the [[plugin:config|config manager]] to specify the path to your Java interpreter. When set, the tool will run the original 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 not provide a Java path, the plugin will instead use an alternative implementation of ditaa written in go. The plugin comes with 64bit versions for Windows and Linux, but will try downloading different binaries if needed. Please note that the go version has not all the features of the orginal ditaa in Java.

===== Syntax =====

The syntax wraps any [[http://ditaa.sourceforge.net/|ditaa formatted]] ASCII flowchart into %%<ditaa></ditaa>%% tags. The opening tag can have several additional optional parameters (see below).

<code html>
<ditaa [optional parameters]>

... (some ditaa-code) ...

</ditaa>
</code>

==== 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 (only with Java)|
| (no)round           | noround       | Enable or disable round corners for all boxes  (only with Java)|
| (no)shadow          | shadow        | Enable or disable box shadows  (only with Java)|
| (no)antialias       | antialias     | Enable or disable antialiasing  (only with Java)|
| (no)edgesep         | edgesep       | Enable or disabling the separation of box edges where boxes directly touch  (only with Java)|
| 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 =====

{{ https://trello.com/1/cards/6593097735813b365132052a/attachments/659309a641fe725dbda9056c/download/Ditaa-Plugin-Screenshot.png?nolink&recache|Ditaa Example}}

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

===== Further Doc =====

  * [[http://ditaa.sourceforge.net/|ditaa @ sourceforge]]