Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
Jan 16, 2006, 10:33:17 AM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    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=== WikiMacros in reStructuredText ===
     87
     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.
     90
     91=== WikiMacro Example ===
     92
     93{{{
     94{{{
     95#!rst
     96
     97.. code-block:: HelloWorld
     98 
     99   Something I wanted to say
     100
     101
     102}}}
     103}}}
     104
     105Will result in the below.
     106
     107[[HelloWorld(Something I wanted to say)]]
     108
     109
     110=== Bigger ReST Example ===
    38111The example below should be mostly self-explanatory:
    39112{{{
     
    61134-------------
    62135
    63 See also ticket |#42|.
    64 
    65 .. |#42| trac:: #42
     136See also ticket `#42`:trac:.
    66137
    67138.. _webpage: http://docutils.sourceforge.net/rst.html
     
    93164-------------
    94165
    95 See also ticket |#42|.
    96 
    97 .. |#42| trac:: #42
     166See also ticket `#42`:trac:.
    98167
    99168.. _webpage: http://docutils.sourceforge.net/rst.html