GraphViz
GraphVizはdotというプログラムが含まれているソフトウェアです。dotは、テキストベースの表現から有効グラフを生成できるプログラムです。 PlantUMLは以下の図を生成するためにGraphVizの動作するバージョンが必要です: これら以外の図の生成は、GraphVizを使用しないため不要です。WARNING
This translation need to be updated. WARNING
Linux環境でのインストール
LinuxでGraphVizをインストールするにはいくつかの方法があります:
- Fedora packages:
sudo yum install graphviz - Ubuntu packages:
sudo apt install graphviz - Debian packages:
sudo apt install graphviz
- まず、
/usr/local/bin/dot - 次に、
/usr/bin/dot
Mac環境でのインストール
Macではbrewをインストールすることで簡単にGraphVizをインストールすることができます。これにより、GraphVizを.dmgパッケージでインストールする際に発生する問題を回避することができます。
brew install libtool
brew link libtool
brew install graphviz
brew link --overwrite graphviz
デフォルトでは、dot実行ファイルは次の場所に存在することが期待されます:
- まず、
/usr/local/bin/dot - 次に、
/usr/bin/dot
GRAPHVIZ_DOTを設定しGraphViz実行ファイルの場所を指定することもできます。
テスト
PlantUMLがdotを検索する場所についての情報を得るために、次のコマンドを使用できます:
java -jar plantuml.jar -testdot
次の特別なダイアグラムを使用することもできます:
|
🎉 Copied!
|
|
コマンドシェルで
dotコマンドを実行してみてください。インストールを完了するためにdot -Cを実行する必要があるかもしれません。
環境変数のGRAPHVIZ_DOTを設定しGraphViz実行ファイルの場所を指定することもできます。
新しいJavaベースのダイアグラム生成エンジン「Smetana」
以下に解説するように、バージョン1.2021.5以降にはGraphvizをインストールしないでPlantUMLを使用可能にする実験的な機能があります。これを利用するには、サポートされた種類の図で!pragma layout smetanaを記述します。その場合、Graphvizの代わりに"Smetana"エンジンが使用されます。Smetanaエンジンを利用する場合、これ以降のセクションはスキップしても構いません。
Windows環境でのインストール
バージョン1.2020.21以降
新しいバージョン(1.2020.21以降)を利用する場合、GraphVizを手動でインストールする必要はありません 最小限のgraphviz dot.exeがPlantUMLに内蔵されていて、必要に応じて(インストール済みのGraphVizが存在しない場合)一時フォルダに自動的に展開されます。 これは、Windowsでは非常に望ましいオプションです。 警告: 1.2020.25以前のバージョンでは、グラフの生成中にエラーメッセージが表示されることがあるので、1.2020.25より新しいバージョンを使用してください。古いバージョンのPlantUML
古いバージョンでは、自分でGraphVizをインストールする必要があります。次のいずれかを準備してください:- Win32版GraphViz 2.44 (最も簡単)
- minimalistic graphviz dot.exeを
c:\ドライブに展開する(以下参照) - x64版GraphViz 2.44 (難しい)
dot -cを実行する必要があるかもしれません:
PlantUMLはdot.exeを得るためにc:\ドライブをスキャンし、c:\*\graphviz*\bin\dot.exeまたはc:\*\graphviz*\release\bin\dot.exeを探します。検索は再帰的に行われないため、ルートレベルのフォルダを使用する必要があります。
別の方法として、環境変数のGRAPHVIZ_DOTを設定しGraphViz実行ファイルの場所を指定することもできます。
バージョンに関する重要なお知らせ
GraphVizの以下のバージョンでテストを行い、動作することを確認しています:
- 2.26.3
- 2.28
- 2.30.1
- 2.34
- 2.36
- 2.38
- 2.44