Extension:IssueTracker

The IssueTracker extension is a simple and powerful bug tracking and issue tracking system developed to make this process easier for your team. It introduces the tag to the MediaWiki markup, which can be used to produce an issue and bug tracking system.

Version 1.0

 * View, add, edit and archive issues.
 * Search issues.
 * Filter issues.
 * List issues (new, resolved, closed, archived and/or any other custom tag).
 * Access Control List (group of users can have a different access levels).
 * Anonymous issue management.
 * MVC architecture, easy to extended.

Version 1.1(not yet released)

 * Attachments.
 * Issue change history.
 * Changelog support.
 * Email notifications.
 * Users can monitor specific issues.

Screencast
YouTube: IssueTracker

Usage
The IssueTracker extension provides a custom tag,, that allows the inclusion of an issue tracker in any wiki page. It's possible to customize almost every aspect of the extension, such as permissions, user groups, colours, titles, and templates. It supports searching and several types of filtering.

To embed an issue tracker into a page, use the tag:

If a project name is not provided, the extension will use the page namespace as the default project name. You can create multiple issue trackers by providing different project names, for example:



To hide the filter and search forms you can set the search and filter options to false:



By default, users must be logged in to add, edit or achieve issues. If you want to allow anonymous issue management, set the authenticate option to false:



Options

 * project = String : The project name (default: page namespace).
 * authenticate = Boolean : User authentication (default: true).
 * search = Boolean : Display search form (default: true).
 * filter = Boolean : Display filter form (default: true).

Requirements
The IssueTracker extension requires MediaWiki 1.9.0 or greater.

Archive File
Available formats: zip | tar.gz

Subversion Repository
Use SVN to checkout a copy of the source code. I highly recommend you to get the trunk version of the extension until a stable version is released. I do what I can to ensure that SVN versions are build-able and run-able, but clearly beta versions in SVN should not be considered stable.

Check out the current development trunk with:

$ cd extensions/ $ svn checkout http://svn.phpimpact.com/repo/MediaWiki/IssueTracker/trunk/ IssueTracker

Installation
1. Copy the IssueTracker/ directory into the extensions folder of your MediaWiki installation. Note: Make sure that the extensions/ directory and the IssueTracker/ directory are both readable and executable by everyone.

2. Add the following line to the LocalSettings.php file:

3. Create the database table, executing the following script on your MySQL administration tool. In case you are using Wiki SQL table prefixes, do not forget to add that prefix as prefix to the table name issue_tracker.

Customization
Customization options are available and can be set in the IssueTracker.config.php file.

Issue Types

You can add as many issue types as you want, for example:

Issue Status

Permissions

By default:


 * list: Any group can access the listing page.
 * view: Any group can view issues.
 * add: Any group can add issues.
 * edit: Any group can edit issues.
 * archive: Any group can archive issues.
 * delete: Any group can delete issues.
 * assign: Only the "Sysop" group can assign issues.
 * assignee: Issues can only be assigned to users in the "Devel" group.

Can't add more than one issue tracker on a page
More than one issue tracker on a page is not properly supported. It looks fine, but when you create a new issue, it creates a new issue for every issue tracker on that page, with the exact same content, into the one tracker.

A possible solution I thought would be to add issue tags with a different project attribute. This instead created 3 issues in the same tracker. But that is different than the results above which would have created 1 in each of the 3.

Path bug
 1.13.3 bug found 

 the same applies for 1.14.0, 1.15.1 and 1.16.0 also 

Open: IssueTracker/Actions/IssueTrackerActionAdd.php

Find: protected function _getUsers

Change: After the opening curly bracket ( { ), add "global $IP;"

Find: require_once 'SpecialListusers.php';

Change to:

--Lhridley 12:41, 18 June 2009 (UTC)

Special Pages name bug
In the current trunk (I don't know about 1.15) the "special pages" page of Issue Tracker is set to "Special:Issue_Tracker", which breaks the code. The new code apparently gets this name from a different source then it used to. To change this behavior open:

neno extensions/IssueTracker/IssueTracker.i18n.php

and edit the first variable, so that "Issue Tracker" becomes "IssueTracker"

$messages['en']['issuetracker']   = 'IssueTracker';

--skerit 23:27, 13 October 2009 (GMT+1)

Issue titles with quotes display incorrectly
Due to the procedure by which information from the database is displayed on the page, quotes in an issue title will be interpreted as HTML, and thus the title will appear truncated. To fix this bug, changes need to be made to 3 files:

--Neatnate 18:37, 22 November 2009 (UTC)
 * wiki-root/extensions/IssueTracker/Views/details.html :
 * should be
 * should be
 * wiki-root/extensions/IssueTracker/Views/list.html :
 * should be
 * should be
 * wiki-root/extensions/IssueTracker/Views/edit.php :
 * should be

Unable to load mediawiki
I am not sure that this matters but I'm using Fedora 14 and the latest mediawiki. When adding the line to LocalSettings.php, the mediawiki fails to load completely. Without this line it works fine but no Issuertracker of course. Tried both syntaxes. Does anyone know why?

require_once( "$IP/extensions/IssueTracker/IssueTracker.php" );
 * 1) Issue Tracker **********
 * 2) require_once $IP . '/extensions/IssueTracker/IssueTracker.php';

permissions are all set to 777 for the extensions directory and issue_tracker table exists in database.

License
GNU General Public Licence 2.0 or later. Copyright &copy; 2008, Federico Cargnelutti.