1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
= reStructuredText Support in Trac =
Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used.
From the reStucturedText webpage:
"''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. ''"
=== Requirements ===
Note that to activate RST support in Trac, the python docutils package must be installed.
If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
=== More information on RST ===
* reStructuredText Website -- http://docutils.sourceforge.net/rst.html
* RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html
----
== Using RST in Trac ==
To specify that a block of text should be parsed using RST, use the ''rst'' processor.
=== TracLinks in reStructuredText ===
* Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text.
Example:
{{{
{{{
#!rst
This is a reference to |a ticket|
.. |a ticket| trac:: #42
}}}
}}}
For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks.
* Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme.
Example:
{{{
{{{
#!rst
This is a reference to ticket `#12`:trac:
To learn how to use Trac, see `TracGuide`:trac:
}}}
}}}
=== Syntax highlighting in reStructuredText ===
There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called
code-block
Example
{{{
{{{
#!rst
.. code-block:: python
class Test:
def TestFunction(self):
pass
}}}
}}}
Will result in the below.
{{{
#!rst
.. code-block:: python
class Test:
def TestFunction(self):
pass
}}}
=== WikiMacros in reStructuredText ===
For doing WikiMacros in ReST you use the same directive as for syntax highlightning i.e
code-block. To work you must use a version of trac that has #801 applied.
=== WikiMacro Example ===
{{{
{{{
#!rst
.. code-block:: HelloWorld
Something I wanted to say
}}}
}}}
Will result in the below.
[[HelloWorld(Something I wanted to say)]]
=== Bigger ReST Example ===
The example below should be mostly self-explanatory:
{{{
#!html
<pre class="wiki">{{{
#!rst
FooBar Header
=============
reStructuredText is **nice**. It has its own webpage_.
A table:
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
RST TracLinks
-------------
See also ticket `#42`:trac:.
.. _webpage: http://docutils.sourceforge.net/rst.html
}}}</pre>
}}}
Results in:
{{{
#!rst
FooBar Header
=============
reStructuredText is **nice**. It has its own webpage_.
A table:
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
RST TracLinks
-------------
See also ticket `#42`:trac:.
.. _webpage: http://docutils.sourceforge.net/rst.html
}}}
----
See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting
|
