Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
09/10/09 19:34:28 (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 
    12 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.
    1311
    1412=== More information on RST ===
     
    2422=== TracLinks in reStructuredText ===
    2523
    26  * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
     24 * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text.
    2725
    2826 Example:
     
    3634 }}}
    3735
    38  * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role.
     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.
    3940
    4041 Example:
     
    4849 }}}
    4950
    50  For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
    51 
    52 
    5351=== Syntax highlighting in reStructuredText ===
    5452
    55 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called
     53There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called
    5654code-block
    5755
     
    8684}}}
    8785
    88 === Wiki Macros in reStructuredText ===
     86=== WikiMacros in reStructuredText ===
    8987
    90 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e
    91 code-block. To work you must use a version of trac that has [trac:ticket:801 #801] applied.
     88For doing WikiMacros in ReST you use the same directive as for syntax highlightning i.e
     89code-block. To work you must use a version of trac that has #801 applied.
    9290
    93 === Wiki Macro Example ===
     91=== WikiMacro Example ===
    9492
    9593{{{
     
    9795#!rst
    9896
    99 .. code-block:: RecentChanges
     97.. code-block:: HelloWorld
     98 
     99   Something I wanted to say
    100100
    101    Trac,3
    102101
    103102}}}
    104103}}}
    105104
    106 Will result in the below:
     105Will result in the below.
    107106
    108      [[RecentChanges(Trac,3)]]
     107[[HelloWorld(Something I wanted to say)]]
    109108
    110 Or a more concise Wiki Macro like syntax is also available:
    111109
    112 {{{
    113 {{{
    114 #!rst
    115 
    116 :code-block:`RecentChanges:Trac,3`
    117 }}}
    118 }}}
    119 
    120 === Bigger RST Example ===
     110=== Bigger ReST Example ===
    121111The example below should be mostly self-explanatory:
    122112{{{