Edgewall Software

Changes between Version 74 and Version 75 of TracLinks


Ignore:
Timestamp:
Apr 10, 2010, 6:22:16 PM (14 years ago)
Author:
Christian Boos
Comment:

copied from 0.12/TracLinks@8

Legend:

Unmodified
Added
Removed
Modified

  • TracLinks

    v74 v75  
     1** Note: this page documents the 0.12 version of Trac, see 0.11/TracLinks if you need the previous version **
    12= Trac Links =
    23[[TracGuideToc]]
    … …  
    1718and any other text fields explicitly marked as supporting WikiFormatting.
    1819
    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''' (absolute path)
    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:1:ticket:2
    36  * Reports: {1} or report:1
    37  * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
    38  * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
    39  * 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
    40  * Wiki pages: CamelCase or wiki:CamelCase
    41  * Parent page: [..]
    42  * Milestones: milestone:1.0
    43  * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
    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
     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 Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`
     30 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
     31 Diffs :: `diff:@1:3`, `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
     32          or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
     33 Milestones :: `milestone:1.0`
     34 Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path)
     35 Files :: `source:trunk/COPYING`
     36 A specific file revision :: `source:/trunk/COPYING@200`
     37 A particular line of a specific file revision :: `source:/trunk/COPYING@200#L25`
     38}}}
     39{{{#!td
     40 Wiki pages :: CamelCase or wiki:CamelCase
     41 Parent page :: [..]
     42 Tickets :: #1 or ticket:1
     43 Ticket comments :: comment:1:ticket:2
     44 Reports :: {1} or report:1
     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:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
     48          or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
     49 Milestones :: milestone:1.0
     50 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
     51 Files :: source:trunk/COPYING
     52 A specific file revision :: source:/trunk/COPYING@200
     53 A particular line of a specific file revision :: source:/trunk/COPYING@200#L25
     54}}}
    4755
    4856'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    … …  
    5159to links to Wiki page names.
    5260
    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]
     61
     62{{{#!table class=""
     63|||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: ||
     64{{{#!td
     65{{{
     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{{{#!td
     71[ticket:1 This is a link to ticket number one] or
     72[[ticket:1|This is another link to ticket number one]].
     73}}}
     74|--------------------------------------------------------------------------------------
     75|||| If the title is omitted, only the id (the part after the colon) is displayed:  ||
     76{{{#!td
     77{{{
     78[ticket:1] or [[ticket:2]]
     79}}}
     80}}}
     81{{{#!td
     82[ticket:1] or [[ticket:2]]
     83}}}
     84|--------------------------------------------------------------------------------------
     85|||| `wiki` is the default if the namespace part of a full link is omitted:  ||
     86{{{#!td
     87{{{
     88[SandBox the sandbox] or
     89[[SandBox|the sandbox]]
     90}}}
     91}}}
     92{{{#!td
     93[SandBox the sandbox] or
     94[[SandBox|the sandbox]]
     95}}}
     96|--------------------------------------------------------------------------------------
     97|||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  ||
     98{{{#!td
     99{{{
     100<wiki:Strange(page@!)>
     101}}}
     102}}}
     103{{{#!td
     104<wiki:Strange(page@!)>
     105}}}
     106}}}
    77107
    78108TracLinks 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.
    … …  
    85115To create a link to a specific anchor in a page, use '#':
    86116{{{
    87  [#Relativelinks relative links]
     117 [#Relativelinks relative links] or [[#Relativelinks|relative links]]
    88118}}}
    89119Displays:
    90   [#Relativelinks relative links]
     120  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
    91121
    92122Hint: 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.
    … …  
    99129To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
    100130{{{
    101   [..]
    102 }}}
    103 
    104 To link from a [trac:SubWiki 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.
     131  [..] or [[..]]
     132}}}
     133  [..] or [[..]]
     134
     135To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
     136{{{
     137  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     138}}}
     139  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     140
     141But in practice you often won't need to add the `../` prefix to link to a sibling page.
     142For resolving the location of a wiki link, it's the target page closest in the hierarchy
     143to the page where the link is written which will be selected. So for example, within
     144a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
     145This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
     146
     147In order to link explicitly to a [=#toplevel toplevel] Wiki page,
     148use the `wiki:/` prefix.
     149Be careful **not** to use the `/` prefix alone, as this corresponds to the
     150[#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
     151part in the resulting URL.
     152
     153''(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.
     154See [#Server-relativelinks] for the new syntax.
    110155
    111156=== InterWiki links ===
    … …  
    117162This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
    118163
    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].
     164Any 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.
     165
     166A 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].
     167See InterTrac for the complete details.
    122168
    123169=== Server-relative links ===
    … …  
    131177
    132178{{{
    133 [/newticket Create a new ticket]
    134 [/ home]
    135 }}}
    136 
    137 Display: [/newticket Create a new ticket] [/ home]
     179[/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     180[/ home] or [[/|home]]
     181}}}
     182
     183Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     184[/ home] or [[/|home]]
    138185
    139186To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''):
    140187
    141188{{{
    142 [//register Register Here]
    143 }}}
    144 
    145 Display: [//register Register Here]
     189[//register Register Here] or [[//register|Register Here]]
     190}}}
     191
     192Display: [//register Register Here] or [[//register|Register Here]]
    146193
    147194=== Quoting space in TracLinks ===
    … …  
    155202 * !attachment:"the file.txt:ticket:123"
    156203
     204Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
     205 * ![[The whitespace convention]]
     206 * ![[attachment:the file.txt]]
     207
    157208=== Escaping Links ===
    158209
    … …  
    170221=== Parameterized Trac links ===
    171222
    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:
     223Many 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.
     224
     225Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
    175226 - `wiki:WikiStart?format=txt`
    176227 - `ticket:1?version=1`
    … …  
    179230
    180231== TracLinks Reference ==
    181 The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
     232The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
    182233
    183234=== attachment: links ===
    … …  
    198249=== comment: links ===
    199250
    200 When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment.
     251When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
    201252It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
    202  - !comment:3:ticket:123
    203  - !ticket:123#comment:3 (note that you can't write !#123#!comment:3!)
     253 - `comment:3:ticket:123`
     254 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
    204255It is also possible to link to the ticket's description using one of the following syntax:
    205  - !comment:description
    206  - !comment:description:ticket:123
    207  - !ticket:123#comment:description
     256 - `comment:description` (within the ticket)
     257 - `comment:description:ticket:123`
     258 - `ticket:123#comment:description`
    208259
    209260=== query: links ===
    … …  
    216267
    217268=== ticket: links ===
     269 ''alias:'' `bug:`
    218270
    219271Besides 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.
    … …  
    243295=== Version Control related links ===
    244296==== source: links ====
    245 
    246 The default behavior for a source:/some/path link is to open the directory browser
    247 if the path points to a directory and otherwise open the log view.
     297 ''aliases:'' `browser:`, `repos:`
     298
     299The default behavior for a source:/some/path link is to open the browser in that directory directory
     300if the path points to a directory or to show the latest content of the file.
    248301
    249302It's also possible to link directly to a specific revision of a file like this:
    … …  
    257310Finally, one can also highlight an arbitrary set of lines:
    258311 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
    259 ''(since 0.11)''
     312   ''(since 0.11)''
     313
     314Note 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)''
    260315
    261316==== export: links ====
    … …  
    272327==== log: links ====
    273328
    274 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.
     329The `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.
    275330 - `log:/` - the latest revisions starting at the root of the repository
    276331 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
    277332 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
    278  - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range
    279  - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path
     333 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
     334 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
    280335
    281336There are short forms for revision ranges as well:
    … …  
    284339 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
    285340
    286 Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`.
     341Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
     342
     343In 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]`.
    287344
    288345----