Changes between Version 1 and Version 2 of Wiki Restructured Text


Ignore:
Timestamp:
Jul 4, 2008, 2:09:43 PM (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Wiki Restructured Text

    v1 v2  
    11= reStructuredText Support in Trac =
    22
    3 Since 0.6, Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context where WikiFormatting is used.
     3Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used.
    44
    55From the reStucturedText webpage:
    … …  
    2121
    2222=== TracLinks in reStructuredText ===
    23 Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text.
    2423
    25 Example:
     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
    2658{{{
    2759{{{
    2860#!rst
    29 This is a reference to |a ticket|
    3061
    31 .. |a ticket| trac:: #42
     62.. code-block:: python
     63
     64 class Test:
     65
     66    def TestFunction(self):
     67        pass
     68
    3269}}}
    3370}}}
    3471
    35 For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks.
     72Will result in the below.
    3673
    37 === Example ===
     74{{{
     75#!rst
     76
     77.. code-block:: python
     78
     79 class Test:
     80
     81    def TestFunction(self):
     82        pass
     83
     84}}}
     85
     86=== Wiki Macros in reStructuredText ===
     87
     88For doing [WikiMacros Wiki Macros] in ReST you use the same directive as for syntax highlighting i.e
     89code-block. To work you must use a version of trac that has #801 applied.
     90
     91=== Wiki Macro Example ===
     92
     93{{{
     94{{{
     95#!rst
     96
     97.. code-block:: RecentChanges
     98
     99   Trac,3
     100
     101}}}
     102}}}
     103
     104Will result in the below:
     105
     106     [[RecentChanges(Trac,3)]]
     107
     108Or a more concise Wiki Macro like syntax is also available:
     109
     110{{{
     111{{{
     112#!rst
     113
     114:code-block:`RecentChanges:Trac,3`
     115}}}
     116}}}
     117
     118=== Bigger ReST Example ===
    38119The example below should be mostly self-explanatory:
    39120{{{
    … …  
    61142-------------
    62143
    63 See also ticket |#42|.
    64 
    65 .. |#42| trac:: #42
     144See also ticket `#42`:trac:.
    66145
    67146.. _webpage: http://docutils.sourceforge.net/rst.html
    … …  
    93172-------------
    94173
    95 See also ticket |#42|.
    96 
    97 .. |#42| trac:: #42
     174See also ticket `#42`:trac:.
    98175
    99176.. _webpage: http://docutils.sourceforge.net/rst.html