Changes between Version 3 and Version 4 of InterTrac


Ignore:
Timestamp:
Jan 30, 2018 2:16:51 PM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterTrac

    v3 v4  
    1 = InterTrac Links  = 
     1= InterTrac Links 
    22 
    3 Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10. 
     3Trac supports a convenient way to refer to resources of other Trac servers using Wiki markup. An !InterTrac link can be seen as a scoped [TracLinks TracLink]. It is used for referring to a Trac resource located in another Trac environment. 
    44 
    5 == Definitions == 
     5== Link Syntax 
    66 
    7 An InterTrac link can be seen as a scoped TracLinks. 
    8 It is used for referring to a Trac resource  
    9 (Wiki page, changeset, ticket, ...) located in another 
    10 Trac environment. 
    11  
    12 == List of Active InterTrac Prefixes == 
    13  
    14 [[InterTrac]] 
    15  
    16 == Link Syntax == 
    17  
    18 Simply use the name of the other Trac environment as a prefix,  
    19 followed by a colon, ending with the resource located in the other environment. 
     7Simply use the name of the other Trac environment as a prefix, followed by a colon, ending with the resource located in the other environment: 
    208 
    219{{{ 
    … …  
    2311}}} 
    2412 
    25 The other resource is specified using a regular TracLinks, of any flavor. 
     13The other resource is specified using a regular !TracLink, of any flavor. 
    2614 
    27 That target environment name is either the real name of the  
    28 environment, or an alias for it.  
    29 The aliases are defined in `trac.ini` (see below). 
     15That target environment name is either the real name of the environment or an alias.  
     16The aliases are defined in the `trac.ini` file, see below. 
    3017The prefix is case insensitive. 
    3118 
    32 If 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`). 
     19If 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. For example, the above would be displayed as `WikiExtrasPlugin`. 
    3320 
    34 For convenience, there's also some alternative short-hand form,  
    35 where one can use an alias as an immediate prefix  
    36 for the identifier of a ticket, changeset or report: 
    37 (e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...) 
     21For convenience, there is also an alternate short-hand form, where an alias can be used as an immediate prefix for the identifier of a ticket, changeset or report, eg `#T234`, `[T1508]`, `[trac 1508]`. 
    3822 
    39 == Examples == 
     23== Examples 
    4024 
    41 It is necessary to setup a configuration for the InterTrac facility. 
    42 This configuration has to be done in the TracIni file, `[intertrac]` section. 
     25The only prefix defined by default is `trac`, which points to trac.edgewall.org. Additional prefixes can be specified in the [TracIni#intertrac-section intertrac] section of TracIni. For example: 
    4326 
    44 Example configuration: 
    45 {{{ 
    46 ... 
     27{{{#!ini 
    4728[intertrac] 
    4829# -- Example of setting up an alias: 
    … …  
    5031 
    5132# -- Link to an external Trac: 
    52 trac.title = Edgewall's Trac for Trac 
    53 trac.url = http://trac.edgewall.org 
     33genshi.title = Edgewall's Trac for Genshi 
     34genshi.url = http://genshi.edgewall.org 
    5435}}} 
    5536 
    5637The `.url` is mandatory and is used for locating the other Trac. 
    57 This can be a relative URL in case that Trac environment is located  
    58 on the same server. 
     38It can be a relative URL when the Trac environment is located on the same server. 
    5939 
    60 The `.title` information will be used for providing an useful tooltip 
    61 when moving the cursor over an InterTrac links. 
    62  
    63 Finally, the `.compat` option can be used to activate or disable 
    64 a ''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. 
     40The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link. 
    7341 
    7442Now, given the above configuration, one could create the following links: 
    … …  
    7644   * `trac:wiki:InterTrac` trac:wiki:InterTrac 
    7745   * `t:wiki:InterTrac` t:wiki:InterTrac 
     46   * `genshi:InterTrac` genshi:InterTrac 
    7847   * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac 
    7948 * to the ticket #234: 
    8049   * `trac:ticket:234` trac:ticket:234 
    8150   * `trac:#234` trac:#234  
     51   * `genshi:#234` genshi:#234 
    8252   * `#T234` #T234 
    8353 * to the changeset [1912]: 
    8454   * `trac:changeset:1912` trac:changeset:1912 
    8555   * `[T1912]` [T1912] 
    86  * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)''' 
     56 * to the log range [3300:3330]: 
    8757   * `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'') 
     58   * `[trac 3300:3330]` [trac 3300:3330] 
     59   * 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]` (note that the ''remote'' Trac has to run Trac >= 0.11 for this to work'') 
    9060 
    91 The generic form `intertrac_prefix:module:id` is translated 
    92 to the corresponding URL `<remote>/module/id`, shorthand links 
    93 are specific to some modules (e.g. !#T234 is processed by the 
    94 ticket module) and for the rest (`intertrac_prefix:something`), 
    95 we rely on the TracSearch#quickjump facility of the remote Trac. 
     61The 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). For the rest (`intertrac_prefix:something`), we rely on the [TracSearch#quickjump quick jump] facility of the remote Trac. 
     62 
     63== List of Active InterTrac Prefixes 
     64 
     65The following InterTrac prefixes are available on this site: 
     66 
     67[[InterTrac]] 
    9668 
    9769----