|
|
# [InterTrac](inter-trac) Links
|
|
|
|
|
|
|
|
|
Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10.
|
|
|
|
|
|
## Definitions
|
|
|
|
|
|
|
|
|
An [InterTrac](inter-trac) link can be seen as a scoped [TracLinks](trac-links).
|
|
|
It is used for referring to a Trac resource
|
|
|
(Wiki page, changeset, ticket, ...) located in another
|
|
|
Trac environment.
|
|
|
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](trac-links). 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.
|
|
|
|
|
|
## List of Active [InterTrac](inter-trac) Prefixes
|
|
|
|
... | ... | @@ -23,8 +15,7 @@ Trac environment. |
|
|
## Link Syntax
|
|
|
|
|
|
|
|
|
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.
|
|
|
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:
|
|
|
|
|
|
```wiki
|
|
|
<target_environment>:<TracLinks>
|
... | ... | @@ -34,60 +25,32 @@ followed by a colon, ending with the resource located in the other environment. |
|
|
The other resource is specified using a regular [TracLinks](trac-links), of any flavor.
|
|
|
|
|
|
|
|
|
That target environment name is either the real name of the
|
|
|
environment, or an alias for it.
|
|
|
The aliases are defined in `trac.ini` (see below).
|
|
|
That target environment name is either the real name of the environment or an alias for it.
|
|
|
The aliases are defined in the `trac.ini` file, see below.
|
|
|
The prefix is case insensitive.
|
|
|
|
|
|
|
|
|
If the [InterTrac](inter-trac) link is enclosed in square brackets (like `[th:WikiExtrasPlugin]`), the [InterTrac](inter-trac) prefix is removed in the displayed link, like a normal link resolver would be (i.e. the above would be displayed as `WikiExtrasPlugin`).
|
|
|
If the [InterTrac](inter-trac) link is enclosed in square brackets, like `[th:WikiExtrasPlugin]`, the [InterTrac](inter-trac) prefix is removed in the displayed link like a normal link resolver would be, ie the above would be displayed as `WikiExtrasPlugin`.
|
|
|
|
|
|
|
|
|
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:
|
|
|
(e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)
|
|
|
For 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]`.
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
It is necessary to setup a configuration for the [InterTrac](inter-trac) facility.
|
|
|
This configuration has to be done in the [TracIni](trac-ini) file, `[intertrac]` section.
|
|
|
|
|
|
|
|
|
Example configuration:
|
|
|
It is necessary to set up a configuration for the [InterTrac](inter-trac) facility.
|
|
|
This configuration has to be done in the [TracIni](trac-ini) file, `[intertrac]` section, for example:
|
|
|
|
|
|
```wiki
|
|
|
...
|
|
|
[intertrac]
|
|
|
# -- Example of setting up an alias:
|
|
|
t = trac
|
|
|
|
|
|
# -- Link to an external Trac:
|
|
|
trac.title = Edgewall's Trac for Trac
|
|
|
trac.url = http://trac.edgewall.org
|
|
|
```
|
|
|
[intertrac]# -- Example of setting up an alias:t=trac# -- Link to an external Trac:trac.title=Edgewall's Trac for Tractrac.url=http://trac.edgewall.org
|
|
|
```
|
|
|
|
|
|
|
|
|
The `.url` is mandatory and is used for locating the other Trac.
|
|
|
This can be a relative URL in case that Trac environment is located
|
|
|
on the same server.
|
|
|
|
|
|
|
|
|
The `.title` information will be used for providing an useful tooltip
|
|
|
when moving the cursor over an [InterTrac](inter-trac) links.
|
|
|
|
|
|
This can be a relative URL in case that Trac environment is located on the same server.
|
|
|
|
|
|
Finally, the `.compat` option can be used to activate or disable
|
|
|
a *compatibility* mode:
|
|
|
|
|
|
- If the targeted Trac is running a version below [ 0.10](http://trac.edgewall.org/intertrac/milestone%3A0.10)
|
|
|
([ r3526](http://trac.edgewall.org/intertrac/r3526) to be precise), then it doesn't know how to dispatch an [InterTrac](inter-trac)
|
|
|
link, and it's up to the local Trac to prepare the correct link.
|
|
|
Not all links will work that way, but the most common do.
|
|
|
This is called the compatibility mode, and is `true` by default.
|
|
|
- If you know that the remote Trac knows how to dispatch [InterTrac](inter-trac) links,
|
|
|
you can explicitly disable this compatibility mode and then *any*[TracLinks](trac-links) can become an [InterTrac](inter-trac) link.
|
|
|
The `.title` information is used in a tooltip, ie when hovering the cursor over an [InterTrac](inter-trac) link.
|
|
|
|
|
|
|
|
|
Now, given the above configuration, one could create the following links:
|
... | ... | @@ -106,18 +69,15 @@ Now, given the above configuration, one could create the following links: |
|
|
|
|
|
- `trac:changeset:1912`[ trac:changeset:1912](http://trac.edgewall.org/intertrac/changeset%3A1912)
|
|
|
- `[T1912]` \[T1912\]
|
|
|
- to the log range [\[3300:3330\]](/trac/ghc/log/ghc/?revs=3300%3A3330): **(Note: the following ones need `trac.compat=false`)**
|
|
|
- to the log range [\[3300:3330\]](/trac/ghc/log/ghc/?revs=3300%3A3330):
|
|
|
|
|
|
- `trac:log:@3300:3330`[ trac:log:\@3300:3330](http://trac.edgewall.org/intertrac/log%3A%403300%3A3330)
|
|
|
- `[trac 3300:3330]`[ \[trac 3300:3330\]](http://trac.edgewall.org/intertrac/log%3A/%403300%3A3330)
|
|
|
- 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*)
|
|
|
- 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*)
|
|
|
*
|
|
|
|
|
|
|
|
|
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](trac-search#) facility of the remote Trac.
|
|
|
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](trac-search#) facility of the remote Trac.
|
|
|
|
|
|
---
|
|
|
|
... | ... | |