no way to compare when less than two revisions

Differences

This shows you the differences between two versions of the page.

@@ Line 1: / Line 1: @@
+====== reStructuredText Support in Trac ======
+Trac supports using //reStructuredText// (RST) as an alternative to wiki markup in any context 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. //"
+==== 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]].
+==== 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 =====
+To specify that a block of text should be parsed using RST, use the //rst// processor.
+==== TracLinks in reStructuredText ====
+  * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text.
+ Example:
+ <code>
+ <code>
+ #!rst
+ This is a reference to |a ticket|
+ .. |a ticket| trac:: #42
+ </code>
+ </code>
+ 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:
+ <code>
+ <code>
+ #!rst
+ This is a reference to ticket `#12`:trac:
+ To learn how to use Trac, see `TracGuide`:trac:
+ </code>
+ </code>
+==== Syntax highlighting in reStructuredText ====
+There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called
+code-block
+Example
+<code>
+<code>
+#!rst
+.. code-block:: python
+ class Test:
+    def TestFunction(self):
+        pass
+</code>
+</code>
+Will result in the below.
+<code>
+#!rst
+.. code-block:: python
+ class Test:
+    def TestFunction(self):
+        pass
+</code>
+==== 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 ====
+<code>
+<code>
+#!rst
+.. code-block:: HelloWorld
+   Something I wanted to say
+</code>
+</code>
+Will result in the below.
+[[:HelloWorld(Something|I wanted to say)]]
+==== Bigger ReST Example ====
+The example below should be mostly self-explanatory:
+<code>
+#!html
+<pre class="wiki"><code>
+#!rst
+FooBar Header
+=============
+reStructuredText is **nice**. It has its own webpage_.
+A table:
+=  =  ======
+   Inputs     Output
+------------  ------
+  A      B    A or B
+=  =  ======
+False  False  False
+True   False  True
+False  True   True
+True   True   True
+=  =  ======
+RST TracLinks
+-------------
+See also ticket `#42`:trac:.
+.. _webpage: http://docutils.sourceforge.net/rst.html
+</code>
+</pre>
+</code>
+Results in:
+<code>
+#!rst
+FooBar Header
+=============
+reStructuredText is **nice**. It has its own webpage_.
+A table:
+=  =  ======
+   Inputs     Output
+------------  ------
+  A      B    A or B
+=  =  ======
+False  False  False
+True   False  True
+False  True   True
+True   True   True
+=  =  ======
+RST TracLinks
+-------------
+See also ticket `#42`:trac:.
+.. _webpage: http://docutils.sourceforge.net/rst.html
+</code>
+----
+See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting