[[PageOutline(2-5,Contents,pullout)]]

= Graphviz for dynamic generation of diagrams

== Description

[[Image(graphviz_logo.png, align=right)]]

This is a plugin that allows the dynamic generation of diagrams by [http://www.graphviz.org/ Graphviz] programs within wiki pages and ticket descriptions. Graphviz is open source graph visualization software library, which itself is [http://www.graphviz.org/license/ Eclipse licensed]. Graphviz works by interpreting a textual description of the nodes and its connections.

The text of a wiki page can contain the source text for Graphviz and the web browser will show the resulting image. For example, add the following lines to a wiki page:

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

and that would produce an image as follows:

[[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/

== Bugs/Feature Requests

Existing bugs and feature requests for GraphvizPlugin are 
[report:9?COMPONENT=GraphvizPlugin here].

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

When creating a new ticket, be sure to mention which version of Trac and which version of the plugin you are using. If the version number ends with `dev`, then please also specify the ''changeset number'' that corresponds to the version you are using.

[[TicketQuery(component=GraphvizPlugin&group=type,format=progress)]]

== Download

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 plugin is also available on [pypi:TracGraphviz PyPI].

== Source

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

== Installation

 1. A prerequisite for installation are the programs from http://www.graphviz.org.
 1. Install
   * By hand:
     1. See [source:graphvizplugin/trunk/README.rst] for details on installing the plugin for Trac 1.3 and up
     1. See [source:graphvizplugin/branches/1.2/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.
   * Using easy_install (for Trac 1.3+)
 {{{#!sh
[sudo] easy_install https://trac-hacks.org/svn/graphvizplugin/trunk
}}}
   * Using easy_install (for Trac 1.0 and 1.2):
 {{{#!sh
[sudo] easy_install https://trac-hacks.org/svn/graphvizplugin/branches/1.2
}}}
   * Using easy_install (for Trac 0.11 and 0.12): 
 {{{#!sh
[sudo] easy_install https://trac-hacks.org/svn/graphvizplugin/tags/0.11-0.7.5
}}}
    * Note: `sudo` is optional case you already have enough authorization 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:
 {{{#!ini
[components]
...
graphviz.* = enabled
...
}}}
   * or accessing your Admin panel ({{{ ..admin/general/plugins }}}).
 1. Configure your environment by modifying your `trac.ini` file.

== Recent Changes

[[ChangeLog(graphvizplugin, 3)]]

== Author/Contributors

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