PluginReStructuredTextFormatter » History » Version 2
William M., 2009-11-25 23:20
| 1 | 1 | William M. | h1. PluginReStructuredTextFormatter |
|---|---|---|---|
| 2 | |||
| 3 | h2. Redmine reStructuredText Formatter |
||
| 4 | |||
| 5 | This is a redmine plugin for supporting reStructuredText as a wiki format using either the "RbST reStructuredText gem":http://rdoc.info/projects/autodata/rbst, which can convert all RST but is slow, or "PandocRuby":http://rdoc.info/projects/autodata/pandoc-ruby, which only supports a subset of RST but is fast. |
||
| 6 | |||
| 7 | h3. Notes |
||
| 8 | |||
| 9 | h4. RbST/docutils version (master branch) |
||
| 10 | |||
| 11 | This is potentially quite slow. RbST processes reStructuredText via Python's docutils, and docutils is slow. As far as I can tell, Redmine always formats text using a helper on each request, which means this plugin will likely add a few tenths of a second to each request, possibly more. On my machine, normal views take 450-550ms to render with the default textile option and 650-750 with this plugin. Heavily marked-up pages like the "RST cheat sheet":http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt bumps it up to 1.2s. I wouldn't recommend this for public-facing pages, but it's probably OK for private Redmine instances. |
||
| 12 | |||
| 13 | h4. PandocRuby version (pandoc-ruby branch) |
||
| 14 | |||
| 15 | Pandoc is much faster than docutils and should be roughly as fast as the native textile, but it only supports a subset of RST, so some features like tables are not available. This version is available on the `pandoc-ruby` branch. |
||
| 16 | |||
| 17 | h3. Installation |
||
| 18 | |||
| 19 | h4. RbST/docutils version |
||
| 20 | |||
| 21 | * Install Python and "docutils":http://docutils.sourceforge.net/ |
||
| 22 | * gem install RbST |
||
| 23 | 2 | William M. | * cd /path/to/redmine |
| 24 | * script/plugin install git://github.com/autodata/redmine\_restructuredtext\_formatter.git |
||
| 25 | 1 | William M. | * Start Redmine |
| 26 | |||
| 27 | h4. PandocRuby version |
||
| 28 | |||
| 29 | * Install "Pandoc":http://johnmacfarlane.net/pandoc/ |
||
| 30 | * gem install pandoc-ruby |
||
| 31 | 2 | William M. | * cd /path/to/redmine/vendor/plugins |
| 32 | * git clone git://github.com/autodata/redmine\_restructuredtext\_formatter.git |
||
| 33 | * cd redmine\_restructuredtext\_formatter |
||
| 34 | 1 | William M. | * git checkout pandoc-ruby |
| 35 | * Start Redmine |
||
| 36 | |||
| 37 | h3. Notes |
||
| 38 | |||
| 39 | This plugin was derived directly from Larry Baltz's "redmine_markdown_formatter":http://github.com/bitherder/redmine_markdown_formatter. |