Code

Changes between Version 4 and Version 5 of TracLinks


Ignore:
Timestamp:
01/28/11 12:52:13 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

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