Exporting Gantt charts with Taskjuggler v3 (tj3)

{Back to Worg's index}

Table of Contents

Introduction

This article discusses the use of Org-mode for project planning using Taskjuggler, self-described as follows (from the project website):

TaskJuggler is a modern and powerful, Free and Open Source Software project management tool. Its new approach to project planning and tracking is more flexible and superior to the commonly used Gantt chart editing tools.

A tutorial already exists for the use of Org-mode and Taskjuggler v2.4.3, the last release of the v2.x.x series. Taskjuggler Version 3 (often referred to as simply "tj3"), was rebuilt using Ruby, and no longer features the former Qt-based GUI for task/timeline management of a project.

It should also be mentioned that the project is now 10 years old, and, as a result, is fantastically documented.

The Org-mode manual coverage of Taskjuggler covers Taskjuggler export to some extent, however the defaults assume the use of version 2.x.x. This tutorial will lay out the changes required to successfully export with tj3.

Installation and Setup

Preface: If you have not recently (and successfully) used tj3, it is recommended that you try compiling the example .tjp file as described below to rule out any issues with the tj3 installation itself before moving on integrating tj3 with Org mode.

Please refer to the installation section of the Taskjuggler manual for instructions. For the high level overview, you will need to install ruby and possibly ruby-gems. The easiest method is probably to install ruby-gems and simply type, from a terminal/command-line interface (you may need to run this as the root user or with sudo):

gem install taskjuggler

For Linux users, you may have a distro-specific package available if you would rather choose that route. For example, the Arch Linux User Repository (AUR) has a Taskjuggler 3 package available.

Once installed, you should check functionality by typing:

tj3 --version

If you just can't wait to see what tj3 can do, try compiling their sample file:

  • Copy/paste into a file called something.tjp. Alternatively,
http://taskjuggler.org/tj3/examples/Tutorial/tutorial.tjp

  • Save the file and then issue:1
$ cd /path/to/something.tjp
$ tj3 something.tjp

Now check out the generated Overview.html in a browser!

Using tj3 with Org mode

To activate the Taskjuggler exporter in Org-mode, add this line to ~/.emacs:

(require 'ox-taskjuggler)

Either restart Emacs or issue M-x load-file RET ~/.emacs RET and we're ready to create our project managment .org file!

This document is a work in progress; more details to come [shortly]!

Footnotes:

1 You may run into compilation issues due to special characters in that file on lines 37 (a copyright symbol), 79, and 83 (two accented characters in resource names). If this happens, just replace those three characters with something else, or delete them, and the file should compile. An issue has been filed inquiring about whether or not this is a system setup issue and, if not, suggesting that the characters be replaced.

Documentation from the http://orgmode.org/worg/ website (either in its HTML format or in its Org format) is licensed under the GNU Free Documentation License version 1.3 or later. The code examples and css stylesheets are licensed under the GNU General Public License v3 or later.