Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Jul 17, 2008 10:45:00 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v2  
    1717and any other text fields explicitly marked as supporting WikiFormatting. 
    1818 
    19 == Overview == 
    20  
    21 ||= Wiki Markup =||= Display =|| 
    22 {{{#!td 
    23  Wiki pages :: `CamelCase` or `wiki:CamelCase` 
    24  Parent page :: `[..]` 
    25  Tickets :: `#1` or `ticket:1` 
    26  Ticket comments :: `comment:1:ticket:2` 
    27  Reports :: `{1}` or `report:1` 
    28  Milestones :: `milestone:1.0` 
    29  Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path) 
    30  Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk` 
    31  Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]` 
    32  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           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 }}} 
    37 {{{#!td 
    38  Wiki pages :: CamelCase or wiki:CamelCase 
    39  Parent page :: [..] 
    40  Tickets :: #1 or ticket:1 
    41  Ticket comments :: comment:1:ticket:2  
    42  Reports :: {1} or report:1 
    43  Milestones :: milestone:1.0 
    44  Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path) 
    45  Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk 
    46  Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] 
    47  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           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 }}} 
     19Some 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''' 
     33Display: 
     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 
    5247 
    5348'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 
     
    5651to links to Wiki page names. 
    5752 
    58  
    59 {{{#!table class="" 
    60 |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: || 
    61 {{{#!td 
    62 {{{ 
    63 [ticket:1 This is a link to ticket number one] or 
    64 [[ticket:1|This is another link to ticket number one]]. 
    65 }}} 
    66 }}} 
    67 {{{#!td 
    68 [ticket:1 This is a link to ticket number one] or 
    69 [[ticket:1|This is another link to ticket number one]]. 
    70 }}} 
    71 |-------------------------------------------------------------------------------------- 
    72 |||| If the title is omitted, only the id (the part after the colon) is displayed:  || 
    73 {{{#!td 
    74 {{{ 
    75 [ticket:1] or [[ticket:2]] 
    76 }}} 
    77 }}} 
    78 {{{#!td 
    79 [ticket:1] or [[ticket:2]] 
    80 }}} 
    81 |-------------------------------------------------------------------------------------- 
    82 |||| `wiki` is the default if the namespace part of a full link is omitted:  ||  
    83 {{{#!td 
    84 {{{ 
    85 [SandBox the sandbox] or 
    86 [[SandBox|the sandbox]] 
    87 }}} 
    88 }}} 
    89 {{{#!td 
    90 [SandBox the sandbox] or 
    91 [[SandBox|the sandbox]] 
    92 }}} 
    93 |-------------------------------------------------------------------------------------- 
    94 |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  || 
    95 {{{#!td 
    96 {{{ 
    97 <wiki:Strange(page@!)> 
    98 }}} 
    99 }}} 
    100 {{{#!td 
    101 <wiki:Strange(page@!)> 
    102 }}} 
    103 }}} 
     53Trac links using the full (non-shorthand) notation can also be given a custom 
     54link title like this: 
     55 
     56{{{ 
     57[ticket:1 This is a link to ticket number one]. 
     58}}} 
     59 
     60Display: [ticket:1 This is a link to ticket number one]. 
     61 
     62If the title is omitted, only the id (the part after the colon) is displayed: 
     63 
     64{{{ 
     65[ticket:1] 
     66}}} 
     67 
     68Display: [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 
     76Display: [SandBox the sandbox] 
    10477 
    10578TracLinks 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. 
     
    11285To create a link to a specific anchor in a page, use '#': 
    11386{{{ 
    114  [#Relativelinks relative links] or [[#Relativelinks|relative links]] 
     87 [#Relativelinks relative links] 
    11588}}} 
    11689Displays: 
    117   [#Relativelinks relative links] or [[#Relativelinks|relative links]] 
     90  [#Relativelinks relative links] 
    11891 
    11992Hint: 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. 
    12093 
    121 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 
     94To create a link to a SubWiki-page just use a '/': 
    12295{{{ 
    12396 WikiPage/SubWikiPage or ./SubWikiPage 
    12497}}} 
    12598 
    126 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 
    127 {{{ 
    128   [..] or [[..]] 
    129 }}} 
    130   [..] or [[..]] 
    131  
    132 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../': 
    133 {{{ 
    134   [../Sibling see next sibling] or [[../Sibling|see next sibling]] 
    135 }}} 
    136   [../Sibling see next sibling] or [[../Sibling|see next sibling]] 
    137  
    138 But in practice you often won't need to add the `../` prefix to link to a sibling page. 
    139 For resolving the location of a wiki link, it's the target page closest in the hierarchy 
    140 to the page where the link is written which will be selected. So for example, within  
    141 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page. 
    142 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 
    143  
    144 In order to link explicitly to a [=#toplevel toplevel] Wiki page, 
    145 use the `wiki:/` prefix. 
    146 Be careful **not** to use the `/` prefix alone, as this corresponds to the 
    147 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`  
    148 part in the resulting URL. 
    149  
    150 ''(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.  
    151 See [#Server-relativelinks] for the new syntax. 
     99To link from a SubWiki page to a parent, simply use a '..': 
     100{{{ 
     101  [..] 
     102}}} 
     103 
     104To 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. 
    152110 
    153111=== InterWiki links === 
     
    159117This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 
    160118 
    161 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.  
    162  
    163 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]. 
    164 See InterTrac for the complete details.  
     119Any 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 
     121A 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]. 
    165122 
    166123=== Server-relative links === 
     
    174131 
    175132{{{ 
    176 [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 
    177 [/ home] or [[/|home]] 
    178 }}} 
    179  
    180 Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 
    181 [/ home] or [[/|home]] 
    182  
    183 To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''): 
    184  
    185 {{{ 
    186 [//register Register Here] or [[//register|Register Here]] 
    187 }}} 
    188  
    189 Display: [//register Register Here] or [[//register|Register Here]] 
     133[/newticket Create a new ticket] 
     134[/ home] 
     135}}} 
     136 
     137Display: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]]  [/ home] 
     138 
     139To 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 
     145Display: [//register Register Here] 
    190146 
    191147=== Quoting space in TracLinks === 
     
    197153 * !attachment:'the file.txt' or 
    198154 * !attachment:"the file.txt"  
    199  * !attachment:"the file.txt:ticket:123"  
    200  
    201 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces: 
    202  * ![[The whitespace convention]] 
    203  * ![[attachment:the file.txt]] 
     155 * !attachment:"ticket:123:the file.txt"  
    204156 
    205157=== Escaping Links === 
     
    218170=== Parameterized Trac links === 
    219171 
    220 Many Trac resources have more than one way to be rendered, depending on some extra parameters. For example, a Wiki page can accept a `version` or a `format` parameter, a report can make use of dynamic variables, etc. 
    221  
    222 Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: 
     172The 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 
     174Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: 
    223175 - `wiki:WikiStart?format=txt` 
    224176 - `ticket:1?version=1` 
    225177 - `[/newticket?component=module1 create a ticket for module1]` 
    226  - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 
    227178 
    228179 
    229180== TracLinks Reference == 
    230 The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 
     181The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 
    231182 
    232183=== attachment: links === 
     
    234185The link syntax for attachments is as follows: 
    235186 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 
    236  * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page 
    237  * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 
    238  
    239 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt. 
    240  
    241 If you'd like to create a direct link to the content of the attached file instead of a link to the attachment page, simply use `raw-attachment:` instead of `attachment:`. 
    242  
    243 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. 
    244  
    245 See also [#export:links]. 
    246  
    247 === comment: links === 
    248  
    249 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. 
    250 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 
    251  - `comment:3:ticket:123`  
    252  - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!) 
    253 It is also possible to link to the ticket's description using one of the following syntax: 
    254  - `comment:description` (within the ticket) 
    255  - `comment:description:ticket:123` 
    256  - `ticket:123#comment:description` 
    257  
    258 === htdocs: links === 
    259  
    260 Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory]. 
     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 
    261189 
    262190=== query: links === 
     
    269197 
    270198=== ticket: links === 
    271  ''alias:'' `bug:` 
    272199 
    273200Besides 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. 
     
    286213 - `timeline:2008-01-29` 
    287214 - `timeline:2008-01-29T15:48` 
    288  - `timeline:2008-01-29T15:48Z` 
    289  - `timeline:2008-01-29T16:48+01` 
     215 - `timeline:2008-01-29T16:48Z+01` 
    290216 
    291217''(since Trac 0.11)'' 
     
    293219=== wiki: links === 
    294220 
    295 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. It is possible to create a link to a specific page revision using the syntax WikiStart@1. 
     221See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. 
    296222 
    297223=== Version Control related links === 
    298  
    299 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). 
    300  
    301 For example, `source:/trunk/COPYING` targets the path `/trunk/COPYING` in the default repository, whereas `source:/projectA/trunk/COPYING` targets the path `/trunk/COPYING` in the repository named `projectA`. This can be the same file if `'projectA'` is an alias to the default repository or if `''` (the default repository) is an alias to `'projectA'`. 
    302  
    303224==== source: links ==== 
    304  ''aliases:'' `browser:`, `repos:` 
    305  
    306 The default behavior for a source:/some/path link is to open the browser in that directory directory  
    307 if the path points to a directory or to show the latest content of the file. 
     225 
     226The default behavior for a source:/some/path link is to open the directory browser  
     227if the path points to a directory and otherwise open the log view. 
    308228 
    309229It's also possible to link directly to a specific revision of a file like this: 
     
    317237Finally, one can also highlight an arbitrary set of lines: 
    318238 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. 
    319    ''(since 0.11)'' 
    320  
    321 Note that in presence of multiple repositories, the name of the repository is simply integrated in the path you specify for `source:` (e.g. `source:reponame/trunk/README`). ''(since 0.12)'' 
     239''(since 0.11)'' 
    322240 
    323241==== export: links ==== 
     
    328246 * `export:/some/file@123` - get revision 123 of the specified file 
    329247 
    330 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.  
    331  
    332 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`). 
     248This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository. 
     249 
     250If 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`. 
    333251 
    334252==== log: links ==== 
    335253 
    336 The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions of the specified path, but it can also support displaying an arbitrary set of revisions. 
     254The `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. 
    337255 - `log:/` - the latest revisions starting at the root of the repository 
    338256 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 
    339257 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000 
    340  - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795  
    341  - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path 
     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 
    342260 
    343261There are short forms for revision ranges as well: 
     
    346264 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`) 
    347265 
    348 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`. 
    349  
    350 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]`. 
     266Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`. 
    351267 
    352268----