Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    View page history    Add new chapter    Reorder page    Raw


構文の一般化

Generalisation

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

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

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

PlantUML now can generate diagrams other than UML. In such cases the usual @startuml does not make sense anymore. So now we allow diagrams start with @startXYZ and finish with @endXYZ, where XYZ can change with the type of diagram and can be any characters (including spaces).

This means that plugin developers are encouraged to change their code to recognize @start instead of @startuml.

DITAA diagrams are usually formatted as @startditaa...@endditaa.

Ditaa

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の生成のみ対応しています。

Ditaa (DIagrams Through Ascii Art) is an Open Source project that allows to generate general diagrams from a text descriptions. The idea is close to PlantUML, and it may be useful for documentation to generate other diagrams than UML.

So last version of PlantUML allows this :

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

You will find the complete documentation about ditaa on:

If your plugin does not support @startditaa yet, a temporary feature has been set up : it is also possible to use Ditaa with @startuml by using ditaa keyword on the very first line of your description.

⚠ On PlantUML, only PNG generation is supported.

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

Option supported by 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

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

タグ 説明
{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

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

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

You will find the complete documentation about ditaa on:


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.