Changes between Version 4 and Version 5 of InterTrac


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • InterTrac

    v4 v5  
    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. 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.
     3Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10.
    44
    5 == List of Active InterTrac Prefixes
     5== Definitions ==
     6
     7An InterTrac link can be seen as a scoped TracLinks.
     8It is used for referring to a Trac resource
     9(Wiki page, changeset, ticket, ...) located in another
     10Trac environment.
     11
     12== List of Active InterTrac Prefixes ==
    613
    714[[InterTrac]]
    815
    9 == Link Syntax
     16== Link Syntax ==
    1017
    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.
     18Simply use the name of the other Trac environment as a prefix,
     19followed by a colon, ending with the resource located in the other environment.
    1220
    1321{{{
     
    1725The other resource is specified using a regular TracLinks, of any flavor.
    1826
    19 That target environment name is either the real name of the environment or an alias for it.
     27That target environment name is either the real name of the
     28environment, or an alias for it.
    2029The aliases are defined in `trac.ini` (see below).
    2130The prefix is case insensitive.
    2231
    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`.
     32If 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`).
    2433
    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]`.
     34For convenience, there's also some alternative short-hand form,
     35where one can use an alias as an immediate prefix
     36for the identifier of a ticket, changeset or report:
     37(e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)
    2638
    27 == Examples
     39== Examples ==
    2840
    2941It is necessary to setup a configuration for the InterTrac facility.
     
    3143
    3244Example configuration:
    33 {{{#!ini
     45{{{
     46...
    3447[intertrac]
    3548# -- Example of setting up an alias:
     
    4255
    4356The `.url` is mandatory and is used for locating the other Trac.
    44 This can be a relative URL in case that Trac environment is located on the same server.
     57This can be a relative URL in case that Trac environment is located
     58on the same server.
    4559
    46 The `.title` information will be used for providing an useful tooltip when moving the cursor over an InterTrac links.
     60The `.title` information will be used for providing an useful tooltip
     61when moving the cursor over an InterTrac links.
    4762
    4863Finally, the `.compat` option can be used to activate or disable
     
    5267   link, and it's up to the local Trac to prepare the correct link.
    5368   Not all links will work that way, but the most common do.
    54    This is called the compatibility mode, and is `false` by default.
     69   This is called the compatibility mode, and is `true` by default.
    5570 * If you know that the remote Trac knows how to dispatch InterTrac links,
    5671   you can explicitly disable this compatibility mode and then ''any''
     
    7489 * 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'')
    7590
    76 The 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.
     91The generic form `intertrac_prefix:module:id` is translated
     92to the corresponding URL `<remote>/module/id`, shorthand links
     93are specific to some modules (e.g. !#T234 is processed by the
     94ticket module) and for the rest (`intertrac_prefix:something`),
     95we rely on the TracSearch#quickjump facility of the remote Trac.
    7796
    7897----