Changes between Version 1 and Version 2 of WikiRestructuredText
- Timestamp:
- Jul 27, 2010, 10:28:48 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiRestructuredText
v1 v2 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 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 8 10 === Requirements === 9 11 Note that to activate RST support in Trac, the python docutils package must be installed. 10 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. 11 15 12 16 === More information on RST === … … 22 26 === TracLinks in reStructuredText === 23 27 24 * Trac provides a custom RST reference-directive 'trac'to allow TracLinks from within RST text.28 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. 25 29 26 30 Example: … … 34 38 }}} 35 39 36 For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks. 37 38 39 * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme. 40 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. 40 41 41 42 Example: … … 49 50 }}} 50 51 52 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks. 53 54 51 55 === Syntax highlighting in reStructuredText === 52 56 53 There is a directive for doing TracSyntaxColoring in R eST as well. The directive is called57 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called 54 58 code-block 55 59 … … 84 88 }}} 85 89 86 === Wiki Macros in reStructuredText ===90 === Wiki Macros in reStructuredText === 87 91 88 For doing WikiMacros in ReST you use the same directive as for syntax highlightning i.e 89 code-block. To work you must use a version of trac that has #801 applied. 92 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 90 93 91 === Wiki Macro Example ===94 === Wiki Macro Example === 92 95 93 96 {{{ … … 95 98 #!rst 96 99 97 .. code-block:: HelloWorld 98 99 Something I wanted to say 100 .. code-block:: RecentChanges 100 101 102 Trac,3 101 103 102 104 }}} 103 105 }}} 104 106 105 Will result in the below .107 Will result in the below: 106 108 107 [[HelloWorld(Something I wanted to say)]]109 [[RecentChanges(Trac,3)]] 108 110 111 Or a more concise Wiki Macro like syntax is also available: 109 112 110 === Bigger ReST Example === 113 {{{ 114 {{{ 115 #!rst 116 117 :code-block:`RecentChanges:Trac,3` 118 }}} 119 }}} 120 121 === Bigger RST Example === 111 122 The example below should be mostly self-explanatory: 112 123 {{{
