Changes between Initial Version and Version 1 of InterTrac

Nov 26, 2018, 5:35:04 PM (3 years ago)



  • InterTrac

    v1 v1  
     1= InterTrac Links
     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.
     5== List of Active InterTrac Prefixes
     9== Link Syntax
     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:
     17The other resource is specified using a regular TracLinks, of any flavor.
     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.
     21The prefix is case insensitive.
     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`.
     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]`.
     27== Examples
     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:
     34# -- Example of setting up an alias:
     35t = trac
     37# -- Link to an external Trac:
     38trac.title = Edgewall's Trac for Trac
     39trac.url =
     42The `.url` is mandatory and is used for locating the other Trac.
     43This can be a relative URL in case that Trac environment is located on the same server.
     45The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link.
     47Now, given the above configuration, one could create the following links:
     48 * to this InterTrac page:
     49   * `trac:wiki:InterTrac` trac:wiki:InterTrac
     50   * `t:wiki:InterTrac` t:wiki:InterTrac
     51   * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac
     52 * to the ticket #234:
     53   * `trac:ticket:234` trac:ticket:234
     54   * `trac:#234` trac:#234
     55   * `#T234` #T234
     56 * to the changeset [1912]:
     57   * `trac:changeset:1912` trac:changeset:1912
     58   * `[T1912]` [T1912]
     59 * to the log range [3300:3330]:
     60   * `trac:log:@3300:3330` trac:log:@3300:3330 
     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'')
     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.
     67See also: TracLinks, InterWiki