3 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.
5 TracLinks are generally of the form '''type:id''' (where ''id'' represents the
6 number, name or path of the item) though some frequently used kinds of items
7 also have short-hand notations.
9 == Where to use TracLinks ==
10 You can use TracLinks in:
12 * Source code (Subversion) commit messages
14 * Full descriptions for tickets, reports and milestones
16 and any other text fields explicitly marked as supporting WikiFormatting.
19 * Tickets: '''!#1''' or '''!ticket:1'''
20 * Ticket comments: '''!comment:1:ticket:2'''
21 * Reports: '''!{1}''' or '''!report:1'''
22 * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk'''
23 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''', '''![2:5/trunk]'''
24 * Diffs (requires [trac:milestone:0.10 0.10]): '''!diff:@1:3''', '''!diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default''' or '''!diff:trunk/trac@3538//sandbox/vc-refactoring@3539'''
25 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase'''
26 * Parent page: '''![..]'''
27 * Milestones: '''!milestone:1.0'''
28 * Attachment: '''!attachment:example.tgz''' (for current page attachment), '''!attachment:attachment.1073.diff:ticket:944'''
30 * Files: '''!source:trunk/COPYING'''
31 * A specific file revision: '''!source:/trunk/COPYING@200'''
32 * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25'''
34 * Tickets: #1 or ticket:1
35 * Ticket comments: comment:1:ticket:2
36 * Reports: {1} or report:1
37 * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
38 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
39 * Diffs (requires [milestone:0.10 0.10]): diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
40 * Wiki pages: CamelCase or wiki:CamelCase
42 * Milestones: milestone:1.0
43 * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944
45 * Files: source:trunk/COPYING
46 * A specific file revision: source:/trunk/COPYING@200
47 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25
49 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
50 pages whose names do not follow WikiPageNames rules, i.e., single words,
51 non-alphabetic characters, etc. See WikiPageNames for more about features specific
52 to links to Wiki page names.
54 Trac links using the full (non-shorthand) notation can also be given a custom
58 [ticket:1 This is a link to ticket number one].
61 Display: [ticket:1 This is a link to ticket number one].
63 If the title is omitted, only the id (the part after the colon) is displayed:
71 `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):
77 Display: [SandBox the sandbox]
79 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.
82 == Advanced use of TracLinks ==
84 === Relative links ===
86 To create a link to a specific anchor in a page, use '#':
88 [#Relativelinks relative links]
91 [#Relativelinks relative links]
93 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.
95 To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
97 WikiPage/SubWikiPage or ./SubWikiPage
100 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
105 To link from a [trac:SubWiki SubWiki] page to a sibling page, use a '../':
107 [../Sibling see next sibling]
110 ''(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.
112 === InterWiki links ===
114 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.
116 === InterTrac links ===
118 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
120 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.
122 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].
124 === Server-relative links ===
126 It is often useful to be able to link to objects in your project that
127 have no built-in Trac linking mechanism, such as static resources, `newticket`,
128 a shared `/register` page on the server, etc.
130 To link to resources inside the project, use either an absolute path from the project root,
131 or a relative link from the URL of the current page:
134 [/ticket.php/new Create a new ticket]
138 Display: [/ticket.php/new newticket] [/ home]
140 To link to another location on the server (outside the project), use the '//location' link syntax:
143 [//register Register Here]
146 Display: [//register Register Here]
148 === Quoting space in TracLinks ===
150 Immediately after a TracLinks prefix, targets containing space characters should
151 be enclosed in a pair of quotes or double quotes.
154 * !wiki:"The whitespace convention"
155 * !attachment:'the file.txt' or
156 * !attachment:"the file.txt"
157 * !attachment:"the file.txt:ticket:123"
160 * wiki:"The whitespace convention"
161 * attachment:'the file.txt' or
162 * attachment:"the file.txt"
163 * attachment:"the file.txt:ticket:123"
166 === Escaping Links ===
168 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
171 ![42] is not a link either.
176 ![42] is not a link either.
179 === Parameterized Trac links ===
181 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.
183 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:
184 - `wiki:Today?format=txt` - wiki:Today?format=txt
185 - `wiki:Today?version=1` - wiki:Today?version=1
186 - `[/newticket?component=module1 create a ticket for module1]`
189 == TracLinks Reference ==
190 The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
192 === attachment: links ===
194 The link syntax for attachments is as follows:
195 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
196 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
197 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
199 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
201 If you'd like to create a direct link to the content of the attached file instead of a link to the attachment page, simply use `raw-attachment:` instead of `attachment:`.
203 This can be useful for pointing directly to an HTML document, for example. Note that for this use case, you'd have to allow the web browser to render the content by setting `[attachment] render_unsafe_content = yes` (see TracIni#attachment-section). Caveat: only do that in environments for which you're 100% confident you can trust the people who are able to attach files, as otherwise this would open up your site to [wikipedia:Cross-site_scripting cross-site scripting] attacks.
205 See also [#export:links].
207 === comment: links ===
209 When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment.
210 It's also possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
211 - !comment:3:ticket:123 - comment:3:ticket:123
212 - !ticket:123#comment:3 - ticket:123#comment:3 (note that you can't write !#123#!comment:3!)
216 See TracQuery#UsingTracLinks and [#ticket:links].
218 === search: links ===
220 See TracSearch#SearchLinks
222 === ticket: links ===
224 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.
227 - `ticket:5000-6000` - ticket:5000-6000
228 - `ticket:1,150` - ticket:1,150
230 === timeline: links ===
232 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.
235 - `timeline:2008-01-29`
236 - `timeline:2008-01-29T15:48`
237 - `timeline:2008-01-29T16:48Z+01`
239 ''(since Trac 0.11)''
243 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.
245 === Version Control related links ===
246 ==== source: links ====
248 The default behavior for a source:/some/path link is to open the directory browser
249 if the path points to a directory and otherwise open the log view.
251 It's also possible to link directly to a specific revision of a file like this:
252 - `source:/some/file@123` - source:/some/file@123 - link to the file's revision 123
253 - `source:/some/file@head` - link explicitly to the latest revision of the file
255 If the revision is specified, one can even link to a specific line number:
256 - `source:/some/file@123#L10`
257 - `source:/tag/0.10@head#L10`
259 Finally, one can also highlight an arbitrary set of lines:
260 - `source:/some/file@123:10-20,100,103#L99` - source:/some/file@123:10-20,100,103#L99 - highlight lines 10 to 20, and lines 100 and 103.
262 ==== export: links ====
264 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:
265 * `export:/some/file` - get the HEAD revision of the specified file
266 * `export:123:/some/file` - get revision 123 of the specified file
267 * `export:/some/file@123` - get revision 123 of the specified file
269 This can be very useful for displaying XML or HTML documentation with correct stylesheets and images, in case that has been checked in into the repository. Note that for this use case, you'd have to allow the web browser to render the content by setting `[browser] render_unsafe_content = yes` (see TracIni#browser-section), otherwise Trac will force the files to be downloaded as attachments for security concerns.
271 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`).
275 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.
276 - `log:/` - log:/ - the latest revisions starting at the root of the repository
277 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
278 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000
279 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range
280 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path
282 There are short forms for revision ranges as well:
283 - `[20788,20791:20795]`
284 - `[20788,20791:20795/trunk/tools]`
285 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
287 Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`.
290 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki