updated branch; this is ready for review for inclusion in IkIWiki

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

diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn
index 969d71cdb0ec0c36885b8b39903b16f39ac1a50e..5e97e2d8058391ec39cb7a493c3a4a6e1a219732 100644 (file)
--- a/doc/plugins/rst.mdwn
+++ b/doc/plugins/rst.mdwn
@@ -1,22 +1,17 @@
-[[template id=plugin name=rst included=1 author="Sergio Talens-Oliag"]]
-[[tag type/format]]
-[[tag type/slow]]
+[[!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)
 
 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
-  [[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.
+* There are issues with inserting raw html into documents, as ikiwiki 
+  does with [[WikiLinks|ikiwiki/WikiLink]] and many 
+  [[directives|ikiwiki/directive]].

 
 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