オンザフライでイメージを生成するのに、オンラインの Web サービスとして PlantUML を使うことができます。オンラインのデモンストレーションは http://www.plantuml.com/plantuml から試すことができます。また、手元の JEE Web アプリケーションサーバに PlantUML を インストール することもできます。 JEEアプリケーションサーバをインストールしたくない場合は、PlantUML PicoWeb Serverをローカルで実行することもできます。
@startxxx
キーワードで開始するように習慣づけると良いでしょう。
ダイアグラムを検証すると、そのダイアグラムをエンコードしたURLにリダイレクトされます。エンコード形式は複数行からなるダイアグラムよりも短くなるため、共有するのに適した形式です。また、ブラウザを使ってオンラインのPlantUMLサーバ上で簡単に表示することができます。
例えば、SyfFKj2rKt3CoKnELR1Io4ZDoSa70000
は次のダイアグラムをエンコードしたものです:
@startuml
Bob -> Alice : hello
@enduml
Bob -> Alice
のシーケンス図をサンプルとして表示します。しかし、ダイアグラムのエンコード形式を使用して他のダイアグラムを初期表示することもできます。
URLに/uml/ENCODED
を追加してください。
例えば、次のリンクhttp://www.plantuml.com/plantuml/uml/Aov9B2hXil98pSd9LoZFByf9iUOgBial0000では、シンプルなHello Worldのアクティビティ図を表示したPlantUMLサーバが開かれます。
metadata
として与えることで、ソースコードを取り出すことが可能になっています。
例えば、http://i.stack.imgur.com/HJvKF.png
の画像からダイアグラムのソースコードを取り出したい場合、次のサーバリクエストを使います: http://www.plantuml.com/plantuml/?metadata=http://i.stack.imgur.com/HJvKF.png
.
まるで魔法のようですが、これは非常に優れたエンジニアリングです :-)
すべてのダイアグラムがSVGとして出力できるわけではありません。例えば、ditaaはPNG形式のみ利用可能です。
<area>
タグのリストが出力されます。各行が図の定義中に含まれるリンクに対応しています。
例えば次の図:
@startuml
participant Bob [[http://plantuml.com]]
Bob -> Alice : [[http://forum.plantuml.net]] hello
@enduml
これにより、次の結果が得られます:
<map id="plantuml_map" name="plantuml_map">
<area shape="rect" id="id1" href="http://forum.plantuml.net" title="http://forum.plantuml.net" alt="" coords="38,50,199,65"/>
<area shape="rect" id="id2" href="http://plantuml.com" title="http://plantuml.com" alt="" coords="8,3,50,116"/>
</map>
完全なイメージマップを作るには、
<area...
タグを<map...
タグの中に含める必要があることに注意してください。
/plantuml/proxy?src=RESOURCE&idx=INDEX&fmt=FORMAT
@startxxx
と@endxxx
タグを含むダイアグラムの記述の書かれたドキュメントのURLです。.html
または.txt
ファイルのURLを指定します。png
、svg
、eps
、epstext
、txt
の値を指定できます。デフォルトはpng
です。