X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins%2Frst.mdwn;h=5e97e2d8058391ec39cb7a493c3a4a6e1a219732;hb=cf707d16541c0f65519231c1ccc9a6c3a7ed8d62;hp=f7cbf57bb9b9910133b4f5d59c06f49b5b119126;hpb=9d7375c3b263e77da29a5db22af480db8b99d990;p=ikiwiki.git diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn index f7cbf57bb..5e97e2d80 100644 --- 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"""]] -[[tag type/format]] +[[!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 + [[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