Changes between Version 2 and Version 3 of TracLinks


Ignore:
Timestamp:
25 Jan 2017, 21:56:44 (15 months 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, because they allow easy hyperlinking between the various entities in the system — such as tickets, reports, changesets, Wiki pages, milestones, and source files — from anywhere where WikiFormatting is used.
     7
     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 =||
     
    2627 Ticket comments :: `comment:1:ticket:2`
    2728 Reports :: `{1}` or `report:1`
    28  Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`
    29  Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
    30  Diffs :: `diff:@1:3`, `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
    31           or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
    3229 Milestones :: `milestone:1.0`
    3330 Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path)
    34  Files :: `source:trunk/COPYING`
    35  A specific file revision :: `source:/trunk/COPYING@200`
    36  A particular line of a specific file revision :: `source:/trunk/COPYING@200#L25`
     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)
    3737}}}
    3838{{{#!td
     
    4242 Ticket comments :: comment:1:ticket:2
    4343 Reports :: {1} or report:1
    44  Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
    45  Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
    46  Diffs :: diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
    47           or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
    4844 Milestones :: milestone:1.0
    4945 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
    50  Files :: source:trunk/COPYING
    51  A specific file revision :: source:/trunk/COPYING@200
    52  A particular line of a specific file revision :: source:/trunk/COPYING@200#L25
    53 }}}
    54 
    55 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    56 pages whose names do not follow WikiPageNames rules, i.e., single words,
    57 non-alphabetic characters, etc. See WikiPageNames for more about features specific
    58 to links to Wiki page names.
     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)
     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.
    5955
    6056
     
    107103TracLinks 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.
    108104
    109 
    110 == Advanced use of TracLinks ==
    111 
    112 === Relative links ===
     105== Advanced use of TracLinks
     106
     107=== Relative links
     108
     109To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
     110{{{
     111 WikiPage/SubWikiPage or ./SubWikiPage
     112}}}
     113
     114To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
     115{{{
     116  [..] or [[..]]
     117}}}
     118  [..] or [[..]]
     119
     120To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
     121{{{
     122  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     123}}}
     124  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     125
     126But in practice you often won't need to add the `../` prefix to link to a sibling page.
     127For 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.
     128This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
     129
     130To link explicitly to a [=#toplevel toplevel] Wiki page, use the `wiki:/` prefix. Be careful **not** to use the `/` prefix alone, as this corresponds to the [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/` part in the resulting URL. A link such as `[../newticket]` will stay in the wiki namespace and therefore link to a sibling page.
     131
     132=== Link anchors
    113133
    114134To create a link to a specific anchor in a page, use '#':
    115135{{{
    116  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
    117 }}}
    118 Displays:
    119   [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     136 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
     137}}}
     138  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
    120139
    121140Hint: 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.
    122141
    123 To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
    124 {{{
    125  WikiPage/SubWikiPage or ./SubWikiPage
    126 }}}
    127 
    128 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
    129 {{{
    130   [..] or [[..]]
    131 }}}
    132   [..] or [[..]]
    133 
    134 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
    135 {{{
    136   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    137 }}}
    138   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    139 
    140 But in practice you often won't need to add the `../` prefix to link to a sibling page.
    141 For resolving the location of a wiki link, it's the target page closest in the hierarchy
    142 to the page where the link is written which will be selected. So for example, within
    143 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
    144 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    145 
    146 In order to link explicitly to a [=#toplevel toplevel] Wiki page,
    147 use the `wiki:/` prefix.
    148 Be careful **not** to use the `/` prefix alone, as this corresponds to the
    149 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
    150 part in the resulting URL.
    151 
    152 ''(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 since 0.11, such a link will stay in the wiki namespace and therefore link to a sibling page.
    153 See [#Server-relativelinks] for the new syntax.
    154 
    155 === InterWiki links ===
    156 
    157 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.
    158 
    159 === InterTrac links ===
     142To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?':
     143{{{
     144 [#/Milestone first occurrence of Milestone] or
     145 [#?Milestone last occurrence of Milestone]
     146}}}
     147 [#/Milestone first occurrence of Milestone] or
     148 [#?Milestone last occurrence of Milestone]
     149This 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':
     150{{{
     151 [#/Milestone/i first occurrence of Milestone or milestone] or
     152 [#?Milestone/i last occurrence of Milestone or milestone]
     153}}}
     154 [#/Milestone/i first occurrence of Milestone or milestone] or
     155 [#?Milestone/i last occurrence of Milestone or milestone]
     156
     157''(since Trac 1.0)''
     158
     159Such anchors can be very useful for linking to specific lines in a file in the source browser:
     160{{{
     161 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or
     162 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47]
     163}}}
     164 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or
     165 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47]
     166(Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.)
     167
     168Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead:
     169{{{
     170 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
     171 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
     172}}}
     173 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
     174 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
     175
     176=== InterWiki links
     177
     178Other prefixes can be defined freely and made to point to resources in other Web applications. The definition of those prefixes as well as the URLs of the corresponding Web applications is defined in a special Wiki page, the InterMapTxt page. Note that while this could be used to create links to other Trac environments, there is a more specialized way to register other Trac environments which offers greater flexibility.
     179
     180=== InterTrac links
    160181
    161182This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
     
    166187See InterTrac for the complete details.
    167188
    168 === Server-relative links ===
    169 
    170 It is often useful to be able to link to objects in your project that
    171 have no built-in Trac linking mechanism, such as static resources, `newticket`,
    172 a shared `/register` page on the server, etc.
    173 
    174 To link to resources inside the project, use either an absolute path from the project root,
    175 or a relative link from the URL of the current page (''Changed in 0.11''):
     189=== Server-relative links
     190
     191It is often useful to be able to link to objects in your project that have no built-in Trac linking mechanism, such as static resources, `newticket`, a shared `/register` page on the server, etc.
     192
     193To 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''):
    176194
    177195{{{
     
    191209Display: [//register Register Here] or [[//register|Register Here]]
    192210
    193 === Quoting space in TracLinks ===
    194 
    195 Immediately after a TracLinks prefix, targets containing space characters should
    196 be enclosed in a pair of quotes or double quotes.
     211=== Quoting space in TracLinks
     212
     213Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes.
    197214Examples:
    198215 * !wiki:"The whitespace convention"
     
    205222 * ![[attachment:the file.txt]]
    206223
    207 === Escaping Links ===
     224=== Escaping Links
    208225
    209226To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     
    217234 ![42] is not a link either.
    218235
    219 
    220 === Parameterized Trac links ===
     236=== Parameterized Trac links
    221237
    222238Many 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.
     
    228244 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
    229245
    230 
    231 == TracLinks Reference ==
     246== TracLinks Reference
     247
    232248The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
    233249
    234 === attachment: links ===
     250=== attachment: links
    235251
    236252The link syntax for attachments is as follows:
     
    247263See also [#export:links].
    248264
    249 === comment: links ===
     265=== comment: links
    250266
    251267When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
     
    258274 - `ticket:123#comment:description`
    259275
    260 === query: links ===
     276=== htdocs: links
     277
     278Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory].
     279
     280=== query: links
    261281
    262282See TracQuery#UsingTracLinks and [#ticket:links].
    263283
    264 === search: links ===
     284=== search: links
    265285
    266286See TracSearch#SearchLinks
    267287
    268 === ticket: links ===
    269  ''alias:'' `bug:`
     288=== ticket: links
     289
     290 ''aliases:'' `bug:`, `issue:`
    270291
    271292Besides 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.
     
    275296 - `ticket:1,150`
    276297
    277 ''(since Trac 0.11)''
    278 
    279 === timeline: links ===
    280 
    281 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.
     298=== timeline: links
     299
     300Links 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.
    282301
    283302Examples:
     
    286305 - `timeline:2008-01-29T15:48Z`
    287306 - `timeline:2008-01-29T16:48+01`
    288 
    289 ''(since Trac 0.11)''
    290 
    291 === wiki: links ===
    292 
    293 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.
    294 
    295 === Version Control related links ===
    296 ==== source: links ====
     307 - `timeline:2008-01-29T16:48+0100`
     308 - `timeline:2008-01-29T16:48+01:00`
     309
     310=== wiki: links
     311
     312See 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.
     313
     314=== Version Control related links
     315
     316It 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.
     317
     318For 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'`.
     319
     320==== source: links
     321
    297322 ''aliases:'' `browser:`, `repos:`
    298323
    299 The default behavior for a source:/some/path link is to open the browser in that directory directory
    300 if the path points to a directory or to show the latest content of the file.
     324The 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.
    301325
    302326It's also possible to link directly to a specific revision of a file like this:
    303327 - `source:/some/file@123` - link to the file's revision 123
    304328 - `source:/some/file@head` - link explicitly to the latest revision of the file
     329 - `source:/some/file@named-branch` - link to latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial)
    305330
    306331If the revision is specified, one can even link to a specific line number:
    307332 - `source:/some/file@123#L10`
    308333 - `source:/tag/0.10@head#L10`
     334 - `source:/some/file@named-branch#L10`
    309335
    310336Finally, one can also highlight an arbitrary set of lines:
    311  - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
    312    ''(since 0.11)''
     337 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99
     338 - or without version number (the `@` is still needed): `source:/some/file@:10-20,100,103#L99`. Version can be omitted when the path is pointing to a source file that will no longer change (like `source:/tags/...`), otherwise it's better to specify which lines of //which version// of the file you're talking about.
    313339
    314340Note 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)''
    315341
    316 ==== export: links ====
     342==== export: links
    317343
    318344To 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:
     
    320346 * `export:123:/some/file` - get revision 123 of the specified file
    321347 * `export:/some/file@123` - get revision 123 of the specified file
     348 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial).
    322349
    323350This 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.
     
    325352If 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`).
    326353
    327 ==== log: links ====
     354==== log: links
    328355
    329356The `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.
     
    333360 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    334361 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
     362 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial)
    335363
    336364There are short forms for revision ranges as well:
     
    345373----
    346374See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
    347