Changes between Version 2 and Version 3 of TracLinks


Ignore:
Timestamp:
2017-08-28T06:33:43Z (3 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 Some examples:
    20  * Tickets: '''!#1''' or '''!ticket:1'''
    21  * Ticket comments: '''!comment:ticket:1:2'''
    22  * Reports: '''!{1}''' or '''!report:1'''
    23  * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''', '''![2:5/trunk]'''
    24  * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3'''
    25  * 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'''
    26  * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase'''
    27  * Parent page: '''![..]'''
    28  * Milestones: '''!milestone:1.0'''
    29  * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
    30  * Files: '''!source:trunk/COPYING'''
    31  * A specific file revision: '''!source:/trunk/COPYING@200'''
    32  * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25'''
    33 Display:
    34  * Tickets: #1 or ticket:1
    35  * Ticket comments: comment:ticket:1:2
    36  * Reports: {1} or report:1
    37  * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk, [2:5/trunk]
    38  * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3
    39  * Diffs (requires [milestone:0.10 0.10]): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539
    40  * Wiki pages: CamelCase or wiki:CamelCase
    41  * Parent page: '''[..]'''
    42  * Milestones: milestone:1.0
    43  * Attachment: attachment:ticket:944:attachment.1073.diff
    44  * Files: source:trunk/COPYING
    45  * A specific file revision: source:/trunk/COPYING@200
    46  * A particular line of a specific file revision: source:/trunk/COPYING@200#L25
    47 
    48 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    49 pages whose names do not follow WikiPageNames rules, i.e., single words,
    50 non-alphabetic characters, etc. See WikiPageNames for more about features specific
    51 to links to Wiki page names.
    52 
    53 Trac links using the full (non-shorthand) notation can also be given a custom
    54 link title like this:
    55 
    56 {{{
    57 [ticket:1 This is a link to ticket number one].
    58 }}}
    59 
    60 Display: [ticket:1 This is a link to ticket number one].
    61 
    62 If the title is omitted, only the id (the part after the colon) is displayed:
    63 
    64 {{{
    65 [ticket:1]
    66 }}}
    67 
    68 Display: [ticket:1]
    69 
    70 `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):
    71 
    72 {{{
    73 [SandBox the sandbox]
    74 }}}
    75 
    76 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)
     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)
     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}}}
    77112
    78113TracLinks 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.
    79114
    80 
    81 == Advanced use of TracLinks ==
    82 
    83 === 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 '/':
     120{{{
     121 WikiPage/SubWikiPage or ./SubWikiPage
     122}}}
     123
     124To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
     125{{{
     126  [..] or [[..]]
     127}}}
     128  [..] or [[..]]
     129
     130To 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
     136But in practice you often won't need to add the `../` prefix to link to a sibling 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 toplevel 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
     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
    84143
    85144To create a link to a specific anchor in a page, use '#':
    86145{{{
    87  [#Relativelinks relative links]
    88 }}}
    89 Displays:
    90   [#Relativelinks relative links]
     146 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
     147}}}
     148  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
    91149
    92150Hint: 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.
    93151
    94 To create a link to a SubWiki-page just use a '/':
    95 {{{
    96  WikiPage/SubWikiPage or ./SubWikiPage
    97 }}}
    98 
    99 To link from a SubWiki page to a parent, simply use a '..':
    100 {{{
    101   [..]
    102 }}}
    103 
    104 To link from a SubWiki page to a sibling page, use a '../':
    105 {{{
    106   [../Sibling see next sibling]
    107 }}}
    108 
    109 ''(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.
    110 
    111 === InterWiki links ===
    112 
    113 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.
    114 
    115 === InterTrac links ===
     152To 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]
     159This 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
     169Such 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
     178Since 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
     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
    116191
    117192This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
    118193
    119 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.
    120 
    121 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].
    122 
    123 === Server-relative links ===
    124 
    125 It is often useful to be able to link to objects in your project that
    126 have no built-in Trac linking mechanism, such as static resources, `newticket`,
    127 a shared `/register` page on the server, etc.
    128 
    129 To link to resources inside the project, use either an absolute path from the project root,
    130 or a relative link from the URL of the current page (''Changed in 0.11''):
    131 
    132 {{{
    133 [/newticket Create a new ticket]
    134 [/ home]
    135 }}}
    136 
    137 Display: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]]  [/ home]
    138 
    139 To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''):
    140 
    141 {{{
    142 [//register Register Here]
    143 }}}
    144 
    145 Display: [//register Register Here]
    146 
    147 === Quoting space in TracLinks ===
    148 
    149 Immediately after a TracLinks prefix, targets containing space characters should
    150 be enclosed in a pair of quotes or double quotes.
     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 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].
     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''):
     204
     205{{{
     206[/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     207[/ home] or [[/|home]]
     208}}}
     209
     210Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     211[/ home] or [[/|home]]
     212
     213To 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
     219Display: [//register Register Here] or [[//register|Register Here]]
     220
     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.
    151224Examples:
    152225 * !wiki:"The whitespace convention"
    153226 * !attachment:'the file.txt' or
    154227 * !attachment:"the file.txt"
    155  * !attachment:"ticket:123:the file.txt"
    156 
    157 === Escaping Links ===
     228 * !attachment:"the file.txt:ticket:123"
     229
     230Note 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
    158235
    159236To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     
    167244 ![42] is not a link either.
    168245
    169 
    170 === Parameterized Trac links ===
    171 
    172 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.
    173 
    174 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
     248Many 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
     250Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
    175251 - `wiki:WikiStart?format=txt`
    176252 - `ticket:1?version=1`
    177253 - `[/newticket?component=module1 create a ticket for module1]`
    178 
    179 
    180 == TracLinks Reference ==
    181 The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
    182 
    183 === attachment: links ===
     254 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
     255
     256== TracLinks Reference
     257
     258The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
     259
     260=== attachment: links
    184261
    185262The link syntax for attachments is as follows:
    186263 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
    187  * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page
    188  * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753
    189 
    190 === query: links ===
     264 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
     265 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
     266
     267Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt, but is not recommended.
     268
     269If 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:`.
     270
     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 `[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.
     272
     273See also [#export:links].
     274
     275=== comment: links
     276
     277When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
     278It 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`!)
     281It 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
     288Use `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
    191291
    192292See TracQuery#UsingTracLinks and [#ticket:links].
    193293
    194 === search: links ===
     294=== search: links
    195295
    196296See TracSearch#SearchLinks
    197297
    198 === ticket: links ===
     298=== ticket: links
     299
     300 ''aliases:'' `bug:`, `issue:`
    199301
    200302Besides 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.
     
    204306 - `ticket:1,150`
    205307
    206 ''(since Trac 0.11)''
    207 
    208 === timeline: links ===
    209 
    210 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
     310Links 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.
    211311
    212312Examples:
    213313 - `timeline:2008-01-29`
    214314 - `timeline:2008-01-29T15:48`
    215  - `timeline:2008-01-29T16:48Z+01`
    216 
    217 ''(since Trac 0.11)''
    218 
    219 === wiki: links ===
    220 
    221 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.
    222 
    223 === Version Control related links ===
    224 ==== source: links ====
    225 
    226 The default behavior for a source:/some/path link is to open the directory browser
    227 if the path points to a directory and otherwise open the log view.
     315 - `timeline:2008-01-29T15:48Z`
     316 - `timeline:2008-01-29T16:48+01`
     317 - `timeline:2008-01-29T16:48+0100`
     318 - `timeline:2008-01-29T16:48+01:00`
     319
     320=== wiki: links
     321
     322See 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 related 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 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.
     327
     328For 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
     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.
    228335
    229336It's also possible to link directly to a specific revision of a file like this:
    230337 - `source:/some/file@123` - link to the file's revision 123
    231338 - `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)
    232340
    233341If the revision is specified, one can even link to a specific line number:
    234342 - `source:/some/file@123#L10`
    235343 - `source:/tag/0.10@head#L10`
     344 - `source:/some/file@named-branch#L10`
    236345
    237346Finally, one can also highlight an arbitrary set of lines:
    238  - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
    239 ''(since 0.11)''
    240 
    241 ==== 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
     350Note 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
    242353
    243354To 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:
     
    245356 * `export:123:/some/file` - get revision 123 of the specified file
    246357 * `export:/some/file@123` - get revision 123 of the specified file
    247 
    248 This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository.
    249 
    250 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`.
    251 
    252 ==== log: links ====
    253 
    254 The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions from the specified path, but it can also support displaying an arbitrary set of revisions.
     358 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial).
     359
     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 `[browser] render_unsafe_content = yes` (see TracIni#browser-section), otherwise Trac will force the files to be downloaded as attachments for security concerns.
     361
     362If 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`).
     363
     364==== log: links
     365
     366The `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.
    255367 - `log:/` - the latest revisions starting at the root of the repository
    256368 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
    257369 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
    258  - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range
    259  - `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)
    260373
    261374There are short forms for revision ranges as well:
     
    264377 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
    265378
    266 Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`.
     379Finally, 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
     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`
    267387
    268388----
    269389See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
    270