web commit by http://svend.myopenid.com/: Added note about backslash.

[git.ikiwiki.info.git] / doc / plugins / rst.mdwn

diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn
index f7cbf57bb9b9910133b4f5d59c06f49b5b119126..1f8073517ad78b732125ca3eef67db895557d5be 100644 (file)
--- a/doc/plugins/rst.mdwn
+++ b/doc/plugins/rst.mdwn
@@ -1,21 +1,17 @@
-[[template id=plugin name=rst included=1 author="""Sergio Talens-Oliag"""]]
+[[template id=plugin name=rst author="martin f. krafft"]]

 [[tag type/format]]
 
 This plugin lets ikwiki convert files with names ending in ".rst" to html.
 It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html)
 [[tag type/format]]
 
 This plugin lets ikwiki convert files with names ending in ".rst" to html.
 It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html)

-markup syntax. You need to have the python-docutils module installed to use
-it.
+markup syntax. You need to have [[cpan RPC::XML]], python and the
+python-docutils module installed to use it.

 
 Note that this plugin does not interoperate very well with the rest of
 ikiwiki. Limitations include:
 
 
 Note that this plugin does not interoperate very well with the rest of
 ikiwiki. Limitations include:
 

-* reStructuredText does not allow raw html to be inserted into
-  documents, but ikiwiki does so in many cases, including
-  [[WikiLinks|WikiLink]] and many
+* There are issues with inserting raw html into documents, as ikiwiki 
+  does with [[WikiLinks|WikiLink]] and many 

   [[PreprocessorDirectives|PreprocessorDirective]].
   [[PreprocessorDirectives|PreprocessorDirective]].

-* It's slow; it forks a copy of python for each page. While there is a
-  perl version of the reStructuredText processor, it is not being kept in
-  sync with the standard version, so is not used.

 
 So while you may find this useful for importing old files into your wiki,
 using this as your main markup language in ikiwiki isn't recommended at
 
 So while you may find this useful for importing old files into your wiki,
 using this as your main markup language in ikiwiki isn't recommended at