Changes between Version 3 and Version 4 of ClientsPlugin

Timestamp:

Oct 14, 2008, 9:07:56 PM (16 years ago)

Author:

anonymous

Comment:

--

ClientsPlugin

@@ -3 +3 @@
 == Description ==
 
-This plugin adds a custom field to to Trac which allows the tickets to be recorded against a specific client.
+Many people and organisations use Trac internally/privately to manage tasks they undertake for a range of different clients. The ClientsPlugin adds several capabilities to Trac to help manage different clients.
 
-It also provides a user interface via [t:wiki:WebAdmin WebAdmin] (0.10.x only) to administer the client lists. [AWK: The web admin interface works for 0.11 trunk also]
+Features Include:
+ * Ability to add, edit and remove clients via the Trac Admin interface.
+ * Ability to define a default "Hourly Rate" for each client (useful when used in conjunction with WorkLogPlugin and TimingAndEstimationPlugin)
+ * Adds "Client Work Summary" report for use with TimingAndEstimationPlugin
+ * Flexible Event structure to keep clients selectively informed by:
+   * Defining custom events which tie together ''Summaries'' and ''Actions''.
+   * Defining special blocks (via a WikiProcessor) in which you can embed content that you want to share with a client in ticket descriptions and comments which can be incorporated into Summaries.
 
-It is work in progress and some features are still missing.
+=== Events ===
 
-At present it requires a [t:ticket:5641 patch] to Trac itself to allow simple use of the {{{enum}}} table to drive custom fields data. [AWK: For 0.11 trunk, patch doesn't seem necessary.]
+The events system is very flexible and allows you to customise they way you interact with your clients. As it's often convenient to use a single Trac instance for internal management purposes, it is typically inappropriate to give direct access to Trac to your clients. However, using Trac to keep your clients informed is still very desirable.
 
+In order to do this, the ClientsPlugin contains several ''Summaries'' which summarise the current status, or the changes in status over time, for each client into an XML object. This object is then passed on to an ''Action'' which can process this summary accordingly and actually do something useful with it.
+
+The current ''Summaries'' available are:
+ * '''Milestone Summary''': Creates a summary of all tickets grouped by milestone (for future milestones with a delivery date attached)
+ * '''Ticket Changes''': Ticket changes/comments since the last time the event was triggered 
+
+The current ''Actions'' available are:
+ * '''Send Email''': Send an email to the client
+ * '''Post to Zendesk''': Post to a [http://www.zendesk.com/ Zendesk] forum
+
+
+The system allows some key setup parameters to be defined in the event itself (e.g. an XSLT to reformat the XML object into an HTML email, or a username/password for interacting with Zendesk), and also certain parameters for each event on a per-client basis (e.g. a list of client specific email addresses to send the summary).
+
+=== Custom Fields ===
+
+ClientsPlugin will automatically add some custom fields to your trac.ini when it is installed.
 
 
@@ -26 +48 @@
 == Example ==
 
-[AWK: The installation for 0.11 (I'm using Trac 0.11 trunk r6893) appears to be somewhat different from what's described below. A database upgrade will be needed after installing the plugin. During the database upgrade the ini entries were added automatically and they are actually somewhat different from below. Also, the patch mentioned doesn't seem necessary.]
+Install the plugin then go through the usual trac update process to automatically create the necessary DB tables and fields.
 
-On installation you need to manually add the following custom fields:
-
-{{{
-client = select
-client.label = Client
-client.order = 5
-client.options = enum:client
-client.value = 0
-}}}
-
-And don't forget the [http://trac.edgewall.org/ticket/5641 patch] mentioned above to Trac itself.
 
 == Recent Changes ==