r-labs

h1. プラグイン Tips

チュートリアルの域を超えそうなものはこちらに？

h2. 活動ページにプラグインの履歴を表示する

Hudson プラグインを例にとり、プラグインの履歴を表示する方法を紹介します。

h3. サイドバーに表示される履歴の種類に、自分のプラグインを追加する

h4. 1. init.rb で活動ページに参加することを宣言する

以下のコードを Redmine::Plugin.register の中に追加します。

<pre><code class="ruby">

  activity_provider :[履歴の種類], :class_name => '[履歴を管理するクラス]', :default => false

</code></pre>

Hudson の場合は以下のようになります。

<pre><code class="ruby">

  activity_provider :hudson, :class_name => 'HudsonBuild', :default => false

</code></pre>

h4. 2. 権限に view_[履歴の種類] を追加する

活動の履歴では権限をチェックします。

現在ログインしているユーザが履歴を閲覧してよいかどうかは、 

*view_[履歴の種類]* 権限が許されているかどうかに依存します。

Hudsonの例で言うと、履歴の種類が hudson なので、 *view_hudson* 権限が必要です。

従って、init.rb に記載する権限の種類に view_hudson がないと、権限なし とみなされてサイドバーに履歴の種類が表示されません。

<pre><code class="ruby">

  project_module :hudson do

    # パーミッション設定。

    permission :view_hudson, {:hudson => [:index, :history]}  # ！！ここ大事！！

    permission :build_hudson, {:hudson => [:build]}, :require => :member

    permission :edit_hudson_settings, {:hudson_settings => [:edit, :joblist]}

  end

</code></pre>

h4. 3. 言語ファイルに label_[イベントの種類]_plural というエントリを追加する

サイドバーに表示する用語は、 label_[イベントの種類]_plural に統一されています。

Hudsonだと label_hudson_plural ですね。

言語ファイルに登録しておかないと label_hudson_plural が表示されるという、格好悪いことになります。