Changes between Version 4 and Version 5 of TracLinks
- Timestamp:
- Aug 2, 2024, 3:31:43 PM (5 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v4 v5 1 = Trac Links = 1 = Trac Links 2 2 3 [[TracGuideToc]] 3 4 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 6 TracLinks are generally of the form '''type:id''' (where ''id'' represents the 7 number, name or path of the item) though some frequently used kinds of items 8 also have short-hand notations. 9 10 == Where to use TracLinks == 4 [[PageOutline(2-5,Contents,pullout)]] 5 6 TracLinks are a fundamental feature of Trac, allowing 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. 7 8 TracLinks are generally of the form '''type:id''' (where ''id'' represents the number, name or path of the item) though some frequently used kinds of items also have short-hand notations. 9 10 == Where to use TracLinks 11 11 12 You can use TracLinks in: 12 13 … … 17 18 and any other text fields explicitly marked as supporting WikiFormatting. 18 19 19 == Overview ==20 == Overview 20 21 21 22 ||= Wiki Markup =||= Display =|| … … 28 29 Milestones :: `milestone:1.0` 29 30 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` 31 Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`, `[1/repository]` 31 32 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]` 32 33 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 `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` 34 35 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 Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25), `source:/trunk/COPYING@200:27-30#L25` (at version 200, line 25, highlighting lines 27-30) 36 37 }}} 37 38 {{{#!td … … 39 40 Parent page :: [..] 40 41 Tickets :: #1 or ticket:1 41 Ticket comments :: comment:1:ticket:2 42 Ticket comments :: comment:1:ticket:2 42 43 Reports :: {1} or report:1 43 44 Milestones :: milestone:1.0 44 45 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 46 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk, [1/repository] 46 47 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] 47 48 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 diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default 49 50 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 54 pages whose names do not follow WikiPageNames rules, i.e., single words, 55 non-alphabetic characters, etc. See WikiPageNames for more about features specific 56 to links to Wiki page names. 51 Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25) source:/trunk/COPYING@200:28-31#L25 (at version 200, line 25, highlighting lines 28-31) 52 }}} 53 54 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to pages whose names do not follow WikiPageNames rules, ie single words, non-alphabetic characters, etc. See WikiPageNames for more about features specific to links to Wiki page names. 57 55 58 56 … … 80 78 }}} 81 79 |-------------------------------------------------------------------------------------- 82 |||| `wiki` is the default if the namespace part of a full link is omitted: || 80 |||| `wiki` is the default if the namespace part of a full link is omitted: || 83 81 {{{#!td 84 82 {{{ … … 101 99 <wiki:Strange(page@!)> 102 100 }}} 101 |-------------------------------------------------------------------------------------- 102 |||| Quoting can be used with the full notation to allow brackets in the label. || 103 {{{#!td 104 {{{ 105 [TracIni#logging-log_type-option "[logging] log_type"] 106 }}} 107 }}} 108 {{{#!td 109 [TracIni#logging-log_type-option "[logging] log_type"] 110 }}} 103 111 }}} 104 112 105 113 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. 106 114 107 108 == Advanced use of TracLinks == 109 110 === Relative links === 115 == Advanced use of TracLinks 116 117 === Relative links 111 118 112 119 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': … … 128 135 129 136 But in practice you often won't need to add the `../` prefix to link to a sibling page. 130 For resolving the location of a wiki link, it's the target page closest in the hierarchy 131 to the page where the link is written which will be selected. So for example, within 132 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page. 137 For resolving the location of a wiki link, it's the target page closest in the hierarchy to the page where the link is written which will be selected. So for example, within a sub-hierarchy, a sibling page will be targeted in preference to a top-level page. 133 138 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 134 139 135 In order to link explicitly to a [=#toplevel toplevel] Wiki page, 136 use the `wiki:/` prefix. 137 Be careful **not** to use the `/` prefix alone, as this corresponds to the 138 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/` 139 part in the resulting URL. 140 141 ''(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. 142 See [#Server-relativelinks] for the new syntax. 143 144 === Link anchors === 145 146 To create a link to a specific anchor in a page, use '#': 140 To link explicitly to a [=#toplevel toplevel] Wiki page, use 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. 141 142 === Link anchors 143 144 To create a link to a specific anchor in a page, use `#`: 147 145 {{{ 148 146 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] … … 150 148 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 151 149 152 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. 153 154 To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?': 150 To create an anchor in a page, use `[=#...]`: 151 {{{ 152 [=#myanchor my anchor] or empty form [=#myanchor] 153 }}} 154 [=#myanchor my anchor] or empty form [=#myanchor] 155 156 Hint: when you hover 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. 157 158 To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with `#/` or `#?`: 155 159 {{{ 156 160 [#/Milestone first occurrence of Milestone] or … … 159 163 [#/Milestone first occurrence of Milestone] or 160 164 [#?Milestone last occurrence of Milestone] 161 This 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':165 This 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`: 162 166 {{{ 163 167 [#/Milestone/i first occurrence of Milestone or milestone] or … … 178 182 (Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.) 179 183 180 Since such links become outdated when the file changes, it can be useful to link using a '#/'pseudo anchor instead:184 Since such links become outdated when the file changes, it can be useful to link using a `#/` pseudo anchor instead: 181 185 {{{ 182 186 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or … … 186 190 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 187 191 188 === InterWiki links ===189 190 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.191 192 === InterTrac links ===192 === InterWiki links 193 194 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 is a more specialized way to register other Trac environments which offers greater flexibility. 195 196 === InterTrac links 193 197 194 198 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 195 199 196 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. 197 198 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]. 199 See InterTrac for the complete details. 200 201 === Server-relative links === 202 203 It is often useful to be able to link to objects in your project that 204 have no built-in Trac linking mechanism, such as static resources, `newticket`, 205 a shared `/register` page on the server, etc. 206 207 To link to resources inside the project, use either an absolute path from the project root, 208 or a relative link from the URL of the current page (''Changed in 0.11''): 200 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. 201 202 A distinct advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links can also be used, such as `{}`, `r`, `#`. For example, if T was set as an alias for Trac, then links to Trac tickets can be written as #T234, and links to Trac changesets can be written as [trac 1508]. 203 See InterTrac for the complete details. 204 205 === Server-relative links 206 207 It is often useful to be able to link to objects in your project that have no built-in Trac linking mechanism, such as static resources, `newticket`, a shared `/register` page on the server, etc. 208 209 To link to resources inside the project, use either an absolute path from the project root, or a relative link from the URL of the current page (''Changed in 0.11''): 209 210 210 211 {{{ … … 224 225 Display: [//register Register Here] or [[//register|Register Here]] 225 226 226 === Quoting space in TracLinks === 227 228 Immediately after a TracLinks prefix, targets containing space characters should 229 be enclosed in a pair of quotes or double quotes. 227 === Quoting space in TracLinks 228 229 Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes. 230 230 Examples: 231 231 * !wiki:"The whitespace convention" 232 232 * !attachment:'the file.txt' or 233 * !attachment:"the file.txt" 234 * !attachment:"the file.txt:ticket:123" 233 * !attachment:"the file.txt" 234 * !attachment:"the file.txt:ticket:123" 235 235 236 236 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces: … … 238 238 * ![[attachment:the file.txt]] 239 239 240 === Escaping Links ===240 === Escaping Links 241 241 242 242 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). … … 250 250 ![42] is not a link either. 251 251 252 253 === Parameterized Trac links === 252 === Parameterized Trac links 254 253 255 254 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. … … 261 260 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 262 261 263 264 == TracLinks Reference == 262 == TracLinks Reference 263 265 264 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 266 265 267 === attachment: links ===266 === attachment: links 268 267 269 268 The link syntax for attachments is as follows: 270 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object269 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current page 271 270 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page 272 271 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 273 272 274 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt .273 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt, but is not recommended. 275 274 276 275 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:`. 277 276 278 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.277 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 [[TracIni#attachment-render_unsafe_content-option|"[attachment] render_unsafe_content"]] = `enabled`. Caveat: only do that in environments for which you're 100% confident you can trust the people who are able to attach files, as this opens up your site to [https://en.wikipedia.org/wiki/Cross-site_scripting cross-site scripting] attacks. 279 278 280 279 See also [#export:links]. 281 280 282 === comment: links ===281 === comment: links 283 282 284 283 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. 285 284 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 286 - `comment:3:ticket:123` 285 - `comment:3:ticket:123` 287 286 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!) 288 287 It is also possible to link to the ticket's description using one of the following syntax: … … 291 290 - `ticket:123#comment:description` 292 291 293 === htdocs: links ===292 === htdocs: links 294 293 295 294 Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory]. 296 295 297 === query: links ===296 === query: links 298 297 299 298 See TracQuery#UsingTracLinks and [#ticket:links]. 300 299 301 === search: links === 302 303 See TracSearch#SearchLinks 304 305 === ticket: links === 306 ''alias:'' `bug:` 300 === search: links 301 302 See TracSearch#SearchTracLinks 303 304 === ticket: links 305 306 ''aliases:'' `bug:`, `issue:` 307 307 308 308 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. 309 309 310 Example: 310 Example: 311 311 - `ticket:5000-6000` 312 312 - `ticket:1,150` 313 313 314 ''(since Trac 0.11)'' 315 316 === timeline: links === 317 318 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. 314 === timeline: links 315 316 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 if you don't want to compute the UTC time, you can specify a local time followed by your timezone offset relative to UTC. 319 317 320 318 Examples: … … 323 321 - `timeline:2008-01-29T15:48Z` 324 322 - `timeline:2008-01-29T16:48+01` 325 326 ''(since Trac 0.11)'' 327 328 === wiki: links ===323 - `timeline:2008-01-29T16:48+0100` 324 - `timeline:2008-01-29T16:48+01:00` 325 326 === wiki: links 329 327 330 328 See 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. 331 329 332 === Version Control related links ===333 334 It 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 l atter "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).330 === Version Control system links 331 332 It 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 link directs to the latter. One can always access such folder by fully qualifying it. The default repository can be an alias of a named repository, or conversely, there may be one or more aliases for the default repository, ask your Trac administrator. 335 333 336 334 For 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'`. 337 335 338 ==== source: links ==== 336 ==== source: links 337 339 338 ''aliases:'' `browser:`, `repos:` 340 339 341 The default behavior for a source:/some/path link is to open the browser in that directory directory 342 if the path points to a directory or to show the latest content of the file. 340 The default behavior for a `source:/some/path link` is to open the browser in that directory directory if the path points to a directory or to show the latest content of the file. 343 341 344 342 It's also possible to link directly to a specific revision of a file like this: 345 343 - `source:/some/file@123` - link to the file's revision 123 346 344 - `source:/some/file@head` - link explicitly to the latest revision of the file 345 - `source:/some/file@named-branch` - link to latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial) 347 346 348 347 If the revision is specified, one can even link to a specific line number: 349 348 - `source:/some/file@123#L10` 350 349 - `source:/tag/0.10@head#L10` 350 - `source:/some/file@named-branch#L10` 351 351 352 352 Finally, one can also highlight an arbitrary set of lines: 353 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103 .354 ''(since 0.11)''353 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99 354 - 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. 355 355 356 356 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)'' 357 357 358 ==== export: links ====358 ==== export: links 359 359 360 360 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: … … 362 362 * `export:123:/some/file` - get revision 123 of the specified file 363 363 * `export:/some/file@123` - get revision 123 of the specified file 364 365 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. 364 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial). 365 366 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 [[TracIni#browser-render_unsafe_content-option|"[browser] render_unsafe_content"]] = `enabled`, otherwise Trac will force the files to be downloaded as attachments for security concerns. 366 367 367 368 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`). 368 369 369 ==== log: links ====370 ==== log: links 370 371 371 372 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. … … 373 374 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 374 375 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000 375 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 376 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 376 377 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path 378 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial) 377 379 378 380 There are short forms for revision ranges as well: … … 383 385 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`. 384 386 385 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]`. 387 ==== Multi-repository links 388 389 In the presence of multiple repositories, the name of the repository should be specified as the first part of the path: 390 - `log:repos/branch` 391 - `[20-40/repos]` 392 - `r20/repos` 386 393 387 394 ---- 388 395 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 389