Changes between Version 4 and Version 5 of TracLinks


Ignore:
Timestamp:
Apr 13, 2010, 3:53:03 AM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v4 v5  
    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  Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`
    29  Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
    30  Diffs :: `diff:@1:3`, `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
    31           or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
    32  Milestones :: `milestone:1.0`
    33  Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path)
    34  Files :: `source:trunk/COPYING`
    35  A specific file revision :: `source:/trunk/COPYING@200`
    36  A particular line of a specific file revision :: `source:/trunk/COPYING@200#L25`
    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  Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
    45  Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
    46  Diffs :: diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
    47           or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
    48  Milestones :: milestone:1.0
    49  Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
    50  Files :: source:trunk/COPYING
    51  A specific file revision :: source:/trunk/COPYING@200
    52  A particular line of a specific file revision :: source:/trunk/COPYING@200#L25
    53 }}}
     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
    5449
    5550'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
     
    5853to links to Wiki page names.
    5954
    60 
    61 {{{#!table class=""
    62 |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: ||
    63 {{{#!td
    64 {{{
    65 [ticket:1 This is a link to ticket number one] or
    66 [[ticket:1|This is another link to ticket number one]].
    67 }}}
    68 }}}
    69 {{{#!td
    70 [ticket:1 This is a link to ticket number one] or
    71 [[ticket:1|This is another link to ticket number one]].
    72 }}}
    73 |--------------------------------------------------------------------------------------
    74 |||| If the title is omitted, only the id (the part after the colon) is displayed:  ||
    75 {{{#!td
    76 {{{
    77 [ticket:1] or [[ticket:2]]
    78 }}}
    79 }}}
    80 {{{#!td
    81 [ticket:1] or [[ticket:2]]
    82 }}}
    83 |--------------------------------------------------------------------------------------
    84 |||| `wiki` is the default if the namespace part of a full link is omitted:  ||
    85 {{{#!td
    86 {{{
    87 [SandBox the sandbox] or
    88 [[SandBox|the sandbox]]
    89 }}}
    90 }}}
    91 {{{#!td
    92 [SandBox the sandbox] or
    93 [[SandBox|the sandbox]]
    94 }}}
    95 |--------------------------------------------------------------------------------------
    96 |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  ||
    97 {{{#!td
    98 {{{
    99 <wiki:Strange(page@!)>
    100 }}}
    101 }}}
    102 {{{#!td
    103 <wiki:Strange(page@!)>
    104 }}}
    105 }}}
     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]
    10679
    10780TracLinks 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.
     
    11487To create a link to a specific anchor in a page, use '#':
    11588{{{
    116  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     89 [#Relativelinks relative links]
    11790}}}
    11891Displays:
    119   [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     92  [#Relativelinks relative links]
    12093
    12194Hint: 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.
     
    128101To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
    129102{{{
    130   [..] or [[..]]
    131 }}}
    132   [..] or [[..]]
    133 
    134 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
    135 {{{
    136   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    137 }}}
    138   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    139 
    140 But in practice you often won't need to add the `../` prefix to link to a sibling page.
    141 For resolving the location of a wiki link, it's the target page closest in the hierarchy
    142 to the page where the link is written which will be selected. So for example, within
    143 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
    144 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    145 
    146 In order to link explicitly to a [=#toplevel toplevel] Wiki page,
    147 use the `wiki:/` prefix.
    148 Be careful **not** to use the `/` prefix alone, as this corresponds to the
    149 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
    150 part in the resulting URL.
    151 
    152 ''(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.
    153 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.
    154112
    155113=== InterWiki links ===
     
    161119This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
    162120
    163 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.
    164 
    165 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].
    166 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].
    167124
    168125=== Server-relative links ===
     
    176133
    177134{{{
    178 [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
    179 [/ home] or [[/|home]]
    180 }}}
    181 
    182 Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
    183 [/ home] or [[/|home]]
     135[/newticket Create a new ticket]
     136[/ home]
     137}}}
     138
     139Display: [/newticket newticket] [/ home]
    184140
    185141To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''):
    186142
    187143{{{
    188 [//register Register Here] or [[//register|Register Here]]
    189 }}}
    190 
    191 Display: [//register Register Here] or [[//register|Register Here]]
     144[//register Register Here]
     145}}}
     146
     147Display: [//register Register Here]
    192148
    193149=== Quoting space in TracLinks ===
     
    201157 * !attachment:"the file.txt:ticket:123"
    202158
    203 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
    204  * ![[The whitespace convention]]
    205  * ![[attachment:the file.txt]]
    206 
    207159=== Escaping Links ===
    208160
     
    220172=== Parameterized Trac links ===
    221173
    222 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.
    223 
    224 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:
    225177 - `wiki:WikiStart?format=txt`
    226178 - `ticket:1?version=1`
     
    229181
    230182== TracLinks Reference ==
    231 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.
    232184
    233185=== attachment: links ===
     
    248200=== comment: links ===
    249201
    250 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
    251 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
    252  - `comment:3:ticket:123`
    253  - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
    254 It is also possible to link to the ticket's description using one of the following syntax:
    255  - `comment:description` (within the ticket)
    256  - `comment:description:ticket:123`
    257  - `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!)
    258206
    259207=== query: links ===
     
    266214
    267215=== ticket: links ===
    268  ''alias:'' `bug:`
    269216
    270217Besides 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.
     
    283230 - `timeline:2008-01-29`
    284231 - `timeline:2008-01-29T15:48`
    285  - `timeline:2008-01-29T15:48Z`
    286  - `timeline:2008-01-29T16:48+01`
     232 - `timeline:2008-01-29T16:48Z+01`
    287233
    288234''(since Trac 0.11)''
     
    294240=== Version Control related links ===
    295241==== source: links ====
    296  ''aliases:'' `browser:`, `repos:`
    297 
    298 The default behavior for a source:/some/path link is to open the browser in that directory directory
    299 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.
    300245
    301246It's also possible to link directly to a specific revision of a file like this:
     
    309254Finally, one can also highlight an arbitrary set of lines:
    310255 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
    311    ''(since 0.11)''
    312 
    313 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)''
    314257
    315258==== export: links ====
     
    326269==== log: links ====
    327270
    328 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.
    329272 - `log:/` - the latest revisions starting at the root of the repository
    330273 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
    331274 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
    332  - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    333  - `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
    334277
    335278There are short forms for revision ranges as well:
     
    338281 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
    339282
    340 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
    341 
    342 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`.
    343284
    344285----

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png