Ticket #896: formatting-and-links.diff

wiki-default/WikiFormatting

@@ -9 +9 @@
 
-The Trac wiki support the following font styles: '''bold''', ''italic''
-and __underline__.
+The Trac wiki support the following font styles: '''bold''', ''italic'',
+__underline__ and ~~overstrike~~ (deleted).
 
 {{{
-The Trac wiki support the following font styles: '''bold''', ''italic''
-and __underline__.
+The Trac wiki support the following font styles: '''bold''', ''italic'',
+__underline__ and ~~overstrike~~ (deleted).
 }}}
@@ -112 +112 @@
 Trac allows wiki pages to link directly to other parts of the Trac system.
-Pages can refer to tickets, reports and changesets by simply writing the
-ticket, report and changeset numbers in the following notation:
+Pages can refer to tickets, reports, changesets, milestones, source files and
+other wiki pages in the following notation:
 {{{
- * Ticket #1 
- * Report {1}
- * Changeset [1]
- * File source:trunk/COPYING.
+ * Ticket #1 or ticket:1
+ * Report {1} or report:1
+ * Changeset [1] or changeset:1
+ * WikiName or wiki:WikiName
+ * Milestone milestone:1.0
+ * File source:trunk/COPYING
  * A specific file revision: source:/trunk/COPYING#200
@@ -122 +124 @@
 Display:
- * Ticket #1 
- * Report {1}
- * Changeset [1]
- * File source:trunk/COPYING.
+ * Ticket #1 or ticket:1
+ * Report {1} or report:1
+ * Changeset [1] or changeset:1
+ * WikiName or wiki:WikiName
+ * Milestone milestone:1.0
+ * File source:trunk/COPYING
  * A specific file revision: source:/trunk/COPYING#200

wiki-default/TracLinks

@@ -4 +4 @@
 
-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 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:
 
-TracLinks can refer to tickets, reports and changesets by simply writing the
-ticket, report and changeset numbers in the following notation:
 {{{
@@ -12 +16 @@
  * Changeset [1] or changeset:1
- * File source:trunk/COPYING.
+ * WikiName or wiki:WikiName
+ * Milestone milestone:1.0
+ * File source:trunk/COPYING
 }}}
@@ -18 +24 @@
  * Changeset [1] or changeset:1
- * File source:trunk/COPYING.
+ * WikiName or wiki:WikiName
+ * Milestone milestone:1.0
+ * File source:trunk/COPYING
+
+The wiki:WikiName form is rarely used, but it can be convenient to refer to
+pages which do not follow WikiPageNames rules, i.e., single-word names, numbered
+pages, etc.
 
@@ -47 +59 @@
 
+You '''can not''' use TracLinks in:
+
+ * Ticket short summaries
+
 See also: WikiFormatting