Changes between Version 3 and Version 4 of TracLinks
- Timestamp:
- Aug 13, 2018, 11:36:48 AM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v3 v4 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 =|| … … 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 … … 105 103 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 104 107 108 == Advanced use of TracLinks == 109 110 === Relative links === 105 == Advanced use of TracLinks 106 107 === Relative links 111 108 112 109 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': … … 128 125 129 126 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. 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 toplevel page. 133 128 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 134 129 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 === 130 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. 131 132 === Link anchors 145 133 146 134 To create a link to a specific anchor in a page, use '#': … … 186 174 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 187 175 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 ===176 === InterWiki links 177 178 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. 179 180 === InterTrac links 193 181 194 182 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. … … 199 187 See InterTrac for the complete details. 200 188 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''): 189 === Server-relative links 190 191 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. 192 193 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 194 210 195 {{{ … … 224 209 Display: [//register Register Here] or [[//register|Register Here]] 225 210 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. 211 === Quoting space in TracLinks 212 213 Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes. 230 214 Examples: 231 215 * !wiki:"The whitespace convention" … … 238 222 * ![[attachment:the file.txt]] 239 223 240 === Escaping Links ===224 === Escaping Links 241 225 242 226 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). … … 250 234 ![42] is not a link either. 251 235 252 253 === Parameterized Trac links === 236 === Parameterized Trac links 254 237 255 238 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 244 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 262 245 263 264 == TracLinks Reference == 246 == TracLinks Reference 247 265 248 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 266 249 267 === attachment: links ===250 === attachment: links 268 251 269 252 The link syntax for attachments is as follows: … … 280 263 See also [#export:links]. 281 264 282 === comment: links ===265 === comment: links 283 266 284 267 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. … … 291 274 - `ticket:123#comment:description` 292 275 293 === htdocs: links ===276 === htdocs: links 294 277 295 278 Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory]. 296 279 297 === query: links ===280 === query: links 298 281 299 282 See TracQuery#UsingTracLinks and [#ticket:links]. 300 283 301 === search: links ===284 === search: links 302 285 303 286 See TracSearch#SearchLinks 304 287 305 === ticket: links === 306 ''alias:'' `bug:` 288 === ticket: links 289 290 ''aliases:'' `bug:`, `issue:` 307 291 308 292 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. … … 312 296 - `ticket:1,150` 313 297 314 ''(since Trac 0.11)'' 315 316 === timeline: links === 298 === timeline: links 317 299 318 300 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. … … 326 308 - `timeline:2008-01-29T16:48+01:00` 327 309 328 ''(since Trac 0.11)'' 329 330 === wiki: links === 310 === wiki: links 331 311 332 312 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. 333 313 334 === Version Control related links ===335 336 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).314 === Version Control related links 315 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 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. 337 317 338 318 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'`. 339 319 340 ==== source: links ==== 320 ==== source: links 321 341 322 ''aliases:'' `browser:`, `repos:` 342 323 343 The default behavior for a source:/some/path link is to open the browser in that directory directory 344 if the path points to a directory or to show the latest content of the file. 324 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. 345 325 346 326 It's also possible to link directly to a specific revision of a file like this: 347 327 - `source:/some/file@123` - link to the file's revision 123 348 328 - `source:/some/file@head` - link explicitly to the latest revision of the file 329 - `source:/some/file@named-branch` - link to latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial) 349 330 350 331 If the revision is specified, one can even link to a specific line number: 351 332 - `source:/some/file@123#L10` 352 333 - `source:/tag/0.10@head#L10` 353 354 Finally, one can also highlight an arbitrary set of lines ''(since 0.11)'': 334 - `source:/some/file@named-branch#L10` 335 336 Finally, one can also highlight an arbitrary set of lines: 355 337 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99 356 - 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 338 - 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. 357 339 358 340 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)'' 359 341 360 ==== export: links ====342 ==== export: links 361 343 362 344 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: … … 364 346 * `export:123:/some/file` - get revision 123 of the specified file 365 347 * `export:/some/file@123` - get revision 123 of the specified file 348 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial). 366 349 367 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. … … 369 352 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`). 370 353 371 ==== log: links ====354 ==== log: links 372 355 373 356 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. … … 377 360 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 378 361 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path 362 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial) 379 363 380 364 There are short forms for revision ranges as well: … … 389 373 ---- 390 374 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 391