Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Jan 16, 2024, 12:52:37 AM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracLinks

    2 11 12 17 18 20 21 31 32 34 36 37 39 40 42 43 46 47 49 57 58 80 81 83 84 101 102 103 104 105 106 111 112 128 129 133 134 141 142 144 145 149 150 153 154 156 157 172 173 175 176 180 181 187 188 189 203 204 218 219 224 225 226 229 230 232 233 235 236 244 245 248 249 255 256 259 260 262 263 265 266 267 269 270 271 273 274 275 277 278 279 281 282 285 286 288 289 290 292 293 294 301 302 303 305 306 307 309 310 318 319 321 322 323 327 328 329 331 332 335 336 346 347 349 350 351 353 354 358 359 361 362 363 365 366 368 369 371 372 379 380 382 383 384 385
    v1 v2  
    1 = Trac Links =
     1= Trac Links
     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
     6TracLinks 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
     8TracLinks 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
    12You can use TracLinks in:
    13
    … …  
    18and any other text fields explicitly marked as supporting WikiFormatting.
    19
    19 == Overview ==
     20== Overview
    21
    22||= Wiki Markup =||= Display =||
    … …  
    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`,
    33           `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` 
     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`
    35  Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25)
     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
    … …  
    40 Parent page :: [..]
    41 Tickets :: #1 or ticket:1
    41  Ticket comments :: comment:1:ticket:2 
     42 Ticket comments :: comment:1:ticket:2
    43 Reports :: {1} or report:1
    44 Milestones :: milestone:1.0
    … …  
    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,
    48           diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default 
     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
    50  Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25)
    51 }}}
    52 
    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.
     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
    … …  
    78}}}
    79|--------------------------------------------------------------------------------------
    82 |||| `wiki` is the default if the namespace part of a full link is omitted:  || 
     80|||| `wiki` is the default if the namespace part of a full link is omitted:  ||
    81{{{#!td
    82{{{
    … …  
    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}}}
    112
    113TracLinks 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.
    114
    107 
    108 == Advanced use of TracLinks ==
    109 
    110 === Relative links ===
     115== Advanced use of TracLinks
     116
     117=== Relative links
    118
    119To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
    … …  
    135
    136But 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.
     137For 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 top-level page.
    138This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    139
    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 ===
    139 
    140 To create a link to a specific anchor in a page, use '#':
     140To 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
     143
     144To create a link to a specific anchor in a page, use `#`:
    145{{{
    146 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
    … …  
    148  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
    149
    146 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.
    147 
    148 To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?':
     150To create an anchor in a page, use `[=#...]`:
     151{{{
     152 [=#myanchor my anchor] or empty form [=#myanchor]
     153}}}
     154 [=#myanchor my anchor] or empty form [=#myanchor]
     155
     156Hint: when you hover 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.
     157
     158To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with `#/` or `#?`:
    159{{{
    160 [#/Milestone first occurrence of Milestone] or
    … …  
    163 [#/Milestone first occurrence of Milestone] or
    164 [#?Milestone last occurrence of Milestone]
    155 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':
     165This 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`:
    166{{{
    167 [#/Milestone/i first occurrence of Milestone or milestone] or
    … …  
    182(Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.)
    183
    174 Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead:
     184Since such links become outdated when the file changes, it can be useful to link using a `#/` pseudo anchor instead:
    185{{{
    186 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
    … …  
    190 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
    191
    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 ===
     192=== InterWiki links
     193
     194Other 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.
     195
     196=== InterTrac links
    197
    198This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
    199
    190 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.
    191 
    192 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].
    193 See InterTrac for the complete details.
    194 
    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''):
     200Any 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.
     201
     202A distinct advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links can also be used, such as `{}`, `r`, `#`. For example, if T was set as an alias for Trac, then links to Trac tickets can be written as #T234, and links to Trac changesets can be written as [trac 1508].
     203See InterTrac for the complete details.
     204
     205=== Server-relative links
     206
     207It 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.
     208
     209To 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''):
    210
    211{{{
    … …  
    225Display: [//register Register Here] or [[//register|Register Here]]
    226
    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.
     227=== Quoting space in TracLinks
     228
     229Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes.
    230Examples:
    231 * !wiki:"The whitespace convention"
    232 * !attachment:'the file.txt' or
    227  * !attachment:"the file.txt" 
    228  * !attachment:"the file.txt:ticket:123" 
     233 * !attachment:"the file.txt"
     234 * !attachment:"the file.txt:ticket:123"
    235
    236Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
    … …  
    238 * ![[attachment:the file.txt]]
    239
    234 === Escaping Links ===
     240=== Escaping Links
    241
    242To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
    … …  
    250 ![42] is not a link either.
    251
    246 
    247 === Parameterized Trac links ===
     252=== Parameterized Trac links
    253
    254Many 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.
    … …  
    260 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
    261
    257 
    258 == TracLinks Reference ==
     262== TracLinks Reference
     263
    264The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
    265
    261 === attachment: links ===
     266=== attachment: links
    267
    268The link syntax for attachments is as follows:
    264  * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
     269 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current page
    270 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
    271 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
    272
    268 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
     273Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt, but is not recommended.
    274
    275If 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:`.
    276
    272 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 open up your site to [wikipedia:Cross-site_scripting cross-site scripting] attacks.
     277This 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 [https://en.wikipedia.org/wiki/Cross-site_scripting cross-site scripting] attacks.
    278
    279See also [#export:links].
    280
    276 === comment: links ===
     281=== comment: links
    282
    283When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
    284It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
    280  - `comment:3:ticket:123` 
     285 - `comment:3:ticket:123`
    286 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
    287It is also possible to link to the ticket's description using one of the following syntax:
    … …  
    290 - `ticket:123#comment:description`
    291
    287 === htdocs: links ===
     292=== htdocs: links
    293
    294Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory].
    295
    291 === query: links ===
     296=== query: links
    297
    298See TracQuery#UsingTracLinks and [#ticket:links].
    299
    295 === search: links ===
    296 
    297 See TracSearch#SearchLinks
    298 
    299 === ticket: links ===
    300  ''alias:'' `bug:`
     300=== search: links
     301
     302See TracSearch#SearchTracLinks
     303
     304=== ticket: links
     305
     306 ''aliases:'' `bug:`, `issue:`
    307
    308Besides 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.
    309
    304 Example: 
     310Example:
    311 - `ticket:5000-6000`
    312 - `ticket:1,150`
    313
    308 === timeline: links ===
     314=== timeline: links
    315
    316Links 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.
    … …  
    324 - `timeline:2008-01-29T16:48+01:00`
    325
    320 === wiki: links ===
     326=== wiki: links
    327
    328See 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.
    329
    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).
     330=== Version Control system links
     331
     332It 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.
    333
    334For 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'`.
    335
    330 ==== source: links ====
     336==== source: links
     337
    338 ''aliases:'' `browser:`, `repos:`
    339
    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.
     340The 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.
    341
    342It's also possible to link directly to a specific revision of a file like this:
    … …  
    352Finally, one can also highlight an arbitrary set of lines:
    353 - `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
     354 - 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.
    355
    356Note 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)''
    357
    352 ==== export: links ====
     358==== export: links
    359
    360To 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 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial).
    365
    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.
     366This 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.
    367
    368If 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`).
    369
    364 ==== log: links ====
     370==== log: links
    371
    372The `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.
    … …  
    374 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
    375 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
    370  - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 
     376 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    377 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
    378 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial)
    … …  
    385Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
    386
    381 In the presence of multiple repositories, the name of the repository should be specified as the first part of the path, e.g. `log:repos/branches` or `[20-40/repos]`.
     387==== Multi-repository links
     388
     389In the presence of multiple repositories, the name of the repository should be specified as the first part of the path:
     390- `log:repos/branch`
     391- `[20-40/repos]`
     392- `r20/repos`
    393
    394----
    395See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki