Changes between Version 1 and Version 2 of InterTrac

Timestamp:

Apr 13, 2005, 6:04:40 PM (19 years ago)

Author:

Christian Boos

Comment:

updated to match the current implementation

InterTrac

@@ -1 +1 @@
 = InterTrac Extension for TracLinks =
 
-''Warning: this is only a feature proposal''
+''Warning: this is a proposal for implementing #234''
 
-An InterTrac link is useful for referring from within a Trac environment
-to a Trac object (Wiki page, changeset, ticket, ...) located in another
-Trac environment, with a syntax as simple as possible.
+== Definition ==
 
-It is base on the usage of 1-letter prefix associated to 
-a Trac environment.
+An InterTrac link is used for referring to a Trac object 
+(Wiki page, changeset, ticket, ...) located in another
+Trac environment.
 
-Assuming the {{{T}}} letter has been set up to refer to the
-Edgewall's Trac environment, one could refer to this page
-as {{{wiki:T:InterTrac}}}.
+The link is composed by the target environment name, followed by a column
+(e.g. {{{trac:}}}) follwoed by a regular TracLinks, of any flavor.
 
-TracLinks shortcuts are also adapted: #T234 refers to #234
-on this Trac site. [T1490] refers to the changeset 1490 on
-this Trac site, etc.
+There's also an alternative short-hand form, 
+where one can use a 1, 2 or 3 letters key as an immediate 
+prefix for the identifier of a ticket, changeset or report.
+That key is associated to an environment name in Trac's configuration file.
 
-The association between letters and Trac environments
-is done quite simply in an {{{[intertrac]}}} section
+== Example ==
+
+Besides other local environments, which are automatically
+detected, it is necessary to setup a configuration for the 
+InterTrac facility:
+ * in order to refer to a remote Trac
+ * for defining project keys
+
+This is done quite simply in an {{{[intertrac]}}} section
 within the {{{trac.ini}}} file.
-Currently this has to be repeated for each Trac environment,
-but there's work in progress concerning a 
-[ticket:1051 centralized trac.ini], which
-would help greatly here.
 
+Example configuration:
+{{{
+...
+[intertrac]
+trac.title = Edgewall's Trac for Trac
+trac.url = http://projects.edgewall.com/trac
+trac.svn = http://repos.edgewall.com/projects/trac
+t.key = trac
+}}}
+
+Now, given this configuration, one could create the following links:
+ * to the current InterTrac page:
+   * {{{trac:wiki:InterTrac}}}     trac:wiki:InterTrac
+   * {{{t:wiki:InterTrac}}}        t:wiki:InterTrac
+   * Keys are case insensitive: {{{T:wiki:InterTrac}}} → T:wiki:InterTrac
+ * to the ticket #234:
+   * {{{trac:ticket:234}}} trac:ticket:234
+   * {{{trac:#234}}} trac:#234
+   * {{{#T234}}} #T234
+ * to the changeset [1508]:
+   * {{{trac:changeset:1508}}} trac:changeset:1508
+   * {{{trac:[1508]}}} trac:[1508]
+   * {{{[T1508]}}} [T1508]
+
+== Notes ==
+
+Currently, the {{{[intertrac]}}} configuration has to be repeated 
+for each Trac environment, but there's work in progress concerning a 
+[ticket:1051 centralized trac.ini], which would help greatly here.
 
 This idea was first proposed as a patch for #234, and 
-should be shortly proposed for inclusion in the 
-following branch: 
+has been implemented in the following branch: 
 source:branches/cboos-dev/intertrac-branch
-(i.e. source:T:branches/cboos-dev/intertrac-branch)
 
+In particular, [1508] should implement all the behavior described here.