Changes between Version 1 and Version 2 of InterTrac


Ignore:
Timestamp:
Jun 6, 2013 4:39:51 AM (15 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • InterTrac

    v1 v2  
    1 = InterTrac Extension for TracLinks = 
     1= InterTrac Links = 
    22 
    3 ''(since [milestone:0.10])'' 
     3Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10. 
    44 
    55== Definitions == 
    66 
    7 An InterTrac link is used for referring to a Trac object  
     7An InterTrac link can be seen as a scoped TracLinks. 
     8It is used for referring to a Trac resource  
    89(Wiki page, changeset, ticket, ...) located in another 
    910Trac environment. 
     
    1516== Link Syntax == 
    1617 
     18Simply use the name of the other Trac environment as a prefix,  
     19followed by a colon, ending with the resource located in the other environment. 
     20 
    1721{{{ 
    1822<target_environment>:<TracLinks> 
    1923}}} 
    2024 
    21 The link is composed by the target environment name,  
    22 followed by a colon (e.g. `trac:`), 
    23 followed by a regular TracLinks, of any flavor. 
     25The other resource is specified using a regular TracLinks, of any flavor. 
    2426 
    2527That target environment name is either the real name of the  
     
    2830The prefix is case insensitive. 
    2931 
    30 For convenience, there's also an alternative short-hand form,  
     32If the InterTrac link is enclosed in square brackets (like `[th:WikiExtrasPlugin]`), the InterTrac prefix is removed in the displayed link, like a normal link resolver would be (i.e. the above would be displayed as `WikiExtrasPlugin`). 
     33 
     34For convenience, there's also some alternative short-hand form,  
    3135where one can use an alias as an immediate prefix  
    3236for the identifier of a ticket, changeset or report: 
    3337(e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...) 
    3438 
    35 == Configuration == 
     39== Examples == 
    3640 
    37 It is necessary to setup a specific `[intertrac]` section in the TracIni for the InterTrac facility, in order to associate a prefix to other Trac sites, and for defining environment aliases. 
     41It is necessary to setup a configuration for the InterTrac facility. 
     42This configuration has to be done in the TracIni file, `[intertrac]` section. 
    3843 
    3944Example configuration: 
     
    4146... 
    4247[intertrac] 
    43 ## -- Example of setting up an alias: 
     48# -- Example of setting up an alias: 
    4449t = trac 
    4550 
    46 ## -- Link to an external Trac: 
     51# -- Link to an external Trac: 
    4752trac.title = Edgewall's Trac for Trac 
    48 trac.url = http://projects.edgewall.com/trac 
    49  
    50 #trac.svn = http://repos.edgewall.com/projects/trac  
    51 # Hint: .svn information could be used in the future to support svn:externals... 
     53trac.url = http://trac.edgewall.org 
    5254}}} 
    5355 
    54 Now, given this configuration, one could create the following links: 
    55  * to the current InterTrac page: 
    56    * `trac:wiki:InterTrac` -> 
    57      [http://projects.edgewall.com/trac/wiki/InterTrac trac:wiki:InterTrac] 
    58    * `t:wiki:InterTrac` -> 
    59      [http://projects.edgewall.com/trac/wiki/InterTrac t:wiki:InterTrac] 
    60    * Keys are case insensitive: `T:wiki:InterTrac` ->  
    61      [http://projects.edgewall.com/trac/wiki/InterTrac T:wiki:InterTrac] 
     56The `.url` is mandatory and is used for locating the other Trac. 
     57This can be a relative URL in case that Trac environment is located  
     58on the same server. 
     59 
     60The `.title` information will be used for providing an useful tooltip 
     61when moving the cursor over an InterTrac links. 
     62 
     63Finally, the `.compat` option can be used to activate or disable 
     64a ''compatibility'' mode: 
     65 * If the targeted Trac is running a version below [trac:milestone:0.10 0.10]  
     66   ([trac:r3526 r3526] to be precise), then it doesn't know how to dispatch an InterTrac  
     67   link, and it's up to the local Trac to prepare the correct link.  
     68   Not all links will work that way, but the most common do.  
     69   This is called the compatibility mode, and is `true` by default.  
     70 * If you know that the remote Trac knows how to dispatch InterTrac links,  
     71   you can explicitly disable this compatibility mode and then ''any''  
     72   TracLinks can become an InterTrac link. 
     73 
     74Now, given the above configuration, one could create the following links: 
     75 * to this InterTrac page: 
     76   * `trac:wiki:InterTrac` trac:wiki:InterTrac 
     77   * `t:wiki:InterTrac` t:wiki:InterTrac 
     78   * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac 
    6279 * to the ticket #234: 
    63    * `trac:ticket:234` -> 
    64      [http://projects.edgewall.com/trac/ticket/234 trac:ticket:234] 
    65    * `trac:#234` -> 
    66      [http://projects.edgewall.com/trac/ticket/234 trac:#234] 
    67    * `#T234` -> 
    68      [http://projects.edgewall.com/trac/search?q=#234 #T234] 
     80   * `trac:ticket:234` trac:ticket:234 
     81   * `trac:#234` trac:#234  
     82   * `#T234` #T234 
    6983 * to the changeset [1912]: 
    70    * `trac:changeset:1912` -> 
    71      [http://projects.edgewall.com/trac/changeset/1912 trac:changeset:1912] 
    72    * `trac:[1912]` -> 
    73      [http:"//projects.edgewall.com/trac/search?q=[1912]" "trac:[1912]"] 
    74    * `[T1912]` -> 
    75      [http://projects.edgewall.com/trac/changeset/1912 "[T1912]"] 
     84   * `trac:changeset:1912` trac:changeset:1912 
     85   * `[T1912]` [T1912] 
     86 * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)''' 
     87   * `trac:log:@3300:3330` trac:log:@3300:3330   
     88   * `[trac 3300:3330]` [trac 3300:3330]  
     89 * 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'') 
    7690 
    77 Anything not given as explicit links (intertrac_prefix:module:id) 
    78 is interpreted by the remote Trac, relying on its quickjump 
    79 facility. 
     91The generic form `intertrac_prefix:module:id` is translated 
     92to the corresponding URL `<remote>/module/id`, shorthand links 
     93are specific to some modules (e.g. !#T234 is processed by the 
     94ticket module) and for the rest (`intertrac_prefix:something`), 
     95we rely on the TracSearch#quickjump facility of the remote Trac. 
    8096 
    8197----