Changes between Version 1 and Version 2 of WikiRestructuredTextLinks

Timestamp:

Oct 25, 2018, 9:17:16 AM (7 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 [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText]. The page is written like:
 
 {{{
-{{{
-#!rst 
+{{{#!rst
+Examples:
 
-Examples:
  * Tickets: :trac:`#1` or :trac:`ticket:1`
  * Ticket comments: :trac:`comment:ticket:1:2`
@@ -13 +12 @@
  * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
  * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
- * Diffs (since version 0.10): :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
+ * Diffs: :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
  * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
  * Milestones: :trac:`milestone:1.0`
@@ -21 +20 @@
  * 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`.
 }}}
 }}}
 
-Provided you have docutils installed, the above block will render as:
+Provided you have [http://docutils.sourceforge.net/ docutils] installed, the above block will render as:
 ----
-{{{
-#!rst 
+{{{#!rst
+Examples:
 
-Examples:
  * Tickets: :trac:`#1` or :trac:`ticket:1`
  * Ticket comments: :trac:`comment:ticket:1:2`
@@ -35 +36 @@
  * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
  * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
- * Diffs (since version 0.10): :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
+ * Diffs: :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
  * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
  * Milestones: :trac:`milestone:1.0`
@@ -43 +44 @@
  * 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 that the above could have been written using substitution references and the `trac::` directive:
 {{{
-{{{
-#!rst
+{{{#!rst
+See |ticket123|.
 
-See _`ticket:123`
-
- .. trac:: ticket:123 Ticket 123
+ .. |ticket123| trac:: ticket:123 this ticket
 }}}
 }}}
+
+This renders as:
 ----
 
-{{{
-#!rst
+{{{#!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.
 
 ----