pages, milestones and source files) from anywhere WikiFormatting is used.

2

[[TracGuideToc]]

3

4

TracLinks are a fundamental feature of Trac, because they allow easy hyperlinking between the various entities in the system—such as tickets, reports, changesets, Wiki pages, milestones, and source files—from anywhere WikiFormatting is used.

6

5

7

6

TracLinks are generally of the form '''type:id''' (where ''id'' represents the

Trac links using the full (non-shorthand) notation can also be given a custom

35

link title like this:

36

37

{{{

38

[ticket:1 This is a link to ticket number one].

39

}}}

40

41

Display: [ticket:1 This is a link to ticket number one].

42

43

If the title is be omitted, only the id (the part after the colon) is displayed:

44

45

{{{

46

[ticket:1]

47

}}}

48

49

Display: [ticket:1]

50

51

It might seem a simple enough concept at a glance, but actually allows quite a complex network of information. In practice, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's happening in a project or why a particular change was made.

52

53

== source: links ==

54

The default behavior for a source:/some/path link is to open the directory browser if the path points

55

to a directory and otherwise open the log view. It's also possible to link directly to a specific

56

revision of a file like this: source:/some/file#123 or like this to link to the latest revision:

non-alphabetic characters, etc. See WikiPageNames for more about features specific

51

to links to Wiki page names.

52

53

Trac links using the full (non-shorthand) notation can also be given a custom

54

link title like this:

55

56

{{{

57

[ticket:1 This is a link to ticket number one].

58

}}}

59

60

Display: [ticket:1 This is a link to ticket number one].

61

62

If the title is omitted, only the id (the part after the colon) is displayed:

63

64

{{{

65

[ticket:1]

66

}}}

67

68

Display: [ticket:1]

69

70

`wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):

71

72

{{{

73

[SandBox the sandbox]

74

}}}

75

76

Display: [SandBox the sandbox]

77

78

TracLinks are a very simple idea, but actually allow quite a complex network of information. In practice, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's happening in a project or why a particular change was made.

79

80

81

== Advanced use of TracLinks ==

82

83

=== Relative links ===

84

85

To create a link to a specific anchor in a page, use '#':

86

{{{

87

[#Relativelinks relative links]

88

}}}

89

Displays:

90

[#Relativelinks relative links]

91

92

Hint: when you move your mouse over the title of a section, a '¶' character will be displayed. This is a link to that specific section and you can use this to copy the `#...` part inside a relative link to an anchor.

93

94

To create a link to a SubWiki-page just use a '/':

95

{{{

96

WikiPage/SubWikiPage or ./SubWikiPage

97

}}}

98

99

To link from a SubWiki page to a parent, simply use a '..':

100

{{{

101

[..]

102

}}}

103

104

To link from a SubWiki page to a sibling page, use a '../':

105

{{{

106

[../Sibling see next sibling]

107

}}}

108

109

''(Changed in 0.11)'' Note that in Trac 0.10, using e.g. `[../newticket]` may have worked for linking to the /newticket top-level URL, but now in 0.11 it will stay in the wiki namespace and link to a sibling page. See [#Server-relativelinks] for the new syntax.

110

111

=== InterWiki links ===

112

113

Other prefixes can be defined freely and made to point to resources in other Web applications. The definition of those prefixes as well as the URLs of the corresponding Web applications is defined in a special Wiki page, the InterMapTxt page. Note that while this could be used to create links to other Trac environments, there's a more specialized way to register other Trac environments which offers greater flexibility.

114

115

=== InterTrac links ===

116

117

This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.

118

119

Any type of Trac links could be written in one Trac environment and actually refer to resources present in another Trac environment, provided the Trac link is prefixed by the name of that other Trac environment followed by a colon. That other Trac environment must be registered, under its name or an alias. See InterTrac for details.

120

121

A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links usually have a way to understand the InterTrac prefixes. For example, links to Trac tickets can be written #T234 (if T was set as an alias for Trac), links to Trac changesets can be written [trac 1508].

122

123

=== Server-relative links ===

124

125

It is often useful to be able to link to objects in your project that

126

have no built-in Trac linking mechanism, such as static resources, `newticket`,

127

a shared `/register` page on the server, etc.

128

129

To link to resources inside the project, use either an absolute path from the project root,

130

or a relative link from the URL of the current page (''Changed in 0.11''):

The Trac links target Trac resources which have generally more than one way to be rendered, according to some extra parameters. For example, a Wiki page can accept a `version` or a `format` parameter, a report can make use of dynamic variables, etc.

173

174

Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:

175

- `wiki:WikiStart?format=txt`

176

- `ticket:1?version=1`

177

- `[/newticket?component=module1 create a ticket for module1]`

178

179

180

== TracLinks Reference ==

181

The following sections describe the individual link types in detail, as well as several notes advanced usage of links.

182

183

=== attachment: links ===

184

185

The link syntax for attachments is as follows:

186

* !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object

187

* !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page

188

* !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753

189

190

=== query: links ===

191

192

See TracQuery#UsingTracLinks and [#ticket:links].

193

194

=== search: links ===

195

196

See TracSearch#SearchLinks

197

198

=== ticket: links ===

199

200

Besides the obvious `ticket:id` form, it is also possible to specify a list of tickets or even a range of tickets instead of the `id`. This generates a link to a custom query view containing this fixed set of tickets.

201

202

Example:

203

- `ticket:5000-6000`

204

- `ticket:1,150`

205

206

''(since Trac 0.11)''

207

208

=== timeline: links ===

209

210

Links to the timeline can be created by specifying a date in the ISO:8601 format. The date can be optionally followed by a time specification. The time is interpreted as being UTC time, but alternatively you can specify your local time, followed by your timezone if you don't want to compute the UTC time.

211

212

Examples:

213

- `timeline:2008-01-29`

214

- `timeline:2008-01-29T15:48`

215

- `timeline:2008-01-29T16:48Z+01`

216

217

''(since Trac 0.11)''

218

219

=== wiki: links ===

220

221

See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.

222

223

=== Version Control related links ===

224

==== source: links ====

225

226

The default behavior for a source:/some/path link is to open the directory browser

227

if the path points to a directory and otherwise open the log view.

228

229

It's also possible to link directly to a specific revision of a file like this:

230

- `source:/some/file@123` - link to the file's revision 123

231

- `source:/some/file@head` - link explicitly to the latest revision of the file

232

233

If the revision is specified, one can even link to a specific line number:

To force the download of a file in the repository, as opposed to displaying it in the browser, use the `export` link. Several forms are available:

244

* `export:/some/file` - get the HEAD revision of the specified file

245

* `export:123:/some/file` - get revision 123 of the specified file

246

* `export:/some/file@123` - get revision 123 of the specified file

247

248

This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository.

249

250

If the path is to a directory in the repository instead of a specific file, the source browser will be used to display the directory (identical to the result of `source:/some/dir`.

251

252

==== log: links ====

253

254

The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions from the specified path, but it can also support displaying an arbitrary set of revisions.

255

- `log:/` - the latest revisions starting at the root of the repository