1====== BugzillaInt Plugin ======
2
3---- plugin ----
4description: Provides customizable Buglinks, Buglists and Bugtrees from Bugzilla via RPC.
5author     : Timo Stamm
6email      : ts@timostamm.de
7type       : syntax
8lastupdate : 2015-06-03
9compatible : "Hrun", 2014-09-29d
10depends    :
11conflicts  :
12similar    :
13tags       : bugzilla
14
15downloadurl: https://github.com/timostamm/BugzillaInt/archive/master.zip
16bugtracker : https://github.com/timostamm/BugzillaInt/issues
17sourcerepo : https://github.com/timostamm/BugzillaInt
18donationurl: http://donatenow.wc.lt/?donate=ts@timostamm.de&item-name=BugzillaInt&amount=5&method=PayPal
19----
20
21===== Description =====
22
23Create complex Buglists, Bugtrees or inline-Links to Bugzilla-Bugs
24with simple intuitive syntax.
25
26Customizable visual alerts direct your attention to oncoming deadlines or high
27priority Bugs.
28
29
30===== Examples/Usage =====
31
32=== Bug 1234 ===
33{{http://pub.devserver2.de/bugzillaint/link.png|Screenshot Bug Link}}
34
35=== <Buglist> ===
36{{http://pub.devserver2.de/bugzillaint/list.png|Screenshot Bug List}}
37
38=== <Bugtree> ===
39{{http://pub.devserver2.de/bugzillaint/tree.png|Screenshot Bug Tree}}
40
41
42
43===== Installation =====
44
45You must provide your Bugzilla Endpoint and Credentials in the configuration
46in order to use this plugin. This plugin is tested with Bugzilla version 4.4.7. Available languages: english, german.
47
48Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download
49URL above, which points to latest version of the plugin. Refer to [[:Plugins]]
50on how to install plugins manually. The local plugin directory must have the
51same name as the plugin is named, otherwise the plugin won't work properly.
52
53
54
55===== Syntax =====
56
57=== Bug Links ===
58
59<code>
60  Bug 123 <status,assigned_to>
61</code>
62
63You can use this syntax for Bug links anywhere. For example, create your own
64ad-hoc TODO-lists:
65
66<code>
67   * Bug 123
68   * Bug 124 <status,assigned_to>
69   * Bug 125 <priority,status,assigned_to>
70</code>
71
72The part wrapped in ''<'' ''>'' is optional. You can define extra fields to show. See below for more information about extra fields.
73
74
75=== Bug Trees ===
76
77<code>
78  <Bugtree 123 depth:3 showResolved extras:priority,assigned_to>
79</code>
80
81The bugtree is similar to Bugzillas Dependency Tree Page. It shows a hierarchy of Bugs blocking the given Bug. By default, only unresolved Bugs are displayed, which can be extended using the optional flag ''showResolved''. The ''depth'' option limits the depth of the hierarchy. Use the option ''extras'' to show extra fields.
82
83
84=== Bug Lists ===
85
86<code>
87  <Buglist OPEN summary:Foo group_by:status extras:assigned_to,priority>
88</code>
89
90The query format for buglists uses the bugzilla quicksearch syntax. You can query for various fields (also using multiple, comma-separated values). In addition to the quicksearch query, you can group the results by a field using ''group_by''. Use the option ''extras'' to show extra fields.
91
92Quicksearch is not available in Bugzillas XML-RPC-API as of version 4.x. Therefore, only a subset of the syntax is implemented until Bugzilla v5 is released and widely deployed.
93
94
95
96=== Extra fields ===
97
98Bugs can be shown with extra fields. For example, you can show the assignee (''assigned_to'')
99next to a Bug, or the ''priority'', and many others.
100
101Extra fields are available on individual Bug Links, Bug Lists as well as Bug
102Trees. If you specify the extra fields, you overwrite the default value as
103defined in the plugin settings. Please not that the fields ''priority'', ''severity'' and ''deadline'' are automatically
104added if they cross a certain threshold, which is customizable in the plugin
105settings.
106
107The complete list of available extra fields:
108
109	* ''dependencies'' - shows the count of open bugs depending on or blocking this bug - links to bugzilla dependency tree
110	* ''assigned_to'' - shows assigne login name, links to a list of all bugs assigned to the person
111	* ''lastchange'' - actually is not functional in my bugzilla installation
112	* ''deadline'' - show deadline if present and uses a warning color from the plugin settings - shows automatically if the deadline apporaches the threshold set in plugin settings.
113	* ''status'' - shows the Bug status, using colors as set in plugin settings
114	* ''version'' - shows the version
115	* ''priority'' - show Bug priority, using colors from the plugin settings - shows automatically if above threshold set in plugin settings
116	* ''severity'' - show severity, using colors from the plugin settings - shows automatically if above threshold set in plugin settings
117	* ''time'' - actually is not functional in my bugzilla installation
118	* ''classification'' - shows the classification the Bug belongs to - links to a list of all open bugs in this classification
119	* ''product'' - shows the product the Bug belongs to - links to the bugzilla product description page
120	* ''component'' - shows the component the Bug belongs to - links to a list of all open bugs in this component
121
122
123
124===== Configuration and Settings =====
125
126In order to use this plugin, you must provide your bugzilla endpoint
127and your bugzilla credentials.
128
129All other settings are optional. You can configure:
130  * the default extras,
131  * warning thresholds for priority, severity and deadline
132  * colors for each bug status
133  * default tree depth
134
135
136=== Change Log ===
137{{rss>http://github.com/timostamm/BugzillaInt/commits/master.atom date}}
138
139
140=== Report Bugs and Issues ===
141Please use GitHub: https://github.com/timostamm/BugzillaInt/issues
142
143
144=== Known issues and roadmap ===
145  * Buglist query syntax should be completely switched to Bugzilla quicksearch syntax once Bugzilla version 5 is released and widely deployed
146  * Authentication via Bugzilla would be nice, so that Users only see Bugs they have access to.
147
148
149===== FAQ =====
150
151=== Who are you? ===
152Timo Stamm
153
154=== Do you accept donations? ===
155Yes.
156
157=== Are you a full-stack web developer who can develop a solution for our business problem? ===
158Yes.
159
160