| |
1 |
= Trac Links = |
| |
2 |
As you might have guessed, TracLinks are a very fundamental feature of Trac. |
| |
3 |
|
| |
4 |
They allow hyperlinking between Trac entities (tickets, reports, changesets, Wiki |
| |
5 |
pages, milestones and source files) from anywhere WikiFormatting is used. |
| |
6 |
|
| |
7 |
TracLinks are generally of the form '''item:id''' (where ''id'' represents the |
| |
8 |
number, name or path of the item) though some frequently used kinds of items |
| |
9 |
also have short-hand, alternative, notations. |
| |
10 |
|
| |
11 |
Some examples: |
| |
12 |
|
| |
13 |
* Tickets: '''!#1''' or '''!ticket:1''' |
| |
14 |
* Reports: '''!{1}''' or '''!report:1''' |
| |
15 |
* Changesets: '''![1]''' or '''!changeset:1''' |
| |
16 |
* Wiki pages: '''CamelCase''' or '''!wiki:CamelCase''' |
| |
17 |
* Milestones: '''!milestone:1.0''' |
| |
18 |
* Files: '''!source:trunk/COPYING''' |
| |
19 |
|
| |
20 |
Display: |
| |
21 |
* Tickets: #1 or ticket:1 |
| |
22 |
* Reports: {1} or report:1 |
| |
23 |
* Changesets: [1] or changeset:1 |
| |
24 |
* Wiki pages: CamelCase or wiki:CamelCase |
| |
25 |
* Milestones: milestone:1.0 |
| |
26 |
* Files: source:trunk/COPYING |
| |
27 |
|
| |
28 |
'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to |
| |
29 |
pages whose names do not follow WikiPageNames rules, i.e., single words, |
| |
30 |
non-alphabetic characters, etc. |
| |
31 |
|
| |
32 |
Trac links using the full (non-shorthand) notation can also be given a custom |
| |
33 |
link title like this: |
| |
34 |
|
| |
35 |
{{{ |
| |
36 |
[ticket:1 This is a link to ticket number one]. |
| |
37 |
}}} |
| |
38 |
|
| |
39 |
Display: |
| |
40 |
|
| |
41 |
[ticket:1 This is a link to ticket number one]. |
| |
42 |
|
| |
43 |
It might seem a simple enough concept at a glance, but actually allows quite a complex network of information. |
| |
44 |
|
| |
45 |
In practice though, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's |
| |
46 |
happening in a project or why a particular change was made. |
| |
47 |
|
| |
48 |
== source: links == |
| |
49 |
The default behavior for a source:/some/path link is to open the directory browser if the path points |
| |
50 |
to a directory and otherwise open the log view. It's also possible to link directly to a specific |
| |
51 |
revision of a file like this: source:/some/file#123 or like this to link to the latest revision: |
| |
52 |
source:/some/file#latest. |
| |
53 |
|
| |
54 |
== Where to use TracLinks == |
| |
55 |
You can use TracLinks in: |
| |
56 |
|
| |
57 |
* Source code (Subversion) commit messages |
| |
58 |
* Wiki pages |
| |
59 |
* Full descriptions for tickets, reports and milestones |
| |
60 |
|
| |
61 |
and any other text fields explicitly marked as supporting WikiFormatting. |
| |
62 |
|
| |
63 |
== Escaping TracLinks == |
| |
64 |
To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). |
| |
65 |
|
| |
66 |
{{{ |
| |
67 |
!NoLinkHere. |
| |
68 |
![42] is not a link either. |
| |
69 |
}}} |
| |
70 |
|
| |
71 |
Display: |
| |
72 |
!NoLinkHere. |
| |
73 |
![42] is not a link either. |
| |
74 |
|
| |
75 |
---- |
| |
76 |
See also: WikiFormatting, TracWiki |
| |
77 |
|
