Changes between Version 22 and Version 23 of ClientsPlugin


Ignore:
Timestamp:
Nov 18, 2015, 8:50:56 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • ClientsPlugin

    v22 v23  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Clients support for Trac Tickets
     3= Clients support for Trac tickets
    44
    55== Description
     
    2727=== Events
    2828
    29 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.
     29The events system is very flexible and allows you to customise they way you interact with your clients. As it is 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.
    3030
    3131To 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.
    3232
    3333The current ''Summaries'' available are:
    34  * '''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)
    35  * '''Ticket Changes''': ([wiki:ClientsPlugin/Summaries/TicketChanges XML info]) Ticket changes/comments since the last time the event was triggered 
     34 * '''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).
     35 * '''Ticket Changes''': ([wiki:ClientsPlugin/Summaries/TicketChanges XML info]) Ticket changes/comments since the last time the event was triggered.
    3636
    3737The current ''Actions'' available are:
    38  * '''Send Email''': ([wiki:ClientsPlugin/Actions/SendEmail XSLT info]) Send an email to the client
    39  * '''Post to Zendesk''': Post to a [http://www.zendesk.com/ Zendesk] forum
     38 * '''Send Email''': ([wiki:ClientsPlugin/Actions/SendEmail XSLT info]) Send an email to the client.
     39 * '''Post to Zendesk''': Post to a [http://www.zendesk.com/ Zendesk] forum.
    4040
    41 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).
     41The system allows some key setup parameters to be defined in the event itself (eg 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 (eg a list of client specific email addresses to send the summary).
    4242
    4343=== Event Recipes
     
    5858== Bugs/Feature Requests
    5959
    60 Existing bugs and feature requests for ClientsPlugin are [query:?status=new&status=assigned&status=reopened&group=&component=ClientsPlugin&order=priority here].
     60Existing bugs and feature requests for ClientsPlugin are [report:9?COMPONENT=ClientsPlugin here].
    6161
    6262If you have any issues, create a [/newticket?component=ClientsPlugin&owner=coling&cc=rjollos new ticket].
     
    6666== Download
    6767
    68 Download the [download:clientsplugin zipped source]
     68Download the zipped source from [export:clientsplugin here].
    6969
    7070== Source
    7171
    72 Check out [/svn/clientsplugin using Subversion], or [source:clientsplugin browse the source] with Trac.
     72Check out ClientsPlugin using Subversion from [/svn/clientsplugin here], or [source:clientsplugin browse the source] with Trac.
    7373
    7474This plugin is active for Trac 0.11 and was originally developed for Trac 0.10. The Trac 0.10 version is considered obsolete.