Changes between Version 1 and Version 2 of WikiRestructuredText

Timestamp:

Apr 20, 2011, 12:03:00 PM (14 years ago)

Author:

trac

Comment:

--

WikiRestructuredText

@@ -6 +6 @@
  "''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 ===
 Note that to activate RST support in Trac, the python docutils package must be installed. 
 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.
+ * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
 
  Example:
@@ -34 +38 @@
  }}}
 
- 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.
+ * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role.
 
  Example:
@@ -49 +50 @@
  }}}
 
+ 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
 
@@ -84 +88 @@
 }}}
 
-=== WikiMacros in reStructuredText ===
+=== Wiki Macros 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. 
+For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block.
 
-=== WikiMacro Example ===
+=== Wiki Macro Example ===
 
 {{{
@@ -95 +98 @@
 #!rst
 
-.. code-block:: HelloWorld
- 
-   Something I wanted to say
+.. code-block:: RecentChanges
 
+   Trac,3
 
 }}}
 }}}
 
-Will result in the below.
+Will result in the below:
 
-[[HelloWorld(Something I wanted to say)]]
+     [[RecentChanges(Trac,3)]]
 
+Or a more concise Wiki Macro like syntax is also available:
 
-=== Bigger ReST Example ===
+{{{
+{{{
+#!rst
+
+:code-block:`RecentChanges:Trac,3`
+}}}
+}}}
+
+=== Bigger RST Example ===
 The example below should be mostly self-explanatory:
 {{{