Changes between Version 1 and Version 2 of TracLinks

Show
Ignore:
Timestamp:
10/09/08 04:57:43 (6 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 
     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 
    1119Some examples: 
    1220 * Tickets: '''!#1''' or '''!ticket:1''' 
     21 * Ticket comments: '''!comment:ticket:1:2'''  
    1322 * 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''' 
     23 * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''', '''![2:5/trunk]''' 
     24 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' 
     25 * 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''' 
     26 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' 
     27 * Parent page: '''![..]''' 
    1728 * Milestones: '''!milestone:1.0''' 
    1829 * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' 
    1930 * Files: '''!source:trunk/COPYING''' 
    20  * A specific file revision: '''!source:/trunk/COPYING#200''' 
     31 * A specific file revision: '''!source:/trunk/COPYING@200''' 
     32 * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' 
    2133Display: 
    2234 * Tickets: #1 or ticket:1 
     35 * Ticket comments: comment:ticket:1:2  
    2336 * Reports: {1} or report:1 
    24  * Changesets: r1, [1] or changeset:1 
    25  * Differences: r1:3, [1:3] or log:#1:3 
     37 * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk, [2:5/trunk] 
     38 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3 
     39 * 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 
    2640 * Wiki pages: CamelCase or wiki:CamelCase 
     41 * Parent page: '''[..]''' 
    2742 * Milestones: milestone:1.0 
     43 * Attachment: attachment:ticket:944:attachment.1073.diff 
    2844 * Files: source:trunk/COPYING 
    29  * Attachment: attachment:ticket:944:attachment.1073.diff 
    30  * A specific file revision: source:/trunk/COPYING#200 
     45 * A specific file revision: source:/trunk/COPYING@200 
     46 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 
    3147 
    3248'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 
    3349pages whose names do not follow WikiPageNames rules, i.e., single words, 
    34 non-alphabetic characters, etc. 
     50non-alphabetic characters, etc. See WikiPageNames for more about features specific 
     51to links to Wiki page names. 
    3552 
    3653Trac links using the full (non-shorthand) notation can also be given a custom 
     
    4360Display: [ticket:1 This is a link to ticket number one]. 
    4461 
    45 If the title is be omitted, only the id (the part after the colon) is displayed: 
     62If the title is omitted, only the id (the part after the colon) is displayed: 
    4663 
    4764{{{ 
     
    5168Display: [ticket:1] 
    5269 
    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 == 
     70`wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''): 
     71 
     72{{{ 
     73[SandBox the sandbox] 
     74}}} 
     75 
     76Display: [SandBox the sandbox] 
     77 
     78TracLinks 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. 
     79 
     80 
     81== Advanced use of TracLinks == 
     82 
     83=== Relative links === 
     84 
     85To create a link to a specific anchor in a page, use '#': 
     86{{{ 
     87 [#Relativelinks relative links] 
     88}}} 
     89Displays: 
     90  [#Relativelinks relative links] 
     91 
     92Hint: 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. 
     93 
     94To create a link to a SubWiki-page just use a '/': 
     95{{{ 
     96 WikiPage/SubWikiPage or ./SubWikiPage 
     97}}} 
     98 
     99To link from a SubWiki page to a parent, simply use a '..': 
     100{{{ 
     101  [..] 
     102}}} 
     103 
     104To link from a SubWiki page to a sibling page, use a '../': 
     105{{{ 
     106  [../Sibling see next sibling] 
     107}}} 
     108 
     109''(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. 
     110 
     111=== InterWiki links === 
     112 
     113Other 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. 
     114 
     115=== InterTrac links === 
     116 
     117This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 
     118 
     119Any 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.  
     120 
     121A 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]. 
     122 
     123=== Server-relative links === 
     124 
     125It is often useful to be able to link to objects in your project that 
     126have no built-in Trac linking mechanism, such as static resources, `newticket`, 
     127a shared `/register` page on the server, etc. 
     128 
     129To link to resources inside the project, use either an absolute path from the project root,  
     130or a relative link from the URL of the current page (''Changed in 0.11''): 
     131 
     132{{{ 
     133[/newticket Create a new ticket] 
     134[/ home] 
     135}}} 
     136 
     137Display: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]]  [/ home] 
     138 
     139To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''): 
     140 
     141{{{ 
     142[//register Register Here] 
     143}}} 
     144 
     145Display: [//register Register Here] 
     146 
     147=== Quoting space in TracLinks === 
     148 
     149Immediately after a TracLinks prefix, targets containing space characters should 
     150be enclosed in a pair of quotes or double quotes. 
     151Examples: 
     152 * !wiki:"The whitespace convention" 
     153 * !attachment:'the file.txt' or 
     154 * !attachment:"the file.txt"  
     155 * !attachment:"ticket:123:the file.txt"  
     156 
     157=== Escaping Links === 
     158 
     159To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 
     160{{{ 
     161 !NoLinkHere. 
     162 ![42] is not a link either. 
     163}}} 
     164 
     165Display: 
     166 !NoLinkHere. 
     167 ![42] is not a link either. 
     168 
     169 
     170=== Parameterized Trac links === 
     171 
     172The 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. 
     173 
     174Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: 
     175 - `wiki:WikiStart?format=txt` 
     176 - `ticket:1?version=1` 
     177 - `[/newticket?component=module1 create a ticket for module1]` 
     178 
     179 
     180== TracLinks Reference == 
     181The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 
     182 
     183=== attachment: links === 
    56184 
    57185The link syntax for attachments is as follows: 
    58186 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 
    59187 * !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 == 
     188 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 
     189 
     190=== query: links === 
     191 
     192See TracQuery#UsingTracLinks and [#ticket:links]. 
     193 
     194=== search: links === 
     195 
     196See TracSearch#SearchLinks  
     197 
     198=== ticket: links === 
     199 
     200Besides 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. 
     201 
     202Example:  
     203 - `ticket:5000-6000` 
     204 - `ticket:1,150` 
     205 
     206''(since Trac 0.11)'' 
     207 
     208=== timeline: links === 
     209 
     210Links 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. 
     211 
     212Examples: 
     213 - `timeline:2008-01-29` 
     214 - `timeline:2008-01-29T15:48` 
     215 - `timeline:2008-01-29T16:48Z+01` 
     216 
     217''(since Trac 0.11)'' 
     218 
     219=== wiki: links === 
     220 
     221See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. 
     222 
     223=== Version Control related links === 
     224==== source: links ==== 
    63225 
    64226The 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  
    78 == Where to use TracLinks == 
    79 You can use TracLinks in: 
    80  
    81  * Source code (Subversion) commit messages 
    82  * Wiki pages 
    83  * Full descriptions for tickets, reports and milestones 
    84  
    85 and any other text fields explicitly marked as supporting WikiFormatting. 
    86  
    87 == Escaping Links == 
    88  
    89 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 
    90 {{{ 
    91  !NoLinkHere. 
    92  ![42] is not a link either. 
    93 }}} 
    94  
    95 Display: 
    96  !NoLinkHere. 
    97  ![42] is not a link either. 
     227if the path points to a directory and otherwise open the log view. 
     228 
     229It's also possible to link directly to a specific revision of a file like this: 
     230 - `source:/some/file@123` - link to the file's revision 123 
     231 - `source:/some/file@head` - link explicitly to the latest revision of the file 
     232 
     233If the revision is specified, one can even link to a specific line number: 
     234 - `source:/some/file@123#L10` 
     235 - `source:/tag/0.10@head#L10` 
     236 
     237Finally, one can also highlight an arbitrary set of lines: 
     238 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. 
     239''(since 0.11)'' 
     240 
     241==== export: links ==== 
     242 
     243To 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: 
     244 * `export:/some/file` - get the HEAD revision of the specified file 
     245 * `export:123:/some/file` - get revision 123 of the specified file 
     246 * `export:/some/file@123` - get revision 123 of the specified file 
     247 
     248This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository. 
     249 
     250If 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`. 
     251 
     252==== log: links ==== 
     253 
     254The `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. 
     255 - `log:/` - the latest revisions starting at the root of the repository 
     256 - `log:/trunk/tools` - the latest revisions in `trunk/tools` 
     257 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000 
     258 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range 
     259 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path 
     260 
     261There are short forms for revision ranges as well: 
     262 - `[20788,20791:20795]` 
     263 - `[20788,20791:20795/trunk/tools]` 
     264 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`) 
     265 
     266Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`. 
    98267 
    99268---- 
    100 See also: WikiFormatting, TracWiki 
     269See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 
    101270