Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
May 15, 2010, 9:05:30 PM (15 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
    86 === WikiMacros in reStructuredText ===
     88=== Wiki Macros in reStructuredText ===
    8789
    88 For doing WikiMacros in ReST you use the same directive as for syntax highlightning i.e
    89 code-block. To work you must use a version of trac that has #801 applied.
     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.
    9092
    91 === WikiMacro Example ===
     93=== Wiki Macro Example ===
    9294
    9395{{{
    … …  
    9597#!rst
    9698
    97 .. code-block:: HelloWorld
    98  
    99    Something I wanted to say
     99.. code-block:: RecentChanges
    100100
     101   Trac,3
    101102
    102103}}}
    103104}}}
    104105
    105 Will result in the below.
     106Will result in the below:
    106107
    107 [[HelloWorld(Something I wanted to say)]]
     108     [[RecentChanges(Trac,3)]]
    108109
     110Or a more concise Wiki Macro like syntax is also available:
    109111
    110 === Bigger ReST Example ===
     112{{{
     113{{{
     114#!rst
     115
     116:code-block:`RecentChanges:Trac,3`
     117}}}
     118}}}
     119
     120=== Bigger RST Example ===
    111121The example below should be mostly self-explanatory:
    112122{{{