Changes between Version 5 and Version 6 of WikiRestructuredText


Ignore:
Timestamp:
03/24/15 23:15:03 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v5 v6  
    11= reStructuredText Support in Trac =
    22
    3 Trac supports [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText (RST)] as an alternative to wiki markup where WikiFormatting is used.
     3Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context 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 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].
     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].
    99
    1010=== Requirements ===
    11 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].
    12 
    13 Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then.
     11Note that to activate RST support in Trac, the python docutils package must be installed.
     12If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
     13
     14Install 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.
    1415
    1516=== More information on RST ===
     
    6970 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
    7071
     72
    7173=== Syntax highlighting in reStructuredText ===
    7274
    73 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block:
     75There is a directive for doing TracSyntaxColoring in RST as well. The directive is called
     76code-block
    7477
    7578||= Wiki Markup ||= Display ||
     
    106109=== Wiki Macros in reStructuredText ===
    107110
    108 To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block:
     111For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block.
    109112
    110113||= Wiki Markup ||= Display ||
     
    132135}}}
    133136
    134 Or a more concise Wiki Macro-like syntax is also available, using the `:code-block:` role:
     137Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role:
    135138
    136139||= Wiki Markup ||= Display ||
     
    153156
    154157=== Bigger RST Example ===
    155 The example below should be self-explanatory:
     158The example below should be mostly self-explanatory:
    156159
    157160||= Wiki Markup ||= Display ||