Table of Contents reStructuredText Support in Trac Requirements More information on RST Using RST in Trac TracLinks in reStructuredText Syntax highlighting in reStructuredText WikiMacros in reStructuredText WikiMacro Example Bigger ReST Example = ===== = ===== = ===== = = ===== = ===== = ===== =

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. ''"

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.

 * reStructuredText Website -- http://docutils.sourceforge.net/rst.html
 * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html

---

To specify that a block of text should be parsed using RST, use the rst processor.

 * 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:
 }}}
 }}}

There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called code-block

Example

Will result in the below.

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.

Will result in the below.

HelloWorld(Something I wanted to say)

The example below should be mostly self-explanatory:

Results in:

---

See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting