Changes between Version 1 and Version 2 of TracLinks
- Timestamp:
- 01/02/10 17:05:00 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v1 v2 1 1 = Trac Links = 2 [[TracGuideToc]]3 4 2 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 3 … … 8 6 also have short-hand notations. 9 7 10 == Where to use TracLinks ==11 You can use TracLinks in:12 13 * Source code (Subversion) commit messages14 * Wiki pages15 * Full descriptions for tickets, reports and milestones16 17 and any other text fields explicitly marked as supporting WikiFormatting.18 19 8 Some examples: 20 9 * Tickets: '''!#1''' or '''!ticket:1''' 21 * Ticket comments: '''!comment: 1:ticket:2'''10 * Ticket comments: '''!comment:ticket:1:2''' 22 11 * Reports: '''!{1}''' or '''!report:1''' 23 12 * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' 24 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' , '''![2:5/trunk]'''25 * 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'''13 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' 14 * 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''' 26 15 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' 27 * Parent page: '''![..]'''28 16 * Milestones: '''!milestone:1.0''' 29 * Attachment: '''!attachment:example.tgz''' (for current page attachment), '''!attachment:attachment.1073.diff:ticket:944''' 30 (absolute path) 17 * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' 31 18 * Files: '''!source:trunk/COPYING''' 32 19 * A specific file revision: '''!source:/trunk/COPYING@200''' … … 34 21 Display: 35 22 * Tickets: #1 or ticket:1 36 * Ticket comments: comment: 1:ticket:223 * Ticket comments: comment:ticket:1:2 37 24 * Reports: {1} or report:1 38 * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk39 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3 , [2:5/trunk]40 * 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@353925 * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk 26 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3 27 * Diffs (requires [milestone:0.10 0.10]): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539 41 28 * Wiki pages: CamelCase or wiki:CamelCase 42 * Parent page: [..]43 29 * Milestones: milestone:1.0 44 * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 45 (absolute path) 30 * Attachment: attachment:ticket:944:attachment.1073.diff 46 31 * Files: source:trunk/COPYING 47 32 * A specific file revision: source:/trunk/COPYING@200 … … 62 47 Display: [ticket:1 This is a link to ticket number one]. 63 48 64 If the title is omitted, only the id (the part after the colon) is displayed:49 If the title is be omitted, only the id (the part after the colon) is displayed: 65 50 66 51 {{{ … … 80 65 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. 81 66 67 The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 82 68 83 == Advanced use of TracLinks ==69 == attachment: links == 84 70 85 === Relative links === 71 The link syntax for attachments is as follows: 72 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 73 * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page 74 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 86 75 87 To create a link to a specific anchor in a page, use '#': 76 == source: links == 77 78 The default behavior for a source:/some/path link is to open the directory browser 79 if the path points to a directory and otherwise open the log view. 80 It's also possible to link directly to a specific revision of a file like this: source:/some/file@123 81 or like this to link to the latest revision: source:/some/file@latest. 82 If the revision is specified, one can even link to a specific line number: source:/some/file@123#L10 83 84 == search: and query: links == 85 86 See TracSearch#SearchLinks and TracQuery#UsingTracLinks 87 88 == !SubWiki links == 89 To create a SubWiki link to a SubWiki-page just use a '/': 88 90 {{{ 89 [#Relativelinks relative links] 90 }}} 91 Displays: 92 [#Relativelinks relative links] 93 94 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 96 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 97 {{{ 98 WikiPage/SubWikiPage or ./SubWikiPage 91 [wiki:WikiPage/SubWikiPage]. 99 92 }}} 100 93 101 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 102 {{{ 103 [..] 104 }}} 105 106 To link from a [trac:SubWiki SubWiki] page to a sibling page, use a '../': 107 {{{ 108 [../Sibling see next sibling] 109 }}} 110 111 ''(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 113 === InterWiki links === 94 == InterWiki links == 114 95 115 96 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 97 117 == = InterTrac links ===98 == InterTrac links == 118 99 119 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 100 Any of the above form 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. See InterTrac for details. 120 101 121 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 102 123 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]. 103 == Server-relative links == 124 104 125 === Server-relative links === 126 127 It is often useful to be able to link to objects in your project that 128 have no built-in Trac linking mechanism, such as static resources, `newticket`, 129 a shared `/register` page on the server, etc. 130 131 To link to resources inside the project, use either an absolute path from the project root, 132 or a relative link from the URL of the current page (''Changed in 0.11''): 105 It is often useful to be able to link to objects on your server that have no built-in 106 Trac linking mechanism, such as static resources, a `/register` page, etc. This 107 can be achieved by simply using either an absolute path from the server root, 108 or a relative link from the URL of the current page: 133 109 134 110 {{{ 135 [ /newticket Create a newticket]111 [../newticket newticket] 136 112 [/ home] 137 113 }}} 138 114 139 Display: [ /newticket newticket] [/ home]115 Display: [../newticket newticket] [/ home] 140 116 141 To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''): 142 143 {{{ 144 [//register Register Here] 145 }}} 146 147 Display: [//register Register Here] 148 149 === Quoting space in TracLinks === 117 == Quoting space in TracLinks == 150 118 151 119 Immediately after a TracLinks prefix, targets containing space characters should … … 155 123 * !attachment:'the file.txt' or 156 124 * !attachment:"the file.txt" 157 * !attachment:"t he file.txt:ticket:123"125 * !attachment:"ticket:123:the file.txt" 158 126 159 === Escaping Links === 127 == Where to use TracLinks == 128 You can use TracLinks in: 129 130 * Source code (Subversion) commit messages 131 * Wiki pages 132 * Full descriptions for tickets, reports and milestones 133 134 and any other text fields explicitly marked as supporting WikiFormatting. 135 136 == Escaping Links == 160 137 161 138 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). … … 169 146 ![42] is not a link either. 170 147 171 172 === Parameterized Trac links ===173 174 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.175 176 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:177 - `wiki:WikiStart?format=txt`178 - `ticket:1?version=1`179 - `[/newticket?component=module1 create a ticket for module1]`180 181 182 == TracLinks Reference ==183 The following sections describe the individual link types in detail, as well as several notes advanced usage of links.184 185 === attachment: links ===186 187 The link syntax for attachments is as follows:188 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object189 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page190 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753191 192 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.193 194 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:`.195 196 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.197 198 See also [#export:links].199 200 === comment: links ===201 202 When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment.203 It's also possible to link to a comment of a specific ticket from anywhere using one of the following syntax:204 - !comment:3:ticket:123205 - !ticket:123#comment:3 (note that you can't write !#123#!comment:3!)206 207 === query: links ===208 209 See TracQuery#UsingTracLinks and [#ticket:links].210 211 === search: links ===212 213 See TracSearch#SearchLinks214 215 === ticket: links ===216 217 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.218 219 Example:220 - `ticket:5000-6000`221 - `ticket:1,150`222 223 ''(since Trac 0.11)''224 225 === timeline: links ===226 227 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.228 229 Examples:230 - `timeline:2008-01-29`231 - `timeline:2008-01-29T15:48`232 - `timeline:2008-01-29T16:48Z+01`233 234 ''(since Trac 0.11)''235 236 === wiki: links ===237 238 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.239 240 === Version Control related links ===241 ==== source: links ====242 243 The default behavior for a source:/some/path link is to open the directory browser244 if the path points to a directory and otherwise open the log view.245 246 It's also possible to link directly to a specific revision of a file like this:247 - `source:/some/file@123` - link to the file's revision 123248 - `source:/some/file@head` - link explicitly to the latest revision of the file249 250 If the revision is specified, one can even link to a specific line number:251 - `source:/some/file@123#L10`252 - `source:/tag/0.10@head#L10`253 254 Finally, one can also highlight an arbitrary set of lines:255 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.256 ''(since 0.11)''257 258 ==== export: links ====259 260 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:261 * `export:/some/file` - get the HEAD revision of the specified file262 * `export:123:/some/file` - get revision 123 of the specified file263 * `export:/some/file@123` - get revision 123 of the specified file264 265 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.266 267 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`).268 269 ==== log: links ====270 271 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.272 - `log:/` - the latest revisions starting at the root of the repository273 - `log:/trunk/tools` - the latest revisions in `trunk/tools`274 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000275 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range276 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path277 278 There are short forms for revision ranges as well:279 - `[20788,20791:20795]`280 - `[20788,20791:20795/trunk/tools]`281 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)282 283 Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`.284 285 148 ---- 286 149 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki