This is an old revision of the document!
Table of Contents
Graphviz Plugin
Compatible with DokuWiki
anteater, 2011-05-25, adora belle, weatherwax, ponder stibbons, Hrun, Detritus
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Similar to dataplot, ditaa, flowchartjs, flowcharts, format, gnuplot, graphgear, mindmap, plantuml, plantumlparser, seqdia, svgedit, wavedrom
Needed for directions
This plugin can create directed and non-directed graph images from a textual description language called “dot” using the Graphviz program. It can use a locally installed graphviz or use Google's chart API for rendering.
The plugin supports exporting to OpenOffice through the ODT Plugin (only with a local graphviz install).
For more information on Graphviz and the dot language refer to the Graphviz documentation
This plugin was originally written by Carl-Christian Salvesen. The current plugin is a nearly complete rewrite and differs on how it works internally and where graphs are stored.
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
- Version upped (2016-07-06 20:43)
- Version upped (2016-02-03 18:16)
- Merge pull request #15 from splitbrain-forks/php7-signature (2016-02-02 16:25)
- Adjust method signatures to match parent (2016-02-02 16:06)
- Version upped (2016-01-24 14:11)
- Version upped (2014-05-21 19:36)
- Merge pull request #8 from araname/master (2014-01-02 11:16)
- update message and add translation (2013-12-25 12:25)
Configuration
The full path to your graphviz' dot
binary can be configured in the config manager. When it isn't configured, remote rendering at Google is used.
Syntax and Usage
Any Graphviz compatible graph definition can be given with graphviz
tags.
The rendering engine can optionally be given as argument in the opening tag. Supported are dot
, neato
, twopi
, circo
and fdp
with dot
being the default:
dot
– “hierarchical” or layered drawings of directed graphs. This is the best tool to use if edges have directionality.neato
– “spring model” layouts. This is the best tool to use if the graph is not too large (about 100 nodes) and you don't know anything else about it. Neato attempts to minimize a global energy function, which is equivalent to statistical multi-dimensional scaling.fdp
– “spring model” layouts similar to those of neato, but does this by reducing forces rather than working with energy.twopi
– radial layouts, after Graham Wills 97. Nodes are placed on concentric circles depending their distance from a given root node.circo
– circular layout, after Six and Tollis 99, Kauffman and Wiese 02. This is suitable for certain diagrams of multiple cyclic structures, such as certain telecommunications networks.
You can also specify left
, center
or right
to align the resulting image.
A parameter in the form of <number>x<number>
is interpreted as wanted output size. To only specify width width=<number>
or <number>x0
can be used, for height height=<number>
or 0x<number>
.
Example
<graphviz dot right 800x400> digraph ATN { rankdir=LR; s25[fontsize=11, label="25", shape=doublecircle, fixedsize=true, width=.6]; s239[fontsize=24,label="239", shape=circle, fixedsize=true, width=.55, peripheries=1]; s240[fontsize=11,label="240", shape=circle, fixedsize=true, width=.55, peripheries=1]; s241[fontsize=11,label="241", shape=circle, fixedsize=true, width=.55, peripheries=1]; s242[fontsize=11,label="242", shape=circle, fixedsize=true, width=.55, peripheries=1]; s243[fontsize=11,label="{→\n243\nd=24|{<p0>|<p1>}}", shape=record, fixedsize=false, peripheries=1]; s244[fontsize=11,label="←\n244", shape=circle, fixedsize=true, width=.55, peripheries=1]; s245[fontsize=11,label="245", shape=circle, fixedsize=true, width=.55, peripheries=1]; s246[fontsize=11,label="246", shape=circle, fixedsize=true, width=.55, peripheries=1]; s247[fontsize=11,label="→\n247+", shape=circle, fixedsize=true, width=.55, peripheries=1]; s24[fontsize=11,label="24", shape=circle, fixedsize=true, width=.55, peripheries=1]; s248[fontsize=11,label="←\n248", shape=circle, fixedsize=true, width=.55, peripheries=1]; s249[fontsize=11,label="{249+\nd=25|{<p0>|<p1>}}", shape=record, fixedsize=false, peripheries=1]; s250[fontsize=11,label="250", shape=circle, fixedsize=true, width=.55, peripheries=1]; s251[fontsize=11,label="251", shape=circle, fixedsize=true, width=.55, peripheries=1]; s252[fontsize=11,label="252", shape=circle, fixedsize=true, width=.55, peripheries=1]; s24 -> s239 [fontname="Times-Italic", label="ε"]; s239 -> s247 [fontsize=11, fontname="Courier", arrowsize=.7, label = "'{'", arrowhead = normal]; s247 -> s240 [fontname="Times-Italic", label="ε"]; s240 -> s243 [fontsize=11, fontname="Courier", arrowsize=.7, label = "'case'", arrowhead = normal]; s243:p0 -> s241 [fontname="Times-Italic", label="ε"]; s243:p1 -> s242 [fontname="Times-Italic", label="ε"]; s241 -> s244 [fontsize=11, fontname="Courier", arrowsize=.7, label = "'null'", arrowhead = normal]; s242 -> s244 [fontsize=11, fontname="Courier", arrowsize=.7, label = "<element>", arrowhead = normal]; s244 -> s245 [fontname="Times-Italic", label="ε"]; s245 -> s246 [fontsize=11, fontname="Courier", arrowsize=.7, label = "'=>'", arrowhead = normal]; s246 -> s248 [fontsize=11, fontname="Courier", arrowsize=.7, label = "<block>", arrowhead = normal]; s248 -> s249 [fontname="Times-Italic", label="ε"]; s249:p0 -> s247 [fontname="Times-Italic", label="ε", style="dashed"]; s249:p1 -> s250 [fontname="Times-Italic", label="ε"]; s250 -> s251 [fontname="Times-Italic", label="ε"]; s251 -> s252 [fontsize=11, fontname="Courier", arrowsize=.7, label = "'}'", arrowhead = normal]; s252 -> s25 [fontname="Times-Italic", label="ε"]; } </graphviz>
Compatibility
It seems to be compatible with “Rincewind”, but I don't dare to list it as compatible based on only my test.
I use it in Rincewind, it seems to work fine for me! Thanks for this great plugin! jdt
I use it in Rincewind but it did not work as all my graphics disapeared (see issue 4. But I seem to have found a workaround since my problem seemed to be a cache problem:
syntax.php /** * Return path to the rendered image on our local system */ function _imgfile($data){ if($conf['debug']){ dbglog($cache, 'image file cache'); } $cache = $this->_cachename($data,'png'); // create the file if needed +++ /******************************************************* +++ **** CSJ added line ****/ +++ clearstatcache(); +++ /*******************************************************/ if(!file_exists($cache)){ $in = $this->_cachename($data,'txt'); if($this->getConf('path')){ $ok = $this->_run($data,$in,$cache); }else{ $ok = $this->_remote($data,$in,$cache); } if(!$ok) return false; clearstatcache(); } // resized version if($data['width']){ $cache = media_resize_image($cache,'png',$data['width'],$data['height']); } // something went wrong, we're missing the file if(!file_exists($cache)) return false; //print $cache; return $cache; }
So there you go!
Enjoy.
Claude
—-
Dokuwiki Farmer issue
It did not work for our wiki which makes use of dokuwiki-farmer. Adding unset($data['animal']); in syntax.php in the function _cachename solved the problem.:
function _cachename($data,$ext){ unset($data['width']); unset($data['height']); unset($data['align']); +++ unset($data['animal']); return getcachename(join('x',array_values($data)),'.graphviz.'.$ext); }
When trying to debug I also realized that $conf['debug'] is never set but i guess it is $conf['allowdebug'].
FAQ
How do I get anti-aliased images ?
Make sure you have a Graphviz version compiled against Cairo, this will cause it to use it by default, and results in anti-aliased images.
Does the server need an access to Internet ?
Yes, it uses Google API to generate graphs.