Changes between Version 95 and Version 96 of TracLinks
- Timestamp:
- Feb 8, 2016, 7:02:15 AM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v95 v96 1 = Trac Links = 1 = Trac Links 2 2 3 [[TracGuideToc]] 4 [[PageOutline(2-5,Contents,pullout)]] 3 5 [[TranslatedPages]] 4 6 5 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. 6 7 TracLinks are generally of the form '''type:id''' (where ''id'' represents the 8 number, name or path of the item) though some frequently used kinds of items 9 also have short-hand notations. 10 11 == Where to use TracLinks == 7 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. 8 9 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. 10 11 == Where to use TracLinks 12 12 13 You can use TracLinks in: 13 14 … … 18 19 and any other text fields explicitly marked as supporting WikiFormatting. 19 20 20 == Overview ==21 == Overview 21 22 22 23 ||= Wiki Markup =||= Display =|| … … 52 53 }}} 53 54 54 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 55 pages whose names do not follow WikiPageNames rules, i.e., single words, 56 non-alphabetic characters, etc. See WikiPageNames for more about features specific 57 to links to Wiki page names. 55 '''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. 58 56 59 57 … … 106 104 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. 107 105 108 109 == Advanced use of TracLinks == 110 111 === Relative links === 106 == Advanced use of TracLinks 107 108 === Relative links 112 109 113 110 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': … … 129 126 130 127 But in practice you often won't need to add the `../` prefix to link to a sibling page. 131 For resolving the location of a wiki link, it's the target page closest in the hierarchy 132 to the page where the link is written which will be selected. So for example, within 133 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page. 128 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. 134 129 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 135 130 136 In order to link explicitly to a [=#toplevel toplevel] Wiki page, 137 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. 138 139 === Link anchors === 131 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. 132 133 === Link anchors 140 134 141 135 To create a link to a specific anchor in a page, use '#': … … 181 175 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 182 176 183 === InterWiki links ===184 185 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.186 187 === InterTrac links ===177 === InterWiki links 178 179 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. 180 181 === InterTrac links 188 182 189 183 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. … … 194 188 See InterTrac for the complete details. 195 189 196 === Server-relative links === 197 198 It is often useful to be able to link to objects in your project that 199 have no built-in Trac linking mechanism, such as static resources, `newticket`, 200 a shared `/register` page on the server, etc. 201 202 To link to resources inside the project, use either an absolute path from the project root, 203 or a relative link from the URL of the current page (''Changed in 0.11''): 190 === Server-relative links 191 192 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. 193 194 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''): 204 195 205 196 {{{ … … 219 210 Display: [//register Register Here] or [[//register|Register Here]] 220 211 221 === Quoting space in TracLinks === 222 223 Immediately after a TracLinks prefix, targets containing space characters should 224 be enclosed in a pair of quotes or double quotes. 212 === Quoting space in TracLinks 213 214 Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes. 225 215 Examples: 226 216 * !wiki:"The whitespace convention" … … 233 223 * ![[attachment:the file.txt]] 234 224 235 === Escaping Links ===225 === Escaping Links 236 226 237 227 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). … … 245 235 ![42] is not a link either. 246 236 247 248 === Parameterized Trac links === 237 === Parameterized Trac links 249 238 250 239 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. … … 256 245 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 257 246 258 259 == TracLinks Reference == 247 == TracLinks Reference 248 260 249 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 261 250 262 === attachment: links ===251 === attachment: links 263 252 264 253 The link syntax for attachments is as follows: … … 275 264 See also [#export:links]. 276 265 277 === comment: links ===266 === comment: links 278 267 279 268 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. … … 286 275 - `ticket:123#comment:description` 287 276 288 === htdocs: links ===277 === htdocs: links 289 278 290 279 Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory]. 291 280 292 === query: links ===281 === query: links 293 282 294 283 See TracQuery#UsingTracLinks and [#ticket:links]. 295 284 296 === search: links ===285 === search: links 297 286 298 287 See TracSearch#SearchLinks 299 288 300 === ticket: links === 289 === ticket: links 290 301 291 ''alias:'' `bug:` 302 292 … … 307 297 - `ticket:1,150` 308 298 309 === timeline: links ===299 === timeline: links 310 300 311 301 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 309 - `timeline:2008-01-29T16:48+01:00` 320 310 321 === wiki: links ===311 === wiki: links 322 312 323 313 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. 324 314 325 === Version Control related links ===326 327 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).315 === Version Control related links 316 317 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. 328 318 329 319 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'`. 330 320 331 ==== source: links ==== 321 ==== source: links 322 332 323 ''aliases:'' `browser:`, `repos:` 333 324 334 The default behavior for a `source:/some/path link` is to open the browser in that directory directory 335 if the path points to a directory or to show the latest content of the file. 325 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. 336 326 337 327 It's also possible to link directly to a specific revision of a file like this: … … 347 337 Finally, one can also highlight an arbitrary set of lines: 348 338 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99 349 - 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 339 - 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. 350 340 351 341 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)'' 352 342 353 ==== export: links ====343 ==== export: links 354 344 355 345 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: … … 363 353 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`). 364 354 365 ==== log: links ====355 ==== log: links 366 356 367 357 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.
