DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:ditaa

Ditaa-Plugin

Compatible with DokuWiki

  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" unknown
  • 2014-05-05 "Ponder Stibbons" unknown

plugin Converts ASCII-Flowcharts to png-Graphics using ditaa

Last updated on
2016-06-24
Provides
Syntax
Repository
Source

Similar to diagram, graphviz

Tagged with diagram, images, java, media

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

Configuration

The plugin provides a configuration setting in the 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 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 (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

Ditaa Example

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

Further Doc

plugin/ditaa.txt · Last modified: 2016-07-01 09:31 by andi