# The &ktjview2; Handbook

Lukáš
Tinkl

    lukas.tinkl@suse.cz

2004
SUSE AG
&FDLNotice;
2004-11-19
0.5

&ktjview2; is an advanced GUI frontend for the TaskJuggler project management suite and the KDE desktop.

KDE
TaskJuggler
GUI
Gantt

## Introduction

The TaskJuggler IDE project aims at developing an easy-to-use frontend to TaskJuggler that integrates well into the KDE desktop.

Features:

- Load, schedule, and display TaskJuggler project files (*.tjp) and XML reports (*.tjx), using TaskJuggler as a library.

- Project info page.

- Customizable Gantt view based on KDGantt.

- Resource and Task views with type-ahead find with many filtering and sorting options.

- Editor integration: Kate or KVim (depending on KDE settings) are used as a TaskJuggler project file editor.

- Syntax highlighting in the editor.

- Reload project files after changing them in the integrated editor or externally. If an error occurs, the file that throws the error is opened with the line that triggered the error highlighted.

- Report view with two predefined reports: Resource Usage and Task Coverage.

- Printing (only for Gantt view at the moment).

## Using &ktjview2;

As you can see on the screenshot below, the main window is comprised of several components between which you can switch by using the sidebar on the left side.

Here's a screenshot of &ktjview2; Screenshot of the main window

Screenshot of the main window

### Info View

This view displays general information about the project, such as the project name, currency, start and end date, copyright or version number.

### Gantt View

The gantt view is divided into two parts: task list and chart. The left part displays a hierarchical list of tasks and the other part depicts their duration in time. The chart has a horizontal header which represents the timeline of the project. Each task is drawn as a box whose color can be configured in the Settings dialog. The color corresponds to the type of the task: group task, milestone or normal task.

If you leave you mouse pointer over the task box for a short while, you will get a tooltip with a detailed information about the task.

Every item has a context menu with the option to jump to the task details.

### Resource View

The resource view displays a tree-like overview of the project's resources. As with other listviews, any column can be sorted by clicking on its header or reordered via drag'n'drop.

### Task View

The task view shows a flat list of tasks in the project. It is otherwise similar to the resource view.

Screenshot of the Quick Search bar Screenshot of the Quick Search bar

Screenshot of the Quick Search bar

Both Resource and Task view contain a very useful feature called Quick Search. Using the Quick Search toolbar you can easily search and filter for the text you want, optionally in some columns only.

New from version 0.6, you can directly jump to a resource or task definition in the editor component by double-clicking on an item in the listview or by pressing the Enter key.

### Report View

&ktjview2; currently contains two predefined reports: Task coverage and Resource usage which are accessible from the Reports menu. Either choice opens a dialog (see below) where you can set some report options.

Report options Screenshot of the report options dialog.

Screenshot of the report options dialog

Once you're content with the start, end date and scale, click on the Create button to generate the report.

### Editor View

Editing source code is recommended to experienced users only.

The editor view allows you to modify the project's source code directly. The editor supports common operations, such as Cut, Copy or Paste and unlimited Undo/Redo that are accessible from the Edit menu.

Once you manually change your project, you might want to save the changes (File -> Save) and then rebuild it (Tools -> Rebuild project).

## Command Reference

### The main &ktjview2; window

#### The File Menu

&Ctrl;N File New

  Creates a new document

&Ctrl;S File Save

  Saves the document

&Ctrl;Q File Quit

  Quits &ktjview2;

#### The Help Menu

&help.menu.documentation;

## Questions and Answers

What are the planned features?

You can find the list of planned on ongoing efforts on &ktjview2;'s homepage.

## Credits and License

&ktjview2;

Program copyright 2004 SUSE AG info@suse.com

Contributors:

- Lukáš Tinkl lukas.tinkl@suse.cz

- Joachim Werner joe@suse.de

Documentation copyright 2004 SUSE AG info@suse.com

&underFDL;

&underGPL;

## Installation

### How to obtain &ktjview2;

At the moment the only way of running the TaskJuggler IDE is downloading and building the daily CVS snapshot of thw whole TaskJuggler suite. The TaskJuggler IDE is currently called ktjview2 because it started as a replacement for ktjview. We are looking for a more pronouncable name. If you have any suggestions please drop us a note!

### Requirements

In order to successfully use &ktjview2;, you need &kde; 3.3 and the main TaskJuggler library.

You can get the whole TaskJuggler package on its home page.

### Compilation and Installation

In order to compile &ktjview2;, you must unpack the TaskJuggler tarball and issue the following:

    ./configure --with-kde-support=yes --prefix=`kde-config --prefix`
    make
    make install

&documentation.index;