Changes between Version 19 and Version 20 of ClientsPlugin


Ignore:
Timestamp:
Mar 4, 2015, 9:49:59 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • ClientsPlugin

    v19 v20  
    11[[PageOutline(2-5,Contents,pullout)]]
    2 = Clients support for Trac Tickets =
    32
    4 == Description ==
     3= Clients support for Trac Tickets
    54
    6 [[Image(clients.jpg, width=400, align=right)]]Many people and organizations 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.
     5== Description
    76
    8 Features Include:
    9  * Ability to add, edit and remove clients via the Trac Admin interface.
    10  * Ability to define a default "Hourly Rate" for each client (useful when used in conjunction with WorkLogPlugin and TimingAndEstimationPlugin)
    11  * Adds "Client Work Summary" report for use with TimingAndEstimationPlugin
     7[[Image(clients.jpg, width=400, align=right)]]
     8Many people and organizations 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.
     9
     10Key features:
     11 * Add, edit and remove clients via the Trac Admin interface.
     12 * Define a default "Hourly Rate" for each client, useful when used in conjunction with WorkLogPlugin and TimingAndEstimationPlugin.
     13 * Adds "Client Work Summary" report for use with TimingAndEstimationPlugin.
    1214 * Flexible Event structure to keep clients selectively informed by:
    1315   * Defining custom events which tie together ''Summaries'' and ''Actions''.
    1416   * Defining special blocks (via a [WikiProcessors 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.
    1517
    16 === Screen Shots ===
     18=== Screen Shots
     19
    1720  * [attachment:clients.jpg Clients Admin]
    1821  * [attachment:client_detail.jpg Client Detail]
    … …  
    2124  * [attachment:ticket_fields.jpg Ticket Fields]
    2225
    23 === Events ===
     26=== Events
    2427
    2528The 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.
    … …  
    2831
    2932The current ''Summaries'' available are:
    30  * '''Milestone Summary: ([wiki:ClientsPlugin/Summaries/MilestoneSummary XML info]) Creates a summary of all tickets grouped by milestone (for future milestones with a delivery date attached)
     33 * '''Milestone Summary''': ([wiki:ClientsPlugin/Summaries/MilestoneSummary XML info]) Creates a summary of all tickets grouped by milestone (for future milestones with a delivery date attached)
    3134 * '''Ticket Changes''': ([wiki:ClientsPlugin/Summaries/TicketChanges XML info]) Ticket changes/comments since the last time the event was triggered
    3235
    … …  
    3538 * '''Post to Zendesk''': Post to a [http://www.zendesk.com/ Zendesk] forum
    3639
    37 
    3840The 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).
    3941
    40 === Event Recipes ===
     42=== Event Recipes
    4143
    4244Here are some detailed examples to help you get started. Please feel free to post your own!
    … …  
    4547 * [wiki:ClientsPlugin/EventRecipes/TicketChanges Nightly Ticket Changes Summary sent by Email]
    4648
     49=== Triggering Events
    4750
    48 === Triggering Events ===
     51So how do you trigger an event? This can currently be achieved via a simple script that can be run via a crontab entry or scheduled task. This script is [source:clientsplugin/0.11/cron/run-client-event].
    4952
    50 So how do you trigger an event? Well, essentially you have to trigger then yourself! This can currently be achieved via a simple script that can be run via a crontab entry or scheduled task. This script is [source:clientsplugin/0.11/cron/run-client-event]
    51 
    52 === Custom Fields ===
     53=== Custom Fields
    5354
    5455ClientsPlugin will automatically add some custom fields to your trac.ini when it is installed.
    5556
     57== Bugs/Feature Requests
    5658
    57 == Bugs/Feature Requests ==
    58 
    59 Existing bugs and feature requests for ClientsPlugin are
    60 [query:?status=new&status=assigned&status=reopened&group=&component=ClientsPlugin&order=priority  here].
     59Existing bugs and feature requests for ClientsPlugin are [query:?status=new&status=assigned&status=reopened&group=&component=ClientsPlugin&order=priority here].
    6160
    6261If you have any issues, create a [/newticket?component=ClientsPlugin&owner=coling&cc=rjollos new ticket].
    6362
    64 == Download and Source ==
     63[[TicketQuery(component=ClientsPlugin,group=type,format=progress)]]
     64
     65== Download and Source
    6566
    6667Download the [download:clientsplugin zipped source], check out [/svn/clientsplugin using Subversion], or [source:clientsplugin browse the source] with Trac.
    6768
    68 This plugin was originally developed for 0.10 but has since been heavily developed for 0.11. The 0.10 version is considered obsolete and is no longer actively developed.
     69This plugin was originally developed for Trac 0.10 but has since been heavily developed for Trac 0.11. The Trac 0.10 version is considered obsolete and is no longer actively developed.
    6970
    70 == Requirements ==
     71== Requirements
    7172
    72 You need the following Python components to use this plugin:
    73  * LXML Library: http://codespeak.net/lxml/
    74 On Fedora do the following commands to install LXML Library:[[BR]]
     73You need the [http://lxml.de/ LXML library] to use this plugin.
    7574
    76 '''yum install libxml2 libxml2-devel libxslt libxslt-devel'''[[BR]]
     75On Fedora perform the following commands to install the LXML Library:
    7776
    78 '''easy_install lxml'''
     77{{{
     78yum install libxml2 libxml2-devel libxslt libxslt-devel
     79}}}
     80or:
    7981
    80 == Example ==
     82{{{
     83easy_install lxml
     84}}}
    8185
    82 Install the plugin then go through the usual trac update process to automatically create the necessary DB tables and fields.
     86== Example
    8387
     88Install the plugin, then go through the usual Trac update process to automatically create the necessary database tables and fields.
    8489
    85 == Recent Changes ==
     90== Recent Changes
    8691
    8792[[ChangeLog(clientsplugin, 3)]]
    8893
    89 == Author/Contributors ==
     94== Author/Contributors
    9095
    9196'''Author:''' [wiki:coling] [[BR]]