1/** 2* IssueTracker Plugin: allows to create simple issue tracker 3* 4* @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 5* @author Taggic <taggic@t-online.de> 6*/ 7 8Intro 9------ 10 Simply spoken a user can easily report an issue for defined products which will 11 be added to an issue log (project). Some checks are implemented to prove if 12 most important values are given. The user will be informed by a green info box 13 if the issue was added successfully to the log file or a red one with details 14 to provide missing information. The issue will be stored to a file of issues 15 and gets an ID. Automatically the configured admin is informed by mail about a 16 new entry to the issue list. The complete issue list delivers a detailed 17 overview to the admin of the reports. The admin is able to easily reduce the 18 visible information (column wise) displayed to the users, which not necessarily 19 of interest by them. 20 21 Members of configured 'assign' groups are able to edit the entries of the issue 22 list and see the complete set of details. The issue list is sortable on all 23 columns. The email addresses of this group members are automatically loaded 24 into the lists select box to be easily set as issue related contact. 25 26 Please read the complete and most recent plugin description at: 27 http://www.fristercons.de/fcon/doku.php?id=issuetracker:descr 28 29 30Syntax 31------- 32 Simply place the following syntax into the page markup of 2 different pages: 33 34 <code> 35 ====== Report an Issue ====== 36 ~~NOCACHE~~ 37 {{issuetracker>project=your_project|status=all|severity=all|display=form}} 38 39 ====== List of Issues ====== 40 ~~NOCACHE~~ 41 {{issuetracker>project=your_project|product=all|status=all|severity=all|display=issues}} 42 </code> 43 44 45Installation 46------------ 47 Just download and extract it as folder �issuetracker� into your �\lib\plugins� 48 directory. 49 50 51Configuration 52-------------- 53 The following configurations can be done via the configuration manager: 54 Admin => Configuration Settings => Issuetracker Plugin Settings 55 56^ config item ^ options & defaults ^ 57-------------------------------------------------------------------------------- 58 Inform by mail about new issues ? = on/off 59 60 Who is to be informed ? = email_address 61 62Edits only by registered users = on/off 63 64 Inform user automatically by mail = on/off 65 about issue mod 66 67 Configure columns to be shown to = multi select of columns to be displayed 68 user as overview if non-admin viewing the issue list 69 70 Use captcha = on/off 71 72 Define severity levels you will use = Query,Minor,Medium,Major,Critical, 73 (comma separated) Feature Request(defines user options) 74 75 Define issue status levels you = New,Assigned,External Pending,In 76 will use(comma separated) Progress,Solved,Canceled,Double 77 (defines assignee's options) 78 79 Define tracked products = define products of the project where 80 (comma separated) users can report issues 81 82 select wiki user groups pre-selected = admin|user 83 for assigning issues to 84 (Pipe �|� separated) 85 86 status text instead of icons at = little icons will be displayed with 87 Issue list status text as tooltip to save space 88 on table output but if you switch on 89 here the statusis provided as text 90 91 severity text instead of icons at = little icons will be displayed with 92 Issue list severity text as tooltip to save space 93 on table output but if you switch on 94 here the severityis provided as text 95 96Examples/Usage 97-------------- 98 Use this plugin to simply create an issue tracking. It is a further development 99 based on dokumicrobugtracker 2011-04-13 initial code base for corrections, 100 which was not working on my installation (Rincewind + Arctic). Probably you 101 noticed the same problems (e.g. edit of entries does not work) and may find a 102 help with this. 103 104 1051. Report an issue 106------------------ 107 This is a form shown to the user to provide controls for input of issue 108 information. Following information are handled: 109 110 {{issuetracker>project=your_project|status=all|display=form}} 111 112 ID automatically set 113 Project automatically set (defined by your_project, see Syntax) 114 Product user can select from admin pre-defined set of values 115 Version user to enter version info 116 User name name derived from login if registered user, else should be entered by user 117 User mail e-mail derived from login if registered user, else should be entered by user 118 User phone phonenumber of the user 119 Add contact a further contact can be added if necessary 120 Severity user can select from admin pre-defined set of severities 121 Issue Title the headline of the issue 122 Issue Description user to enter the issue details 123 Symptoms user may add up to 3 links targeting files on a symptom server 124 Captcha user to enter for security reasons (if configured) 125 126 1272. Issue List 128------------- 129 The Plugin delivers an issue list, where admin can configure a restricted view 130 for users. The admin view delivers more details in the table. Admin is able to 131 modify some entries directly on this output, i.e. admin is able to assign the 132 issue to a member of configured user-groups (see configuration). 133 134 {{issuetracker>project=your_project|product=all|status=all|severity=all|display=issues}} 135 1363. Issue Details view 137--------------------- 138 For better handling and also accessible for users there is a details view of an 139 issue. Therefore the Issue List containing a input and button to specify the 140 isuue ID. This will provide a new page displaying all information of an issue 141 and delivering a comment function for interaction between User and Admin/ 142 assigned resource. Both (user/assignee) will be informed about issue updates by 143 email, if configured. 144 145 1464. General Info 147---------------- 148 There are multiple files created. First there is a project file containing all 149 issue information except comments. Each issue will have a related comments file 150 where the communication is stored to. Additionally a status log file will 151 provide an overview when the status changed and by whom. All files are stored 152 to data/meta directory with file extension �.issue� or �.cmnts�. 153