====== structgantt Plugin ======

---- plugin ----
description: Create Gantt charts from struct data
author     : Andreas Gohr 
email      : andi@splitbrain.org 
type       : syntax
lastupdate : 2023-08-09
compatible : Frusterick Manners
depends    : struct
conflicts  : 
similar    : 
tags       : gantt, charts

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-structgantt/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-structgantt/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-structgantt/
donationurl: 

screenshot_img : https://i.imgur.com/IKNdQNV.png
----

This plugin creates simple Gantt charts from data stored with the [[struct]] plugin.

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

===== Installation =====

Be sure to install an up-to-date [[struct]] plugin version first.

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Changes ====

{{rss>https://github.com/cosmocode/dokuwiki-plugin-structgantt/commits/master.atom}}

===== Usage and Syntax =====

The Syntax is the same as for other [[plugin:struct:aggregation|Struct Plugin Aggregations]], except that the header uses ''struct gantt'' as identifier. Here's a very basic example:

<code>
---- struct gantt ----
schema: timemachine
cols: %title%, *
skipweekends: 1
----
</code>

As you can see there is a new option ''skipweekends'' which will remove Saturdays and Sundays from the shown chart.

The chart automatically switches the headers from days, week numbers and month names depending on the amount of days in the whole chart.

There are a few restrictions you have to keep in mind:

  * your aggregation needs to select at least two [[plugin:struct:type_date|Date]] or [[plugin:struct:type_date|DateTime]] fields
    * the first one is used as start date
    * the second one is used as end date
  * There have to be at least two days in the whole chart
  * Tasks not having a start or end date are not shown
  * your aggregation needs to select at least one non-Date/DateTime field
    * the first one is used as the task header
    * the second one is used as label on the task itself
  * your aggregation may contain a [[plugin:struct:type_color|Color]] field
    * the first one will be used as the background color of the task
  * currently neither Multi nor Lookup Fields are properly supported
    * you may encounter weird or broken behavior with them