doc/plugins/rst.mdwn

   1 [[template id=plugin name=rst included=1 author="Sergio Talens-Oliag"]]
   2 [[tag type/format]]
   3 [[tag type/slow]]
   4
   5 This plugin lets ikwiki convert files with names ending in ".rst" to html.
   6 It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html)
   7 markup syntax. You need to have the python-docutils module installed to use
   8 it.
   9
  10 Note that this plugin does not interoperate very well with the rest of
  11 ikiwiki. Limitations include:
  12
  13 * reStructuredText does not allow raw html to be inserted into
  14   documents, but ikiwiki does so in many cases, including
  15   [[WikiLinks|WikiLink]] and many
  16   [[PreprocessorDirectives|PreprocessorDirective]].
  17 * It's slow; it forks a copy of python for each page. While there is a
  18   perl version of the reStructuredText processor, it is not being kept in
  19   sync with the standard version, so is not used.
  20
  21 So while you may find this useful for importing old files into your wiki,
  22 using this as your main markup language in ikiwiki isn't recommended at
  23 this time.