Changes between Version 5 and Version 6 of WikiRestructuredText


Ignore:
Timestamp:
08/08/15 13:07:53 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v5 v6  
    11= reStructuredText Support in Trac = 
    22 
    3 Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used. 
     3Trac supports [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText (RST)] as an alternative to wiki markup where WikiFormatting is used. 
    44 
    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. ''" 
    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]. 
     8If 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]. 
    99 
    1010=== Requirements === 
    11 Note that to activate RST support in Trac, the python docutils package must be installed.  
    12 If 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. 
     11To 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]. 
     12 
     13Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then. 
    1514 
    1615=== More information on RST === 
     
    7069 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.  
    7170 
    72  
    7371=== Syntax highlighting in reStructuredText === 
    7472 
    75 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called 
    76 code-block 
     73There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block: 
    7774 
    7875||= Wiki Markup ||= Display || 
     
    109106=== Wiki Macros in reStructuredText === 
    110107 
    111 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 
     108To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block: 
    112109 
    113110||= Wiki Markup ||= Display || 
     
    135132}}} 
    136133 
    137 Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role: 
     134Or a more concise Wiki Macro-like syntax is also available, using the `:code-block:` role: 
    138135 
    139136||= Wiki Markup ||= Display || 
     
    156153 
    157154=== Bigger RST Example === 
    158 The example below should be mostly self-explanatory: 
     155The example below should be self-explanatory: 
    159156 
    160157||= Wiki Markup ||= Display ||