Changes between Version 3 and Version 4 of WikiRestructuredText


Ignore:
Timestamp:
19/05/2016 16:30:59 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v3 v4  
    1 = reStructuredText Support in Trac =
     1= reStructuredText Support in Trac
     2
     3== Introduction
     4
    25
    36Trac 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. ''"
     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."
    710
    811If 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].
    912
    10 === Requirements ===
     13=== Requirements
     14
    1115To 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].
    1216
    1317Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then.
    1418
    15 === More information on RST ===
     19=== More information on RST
    1620
    1721 * reStructuredText Website -- http://docutils.sourceforge.net/rst.html
    1822 * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html
    1923
    20 ----
    21 
    22 == Using RST in Trac ==
     24== Using RST in Trac
     25
    2326To specify that a block of text should be parsed using RST, use the ''rst'' processor.
    2427
    25 === TracLinks in reStructuredText ===
     28=== TracLinks in reStructuredText
    2629
    2730 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
    … …  
    6972 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
    7073
    71 === Syntax highlighting in reStructuredText ===
     74=== Syntax highlighting in reStructuredText
    7275
    7376There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block:
    … …  
    104107Note the need to indent the code at least one character after the `.. code-block` directive.
    105108
    106 === Wiki Macros in reStructuredText ===
     109=== Wiki Macros in reStructuredText
    107110
    108111To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block:
    … …  
    152155}}}
    153156
    154 === Bigger RST Example ===
     157=== Bigger RST Example
     158
    155159The example below should be self-explanatory:
    156160