Edgewall Software

Changes between Version 29 and Version 30 of WikiRestructuredText


Ignore:
Timestamp:
Jan 3, 2015, 2:00:56 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v29 v30  
    22[[TranslatedPages]]
    33
    4 Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used.
     4Trac supports [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText (RST)] as an alternative to wiki markup where WikiFormatting is used.
    55
    66From the reStucturedText webpage:
    77 "''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. ''"
    88
    9 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].
     9If 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].
    1010
    1111=== Requirements ===
    12 Note that to activate RST support in Trac, the python docutils package must be installed.
    13 If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
    14 
    15 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.
     12To 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].
     13
     14Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then.
    1615
    1716=== More information on RST ===
     
    7170 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
    7271
    73 
    7472=== Syntax highlighting in reStructuredText ===
    7573
    76 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called
    77 code-block
     74There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block:
    7875
    7976||= Wiki Markup ||= Display ||
     
    110107=== Wiki Macros in reStructuredText ===
    111108
    112 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block.
     109To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block:
    113110
    114111||= Wiki Markup ||= Display ||
     
    136133}}}
    137134
    138 Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role:
     135Or a more concise Wiki Macro-like syntax is also available, using the `:code-block:` role:
    139136
    140137||= Wiki Markup ||= Display ||
     
    157154
    158155=== Bigger RST Example ===
    159 The example below should be mostly self-explanatory:
     156The example below should be self-explanatory:
    160157
    161158||= Wiki Markup ||= Display ||