はじめに
Redmine のチケットや Wiki にちょっとした図を埋め込みたいときって、皆さんどのようにされていますでしょうか?いちいち描画ツールを起動して、図を描いてファイル保存してアップロードするのも面倒ですよね。最新の Redmine 4.1 でしたらクリップボードから直接貼り付けることができますし、それ以前のバージョンでも Redmine clipboard_image_paste plugin を使えば同じことができますが、それでも描画ツールを起動する手間はかかります。
ところで皆さん、描画ツールは何を使っていますか?僕は draw.io (今は diagrams.net に変わろうとしているそうです1 )を好んで使っています。ブラウザ上でいろんな図を描くことができる優れものです。でも、このツールを使って描いた図を Redmine に貼り付けるときには、ファイルかクリップボードを経由しなきゃいけないので、いつも面倒に感じていました。(面倒なので図を添えないこともよくあります。)
そこで、何かいい方法はないものかと探してみたところ、すごいものを見つけました。それが Redmine draw.io plugin です。調べてみたところ、どうやら日本語の紹介記事がなさそうでしたので、クソザコメンタルな僕がなけなしの勇気を振り絞って先陣を切って紹介してみます。
Redmine draw.io plugin
どんなプラグイン?
Redmine のチケットや Wiki に draw.io の図を直接埋め込めるプラグインです。しかも、ただ埋め込むだけじゃなく、添付ファイルや Redmine DMSF Plugin のファイルとして管理することができます。埋め込んだ図はダブルクリックすると draw.io のエディタが起動して直接編集することができます。
どんな感じで動くの?
実際に動かした結果を、チケットを例にしてキャプチャ付きで説明します。
環境は、 以前の記事 で紹介した「 Docker Compose で作る Redmine 」に Redmine draw.io plugin を追加して構築しました。(あわせて GitHub で公開している Dockerfile を更新しました。)
マクロの埋め込み
Redmine draw.io plugin をインストールすると、テキスト入力エリア上部のツールバーにアイコンが追加されます。
- Attach a Drawio diagram
- Use Drawio diagram stored in DMSF module
前者がチケットの添付ファイル、後者が Redmine DMSF Plugin の文書管理のファイルとして保存されます。
今回は、文書管理のファイルで試してみます。 README によると、 Redmine DMSF Plugin の設定で WebDAV を有効にしてアクセス制御を読み書き可能にする必要があるそうです。(なぜか読み取り専用でも保存できましたが…どうも怪しいので読み書き可能にした方が無難かと思います)
アイコンをクリックするとダイアログが表示されるので、画像の名前、形式、幅を入力します。
「Insert macro」ボタンを押すとマクロが埋め込まれます。
この状態でチケットを作成すると「 Double click to start drawing 」と書かれたボタン画像が埋め込まれます。
図の編集
ボタン画像をダブルクリックすると draw.io のエディタが起動します。
あとは、ボタン画像を消して、好きな図を描くだけです。
図が描けたら右上の「 Save 」ボタンを押します。 このときユーザー/パスワードの入力が必要ですので、うっかりキャンセルしないように気を付けてください。せっかく描いた図が保存されず消えてしまいます。( 1 敗)
「文書管理」タブを開くと、マクロ埋め込み時に指定した名前で画像が保存されていることを確認できます。
おわりに
文章だけよりも図が添えてある方が伝わりやすいケースは多いと思います。Redmine draw.io plugin を使うと、Redmine に図を埋め込むのが簡単になります。(まるで僕のように)これまでは図を埋め込むのが面倒で文章だけで済ませていた方々が、このプラグインを使ってどんどん図を描くようになって、今まで以上にコミュニケーションが円滑で活発になればとても喜ばしいことだと考えています。
あと、 Redmine ってまだまだ知らないことが多くて、触っていてとても面白いです。これからも色々と試していきたいなと思います。