Changes between Version 21 and Version 22 of InterTrac

Timestamp:

May 22, 2006, 11:36:43 PM (18 years ago)

Author:

Christian Boos

Comment:

following-up to bboisvert's comment, I fixed the examples

InterTrac

@@ -1 @@
-= InterTrac Extension for TracLinks =
+= InterTrac Links  =
 
 ''(since [milestone:0.10])''
@@ -5 +5 @@
 == 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.
@@ -34 +35 @@
 
 == Examples ==
+
 {{{
-#!
+#!comment
  Besides the other environments run by the same server process
  (called ''sibling'' environments), which are automatically detected,
-
 Support for sibling environments has been disabled.
 See http://thread.gmane.org/gmane.comp.version-control.subversion.trac.devel/157
 }}}
+
 It is necessary to setup a configuration for the InterTrac facility:
  * in order to refer to a remote Trac
@@ -53 +55 @@
 ...
 [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...
 }}}
 
 Now, given this configuration, one could create the following links:
  * to this 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]
+   * `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] ''(deprecated)''
-   * `#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]
-   * `[T1912]` ->
-     [http://projects.edgewall.com/trac/changeset/1912 "[T1912]"]
+   * `trac:changeset:1912` trac:changeset:1912
+   * `[T1912]` [T1912]
+ * to the log range [3300:3330]: ''(Note: these ones will work at the next server upgrade)''
+   * `trac:log:3300:3330` trac:log:3300:3330
+   * `[trac 3300:3330]` [trac 3300:3330]
 
-Anything not given as explicit links (intertrac_prefix:module:id)
-is interpreted by the remote Trac, relying on its quickjump
-facility. ''(deprecated)''
+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.
+
+----
+=== Discussion ===
 
   Note that the examples above are hard coded to appropriate destinations, '''not''' processed via InterTrac.  Specifically, the format of the links that rely on the remote quickjump are not as they will appear when generated by InterTrac.
+
+Thanks for the reminder... Ir's fixed now: the examples are using the real thing. 
+I think that the `trac` prefix could even be set as a default in the `[intertrac]` TracIni section. --CB
 
 ----
   It would be great, if these links also work in changeset comments, and source code comments. This would facilitate tickets, which touch multiple source code repositories, and patches which can be applied to multiple trees, which a dedicated trac instance each, as it should be possible by using source code control systems like bazaar-ng and mercurial.
 
-The InterTrac notation is supported everywhere WikiFormatting is supported,
-or maybe I misunderstood your query?
-Can you provide a more concrete example of what you're looking for? --CB
+''worksforme'' (next time, I'll delete the above)
 
 ----