Version 2 (modified by anonymous, 15 years ago) (diff) |
---|
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
- 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:
{{{ #!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.
class Test: def TestFunction(self): pass
Example
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|. .. |#42| trac:: #42 .. _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.
See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormattingI'm going back to windoze, too many dammed options with linux ;)
-- Blumf
http://studenti.dsi.unive.it/forum/index.php?showuser=1212
acquista cialis viagra generico cialis http://www.maclife.com/user/buy_tramadol_0 http://www.maclife.com/user/buy_cialis_com http://www.gomedia.us/forum/member.php?u=1621 http://forum.desktopreview.com/member.php?u=145579 lrEFLhq acquistare viagra buy cheap fioricet headache Generic Cialis vs Brand Cialis 3CiYFef how to buy tramadol