Changes between Version 26 and Version 27 of InterTrac

Timestamp:

Jul 19, 2006, 1:09:33 PM (18 years ago)

Author:

Christian Boos

Comment:

Document the <trac_prefix>.compat configuration option.

InterTrac

@@ -30 +30 @@
 The prefix is case insensitive.
 
-For convenience, there's also an alternative short-hand form, 
+For convenience, there's also some alternative short-hand form, 
 where one can use an alias as an immediate prefix 
 for the identifier of a ticket, changeset or report:
@@ -45 +45 @@
 }}}
 
-It is necessary to setup a configuration for the InterTrac facility:
- * in order to refer to a remote Trac
- * for defining environment aliases
-
-This is done quite simply in an `[intertrac]` section
-within the `trac.ini` file.
+It is necessary to setup a configuration for the InterTrac facility.
+This configuration has to be done in the TracIni file, `[intertrac]` section.
 
 Example configuration:
@@ -62 +58 @@
 trac.title = Edgewall's Trac for Trac
 trac.url = http://projects.edgewall.com/trac
+trac.compat = false
 }}}
 
-Now, given this configuration, one could create the following links:
+The `.url` is mandatory and is used for locating the other Trac.
+This can be a relative URL in case that Trac environment is located 
+on the same server.
+
+The `.title` information will be used for providing an useful tooltip
+when moving the cursor over an InterTrac links.
+
+Finally, the `.compat` option can be used to activate or disable
+a ''compatbility'' mode:
+ * If the targeted Trac is running a version below milestone:0.10 
+   (r3526 to be precise), then it doesn't know how to dispatch an InterTrac 
+   link, and it's up to the local Trac to prepare the correct link. 
+   Not all links will work that way, but the most common do. 
+   This is called the compatibility mode, and is `true` by default. 
+ * If you know that the remote Trac knows how to dispatch InterTrac links, 
+   you can explicitely disable this compatibility mode and then ''any'' 
+   TracLinks can become an InterTrac link.
+
+Now, given the above configuration, one could create the following links:
  * to this InterTrac page:
    * `trac:wiki:InterTrac` trac:wiki:InterTrac
@@ -76 +91 @@
    * `trac:changeset:1912` trac:changeset:1912
    * `[T1912]` [T1912]
- * to the log range [3300:3330]: ''whoops, still doesn't work, why?''
-   * `trac:log:3300:3330` trac:log:3300:3330
+ * to the log range [3300:3330]: ''Note: will work at next server upgrade''
+   * `trac:log:@3300:3330` trac:log:@3300:3330
    * `[trac 3300:3330]` [trac 3300:3330]