Changes between Version 1 and Version 2 of WikiRestructuredText

Timestamp:

10/12/11 21:24:16 (14 years ago)

Author:

trac

Comment:

--

WikiRestructuredText

@@ -5 +5 @@
 From the reStucturedText webpage:
  "''reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser   system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating  simple web pages, and for standalone documents. reStructuredText is designed for extensibility for  specific application domains. ''"
+
+If you want a file from your Subversion repository be displayed as reStructuredText in Trac's source browser, set `text/x-rst` as value for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example].
 
 === Requirements ===
@@ -10 +12 @@
 If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
 
+Install docutils using `easy_install docutils`. Do not use the package manager of your OS (e.g. `apt-get install python-docutils`), because Trac will not find docutils then.
+
 === More information on RST ===
 
@@ -22 +26 @@
 === TracLinks in reStructuredText ===
 
- * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text.
-
- Example:
- {{{
- {{{
- #!rst
- This is a reference to |a ticket|
-
- .. |a ticket| trac:: #42
- }}}
- }}}
-
- For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks. 
-
-
- * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme.
-
- Example:
- {{{
- {{{
- #!rst
- This is a reference to ticket `#12`:trac:
-
- To learn how to use Trac, see `TracGuide`:trac:
- }}}
- }}}
+ * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
+   ||= Wiki Markup ||= Display ||
+   {{{#!td
+     {{{
+     {{{
+     #!rst
+     This is a reference to |a ticket|
+
+     .. |a ticket| trac:: #42
+     }}}
+     }}}
+   }}}
+   {{{#!td
+     {{{
+     #!rst
+     This is a reference to |a ticket|
+
+     .. |a ticket| trac:: #42
+     }}}
+   }}}
+
+ * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role.
+   ||= Wiki Markup ||= Display ||
+   {{{#!td
+     {{{
+     {{{
+     #!rst
+     This is a reference to ticket `#12`:trac:
+
+     To learn how to use Trac, see `TracGuide`:trac:
+     }}}
+     }}}
+   }}}
+   {{{#!td
+     {{{
+     #!rst
+     This is a reference to ticket `#12`:trac:
+
+     To learn how to use Trac, see `TracGuide`:trac:
+     }}}
+   }}}
+
+ For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks. 
+
 
 === Syntax highlighting in reStructuredText ===
 
-There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called
+There is a directive for doing TracSyntaxColoring in RST as well. The directive is called
 code-block
 
-Example
-
-{{{
-{{{
-#!rst
-
-.. code-block:: python
-
- class Test:
-
-    def TestFunction(self):
-        pass
-
-}}}
-}}}
-
-Will result in the below.
-
-{{{
-#!rst
-
-.. code-block:: python
-
- class Test:
-
-    def TestFunction(self):
-        pass
-
-}}}
-
-=== WikiMacros in reStructuredText ===
-
-For doing WikiMacros in ReST you use the same directive as for syntax highlightning i.e
-code-block. To work you must use a version of trac that has #801 applied. 
-
-=== WikiMacro Example ===
-
-{{{
-{{{
-#!rst
-
-.. code-block:: HelloWorld
- 
-   Something I wanted to say
-
-
-}}}
-}}}
-
-Will result in the below.
-
-[[HelloWorld(Something I wanted to say)]]
-
-
-=== Bigger ReST Example ===
+||= Wiki Markup ||= Display ||
+{{{#!td
+  {{{
+  {{{
+  #!rst
+
+  .. code-block:: python
+
+     class Test:
+
+         def TestFunction(self):
+             pass
+  
+  }}}
+  }}}
+}}}
+{{{#!td
+  {{{
+  #!rst
+
+  .. code-block:: python
+
+     class Test:
+
+         def TestFunction(self):
+             pass
+
+  }}}
+}}}
+Note the need to indent the code at least one character after the `.. code-block` directive.
+
+=== Wiki Macros in reStructuredText ===
+
+For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block.
+
+||= Wiki Markup ||= Display ||
+{{{#!td
+  {{{
+  {{{
+  #!rst
+
+  .. code-block:: RecentChanges
+
+     Trac,3
+
+  }}}
+  }}}
+}}}
+{{{#!td
+  {{{
+  #!rst
+
+  .. code-block:: RecentChanges
+
+     Trac,3
+
+  }}}
+}}}
+
+Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role:
+
+||= Wiki Markup ||= Display ||
+{{{#!td
+  {{{
+  {{{
+  #!rst
+
+  :code-block:`RecentChanges:Trac,3`
+  }}}
+  }}}
+}}}
+{{{#!td
+  {{{
+  #!rst
+
+  :code-block:`RecentChanges:Trac,3`
+  }}}
+}}}
+
+=== Bigger RST Example ===
 The example below should be mostly self-explanatory:
+
+||= Wiki Markup ||= Display ||
+{{{#!td
 {{{
 #!html
@@ -139 +189 @@
 }}}</pre>
 }}}
-
-
-Results in:
+}}}
+{{{#!td
 {{{
 #!rst
@@ -168 +217 @@
 .. _webpage: http://docutils.sourceforge.net/rst.html
 }}}
-
+}}}
 
 ----