Changes between Version 6 and Version 7 of WikiRestructuredText

Timestamp:

01/17/08 22:31:17 (18 years ago)

Author:

trac (IP: 127.0.0.1)

Comment:

--

WikiRestructuredText

@@ -4 +4 @@
 
 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. ''"
+ "''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 ===
@@ -25 +25 @@
 
  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 
-  <p style=display:none>
-<a href="http://www.order-now.biz/">ultra herbal</a><br>
-<a href="http://provillus.order-now.biz/">Provillus</a><br> Hair Loss Treatment for Men and Woman<br>
-<a href="http://breastactives.order-now.biz/">Breast Actives</a><br>
-<a href="http://eazol.order-now.biz/">Eazol</a><br>
-<a href="http://freedietpills.order-now.biz/">free diet pills</a><br>
+#!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
 }}}