Changes between Initial Version and Version 1 of WikiRestructuredText


Ignore:
Timestamp:
02/11/05 11:50:06 (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v1 v1  
     1= reStructuredText Support in Trac = 
     2 
     3Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used. 
     4 
     5From the reStucturedText webpage: 
     6 "''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. ''" 
     7 
     8=== Requirements === 
     9Note that to activate RST support in Trac, the python docutils package must be installed. 
     10If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website]. 
     11 
     12=== More information on RST === 
     13 
     14 * reStructuredText Website -- http://docutils.sourceforge.net/rst.html 
     15 * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html 
     16 
     17---- 
     18 
     19== Using RST in Trac == 
     20To specify that a block of text should be parsed using RST, use the ''rst'' processor. 
     21 
     22=== TracLinks in reStructuredText === 
     23 
     24 * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text. 
     25 
     26 Example: 
     27 {{{ 
     28 {{{ 
     29 #!rst 
     30 This is a reference to |a ticket| 
     31 
     32 .. |a ticket| trac:: #42 
     33 }}} 
     34 }}} 
     35 
     36 For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks. 
     37 
     38 
     39 * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme. 
     40 
     41 Example: 
     42 {{{ 
     43 {{{ 
     44 #!rst 
     45 This is a reference to ticket `#12`:trac: 
     46 
     47 To learn how to use Trac, see `TracGuide`:trac: 
     48 }}} 
     49 }}} 
     50 
     51=== Syntax highlighting in reStructuredText === 
     52 
     53There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called 
     54code-block 
     55 
     56Example 
     57 
     58{{{ 
     59{{{ 
     60#!rst 
     61 
     62.. code-block:: python 
     63 
     64 class Test: 
     65 
     66    def TestFunction(self): 
     67        pass 
     68 
     69}}} 
     70}}} 
     71 
     72Will result in the below. 
     73 
     74{{{ 
     75#!rst 
     76 
     77.. code-block:: python 
     78 
     79 class Test: 
     80 
     81    def TestFunction(self): 
     82        pass 
     83 
     84}}} 
     85 
     86 
     87=== Example === 
     88The example below should be mostly self-explanatory: 
     89{{{ 
     90#!html 
     91<pre class="wiki">{{{ 
     92#!rst 
     93FooBar Header 
     94============= 
     95reStructuredText is **nice**. It has its own webpage_. 
     96 
     97A table: 
     98 
     99=====  =====  ====== 
     100   Inputs     Output 
     101------------  ------ 
     102  A      B    A or B 
     103=====  =====  ====== 
     104False  False  False 
     105True   False  True 
     106False  True   True 
     107True   True   True 
     108=====  =====  ====== 
     109 
     110RST TracLinks 
     111------------- 
     112 
     113See also ticket |#42|. 
     114 
     115.. |#42| trac:: #42 
     116 
     117.. _webpage: http://docutils.sourceforge.net/rst.html 
     118}}}</pre> 
     119}}} 
     120 
     121 
     122Results in: 
     123{{{ 
     124#!rst 
     125FooBar Header 
     126============= 
     127reStructuredText is **nice**. It has its own webpage_. 
     128 
     129A table: 
     130 
     131=====  =====  ====== 
     132   Inputs     Output 
     133------------  ------ 
     134  A      B    A or B 
     135=====  =====  ====== 
     136False  False  False 
     137True   False  True 
     138False  True   True 
     139True   True   True 
     140=====  =====  ====== 
     141 
     142RST TracLinks 
     143------------- 
     144 
     145See also ticket |#42|. 
     146 
     147.. |#42| trac:: #42 
     148 
     149.. _webpage: http://docutils.sourceforge.net/rst.html 
     150}}} 
     151 
     152 
     153---- 
     154See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting