Changes between Version 1 and Version 2 of TracLinks

Timestamp:

Dec 7, 2010, 10:14:18 PM (14 years ago)

Author:

trac

Comment:

--

TracLinks

@@ -19 +19 @@
 Some examples:
  * Tickets: '''!#1''' or '''!ticket:1'''
- * Ticket comments: '''!comment:ticket:1:2''' 
+ * Ticket comments: '''!comment:1:ticket:2''' 
  * Reports: '''!{1}''' or '''!report:1'''
- * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''', '''![2:5/trunk]'''
- * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3'''
- * 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'''
+ * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk'''
+ * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''', '''![2:5/trunk]'''
+ * 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'''
  * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase'''
  * Parent page: '''![..]'''
  * Milestones: '''!milestone:1.0'''
- * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
+ * Attachment: '''!attachment:example.tgz''' (for current page attachment), '''!attachment:attachment.1073.diff:ticket:944''' 
+(absolute path)
  * Files: '''!source:trunk/COPYING'''
  * A specific file revision: '''!source:/trunk/COPYING@200'''
@@ -33 +34 @@
 Display:
  * Tickets: #1 or ticket:1
- * Ticket comments: comment:ticket:1:2 
+ * Ticket comments: comment:1:ticket:2 
  * Reports: {1} or report:1
- * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk, [2:5/trunk]
- * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3
- * 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
+ * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
+ * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
+ * 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
  * Wiki pages: CamelCase or wiki:CamelCase
- * Parent page: '''[..]'''
+ * Parent page: [..]
  * Milestones: milestone:1.0
- * Attachment: attachment:ticket:944:attachment.1073.diff
+ * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 
+(absolute path)
  * Files: source:trunk/COPYING
  * A specific file revision: source:/trunk/COPYING@200
@@ -92 +94 @@
 Hint: 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.
 
-To create a link to a SubWiki-page just use a '/':
+To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
 {{{
  WikiPage/SubWikiPage or ./SubWikiPage
 }}}
 
-To link from a SubWiki page to a parent, simply use a '..':
+To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
 {{{
   [..]
 }}}
 
-To link from a SubWiki page to a sibling page, use a '../':
+To link from a [trac:SubWiki SubWiki] page to a sibling page, use a '../':
 {{{
   [../Sibling see next sibling]
@@ -135 +137 @@
 }}}
 
-Display: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]]  [/ home]
+Display: [/newticket newticket] [/ home]
 
 To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''):
@@ -153 +155 @@
  * !attachment:'the file.txt' or
  * !attachment:"the file.txt" 
- * !attachment:"ticket:123:the file.txt" 
+ * !attachment:"the file.txt:ticket:123" 
 
 === Escaping Links ===
@@ -185 +187 @@
 The link syntax for attachments is as follows:
  * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
- * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page
- * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753
+ * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
+ * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
+
+Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
+
+If 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:`.
+
+This 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.
+
+See also [#export:links].
+
+=== comment: links ===
+
+When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment.
+It's also possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
+ - !comment:3:ticket:123 
+ - !ticket:123#comment:3 (note that you can't write !#123#!comment:3!)
 
 === query: links ===
@@ -246 +263 @@
  * `export:/some/file@123` - get revision 123 of the specified file
 
-This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository.
-
-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`.
+This 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. 
+
+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`).
 
 ==== log: links ====