Project

General

Profile

PluginReStructuredTextFormatter » History » Version 1

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

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
* script/plugin install git://github.com/autodata/redmine_restructuredtext_formatter.git
24
* Start Redmine
25
26
h4. PandocRuby version
27
28
* Install "Pandoc":http://johnmacfarlane.net/pandoc/
29
* gem install pandoc-ruby
30
* cd vendor/plugins
31
* git clone git://github.com/autodata/redmine_restructuredtext_formatter.git
32
* git checkout pandoc-ruby
33
* Start Redmine
34
35
h3. Notes
36
37
This plugin was derived directly from Larry Baltz's "redmine_markdown_formatter":http://github.com/bitherder/redmine_markdown_formatter.