2.1. PlantUMLとは#
PlantUML はオープンソースのダイアグラム作成ソフトウェアです。 Javaで開発され、一つのjarファイルに全ての機能がまとめられています。 その名が示す様に UML(Unified Modeling Language) に基づくクラス図などの図をテキストベースで作成するために開発されました。 しかし現在では Gannt図、WBS(Work Breakdown Strucuture)図など その他の図も作成できるように成長しています。 また、色々な文書作成システムでPlantUMLによる図をサポートするためのプラグインが開発され、 利用されています。
2.1.1. PlantUMLの理解のためのヒント#
PlantUMLは多種にわたる図版のタイプをサポートしていますので、 全てのドキュメントに眼を通すことは困難です。
webに様々なドキュメント(日本語翻訳も多数）が用意されていますが、 ソフトウェアの開発に間に合っていないところもあるようです。また、 このサイトの検索機能が提供されていないことと、webの構成の更新が 間に合っていないと思われることがあって、必要な情報に辿り着くには時間が掛かる感じです。
必要とされる図版タイプを絞ってドキュメントを読むのが良さそうです。
この時、全ての図版タイプに共通な
と 図版にコメントなどを追加するときに使う、
にざっと目を通しておいてから、
一目でわかるPlantUML を出発点に必要な場所を読むのが良さそうです。 それぞれの図版の詳細については、PlantUML ウェブサイトの Language specification を探して見ましょう。このページは情報の検索の良い入り口かもしれません。FAQ/フォーラムで検索してみるのも良いでしょう。
前処理(プリプロセス） はC言語のcppに対応するようなマクロ機能を説明しています。 この機能も全ての図形タイプに共通なので、余裕があれば目を通しておきましょう。
ダイアグラムの書き方と書く場所 はある程度PlantUMLに慣れたら読んでおく方がいいでしょう。
この小文の 2.10 章 PlantUML Hints: PlantUML使用時の小技 に執筆途上で入手したPlantUML利用のヒントを入れてあります。
PlantUMLのWebページは検索機能がない（？）こともあり、初心者が最初に知りたい情報を簡単に見つけることが難しいように感じます[1]。 このコメントがみなさんのお役にたてば何よりです。