Changes between Version 2 and Version 3 of TracLinks


Ignore:
Timestamp:
Nov 26, 2022, 2:16:12 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracLinks

    v2 v3  
    1 = Trac Links =
     1= Trac Links
     2
    23[[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
    1112You can use TracLinks in:
    1213
    … …  
    1718and any other text fields explicitly marked as supporting WikiFormatting.
    1819
    19 == Overview ==
     20== Overview
    2021
    2122||= Wiki Markup =||= Display =||
    … …  
    3132 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
    3233 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`
    3435          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)
    3637}}}
    3738{{{#!td
    … …  
    3940 Parent page :: [..]
    4041 Tickets :: #1 or ticket:1
    41  Ticket comments :: comment:1:ticket:2 
     42 Ticket comments :: comment:1:ticket:2
    4243 Reports :: {1} or report:1
    4344 Milestones :: milestone:1.0
    … …  
    4647 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
    4748 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
    4950          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.
    5755
    5856
    … …  
    8078}}}
    8179|--------------------------------------------------------------------------------------
    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:  ||
    8381{{{#!td
    8482{{{
    … …  
    10199<wiki:Strange(page@!)>
    102100}}}
     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}}}
    103111}}}
    104112
    105113TracLinks 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.
    106114
    107 
    108 == Advanced use of TracLinks ==
    109 
    110 === Relative links ===
     115== Advanced use of TracLinks
     116
     117=== Relative links
    111118
    112119To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
    … …  
    128135
    129136But 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.
    133138This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    134139
    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 ===
     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
    139143
    140144To create a link to a specific anchor in a page, use '#':
    … …  
    144148  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
    145149
    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.
     150Hint: 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.
    147151
    148152To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?':
    … …  
    180184 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
    181185
    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 ===
     186=== InterWiki links
     187
     188Other 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
    187191
    188192This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
    189193
    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''):
     194Any 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
     196A 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].
     197See InterTrac for the complete details.
     198
     199=== Server-relative links
     200
     201It 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
     203To 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''):
    203204
    204205{{{
    … …  
    218219Display: [//register Register Here] or [[//register|Register Here]]
    219220
    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.
     221=== Quoting space in TracLinks
     222
     223Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes.
    224224Examples:
    225225 * !wiki:"The whitespace convention"
    226226 * !attachment:'the file.txt' or
    227  * !attachment:"the file.txt" 
    228  * !attachment:"the file.txt:ticket:123" 
     227 * !attachment:"the file.txt"
     228 * !attachment:"the file.txt:ticket:123"
    229229
    230230Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
    … …  
    232232 * ![[attachment:the file.txt]]
    233233
    234 === Escaping Links ===
     234=== Escaping Links
    235235
    236236To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
    … …  
    244244 ![42] is not a link either.
    245245
    246 
    247 === Parameterized Trac links ===
     246=== Parameterized Trac links
    248247
    249248Many 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.
    … …  
    255254 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
    256255
    257 
    258 == TracLinks Reference ==
     256== TracLinks Reference
     257
    259258The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
    260259
    261 === attachment: links ===
     260=== attachment: links
    262261
    263262The 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
     263 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current page
    265264 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
    266265 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
    267266
    268 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
     267Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt, but is not recommended.
    269268
    270269If 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:`.
    271270
    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.
     271This 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.
    273272
    274273See also [#export:links].
    275274
    276 === comment: links ===
     275=== comment: links
    277276
    278277When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
    279278It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
    280  - `comment:3:ticket:123` 
     279 - `comment:3:ticket:123`
    281280 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
    282281It is also possible to link to the ticket's description using one of the following syntax:
    … …  
    285284 - `ticket:123#comment:description`
    286285
    287 === htdocs: links ===
     286=== htdocs: links
    288287
    289288Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory].
    290289
    291 === query: links ===
     290=== query: links
    292291
    293292See TracQuery#UsingTracLinks and [#ticket:links].
    294293
    295 === search: links ===
    296 
    297 See TracSearch#SearchLinks
    298 
    299 === ticket: links ===
    300  ''alias:'' `bug:`
     294=== search: links
     295
     296See TracSearch#SearchTracLinks
     297
     298=== ticket: links
     299
     300 ''aliases:'' `bug:`, `issue:`
    301301
    302302Besides 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.
    303303
    304 Example: 
     304Example:
    305305 - `ticket:5000-6000`
    306306 - `ticket:1,150`
    307307
    308 === timeline: links ===
     308=== timeline: links
    309309
    310310Links 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.
    … …  
    318318 - `timeline:2008-01-29T16:48+01:00`
    319319
    320 === wiki: links ===
     320=== wiki: links
    321321
    322322See 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.
    323323
    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).
     324=== Version Control system links
     325
     326It 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.
    327327
    328328For 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'`.
    329329
    330 ==== source: links ====
     330==== source: links
     331
    331332 ''aliases:'' `browser:`, `repos:`
    332333
    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.
     334The 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.
    335335
    336336It's also possible to link directly to a specific revision of a file like this:
    … …  
    346346Finally, one can also highlight an arbitrary set of lines:
    347347 - `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
     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.
    349349
    350350Note 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)''
    351351
    352 ==== export: links ====
     352==== export: links
    353353
    354354To 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:
    … …  
    358358 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial).
    359359
    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.
     360This 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.
    361361
    362362If 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`).
    363363
    364 ==== log: links ====
     364==== log: links
    365365
    366366The `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.
    … …  
    368368 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
    369369 - `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 
     370 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    371371 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
    372372 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial)
    … …  
    379379Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
    380380
    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]`.
     381==== Multi-repository links
     382
     383In 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`
    382387
    383388----
    384389See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
    385