Changes between Version 5 and Version 6 of WikiRestructuredText
- Timestamp:
- Jan 12, 2016, 11:21:52 PM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiRestructuredText
v5 v6 1 1 = reStructuredText Support in Trac = 2 2 3 Trac supports [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText (RST)] as an alternative to wiki markup whereWikiFormatting is used.3 Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used. 4 4 5 5 From the reStucturedText webpage: 6 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. ''" 7 7 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 thevalue for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example].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]. 9 9 10 10 === 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. 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. 14 15 15 16 === More information on RST === … … 69 70 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks. 70 71 72 71 73 === Syntax highlighting in reStructuredText === 72 74 73 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block: 75 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called 76 code-block 74 77 75 78 ||= Wiki Markup ||= Display || … … 106 109 === Wiki Macros in reStructuredText === 107 110 108 To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block: 111 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 109 112 110 113 ||= Wiki Markup ||= Display || … … 132 135 }}} 133 136 134 Or a more concise Wiki Macro -like syntax is also available, using the `:code-block:` role:137 Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role: 135 138 136 139 ||= Wiki Markup ||= Display || … … 153 156 154 157 === Bigger RST Example === 155 The example below should be self-explanatory:158 The example below should be mostly self-explanatory: 156 159 157 160 ||= Wiki Markup ||= Display ||