Changes between Version 2 and Version 3 of InterTrac

Timestamp:

09/01/12 10:21:30 (17 months ago)

Author:

trac

Comment:

--

InterTrac

@@ -6 +6 @@
 
 An InterTrac link can be seen as a scoped TracLinks.
-It is used for referring to a Trac resource
+It is used for referring to a Trac resource 
 (Wiki page, changeset, ticket, ...) located in another
 Trac environment.
@@ -16 +16 @@
 == Link Syntax ==
 
-Simply use the name of the other Trac environment as a prefix,
+Simply use the name of the other Trac environment as a prefix, 
 followed by a colon, ending with the resource located in the other environment.
 
@@ -25 +25 @@
 The other resource is specified using a regular TracLinks, of any flavor.
 
-That target environment name is either the real name of the
-environment, or an alias for it.
+That target environment name is either the real name of the 
+environment, or an alias for it. 
 The aliases are defined in `trac.ini` (see below).
 The prefix is case insensitive.
 
-For convenience, there's also some alternative short-hand form,
-where one can use an alias as an immediate prefix
+If the InterTrac link is enclosed in square brackets (like `[th:WikiGoodiesPlugin]`), the InterTrac prefix is removed in the displayed link, like a normal link resolver would be (i.e. the above would be displayed as `WikiGoodiesPlugin`).
+
+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:
 (e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)
@@ -53 +55 @@
 
 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
+This can be a relative URL in case that Trac environment is located 
 on the same server.
 
@@ -61 +63 @@
 Finally, the `.compat` option can be used to activate or disable
 a ''compatibility'' 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 explicitly disable this compatibility mode and then ''any''
+ * If the targeted Trac is running a version below [trac:milestone:0.10 0.10] 
+   ([trac:r3526 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 explicitly disable this compatibility mode and then ''any'' 
    TracLinks can become an InterTrac link.
 
@@ -77 +79 @@
  * to the ticket #234:
    * `trac:ticket:234` trac:ticket:234
-   * `trac:#234` trac:#234
+   * `trac:#234` trac:#234 
    * `#T234` #T234
  * to the changeset [1912]:
@@ -83 +85 @@
    * `[T1912]` [T1912]
  * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''
-   * `trac:log:@3300:3330` trac:log:@3300:3330
-   * `[trac 3300:3330]` [trac 3300:3330]
+   * `trac:log:@3300:3330` trac:log:@3300:3330  
+   * `[trac 3300:3330]` [trac 3300:3330] 
  * finally, to link to the start page of a remote trac, simply use its prefix followed by ':', inside an explicit link. Example: `[th: Trac Hacks]` (''since 0.11; note that the ''remote'' Trac has to run 0.11 for this to work'')