RedmineはRESTを使ってHTTP経由等で操作することが可能です。

プロジェクトで作成したスクリプトのコマンドをWikiに書いていたのですが、ふと
「REST使って"xxx.rb --help"の内容をWikiにアップできるのでは？」
と思い、トライしてみました。 
API-KeyはRedmineの個人設定から確認できます。

API-Key = XXXXXXXXXXXXX
URL = http://hostname/redmine/
TextFile = wiki.xml
ProjectName = foo
WikiPage = /page_test

curl -v -H "Content-Type: application/xml" -X PUT --data-binary "@wiki.xml" -H "X-Redmine-API-Key: XXXXXXXXXXXXX" http://hostname/redmine/projects/foo/wiki/page_test.xml
 
書き込むwiki.xmlは、例えば以下のようにします。
<?xml version="1.0"?>
<wiki_page>
<text>
&lt;pre&gt;
Usage: hoge_create [options]
    -h, --help                       show this message.
    -g, --gui                        run with GUI.
    -t, --test=TEST                  create test name(s).
    -s, --seed=N                     set random seed=N.
&lt;/pre&gt;
</text>
</wiki_page>

注意しなくてはならないのは、XMLとして書くので特殊記号はエスケープしておかなくてはいけないこと。
今回は<pre></pre>を使用していたので、&lt;と&gt;に置換しておきました。  

これで、page_testというWikiページが追加されました。
私は、このページをさらにincludeして使用しています。

h1. test_gen.rb使用方法

{{toc}}

h2. 概要

{{include(usage_test_gen.rb)}}

h2. 詳細

h3. -h, --help

show this message.


h2. 実行例

<pre>
>test_gen.rb -h

</pre>

h2. 特記事項

 
これで、少しwikiの更新が楽になりました。
一連の作業はスクリプトにしておいて、Jenkinsにやらせるようにしておけば常に最新の使用方法がWikiからも参照できるようになりました。