Changes between Version 4 and Version 5 of InterTrac


Ignore:
Timestamp:
Jan 5, 2017, 12:12:59 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterTrac

    v4 v5  
    11= InterTrac Links
    22
    3 Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup.
    4 
    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.
     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.
    114
    125== List of Active InterTrac Prefixes
    … …  
    169== 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 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`).
     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`.
    3324
    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]`, ...)
     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
    3927== Examples
    4028
    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.
     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:
    4331
    44 Example configuration:
    4532{{{#!ini
    4633[intertrac]
    … …  
    5441
    5542The `.url` is mandatory and is used for locating the other Trac.
    56 This can be a relative URL in case that Trac environment is located
    57 on the same server.
     43This can be a relative URL in case that Trac environment is located on the same server.
    5844
    59 The `.title` information will be used for providing an useful tooltip
    60 when moving the cursor over an InterTrac links.
    61 
    62 Finally, the `.compat` option can be used to activate or disable
    63 a ''compatibility'' mode:
    64  * If the targeted Trac is running a version below [trac:milestone:0.10 0.10]
    65    ([trac:r3526 r3526] to be precise), then it doesn't know how to dispatch an InterTrac
    66    link, and it's up to the local Trac to prepare the correct link.
    67    Not all links will work that way, but the most common do.
    68    This is called the compatibility mode, and is `false` by default.
    69  * If you know that the remote Trac knows how to dispatch InterTrac links,
    70    you can explicitly disable this compatibility mode and then ''any''
    71    TracLinks can become an InterTrac link.
     45The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link.
    7246
    7347Now, given the above configuration, one could create the following links:
    … …  
    8357   * `trac:changeset:1912` trac:changeset:1912
    8458   * `[T1912]` [T1912]
    85  * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''
     59 * to the log range [3300:3330]:
    8660   * `trac:log:@3300:3330` trac:log:@3300:3330 
    87    * `[trac 3300:3330]` [trac 3300:3330] 
    88  * 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'')
     61   * `[trac 3300:3330]` [trac 3300:3330]
     62   * 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'')
    8963
    90 The generic form `intertrac_prefix:module:id` is translated
    91 to the corresponding URL `<remote>/module/id`, shorthand links
    92 are specific to some modules (e.g. !#T234 is processed by the
    93 ticket module) and for the rest (`intertrac_prefix:something`),
    94 we rely on the TracSearch#quickjump facility of the remote Trac.
     64The 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.
    9565
    9666----