Changes between Version 1 and Version 2 of InterTrac


Ignore:
Timestamp:
Mar 2, 2017 6:39:50 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterTrac

    v1 v2  
    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, from within the Wiki markup. An !InterTrac link can be seen as a scoped TracLinks. It is used for referring to a Trac resource located in another Trac environment. A resource can be a wiki page, changeset, ticket or milestone.
    44
    5 == Definitions ==
    6 
    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 ==
     5== List of Active InterTrac Prefixes
    136
    147[[InterTrac]]
    158
    16 == Link Syntax ==
     9== Link Syntax
    1710
    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.
     11Simply use the name of the other Trac environment as a prefix, followed by a colon, ending with the resource located in the other environment:
    2012
    2113{{{
    … …  
    2517The other resource is specified using a regular TracLinks, of any flavor.
    2618
    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).
     19That target environment name is either the real name of the environment or an alias for it.
     20The aliases are defined in the `trac.ini` file, see below.
    3021The prefix is case insensitive.
    3122
    32 For convenience, there's also some alternative short-hand form,
    33 where one can use an alias as an immediate prefix
    34 for the identifier of a ticket, changeset or report:
    35 (e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)
     23If 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, ie the above would be displayed as `WikiExtrasPlugin`.
    3624
    37 == Examples ==
     25For convenience, there is also an alternative 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]`.
    3826
    39 It is necessary to setup a configuration for the InterTrac facility.
    40 This configuration has to be done in the TracIni file, `[intertrac]` section.
     27== Examples
    4128
    42 Example configuration:
    43 {{{
    44 ...
     29It is necessary to set up a configuration for the InterTrac facility.
     30This configuration has to be done in the TracIni file, `[intertrac]` section, for example:
     31
     32{{{#!ini
    4533[intertrac]
    4634# -- Example of setting up an alias:
    … …  
    5341
    5442The `.url` is mandatory and is used for locating the other Trac.
    55 This can be a relative URL in case that Trac environment is located
    56 on the same server.
     43This can be a relative URL in case that Trac environment is located on the same server.
    5744
    58 The `.title` information will be used for providing an useful tooltip
    59 when moving the cursor over an InterTrac links.
     45The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link.
    6046
    61 Finally, the `.compat` option can be used to activate or disable
    62 a ''compatibility'' mode:
    63  * If the targeted Trac is running a version below [trac:milestone:0.10 0.10]
    64    ([trac:r3526 r3526] to be precise), then it doesn't know how to dispatch an InterTrac
    65    link, and it's up to the local Trac to prepare the correct link.
    66    Not all links will work that way, but the most common do.
    67    This is called the compatibility mode, and is `true` by default.
    68  * If you know that the remote Trac knows how to dispatch InterTrac links,
    69    you can explicitly disable this compatibility mode and then ''any''
    70    TracLinks can become an InterTrac link.
     47Finally, the `.compat` option can be used to enable or disable a ''compatibility'' mode:
     48 * 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 is up to the local Trac to prepare the correct link. Not all links will work that way, but the most common ones do. This is called the compatibility mode, and is `false` by default.
     49 * 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.
    7150
    7251Now, given the above configuration, one could create the following links:
    … …  
    8261   * `trac:changeset:1912` trac:changeset:1912
    8362   * `[T1912]` [T1912]
    84  * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''
     63 * to the log range [3300:3330]: '''Note''': the following ones need `trac.compat=false`:
    8564   * `trac:log:@3300:3330` trac:log:@3300:3330 
    8665   * `[trac 3300:3330]` [trac 3300:3330]
    87  * 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'')
     66 * finally, to link to the start page of a remote Trac, simply use its prefix followed by a colon `:` and inside an explicit link. Example: `[th: Trac Hacks]`. Since Trac 0.11, note that the ''remote'' Trac has to run at least version 0.11 for this to work.
    8867
    89 The generic form `intertrac_prefix:module:id` is translated
    90 to the corresponding URL `<remote>/module/id`, shorthand links
    91 are specific to some modules (e.g. !#T234 is processed by the
    92 ticket module) and for the rest (`intertrac_prefix:something`),
    93 we rely on the TracSearch#quickjump facility of the remote Trac.
     68The 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.
    9469
    9570----