Skip to content

WikiRestructuredText

Jump to bottom Edit New page
Ricardo M. Ferraz Leal edited this page Apr 11, 2019 · 5 revisions

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

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 .

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 .

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

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 directive trac:: to allow TracLinks from within RST text.
Wiki Markup Display 
{{{
#!rst
This is a reference to |a ticket|

.. |a ticket| trac:: #42
}}}

This is a reference to SasView/sasview#270
  • Trac allows an even easier way of creating TracLinks in RST, using the custom :trac: role.
Wiki Markup Display 
{{{
#!rst
This is a reference to ticket `#12`:trac:

To learn how to use Trac, see TracGuide:trac:
}}}

This is a reference to ticket SasView/sasview#241

To learn how to use Trac, see TracGuide

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

Wiki Markup Display 
{{{
#!rst

.. code-block:: python


class Test:


   def TestFunction(self):
       pass



}}}
 
class Test:
    def TestFunction(self):
        pass

Note the need to indent the code at least one character after the .. code-block directive.

Wiki Macros in reStructuredText

For doing Wiki Macros in RST you use the same directive as for syntax highlighting i.e code-block.

Wiki Markup Display 
{{{
#!rst

.. code-block:: RecentChanges


Trac,3


}}}

Oct 5, 2016

Or a more concise Wiki Macro like syntax is also available, using the :code-block: role:

Wiki Markup Display 
{{{
#!rst

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

Oct 5, 2016

Bigger RST Example

The example below should be mostly self-explanatory:

Wiki Markup Display 
{{{
#!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
}}}

FooBar Header

reStructuredText is nice . It has its own webpage .

A table:

Inputs Output
A B
False False
True False
False True
True True

RST TracLinks

See also ticket SasView/sasview#270 .

See also: WikiRestructuredTextLinks , WikiProcessors , WikiFormatting

Add a custom footer

HOME

The Developers' Corner

(Potential) Contributors Resources

Helping others to use SasView

Code & Contributor Camps

Clone this wiki locally