Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Dec 6, 2012, 11:36:21 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 Some examples: 
    20  * Tickets: '''!#1''' or '''!ticket:1''' 
    21  * Ticket comments: '''!comment:1:ticket:2'''  
    22  * Reports: '''!{1}''' or '''!report:1''' 
    23  * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' 
    24  * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''', '''![2:5/trunk]''' 
    25  * Diffs (requires [trac: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:example.tgz''' (for current page attachment), '''!attachment:attachment.1073.diff:ticket:944'''  
    30 (absolute path) 
    31  * Files: '''!source:trunk/COPYING''' 
    32  * A specific file revision: '''!source:/trunk/COPYING@200''' 
    33  * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' 
    34 Display: 
    35  * Tickets: #1 or ticket:1 
    36  * Ticket comments: comment:1:ticket:2  
    37  * Reports: {1} or report:1 
    38  * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk 
    39  * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] 
    40  * 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 
    41  * Wiki pages: CamelCase or wiki:CamelCase 
    42  * Parent page: [..] 
    43  * Milestones: milestone:1.0 
    44  * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944  
    45 (absolute path) 
    46  * Files: source:trunk/COPYING 
    47  * A specific file revision: source:/trunk/COPYING@200 
    48  * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 
     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}}} 
    4952 
    5053'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 
    … …  
    5356to links to Wiki page names. 
    5457 
    55 Trac links using the full (non-shorthand) notation can also be given a custom 
    56 link title like this: 
    57  
    58 {{{ 
    59 [ticket:1 This is a link to ticket number one]. 
    60 }}} 
    61  
    62 Display: [ticket:1 This is a link to ticket number one]. 
    63  
    64 If the title is omitted, only the id (the part after the colon) is displayed: 
    65  
    66 {{{ 
    67 [ticket:1] 
    68 }}} 
    69  
    70 Display: [ticket:1] 
    71  
    72 `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''): 
    73  
    74 {{{ 
    75 [SandBox the sandbox] 
    76 }}} 
    77  
    78 Display: [SandBox the sandbox] 
     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}}} 
    79104 
    80105TracLinks 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. 
    … …  
    85110=== Relative links === 
    86111 
     112To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 
     113{{{ 
     114 WikiPage/SubWikiPage or ./SubWikiPage 
     115}}} 
     116 
     117To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 
     118{{{ 
     119  [..] or [[..]] 
     120}}} 
     121  [..] or [[..]] 
     122 
     123To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../': 
     124{{{ 
     125  [../Sibling see next sibling] or [[../Sibling|see next sibling]] 
     126}}} 
     127  [../Sibling see next sibling] or [[../Sibling|see next sibling]] 
     128 
     129But in practice you often won't need to add the `../` prefix to link to a sibling page. 
     130For resolving the location of a wiki link, it's the target page closest in the hierarchy 
     131to the page where the link is written which will be selected. So for example, within  
     132a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page. 
     133This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. 
     134 
     135In order to link explicitly to a [=#toplevel toplevel] Wiki page, 
     136use the `wiki:/` prefix. 
     137Be careful **not** to use the `/` prefix alone, as this corresponds to the 
     138[#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`  
     139part in the resulting URL. 
     140 
     141''(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.  
     142See [#Server-relativelinks] for the new syntax. 
     143 
     144=== Link anchors === 
     145 
    87146To create a link to a specific anchor in a page, use '#': 
    88147{{{ 
    89  [#Relativelinks relative links] 
    90 }}} 
    91 Displays: 
    92   [#Relativelinks relative links] 
     148 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 
     149}}} 
     150  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] 
    93151 
    94152Hint: 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. 
    95153 
    96 To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 
    97 {{{ 
    98  WikiPage/SubWikiPage or ./SubWikiPage 
    99 }}} 
    100  
    101 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 
    102 {{{ 
    103   [..] 
    104 }}} 
    105  
    106 To link from a [trac:SubWiki SubWiki] page to a sibling page, use a '../': 
    107 {{{ 
    108   [../Sibling see next sibling] 
    109 }}} 
    110  
    111 ''(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. 
     154To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?': 
     155{{{ 
     156 [#/Milestone first occurrence of Milestone] or 
     157 [#?Milestone last occurrence of Milestone] 
     158}}} 
     159 [#/Milestone first occurrence of Milestone] or 
     160 [#?Milestone last occurrence of Milestone] 
     161This 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': 
     162{{{ 
     163 [#/Milestone/i first occurrence of Milestone or milestone] or 
     164 [#?Milestone/i last occurrence of Milestone or milestone] 
     165}}} 
     166 [#/Milestone/i first occurrence of Milestone or milestone] or 
     167 [#?Milestone/i last occurrence of Milestone or milestone] 
     168 
     169''(since Trac 1.0)'' 
     170 
     171Such anchors can be very useful for linking to specific lines in a file in the source browser: 
     172{{{ 
     173 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or 
     174 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47] 
     175}}} 
     176 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or 
     177 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47] 
     178(Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.) 
     179 
     180Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead: 
     181{{{ 
     182 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or 
     183 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 
     184}}} 
     185 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or 
     186 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] 
    112187 
    113188=== InterWiki links === 
    … …  
    119194This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 
    120195 
    121 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.  
    122  
    123 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]. 
     196Any 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.  
     197 
     198A 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]. 
     199See InterTrac for the complete details.  
    124200 
    125201=== Server-relative links === 
    … …  
    133209 
    134210{{{ 
    135 [/newticket Create a new ticket] 
    136 [/ home] 
    137 }}} 
    138  
    139 Display: [/newticket Create a new ticket] [/ home] 
    140  
    141 To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''): 
    142  
    143 {{{ 
    144 [//register Register Here] 
    145 }}} 
    146  
    147 Display: [//register Register Here] 
     211[/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 
     212[/ home] or [[/|home]] 
     213}}} 
     214 
     215Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] 
     216[/ home] or [[/|home]] 
     217 
     218To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''): 
     219 
     220{{{ 
     221[//register Register Here] or [[//register|Register Here]] 
     222}}} 
     223 
     224Display: [//register Register Here] or [[//register|Register Here]] 
    148225 
    149226=== Quoting space in TracLinks === 
    … …  
    157234 * !attachment:"the file.txt:ticket:123"  
    158235 
     236Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces: 
     237 * ![[The whitespace convention]] 
     238 * ![[attachment:the file.txt]] 
     239 
    159240=== Escaping Links === 
    160241 
    … …  
    172253=== Parameterized Trac links === 
    173254 
    174 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. 
    175  
    176 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: 
     255Many 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. 
     256 
     257Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: 
    177258 - `wiki:WikiStart?format=txt` 
    178259 - `ticket:1?version=1` 
    179260 - `[/newticket?component=module1 create a ticket for module1]` 
     261 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` 
    180262 
    181263 
    182264== TracLinks Reference == 
    183 The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 
     265The following sections describe the individual link types in detail, as well as notes on advanced usage of links. 
    184266 
    185267=== attachment: links === 
    … …  
    200282=== comment: links === 
    201283 
    202 When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment. 
    203 It's also possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 
    204  - !comment:3:ticket:123  
    205  - !ticket:123#comment:3 (note that you can't write !#123#!comment:3!) 
     284When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. 
     285It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: 
     286 - `comment:3:ticket:123`  
     287 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!) 
     288It is also possible to link to the ticket's description using one of the following syntax: 
     289 - `comment:description` (within the ticket) 
     290 - `comment:description:ticket:123` 
     291 - `ticket:123#comment:description` 
     292 
     293=== htdocs: links === 
     294 
     295Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory]. 
    206296 
    207297=== query: links === 
    … …  
    214304 
    215305=== ticket: links === 
     306 ''alias:'' `bug:` 
    216307 
    217308Besides 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. 
    … …  
    237328=== wiki: links === 
    238329 
    239 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. 
     330See 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. 
    240331 
    241332=== Version Control related links === 
     333 
     334It 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). 
     335 
     336For 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'`. 
     337 
    242338==== source: links ==== 
    243  
    244 The default behavior for a source:/some/path link is to open the directory browser  
    245 if the path points to a directory and otherwise open the log view. 
     339 ''aliases:'' `browser:`, `repos:` 
     340 
     341The default behavior for a source:/some/path link is to open the browser in that directory directory  
     342if the path points to a directory or to show the latest content of the file. 
    246343 
    247344It's also possible to link directly to a specific revision of a file like this: 
    … …  
    255352Finally, one can also highlight an arbitrary set of lines: 
    256353 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. 
    257 ''(since 0.11)'' 
     354   ''(since 0.11)'' 
     355 
     356Note that in presence of multiple repositories, the name of the repository is simply integrated in the path you specify for `source:` (e.g. `source:reponame/trunk/README`). ''(since 0.12)'' 
    258357 
    259358==== export: links ==== 
    … …  
    270369==== log: links ==== 
    271370 
    272 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. 
     371The `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. 
    273372 - `log:/` - the latest revisions starting at the root of the repository 
    274373 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 
    275374 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000 
    276  - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range 
    277  - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path 
     375 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795  
     376 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path 
    278377 
    279378There are short forms for revision ranges as well: 
    … …  
    282381 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`) 
    283382 
    284 Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`. 
     383Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`. 
     384 
     385In 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]`. 
    285386 
    286387----