source: wiki/pages/TracLinks @ 40542

Last change on this file since 40542 was 40542, checked in by obi, 2 years ago

reset wiki files

File size: 18.5 KB
RevLine 
[40542]1= Trac Links =
2[[TracGuideToc]]
3
4TracLinks 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
6TracLinks are generally of the form '''type:id''' (where ''id'' represents the
7number, name or path of the item) though some frequently used kinds of items
8also have short-hand notations.
9
10== Where to use TracLinks ==
11You can use TracLinks in:
12
13 * Source code (Subversion) commit messages
14 * Wiki pages
15 * Full descriptions for tickets, reports and milestones
16
17and any other text fields explicitly marked as supporting WikiFormatting.
18
19== Overview ==
20
21||= Wiki Markup =||= Display =||
22{{{#!td
23 Wiki pages :: `CamelCase` or `wiki:CamelCase`
24 Parent page :: `[..]`
25 Tickets :: `#1` or `ticket:1`
26 Ticket comments :: `comment:1:ticket:2`
27 Reports :: `{1}` or `report:1`
28 Milestones :: `milestone:1.0`
29 Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path)
30 Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`, `[1/repository]`
31 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
32 Diffs :: `diff:@1:3`, `diff:plugins/0.12/mercurial-plugin@9128:9953`,
33          `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
34          or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
35 Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25)
36}}}
37{{{#!td
38 Wiki pages :: CamelCase or wiki:CamelCase
39 Parent page :: [..]
40 Tickets :: #1 or ticket:1
41 Ticket comments :: comment:1:ticket:2
42 Reports :: {1} or report:1
43 Milestones :: milestone:1.0
44 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
45 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk, [1/repository]
46 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
47 Diffs :: diff:@1:3, diff:plugins/0.12/mercurial-plugin@9128:9953,
48          diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
49          or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
50 Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25)
51}}}
52
53'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
54pages whose names do not follow WikiPageNames rules, i.e., single words,
55non-alphabetic characters, etc. See WikiPageNames for more about features specific
56to links to Wiki page names.
57
58
59{{{#!table class=""
60|||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: ||
61{{{#!td
62{{{
63[ticket:1 This is a link to ticket number one] or
64[[ticket:1|This is another link to ticket number one]].
65}}}
66}}}
67{{{#!td
68[ticket:1 This is a link to ticket number one] or
69[[ticket:1|This is another link to ticket number one]].
70}}}
71|--------------------------------------------------------------------------------------
72|||| If the title is omitted, only the id (the part after the colon) is displayed:  ||
73{{{#!td
74{{{
75[ticket:1] or [[ticket:2]]
76}}}
77}}}
78{{{#!td
79[ticket:1] or [[ticket:2]]
80}}}
81|--------------------------------------------------------------------------------------
82|||| `wiki` is the default if the namespace part of a full link is omitted:  ||
83{{{#!td
84{{{
85[SandBox the sandbox] or
86[[SandBox|the sandbox]]
87}}}
88}}}
89{{{#!td
90[SandBox the sandbox] or
91[[SandBox|the sandbox]]
92}}}
93|--------------------------------------------------------------------------------------
94|||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  ||
95{{{#!td
96{{{
97<wiki:Strange(page@!)>
98}}}
99}}}
100{{{#!td
101<wiki:Strange(page@!)>
102}}}
103}}}
104
105TracLinks 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.
106
107
108== Advanced use of TracLinks ==
109
110=== Relative links ===
111
112To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
113{{{
114 WikiPage/SubWikiPage or ./SubWikiPage
115}}}
116
117To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
118{{{
119  [..] or [[..]]
120}}}
121  [..] or [[..]]
122
123To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
124{{{
125  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
126}}}
127  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
128
129But in practice you often won't need to add the `../` prefix to link to a sibling page.
130For resolving the location of a wiki link, it's the target page closest in the hierarchy
131to the page where the link is written which will be selected. So for example, within
132a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
133This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
134
135In order to link explicitly to a [=#toplevel toplevel] Wiki page,
136use the `wiki:/` prefix. Be careful **not** to use the `/` prefix alone, as this corresponds to the [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/` part in the resulting URL. A link such as `[../newticket]` will stay in the wiki namespace and therefore link to a sibling page.
137
138=== Link anchors ===
139
140To create a link to a specific anchor in a page, use '#':
141{{{
142 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
143}}}
144  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
145
146Hint: 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.
147
148To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?':
149{{{
150 [#/Milestone first occurrence of Milestone] or
151 [#?Milestone last occurrence of Milestone]
152}}}
153 [#/Milestone first occurrence of Milestone] or
154 [#?Milestone last occurrence of Milestone]
155This will also highlight all other matches on the linked page. By default only case sensitive matches are considered. To include case insensitive matches append '/i':
156{{{
157 [#/Milestone/i first occurrence of Milestone or milestone] or
158 [#?Milestone/i last occurrence of Milestone or milestone]
159}}}
160 [#/Milestone/i first occurrence of Milestone or milestone] or
161 [#?Milestone/i last occurrence of Milestone or milestone]
162
163''(since Trac 1.0)''
164
165Such anchors can be very useful for linking to specific lines in a file in the source browser:
166{{{
167 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or
168 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47]
169}}}
170 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or
171 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47]
172(Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.)
173
174Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead:
175{{{
176 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
177 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
178}}}
179 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
180 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
181
182=== InterWiki links ===
183
184Other 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.
185
186=== InterTrac links ===
187
188This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
189
190Any type of Trac link can be written in one Trac environment and actually refer to resources in another Trac environment. All that is required is to prefix the Trac link with the name of the other Trac environment followed by a colon. The other Trac environment must be registered on the InterTrac page.
191
192A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links (e.g. `{}`, `r`, `#`) can also be used. For example if T was set as an alias for Trac, links to Trac tickets can be written #T234, links to Trac changesets can be written [trac 1508].
193See InterTrac for the complete details.
194
195=== Server-relative links ===
196
197It is often useful to be able to link to objects in your project that
198have no built-in Trac linking mechanism, such as static resources, `newticket`,
199a shared `/register` page on the server, etc.
200
201To link to resources inside the project, use either an absolute path from the project root,
202or a relative link from the URL of the current page (''Changed in 0.11''):
203
204{{{
205[/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
206[/ home] or [[/|home]]
207}}}
208
209Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
210[/ home] or [[/|home]]
211
212To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''):
213
214{{{
215[//register Register Here] or [[//register|Register Here]]
216}}}
217
218Display: [//register Register Here] or [[//register|Register Here]]
219
220=== Quoting space in TracLinks ===
221
222Immediately after a TracLinks prefix, targets containing space characters should
223be enclosed in a pair of quotes or double quotes.
224Examples:
225 * !wiki:"The whitespace convention"
226 * !attachment:'the file.txt' or
227 * !attachment:"the file.txt"
228 * !attachment:"the file.txt:ticket:123"
229
230Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
231 * ![[The whitespace convention]]
232 * ![[attachment:the file.txt]]
233
234=== Escaping Links ===
235
236To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
237{{{
238 !NoLinkHere.
239 ![42] is not a link either.
240}}}
241
242Display:
243 !NoLinkHere.
244 ![42] is not a link either.
245
246
247=== Parameterized Trac links ===
248
249Many Trac resources have more than one way to be rendered, depending on 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.
250
251Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
252 - `wiki:WikiStart?format=txt`
253 - `ticket:1?version=1`
254 - `[/newticket?component=module1 create a ticket for module1]`
255 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
256
257
258== TracLinks Reference ==
259The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
260
261=== attachment: links ===
262
263The link syntax for attachments is as follows:
264 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
265 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
266 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
267
268Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
269
270If 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:`.
271
272This 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.
273
274See also [#export:links].
275
276=== comment: links ===
277
278When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
279It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
280 - `comment:3:ticket:123`
281 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
282It is also possible to link to the ticket's description using one of the following syntax:
283 - `comment:description` (within the ticket)
284 - `comment:description:ticket:123`
285 - `ticket:123#comment:description`
286
287=== htdocs: links ===
288
289Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory].
290
291=== query: links ===
292
293See TracQuery#UsingTracLinks and [#ticket:links].
294
295=== search: links ===
296
297See TracSearch#SearchLinks
298
299=== ticket: links ===
300 ''alias:'' `bug:`
301
302Besides 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.
303
304Example:
305 - `ticket:5000-6000`
306 - `ticket:1,150`
307
308=== timeline: links ===
309
310Links 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 if you don't want to compute the UTC time, you can specify a local time followed by your timezone offset relative to UTC.
311
312Examples:
313 - `timeline:2008-01-29`
314 - `timeline:2008-01-29T15:48`
315 - `timeline:2008-01-29T15:48Z`
316 - `timeline:2008-01-29T16:48+01`
317 - `timeline:2008-01-29T16:48+0100`
318 - `timeline:2008-01-29T16:48+01:00`
319
320=== wiki: links ===
321
322See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. It is possible to create a link to a specific page revision using the syntax WikiStart@1.
323
324=== Version Control related links ===
325
326It should be noted that multiple repository support works by creating a kind of virtual namespace for versioned files in which the toplevel folders correspond to the repository names. Therefore, in presence of multiple repositories, a ''/path'' specification in the syntax of links detailed below should start with the name of the repository. If omitted, the default repository is used. In case a toplevel folder of the default repository has the same name as a repository, the latter "wins". One can always access such folder by fully qualifying it (the default repository can be an alias of a named repository, or conversely, it is always possible to create an alias for the default repository, ask your Trac administrator).
327
328For example, `source:/trunk/COPYING` targets the path `/trunk/COPYING` in the default repository, whereas `source:/projectA/trunk/COPYING` targets the path `/trunk/COPYING` in the repository named `projectA`. This can be the same file if `'projectA'` is an alias to the default repository or if `''` (the default repository) is an alias to `'projectA'`.
329
330==== source: links ====
331 ''aliases:'' `browser:`, `repos:`
332
333The default behavior for a `source:/some/path link` is to open the browser in that directory directory
334if the path points to a directory or to show the latest content of the file.
335
336It's also possible to link directly to a specific revision of a file like this:
337 - `source:/some/file@123` - link to the file's revision 123
338 - `source:/some/file@head` - link explicitly to the latest revision of the file
339
340If the revision is specified, one can even link to a specific line number:
341 - `source:/some/file@123#L10`
342 - `source:/tag/0.10@head#L10`
343
344Finally, one can also highlight an arbitrary set of lines:
345 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99
346 - or without version number (the `@` is still needed): `source:/some/file@:10-20,100,103#L99`. Version can be omitted when the path is pointing to a source file that will no longer change (like `source:/tags/...`), otherwise it's better to specify which lines of //which version// of the file you're talking about
347
348Note that in presence of multiple repositories, the name of the repository is simply integrated in the path you specify for `source:` (e.g. `source:reponame/trunk/README`). ''(since 0.12)''
349
350==== export: links ====
351
352To 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:
353 * `export:/some/file` - get the HEAD revision of the specified file
354 * `export:123:/some/file` - get revision 123 of the specified file
355 * `export:/some/file@123` - get revision 123 of the specified file
356
357This 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.
358
359If 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`).
360
361==== log: links ====
362
363The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions of the specified path, but it can also support displaying an arbitrary set of revisions.
364 - `log:/` - the latest revisions starting at the root of the repository
365 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
366 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
367 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
368 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
369
370There are short forms for revision ranges as well:
371 - `[20788,20791:20795]`
372 - `[20788,20791:20795/trunk/tools]`
373 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
374
375Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
376
377In the presence of multiple repositories, the name of the repository should be specified as the first part of the path, e.g. `log:repos/branches` or `[20-40/repos]`.
378
379----
380See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
381 
Note: See TracBrowser for help on using the repository browser.