wiki:InterTrac

InterTrac Links

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.

List of Active InterTrac Prefixes

PrefixTrac Site
adminSite administration
ancilCentral Ancillary Program (CAP)
cddsClimate Data Dissemination System
docPublished documentation
gaGlobal Atmosphere Development
gcomGCOM
glGlobal Land Development
goNEMO Global Ocean Development
gsiGlobal Sea-Ice Development
homeGeneral site information
julesJULES land surface model
lfricLFRic
mociMet Office Coupling Infrastructure
modelevalGlobal Model Evaluation
moncMet Office/NERC cloud model
opsObservational Processing System (OPS)
roses-uRosie: Suite Repository
socratesSuite of Community Radiative Transfer codes based on Edwards and Slingo
testTest repository
tiTechnical Infrastructure Programme
tracThe Trac Project
ukesmUK Earth System Model
umUnified Model
utilsSmall projects, systems and utilities
varVariational Data Assimilation (VAR)

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:

<target_environment>:<TracLinks>

The other resource is specified using a regular TracLinks, 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 the trac.ini file, see below. The prefix is case insensitive.

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.

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 set up a configuration for the InterTrac facility. This configuration has to be done in the TracIni file, [intertrac] section, for example:

[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

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 is used in a tooltip, ie when hovering the cursor over an InterTrac link.

Now, given the above configuration, one could create the following links:

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.


See also: TracLinks, InterWiki

Last modified 4 years ago Last modified on Dec 13, 2016 10:03:31 AM