Changes between Version 2 and Version 3 of TracLinks


Ignore:
Timestamp:
Feb 22, 2011, 12:35:15 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v2 v3  
    11= Trac Links =
     2[[TracGuideToc]]
     3
    24TracLinks are a fundamental feature of Trac, because they allow easy hyperlinking between the various entities in the system—such as tickets, reports, changesets, Wiki pages, milestones, and source files—from anywhere WikiFormatting is used.
    35
     
    68also have short-hand notations.
    79
    8 Some examples:
    9  * Tickets: '''!#1''' or '''!ticket:1'''
    10  * Ticket comments: '''!comment:ticket:1:2'''
    11  * Reports: '''!{1}''' or '''!report:1'''
    12  * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk'''
    13  * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3'''
    14  * 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'''
    15  * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase'''
    16  * Milestones: '''!milestone:1.0'''
    17  * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
    18  * Files: '''!source:trunk/COPYING'''
    19  * A specific file revision: '''!source:/trunk/COPYING@200'''
    20  * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25'''
    21 Display:
    22  * Tickets: #1 or ticket:1
    23  * Ticket comments: comment:ticket:1:2
    24  * Reports: {1} or report:1
    25  * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk
    26  * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3
    27  * 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
    28  * Wiki pages: CamelCase or wiki:CamelCase
    29  * Milestones: milestone:1.0
    30  * Attachment: attachment:ticket:944:attachment.1073.diff
    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
     10== Where to use TracLinks ==
     11You can use TracLinks in:
     12
     13 * Source code (Subversion) commit messages
     14 * Wiki pages
     15 * Full descriptions for tickets, reports and milestones
     16
     17and any other text fields explicitly marked as supporting WikiFormatting.
     18
     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:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
     33          or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
     34 Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25)
     35}}}
     36{{{#!td
     37 Wiki pages :: CamelCase or wiki:CamelCase
     38 Parent page :: [..]
     39 Tickets :: #1 or ticket:1
     40 Ticket comments :: comment:1:ticket:2
     41 Reports :: {1} or report:1
     42 Milestones :: milestone:1.0
     43 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
     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 Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25)
     49}}}
    3450
    3551'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
     
    3854to links to Wiki page names.
    3955
    40 Trac links using the full (non-shorthand) notation can also be given a custom
    41 link title like this:
    42 
    43 {{{
    44 [ticket:1 This is a link to ticket number one].
    45 }}}
    46 
    47 Display: [ticket:1 This is a link to ticket number one].
    48 
    49 If the title is be omitted, only the id (the part after the colon) is displayed:
    50 
    51 {{{
    52 [ticket:1]
    53 }}}
    54 
    55 Display: [ticket:1]
    56 
    57 `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):
    58 
    59 {{{
    60 [SandBox the sandbox]
    61 }}}
    62 
    63 Display: [SandBox the sandbox]
     56
     57{{{#!table class=""
     58|||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: ||
     59{{{#!td
     60{{{
     61[ticket:1 This is a link to ticket number one] or
     62[[ticket:1|This is another link to ticket number one]].
     63}}}
     64}}}
     65{{{#!td
     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|||| If the title is omitted, only the id (the part after the colon) is displayed:  ||
     71{{{#!td
     72{{{
     73[ticket:1] or [[ticket:2]]
     74}}}
     75}}}
     76{{{#!td
     77[ticket:1] or [[ticket:2]]
     78}}}
     79|--------------------------------------------------------------------------------------
     80|||| `wiki` is the default if the namespace part of a full link is omitted:  ||
     81{{{#!td
     82{{{
     83[SandBox the sandbox] or
     84[[SandBox|the sandbox]]
     85}}}
     86}}}
     87{{{#!td
     88[SandBox the sandbox] or
     89[[SandBox|the sandbox]]
     90}}}
     91|--------------------------------------------------------------------------------------
     92|||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  ||
     93{{{#!td
     94{{{
     95<wiki:Strange(page@!)>
     96}}}
     97}}}
     98{{{#!td
     99<wiki:Strange(page@!)>
     100}}}
     101}}}
    64102
    65103TracLinks 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.
    66104
    67 The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
    68 
    69 == attachment: links ==
    70 
    71 The link syntax for attachments is as follows:
    72  * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
    73  * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page
    74  * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753
    75 
    76 == source: links ==
    77 
    78 The default behavior for a source:/some/path link is to open the directory browser
    79 if the path points to a directory and otherwise open the log view.
    80 It's also possible to link directly to a specific revision of a file like this: source:/some/file@123
    81 or like this to link to the latest revision: source:/some/file@latest.
    82 If the revision is specified, one can even link to a specific line number: source:/some/file@123#L10
    83 
    84 == search: and query: links ==
    85 
    86 See TracSearch#SearchLinks and TracQuery#UsingTracLinks
    87 
    88 == !SubWiki links ==
    89 To create a SubWiki link to a SubWiki-page just use a '/':
    90 {{{
    91  [wiki:WikiPage/SubWikiPage].
    92 }}}
    93 
    94 == InterWiki links ==
     105
     106== Advanced use of TracLinks ==
     107
     108=== Relative links ===
     109
     110To create a link to a specific anchor in a page, use '#':
     111{{{
     112 [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     113}}}
     114Displays:
     115  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     116
     117Hint: 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.
     118
     119To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
     120{{{
     121 WikiPage/SubWikiPage or ./SubWikiPage
     122}}}
     123
     124To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
     125{{{
     126  [..] or [[..]]
     127}}}
     128  [..] or [[..]]
     129
     130To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
     131{{{
     132  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     133}}}
     134  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     135
     136But in practice you often won't need to add the `../` prefix to link to a sibling page.
     137For resolving the location of a wiki link, it's the target page closest in the hierarchy
     138to the page where the link is written which will be selected. So for example, within
     139a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
     140This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
     141
     142In order to link explicitly to a [=#toplevel toplevel] Wiki page,
     143use the `wiki:/` prefix.
     144Be careful **not** to use the `/` prefix alone, as this corresponds to the
     145[#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
     146part in the resulting URL.
     147
     148''(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.
     149See [#Server-relativelinks] for the new syntax.
     150
     151=== InterWiki links ===
    95152
    96153Other prefixes can be defined freely and made to point to resources in other Web applications. The definition of those prefixes as well as the URLs of the corresponding Web applications is defined in a special Wiki page, the InterMapTxt page. Note that while this could be used to create links to other Trac environments, there's a more specialized way to register other Trac environments which offers greater flexibility.
    97154
    98 == InterTrac links ==
    99 
    100 Any of the above form 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. See InterTrac for details.
    101 
    102 
    103 == Server-relative links ==
    104 
    105 It is often useful to be able to link to objects on your server that have no built-in
    106 Trac linking mechanism, such as static resources, a `/register` page, etc. This
    107 can be achieved by simply using either an absolute path from the server root,
    108 or a relative link from the URL of the current page:
    109 
    110 {{{
    111 [../newticket newticket]
    112 [/ home]
    113 }}}
    114 
    115 Display: [../newticket newticket] [/ home]
    116 
    117 == Quoting space in TracLinks ==
     155=== InterTrac links ===
     156
     157This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
     158
     159Any 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.
     160
     161A 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].
     162See InterTrac for the complete details.
     163
     164=== Server-relative links ===
     165
     166It is often useful to be able to link to objects in your project that
     167have no built-in Trac linking mechanism, such as static resources, `newticket`,
     168a shared `/register` page on the server, etc.
     169
     170To link to resources inside the project, use either an absolute path from the project root,
     171or a relative link from the URL of the current page (''Changed in 0.11''):
     172
     173{{{
     174[/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     175[/ home] or [[/|home]]
     176}}}
     177
     178Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     179[/ home] or [[/|home]]
     180
     181To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''):
     182
     183{{{
     184[//register Register Here] or [[//register|Register Here]]
     185}}}
     186
     187Display: [//register Register Here] or [[//register|Register Here]]
     188
     189=== Quoting space in TracLinks ===
    118190
    119191Immediately after a TracLinks prefix, targets containing space characters should
     
    123195 * !attachment:'the file.txt' or
    124196 * !attachment:"the file.txt"
    125  * !attachment:"ticket:123:the file.txt"
    126 
    127 == Where to use TracLinks ==
    128 You can use TracLinks in:
    129 
    130  * Source code (Subversion) commit messages
    131  * Wiki pages
    132  * Full descriptions for tickets, reports and milestones
    133 
    134 and any other text fields explicitly marked as supporting WikiFormatting.
    135 
    136 == Escaping Links ==
     197 * !attachment:"the file.txt:ticket:123"
     198
     199Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
     200 * ![[The whitespace convention]]
     201 * ![[attachment:the file.txt]]
     202
     203=== Escaping Links ===
    137204
    138205To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     
    146213 ![42] is not a link either.
    147214
     215
     216=== Parameterized Trac links ===
     217
     218Many 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.
     219
     220Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
     221 - `wiki:WikiStart?format=txt`
     222 - `ticket:1?version=1`
     223 - `[/newticket?component=module1 create a ticket for module1]`
     224 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
     225
     226
     227== TracLinks Reference ==
     228The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
     229
     230=== attachment: links ===
     231
     232The link syntax for attachments is as follows:
     233 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
     234 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
     235 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
     236
     237Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
     238
     239If 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:`.
     240
     241This 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.
     242
     243See also [#export:links].
     244
     245=== comment: links ===
     246
     247When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
     248It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
     249 - `comment:3:ticket:123`
     250 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
     251It is also possible to link to the ticket's description using one of the following syntax:
     252 - `comment:description` (within the ticket)
     253 - `comment:description:ticket:123`
     254 - `ticket:123#comment:description`
     255
     256=== query: links ===
     257
     258See TracQuery#UsingTracLinks and [#ticket:links].
     259
     260=== search: links ===
     261
     262See TracSearch#SearchLinks
     263
     264=== ticket: links ===
     265 ''alias:'' `bug:`
     266
     267Besides 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.
     268
     269Example:
     270 - `ticket:5000-6000`
     271 - `ticket:1,150`
     272
     273''(since Trac 0.11)''
     274
     275=== timeline: links ===
     276
     277Links to the timeline can be created by specifying a date in the ISO:8601 format. The date can be optionally followed by a time specification. The time is interpreted as being UTC time, but alternatively you can specify your local time, followed by your timezone if you don't want to compute the UTC time.
     278
     279Examples:
     280 - `timeline:2008-01-29`
     281 - `timeline:2008-01-29T15:48`
     282 - `timeline:2008-01-29T15:48Z`
     283 - `timeline:2008-01-29T16:48+01`
     284
     285''(since Trac 0.11)''
     286
     287=== wiki: links ===
     288
     289See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.
     290
     291=== Version Control related links ===
     292
     293It 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).
     294
     295For 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'`.
     296
     297==== source: links ====
     298 ''aliases:'' `browser:`, `repos:`
     299
     300The default behavior for a source:/some/path link is to open the browser in that directory directory
     301if the path points to a directory or to show the latest content of the file.
     302
     303It's also possible to link directly to a specific revision of a file like this:
     304 - `source:/some/file@123` - link to the file's revision 123
     305 - `source:/some/file@head` - link explicitly to the latest revision of the file
     306
     307If the revision is specified, one can even link to a specific line number:
     308 - `source:/some/file@123#L10`
     309 - `source:/tag/0.10@head#L10`
     310
     311Finally, one can also highlight an arbitrary set of lines:
     312 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
     313   ''(since 0.11)''
     314
     315Note 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)''
     316
     317==== export: links ====
     318
     319To force the download of a file in the repository, as opposed to displaying it in the browser, use the `export` link.  Several forms are available:
     320 * `export:/some/file` - get the HEAD revision of the specified file
     321 * `export:123:/some/file` - get revision 123 of the specified file
     322 * `export:/some/file@123` - get revision 123 of the specified file
     323
     324This 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.
     325
     326If 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`).
     327
     328==== log: links ====
     329
     330The `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.
     331 - `log:/` - the latest revisions starting at the root of the repository
     332 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
     333 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
     334 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
     335 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
     336
     337There are short forms for revision ranges as well:
     338 - `[20788,20791:20795]`
     339 - `[20788,20791:20795/trunk/tools]`
     340 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
     341
     342Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
     343
     344In 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]`.
     345
    148346----
    149347See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki