MediaWiki extensions manual

JSWikiGantt Release status: unmaintained
Implementation	Tag
Description	Draws Gantt charts inside wiki articles.
Author(s)	• Extension code and fixes by Maciej "Nux" Jaros, • JSGantt by Shlomy Gantz, • Xaprb JavaScript date formatting by Baron Schwartz
Latest version	0.6.0 (2014-08-10)
MediaWiki	1.16+
PHP	5.1+
License	BSD 2-clause "Simplified" License
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net .
Parameters mostly you'll want to change "$wgJSGanttConfig" (see "JSWikiGantt.config.php" for details)
Tags <jsgantt>
Hooks used ParserFirstCallInit ParserAfterTidy

The JSWikiGantt extension aims to allow adding Gantt charts (diagrams) to wiki pages without the need of exporting diagrams to PNG.

This is achieved by allowing users to add simple XML definition of diagrams in <jsgantt> tag. Currently only one diagram per page is allowed (which is due to the limitations of the original JSGantt).

Usage

To add a diagram to a page, simply add a <jsgantt> tag with <task> tags inside it (described below).

The <jsgantt> tag can have only one attribute:

autolink

if set to 1, your tasks will be automatically linked based on the task id (very useful if you use task ids from your bug tracking software). Remember to set $wgJSGanttConfig['TasksAutoLink'] in JSWikiGantt.config.php if you use this. The default state of autolinking is set with the $wgJSGanttConfig['AutoLinks'] variable.

Example

Rendering of the code

Example code:

<jsgantt>
<task>
	<pID>10</pID>
	<pName>WCF Changes</pName>
	<pColor>0000ff</pColor>
	<pLink></pLink>
	<pMile>0</pMile>
	<pRes></pRes>
	<pComp>0</pComp>
	<pGroup>1</pGroup>
	<pParent>0</pParent>
	<pOpen>1</pOpen>
	<pDepend></pDepend>
</task>
<task>
	<pID>20</pID>
	<pName>Move to WCF from remoting</pName>
	<pStart>2010-07-11</pStart>
	<pEnd>2010-07-15</pEnd>
	<pColor>0000ff</pColor>
	<pLink></pLink>
	<pMile>0</pMile>
	<pRes>Rich</pRes>
	<pComp>10</pComp>
	<pGroup>0</pGroup>
	<pParent>10</pParent>
	<pOpen>1</pOpen>
	<pDepend></pDepend>
</task>
<task>
	<pID>30</pID>
	<pName>add Auditing</pName>
	<pStart>2010-07-19</pStart>
	<pEnd>2010-07-21</pEnd>
	<pColor>0000ff</pColor>
	<pLink></pLink>
	<pMile>0</pMile>
	<pRes>Mal</pRes>
	<pComp>50</pComp>
	<pGroup>0</pGroup>
	<pParent>10</pParent>
	<pOpen>1</pOpen>
	<pDepend>20</pDepend>
</task>
</jsgantt>

Diagram options

As of 0.6.0 you can set some extra Gantt options from MediaWiki code e.g.:

<jsgantt option-caption-type="Complete" option-show-resource="1" option-show-duration="1">
...
</jsgantt>

Those options allow you to enable features for certain Gantt diagram without changing the configuration of the extension.

$attrib = '[A-Za-z0-9]';

$attrib = '[A-Za-z0-9\-]';

Installation

1. Download, extract and place the files them under $IP /extensions/JSWikiGantt
2. At the end of LocalSettings.php , add:

   require_once "$IP/extensions/JSWikiGantt/JSWikiGantt.php";
   

3. Installation can now be verified through Special:Version on your wiki
4. If you use apache's mod_rewrite to beautify your wiki's URLs you need to add a RewriteCond to apache's config to exclude the path to your JSWikiGantt installation from rewriting. Example: RewriteCond %{REQUEST_URI} !^/YOUR_WIKI_PATH/extensions/(JSWikiGantt|MORE_EXTENSIONS_THAT_NEED_TO_LOAD_JS-FILES_FROM_THEIR_PATH)/

See also

• Extension:JSWikiGanttFrontEnd - Front end interface for editing the Gantt chart
• Extension:JobSchEd - interface for editing one of types of Gantt diagrams
• Extension:EasyTimeline - other timeline drawing extension