Legend:

Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10.

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]]

15

16

== Link Syntax ==

17

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.

20

21

{{{

22

<target_environment>:<TracLinks>

23

}}}

24

25

The other resource is specified using a regular TracLinks, of any flavor.

26

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).

30

The prefix is case insensitive.

31

32

For convenience, there's also some alternative short-hand form,

33

where one can use an alias as an immediate prefix

34

for the identifier of a ticket, changeset or report:

35

(e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)

36

37

== Examples ==

38

39

It is necessary to setup a configuration for the InterTrac facility.

40

This configuration has to be done in the TracIni file, `[intertrac]` section.

41

42

Example configuration:

43

{{{

44

...

45

[intertrac]

46

# -- Example of setting up an alias:

47

t = trac

48

49

# -- Link to an external Trac:

50

trac.title = Edgewall's Trac for Trac

51

trac.url = http://trac.edgewall.org

52

}}}

53

54

The `.url` is mandatory and is used for locating the other Trac.

55

This can be a relative URL in case that Trac environment is located

56

on the same server.

57

58

The `.title` information will be used for providing an useful tooltip

59

when moving the cursor over an InterTrac links.

60

61

Finally, the `.compat` option can be used to activate or disable

62

a ''compatibility'' mode:

63

* If the targeted Trac is running a version below milestone:0.10

64

(r3526 to be precise), then it doesn't know how to dispatch an InterTrac

65

link, and it's up to the local Trac to prepare the correct link.

66

Not all links will work that way, but the most common do.

67

This is called the compatibility mode, and is `true` by default.

68

* If you know that the remote Trac knows how to dispatch InterTrac links,

69

you can explicitly disable this compatibility mode and then ''any''

70

TracLinks can become an InterTrac link.

71

72

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

73

* to this InterTrac page:

74

* `trac:wiki:InterTrac` trac:wiki:InterTrac

75

* `t:wiki:InterTrac` t:wiki:InterTrac

76

* Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac

77

* to the ticket #234:

78

* `trac:ticket:234` trac:ticket:234

79

* `trac:#234` trac:#234

80

* `#T234` #T234

81

* to the changeset [1912]:

82

* `trac:changeset:1912` trac:changeset:1912

83

* `[T1912]` [T1912]

84

* to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''

85

* `trac:log:@3300:3330` trac:log:@3300:3330

86

* `[trac 3300:3330]` [trac 3300:3330]

87

* 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'')