README.md
1DokuMicroBugTracker
2=================
3**Licence :** GPLv3
4**Download :** [DokuMicroBugTracker Version 2011_10_18](/downloads/dokumicrobugtracker_latest.zip)
5**Sources :** [GitHub Repository](https://github.com/khertan/dokumicrobugtracker)
6**Bug Tracker :** [Bug Tracker](https://github.com/khertan/DokuMicroBugTracker/issues)
7
8DokuMicroBugTracker is a DokuWiki plugin which integrates a really small bug tracker in your wiki by displaying a small form that enable everyone to report bug and every users with edit right to edit any information.
9
10
11
12Download and Installation
13----------------------
14
15Download and install the plugin using the [Plugin Manager](http://www.dokuwiki.org/plugin:plugin) using the URL given above.
16
17[Download Version 2011_10_18](http://khertan.net/downloads/dokumicrobugtracker_latest.zip)
18
19Syntax and Usage
20--------------
21
22 {{dokumicrobugtracker>project=projectname|status=all|display=bugs}}
23
24| Parameter | Description | Default |
25|------------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------|
26| [project] | the project of your bugtracker (eg : name of your software) | required |
27| [status] | a filter to display only some status | default is all |
28| [display] | a filter to display only the report form, or only the bugs list, or count the number of different status in the project | default is both form and report |
29
30Storage
31------
32
33Each project have is own data file, which are nammed from an md5 of the project name with the bugs extension, and store in the datas/metas doku wiki folder.
34
35Examples
36-------
37
38**Display all bugs of project KhtEditor :**
39
40 {{dokumicrobugtracker>project=KhtEditor|status=all|display=bugs}}
41
42
43**Display just the report forms for project KhtEditor :**
44
45 {{dokumicrobugtracker>project=KhtEditor|status=all|display=form}}
46
47
48**Display all fixed bugs for project KhtEditor with a report form :**
49
50 {{dokumicrobugtracker>project=KhtEditor|status=Fixed}}
51
52
53**Display the number of report group by status :**
54
55 {{dokumicrobugtracker>project=KhtEditor|display=Count}}
56
57Still in developpment
58-------------------
59
60This plugin is a first shot, it s still in development and your all welcome to submit any ideas, or review.
61There is currently a bug on the sort of header when displaying multiple form in the same page.
62
63| Version | Release Note |
64|--------------------|-------------------------|
65| 2010-08-13 | Initial Release |
66| 2010-08-14 | Fix bug creating first bug report |
67| 2010-08-16 | Add report to user saying that bug is well saved (#4) |
68| 2010-08-17 | Add several feature, email notification, delete (for admin only), dynamic captcha (#3, #5, #6) |
69| 2010-08-26 | Fix bug on the dynamic captcha, notifications, clear description area after report |
70| 2010-08-27 | Fix bug on insert report due to deletion |
71| 2011-01-05 | Implement Ajax edition, add count feature, remove delete button |
72| 2011-02-18 | Fix #16, #20 : Add missing / and table class inline. |
73| 2011-03-07 | Fix #11, #21 : Fix edit and url callback. |
74| 2011-04-13 | Fix #27, remove the forced title in the form, fix multiple post occurring when displaying multiple bugs list and report in the same page. |
75| 2011-08-24 | Implement #65 (Configurable severity), Implement #62 (Inform user of modification on a report), Implement #64 (No report without information), Use captcha helper plugin for consistent captcha on the wiki, Fix #34. |
76| 2011-10-17 | Use jquery, datatables plugin and jEditable to manage table, and fix a security issue. |
77| 2011-10-18 | Fix link to the stylesheet in action.php, fix the delete feature. |
78
){kind=link}