close
Warning:
Can't synchronize with repository "(default)" (/var/lib/svn/mod_papi does not appear to be a Subversion repository.). Look in the Trac log for more information.
- Timestamp:
-
Jan 20, 2016, 12:17:02 PM (10 years ago)
- Author:
-
trac
- Comment:
-
--
Legend:
- Unmodified
- Added
- Removed
- Modified
-
|
v3
|
v4
|
|
| 1 | | = InterTrac Links = |
| | 1 | = InterTrac Links |
| 2 | 2 | |
| 3 | | Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10. |
| | 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 | 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 == |
| | 5 | == List of Active InterTrac Prefixes |
| 13 | 6 | |
| 14 | 7 | [[InterTrac]] |
| 15 | 8 | |
| 16 | | == Link Syntax == |
| | 9 | == Link Syntax |
| 17 | 10 | |
| 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. |
| | 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. |
| 20 | 12 | |
| 21 | 13 | {{{ |
| … |
… |
|
| 25 | 17 | The other resource is specified using a regular TracLinks, of any flavor. |
| 26 | 18 | |
| 27 | | That target environment name is either the real name of the |
| 28 | | environment, or an alias for it. |
| | 19 | That target environment name is either the real name of the environment or an alias for it. |
| 29 | 20 | The aliases are defined in `trac.ini` (see below). |
| 30 | 21 | The prefix is case insensitive. |
| 31 | 22 | |
| 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`). |
| | 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`. |
| 33 | 24 | |
| 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]`, ...) |
| | 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]`. |
| 38 | 26 | |
| 39 | | == Examples == |
| | 27 | == Examples |
| 40 | 28 | |
| 41 | 29 | It is necessary to setup a configuration for the InterTrac facility. |
| … |
… |
|
| 43 | 31 | |
| 44 | 32 | Example configuration: |
| 45 | | {{{ |
| 46 | | ... |
| | 33 | {{{#!ini |
| 47 | 34 | [intertrac] |
| 48 | 35 | # -- Example of setting up an alias: |
| … |
… |
|
| 55 | 42 | |
| 56 | 43 | The `.url` is mandatory and is used for locating the other Trac. |
| 57 | | This can be a relative URL in case that Trac environment is located |
| 58 | | on the same server. |
| | 44 | This can be a relative URL in case that Trac environment is located on the same server. |
| 59 | 45 | |
| 60 | | The `.title` information will be used for providing an useful tooltip |
| 61 | | when moving the cursor over an InterTrac links. |
| | 46 | The `.title` information will be used for providing an useful tooltip when moving the cursor over an InterTrac links. |
| 62 | 47 | |
| 63 | 48 | Finally, the `.compat` option can be used to activate or disable |
| … |
… |
|
| 67 | 52 | link, and it's up to the local Trac to prepare the correct link. |
| 68 | 53 | Not all links will work that way, but the most common do. |
| 69 | | This is called the compatibility mode, and is `true` by default. |
| | 54 | This is called the compatibility mode, and is `false` by default. |
| 70 | 55 | * If you know that the remote Trac knows how to dispatch InterTrac links, |
| 71 | 56 | you can explicitly disable this compatibility mode and then ''any'' |
| … |
… |
|
| 89 | 74 | * 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'') |
| 90 | 75 | |
| 91 | | The generic form `intertrac_prefix:module:id` is translated |
| 92 | | to the corresponding URL `<remote>/module/id`, shorthand links |
| 93 | | are specific to some modules (e.g. !#T234 is processed by the |
| 94 | | ticket module) and for the rest (`intertrac_prefix:something`), |
| 95 | | we rely on the TracSearch#quickjump facility of the remote Trac. |
| | 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. |
| 96 | 77 | |
| 97 | 78 | ---- |