Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Apr 13, 2011, 9:04:35 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v2  
    11= Trac Links =
    2 As you might have guessed, TracLinks are a very fundamental feature of Trac.
    3 
    4 They allow hyperlinking between Trac entities (tickets, reports, changesets, Wiki
    5 pages, milestones and source files) from anywhere WikiFormatting is used.
     2[[TracGuideToc]]
     3
     4TracLinks 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.
    65
    76TracLinks are generally of the form '''type:id''' (where ''id'' represents the
     
    98also have short-hand notations.
    109
    11 Some examples:
    12  * Tickets: '''!#1''' or '''!ticket:1'''
    13  * Reports: '''!{1}''' or '''!report:1'''
    14  * Changesets: '''!r1''', '''![1]''' or '''!changeset:1'''
    15  * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:#1:3'''
    16  * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase'''
    17  * Milestones: '''!milestone:1.0'''
    18  * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
    19  * Files: '''!source:trunk/COPYING'''
    20  * A specific file revision: '''!source:/trunk/COPYING#200'''
    21 Display:
    22  * Tickets: #1 or ticket:1
    23  * Reports: {1} or report:1
    24  * Changesets: r1, [1] or changeset:1
    25  * Differences: r1:3, [1:3] or log:#1:3
    26  * Wiki pages: CamelCase or wiki:CamelCase
    27  * Milestones: milestone:1.0
    28  * Files: source:trunk/COPYING
    29  * Attachment: attachment:ticket:944:attachment.1073.diff
    30  * A specific file revision: source:/trunk/COPYING#200
    31 
    32 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    33 pages whose names do not follow WikiPageNames rules, i.e., single words,
    34 non-alphabetic characters, etc.
    35 
    36 Trac links using the full (non-shorthand) notation can also be given a custom
    37 link title like this:
    38 
    39 {{{
    40 [ticket:1 This is a link to ticket number one].
    41 }}}
    42 
    43 Display: [ticket:1 This is a link to ticket number one].
    44 
    45 If the title is be omitted, only the id (the part after the colon) is displayed:
    46 
    47 {{{
    48 [ticket:1]
    49 }}}
    50 
    51 Display: [ticket:1]
    52 
    53 It might seem a simple enough concept at a glance, but actually allows 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.
    54 
    55 == attachement: links ==
    56 
    57 The link syntax for attachments is as follows:
    58  * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
    59  * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page
    60  * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 !attachment:wiki:MyPage:the_file.txt
    61 
    62 == source: links ==
    63 
    64 The default behavior for a source:/some/path link is to open the directory browser
    65 if the path points to a directory and otherwise open the log view.
    66 It's also possible to link directly to a specific revision of a file like this: source:/some/file@123
    67 or like this to link to the latest revision: source:/some/file@latest.
    68 If the revision is specified, one can even link to a specific line number: !source:/some/file@123#L10
    69 [[comment(TODO: remove the ! when Edgewall Trac is upgraded with the support for the line syntax)]]
    70 
    71 == Quoting space in TracLinks ==
    72 
    73 The usual syntax for quoting space is:
    74 
    75  * !attachment:'the file.txt' or
    76  * !attachment:"the file.txt"
    77 
    7810== Where to use TracLinks ==
    7911You can use TracLinks in:
     
    8517and any other text fields explicitly marked as supporting WikiFormatting.
    8618
    87 == Escaping Links ==
     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}}}
     52
     53'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
     54pages whose names do not follow WikiPageNames rules, i.e., single words,
     55non-alphabetic characters, etc. See WikiPageNames for more about features specific
     56to links to Wiki page names.
     57
     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}}}
     104
     105TracLinks 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.
     106
     107
     108== Advanced use of TracLinks ==
     109
     110=== Relative links ===
     111
     112To create a link to a specific anchor in a page, use '#':
     113{{{
     114 [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     115}}}
     116Displays:
     117  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     118
     119Hint: 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.
     120
     121To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
     122{{{
     123 WikiPage/SubWikiPage or ./SubWikiPage
     124}}}
     125
     126To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
     127{{{
     128  [..] or [[..]]
     129}}}
     130  [..] or [[..]]
     131
     132To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
     133{{{
     134  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     135}}}
     136  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     137
     138But in practice you often won't need to add the `../` prefix to link to a sibling page.
     139For resolving the location of a wiki link, it's the target page closest in the hierarchy
     140to the page where the link is written which will be selected. So for example, within
     141a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
     142This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
     143
     144In order to link explicitly to a [=#toplevel toplevel] Wiki page,
     145use the `wiki:/` prefix.
     146Be careful **not** to use the `/` prefix alone, as this corresponds to the
     147[#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
     148part in the resulting URL.
     149
     150''(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.
     151See [#Server-relativelinks] for the new syntax.
     152
     153=== InterWiki links ===
     154
     155Other 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.
     156
     157=== InterTrac links ===
     158
     159This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
     160
     161Any 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.
     162
     163A 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].
     164See InterTrac for the complete details.
     165
     166=== Server-relative links ===
     167
     168It is often useful to be able to link to objects in your project that
     169have no built-in Trac linking mechanism, such as static resources, `newticket`,
     170a shared `/register` page on the server, etc.
     171
     172To link to resources inside the project, use either an absolute path from the project root,
     173or a relative link from the URL of the current page (''Changed in 0.11''):
     174
     175{{{
     176[/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     177[/ home] or [[/|home]]
     178}}}
     179
     180Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     181[/ home] or [[/|home]]
     182
     183To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''):
     184
     185{{{
     186[//register Register Here] or [[//register|Register Here]]
     187}}}
     188
     189Display: [//register Register Here] or [[//register|Register Here]]
     190
     191=== Quoting space in TracLinks ===
     192
     193Immediately after a TracLinks prefix, targets containing space characters should
     194be enclosed in a pair of quotes or double quotes.
     195Examples:
     196 * !wiki:"The whitespace convention"
     197 * !attachment:'the file.txt' or
     198 * !attachment:"the file.txt"
     199 * !attachment:"the file.txt:ticket:123"
     200
     201Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
     202 * ![[The whitespace convention]]
     203 * ![[attachment:the file.txt]]
     204
     205=== Escaping Links ===
    88206
    89207To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     
    97215 ![42] is not a link either.
    98216
     217
     218=== Parameterized Trac links ===
     219
     220Many 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.
     221
     222Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
     223 - `wiki:WikiStart?format=txt`
     224 - `ticket:1?version=1`
     225 - `[/newticket?component=module1 create a ticket for module1]`
     226 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
     227
     228
     229== TracLinks Reference ==
     230The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
     231
     232=== attachment: links ===
     233
     234The link syntax for attachments is as follows:
     235 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
     236 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
     237 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
     238
     239Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
     240
     241If 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:`.
     242
     243This 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.
     244
     245See also [#export:links].
     246
     247=== comment: links ===
     248
     249When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
     250It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
     251 - `comment:3:ticket:123`
     252 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
     253It is also possible to link to the ticket's description using one of the following syntax:
     254 - `comment:description` (within the ticket)
     255 - `comment:description:ticket:123`
     256 - `ticket:123#comment:description`
     257
     258=== query: links ===
     259
     260See TracQuery#UsingTracLinks and [#ticket:links].
     261
     262=== search: links ===
     263
     264See TracSearch#SearchLinks
     265
     266=== ticket: links ===
     267 ''alias:'' `bug:`
     268
     269Besides 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.
     270
     271Example:
     272 - `ticket:5000-6000`
     273 - `ticket:1,150`
     274
     275''(since Trac 0.11)''
     276
     277=== timeline: links ===
     278
     279Links 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.
     280
     281Examples:
     282 - `timeline:2008-01-29`
     283 - `timeline:2008-01-29T15:48`
     284 - `timeline:2008-01-29T15:48Z`
     285 - `timeline:2008-01-29T16:48+01`
     286
     287''(since Trac 0.11)''
     288
     289=== wiki: links ===
     290
     291See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.
     292
     293=== Version Control related links ===
     294
     295It 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).
     296
     297For 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'`.
     298
     299==== source: links ====
     300 ''aliases:'' `browser:`, `repos:`
     301
     302The default behavior for a source:/some/path link is to open the browser in that directory directory
     303if the path points to a directory or to show the latest content of the file.
     304
     305It's also possible to link directly to a specific revision of a file like this:
     306 - `source:/some/file@123` - link to the file's revision 123
     307 - `source:/some/file@head` - link explicitly to the latest revision of the file
     308
     309If the revision is specified, one can even link to a specific line number:
     310 - `source:/some/file@123#L10`
     311 - `source:/tag/0.10@head#L10`
     312
     313Finally, one can also highlight an arbitrary set of lines:
     314 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
     315   ''(since 0.11)''
     316
     317Note 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)''
     318
     319==== export: links ====
     320
     321To 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:
     322 * `export:/some/file` - get the HEAD revision of the specified file
     323 * `export:123:/some/file` - get revision 123 of the specified file
     324 * `export:/some/file@123` - get revision 123 of the specified file
     325
     326This 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.
     327
     328If 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`).
     329
     330==== log: links ====
     331
     332The `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.
     333 - `log:/` - the latest revisions starting at the root of the repository
     334 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
     335 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
     336 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
     337 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
     338
     339There are short forms for revision ranges as well:
     340 - `[20788,20791:20795]`
     341 - `[20788,20791:20795/trunk/tools]`
     342 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
     343
     344Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
     345
     346In 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]`.
     347
    99348----
    100 See also: WikiFormatting, TracWiki
     349See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
    101350