View Customize Plugin for Redmine

1. View Customize Plugin
for Redmine
コードでRedmineをカスタマイズ
2015.02.19 社内勉強会
onozaty

2. View Customize Plugin
Author: onozaty
onozaty/redmine-view-customize - GitHub

3. 作ったきっかけ

4. 個人が使っている
Redmine用のステキなUserScriptを
プロジェクト全員に適用できないか？
※UserScriptとは、画面ロード時に任意のJavaScriptを実行して
画面カスタマイズを行えるブラウザの機能
(FirefoxのGreasemonkeyとか)

5. いろいろ難しそう
• UserScriptをメンバ全員に確実にインス
トールする方法がない(個人任せになって
しまう)
• UserScriptをアップデートするたびに、各
メンバに反映してもらうのが大変
• UserScriptって何？IEはどうする？

6. じゃぁ、Redmine側を
カスタマイズすればよいのでは？

7. Redmineのカスタマイズ方法
• Redmineのコードを変更する
• Pluginを作る
手っ取り早いけど、メンテナンス性考えると後々面倒
(Redmineのバージョンアップ時に、どこに手を加えた
のかを追わなければならない)
といっても、ちょっとした変更毎にPlugin作ったり、
Plugin修正するのは面倒

8. UserScript のように
自由にスクリプトを
実行できる機能をRedmineに！

9. View Customize Plugin
• Redmineの画面をカスタマイズするための
Plugin
• 変更したい画面に対してJavaScript、CSS
を埋め込み、実行することにより、画面
を変更する

10. 設定方法
コードを実行するパス。
正規表現で記載。
実行するコード。
JavaScript または
StyleSheet(CSS)で書く。
Redmineの画面で使用
されているJQueryも使
える。(Redmineのバー
ジョンによってライブ
ラリが違うので注意)

11. 実行
パスが一致すると、コードが埋め込まれて、実行される

12. できること
• UserScriptで対応可能なことは、ほとんど
できるはず(UserScript特有の機能を使って
いない限り、移行も簡単)
• JavaScriptとCSSを埋め込めるので、画面
上で完結することは、コードさえかけれ
ば、なんでもできる

13. 例
• プロジェクト毎に背景色を変える
• http://onozaty.hatenablog.com/entry/2014/07/05/000000
• 自分の名前を強調して表示する
• http://onozaty.hatenablog.com/entry/2014/07/07/000000
• サイドバーを非表示にする
• http://onozaty.hatenablog.com/entry/2014/08/08/000000
• チケット画面で履歴をショートカットで
移動する
• http://onozaty.hatenablog.com/entry/2015/02/08/000000

14. ちょっとコードを書けば
Redmineを変えられる

15. ぜひあなたのコードで
プロジェクトのみんなをハッピーに
おわり