diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins/rst.mdwn | 10 | ||||
| -rw-r--r-- | doc/plugins/write/external.mdwn | 6 | ||||
| -rw-r--r-- | doc/todo/rst_plugin_python_rewrite.mdwn | 2 |
3 files changed, 10 insertions, 8 deletions
diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn index 7250e46a1..1f8073517 100644 --- a/doc/plugins/rst.mdwn +++ b/doc/plugins/rst.mdwn @@ -1,11 +1,10 @@ -[[template id=plugin name=rst author="Sergio Talens-Oliag"]] +[[template id=plugin name=rst author="martin f. krafft"]] [[tag type/format]] -[[tag type/slow]] 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: @@ -13,9 +12,6 @@ ikiwiki. Limitations include: * There are issues with inserting raw html into documents, as ikiwiki does with [[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. 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 diff --git a/doc/plugins/write/external.mdwn b/doc/plugins/write/external.mdwn index e699e43e1..0abc9b0a0 100644 --- a/doc/plugins/write/external.mdwn +++ b/doc/plugins/write/external.mdwn @@ -8,6 +8,10 @@ written in perl, but is intended to be an example of how to write an external plugin in your favorite programming language. Wow us at how much easier you can do the same thing in your favorite language. ;-) +There's now a second external plugin, the [[rst]] plugin, written in +python. (Could someone convert it into a python library that can be used by +other plugins?) + [[toc ]] ## How external plugins use XML RPC @@ -87,7 +91,7 @@ to 1. Since XML RPC can't pass around references to objects, it can't be used with functions that take or return such references. That means you can't -use XML RPC for `cgi` or `formbuilder` hooks (which are passed CGI and +100% use XML RPC for `cgi` or `formbuilder` hooks (which are passed CGI and FormBuilder perl objects), or use it to call `template()` (which returns a perl HTML::Template object). diff --git a/doc/todo/rst_plugin_python_rewrite.mdwn b/doc/todo/rst_plugin_python_rewrite.mdwn index 7626f03a3..222fdb177 100644 --- a/doc/todo/rst_plugin_python_rewrite.mdwn +++ b/doc/todo/rst_plugin_python_rewrite.mdwn @@ -3,3 +3,5 @@ rendered. Now that ikiwiki supports plugins written in [[other_languages|plugins/write/external]], it would be excellent if someone could rewrite the rst plugin as a pure python external plugin. It would then run nice and quick. + +[[done]], thanks to madduck! |