close
Warning:
Can't synchronize with repository "(default)" (/usr/svn/silverfile does not appear to be a Subversion repository.). Look in the Trac log for more information.
- Timestamp:
-
Feb 27, 2009, 6:57:00 PM (14 years ago)
- Author:
-
trac
- Comment:
-
--
Legend:
- Unmodified
- Added
- Removed
- Modified
-
v1
|
v2
|
|
9 | 9 | Note that to activate RST support in Trac, the python docutils package must be installed. |
10 | 10 | If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website]. |
| 11 | |
| 12 | 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 | 13 | |
12 | 14 | === More information on RST === |
… |
… |
|
22 | 24 | === TracLinks in reStructuredText === |
23 | 25 | |
24 | | * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text. |
| 26 | * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. |
25 | 27 | |
26 | 28 | Example: |
… |
… |
|
34 | 36 | }}} |
35 | 37 | |
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. |
| 38 | * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. |
40 | 39 | |
41 | 40 | Example: |
… |
… |
|
49 | 48 | }}} |
50 | 49 | |
| 50 | For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks. |
| 51 | |
| 52 | |
51 | 53 | === Syntax highlighting in reStructuredText === |
52 | 54 | |
53 | | There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called |
| 55 | There is a directive for doing TracSyntaxColoring in RST as well. The directive is called |
54 | 56 | code-block |
55 | 57 | |
… |
… |
|
84 | 86 | }}} |
85 | 87 | |
86 | | === WikiMacros in reStructuredText === |
| 88 | === Wiki Macros in reStructuredText === |
87 | 89 | |
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. |
| 90 | For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e |
| 91 | code-block. To work you must use a version of trac that has [trac:ticket:801 #801] applied. |
90 | 92 | |
91 | | === WikiMacro Example === |
| 93 | === Wiki Macro Example === |
92 | 94 | |
93 | 95 | {{{ |
… |
… |
|
95 | 97 | #!rst |
96 | 98 | |
97 | | .. code-block:: HelloWorld |
98 | | |
99 | | Something I wanted to say |
| 99 | .. code-block:: RecentChanges |
100 | 100 | |
| 101 | Trac,3 |
101 | 102 | |
102 | 103 | }}} |
103 | 104 | }}} |
104 | 105 | |
105 | | Will result in the below. |
| 106 | Will result in the below: |
106 | 107 | |
107 | | [[HelloWorld(Something I wanted to say)]] |
| 108 | [[RecentChanges(Trac,3)]] |
108 | 109 | |
| 110 | Or a more concise Wiki Macro like syntax is also available: |
109 | 111 | |
110 | | === Bigger ReST Example === |
| 112 | {{{ |
| 113 | {{{ |
| 114 | #!rst |
| 115 | |
| 116 | :code-block:`RecentChanges:Trac,3` |
| 117 | }}} |
| 118 | }}} |
| 119 | |
| 120 | === Bigger RST Example === |
111 | 121 | The example below should be mostly self-explanatory: |
112 | 122 | {{{ |