Changes between Version 2 and Version 3 of InterTrac


Ignore:
Timestamp:
04/22/15 15:16:44 (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterTrac

    v2 v3  
    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.
     19That target environment name is either the real name of the environment or an alias for it.
    2920The aliases are defined in `trac.ini` (see below).
    3021The prefix is case insensitive.
    3122
    32 When a TracLink is enclosed in brackets, the alias is expanded.  That is, `[th:ticket:1]` is displayed as `trachacks:ticket:1`, since `th` is an alias for `trachacks`.  If the TracLink is not enclosed in brackets, then the alias is displayed as it is typed.
     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'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]`.
    3826
    39 == Examples ==
     27== Examples
    4028
    4129It is necessary to setup a configuration for the InterTrac facility.
    … …  
    4331
    4432Example configuration:
    45 {{{
    46 ...
     33{{{#!ini
    4734[intertrac]
    4835# -- Example of setting up an alias:
    … …  
    5542
    5643The `.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.
     44This can be a relative URL in case that Trac environment is located on the same server.
    5945
    60 The `.title` information will be used for providing an useful tooltip
    61 when moving the cursor over an InterTrac links.
     46The `.title` information will be used for providing an useful tooltip when moving the cursor over an InterTrac links.
    6247
    6348Finally, the `.compat` option can be used to activate or disable
    … …  
    6752   link, and it's up to the local Trac to prepare the correct link.
    6853   Not all links will work that way, but the most common do.
    69    This is called the compatibility mode, and is `true` by default.
     54   This is called the compatibility mode, and is `false` by default.
    7055 * If you know that the remote Trac knows how to dispatch InterTrac links,
    7156   you can explicitly disable this compatibility mode and then ''any''
    … …  
    8974 * 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'')
    9075
    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.
     76The 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.
    9677
    9778----