我々BeProudのRedmineのWikiやチケットの説明文やチケットのコメント文にはReStructuredTextを使っている。RedmineのデフォルトのTextileはPythonが好きな弊社で使うのは以ての外。なので、ReSTを使うようにした。そして、生のReSTしか使わなければ、出来ることが少ないので、blockdiagや、コードの構文ハイライト(Pygments) を使っている。

Redmine はテキストフォマッターを入れ換えるように作られている。プラグインを入れるとWiki やチケットの内容のフォーマットを変えることができます。BeProud では Redmine reStructuredText Formatter の RbST/docutils ブランチを使っている。

http://glacialis.postmodo.com/posts/zyd1ig

インストール

Note

ここには説明しないんですけど、Redmine を先にインストールする必要があります。

まずは、Redmine reStructuredText Formatter プラグインを入れる。その為、RbST ライブラリをインストールする必要がある。

RbST

RbST のdocutils バージョンはデータをフォーマットする時に、Python プロセスを実行して、そのプログラムの標準入力に ReST コンテンツを送信して、標準出力でHTMLコンテンツを受け取ると言う形になっている。

https://storage.googleapis.com/static.ianlewis.org/prod/img/673/redmine-rest.png
$ gem install RbST

RbSTも日本語をレンダーする場合のバグがありますので、修正する必要があります。 (興味ある人は僕の github を見ててください)

$ cd /path/to/ruby/gems/RbST-0.1.3/lib/rst2parts $ vim rst2html.py

最後のほうに、データを print する行があって、それを修正します。

if __name__ == '__main__':
    try:
        output = main()
        if output:
            # ここを修正して、 print ではなくて、sys.stdout.write()にする
            sys.stdout.write(output)
    except Exception, e:
        sys.stdout.write('<strong style="color:red">Error Parsing ReSt: %r</strong>' % e)

そして、redmine のインストールディレクトリに移動して、プラグインをインストール (Python と docutils もインストールしておいてください。

$ cd path/to/redmine
$ script/plugin install git://github.com/alphabetum/redmine_restructuredtext_formatter.git

そうしたら、Redmine を起動・再起動します。

そうすると、Redmineの「管理」=>「設定」に行くと、フォーマッターとして、ReST を選択できます。該当の設定は「ッテキスト書式」と書いています。ReSTをレンダーする度に、外部 Python プロセスをたたくので、次のチェックボックスで、レンダーを出力をキャシューするように設定しておいてください。

https://storage.googleapis.com/static.ianlewis.org/prod/img/673/settings.png

設定画面でせっていし後にWikiやチケットにreSTを書けばちゃんと表示されます。

reSTでWiki 書きましょう

https://storage.googleapis.com/static.ianlewis.org/prod/img/673/rest-input.png

ちゃんと表示されます。

https://storage.googleapis.com/static.ianlewis.org/prod/img/673/html-rest.png

Textile 書かなくてもよくて、気持ちいいですね!

Wikiリンク

デフォルトでリンクを書く時に、そのまま表示するURL書かないといけないのでWikiで簡単にリンク書けるようにしょう。

RbSTのインストール先の gems ディレクトリに行って、rst2html.py を修正しよう

$ cd /path/to/ruby/gems/RbST-0.1.3/lib/rst2parts
$ vim rst2html.py

そして、下記のコードを加えましょう。 ( moinmoin からコピーした

from docutils.writers.html4css1 import Writer

class WikiWriter(Writer):
    def __init__(self, *args, **kwargs):
        Writer.__init__(self, *args, **kwargs)
        self.unknown_reference_resolvers = [self.wiki_resolver]
        self.nodes = []
    def wiki_resolver(self, node):
        """
            Normally an unknown reference would be an error in an reST document.
            However, this is how new documents are created in the wiki. This
            passes on unknown references to eventually be handled by
            MoinMoin.
        """
        if hasattr(node, 'indirect_reference_name'):
            node['refuri'] = node.indirect_reference_name
        elif (len(node['ids']) != 0):
            # If the node has an id then it's probably an internal link. Let
            # docutils generate an error.
            return False
        elif node.hasattr('name'):
            node['refuri'] = node['name']
        else:
            node['refuri'] = node['refname']
        del node['refname']
        if hasattr(self, 'nodes'):
            node.resolved = 1
            self.nodes.append(node)
            return True
        else:
            return False
    wiki_resolver.priority = 1

レンダーする時に、WikiWriterを利用するように、main() 関数も修正しよう。

def main():
    #ここは修正して、writerの引数を追加
    return transform(writer=WikiWriter(), part='html_body')

それで、Wiki でこういうように他のWiki ページへのリンクを作ることができる。

* これは「リンク」というページの `リンク`_ です。
* リンクのテキストが異なる場合は、`こう書く <リンク>`_

それ以外のリンクの使い方は はやわかり reStructuredText を参考にしてください。

Note

外部 Python プログラムを叩いてるだけなのでredmineのパスなどがレンダーする時にわかる用がないので相対パスを吐き出すようにしているだけ。従って、プレビューする時などパスが違うのでレンダーするリンクがおかしくなる。それだけは我慢してください (´・ω・`)

System Message: WARNING/2 (<string>, line 138); backlink

Inline interpreted text or phrase reference start-string without end-string.

コードブロック

標準のreSTじゃつまらないので、コードハイライトできるようにしょう。まずはライブラリをインストールするので、virtualenv を作ろう

$ cd /path/to/ruby/gems/RbST-0.1.3/lib/rst2parts
$ virtualenv venv

次はpygmentsをvirtualenvにインストールする

$ pip install pygments -E venv

そして、rst2html.py で virtualenv を使うようにしよう。rst2html.py の上にこのコードを加えましょう

import site

site.addsitedir(os.path.join(os.path.dirname(__file__), 'venv', 'lib', 'python2.7', 'site-packages'))

Note

Python のバージョンによってパスが異なるので、ご注意を

rst2html.pyを修正して、 code-blockディレクティブを追加する。

from docutils import nodes
from docutils.parsers.rst import directives
from pygments import highlight
from pygments.formatters import HtmlFormatter
from pygments.lexers import get_lexer_by_name, TextLexer

############### code-block, sourcecode ##############

VARIANTS = {}

def pygments_directive(name, arguments, options, content, lineno,
                       content_offset, block_text, state, state_machine):
    try:
        lexer = get_lexer_by_name(arguments[0])
    except (ValueError, IndexError):
        # no lexer found - use the text one instead of an exception
        lexer = TextLexer()
    parsed = highlight(u"\n".join(content), lexer, HtmlFormatter(noclasses=True))
    return [nodes.raw("", parsed, format="html")]
pygments_directive.arguments = (0, 1, False)
pygments_directive.content = 1
pygments_directive.options = dict([(key, directives.flag) for key in VARIANTS])
directives.register_directive("sourcecode", pygments_directive)
directives.register_directive("code-block", pygments_directive)

そうすると、Wiki で code-block ディレクティブを使うと

.. code-block:: python

    class PythonRocks(object):
        """Python Rocks! を出力"""
        def rock(self):
            print "Python Rocks!"

ハイライトされたコードが書けます

https://storage.googleapis.com/static.ianlewis.org/prod/img/673/highlight.png

まとめ

とにかく、Redmineは大変だから、だけか、Python版を作ってほしい!

それができるまでは、rst2html.py は普通のpythonプログラムなので、Pythonで対応出来る限り、何でもできます。実は僕達は blockdiag もRedmineのWiki で書けます。 seqdiag もあって、可能性がいろいろあります。 いろいろ試してみてください!