]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/rst.mdwn
po plugin: switch to page.LL.html naming convention
[git.ikiwiki.info.git] / doc / plugins / rst.mdwn
index 7d542646cacbcf1168e0a2d668283361141a829d..9355597ac6e9cdcc35988bde5130faf1020ebd23 100644 (file)
@@ -1,15 +1,17 @@
-[[template id=plugin name=rst 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)
-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 is rather 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.
+Note that this plugin does not interoperate very well with the rest of
+ikiwiki. Limitations include:
+
+* There are issues with inserting raw html into documents, as ikiwiki 
+  does with [[WikiLinks|ikiwiki/WikiLink]] and many 
+  preprocessor [[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