Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
Jul 17, 2008 10:45:00 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v1 v2  
    66 "''reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser   system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating  simple web pages, and for standalone documents. reStructuredText is designed for extensibility for  specific application domains. ''" 
    77 
    8 If you want a file from your Subversion repository be displayed as reStructuredText in Trac's source browser, set `text/x-rst` as value for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example]. 
    9  
    108=== Requirements === 
    119Note that to activate RST support in Trac, the python docutils package must be installed.  
    1210If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website]. 
    13  
    14 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. 
    1511 
    1612=== More information on RST === 
     
    2622=== TracLinks in reStructuredText === 
    2723 
    28  * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. 
    29    ||= Wiki Markup ||= Display || 
    30    {{{#!td 
    31      {{{ 
    32      {{{ 
    33      #!rst 
    34      This is a reference to |a ticket| 
     24 * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text. 
    3525 
    36      .. |a ticket| trac:: #42 
    37      }}} 
    38      }}} 
    39    }}} 
    40    {{{#!td 
    41      {{{ 
    42      #!rst 
    43      This is a reference to |a ticket| 
     26 Example: 
     27 {{{ 
     28 {{{ 
     29 #!rst 
     30 This is a reference to |a ticket| 
    4431 
    45      .. |a ticket| trac:: #42 
    46      }}} 
    47    }}} 
     32 .. |a ticket| trac:: #42 
     33 }}} 
     34 }}} 
    4835 
    49  * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. 
    50    ||= Wiki Markup ||= Display || 
    51    {{{#!td 
    52      {{{ 
    53      {{{ 
    54      #!rst 
    55      This is a reference to ticket `#12`:trac: 
     36 For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks.  
    5637 
    57      To learn how to use Trac, see `TracGuide`:trac: 
    58      }}} 
    59      }}} 
    60    }}} 
    61    {{{#!td 
    62      {{{ 
    63      #!rst 
    64      This is a reference to ticket `#12`:trac: 
    6538 
    66      To learn how to use Trac, see `TracGuide`:trac: 
    67      }}} 
    68    }}} 
     39 * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme. 
    6940 
    70  For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.  
     41 Example: 
     42 {{{ 
     43 {{{ 
     44 #!rst 
     45 This is a reference to ticket `#12`:trac: 
    7146 
     47 To learn how to use Trac, see `TracGuide`:trac: 
     48 }}} 
     49 }}} 
    7250 
    7351=== Syntax highlighting in reStructuredText === 
    7452 
    75 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 
    7654code-block 
    7755 
    78 ||= Wiki Markup ||= Display || 
    79 {{{#!td 
    80   {{{ 
    81   {{{ 
    82   #!rst 
     56Example 
    8357 
    84   .. code-block:: python 
     58{{{ 
     59{{{ 
     60#!rst 
    8561 
    86      class Test: 
     62.. code-block:: python 
    8763 
    88          def TestFunction(self): 
    89              pass 
    90    
    91   }}} 
    92   }}} 
     64 class Test: 
     65 
     66    def TestFunction(self): 
     67        pass 
     68 
    9369}}} 
    94 {{{#!td 
    95   {{{ 
    96   #!rst 
     70}}} 
    9771 
    98   .. code-block:: python 
     72Will result in the below. 
    9973 
    100      class Test: 
     74{{{ 
     75#!rst 
    10176 
    102          def TestFunction(self): 
    103              pass 
     77.. code-block:: python 
    10478 
    105   }}} 
     79 class Test: 
     80 
     81    def TestFunction(self): 
     82        pass 
     83 
    10684}}} 
    107 Note the need to indent the code at least one character after the `.. code-block` directive. 
    10885 
    10986=== Wiki Macros in reStructuredText === 
    11087 
    111 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 
     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.  
    11290 
    113 ||= Wiki Markup ||= Display || 
    114 {{{#!td 
    115   {{{ 
    116   {{{ 
    117   #!rst 
     91=== Wiki Macro Example === 
    11892 
    119   .. code-block:: RecentChanges 
     93{{{ 
     94{{{ 
     95#!rst 
    12096 
    121      Trac,3 
     97.. code-block:: RecentChanges 
    12298 
    123   }}} 
    124   }}} 
     99   Trac,3 
     100 
    125101}}} 
    126 {{{#!td 
    127   {{{ 
    128   #!rst 
    129  
    130   .. code-block:: RecentChanges 
    131  
    132      Trac,3 
    133  
    134   }}} 
    135102}}} 
    136103 
    137 Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role: 
     104Will result in the below: 
    138105 
    139 ||= Wiki Markup ||= Display || 
    140 {{{#!td 
    141   {{{ 
    142   {{{ 
    143   #!rst 
     106     [[RecentChanges(Trac,3)]] 
    144107 
    145   :code-block:`RecentChanges:Trac,3` 
    146   }}} 
    147   }}} 
     108Or a more concise Wiki Macro like syntax is also available: 
     109 
     110{{{ 
     111{{{ 
     112#!rst 
     113 
     114:code-block:`RecentChanges:Trac,3` 
    148115}}} 
    149 {{{#!td 
    150   {{{ 
    151   #!rst 
    152  
    153   :code-block:`RecentChanges:Trac,3` 
    154   }}} 
    155116}}} 
    156117 
    157 === Bigger RST Example === 
     118=== Bigger ReST Example === 
    158119The example below should be mostly self-explanatory: 
    159  
    160 ||= Wiki Markup ||= Display || 
    161 {{{#!td 
    162120{{{ 
    163121#!html 
     
    189147}}}</pre> 
    190148}}} 
    191 }}} 
    192 {{{#!td 
     149 
     150 
     151Results in: 
    193152{{{ 
    194153#!rst 
     
    217176.. _webpage: http://docutils.sourceforge.net/rst.html 
    218177}}} 
    219 }}} 
     178 
    220179 
    221180----