構文の一般化

Ditaa
DOT

もともと PlantUML では、図の記述の前に @startuml を、後に @enduml と書く必要がありました。PlantUML は新たに UML 以外の図を生成できるようになったため、その場合にも @startuml という名前を使用するのは無意味です。

そのため、一般的な慣習として、図の記述の前に @startXYZ を、後ろに @endXYZ と記述することになりました。ここで、XYZ は図の種類を表す文字列に置き換えます。

メモ: XYZ には空白を含む任意の文字列が使用できます。

そのため、プラグインの開発者は、@startuml の代わりに @start を認識できるようにすることが推奨されます。

Ditaa

Ditaa は、テキストで書かれた図の記述を一般的な図に変換するオープンソースのプロジェクトです。アイデアとしては PlantUML に近いもので、ドキュメントのために UML 以外の図を生成したい場合には役に立つことがあります。

そのため、最新バージョンの PlantUML では、以下のようにして Ditaa の図を埋め込むことができます。

@startuml
ditaa
+--------+   +-------+    +-------+
|        +---+ ditaa +--> |       |
|  Text  |   +-------+    |diagram|
|Document|   |!magic!|    |       |
|     {d}|   |       |    |       |
+---+----+   +-------+    +-------+
    :                         ^
    |       Lots of work      |
    +-------------------------+
@enduml

Ditaa の完全なドキュメントは、こちらで参照できます。

もし、あなたの使っているプラグインが @startditaa をサポートしていなくても、暫定の機能がすでに用意してあります。: @startuml のすぐ次の行に、 ditaa と書くことで、Ditaaを使うことができます。

@startditaa または @ditaa キーワードの後ろには、いくつかのオプションが指定できます。

-E または --no-separation - 境界線を消す
-S または --no-shadows - シャドウを消す
scale=XYZ - 図を指定した倍率で拡大または縮小する

@startuml
ditaa(--no-shadows, scale=0.8)
/--------\   +-------+
|cAAA    +---+Version|
|  Data  |   |   V3  |
|  Base  |   |cRED{d}|
|     {s}|   +-------+
\---+----/
@enduml

PNG の生成のみ対応しています。

DOT

PlantUML は内部で Graphviz/DOT を使用しているため、直接 DOT 言語を使用することも可能です。つまり、PlantUML をサポートするどんなツールでも Graphviz/DOT が使用できるということです。

一番最初の行は次の形式でなければならないことに注意してください。

digraph XYZ {

また、@startdot/@enddot の代わりに @startuml/@enduml を使用することもできます。以下は、正しく変換できるコードの一例です。

@startuml
digraph foo {
  node [style=rounded]
  node1 [shape=box]
  node2 [fillcolor=yellow, style="rounded,filled", shape=diamond]
  node3 [shape=record, label="{ a | b | c }"]

  node1 -> node2 -> node3
}
@enduml