Changes between Version 3 and Version 4 of TracLinks


Ignore:
Timestamp:
Apr 4, 2012, 2:28:19 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracLinks

    v3 v4  
    1717and any other text fields explicitly marked as supporting WikiFormatting.
    1818
    19 == Overview ==
    20 
    21 ||= Wiki Markup =||= Display =||
    22 {{{
    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 {{{
    40 #!td
    41  Wiki pages :: CamelCase or wiki:CamelCase
    42  Parent page :: [..]
    43  Tickets :: #1 or ticket:1
    44  Ticket comments :: comment:1:ticket:2
    45  Reports :: {1} or report:1
    46  Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
    47  Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
    48  Diffs :: diff:@1:3, 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  Milestones :: milestone:1.0
    51  Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
    52  Files :: source:trunk/COPYING
    53  A specific file revision :: source:/trunk/COPYING@200
    54  A particular line of a specific file revision :: source:/trunk/COPYING@200#L25
    55 }}}
     19Some 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'''
     34Display:
     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
    5649
    5750'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    … …  
    6053to links to Wiki page names.
    6154
    62 
    63 {{{
    64 #!table class=""
    65 |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: ||
    66 {{{
    67 #!td
    68 {{{
    69 [ticket:1 This is a link to ticket number one] or
    70 [[ticket:1|This is another link to ticket number one]].
    71 }}}
    72 }}}
    73 {{{
    74 #!td
    75 [ticket:1 This is a link to ticket number one] or
    76 [[ticket:1|This is another link to ticket number one]].
    77 }}}
    78 |--------------------------------------------------------------------------------------
    79 |||| If the title is omitted, only the id (the part after the colon) is displayed:  ||
    80 {{{
    81 #!td
    82 {{{
    83 [ticket:1] or [[ticket:2]]
    84 }}}
    85 }}}
    86 {{{
    87 #!td
    88 [ticket:1] or [[ticket:2]]
    89 }}}
    90 |--------------------------------------------------------------------------------------
    91 |||| `wiki` is the default if the namespace part of a full link is omitted:  ||
    92 {{{
    93 #!td
    94 {{{
    95 [SandBox the sandbox] or
    96 [[SandBox|the sandbox]]
    97 }}}
    98 }}}
    99 {{{
    100 #!td
    101 [SandBox the sandbox] or
    102 [[SandBox|the sandbox]]
    103 }}}
    104 |--------------------------------------------------------------------------------------
    105 |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  ||
    106 {{{
    107 #!td
    108 {{{
    109 <wiki:Strange(page@!)>
    110 }}}
    111 }}}
    112 {{{
    113 #!td
    114 <wiki:Strange(page@!)>
    115 }}}
    116 }}}
     55Trac links using the full (non-shorthand) notation can also be given a custom
     56link title like this:
     57
     58{{{
     59[ticket:1 This is a link to ticket number one].
     60}}}
     61
     62Display: [ticket:1 This is a link to ticket number one].
     63
     64If the title is omitted, only the id (the part after the colon) is displayed:
     65
     66{{{
     67[ticket:1]
     68}}}
     69
     70Display: [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
     78Display: [SandBox the sandbox]
    11779
    11880TracLinks 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.
    … …  
    12587To create a link to a specific anchor in a page, use '#':
    12688{{{
    127  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     89 [#Relativelinks relative links]
    12890}}}
    12991Displays:
    130   [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     92  [#Relativelinks relative links]
    13193
    13294Hint: 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.
    … …  
    139101To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
    140102{{{
    141   [..] or [[..]]
    142 }}}
    143   [..] or [[..]]
    144 
    145 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
    146 {{{
    147   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    148 }}}
    149   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    150 
    151 But in practice you often won't need to add the `../` prefix to link to a sibling page.
    152 For resolving the location of a wiki link, it's the target page closest in the hierarchy
    153 to the page where the link is written which will be selected. So for example, within
    154 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
    155 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    156 
    157 In order to link explicitly to a [=#toplevel toplevel] Wiki page,
    158 use the `wiki:/` prefix.
    159 Be careful **not** to use the `/` prefix alone, as this corresponds to the
    160 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
    161 part in the resulting URL.
    162 
    163 ''(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.
    164 See [#Server-relativelinks] for the new syntax.
     103  [..]
     104}}}
     105
     106To 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.
    165112
    166113=== InterWiki links ===
    … …  
    172119This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
    173120
    174 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.
    175 
    176 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].
    177 See InterTrac for the complete details.
     121Any 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
     123A 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].
    178124
    179125=== Server-relative links ===
    … …  
    187133
    188134{{{
    189 [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
    190 [/ home] or [[/|home]]
    191 }}}
    192 
    193 Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
    194 [/ home] or [[/|home]]
    195 
    196 To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''):
    197 
    198 {{{
    199 [//register Register Here] or [[//register|Register Here]]
    200 }}}
    201 
    202 Display: [//register Register Here] or [[//register|Register Here]]
     135[/newticket Create a new ticket]
     136[/ home]
     137}}}
     138
     139Display: [/newticket newticket] [/ home]
     140
     141To 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
     147Display: [//register Register Here]
    203148
    204149=== Quoting space in TracLinks ===
    … …  
    212157 * !attachment:"the file.txt:ticket:123"
    213158
    214 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
    215  * ![[The whitespace convention]]
    216  * ![[attachment:the file.txt]]
    217 
    218159=== Escaping Links ===
    219160
    … …  
    231172=== Parameterized Trac links ===
    232173
    233 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.
    234 
    235 Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
     174The 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
     176Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
    236177 - `wiki:WikiStart?format=txt`
    237178 - `ticket:1?version=1`
    238179 - `[/newticket?component=module1 create a ticket for module1]`
    239  - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
    240180
    241181
    242182== TracLinks Reference ==
    243 The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
     183The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
    244184
    245185=== attachment: links ===
    … …  
    260200=== comment: links ===
    261201
    262 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
    263 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
    264  - `comment:3:ticket:123`
    265  - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
    266 It is also possible to link to the ticket's description using one of the following syntax:
    267  - `comment:description` (within the ticket)
    268  - `comment:description:ticket:123`
    269  - `ticket:123#comment:description`
     202When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment.
     203It'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!)
    270206
    271207=== query: links ===
    … …  
    278214
    279215=== ticket: links ===
    280  ''alias:'' `bug:`
    281216
    282217Besides 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.
    … …  
    295230 - `timeline:2008-01-29`
    296231 - `timeline:2008-01-29T15:48`
    297  - `timeline:2008-01-29T15:48Z`
    298  - `timeline:2008-01-29T16:48+01`
     232 - `timeline:2008-01-29T16:48Z+01`
    299233
    300234''(since Trac 0.11)''
    … …  
    306240=== Version Control related links ===
    307241==== source: links ====
    308  ''aliases:'' `browser:`, `repos:`
    309 
    310 The default behavior for a source:/some/path link is to open the browser in that directory directory
    311 if the path points to a directory or to show the latest content of the file.
     242
     243The default behavior for a source:/some/path link is to open the directory browser
     244if the path points to a directory and otherwise open the log view.
    312245
    313246It's also possible to link directly to a specific revision of a file like this:
    … …  
    321254Finally, one can also highlight an arbitrary set of lines:
    322255 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
    323    ''(since 0.11)''
    324 
    325 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)''
     256''(since 0.11)''
    326257
    327258==== export: links ====
    … …  
    338269==== log: links ====
    339270
    340 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.
     271The `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.
    341272 - `log:/` - the latest revisions starting at the root of the repository
    342273 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
    343274 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
    344  - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    345  - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
     275 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range
     276 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path
    346277
    347278There are short forms for revision ranges as well:
    … …  
    350281 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
    351282
    352 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
    353 
    354 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]`.
     283Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`.
    355284
    356285----