Changes between Version 2 and Version 3 of WikiRestructuredTextLinks

Timestamp:

02/28/11 14:16:41 (14 years ago)

Author:

trac

Comment:

--

WikiRestructuredTextLinks

@@ -1 +1 @@
 = TracLinks in reStructuredText =
 
-This document illustrates how to use the ``..trac::`` directive in reStructureThe page is written like
+This document illustrates how to use the `:trac:` role in reStructuredText. The page is written like:
 
 {{{
 {{{
 #!rst 
+Examples:
 
-Examples:
  * Tickets: :trac:`#1` or :trac:`ticket:1`
  * Ticket comments: :trac:`comment:ticket:1:2`
@@ -21 +21 @@
  * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
 
+An explicit label can be specified, separated from the link by a space:
+
+ * See :trac:`#1 ticket 1` and the :trac:`source:trunk/COPYING license`.
 }}}
 }}}
@@ -28 +31 @@
 {{{
 #!rst 
+Examples:
 
-Examples:
  * Tickets: :trac:`#1` or :trac:`ticket:1`
  * Ticket comments: :trac:`comment:ticket:1:2`
@@ -43 +46 @@
  * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
 
+An explicit label can be specified, separated from the link by a space:
+
+ * See :trac:`#1 ticket 1` and the :trac:`source:trunk/COPYING license`.
 }}}
 ----
 
-Note also that any of the above could have been written using the alternate syntax for roles:
+Note also that any of the above could have been written using substitution references and the `trac::` directive:
 {{{
 {{{
 #!rst
+See |ticket123|.
 
-See _`ticket:123`
-
- .. trac:: ticket:123 Ticket 123
+ .. |ticket123| trac:: ticket:123 this ticket
 }}}
 }}}
+
+This renders as:
 ----
 
 {{{
 #!rst
+See |ticket123|.
 
-See _`ticket:123`
-
-.. trac:: ticket:123 Ticket 123
+ .. |ticket123| trac:: ticket:123 this ticket
 }}}
-----
-The above form has the additional benefit of allowing you to specify an explicit label for the link.
 
 ----