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. "
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 ?this example.
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 ?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.
To specify that a block of text should be parsed using RST, use the rst processor.
Example:
{{{ #!rst This is a reference to |a ticket| .. |a ticket| trac:: #42 }}}
Example:
{{{ #!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.
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.
.. code-block:: python class Test: def TestFunction(self): pass
For doing Wiki Macros in RST you use the same directive as for syntax highlighting i.e code-block.
{{{ #!rst .. code-block:: RecentChanges Trac,3 }}}
Will result in the below:
2010-12-25
Or a more concise Wiki Macro like syntax is also available:
{{{ #!rst :code-block:`RecentChanges:Trac,3` }}}
The example below should be mostly self-explanatory:
{{{ #!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 }}}
Results in:
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
See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting