XP Tracker Plugin
Version 3.2 - Jul 28 2004
This is a plugin for tracking
eXtreme Programming projects. The original code was
written by
TWiki:Main.RichardBennett, It was converted into this plugin by
TWiki:Main.MartinWatt and enhanced by
TWiki:Main.AndreaBacchetta,
TWiki:Main.AnthonPang,
TWiki:Main.AndreaSterbini,
TWiki:Main.ThomasEschner and
TWiki:Main.RafaelAlvarez
See
TWiki:Plugins/XpTrackerPluginHistory for a description of changes in this new version.
Documentation
The documentation is hosted in the Twiki.org site, and is not being distributed with the plugin as it's a ongoing effort.
Description
Layout
There is a hierarchy of information here:
- Web - the TWiki web for XP tracking. One web can be used to track multiple products.
- Project - the project being worked on for a Product. Usually this will be the next major release. Each project has a page, which contains an auto-generated summary of the project progress.
- Team - Each project has one or more teams, groups of developers that work on one aspect of the project. Each team has a page which contains an auto-generated summary of the team's progress.
- Iteration - a project is divided into a series of short iterations. Each iteration has a page, the contents of which are also auto-generated.
- Story - An iteration comprises a number of stories. Stories are pieces of related functionality that are owned by a lead developer but can be worked on by more than one developer. The story page contains information on the acceptance criteria, and also a list of tasks.
- Tasks - these are the atomic units of work. A story is usually broken up into a number of tasks. Tasks may be shared among more than one developer. Tasks details are entered on the story page.
Information is entered for Stories and their associated tasks, and for iteration dates. Information for all other levels in the hierarchy is automatically generated.
Usage
Creation of pages is recursive, each page has an html form that uses a template to create child pages:
- Projects/Teams. You can create a new project page using the html form on the home page for the tracking web. You can create a new team page using the form on the project page. You can add additional content to these pages if desired, but do not delete the existing content. This is used to provide high level overviews of schedule progress. Projects and Teams will not be shown in the pages if they don't have any iteration.
- Iterations Create new iterations from the team pages.
- Stories Create new stories from the iteration page. The story name can be any unique name, as long as it ends with the string "Story". Fill in the two tables for the story summary and task list respectively.
XpTrackerPlugin Settings
Plugin settings are stored as preferences variables.
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = This plugin tracks XP projects
- Debug plugin: (See output in
data/debug.txt)
- Plugin coloring schema:
- Set UNSTARTEDCOLOR = #FFCCCC
- Set INPROGRESSCOLOR = #FFFF99
- Set FINISHEDCOLOR = #99FF00
- Set DEPLOYMENTCOLOR = #99CCCC
- Set ACCEPTANCECOLOR = #CCFFFF
- Set COMPLETECOLOR = #99FF99
- Set ERRORCOLOR = #999999
- Set HOLDCOLOR = #FFFFFF
Templates
-
- Set PROJECTTEMPLATE = XpProjectTemplate?
- Set TEAMTEMPLATE = XpTeamTemplate?
- Set ITERATIONTEMPLATE = XpIterationTemplate?
Recognized Variables.
This is a list of all the tables available. The names should be self-explanatory.
| Variable | Parameters | Comment |
|---|
| XPSHOWALLPROJECTS | none | |
| XPSHOWALLTEAMS | none | |
| XPSHOWALLITERATIONS | none | |
| XPSHOWPROJECTTEAMS | project topic | |
| XPSHOWPROJECTITERATIONS | project topic | |
| XPSHOWPROJECTSTORIES | project topic | |
| XPSHOWTEAMITERATIONS | team topic | |
| XPSHOWITERATION | iteration topic | |
| XPSHOWITERATIONTERSE | iteration topic | |
| XPSHOWPROJECTCOMPLETIONBYSTORIES | project topic | |
| XPSHOWPROJECTCOMPLETIONBYTASKS | project topic | |
| XPVELOCITIES | iteration topic | |
| XPDUMPITERATION | iteration topic | Shows the iteration in the Book format (the complete text for each story one after another) |
| XPSHOWDEVELOPERTASKS | developer | Show a developer's open tasks group by project and iteration |
| XPSHOWDEVELOPERTASKS | developer, web | Show a developer's open tasks group by project and iteration, in the specified tracking web |
| XPSHOWDEVELOPERTASKSBYITERATION | developer,iteration | Show a developer's open tasks for a given iteration |
| XPSHOWDEVELOPERTASKSBYITERATION | developer,iteration,web | Show a developer's open tasks for a given iteration, in the specified tracking web |
| XPSHOWLOAD | developer | Show a developer's group by project/iteration |
| XPSHOWCOLOURS | | Service procedure to show current colours for each story status |
| XPGETSTORYSTATUS | story | Shows the status text for the given story |
Limitations
- This version has not been checked against data from V2.0.
Additional TWiki plugins/changes needed to get this plugin to work at its best
- The plugin should work in a standard 01Dec2001, 01Feb2003 and TWiki20040119beta TWiki install, but it is easier to use with these additional plugins:
- If not using the latest TWiki version, you need to apply the patch in TWiki:Codev.AfterSavePluginHandler
Plugin Installation Instructions
Note: You do not need to install anything on the browser to use this Plugin. The following instructions are for the administrator who installs the Plugin on the server where TWiki is running.
- Download the ZIP file XpTrackerPlugin.zip from the Plugin web (see below)
- Unzip
XpTrackerPlugin.zip in your twiki installation directory.
Content:
| File: | Description: |
|---|
data/TWiki/XpTrackerPlugin.txt | Plugin topic |
data/Tracking/WebHome.txt | Home page for XP tracking web |
data/Tracking/SetupHowto.txt | Help page - how to set up tracking for a project |
data/Tracking/TrackingIntro.txt | Help page - Introduction to web layout |
data/Tracking/WebTopicEditTemplate.txt | Template for any other type of new page (empty) |
data/Tracking/XpAdminPage.txt | Tracking Web Admin Page |
data/Tracking/XpIterationDetails.txt | Show XPSHOWITERATION for the including iteration topic |
data/Tracking/XpIterationTemplate.txt | New Iteration template |
data/Tracking/XpMyOpenTasks.txt | List the open tasks for the logged used |
data/Tracking/XpNewPageError.txt | Page shown when there is an error creating a page |
data/Tracking/XpProjectStories.txt | List all the stories for the including project topic |
data/Tracking/XpProjectStoriesStatus.txt | Show the stories status for the including project topic |
data/Tracking/XpProjectTasksStatus.txt | Show the tasks status for the including project topic |
data/Tracking/XpProjectTemplate.txt | New project template |
data/Tracking/XpShowWindowScript.txt | A utility javascript to show a topic in a new window |
data/Tracking/XpStoryTemplate.txt | New Story template |
data/Tracking/XpTeamTemplate.txt | New Team Template |
lib/TWiki/Plugins/XpTrackerPlugin.pm | Main plugin Perl module |
lib/TWiki/Plugins/Xp/*.pm | plugin Perl submodules |
Installation test
- If installed correctly,you should see the table with all the possible Story status and their colors, if not then you'll see %XPSHOWCOLOURS%
name  | colour | title |
|---|
| acceptance | | Acceptance |
| complete | | Complete |
| deployment | | Deployment |
| error | | Error |
| finished | | Finished |
| hold | | On Hold |
| inprogress | | In progress |
| unstarted | | Not Started |
Plugin Info
Related Topics: TWikiPreferences,
TWikiPlugins,
DefaultPlugin
to top