Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
06/17/09 18:53:29 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v1 v2  
    99Note that to activate RST support in Trac, the python docutils package must be installed.  
    1010If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website]. 
     11 
     12Install 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. 
    1113 
    1214=== More information on RST === 
    … …  
    2224=== TracLinks in reStructuredText === 
    2325 
    24  * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text. 
     26 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. 
    2527 
    2628 Example: 
    … …  
    3436 }}} 
    3537 
    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. 
     38 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. 
    4039 
    4140 Example: 
    … …  
    4948 }}} 
    5049 
     50 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.  
     51 
     52 
    5153=== Syntax highlighting in reStructuredText === 
    5254 
    53 There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called 
     55There is a directive for doing TracSyntaxColoring in RST as well. The directive is called 
    5456code-block 
    5557 
    … …  
    8486}}} 
    8587 
     88=== Wiki Macros in reStructuredText === 
    8689 
    87 === Example === 
     90For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e 
     91code-block. To work you must use a version of trac that has [trac:ticket:801 #801] applied.  
     92 
     93=== Wiki Macro Example === 
     94 
     95{{{ 
     96{{{ 
     97#!rst 
     98 
     99.. code-block:: RecentChanges 
     100 
     101   Trac,3 
     102 
     103}}} 
     104}}} 
     105 
     106Will result in the below: 
     107 
     108     [[RecentChanges(Trac,3)]] 
     109 
     110Or a more concise Wiki Macro like syntax is also available: 
     111 
     112{{{ 
     113{{{ 
     114#!rst 
     115 
     116:code-block:`RecentChanges:Trac,3` 
     117}}} 
     118}}} 
     119 
     120=== Bigger RST Example === 
    88121The example below should be mostly self-explanatory: 
    89122{{{ 
    … …  
    111144------------- 
    112145 
    113 See also ticket |#42|. 
    114  
    115 .. |#42| trac:: #42 
     146See also ticket `#42`:trac:. 
    116147 
    117148.. _webpage: http://docutils.sourceforge.net/rst.html 
    … …  
    143174------------- 
    144175 
    145 See also ticket |#42|. 
    146  
    147 .. |#42| trac:: #42 
     176See also ticket `#42`:trac:. 
    148177 
    149178.. _webpage: http://docutils.sourceforge.net/rst.html