Changes between Version 3 and Version 4 of WikiRestructuredText

Timestamp:

01/14/19 00:01:55 (6 years ago)

Author:

trac

Comment:

--

WikiRestructuredText

@@ -1 @@
-= reStructuredText Support in Trac =
-
-Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used.
+= reStructuredText Support in Trac
+
+== Introduction
+
+
+Trac supports [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText (RST)] as an alternative to wiki markup where WikiFormatting is used.
 
 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 ===
-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 ===
+ "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 to be displayed as reStructuredText in the Trac source browser, set `text/x-rst` as the value for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example].
+
+=== Requirements
+
+To activate RST support in Trac, install the python docutils package: `easy_install docutils`. If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
+
+Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then.
+
+=== More information on RST
 
  * reStructuredText Website -- http://docutils.sourceforge.net/rst.html
  * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html
 
-----
-
-== Using RST in Trac ==
+== Using RST in Trac
+
 To specify that a block of text should be parsed using RST, use the ''rst'' processor. 
 
-=== TracLinks in reStructuredText ===
+=== TracLinks in reStructuredText
 
  * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
@@ -70 +72 @@
  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 RST as well. The directive is called
-code-block
+=== Syntax highlighting in reStructuredText
+
+There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block:
 
 ||= Wiki Markup ||= Display ||
@@ -107 +107 @@
 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 Macros in reStructuredText
+
+To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block:
 
 ||= Wiki Markup ||= Display ||
@@ -135 +135 @@
 }}}
 
-Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role:
+Or a more concise Wiki Macro-like syntax is also available, using the `:code-block:` role:
 
 ||= Wiki Markup ||= Display ||
@@ -155 +155 @@
 }}}
 
-=== Bigger RST Example ===
-The example below should be mostly self-explanatory:
+=== Bigger RST Example
+
+The example below should be self-explanatory:
 
 ||= Wiki Markup ||= Display ||