EnhancedXpTrackerPlugin

This plugin allows you to track the project an report its staus.The plugin will track the status of all iterations for all products are tracked in one web. I take a vision fromTWiki:Plugins/XpTrackerPlugin but it doesn't fulfil all needs of our company. So I has developed plugin and enhanced the convenience,usability and simplicity of the entire project tracking system by using other plugins(which are stated below).

Hierachy of Information

Layout

There is a hierarchy of information here(same as in XpTrackerPlugin):

• 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.

EnhancedXpTrackerPlugin Settings

Plugin settings are stored as preferences variables.

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Track projects using the Extreme Programming methodology

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Topic Templates

Used to create new Projects, Teams, Iterations and Stories

• XpProjectTemplate
• XpTeamTemplate
• XpIterationTemplate
• XpStoryTemplate
  The above templates should not be directly edited in the TWIKI website. They should be done in the editors

Supplementary page Templates

• NavTeamTemplate
• NavProjectTemplate
• NavIterationTemplate
• NavStoryTemplate
• TeamSummaryTemplate
• IterationSummaryTemplate
• ProjectSummaryTemplate
• ProjectDocumentationTemplate
• StoryReviewTemplate

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
XPSHOWITERATIONSINTOPIC	Team	Displays the iterations of a team
XPSHOWSTORIESINTOPIC	Iteration	Displays the stories of an iteration

Additional TWiki plugins/changes needed to get this plugin to workt

• The plugin should work in a standard 01Dec2001, 01Feb2003 and TWiki20040119beta TWiki install, but it is with these additional plugins:
  • TWiki:Plugins.TablePlugin
  • TWiki:Plugins.EditTablePlugin
  • TWiki:Plugins:TopicCreatePlugin
  • TWiki:Plugins:TwistyPlugin
  • TWiki:Plugins/NavBarAddOn
• If not using the latest TWiki version, you need to apply the patch in TWiki:Codev.AfterSavePluginHandler

Examples

This is the screen shot of the plugin working Note: The project names and teams names have been blurred out for confidentiality.

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 TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Unzip EnhancedXpTrackerPlugin.zip in your twiki installation directory. Content:

File:	Description:
data/TWiki/EnhancedXpTrackerPlugin.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/EnhancedXpTrackerPlugin.pm	Main plugin Perl module
lib/TWiki/Plugins/Xp/*.pm	plugin Perl submodules

and Supplementary page templates for efficient navigation of topics.

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed

Plugin Info

Plugin Author:	TWiki:Main.SrikanthRevanuru
Copyright:	© 2007, TWiki:Main.SrikanthRevanuru
License:	GPL (GNU General Public License)
Plugin Version:	10 Jul 2008 (V1.000)
Change History:
10 Jul 2008:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	HTTP::Date
Other Dependencies:
Perl Version:	5.005
Benchmarks:	GoodStyle nn%, FormattedSearch nn%, EnhancedXpTrackerPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/EnhancedXpTrackerPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/EnhancedXpTrackerPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/EnhancedXpTrackerPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.SrikanthRevanuru - 10 Jul 2008