X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/63edea27bc71c3bdf1837f994fb7effdd93fb2dd..92a43d5d384ba4e504c5255989a869ced424219c:/doc/plugins/rst.mdwn diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn index 0f0d6f96c..9355597ac 100644 --- a/doc/plugins/rst.mdwn +++ b/doc/plugins/rst.mdwn @@ -1,24 +1,18 @@ +[[!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 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 + 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 this time. - -This plugin is included in ikiwiki, but not enabled by default. -It was contributed by Sergio Talens-Oliag. - -[[tag type/format]]