Changes between Version 2 and Version 3 of InterTrac
- Timestamp:
- Apr 5, 2019, 9:38:47 AM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
InterTrac
v2 v3 1 1 = InterTrac Links 2 2 3 Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup. 4 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 13 14 [[InterTrac]] 3 Trac 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. 15 4 16 5 == Link Syntax 17 6 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. 7 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: 20 8 21 9 {{{ … … 23 11 }}} 24 12 25 The other resource is specified using a regular TracLinks, of any flavor.13 The other resource is specified using a regular !TracLink, of any flavor. 26 14 27 That target environment name is either the real name of the 28 environment, or an alias for it. 29 The aliases are defined in `trac.ini` (see below). 15 That target environment name is either the real name of the environment or an alias. 16 The aliases are defined in the `trac.ini` file, see below. 30 17 The prefix is case insensitive. 31 18 32 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 (i.e. the above would be displayed as `WikiExtrasPlugin`).19 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. For example, the above would be displayed as `WikiExtrasPlugin`. 33 20 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]`, ...) 21 For 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]`. 38 22 39 23 == Examples 40 24 41 It is necessary to setup a configuration for the InterTrac facility. 42 This configuration has to be done in the TracIni file, `[intertrac]` section. 25 The 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: 43 26 44 Example configuration:45 27 {{{#!ini 46 28 [intertrac] … … 49 31 50 32 # -- Link to an external Trac: 51 trac.title = Edgewall's Trac for Trac 52 trac.url = http://trac.edgewall.org33 genshi.title = Edgewall's Trac for Genshi 34 genshi.url = http://genshi.edgewall.org 53 35 }}} 54 36 55 37 The `.url` is mandatory and is used for locating the other Trac. 56 This can be a relative URL in case that Trac environment is located 57 on the same server. 38 It can be a relative URL when the Trac environment is located on the same server. 58 39 59 The `.title` information will be used for providing an useful tooltip 60 when moving the cursor over an InterTrac links. 61 62 Finally, the `.compat` option can be used to activate or disable 63 a ''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. 40 The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link. 72 41 73 42 Now, given the above configuration, one could create the following links: … … 75 44 * `trac:wiki:InterTrac` trac:wiki:InterTrac 76 45 * `t:wiki:InterTrac` t:wiki:InterTrac 46 * `genshi:InterTrac` genshi:InterTrac 77 47 * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac 78 48 * to the ticket #234: 79 49 * `trac:ticket:234` trac:ticket:234 80 50 * `trac:#234` trac:#234 51 * `genshi:#234` genshi:#234 81 52 * `#T234` #T234 82 53 * to the changeset [1912]: 83 54 * `trac:changeset:1912` trac:changeset:1912 84 55 * `[T1912]` [T1912] 85 * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''56 * to the log range [3300:3330]: 86 57 * `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 run0.11 for this to work'')58 * `[trac 3300:3330]` [trac 3300:3330] 59 * 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'') 89 60 90 The generic form `intertrac_prefix:module:id` is translated 91 to the corresponding URL `<remote>/module/id`, shorthand links 92 are specific to some modules (e.g. !#T234 is processed by the 93 ticket module) and for the rest (`intertrac_prefix:something`), 94 we rely on the TracSearch#quickjump facility of the remote Trac. 61 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). 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 65 The following InterTrac prefixes are available on this site: 66 67 [[InterTrac]] 95 68 96 69 ----