Skip to content

WikiRestructuredText

Jump to bottom
Joe Hellerstein edited this page Dec 8, 2015 · 1 revision

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 RST Website.

More information on RST

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:

 {{{
 #!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:
 }}}
 }}}

=== Syntax highlighting in reStructuredText ===

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

Example

{{{
{{{
#!rst

.. code-block:: python

 class Test:

    def TestFunction(self):
        pass

}}}

Will result in the below.

#!rst

.. code-block:: python

 class Test:

    def TestFunction(self):
        pass

Wiki Macros in reStructuredText

For doing [WikiMacros Wiki Macros] in ReST you use the same directive as for syntax highlighting i.e code-block. To work you must use a version of trac that has #801 applied.

Wiki Macro Example

{{{
#!rst

.. code-block:: RecentChanges

   Trac,3

}}}

Will result in the below:

 [[RecentChanges(Trac,3)]]

Or a more concise Wiki Macro like syntax is also available:

{{{
#!rst

:code-block:`RecentChanges:Trac,3`

}}}

Bigger ReST Example

The example below should be mostly self-explanatory:

#!html
<pre class="wiki">{{{
#!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</pre>

}}}

Results in:

#!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

See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting

Clone this wiki locally