PlantUMLをRedmineから使う

今回はRedmineにPlantUMLを埋め込むことができるプラグインPlantUML Redmine pluginを導入してみたいと思います。

インストール

PlantUML本体

まずはサーバ上でコマンドラインからPlantUMLが動作するよう設定します。詳しくは以下の記事に沿ってインストールを進めてください。コマンドのパスはあとで使うのでどこかにメモを。

PlantUMLをUbuntuにインストールする

https://blog.katsubemakito.net/articles/install_plantuml_for_ubuntu

テキストでUML関連の様々な図が書けるPlantUMLを今回はUbuntuに入れてみたいと思います。※画像は公式サイトより必要なソフトウェアのインストール今回インストールするのはAWSのLightsailに建てたTrustyになります。$ cat /etc/os-releaseNAME="Ubuntu"VERSION="14.04.5 LTS, Trusty Tahr"JDK/JREPlantUMLの動作にはJavaが必要になるため、JREまたはJDKをインストールします。Javaでの開発を行う場合はJDKを、すでにあるソフトウェアを動かすだけならJREを選択します。特にバージョンなどにこだわりが無ければdefa...

ねこの足跡R

PlantUML Redmine plugin

今回は次のプラグインを利用します。

dkd/plantuml

https://github.com/dkd/plantuml

PlantUML Plugin for Redmine. Contribute to dkd/plantuml development by creating an account on GitHub.

GitHub

まずはRedmineをインストールしたディレクトリ内にあるpluginsディレクトリまで移動します（パスは環境によって変わります）

$ cd ~/apps/redmine/htdocs/plugins

先ほどのGitHubのリポジトリをgit cloneし、ユーザーやグループを合わせてやります（ユーザーやグループは環境によって変わります）

$ git clone https://github.com/dkd/plantuml.git
$ sudo chown -R bitnami:daemon plantuml

最後にRedmineにプラグインをインストールする際にいつも打つコマンドを実行します。

$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Apacheを再起動すればCLI上での作業は完了です。

$ sudo apache2ctl restart

Redmineにログインし、「管理」→「プラグイン」とたどり、PlantUML plugin for Redmineの行が表示されているか確認を行ってください。

コマンドをインストールしたパスを入力し「保存」ボタンを押せば設定は完了です。

動かしてみる

チケットやWikiなどで、以下のような記述方法をすることで、PlantUMLの画像を埋め込むことができます。

{{plantuml(png)
  Bob -> Alice : Hello
  Bob <- Alice : Nice to meet you
}}

チケットの説明文に埋め込んだ例

コメントにももちろん使えます。

当然Wikiにも。どちらかというとWikiに仕様まとめたりする使い方が多いですよね。

実際にサーバ上でJavaを起動して画像を生成しているため、通常よりもレスポンスが遅くなります。またたくさんの方が利用する(生成する)とサーバもそれなりに重くなりますのでくれぐれもご注意を。

検索してみる

PlantUMLを埋め込むメリットとして、Redmineの検索に引っかかるようになるのは中々大きいですね。チケットとWikiの両方を対象に検索してみたところ、想定通りヒットしてくれました。

ドキュメントをWikiなどで書いている場合、単純な画像だと検索で引っ掛けることができませんが、PlantUMLで書いておけばこのような恩恵に預かれるというわけです。

かんたん UML入門 [改訂2版] (プログラミングの教科書)

posted with amazlet at 18.10.04

竹政 昭利 林田 幸司 大西 洋平 三村 次朗 藤本 陽啓 伊藤 宏幸
技術評論社
売り上げランキング: 53,567

Amazon.co.jpで詳細を見る

このブログを応援する

お寄せいただいたお気持ちは全額サーバ代や次の記事を執筆するための原資として活用させていただいております。この記事が参考になった場合などぜひご検討ください。

PayPalで300円支払う
※金額は任意で変更できます。
※100円でも泣いて喜びますw
※住所の入力欄が現れた場合は「no needed」を選択ください
これまでのご協力者さま

- Sponsored Link -