Changes between Version 6 and Version 7 of InterTrac


Ignore:
Timestamp:
Feb 21, 2016, 9:52:37 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterTrac

    v6 v7  
    99== Link Syntax
    1010
    11 Simply use the name of the other Trac environment as a prefix, 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:
    1212
    1313{{{
    … …  
    1818
    1919That target environment name is either the real name of the environment or an alias for it.
    20 The aliases are defined in `trac.ini` (see below).
     20The aliases are defined in the `trac.ini` file, see below.
    2121The prefix is case insensitive.
    2222
    23 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, ie the above would be displayed as `WikiExtrasPlugin`.
     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`.
    2424
    25 For convenience, there's also some alternative short-hand form, where one can use an alias as an immediate prefix for the identifier of a ticket, changeset or report, eg `#T234`, `[T1508]`, `[trac 1508]`.
     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]`.
    2626
    2727== Examples
    2828
    29 It is necessary to setup a configuration for the InterTrac facility.
    30 This configuration has to be done in the TracIni file, `[intertrac]` section.
     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:
    3131
    32 Example configuration:
    3332{{{#!ini
    3433[intertrac]
    … …  
    4443This can be a relative URL in case that Trac environment is located on the same server.
    4544
    46 The `.title` information will be used for providing an useful tooltip 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.
    4746
    48 Finally, the `.compat` option can be used to activate or disable
    49 a ''compatibility'' mode:
    50  * If the targeted Trac is running a version below [trac:milestone:0.10 0.10]
    51    ([trac:r3526 r3526] to be precise), then it doesn't know how to dispatch an InterTrac
    52    link, and it's up to the local Trac to prepare the correct link.
    53    Not all links will work that way, but the most common do.
    54    This is called the compatibility mode, and is `false` by default.
    55  * If you know that the remote Trac knows how to dispatch InterTrac links,
    56    you can explicitly disable this compatibility mode and then ''any''
    57    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.
    5850
    5951Now, given the above configuration, one could create the following links:
    … …  
    6961   * `trac:changeset:1912` trac:changeset:1912
    7062   * `[T1912]` [T1912]
    71  * 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`:
    7264   * `trac:log:@3300:3330` trac:log:@3300:3330 
    7365   * `[trac 3300:3330]` [trac 3300:3330]
    74  * 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.
    7567
    7668The 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.