Donate252Patreon122


構文の一般化

もともと 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 の生成のみ対応しています。 ⚠ On PlantUML, only PNG generation is supported.
WARNING
 This translation need to be updated. 
WARNING

Option supported by PlantUML

You can also use some option, after the @startditaa or ditaa keyword:

  • -E or --no-separation to remove separator
  • -S or --no-shadows to remove shadow
  • scale=<XYZ> to scale up or down the diagram

Without option

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

Remove separator

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

Remove shadow or scale diagram

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

Tags

Tag Description
{c} Choice or Decision
{d} Document - Symbol representing a document
{io} Input/Output - Symbol representing input/output
{mo} Manual operation
{o} Ellipse
{s} Storage - Symbol representing a form of storage, like a database or a hard disk.
{tr} Trapezoid

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

More documentation

You will find the complete documentation about ditaa on: