Changes between Version 7 and Version 8 of TracLinks
- Timestamp:
- Aug 1, 2024, 10:29:33 AM (5 weeks ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v7 v8 4 4 [[PageOutline(2-5,Contents,pullout)]] 5 5 6 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 anywherewhere WikiFormatting is used.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 7 8 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. … … 32 32 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]` 33 33 Diffs :: `diff:@1:3`, `diff:plugins/0.12/mercurial-plugin@9128:9953`, 34 `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` 35 35 or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539` 36 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) 37 37 }}} 38 38 {{{#!td … … 40 40 Parent page :: [..] 41 41 Tickets :: #1 or ticket:1 42 Ticket comments :: comment:1:ticket:2 42 Ticket comments :: comment:1:ticket:2 43 43 Reports :: {1} or report:1 44 44 Milestones :: milestone:1.0 … … 47 47 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] 48 48 Diffs :: diff:@1:3, diff:plugins/0.12/mercurial-plugin@9128:9953, 49 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 50 50 or diff:trunk/trac@3538//sandbox/vc-refactoring@3539 51 Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25) 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 52 }}} 53 53 … … 78 78 }}} 79 79 |-------------------------------------------------------------------------------------- 80 |||| `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: || 81 81 {{{#!td 82 82 {{{ … … 99 99 <wiki:Strange(page@!)> 100 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 }}} 101 111 }}} 102 112 … … 125 135 126 136 But in practice you often won't need to add the `../` prefix to link to a sibling page. 127 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.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. 128 138 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 129 139 … … 132 142 === Link anchors 133 143 134 To create a link to a specific anchor in a page, use '#':144 To create a link to a specific anchor in a page, use `#`: 135 145 {{{ 136 146 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] … … 138 148 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 139 149 140 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. 141 142 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 `#?`: 143 159 {{{ 144 160 [#/Milestone first occurrence of Milestone] or … … 147 163 [#/Milestone first occurrence of Milestone] or 148 164 [#?Milestone last occurrence of Milestone] 149 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`: 150 166 {{{ 151 167 [#/Milestone/i first occurrence of Milestone or milestone] or … … 166 182 (Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.) 167 183 168 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: 169 185 {{{ 170 186 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or … … 182 198 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 183 199 184 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. 185 186 A distinct ive 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].187 See InterTrac for the complete details. 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. 188 204 189 205 === Server-relative links … … 215 231 * !wiki:"The whitespace convention" 216 232 * !attachment:'the file.txt' or 217 * !attachment:"the file.txt" 218 * !attachment:"the file.txt:ticket:123" 233 * !attachment:"the file.txt" 234 * !attachment:"the file.txt:ticket:123" 219 235 220 236 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces: … … 251 267 252 268 The link syntax for attachments is as follows: 253 * !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 254 270 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page 255 271 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 256 272 257 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. 258 274 259 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:`. 260 276 261 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. 262 278 263 279 See also [#export:links]. … … 267 283 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. 268 284 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 269 - `comment:3:ticket:123` 285 - `comment:3:ticket:123` 270 286 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!) 271 287 It is also possible to link to the ticket's description using one of the following syntax: … … 284 300 === search: links 285 301 286 See TracSearch#Search Links302 See TracSearch#SearchTracLinks 287 303 288 304 === ticket: links 289 305 290 ''alias :'' `bug:`306 ''aliases:'' `bug:`, `issue:` 291 307 292 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. 293 309 294 Example: 310 Example: 295 311 - `ticket:5000-6000` 296 312 - `ticket:1,150` … … 312 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. 313 329 314 === Version Control relatedlinks315 316 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. 317 333 318 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'`. … … 348 364 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial). 349 365 350 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.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. 351 367 352 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`). … … 358 374 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 359 375 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000 360 - `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 361 377 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path 362 378 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial) … … 369 385 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`. 370 386 371 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` 372 393 373 394 ---- 374 395 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 375