Changes between Version 13 and Version 14 of InterTrac

Timestamp:

Sep 28, 2005, 12:00:21 PM (19 years ago)

Author:

Christian Boos

Comment:

Updated InterTrac documentation to match the current development status

InterTrac

@@ -1 +1 @@
 = InterTrac Extension for TracLinks =
 
-''This is a proposal for implementing #234''
-''I think it's now ready for testing (see r1912)''
+''This is a proposal for implementing #234''.
+''It's candidate for integration in the trunk, after the 0.9 release (see #2041)''
 
 == Definitions ==
@@ -17 +17 @@
 
 The link is composed by the target environment name, 
-followed by a colon (e.g. {{{trac:}}}),
+followed by a colon (e.g. `trac:`),
 followed by a regular TracLinks, of any flavor.
 
 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 aliases are defined in `trac.ini` (see below).
 The prefix is case insensitive.
 
@@ -28 +28 @@
 where one can use an alias as an immediate prefix 
 for the identifier of a ticket, changeset or report:
-(e.g. {{{#T234}}}, {{{[T1508]}}}...)
-That alias must be at most 3 letters long.
+(e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)
 
 == Examples ==
@@ -35 +34 @@
 Besides the other environments run by the same server process
 (called ''sibling'' environments), which are automatically detected,
-(''Note: currently only in {{{tracd}}}''),
+(''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.
+This is done quite simply in an `[intertrac]` section
+within the `trac.ini` file.
 
 Example configuration:
@@ -48 +47 @@
 [intertrac]
 ## -- Example of setting up an alias:
-t.key = trac
+t = trac
 
 ## -- Link to an external Trac:
@@ -60 +59 @@
 Now, given this configuration, one could create the following links:
  * to the current InterTrac page:
-   * {{{trac:wiki:InterTrac}}} ->
+   * `trac:wiki:InterTrac` ->
      [http://projects.edgewall.com/trac/wiki/InterTrac trac:wiki:InterTrac]
-   * {{{t:wiki:InterTrac}}} ->
+   * `t:wiki:InterTrac` ->
      [http://projects.edgewall.com/trac/wiki/InterTrac t:wiki:InterTrac]
-   * Keys are case insensitive: {{{T:wiki:InterTrac}}} -> 
+   * Keys are case insensitive: `T:wiki:InterTrac` -> 
      [http://projects.edgewall.com/trac/wiki/InterTrac T:wiki:InterTrac]
  * to the ticket #234:
-   * {{{trac:ticket:234}}} ->
+   * `trac:ticket:234` ->
      [http://projects.edgewall.com/trac/ticket/234 trac:ticket:234]
-   * {{{trac:#234}}} ->
+   * `trac:#234` ->
      [http://projects.edgewall.com/trac/ticket/234 trac:#234]
-   * {{{#T234}}} ->
-     [http://projects.edgewall.com/trac/ticket/234 #T234]
+   * `#T234` ->
+     [http://projects.edgewall.com/trac/search?q=#234 #T234]
  * to the changeset [1912]:
-   * {{{trac:changeset:1912}}} ->
+   * `trac:changeset:1912` ->
      [http://projects.edgewall.com/trac/changeset/1912 trac:changeset:1912]
-   * {{{trac:[1912]}}} 
-     [http://projects.edgewall.com/trac/changeset/1912 trac:[1912]]
-   * {{{[T1912]}}} ->
-     [http://projects.edgewall.com/trac/changeset/1912 [T1912]]
-{{{
-#!comment
-To wjl@icecavern.net:
-The link values you modified were actually matching the current implementation:
- * {{{trac:[1912]}}} 
-   [http://projects.edgewall.com/trac/search?q=1912 trac:[1912]]
- * {{{trac:#234}}} ->
-   [http://projects.edgewall.com/trac/search?q=234 trac:#234]
+   * `trac:[1912]` ->
+     [http:"//projects.edgewall.com/trac/search?q=[1912]" "trac:[1912]"]
+   * `[T1912]` ->
+     [http://projects.edgewall.com/trac/changeset/1912 "[T1912]"]
 
-In short: one can't assume the local Trac knows about all of 
-the shortcut syntax used by the remote Trac.
 Anything not given as explicit links (intertrac_prefix:module:id)
-has to be interpreted by the remote Trac, relying on its quickjump
+is interpreted by the remote Trac, relying on its quickjump
 facility.
-}}}
 
 
@@ -103 +91 @@
 == Implementation Notes ==
 
-Currently, the {{{[intertrac]}}} configuration has to be repeated 
+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.
@@ -111 +99 @@
 source:branches/cboos-dev/intertrac-branch
 
-In particular, [1912] should implement the behavior described 
-in version 9 of this page.
-
-
-The general idea is that any {{{[a-zA-Z][a-zA-Z0-9]*:}}} prefix, 
+The general idea is that any `[a-zA-Z.+-]+:` prefix, 
 followed by anything which is not a space, has to be interpreted as:
- 1. maybe an alias to something else; it yes, it is dereferenced
+ 1. maybe an alias to something else; if yes, it is dereferenced
     before going on
- 1. either a link prefix given by an IWikiSyntaxProvider component 
- 1. if not found, an environment name (!InterTrac link)
- 1. if not found, an external system name (!InterWiki link)
- 1. if not found, it is left unchanged
-
-This order enables one to configure Trac for using another
-ticket system: first disable the {{{[ticket]}}} component 
-and setup a {{{ticket}}} !InterWiki link pointing to the other 
-BugTrackingSystem.
+ 1. then, it's maybe a link prefix given by an `IWikiSyntaxProvider` component 
+ 1. if not, it's maybe an environment name (!InterTrac link)
+ 1. if not, it's maybe an !InterWiki link
+ 1. if not, it is not a link