Changes between Version 5 and Version 6 of Inter Trac


Ignore:
Timestamp:
Oct 25, 2020, 10:52:22 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Inter Trac

    v5 v6  
    11= 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.
    4 
    5 == List of Active InterTrac Prefixes
    6 
    7 [[InterTrac]]
     3Trac supports a convenient way to refer to resources of other Trac servers using Wiki markup. An !InterTrac link can be seen as a scoped [TracLinks TracLink]. It is used for referring to a Trac resource located in another Trac environment.
    84
    95== Link Syntax
    106
    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.
     7Simply use the name of the other Trac environment as a prefix, followed by a colon, ending with the resource located in the other environment:
    128
    139{{{
    … …  
    1511}}}
    1612
    17 The other resource is specified using a regular TracLinks, of any flavor.
     13The other resource is specified using a regular !TracLink, of any flavor.
    1814
    19 That 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).
     15That target environment name is either the real name of the environment or an alias.
     16The aliases are defined in the `trac.ini` file, see below.
    2117The prefix is case insensitive.
    2218
    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`.
     19If 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. For example, the above would be displayed as `WikiExtrasPlugin`.
    2420
    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]`.
     21For convenience, there is also an alternate 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]`.
    2622
    2723== Examples
    2824
    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.
     25The only prefix defined by default is `trac`, which points to trac.edgewall.org. Additional prefixes can be specified in the [TracIni#intertrac-section intertrac] section of TracIni. For example:
    3126
    32 Example configuration:
    3327{{{#!ini
    3428[intertrac]
    … …  
    3731
    3832# -- Link to an external Trac:
    39 trac.title = Edgewall's Trac for Trac
    40 trac.url = http://trac.edgewall.org
     33genshi.title = Edgewall's Trac for Genshi
     34genshi.url = http://genshi.edgewall.org
    4135}}}
    4236
    4337The `.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.
     38It can be a relative URL when the Trac environment is located on the same server.
    4539
    46 The `.title` information will be used for providing an useful tooltip when moving the cursor over an InterTrac links.
     40The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link.
    4741
    4842Now, given the above configuration, one could create the following links:
    … …  
    5044   * `trac:wiki:InterTrac` trac:wiki:InterTrac
    5145   * `t:wiki:InterTrac` t:wiki:InterTrac
     46   * `genshi:InterTrac` genshi:InterTrac
    5247   * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac
    5348 * to the ticket #234:
    5449   * `trac:ticket:234` trac:ticket:234
    5550   * `trac:#234` trac:#234
     51   * `genshi:#234` genshi:#234
    5652   * `#T234` #T234
    5753 * to the changeset [1912]:
    … …  
    6359   * 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'')
    6460
    65 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.
     61The 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). For the rest (`intertrac_prefix:something`), we rely on the [TracSearch#quickjump quick jump] facility of the remote Trac.
     62
     63== List of Active InterTrac Prefixes
     64
     65The following InterTrac prefixes are available on this site:
     66
     67[[InterTrac]]
    6668
    6769----