Changes between Version 2 and Version 3 of TracLinks
- Timestamp:
- Jun 18, 2010, 12:36:46 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v2 v3 17 17 and any other text fields explicitly marked as supporting WikiFormatting. 18 18 19 Some examples: 20 * Tickets: '''!#1''' or '''!ticket:1''' 21 * Ticket comments: '''!comment:ticket:1:2''' 22 * Reports: '''!{1}''' or '''!report:1''' 23 * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''', '''![2:5/trunk]''' 24 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' 25 * 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 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' 27 * Parent page: '''![..]''' 28 * Milestones: '''!milestone:1.0''' 29 * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' 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''' 33 Display: 34 * Tickets: #1 or ticket:1 35 * Ticket comments: comment:ticket:1:2 36 * Reports: {1} or report:1 37 * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk, [2:5/trunk] 38 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3 39 * 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 40 * Wiki pages: CamelCase or wiki:CamelCase 41 * Parent page: '''[..]''' 42 * Milestones: milestone:1.0 43 * Attachment: attachment:ticket:944:attachment.1073.diff 44 * Files: source:trunk/COPYING 45 * A specific file revision: source:/trunk/COPYING@200 46 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 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 Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk` 29 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]` 30 Diffs :: `diff:@1:3`, `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` 31 or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539` 32 Milestones :: `milestone:1.0` 33 Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path) 34 Files :: `source:trunk/COPYING` 35 A specific file revision :: `source:/trunk/COPYING@200` 36 A particular line of a specific file revision :: `source:/trunk/COPYING@200#L25` 37 }}} 38 {{{#!td 39 Wiki pages :: CamelCase or wiki:CamelCase 40 Parent page :: [..] 41 Tickets :: #1 or ticket:1 42 Ticket comments :: comment:1:ticket:2 43 Reports :: {1} or report:1 44 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk 45 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] 46 Diffs :: diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default 47 or diff:trunk/trac@3538//sandbox/vc-refactoring@3539 48 Milestones :: milestone:1.0 49 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path) 50 Files :: source:trunk/COPYING 51 A specific file revision :: source:/trunk/COPYING@200 52 A particular line of a specific file revision :: source:/trunk/COPYING@200#L25 53 }}} 47 54 48 55 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to … … 51 58 to links to Wiki page names. 52 59 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] 60 61 {{{#!table class="" 62 |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: || 63 {{{#!td 64 {{{ 65 [ticket:1 This is a link to ticket number one] or 66 [[ticket:1|This is another link to ticket number one]]. 67 }}} 68 }}} 69 {{{#!td 70 [ticket:1 This is a link to ticket number one] or 71 [[ticket:1|This is another link to ticket number one]]. 72 }}} 73 |-------------------------------------------------------------------------------------- 74 |||| If the title is omitted, only the id (the part after the colon) is displayed: || 75 {{{#!td 76 {{{ 77 [ticket:1] or [[ticket:2]] 78 }}} 79 }}} 80 {{{#!td 81 [ticket:1] or [[ticket:2]] 82 }}} 83 |-------------------------------------------------------------------------------------- 84 |||| `wiki` is the default if the namespace part of a full link is omitted: || 85 {{{#!td 86 {{{ 87 [SandBox the sandbox] or 88 [[SandBox|the sandbox]] 89 }}} 90 }}} 91 {{{#!td 92 [SandBox the sandbox] or 93 [[SandBox|the sandbox]] 94 }}} 95 |-------------------------------------------------------------------------------------- 96 |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >) || 97 {{{#!td 98 {{{ 99 <wiki:Strange(page@!)> 100 }}} 101 }}} 102 {{{#!td 103 <wiki:Strange(page@!)> 104 }}} 105 }}} 77 106 78 107 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. … … 85 114 To create a link to a specific anchor in a page, use '#': 86 115 {{{ 87 [#Relativelinks relative links] 116 [#Relativelinks relative links] or [[#Relativelinks|relative links]] 88 117 }}} 89 118 Displays: 90 [#Relativelinks relative links] 119 [#Relativelinks relative links] or [[#Relativelinks|relative links]] 91 120 92 121 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 122 94 To create a link to a SubWiki-page just use a '/':123 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 95 124 {{{ 96 125 WikiPage/SubWikiPage or ./SubWikiPage 97 126 }}} 98 127 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. 128 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 129 {{{ 130 [..] or [[..]] 131 }}} 132 [..] or [[..]] 133 134 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../': 135 {{{ 136 [../Sibling see next sibling] or [[../Sibling|see next sibling]] 137 }}} 138 [../Sibling see next sibling] or [[../Sibling|see next sibling]] 139 140 But in practice you often won't need to add the `../` prefix to link to a sibling page. 141 For resolving the location of a wiki link, it's the target page closest in the hierarchy 142 to the page where the link is written which will be selected. So for example, within 143 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page. 144 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 145 146 In order to link explicitly to a [=#toplevel toplevel] Wiki page, 147 use the `wiki:/` prefix. 148 Be careful **not** to use the `/` prefix alone, as this corresponds to the 149 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/` 150 part in the resulting URL. 151 152 ''(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 since 0.11, such a link will stay in the wiki namespace and therefore link to a sibling page. 153 See [#Server-relativelinks] for the new syntax. 110 154 111 155 === InterWiki links === … … 117 161 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 118 162 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]. 163 Any 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. 164 165 A 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]. 166 See InterTrac for the complete details. 122 167 123 168 === Server-relative links === … … 131 176 132 177 {{{ 133 [/newticket Create a new ticket] 134 [/ home] 135 }}} 136 137 Display: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]] [/ home] 138 139 To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''): 140 141 {{{ 142 [//register Register Here] 143 }}} 144 145 Display: [//register Register Here] 178 [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 179 [/ home] or [[/|home]] 180 }}} 181 182 Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 183 [/ home] or [[/|home]] 184 185 To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''): 186 187 {{{ 188 [//register Register Here] or [[//register|Register Here]] 189 }}} 190 191 Display: [//register Register Here] or [[//register|Register Here]] 146 192 147 193 === Quoting space in TracLinks === … … 153 199 * !attachment:'the file.txt' or 154 200 * !attachment:"the file.txt" 155 * !attachment:"ticket:123:the file.txt" 201 * !attachment:"the file.txt:ticket:123" 202 203 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces: 204 * ![[The whitespace convention]] 205 * ![[attachment:the file.txt]] 156 206 157 207 === Escaping Links === … … 170 220 === Parameterized Trac links === 171 221 172 The Trac links target Trac resources which have generally more than one way to be rendered, according tosome 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 AnyTrac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:222 Many 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. 223 224 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 225 - `wiki:WikiStart?format=txt` 176 226 - `ticket:1?version=1` 177 227 - `[/newticket?component=module1 create a ticket for module1]` 228 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 178 229 179 230 180 231 == TracLinks Reference == 181 The following sections describe the individual link types in detail, as well as several notesadvanced usage of links.232 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 182 233 183 234 === attachment: links === … … 185 236 The link syntax for attachments is as follows: 186 237 * !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 238 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page 239 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 240 241 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt. 242 243 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:`. 244 245 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. 246 247 See also [#export:links]. 248 249 === comment: links === 250 251 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. 252 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 253 - `comment:3:ticket:123` 254 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!) 255 It is also possible to link to the ticket's description using one of the following syntax: 256 - `comment:description` (within the ticket) 257 - `comment:description:ticket:123` 258 - `ticket:123#comment:description` 189 259 190 260 === query: links === … … 197 267 198 268 === ticket: links === 269 ''alias:'' `bug:` 199 270 200 271 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. … … 213 284 - `timeline:2008-01-29` 214 285 - `timeline:2008-01-29T15:48` 215 - `timeline:2008-01-29T16:48Z+01` 286 - `timeline:2008-01-29T15:48Z` 287 - `timeline:2008-01-29T16:48+01` 216 288 217 289 ''(since Trac 0.11)'' … … 223 295 === Version Control related links === 224 296 ==== 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. 297 ''aliases:'' `browser:`, `repos:` 298 299 The default behavior for a source:/some/path link is to open the browser in that directory directory 300 if the path points to a directory or to show the latest content of the file. 228 301 229 302 It's also possible to link directly to a specific revision of a file like this: … … 237 310 Finally, one can also highlight an arbitrary set of lines: 238 311 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. 239 ''(since 0.11)'' 312 ''(since 0.11)'' 313 314 Note 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)'' 240 315 241 316 ==== export: links ==== … … 246 321 * `export:/some/file@123` - get revision 123 of the specified file 247 322 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` .323 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. 324 325 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 326 252 327 ==== log: links ==== 253 328 254 The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions fromthe specified path, but it can also support displaying an arbitrary set of revisions.329 The `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. 255 330 - `log:/` - the latest revisions starting at the root of the repository 256 331 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 257 332 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000 258 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range259 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 rangewhich affect the given path333 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 334 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path 260 335 261 336 There are short forms for revision ranges as well: … … 264 339 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`) 265 340 266 Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`. 341 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`. 342 343 In 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]`. 267 344 268 345 ----