Changes between Version 1 and Version 2 of TracLinks
- Timestamp:
- May 9, 2017, 5:01:29 PM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v1 v2 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, 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 where 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`, … … 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, … … 51 52 }}} 52 53 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. 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 … … 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 118 119 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 120 {{{ 121 WikiPage/SubWikiPage or ./SubWikiPage 122 }}} 123 124 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 125 {{{ 126 [..] or [[..]] 127 }}} 128 [..] or [[..]] 129 130 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../': 131 {{{ 132 [../Sibling see next sibling] or [[../Sibling|see next sibling]] 133 }}} 134 [../Sibling see next sibling] or [[../Sibling|see next sibling]] 135 136 But in practice you often won't need to add the `../` prefix to link to a sibling 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 toplevel page. 138 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 139 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 111 143 112 144 To create a link to a specific anchor in a page, use '#': 113 145 {{{ 114 [#Relativelinks relative links] or [[#Relativelinks|relative links]] 115 }}} 116 Displays: 117 [#Relativelinks relative links] or [[#Relativelinks|relative links]] 146 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 147 }}} 148 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 118 149 119 150 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. 120 151 121 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 122 {{{ 123 WikiPage/SubWikiPage or ./SubWikiPage 124 }}} 125 126 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 127 {{{ 128 [..] or [[..]] 129 }}} 130 [..] or [[..]] 131 132 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../': 133 {{{ 134 [../Sibling see next sibling] or [[../Sibling|see next sibling]] 135 }}} 136 [../Sibling see next sibling] or [[../Sibling|see next sibling]] 137 138 But in practice you often won't need to add the `../` prefix to link to a sibling page. 139 For resolving the location of a wiki link, it's the target page closest in the hierarchy 140 to the page where the link is written which will be selected. So for example, within 141 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page. 142 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 143 144 In order to link explicitly to a [=#toplevel toplevel] Wiki page, 145 use the `wiki:/` prefix. 146 Be careful **not** to use the `/` prefix alone, as this corresponds to the 147 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/` 148 part in the resulting URL. 149 150 ''(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. 151 See [#Server-relativelinks] for the new syntax. 152 153 === InterWiki links === 154 155 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. 156 157 === InterTrac links === 152 To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?': 153 {{{ 154 [#/Milestone first occurrence of Milestone] or 155 [#?Milestone last occurrence of Milestone] 156 }}} 157 [#/Milestone first occurrence of Milestone] or 158 [#?Milestone last occurrence of Milestone] 159 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': 160 {{{ 161 [#/Milestone/i first occurrence of Milestone or milestone] or 162 [#?Milestone/i last occurrence of Milestone or milestone] 163 }}} 164 [#/Milestone/i first occurrence of Milestone or milestone] or 165 [#?Milestone/i last occurrence of Milestone or milestone] 166 167 ''(since Trac 1.0)'' 168 169 Such anchors can be very useful for linking to specific lines in a file in the source browser: 170 {{{ 171 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or 172 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47] 173 }}} 174 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or 175 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47] 176 (Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.) 177 178 Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead: 179 {{{ 180 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or 181 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 182 }}} 183 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or 184 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 185 186 === InterWiki links 187 188 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. 189 190 === InterTrac links 158 191 159 192 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. … … 164 197 See InterTrac for the complete details. 165 198 166 === Server-relative links === 167 168 It is often useful to be able to link to objects in your project that 169 have no built-in Trac linking mechanism, such as static resources, `newticket`, 170 a shared `/register` page on the server, etc. 171 172 To link to resources inside the project, use either an absolute path from the project root, 173 or a relative link from the URL of the current page (''Changed in 0.11''): 199 === Server-relative links 200 201 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. 202 203 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''): 174 204 175 205 {{{ … … 189 219 Display: [//register Register Here] or [[//register|Register Here]] 190 220 191 === Quoting space in TracLinks === 192 193 Immediately after a TracLinks prefix, targets containing space characters should 194 be enclosed in a pair of quotes or double quotes. 221 === Quoting space in TracLinks 222 223 Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes. 195 224 Examples: 196 225 * !wiki:"The whitespace convention" … … 203 232 * ![[attachment:the file.txt]] 204 233 205 === Escaping Links ===234 === Escaping Links 206 235 207 236 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). … … 215 244 ![42] is not a link either. 216 245 217 218 === Parameterized Trac links === 246 === Parameterized Trac links 219 247 220 248 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. … … 226 254 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 227 255 228 229 == TracLinks Reference == 256 == TracLinks Reference 257 230 258 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 231 259 232 === attachment: links ===260 === attachment: links 233 261 234 262 The link syntax for attachments is as follows: … … 237 265 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 238 266 239 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt .267 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt, but is not recommended. 240 268 241 269 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:`. … … 245 273 See also [#export:links]. 246 274 247 === comment: links ===275 === comment: links 248 276 249 277 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. … … 256 284 - `ticket:123#comment:description` 257 285 258 === query: links === 286 === htdocs: links 287 288 Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory]. 289 290 === query: links 259 291 260 292 See TracQuery#UsingTracLinks and [#ticket:links]. 261 293 262 === search: links ===294 === search: links 263 295 264 296 See TracSearch#SearchLinks 265 297 266 === ticket: links === 267 ''alias:'' `bug:` 298 === ticket: links 299 300 ''aliases:'' `bug:`, `issue:` 268 301 269 302 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. … … 273 306 - `ticket:1,150` 274 307 275 ''(since Trac 0.11)'' 276 277 === timeline: links === 278 279 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. 308 === timeline: links 309 310 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. 280 311 281 312 Examples: … … 284 315 - `timeline:2008-01-29T15:48Z` 285 316 - `timeline:2008-01-29T16:48+01` 286 287 ''(since Trac 0.11)'' 288 289 === wiki: links ===290 291 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. 292 293 === Version Control related links ===294 295 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 latter "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).317 - `timeline:2008-01-29T16:48+0100` 318 - `timeline:2008-01-29T16:48+01:00` 319 320 === wiki: links 321 322 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. 323 324 === Version Control related links 325 326 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 latter "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. 296 327 297 328 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'`. 298 329 299 ==== source: links ==== 330 ==== source: links 331 300 332 ''aliases:'' `browser:`, `repos:` 301 333 302 The default behavior for a source:/some/path link is to open the browser in that directory directory 303 if the path points to a directory or to show the latest content of the file. 334 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. 304 335 305 336 It's also possible to link directly to a specific revision of a file like this: 306 337 - `source:/some/file@123` - link to the file's revision 123 307 338 - `source:/some/file@head` - link explicitly to the latest revision of the file 339 - `source:/some/file@named-branch` - link to latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial) 308 340 309 341 If the revision is specified, one can even link to a specific line number: 310 342 - `source:/some/file@123#L10` 311 343 - `source:/tag/0.10@head#L10` 344 - `source:/some/file@named-branch#L10` 312 345 313 346 Finally, one can also highlight an arbitrary set of lines: 314 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103 .315 ''(since 0.11)''347 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99 348 - 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. 316 349 317 350 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)'' 318 351 319 ==== export: links ====352 ==== export: links 320 353 321 354 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: … … 323 356 * `export:123:/some/file` - get revision 123 of the specified file 324 357 * `export:/some/file@123` - get revision 123 of the specified file 358 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial). 325 359 326 360 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. … … 328 362 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`). 329 363 330 ==== log: links ====364 ==== log: links 331 365 332 366 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. … … 336 370 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 337 371 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path 372 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial) 338 373 339 374 There are short forms for revision ranges as well: … … 348 383 ---- 349 384 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 350