PluginReStructuredTextFormatter » History » Version 1

William M., 2009-11-25 22:10

1 1 William M.
h1. PluginReStructuredTextFormatter
2 1 William M.
3 1 William M.
h2. Redmine reStructuredText Formatter
4 1 William M.
5 1 William M.
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 1 William M.
7 1 William M.
h3. Notes
8 1 William M.
9 1 William M.
h4. RbST/docutils version (master branch)
10 1 William M.
11 1 William M.
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 1 William M.
13 1 William M.
h4. PandocRuby version (pandoc-ruby branch)
14 1 William M.
15 1 William M.
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 1 William M.
17 1 William M.
h3. Installation
18 1 William M.
19 1 William M.
h4. RbST/docutils version
20 1 William M.
21 1 William M.
* Install Python and "docutils":http://docutils.sourceforge.net/
22 1 William M.
* gem install RbST
23 1 William M.
* script/plugin install git://github.com/autodata/redmine_restructuredtext_formatter.git
24 1 William M.
* Start Redmine
25 1 William M.
26 1 William M.
h4. PandocRuby version
27 1 William M.
28 1 William M.
* Install "Pandoc":http://johnmacfarlane.net/pandoc/
29 1 William M.
* gem install pandoc-ruby
30 1 William M.
* cd vendor/plugins
31 1 William M.
* git clone git://github.com/autodata/redmine_restructuredtext_formatter.git
32 1 William M.
* git checkout pandoc-ruby
33 1 William M.
* Start Redmine
34 1 William M.
35 1 William M.
h3. Notes
36 1 William M.
37 1 William M.
This plugin was derived directly from Larry Baltz's "redmine_markdown_formatter":http://github.com/bitherder/redmine_markdown_formatter.