View Customize Plugin for Redmine コードでRedmineをカスタマイズ

2015.02.19 社内勉強会

onozaty

View Customize Plugin

Author: onozaty onozaty/redmine-view-customize - GitHub

作ったきっかけ

個人が使っている

Redmine用のステキなUserScriptを

プロジェクト全員に適用できないか？

※UserScriptとは、画面ロード時に任意のJavaScriptを実行して

画面カスタマイズを行えるブラウザの機能

(FirefoxのGreasemonkeyとか)

いろいろ難しそう

• UserScriptをメンバ全員に確実にインストールする方法がない(個人任せになってしまう)

• UserScriptをアップデートするたびに、各メンバに反映してもらうのが大変

• UserScriptって何？IEはどうする？

じゃぁ、Redmine側を

カスタマイズすればよいのでは？

Redmineのカスタマイズ方法

• Redmineのコードを変更する

• Pluginを作る

手っ取り早いけど、メンテナンス性考えると後々面倒

(Redmineのバージョンアップ時に、どこに手を加えたのかを追わなければならない)

といっても、ちょっとした変更毎にPlugin作ったり、Plugin修正するのは面倒

UserScript のように

自由にスクリプトを

実行できる機能をRedmineに！

View Customize Plugin

• Redmineの画面をカスタマイズするためのPlugin

• 変更したい画面に対してJavaScript、CSSを埋め込み、実行することにより、画面を変更する

設定方法

コードを実行するパス。

正規表現で記載。

実行するコード。

JavaScript または

StyleSheet(CSS)で書く。

Redmineの画面で使用されているJQueryも使える。(Redmineのバージョンによってライブラリが違うので注意)

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

できること

• UserScriptで対応可能なことは、ほとんどできるはず(UserScript特有の機能を使っていない限り、移行も簡単)

• JavaScriptとCSSを埋め込めるので、画面上で完結することは、コードさえかければ、なんでもできる

例

• プロジェクト毎に背景色を変える • 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

ちょっとコードを書けば

Redmineを変えられる

ぜひあなたのコードで

プロジェクトのみんなをハッピーに

おわり