Changes between Version 1 and Version 2 of InterTrac

Timestamp:

Jun 12, 2009, 10:30:22 AM (16 years ago)

Author:

trac

Comment:

--

InterTrac

@@ -1 @@
-= InterTrac Extension for TracLinks =
+= InterTrac Links  =
 
-''(since [milestone:0.10])''
+Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10.
 
 == Definitions ==
 
-An InterTrac link is used for referring to a Trac object 
+An InterTrac link can be seen as a scoped TracLinks.
+It is used for referring to a Trac resource 
 (Wiki page, changeset, ticket, ...) located in another
 Trac environment.
 
+== List of Active InterTrac Prefixes ==
+
+[[InterTrac]]
+
 == Link Syntax ==
+
+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.
 
 {{{
@@ -15 +23 @@
 }}}
 
-The link is composed by the target environment name, 
-followed by a colon (e.g. `trac:`),
-followed by a regular TracLinks, of any flavor.
+The other resource is specified using a regular TracLinks, of any flavor.
 
 That target environment name is either the real name of the 
@@ -24 +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:
@@ -31 +37 @@
 == Examples ==
 
-Besides the other environments run by the same server process
-(called ''sibling'' environments), which are automatically detected,
-(''Note: currently only in `tracd`''),
-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:
@@ -45 +44 @@
 ...
 [intertrac]
-## -- Example of setting up an alias:
+# -- Example of setting up an alias:
 t = trac
 
-## -- Link to an external Trac:
+# -- Link to an external Trac:
 trac.title = Edgewall's Trac for Trac
-trac.url = http://projects.edgewall.com/trac
-
-#trac.svn = http://repos.edgewall.com/projects/trac 
-# Hint: .svn information could be used in the future to support svn:externals...
+trac.url = http://trac.edgewall.org
 }}}
 
-Now, given this configuration, one could create the following links:
- * to the current InterTrac page:
-   * `trac:wiki:InterTrac` ->
-     [http://projects.edgewall.com/trac/wiki/InterTrac trac:wiki:InterTrac]
-   * `t:wiki:InterTrac` ->
-     [http://projects.edgewall.com/trac/wiki/InterTrac t:wiki:InterTrac]
-   * Keys are case insensitive: `T:wiki:InterTrac` -> 
-     [http://projects.edgewall.com/trac/wiki/InterTrac T:wiki:InterTrac]
+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 ''compatibility'' mode:
+ * 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.
+
+Now, given the above configuration, one could create the following links:
+ * to this 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` ->
-     [http://projects.edgewall.com/trac/ticket/234 trac:ticket:234]
-   * `trac:#234` ->
-     [http://projects.edgewall.com/trac/ticket/234 trac:#234]
-   * `#T234` ->
-     [http://projects.edgewall.com/trac/search?q=#234 #T234]
+   * `trac:ticket:234` trac:ticket:234
+   * `trac:#234` trac:#234 
+   * `#T234` #T234
  * to the changeset [1912]:
-   * `trac:changeset:1912` ->
-     [http://projects.edgewall.com/trac/changeset/1912 trac:changeset:1912]
-   * `trac:[1912]` ->
-     [http:"//projects.edgewall.com/trac/search?q=[1912]" "trac:[1912]"]
-   * `[T1912]` ->
-     [http://projects.edgewall.com/trac/changeset/1912 "[T1912]"]
+   * `trac:changeset:1912` trac:changeset:1912
+   * `[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] 
+ * 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'')
 
-Anything not given as explicit links (intertrac_prefix:module:id)
-is interpreted by the remote Trac, relying on its quickjump
-facility.
+The generic form `intertrac_prefix:module:id` is translated
+to the corresponding URL `<remote>/module/id`, shorthand links
+are specific to some modules (e.g. !#T234 is processed by the
+ticket module) and for the rest (`intertrac_prefix:something`),
+we rely on the TracSearch#quickjump facility of the remote Trac.
 
 ----