intertrac
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | intertrac [2015/06/09 15:23] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== InterTrac 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 link can be seen as a scoped TracLinks. | ||
+ | It is used for referring to a Trac resource | ||
+ | (Wiki page, changeset, ticket, ...) located in another | ||
+ | Trac environment. | ||
+ | |||
+ | ===== List of Active InterTrac Prefixes ===== | ||
+ | |||
+ | [[: | ||
+ | |||
+ | ===== 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. | ||
+ | |||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | |||
+ | The other resource is specified using a regular TracLinks, of any flavor. | ||
+ | |||
+ | That target environment name is either the real name of the | ||
+ | environment, | ||
+ | The aliases are defined in `trac.ini` (see below). | ||
+ | The prefix is case insensitive. | ||
+ | |||
+ | For convenience, | ||
+ | where one can use an alias as an immediate prefix | ||
+ | for the identifier of a ticket, changeset or report: | ||
+ | (e.g. `#T234`, `[[: | ||
+ | |||
+ | ===== Examples ===== | ||
+ | |||
+ | < | ||
+ | #!comment | ||
+ | | ||
+ | | ||
+ | Support for sibling environments has been disabled. | ||
+ | See http:// | ||
+ | </ | ||
+ | |||
+ | |||
+ | It is necessary to setup a configuration for the InterTrac facility. | ||
+ | This configuration has to be done in the TracIni file, `[[: | ||
+ | |||
+ | Example configuration: | ||
+ | < | ||
+ | ... | ||
+ | [[: | ||
+ | # -- Example of setting up an alias: | ||
+ | t = trac | ||
+ | |||
+ | # -- Link to an external Trac: | ||
+ | trac.title = Edgewall' | ||
+ | trac.url = http:// | ||
+ | trac.compat = false | ||
+ | </ | ||
+ | |||
+ | |||
+ | 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 links. | ||
+ | |||
+ | Finally, the `.compat` option can be used to activate or disable | ||
+ | a // | ||
+ | * If the targeted Trac is running a version below milestone: | ||
+ | | ||
+ | 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 links, | ||
+ | you can explicitely disable this compatibility mode and then // | ||
+ | | ||
+ | |||
+ | Now, given the above configuration, | ||
+ | * to this InterTrac page: | ||
+ | * `trac: | ||
+ | * `t: | ||
+ | * Keys are case insensitive: | ||
+ | * to the ticket #234: | ||
+ | * `trac: | ||
+ | * `trac:#234` trac:# | ||
+ | * `#T234` #T234 | ||
+ | * to the changeset [[:1912]]: | ||
+ | * `trac: | ||
+ | * `[[: | ||
+ | * to the log range [[: | ||
+ | * `trac: | ||
+ | * `[[: | ||
+ | |||
+ | The generic form `intertrac_prefix: | ||
+ | to the corresponding URL `< | ||
+ | are specific to some modules (e.g. !#T234 is processed by the | ||
+ | ticket module) and for the rest (`intertrac_prefix: | ||
+ | we rely on the TracSearch# | ||
+ | |||
+ | ---- | ||
+ | ==== Discussion ==== | ||
+ | |||
+ | I think that the `trac` prefix could even be set as a default in the `[[: | ||
+ | |||
+ | ---- | ||
+ | See also: TracLinks, InterWiki | ||
+ | |||
intertrac.txt · Last modified: 2015/06/09 15:23 by 127.0.0.1