Changes between Initial Version and Version 1 of InterTrac


Ignore:
Timestamp:
03/14/15 20:29:38 (5 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • InterTrac

    v1 v1  
     1= InterTrac Links  =
     2
     3Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10.
     4
     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 ==
     13
     14[[InterTrac]]
     15
     16== Link Syntax ==
     17
     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.
     20
     21{{{
     22<target_environment>:<TracLinks>
     23}}}
     24
     25The other resource is specified using a regular TracLinks, of any flavor.
     26
     27That target environment name is either the real name of the
     28environment, or an alias for it.
     29The aliases are defined in `trac.ini` (see below).
     30The prefix is case insensitive.
     31
     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`).
     33
     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]`, ...)
     38
     39== Examples ==
     40
     41It is necessary to setup a configuration for the InterTrac facility.
     42This configuration has to be done in the TracIni file, `[intertrac]` section.
     43
     44Example configuration:
     45{{{#!ini
     46[intertrac]
     47# -- Example of setting up an alias:
     48t = trac
     49
     50# -- Link to an external Trac:
     51trac.title = Edgewall's Trac for Trac
     52trac.url = http://trac.edgewall.org
     53}}}
     54
     55The `.url` is mandatory and is used for locating the other Trac.
     56This can be a relative URL in case that Trac environment is located
     57on the same server.
     58
     59The `.title` information will be used for providing an useful tooltip
     60when moving the cursor over an InterTrac links.
     61
     62Finally, the `.compat` option can be used to activate or disable
     63a ''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.
     72
     73Now, given the above configuration, one could create the following links:
     74 * to this InterTrac page:
     75   * `trac:wiki:InterTrac` trac:wiki:InterTrac
     76   * `t:wiki:InterTrac` t:wiki:InterTrac
     77   * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac
     78 * to the ticket #234:
     79   * `trac:ticket:234` trac:ticket:234
     80   * `trac:#234` trac:#234
     81   * `#T234` #T234
     82 * to the changeset [1912]:
     83   * `trac:changeset:1912` trac:changeset:1912
     84   * `[T1912]` [T1912]
     85 * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''
     86   * `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'')
     89
     90The generic form `intertrac_prefix:module:id` is translated
     91to the corresponding URL `<remote>/module/id`, shorthand links
     92are specific to some modules (e.g. !#T234 is processed by the
     93ticket module) and for the rest (`intertrac_prefix:something`),
     94we rely on the TracSearch#quickjump facility of the remote Trac.
     95
     96----
     97See also: TracLinks, InterWiki