[[PageOutline(2-5,Contents,pullout)]]
= Graphviz Plugin =

== Description ==

The graphviz wiki processor is a plugin for Trac that allows the the
dynamic generation of diagrams by the various [http://www.graphviz.org/ Graphviz] programs. The
text of a wiki page can contain the source text for graphviz and the
web browser will show the resulting image

== Bugs/Feature Requests == 

Existing bugs and feature requests for GraphvizPlugin are [query:status!=closed&component=GraphvizPlugin&order=priority here].

If you have any issues, create a [/newticket?component=GraphvizPlugin&owner=pkropf new ticket].

Be sure to mention which version of Trac and which version of the plugin you're using. If the version number ends with `dev`, then please also specify the ''changeset number'' corresponding to the version you're using.

== Requirements ==

The programs from http://www.graphviz.org.

== Installation ==

 1. Install
   * By hand:
     1. See source:graphvizplugin/branches/1.0/README.txt for details on installing the plugin for Trac 1.0 and up
     1. See source:graphvizplugin/tags/0.11-0.7.5/README.txt for details on installing the plugin on Trac 0.11 '''and''' Trac 0.12.
     1. See source:graphvizplugin/tags/0.10/README.txt for details on installing the plugin on Trac 0.10.
   * Using easy_install (for 1.0 and 1.1):
{{{
#!sh
$ [sudo] easy_install http://trac-hacks.org/svn/graphvizplugin/branches/1.0
}}}
   * Using easy_install (for 0.11 and 0.12):
{{{
#!sh
$ [sudo] easy_install http://trac-hacks.org/svn/graphvizplugin/tags/0.11-0.7.5
}}}
    * ,,`sudo` is optional case you already have enough authority to modify your server.,,
 1. Restart your web server ,,(this example command line for Apache on Ubuntu),,.
{{{
#!sh
$ [sudo] /etc/init.d/apache2 restart
}}}
 1. Enable the plugin. 
   * by updating your [wiki:TracIni trac.ini] with this:
{{{
[components]
...
graphviz.* = enabled
...
}}}
   * or accessing your Admin panel ({{{ ..admin/general/plugins }}});
 1. Configure your environment
   * by modifiying `trac.ini` file;
   * by accessing your Admin panel case you have WebAdminPlugin enabled;

== Source and Download ==

You can check out GraphvizPlugin from [http://trac-hacks.org/svn/graphvizplugin here] using Subversion, or [browser:graphvizplugin browse the source] with Trac.

Or you can download the zipped source from [source:graphvizplugin here]. Note that this contains everything regarding the Graphviz plugin including tagged releases and branches. The 0.10 directory contains the latest released version of the code for Trac 0.10 and the 0.11 directory contains the latest code for Trac 0.11. 
 - [download:graphvizplugin/tags/0.11-0.7.5 download] latest stable version (0.7.5) for Trac 0.11
 - [download:graphvizplugin/tags/0.10 download] latest version for Trac 0.10

That version has some trouble with `rsvg` support for creating anti-aliased images. The upcoming version contains a few related fixes:
 - [download:graphvizplugin/trunk download] latest unstable version for Trac 0.11 and later.
 - [download:graphvizplugin/branches/0.13 download] latest unstable version for Trac 0.13
If you want to have anti-aliased images, it might be a better option anyway to get/build a recent version of graphviz tools, which support producing anti-aliased images directly (through pangocairo support).

== Example ==

{{{
{{{
#!graphviz
digraph G {Hello->World->Graphviz->Rules}
}}}
}}}

would produce an image like:

[[Image(first-example.png)]]

Note that you can insert TracLinks like this:
{{{  
{{{
#!graphviz
  digraph G {
    rankdir = "LR"
    GraphvizPlugin [ URL=GraphvizPlugin ]
    Trac [ 
      URL="http://trac.edgewall.org/"   
      fontcolor=red
    ]
    GraphvizPlugin -> Trac
    }
}}}
}}}

This produces an image like this, but with clickable nodes (note that nodes aren't actually clickable in this example):

  [[Image(second-example.png)]]

More examples at: http://www.graphviz.org/Gallery.php

== Recent Changes ==

[[ChangeLog(graphvizplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:pkropf] [[BR]]
'''Maintainer:''' cboos [[BR]]
'''Contributors:''' cboos [[BR]]