Changes between Version 2 and Version 3 of RemoteTicketPlugin

Timestamp:

Nov 18, 2010, 4:45:19 PM (13 years ago)

Author:

Alex Willmer

Comment:

Add configuration instructions

RemoteTicketPlugin

@@ -5 +5 @@
 == Description ==
 
-Link tickets in one Trac instance to tickets in other Trac instances. The plugin requires the ticket-links branch of Trac. Currently this means you must be running Trac from [https://bitbucket.org/moreati/trac-ticketlinks/].
+Link tickets in one Trac instance to tickets in other Trac instances. Links and their behaviour are configurable - e.g. parents/children, blockers/blockedby.
+
+The builds on and requires the ticket-links branch of Trac. Currently this means you must be running Trac from [https://bitbucket.org/moreati/trac-ticketlinks/]. XmlRpcPlugin is also required to perform remote fetching of ticket details.
 
 == Bugs/Feature Requests == 
@@ -25 +27 @@
 == Example ==
 
-To follow
+To configure ticket-links for a relationship in which
+ - Any ticket may depend on and be dependant on many tickets
+ - A ticket may not be closed until all tickets it depends on are closed
+
+{{{
+[ticket-links]
+dependency = dependson,dependant
+dependency.validator = no_cycle
+dependant.label = Dependant
+dependson.label = Depends on
+dependson.blocks = true
+}}}
+
+To confgiure a relationship in which 
+ - A ticket may have many child tickets, and at most one parent ticket
+ - A new child ticket will have it's summary and description pre-populated from it's parent
+ - A parent ticket may not be closed until all child tickets are closed
+
+{{{
+[ticket-links]
+parentchild = parent,children
+parentchild.validator = parent_child
+children.blocks = true
+children.label = Child
+children.copy_fields = summary, description
+parent.label = Parent
+}}}
+
+To configure a relationship in which
+ - A ticket may refer to another ticket, and there is not reciprocal link
+ - A ticket may be closed regardless of the link
+
+{{{
+[ticket-links]
+reference = refersto
+refersto.label = Refers to
+}}}
+
+Many different relationships may be configured at once, relationship names must each be unique.
+
+
+To enable the remote tickets plugin, add to your trac.ini
+{{{
+[components]
+tracremoteticket.* = enabled
+}}}
+
+To configure remote trac instances create a trac:InterTrac reference and add {{{remote_ticket = true}}}
+{{{
+[intertrac]
+example.remote_ticket = true
+example.title = Bravo
+example.url = http://trac.example.org/
+}}}
+
+Install XmlRpcPlugin and grant {{{XML_RPC}}} to {{{anonymous}}}.
+
+Configure the an trac:InterTrac reference, the same ticket-links relationships and the same XmlRpcPlugin grant in the remote Trac instance.
 
 == Recent Changes ==