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

= Render Gantt charts in wiki pages

== Description

This plugin implements a wiki processor that generates a Gantt chart using a YAML text block. [wikipedia:YAML YAML] is a data serialisation markup language, suited for tasks where humans are likely to view or edit data structures. In this case the YAML text block is interpreted as an ordered list of tasks, each with a start date and duration.

Add this to the text of any wiki page:
{{{
{{{
#!gantt
0 : {start: '2008-03-20', dur: 5d, title: Punchlist}
1 : {start: '2008-03-28', dur: 2w, title: Alpha Project}
2 : {start: '2008-03-28', end: '2008-05-15', title: Project V, color: green}
3 : {start: '2008-03-28', end: '2008-10-01', title: Testing 2.0, color: blue}
4 : {start: '2008-04-28', end: '2008-05-15', title: Bug Fixes, color: red}
}}}
}}}

which will then be rendered as follows:

[[Image(Example.png)]]

The Gantt chart is output in one of the following image formats: jpg, png (default), gif.

== Bugs/Feature Requests

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

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

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

== Download

Download the zipped source from [export:ganttchartplugin here].

== Source

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

== Installation

Installation prerequisites:
 * [http://pyyaml.org/wiki/PyYAML PyYAML].
 * [http://labix.org/python-dateutil python-dateutil].
 * [pypi:Pillow Python Imaging library (PIL)].
 * `arial.ttf` font; for example, on Ubuntu install the `msttcorefonts` package and set `font_file = /usr/share/fonts/truetype/msttcorefonts/arial.ttf`.
 * [pypi:hashlib/20060408a hashlib], if using Python 2.4, and it is part of Python core in >= 2.5.

Add the following to your `trac.ini` file:

{{{#!ini
[components]
gantt.* = enabled

[gantt]
cache_dir = path/to/cache/dir
font_file = path/to/font/file
date_format = %m/%d/%Y
include_summary = true
show_opened = true
summary_length = 16
use_creation_date = true 
}}}

== Recent Changes

[[ChangeLog(ganttchartplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:malsmith] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' StefanSimroth