Changes between Version 1 and Version 2 of WikiRestructuredTextLinks

Timestamp:

01/22/09 18:49:02 (16 years ago)

Author:

trac

Comment:

--

WikiRestructuredTextLinks

@@ -1 +1 @@
 = TracLinks in reStructuredText =
 
-This document is for testing the ``..trac::`` directive. The page is written like
+This document illustrates how to use the ``..trac::`` directive in reStructureThe page is written like
 
 {{{
@@ -7 +7 @@
 #!rst 
 
-Examples
-...
-...
+Examples:
+ * Tickets: :trac:`#1` or :trac:`ticket:1`
+ * Ticket comments: :trac:`comment:ticket:1:2`
+ * Reports: :trac:`{1}` or :trac:`report:1`
+ * 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`
+ * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
+ * Milestones: :trac:`milestone:1.0`
+ * Attachment: :trac:`attachment:ticket:944:attachment.1073.diff`
+ * Files: :trac:`source:trunk/COPYING`
+ * A specific file revision: :trac:`source:/trunk/COPYING@200`
+ * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
 
 }}}
 }}}
 
+Provided you have docutils installed, the above block will render as:
+----
+{{{
+#!rst 
 
-This is a list of example uses of the ''trac'' directive, providing use of TracLinks in WikiRestructuredText.
+Examples:
+ * Tickets: :trac:`#1` or :trac:`ticket:1`
+ * Ticket comments: :trac:`comment:ticket:1:2`
+ * Reports: :trac:`{1}` or :trac:`report:1`
+ * 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`
+ * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
+ * Milestones: :trac:`milestone:1.0`
+ * Attachment: :trac:`attachment:ticket:944:attachment.1073.diff`
+ * Files: :trac:`source:trunk/COPYING`
+ * A specific file revision: :trac:`source:/trunk/COPYING@200`
+ * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
+
+}}}
+----
+
+Note also that any of the above could have been written using the alternate syntax for roles:
+{{{
+{{{
+#!rst
+
+See _`ticket:123`
+
+ .. trac:: ticket:123 Ticket 123
+}}}
+}}}
+----
 
 {{{
 #!rst
 
-Examples
---------
+See _`ticket:123`
 
-trac role
-=========
-Syntax is \`link\`\:trac: or :trac:\`link\`, and could be put anywhere in the text. 'link' has the same format as explain for the ``.. trac::`` directive below.
-
-``In the middle of my text `WikiFormatting`:trac: see!!!!`` 
-   In the middle of my text `WikiFormatting`:trac: see!!!!
-
-or
-
-``In the middle of my text :trac:`WikiFormatting` see!!!!`` 
-   In the middle of my text :trac:`WikiFormatting` see!!!!
-
-
-wiki
-====
-``.. trac:: WikiFormatting``
-        .. trac:: WikiFormatting
-
-``.. trac:: wiki:WikiFormatting``
-       .. trac:: wiki:WikiFormatting
-
-``.. trac:: wiki:WikiFormatting WikiFormatting``
-        .. trac:: wiki:WikiFormatting WikiFormatting
-
-``.. trac:: wiki:WikiFormatting LinkText``
-        .. trac:: wiki:WikiFormatting LinkText
-
-tickets
-=======
-
-``.. trac:: #1``
-        .. trac:: #1
-``.. trac:: #1 ticket one``
-        .. trac:: #1 ticket one
-``.. trac:: ticket:1``
-        .. trac:: ticket:1
-``.. trac:: ticket:1 ticket one``
-        .. trac:: ticket:1 ticket one
-
-reports
-=======
-
-``.. trac:: {1}``
-        .. trac:: {1}
-``.. trac:: {1} report one``
-        .. trac:: {1} report one
-``.. trac:: report:1``
-        .. trac:: report:1
-``.. trac:: report:1 report one``
-        .. trac:: report:1 report one
-
-changesets
-==========
-
-``.. trac:: [42]``
-        .. trac:: [42]
-``.. trac:: [42] changeset 42``
-        .. trac:: [42] changeset 42
-``.. trac:: changeset:42``
-        .. trac:: changeset:42
-``.. trac:: changeset:42 changeset 42``
-        .. trac:: changeset:42 changeset 42
-``.. trac:: foo``
-        .. trac:: foo
-
-files
-=====
-
-``.. trac:: browser:/trunk/trac``
-        .. trac:: browser:/trunk/trac
-
-The leading ``/`` can be omitted...
-
-``.. trac:: repos:trunk/trac trunk/trac``
-        .. trac:: repos:trunk/trac trunk/trac
-``.. trac:: source:trunk/trac Trac source code``
-        .. trac:: source:trunk/trac Trac source code
-
-``.. trac:: browser:trunk/README``
-        .. trac:: browser:trunk/README
-``.. trac:: repos:trunk/README trunk/README``
-        .. trac:: repos:trunk/README trunk/README
-``.. trac:: source:trunk/README README in trunk``
-        .. trac:: source:trunk/README README in trunk
-
-Note that if ``hoo`` is a file, the link targets its revision log. In order to see the file's content, you need to specify the revision explicitely, like here:
-
-``.. trac:: browser:/trunk/README#latest latest of trunk/README``
-        .. trac:: browser:/trunk/README#latest latest of trunk/README
-``.. trac:: repos:trunk/README#42 trunk/README in rev 42``
-        .. trac:: repos:trunk/README#42 trunk/README in rev 42
+.. trac:: ticket:123 Ticket 123
 }}}
+----
+The above form has the additional benefit of allowing you to specify an explicit label for the link.
 
 ----
-See also: WikiRestructuredTextLinks, TracLinks
+See also: WikiRestructuredText, TracLinks