Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Jan 10, 2010 6:55:03 PM (4 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 == 
     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 
     49 
     50'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 
     51pages whose names do not follow WikiPageNames rules, i.e., single words, 
     52non-alphabetic characters, etc. See WikiPageNames for more about features specific 
     53to links to Wiki page names. 
     54 
     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] 
     79 
     80TracLinks 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. 
     81 
     82 
     83== Advanced use of TracLinks == 
     84 
     85=== Relative links === 
     86 
     87To create a link to a specific anchor in a page, use '#': 
     88{{{ 
     89 [#Relativelinks relative links] 
     90}}} 
     91Displays: 
     92  [#Relativelinks relative links] 
     93 
     94Hint: 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. 
     95 
     96To create a link to a [trac:SubWiki SubWiki]-page just use a '/': 
     97{{{ 
     98 WikiPage/SubWikiPage or ./SubWikiPage 
     99}}} 
     100 
     101To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': 
     102{{{ 
     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. 
     112 
     113=== InterWiki links === 
     114 
     115Other 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. 
     116 
     117=== InterTrac links === 
     118 
     119This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 
     120 
     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]. 
     124 
     125=== Server-relative links === 
     126 
     127It is often useful to be able to link to objects in your project that 
     128have no built-in Trac linking mechanism, such as static resources, `newticket`, 
     129a shared `/register` page on the server, etc. 
     130 
     131To link to resources inside the project, use either an absolute path from the project root,  
     132or a relative link from the URL of the current page (''Changed in 0.11''): 
     133 
     134{{{ 
     135[/newticket Create a new ticket] 
     136[/ home] 
     137}}} 
     138 
     139Display: [/newticket Create a new ticket] [/ 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] 
     148 
     149=== Quoting space in TracLinks === 
     150 
     151Immediately after a TracLinks prefix, targets containing space characters should 
     152be enclosed in a pair of quotes or double quotes. 
     153Examples: 
     154 * !wiki:"The whitespace convention" 
     155 * !attachment:'the file.txt' or 
     156 * !attachment:"the file.txt"  
     157 * !attachment:"the file.txt:ticket:123"  
     158 
     159=== Escaping Links === 
    88160 
    89161To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 
     
    97169 ![42] is not a link either. 
    98170 
     171 
     172=== Parameterized Trac links === 
     173 
     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: 
     177 - `wiki:WikiStart?format=txt` 
     178 - `ticket:1?version=1` 
     179 - `[/newticket?component=module1 create a ticket for module1]` 
     180 
     181 
     182== TracLinks Reference == 
     183The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 
     184 
     185=== attachment: links === 
     186 
     187The link syntax for attachments is as follows: 
     188 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 
     189 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page 
     190 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 
     191 
     192Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt. 
     193 
     194If 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:`. 
     195 
     196This 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. 
     197 
     198See also [#export:links]. 
     199 
     200=== comment: links === 
     201 
     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!) 
     206 
     207=== query: links === 
     208 
     209See TracQuery#UsingTracLinks and [#ticket:links]. 
     210 
     211=== search: links === 
     212 
     213See TracSearch#SearchLinks  
     214 
     215=== ticket: links === 
     216 
     217Besides 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. 
     218 
     219Example:  
     220 - `ticket:5000-6000` 
     221 - `ticket:1,150` 
     222 
     223''(since Trac 0.11)'' 
     224 
     225=== timeline: links === 
     226 
     227Links 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. 
     228 
     229Examples: 
     230 - `timeline:2008-01-29` 
     231 - `timeline:2008-01-29T15:48` 
     232 - `timeline:2008-01-29T15:48Z` 
     233 - `timeline:2008-01-29T16:48+01` 
     234 
     235''(since Trac 0.11)'' 
     236 
     237=== wiki: links === 
     238 
     239See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. 
     240 
     241=== Version Control related links === 
     242==== source: links ==== 
     243 
     244The default behavior for a source:/some/path link is to open the directory browser  
     245if the path points to a directory and otherwise open the log view. 
     246 
     247It's also possible to link directly to a specific revision of a file like this: 
     248 - `source:/some/file@123` - link to the file's revision 123 
     249 - `source:/some/file@head` - link explicitly to the latest revision of the file 
     250 
     251If the revision is specified, one can even link to a specific line number: 
     252 - `source:/some/file@123#L10` 
     253 - `source:/tag/0.10@head#L10` 
     254 
     255Finally, one can also highlight an arbitrary set of lines: 
     256 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. 
     257''(since 0.11)'' 
     258 
     259==== export: links ==== 
     260 
     261To 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: 
     262 * `export:/some/file` - get the HEAD revision of the specified file 
     263 * `export:123:/some/file` - get revision 123 of the specified file 
     264 * `export:/some/file@123` - get revision 123 of the specified file 
     265 
     266This 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.  
     267 
     268If 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`). 
     269 
     270==== log: links ==== 
     271 
     272The `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. 
     273 - `log:/` - the latest revisions starting at the root of the repository 
     274 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 
     275 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000 
     276 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range 
     277 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path 
     278 
     279There are short forms for revision ranges as well: 
     280 - `[20788,20791:20795]` 
     281 - `[20788,20791:20795/trunk/tools]` 
     282 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`) 
     283 
     284Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`. 
     285 
    99286---- 
    100 See also: WikiFormatting, TracWiki 
     287See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 
    101288