Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
Mar 2, 2017 6:39:50 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v1 v2  
    1 = reStructuredText Support in Trac =
    2 
    3 Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used.
     1= reStructuredText Support in Trac
     2
     3== Introduction
     4
     5
     6Trac supports [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText (RST)] as an alternative to wiki markup where WikiFormatting is used.
    47
    58From the reStucturedText webpage:
    6  "''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 
    8 === Requirements ===
    9 Note that to activate RST support in Trac, the python docutils package must be installed.
    10 If 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.
    13 
    14 === More information on RST ===
     9 "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."
     10
     11If you want a file from your Subversion repository to be displayed as reStructuredText in the Trac source browser, set `text/x-rst` as the value for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example].
     12
     13=== Requirements
     14
     15To activate RST support in Trac, install the python docutils package: `easy_install docutils`. If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
     16
     17Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then.
     18
     19=== More information on RST
    1520
    1621 * reStructuredText Website -- http://docutils.sourceforge.net/rst.html
    1722 * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html
    1823
    19 ----
    20 
    21 == Using RST in Trac ==
     24== Using RST in Trac
     25
    2226To specify that a block of text should be parsed using RST, use the ''rst'' processor.
    2327
    24 === TracLinks in reStructuredText ===
    25 
    26  * Trac provides a custom RST reference-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  }}}
    37 
    38  For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks.
    39 
    40 
    41  * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme.
    42 
    43  Example:
    44  {{{
    45  {{{
    46  #!rst
    47  This is a reference to ticket `#12`:trac:
    48 
    49  To learn how to use Trac, see `TracGuide`:trac:
    50  }}}
    51  }}}
    52 
    53 === Syntax highlighting in reStructuredText ===
    54 
    55 There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called
    56 code-block
    57 
    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 }}}
    87 
    88 === Wiki Macros in reStructuredText ===
    89 
    90 For doing [WikiMacros Wiki Macros] in ReST 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 }}}
    118 }}}
    119 
    120 === Bigger ReST Example ===
    121 The example below should be mostly self-explanatory:
     28=== TracLinks in reStructuredText
     29
     30 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
     31   ||= Wiki Markup ||= Display ||
     32   {{{#!td
     33     {{{
     34     {{{
     35     #!rst
     36     This is a reference to |a ticket|
     37
     38     .. |a ticket| trac:: #42
     39     }}}
     40     }}}
     41   }}}
     42   {{{#!td
     43     {{{
     44     #!rst
     45     This is a reference to |a ticket|
     46
     47     .. |a ticket| trac:: #42
     48     }}}
     49   }}}
     50
     51 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role.
     52   ||= Wiki Markup ||= Display ||
     53   {{{#!td
     54     {{{
     55     {{{
     56     #!rst
     57     This is a reference to ticket `#12`:trac:
     58
     59     To learn how to use Trac, see `TracGuide`:trac:
     60     }}}
     61     }}}
     62   }}}
     63   {{{#!td
     64     {{{
     65     #!rst
     66     This is a reference to ticket `#12`:trac:
     67
     68     To learn how to use Trac, see `TracGuide`:trac:
     69     }}}
     70   }}}
     71
     72 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
     73
     74=== Syntax highlighting in reStructuredText
     75
     76There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block:
     77
     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.
     108
     109=== Wiki Macros in reStructuredText
     110
     111To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie 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  }}}
     155}}}
     156
     157=== Bigger RST Example
     158
     159The example below should be self-explanatory:
     160
     161||= Wiki Markup ||= Display ||
     162{{{#!td
    122163{{{
    123164#!html
    … …  
    149190}}}</pre>
    150191}}}
    151 
    152 
    153 Results in:
     192}}}
     193{{{#!td
    154194{{{
    155195#!rst
    … …  
    178218.. _webpage: http://docutils.sourceforge.net/rst.html
    179219}}}
    180 
     220}}}
    181221
    182222----