Changes between Version 5 and Version 6 of TracLinks

Timestamp:

Nov 8, 2004, 2:59:20 PM (20 years ago)

Author:

jbarranquero@…

Comment:

Document wiki: and milestone: links.

TracLinks

@@ -2 +2 @@
 As you might have guessed, TracLinks are a very fundamental feature of Trac.
 
-They allow easy hyperlinking to files, changesets, bugs/issues and wiki pages from anywhere in the system where WikiFormatting is used. 
+They allow easy hyperlinking to Trac items (tickets, reports, changesets, Wiki
+pages, milestones and source files) from anywhere in the system where
+WikiFormatting is used.
 
-TracLinks can refer to tickets, reports and changesets by simply writing the
-ticket, report and changeset numbers in the following notation:
-{{{
- * Ticket #1 or ticket:1
- * Report {1} or report:1
- * Changeset [1] or changeset:1
- * File source:trunk/COPYING.
-}}}
+TracLinks are generally of the form '''item:id''' (where ''id'' represents the
+number, name or path of the item) though some frequently used kinds of items
+have also alternative, shorthand notations. For example:
+
+ * Tickets: '''!#1''' or '''!ticket:1
+ * Reports: '''!{1}''' or '''!report:1
+ * Changesets: '''![1]''' or '''!changeset:1
+ * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase
+ * Milestones: '''!milestone:1.0
+ * Files: '''!source:trunk/COPYING
+
 Display:
- * Ticket #1 or ticket:1
- * Report {1} or report:1
- * Changeset [1] or changeset:1
- * File source:trunk/COPYING.
+ * Tickets: #1 or ticket:1
+ * Reports: {1} or report:1
+ * Changesets: [1] or changeset:1
+ * Wiki pages: CamelCase or wiki:CamelCase
+ * Milestones: milestone:1.0
+ * Files: source:trunk/COPYING
 
-Trac links can also be given a custom link title like this:
+The wiki:CamelCase form is rarely used, but it can be convenient to refer to
+pages whose names do not follow WikiPageNames rules, i.e., single words,
+non-alphabetic characters, etc.
+
+Trac links using the full (non-shorthand) notation can also be given a custom
+link title like this:
 {{{
 [ticket:1 This is a link to ticket number one].
@@ -38 +50 @@
 
 == Where to use TracLinks ==
-You can use TracLinks and WikiFormatting in:
+You can use TracLinks in:
 
+ * Source code (Subversion) commit messages
  * Wiki pages
- * Ticket descriptions
- * Source code (Subversion) commit messages
+ * Full descriptions for tickets, reports and milestones
+
+and any other text fields explicitly marked as supporting WikiFormatting.
 
 == Escaping TracLinks ==