Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
10/22/08 03:31:28 (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v2  
    77number, name or path of the item) though some frequently used kinds of items 
    88also have short-hand notations. 
     9 
     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. 
    918 
    1019Some examples: 
     
    1625 * 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''' 
    1726 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' 
     27 * Parent page: '''![..]''' 
    1828 * Milestones: '''!milestone:1.0''' 
    1929 * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' 
     
    2939 * 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 
    3040 * Wiki pages: CamelCase or wiki:CamelCase 
     41 * Parent page: '''[..]''' 
    3142 * Milestones: milestone:1.0 
    3243 * Attachment: attachment:ticket:944:attachment.1073.diff 
     
    6778TracLinks 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. 
    6879 
    69 The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 
    70  
    71 == attachment: links == 
    72  
    73 The link syntax for attachments is as follows: 
    74  * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 
    75  * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page 
    76  * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 
    77  
    78 == source: links == 
    79  
    80 The default behavior for a source:/some/path link is to open the directory browser  
    81 if the path points to a directory and otherwise open the log view. 
    82  
    83 It's also possible to link directly to a specific revision of a file like this: 
    84  - `source:/some/file@123` - link to the file's revision 123 
    85  - `source:/some/file@head` - link explicitly to the latest revision of the file 
    86  
    87 If the revision is specified, one can even link to a specific line number: 
    88  - `source:/some/file@123#L10` 
    89  - `source:/tag/0.10@head#L10` 
    90  
    91 Finally, one can also highlight an arbitrary set of lines: 
    92  - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. 
    93 ''(since 0.11)'' 
    94  
    95 == export: links == 
    96  
    97 To 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: 
    98  * `export:/some/file` - get the HEAD revision of the specified file 
    99  * `export:123:/some/file` - get revision 123 of the specified file 
    100  * `export:/some/file@123` - get revision 123 of the specified file 
    101  
    102 This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository. 
    103  
    104 If 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`. 
    105  
    106 == search: and query: links == 
    107  
    108 See TracSearch#SearchLinks and TracQuery#UsingTracLinks 
    109  
    110 == !SubWiki links == 
    111 To create a SubWiki link to a SubWiki-page just use a '/': 
    112 {{{ 
    113  [wiki:WikiPage/SubWikiPage]. 
    114 }}} 
    115  
    116 == InterWiki links == 
     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 === 
    117112 
    118113Other 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. 
    119114 
    120 == InterTrac links == 
    121  
    122 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.  
    123  
    124  
    125 == Server-relative links == 
    126  
    127 It is often useful to be able to link to objects on your server that have no built-in 
    128 Trac linking mechanism, such as static resources, a `/register` page, etc. This 
    129 can be achieved by simply using either an absolute path from the server root,  
    130 or a relative link from the URL of the current page: 
    131  
    132 {{{ 
    133 [../newticket newticket] 
     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] 
    134134[/ home] 
    135135}}} 
    136136 
    137 Display: [../newticket newticket] [/ home] 
    138  
    139 == Quoting space in TracLinks == 
     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 === 
    140148 
    141149Immediately after a TracLinks prefix, targets containing space characters should 
     
    147155 * !attachment:"ticket:123:the file.txt"  
    148156 
    149 == Where to use TracLinks == 
    150 You can use TracLinks in: 
    151  
    152  * Source code (Subversion) commit messages 
    153  * Wiki pages 
    154  * Full descriptions for tickets, reports and milestones 
    155  
    156 and any other text fields explicitly marked as supporting WikiFormatting. 
    157  
    158 == Escaping Links == 
     157=== Escaping Links === 
    159158 
    160159To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 
     
    168167 ![42] is not a link either. 
    169168 
     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 === 
     184 
     185The link syntax for attachments is as follows: 
     186 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 
     187 * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page 
     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 ==== 
     225 
     226The default behavior for a source:/some/path link is to open the directory browser  
     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`. 
     267 
    170268---- 
    171269See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki