Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
Apr 24, 2020, 9:10:42 AM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v1 v2  
    99 "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."
    1010
    11 If 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].
     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`, or add the extension `rst` to the filename. See [trac:source:branches/1.2-stable/INSTALL.rst this example].
     12
     13The examples will only be rendered as reStructuredText if docutils is installed. If Pygments is installed but docutils is not installed, the examples will be syntax-highlighted rather than rendered as reStructuredText.
    1214
    1315=== Requirements
    1416
    15 To 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 
    17 Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then.
     17To activate RST support in Trac, install the python docutils package with the command `easy_install docutils`, or through your operating system package manager. If not already available on your operating system, you can download it from [https://pypi.python.org/pypi/docutils PyPI].
    1818
    1919=== More information on RST
    2020
    21  * reStructuredText Website -- http://docutils.sourceforge.net/rst.html
    22  * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html
     21 * [http://docutils.sourceforge.net/rst.html reStructuredText Website]
     22 * [http://docutils.sourceforge.net/docs/rst/quickref.html RST Quick Reference]
    2323
    2424== Using RST in Trac
    … …  
    3232   {{{#!td
    3333     {{{
     34     {{{#!rst
     35     This is a reference to |a ticket|
     36
     37     .. |a ticket| trac:: #42
     38     }}}
     39     }}}
     40   }}}
     41   {{{#!td
     42     {{{#!rst
     43     This is a reference to |a ticket|
     44
     45     .. |a ticket| trac:: #42
     46     }}}
     47   }}}
     48
     49 * You can also use the custom `:trac:` role to create TracLinks in RST.
     50   ||= Wiki Markup ||= Display ||
     51   {{{#!td
    3452     {{{
    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
     53     {{{#!rst
    5754     This is a reference to ticket `#12`:trac:
    5855
    … …  
    6259   }}}
    6360   {{{#!td
    64      {{{
    65      #!rst
     61     {{{#!rst
    6662     This is a reference to ticket `#12`:trac:
    6763
    … …  
    7066   }}}
    7167
    72  For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
     68 For a complete example of all uses of the `:trac:` role, see WikiRestructuredTextLinks.
    7369
    7470=== Syntax highlighting in reStructuredText
    … …  
    7975{{{#!td
    8076  {{{
    81   {{{
    82   #!rst
     77  {{{#!rst
    8378
    8479  .. code-block:: python
    … …  
    9388}}}
    9489{{{#!td
    95   {{{
    96   #!rst
     90  {{{#!rst
    9791
    9892  .. code-block:: python
    … …  
    109103=== Wiki Macros in reStructuredText
    110104
    111 To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block:
     105To enable [WikiMacros Wiki Macros] in RST, you use the same `code-block` directive as for syntax highlighting:
     106
     107||= Wiki Markup ||= Display ||
     108{{{#!td
     109  {{{
     110  {{{#!rst
     111
     112  .. code-block:: RecentChanges
     113
     114     Trac,3
     115
     116  }}}
     117  }}}
     118}}}
     119{{{#!td
     120  {{{#!rst
     121
     122  .. code-block:: RecentChanges
     123
     124     Trac,3
     125
     126  }}}
     127}}}
     128
     129Or use the `:code-block:` role for a more concise Wiki Macro-like syntax:
    112130
    113131||= Wiki Markup ||= Display ||
    … …  
    117135  #!rst
    118136
    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 
    137 Or 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 
    145137  :code-block:`RecentChanges:Trac,3`
    146138  }}}
    … …  
    148140}}}
    149141{{{#!td
    150   {{{
    151   #!rst
     142  {{{#!rst
    152143
    153144  :code-block:`RecentChanges:Trac,3`
    … …  
    161152||= Wiki Markup ||= Display ||
    162153{{{#!td
    163 {{{
    164 #!html
    165 <pre class="wiki">{{{
    166 #!rst
     154{{{#!html
     155<pre class="wiki">{{{#!rst
    167156FooBar Header
    168157=============
    … …  
    192181}}}
    193182{{{#!td
    194 {{{
    195 #!rst
     183{{{#!rst
    196184FooBar Header
    197185=============