Changes between Version 2 and Version 3 of TracLinks
- Timestamp:
- 11/14/18 14:29:06 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v2 v3 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, 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 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 Some examples: 20 * Tickets: '''!#1''' or '''!ticket:1''' 21 * Ticket comments: '''!comment:1:ticket:2''' 22 * Reports: '''!{1}''' or '''!report:1''' 23 * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' 24 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''', '''![2:5/trunk]''' 25 * Diffs (requires [trac:milestone:0.10 0.10]): '''!diff:@1:3''', '''!diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default''' or '''!diff:trunk/trac@3538//sandbox/vc-refactoring@3539''' 26 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' 27 * Parent page: '''![..]''' 28 * Milestones: '''!milestone:1.0''' 29 * Attachment: '''!attachment:example.tgz''' (for current page attachment), '''!attachment:attachment.1073.diff:ticket:944''' 30 (absolute path) 31 * Files: '''!source:trunk/COPYING''' 32 * A specific file revision: '''!source:/trunk/COPYING@200''' 33 * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' 34 Display: 35 * Tickets: #1 or ticket:1 36 * Ticket comments: comment:1:ticket:2 37 * Reports: {1} or report:1 38 * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk 39 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] 40 * Diffs (requires [milestone:0.10 0.10]): diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring@3539 41 * Wiki pages: CamelCase or wiki:CamelCase 42 * Parent page: [..] 43 * Milestones: milestone:1.0 44 * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 45 (absolute path) 46 * Files: source:trunk/COPYING 47 * A specific file revision: source:/trunk/COPYING@200 48 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 49 50 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 51 pages whose names do not follow WikiPageNames rules, i.e., single words, 52 non-alphabetic characters, etc. See WikiPageNames for more about features specific 53 to links to Wiki page names. 54 55 Trac links using the full (non-shorthand) notation can also be given a custom 56 link title like this: 57 58 {{{ 59 [ticket:1 This is a link to ticket number one]. 60 }}} 61 62 Display: [ticket:1 This is a link to ticket number one]. 63 64 If the title is omitted, only the id (the part after the colon) is displayed: 65 66 {{{ 67 [ticket:1] 68 }}} 69 70 Display: [ticket:1] 71 72 `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''): 73 74 {{{ 75 [SandBox the sandbox] 76 }}} 77 78 Display: [SandBox the sandbox] 20 == Overview 21 22 ||= Wiki Markup =||= Display =|| 23 {{{#!td 24 Wiki pages :: `CamelCase` or `wiki:CamelCase` 25 Parent page :: `[..]` 26 Tickets :: `#1` or `ticket:1` 27 Ticket comments :: `comment:1:ticket:2` 28 Reports :: `{1}` or `report:1` 29 Milestones :: `milestone:1.0` 30 Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path) 31 Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`, `[1/repository]` 32 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]` 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` 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), `source:/trunk/COPYING@200:27-30#L25` (at version 200, line 25, highlighting lines 27-30) 37 }}} 38 {{{#!td 39 Wiki pages :: CamelCase or wiki:CamelCase 40 Parent page :: [..] 41 Tickets :: #1 or ticket:1 42 Ticket comments :: comment:1:ticket:2 43 Reports :: {1} or report:1 44 Milestones :: milestone:1.0 45 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path) 46 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk, [1/repository] 47 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] 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 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) source:/trunk/COPYING@200:28-31#L25 (at version 200, line 25, highlighting lines 28-31) 52 }}} 53 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. 55 56 57 {{{#!table class="" 58 |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: || 59 {{{#!td 60 {{{ 61 [ticket:1 This is a link to ticket number one] or 62 [[ticket:1|This is another link to ticket number one]]. 63 }}} 64 }}} 65 {{{#!td 66 [ticket:1 This is a link to ticket number one] or 67 [[ticket:1|This is another link to ticket number one]]. 68 }}} 69 |-------------------------------------------------------------------------------------- 70 |||| If the title is omitted, only the id (the part after the colon) is displayed: || 71 {{{#!td 72 {{{ 73 [ticket:1] or [[ticket:2]] 74 }}} 75 }}} 76 {{{#!td 77 [ticket:1] or [[ticket:2]] 78 }}} 79 |-------------------------------------------------------------------------------------- 80 |||| `wiki` is the default if the namespace part of a full link is omitted: || 81 {{{#!td 82 {{{ 83 [SandBox the sandbox] or 84 [[SandBox|the sandbox]] 85 }}} 86 }}} 87 {{{#!td 88 [SandBox the sandbox] or 89 [[SandBox|the sandbox]] 90 }}} 91 |-------------------------------------------------------------------------------------- 92 |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >) || 93 {{{#!td 94 {{{ 95 <wiki:Strange(page@!)> 96 }}} 97 }}} 98 {{{#!td 99 <wiki:Strange(page@!)> 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 }}} 111 }}} 79 112 80 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. 81 114 82 83 == Advanced use of TracLinks == 84 85 === 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 86 143 87 144 To create a link to a specific anchor in a page, use '#': 88 145 {{{ 89 [#Relativelinks relative links] 90 }}} 91 Displays: 92 [#Relativelinks relative links] 146 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 147 }}} 148 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 93 149 94 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. 95 151 96 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 97 {{{ 98 WikiPage/SubWikiPage or ./SubWikiPage 99 }}} 100 101 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 102 {{{ 103 [..] 104 }}} 105 106 To link from a [trac:SubWiki SubWiki] page to a sibling page, use a '../': 107 {{{ 108 [../Sibling see next sibling] 109 }}} 110 111 ''(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 now in 0.11 it will stay in the wiki namespace and link to a sibling page. See [#Server-relativelinks] for the new syntax. 112 113 === InterWiki links === 114 115 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. 116 117 === 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 118 191 119 192 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 120 193 121 Any type of Trac links could be written in one Trac environment and actually refer to resources present in another Trac environment, provided the Trac link is prefixed by the name of that other Trac environment followed by a colon. That other Trac environment must be registered, under its name or an alias. See InterTrac for details. 122 123 A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links usually have a way to understand the InterTrac prefixes. For example, links to Trac tickets can be written #T234 (if T was set as an alias for Trac), links to Trac changesets can be written [trac 1508]. 124 125 === Server-relative links === 126 127 It is often useful to be able to link to objects in your project that 128 have no built-in Trac linking mechanism, such as static resources, `newticket`, 129 a shared `/register` page on the server, etc. 130 131 To link to resources inside the project, use either an absolute path from the project root, 132 or a relative link from the URL of the current page (''Changed in 0.11''): 133 134 {{{ 135 [/newticket Create a new ticket] 136 [/ home] 137 }}} 138 139 Display: [/newticket Create a new ticket] [/ home] 140 141 To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''): 142 143 {{{ 144 [//register Register Here] 145 }}} 146 147 Display: [//register Register Here] 148 149 === Quoting space in TracLinks === 150 151 Immediately after a TracLinks prefix, targets containing space characters should 152 be enclosed in a pair of quotes or double quotes. 194 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. 195 196 A distinctive 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]. 197 See InterTrac for the complete details. 198 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''): 204 205 {{{ 206 [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 207 [/ home] or [[/|home]] 208 }}} 209 210 Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 211 [/ home] or [[/|home]] 212 213 To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''): 214 215 {{{ 216 [//register Register Here] or [[//register|Register Here]] 217 }}} 218 219 Display: [//register Register Here] or [[//register|Register Here]] 220 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. 153 224 Examples: 154 225 * !wiki:"The whitespace convention" … … 157 228 * !attachment:"the file.txt:ticket:123" 158 229 159 === Escaping Links === 230 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces: 231 * ![[The whitespace convention]] 232 * ![[attachment:the file.txt]] 233 234 === Escaping Links 160 235 161 236 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). … … 169 244 ![42] is not a link either. 170 245 171 172 === Parameterized Trac links === 173 174 The Trac links target Trac resources which have generally more than one way to be rendered, according to 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. 175 176 Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: 246 === Parameterized Trac links 247 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. 249 250 Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: 177 251 - `wiki:WikiStart?format=txt` 178 252 - `ticket:1?version=1` 179 253 - `[/newticket?component=module1 create a ticket for module1]` 180 181 182 == TracLinks Reference == 183 The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 184 185 === attachment: links === 254 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 255 256 == TracLinks Reference 257 258 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 259 260 === attachment: links 186 261 187 262 The link syntax for attachments is as follows: 188 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object263 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current page 189 264 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page 190 265 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 191 266 192 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. 193 268 194 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:`. 195 270 196 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 openup your site to [wikipedia:Cross-site_scripting cross-site scripting] attacks.271 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 [wikipedia:Cross-site_scripting cross-site scripting] attacks. 197 272 198 273 See also [#export:links]. 199 274 200 === comment: links === 201 202 When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment. 203 It's also possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 204 - !comment:3:ticket:123 205 - !ticket:123#comment:3 (note that you can't write !#123#!comment:3!) 206 207 === query: links === 275 === comment: links 276 277 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. 278 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 279 - `comment:3:ticket:123` 280 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!) 281 It is also possible to link to the ticket's description using one of the following syntax: 282 - `comment:description` (within the ticket) 283 - `comment:description:ticket:123` 284 - `ticket:123#comment:description` 285 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 208 291 209 292 See TracQuery#UsingTracLinks and [#ticket:links]. 210 293 211 === search: links === 212 213 See TracSearch#SearchLinks 214 215 === ticket: links === 294 === search: links 295 296 See TracSearch#SearchTracLinks 297 298 === ticket: links 299 300 ''aliases:'' `bug:`, `issue:` 216 301 217 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. … … 221 306 - `ticket:1,150` 222 307 223 ''(since Trac 0.11)'' 224 225 === timeline: links === 226 227 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. 228 311 229 312 Examples: … … 232 315 - `timeline:2008-01-29T15:48Z` 233 316 - `timeline:2008-01-29T16:48+01` 234 235 ''(since Trac 0.11)'' 236 237 === wiki: links === 238 239 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. 240 241 === Version Control related links === 242 ==== source: links ==== 243 244 The default behavior for a source:/some/path link is to open the directory browser 245 if the path points to a directory and otherwise open the log view. 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 system 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 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. 327 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'`. 329 330 ==== source: links 331 332 ''aliases:'' `browser:`, `repos:` 333 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. 246 335 247 336 It's also possible to link directly to a specific revision of a file like this: 248 337 - `source:/some/file@123` - link to the file's revision 123 249 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) 250 340 251 341 If the revision is specified, one can even link to a specific line number: 252 342 - `source:/some/file@123#L10` 253 343 - `source:/tag/0.10@head#L10` 344 - `source:/some/file@named-branch#L10` 254 345 255 346 Finally, one can also highlight an arbitrary set of lines: 256 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. 257 ''(since 0.11)'' 258 259 ==== export: links ==== 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. 349 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)'' 351 352 ==== export: links 260 353 261 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: … … 263 356 * `export:123:/some/file` - get revision 123 of the specified file 264 357 * `export:/some/file@123` - get revision 123 of the specified file 265 266 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. 358 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial). 359 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 [[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. 267 361 268 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`). 269 363 270 ==== log: links ====271 272 The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions fromthe specified path, but it can also support displaying an arbitrary set of revisions.364 ==== log: links 365 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. 273 367 - `log:/` - the latest revisions starting at the root of the repository 274 368 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 275 369 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000 276 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range 277 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path 370 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 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) 278 373 279 374 There are short forms for revision ranges as well: … … 282 377 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`) 283 378 284 Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`. 379 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`. 380 381 ==== Multi-repository links 382 383 In the presence of multiple repositories, the name of the repository should be specified as the first part of the path: 384 - `log:repos/branch` 385 - `[20-40/repos]` 386 - `r20/repos` 285 387 286 388 ---- 287 389 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 288