PlantUMLAdvanced usageDitaa diagram
Donate258Patreon127


構文の一般化

現在、PlantUML では UML 以外の図も生成できるようになっています。その場合、@startumlでは意味が分かりません。そこで、図の開始に@startXYZ、終了に@endXYZをそれぞれ書けるようになりました。ここで、XYZは図の種類によって変わる空白も含む文字列が使用できます。

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

DITAAでは、通常、@startditaa...@endditaaの形式で記述します。

Ditaa

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

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

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

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

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

⚠ PlantUMLでは、PNGの生成のみ対応しています。

PlantUMLでサポートするオプション

@startditaaまたはditaaキーワードに続けて記述できるオプションがあります：

  • -Eまたは--no-separation：境界の隙間を無くします
  • -Sまたは--no-shadows：影を無くします
  • scale=<XYZ>：図を指定した倍率で拡大または縮小します

オプション無し

@startditaa
+---------+  /--------\   +-------+
| cBLU    +--+cAAA    +---+Version|
|         |  |  Data  |   |   V3  |
|    +----+  |  Base  |   |cRED{d}|
|    |cPNK|  |     {s}|   +-------+
|    |    |  \---+----/
+----+----+    
@endditaa

隙間を無くす

@startditaa -E
+---------+  /--------\   +-------+
| cBLU    +--+cAAA    +---+Version|
|         |  |  Data  |   |   V3  |
|    +----+  |  Base  |   |cRED{d}|
|    |cPNK|  |     {s}|   +-------+
|    |    |  \---+----/
+----+----+    
@endditaa

影を無くしてスケールを指定

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

タグ

タグ 説明
{c} Choice - 選択、または、決定
{d} Document - ドキュメント
{io} Input/Output - 入出力
{mo} Manual operation - 手作業
{o} Ellipse - 楕円
{s} Storage - データベースやハードディスクなどのストレージ
{tr} Trapezoid - 台形 

@startditaa
+------+------+------+------+------+------+------+
| c {c}|d {d} |io{io}|mo{mo}|o{o}  |s{s}  |tr{tr}|
+------+------+------+------+------+------+------+
@endditaa

その他のドキュメント

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