Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
02/25/11 22:52:52 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v1 v2  
    55From the reStucturedText webpage: 
    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. ''" 
     7 
     8If 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]. 
    79 
    810=== Requirements === 
    … …  
    2527 
    2628 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. 
    27  
    28  Example: 
    29  {{{ 
    30  {{{ 
    31  #!rst 
    32  This is a reference to |a ticket| 
    33  
    34  .. |a ticket| trac:: #42 
    35  }}} 
    36  }}} 
     29   ||= Wiki Markup ||= Display || 
     30   {{{#!td 
     31     {{{ 
     32     {{{ 
     33     #!rst 
     34     This is a reference to |a ticket| 
     35 
     36     .. |a ticket| trac:: #42 
     37     }}} 
     38     }}} 
     39   }}} 
     40   {{{#!td 
     41     {{{ 
     42     #!rst 
     43     This is a reference to |a ticket| 
     44 
     45     .. |a ticket| trac:: #42 
     46     }}} 
     47   }}} 
    3748 
    3849 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. 
    39  
    40  Example: 
    41  {{{ 
    42  {{{ 
    43  #!rst 
    44  This is a reference to ticket `#12`:trac: 
    45  
    46  To learn how to use Trac, see `TracGuide`:trac: 
    47  }}} 
    48  }}} 
     50   ||= Wiki Markup ||= Display || 
     51   {{{#!td 
     52     {{{ 
     53     {{{ 
     54     #!rst 
     55     This is a reference to ticket `#12`:trac: 
     56 
     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: 
     65 
     66     To learn how to use Trac, see `TracGuide`:trac: 
     67     }}} 
     68   }}} 
    4969 
    5070 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.  
    … …  
    5676code-block 
    5777 
    58 Example 
    59  
    60 {{{ 
    61 {{{ 
    62 #!rst 
    63  
    64 .. code-block:: python 
    65  
    66  class Test: 
    67  
    68     def TestFunction(self): 
    69         pass 
    70  
    71 }}} 
    72 }}} 
    73  
    74 Will result in the below. 
    75  
    76 {{{ 
    77 #!rst 
    78  
    79 .. code-block:: python 
    80  
    81  class Test: 
    82  
    83     def TestFunction(self): 
    84         pass 
    85  
    86 }}} 
     78||= Wiki Markup ||= Display || 
     79{{{#!td 
     80  {{{ 
     81  {{{ 
     82  #!rst 
     83 
     84  .. code-block:: python 
     85 
     86     class Test: 
     87 
     88         def TestFunction(self): 
     89             pass 
     90   
     91  }}} 
     92  }}} 
     93}}} 
     94{{{#!td 
     95  {{{ 
     96  #!rst 
     97 
     98  .. code-block:: python 
     99 
     100     class Test: 
     101 
     102         def TestFunction(self): 
     103             pass 
     104 
     105  }}} 
     106}}} 
     107Note the need to indent the code at least one character after the `.. code-block` directive. 
    87108 
    88109=== Wiki Macros in reStructuredText === 
    89110 
    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.  
    92  
    93 === Wiki Macro Example === 
    94  
    95 {{{ 
    96 {{{ 
    97 #!rst 
    98  
    99 .. code-block:: RecentChanges 
    100  
    101    Trac,3 
    102  
    103 }}} 
    104 }}} 
    105  
    106 Will result in the below: 
    107  
    108      [[RecentChanges(Trac,3)]] 
    109  
    110 Or a more concise Wiki Macro like syntax is also available: 
    111  
    112 {{{ 
    113 {{{ 
    114 #!rst 
    115  
    116 :code-block:`RecentChanges:Trac,3` 
    117 }}} 
     111For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 
     112 
     113||= Wiki Markup ||= Display || 
     114{{{#!td 
     115  {{{ 
     116  {{{ 
     117  #!rst 
     118 
     119  .. code-block:: RecentChanges 
     120 
     121     Trac,3 
     122 
     123  }}} 
     124  }}} 
     125}}} 
     126{{{#!td 
     127  {{{ 
     128  #!rst 
     129 
     130  .. code-block:: RecentChanges 
     131 
     132     Trac,3 
     133 
     134  }}} 
     135}}} 
     136 
     137Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role: 
     138 
     139||= Wiki Markup ||= Display || 
     140{{{#!td 
     141  {{{ 
     142  {{{ 
     143  #!rst 
     144 
     145  :code-block:`RecentChanges:Trac,3` 
     146  }}} 
     147  }}} 
     148}}} 
     149{{{#!td 
     150  {{{ 
     151  #!rst 
     152 
     153  :code-block:`RecentChanges:Trac,3` 
     154  }}} 
    118155}}} 
    119156 
    120157=== Bigger RST Example === 
    121158The example below should be mostly self-explanatory: 
     159 
     160||= Wiki Markup ||= Display || 
     161{{{#!td 
    122162{{{ 
    123163#!html 
    … …  
    149189}}}</pre> 
    150190}}} 
    151  
    152  
    153 Results in: 
     191}}} 
     192{{{#!td 
    154193{{{ 
    155194#!rst 
    … …  
    178217.. _webpage: http://docutils.sourceforge.net/rst.html 
    179218}}} 
    180  
     219}}} 
    181220 
    182221----