![(please configure [header_logo] section in trac.ini)](https://lpsc.in2p3.fr/trac/chrome/common/logo_LPSC.png){kind=logo}
Changes between Version 5 and Version 6 of TracLinks
- Timestamp:
- 19/05/2016 16:30:59 (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v5 v6 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. 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. 137 138 === 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 139 133 140 134 To create a link to a specific anchor in a page, use '#': … … 180 174 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 181 175 182 === InterWiki links ===183 184 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.185 186 === 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 187 181 188 182 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. … … 193 187 See InterTrac for the complete details. 194 188 195 === Server-relative links === 196 197 It is often useful to be able to link to objects in your project that 198 have no built-in Trac linking mechanism, such as static resources, `newticket`, 199 a shared `/register` page on the server, etc. 200 201 To link to resources inside the project, use either an absolute path from the project root, 202 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''): 203 194 204 195 {{{ … … 218 209 Display: [//register Register Here] or [[//register|Register Here]] 219 210 220 === Quoting space in TracLinks === 221 222 Immediately after a TracLinks prefix, targets containing space characters should 223 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. 224 214 Examples: 225 215 * !wiki:"The whitespace convention" … … 232 222 * ![[attachment:the file.txt]] 233 223 234 === Escaping Links ===224 === Escaping Links 235 225 236 226 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). … … 244 234 ![42] is not a link either. 245 235 246 247 === Parameterized Trac links === 236 === Parameterized Trac links 248 237 249 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. … … 255 244 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 256 245 257 258 == TracLinks Reference == 246 == TracLinks Reference 247 259 248 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 260 249 261 === attachment: links ===250 === attachment: links 262 251 263 252 The link syntax for attachments is as follows: … … 274 263 See also [#export:links]. 275 264 276 === comment: links ===265 === comment: links 277 266 278 267 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. … … 285 274 - `ticket:123#comment:description` 286 275 287 === htdocs: links ===276 === htdocs: links 288 277 289 278 Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory]. 290 279 291 === query: links ===280 === query: links 292 281 293 282 See TracQuery#UsingTracLinks and [#ticket:links]. 294 283 295 === search: links ===284 === search: links 296 285 297 286 See TracSearch#SearchLinks 298 287 299 === ticket: links === 288 === ticket: links 289 300 290 ''alias:'' `bug:` 301 291 … … 306 296 - `ticket:1,150` 307 297 308 === timeline: links ===298 === timeline: links 309 299 310 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. … … 318 308 - `timeline:2008-01-29T16:48+01:00` 319 309 320 === wiki: links ===310 === wiki: links 321 311 322 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. 323 313 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).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. 327 317 328 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'`. 329 319 330 ==== source: links ==== 320 ==== source: links 321 331 322 ''aliases:'' `browser:`, `repos:` 332 323 333 The default behavior for a `source:/some/path link` is to open the browser in that directory directory 334 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. 335 325 336 326 It's also possible to link directly to a specific revision of a file like this: 337 327 - `source:/some/file@123` - link to the file's revision 123 338 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) 339 330 340 331 If the revision is specified, one can even link to a specific line number: 341 332 - `source:/some/file@123#L10` 342 333 - `source:/tag/0.10@head#L10` 334 - `source:/some/file@named-branch#L10` 343 335 344 336 Finally, one can also highlight an arbitrary set of lines: 345 337 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99 346 - 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. 347 339 348 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)'' 349 341 350 ==== export: links ====342 ==== export: links 351 343 352 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: … … 354 346 * `export:123:/some/file` - get revision 123 of the specified file 355 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). 356 349 357 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. … … 359 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`). 360 353 361 ==== log: links ====354 ==== log: links 362 355 363 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. … … 367 360 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 368 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) 369 363 370 364 There are short forms for revision ranges as well:
