BugsContrib < Extensions

You are here: Foswiki>Extensions Web>BugsContrib (05 Oct 2010, GeorgeClark) (raw view)

<!--
This topic is part of the documentation for BugsContrib and is
automatically generated from Subversion. You can edit it, but if you do,
please make sure the maintainer of the extension knows about your changes,
otherwise your edits might be lost the next time the topic is uploaded.

If you want to report an error in the topic, please raise a report at
http://foswiki.org/Tasks/BugsContrib
-->
<img src="%PUBURL%/%WEB%/%TOPIC%/wikiring-bugscontrib.png" style="float:right;" />

---+ Item Tracking system implemented as a Foswiki Data Application

<!--

   PLEASE DO NOT EDIT THIS TOPIC

   It is automatically generated from the subversion repository, and any changes
   you make will simply be overwritten the next time a release is generated.

   Instead, you could check your fix in, raise a bug in the Bugs web, or mail thge author.
-->

The [[_BugsContrib.WebHome][Bugs]] web is intended for collecting reports of issues, and then tracking progress towards getting those issues fixed. 
Issues are structured Foswiki topics, where forms are used to store a number of fields that contain data about the issue.

This is an Item Tracking System implemented using %SYSTEMWEB%.DataForms.
It has been implemented to be used in a web on its own, but could be intermingled with a discussion style Web. 
It is a pure Foswiki Data Application implemented using only what you get in the box when you download Foswiki. 

A customised version of it has been in use as TWiki's bug tracking and shakeout system since 2005 - See http://develop.twiki.org/~twiki4/cgi-bin/view/Bugs, and
now also as [[http://foswiki.org/Tasks][Foswiki's tracking system]] since the [[http://foswiki.org/Home/WhyThisFork][Fork]].

The BugsContrib is a _Foswiki Application_ (an application that is implemented entirely in Foswiki topics). 
It is designed to use the left bars supported by %SYSTEMWEB%.PatternSkin and the Foswiki:Extensions.MoveableTypeSkin, 
though could easily be converted to another skin. It's ideal for a small bug database (we have used it with over 4000 items with no problems) for a disciplined team.

The main entry point for examining the list of issues is [[_BugsContrib.AllOutStandingItems]], which can be used to perform general purpose searches over the database. 
You can subdivide the web into different areas using the [[_BugsContrib.AppliesTo]] field, and provide each area with its own search topic.


---++ Existing bug bases

%SEARCH{ "NEWTOPICNAME"
         nonoise="on" nototal="off"
         web="all"
         topic="WebPreferences"
         scope="text"
         type="literal"
         format="| <img src='%PUBURL%/$web/WebPreferences/logo.png' height=48 /> [[$web.%HOMETOPIC%][$web]] |"
         header="| *Bugs base web* |"
}%


---++ Installation

---+++ Installation Instructions

	* Download the archive from the Extensions web (see below)
	* Unpack it in your Foswiki installation directory. 
	* Make sure that all files are readable by the web server user
	* Run =perl= ==%TOPIC%_installer.pl== =install= to automatically check and install other Foswiki modules that this module depends on, that you may not have installed. This script also includes an =uninstall= option should you ever wish to remove the plugin from your installation, and an =upgrade= option that will automatically download and install the latest version.
	* Create a new bugs web workspace below.
	* To notify users via email when a report they have created, or are expected to provide feedback for, has changed, modify your crontab entry for the MailerContrib


---++++ Create a new Bugs web workspace
<form name="admin" action="%SCRIPTURLPATH{manage}%/%WEB%/%TOPIC%" method="post">
|  *Name of new Bugs web* | <input name="newweb" class="foswikiInputField" type="text" value="%URLPARAM{"newweb"}%" size="16" /> %BR% <small>The name must start with an upper case letter, followed by upper or lower case letters or numbers. Specify a short name to avoid long URLs.</small> ||
|  *Web color* | <input name="WEBBGCOLOR" class="foswikiInputField" type="text" value="#D0D0D0" size="16" /> %BR% <small>Enter a StandardColors code for the web</small> ||
|  *Description<br /> &nbsp;<br /> &nbsp;* | <input type="text" class="foswikiInputField" name="SITEMAPWHAT" value="" size="60" /><br /> <small>Enter a short description of the web. Write =Web.TopicName= instead of just =TopicName= if you include links. This description will be used in the %SYSTEMWEB%.SiteMap</small> ||
| *&nbsp;* | <input type="submit" class="foswikiSubmit" value="Create new web" /> ||
<input name="baseweb" value="_BugsContrib" type="hidden" />
<input name="SITEMAPLIST" value="on" type="hidden" />
<input name="SITEMAPUSETO" value="" type="hidden" />
<input name="NOSEARCHALL" value="" type="hidden" />
<input name="newtopic" type="hidden" value="%URLPARAM{"newtopic"}%" />
<input name="action" type="hidden" value="createweb" />
</form>


<verbatim>
0 0 * * *      ( cd /path/to/foswiki/bin && ../tools/genwebnotify WebName && ../tools/mailnotify )
</verbatim>


---++++ Customising the Bugs Web

The web is configured as a simple bug tracker, but can easily be customised to meet your own requirements. Here are some pointers:
   1 [[_BugsContrib.ItemTemplate]] contains the basic bug form. This is a [[%SYSTEMWEB%.DataForms][DataForm]].
   1 [[_BugsContrib.WebLeftBar]] contains the left menu bar
   1 [[_BugsContrib.AppliesTo]] contains the list of areas that an issue might apply to. Configure this to your own requirements
   1 [[_BugsContrib.Priority]] contains a list of valid priorities
   1 [[_BugsContrib.CurrentState]] contains a list of valid item states
   
----

   * Set SHORTDESCRIPTION = Item Tracking system implemented as a Foswiki Application

|  Authors: | Foswiki:Main.SvenDowideit of [[http://distributedINFORMATION.com][distributedINFORMATION.com]], %PUBURL%/%WEB%/%TOPIC%/wikiring.png http://wikiring.com partners & others |
| Plasticbug logo | by [[http://liquisoft.com][Ryan Ford]] |
|  Dependencies: | None |
|  License: | GPL |
|  Release: | 4 Oct 2010 |
|  Version: | 9513 (2010-10-05) |
| Change&nbsp;History: | |
|   3 Oct 2010: | Foswikitask:Item9785: Add BugsContrib.pm dummy module and document requirement. | 
|  15 Oct 2009: | Foswiki:Main.SvenDowideit - Foswiki:Bugs.Item2252 - remove twiki css |
|  16 May 2009: | Foswiki:Main.WillNorris - Foswiki:Bugs.Item5669 - dashboard cleanup |
|  16 May 2009: | Foswiki:Main.WillNorris - Foswiki:Bugs.Item8158 - add edit %ICON{edittopic}% to each result row |
|  16 May 2009: | Foswiki:Main.WillNorris - Foswiki:Bugs.Item8156 - change to template web architecture, to allow more than one bug base per installation |
|  15 May 2009: | Foswiki:Main.WillNorris - Foswiki:Bugs.Item1576 - fix hard-coded =/Bugs/= web directory name |
|  22 Jan 2009: | Foswiki:Main.WillNorris - support to email users when a report they have created, or are expected to provide feedback for, has changed |
|   1 Nov 2007: | Foswiki:Main.SvenDowideit - updated to fix bugs reported in the Dev topic (4.2 query release to come later) |
|  13 Feb 2007: | Foswiki:Main.SvenDowideit - update with lessons learned from longer term use |
|  | Foswiki:Main.CrawfordCurrie - packaged for Release |
|  Home: | Foswiki:Extensions/%TOPIC% |
|  Support: | Foswiki:Support/%TOPIC% |

PackageForm edit

ExtensionClassification	Development, Workflow automation
ExtensionType	ContribPackage
ImageUrl
DemoUrl	http://foswiki.org/Tasks
SupportUrl	BugsContrib
DevelopedInSVN	Yes
ModificationPolicy	PleaseFeelFreeToModify

Topic attachments
I	Attachment	Action	Size	Date	Who
md5	BugsContrib.md5	manage	0.2 K	05 Oct 2010 - 01:17	GeorgeClark
sha1	BugsContrib.sha1	manage	0.2 K	05 Oct 2010 - 01:17	GeorgeClark
tgz	BugsContrib.tgz	manage	84.6 K	05 Oct 2010 - 01:17	GeorgeClark
zip	BugsContrib.zip	manage	102.0 K	05 Oct 2010 - 01:17	GeorgeClark
EXT	BugsContrib_installer	manage	5.8 K	05 Oct 2010 - 01:17	GeorgeClark
png	wikiring-bugscontrib.png	manage	26.6 K	05 Oct 2010 - 01:16	GeorgeClark
png	wikiring.png	manage	1.3 K	05 Oct 2010 - 01:17	GeorgeClark

Topic revision: r16 - 05 Oct 2010, GeorgeClark

Extensions

Quick Links

Tools

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement.