Edit in DokuwikiEdit in AsciidocEdit in Markdown

ダイアグラムの書き方と書く場所

各ダイアグラムの記述は@startumlキーワードで開始し@endumlキーワードで終了します。（または、ダイアグラムの種類に応じて@startXYZ、@endXYZを使用します。）

the PlantUML Language Reference Guideを参照してください。

以下の場所に記述できます:

• PlantUMLファイル(.pu、.puml)
• テキストファイル(.txt),
• HTMLファイル(.html、.htm),
• Javaソースファイル (.java),
• C/C++ソースファイル(.c、.h、.cpp、.hpp、.hh)
• LaTeXソースファイル(.tex),
• APTファイル(.apt)
• Wordファイル(.doc)
• URL

HTML、LaTeX、APT、Java/C/C++ファイルの場合は、当然、コメント中にダイアグラムを記述する必要があります。

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ファイル名

デフォルトでは、.pngファイルは、それを生成するために使われたソースファイルと同じ名前になります（拡張子のみ変更されます）。

ソースファイルに複数の@startXXXが含まれていた場合は、自動的に連番が追加されます。

生成するファイルに別の名前を付けることもできます。例えば、:

@startuml image.png
Alice->Bob: Authentication Request
Bob-->Alice: Authentication Response
@enduml

この場合、.pngファイルはimage.pngという名前になります。

(Word統合機能では、この機能を使うことはできません。)

Edit in DokuwikiEdit in AsciidocEdit in Markdown

IDを使ったインクルード[include]

ファイルの一部に対してIDを宣言することができます(id=<identifier>)、例えば:

file.puというファイルに対する例です:

@startuml(id=TAG1)
Alice->Bob : TAG1
@enduml

@startuml(id=TAG2)
Alice->Bob : TAG2
@enduml

その後、!include <filemane>!<id>コマンドを使用して、先ほど定義したidの個所をインクルードすることができます:

@startuml
!include file.pu!TAG2
Alice->Bob : hello
@enduml

これに対応する出力は次のようになります:

🎉 Copied!

@startuml Alice->Bob : TAG2 Alice->Bob : hello @enduml

[Ref. QA-4467]

Edit in DokuwikiEdit in AsciidocEdit in Markdown

定義IDをつかった(同一ファイル中での)インクルード [includedef]

@startdef(id=<identifier>)と@enddefで囲むことで、ファイルの一部を定義（def）として宣言することができます。

それから、!includedef <identifier>コマンドを使用して、同一ファイル内で定義をインクルードすることができます。

file.puというファイルの例です:

🎉 Copied!

@startdef(id=macro_def_id) Alice -> Bob : hello1 @enddef @startuml !includedef macro_def_id Alice -> Bob : hello2 @enduml

これに対応する出力結果file_001.pngは次のようになります:

🎉 Copied!

@startuml Alice -> Bob : hello1 Alice -> Bob : hello2 @enduml

[Ref. QA-5769]

Edit in DokuwikiEdit in AsciidocEdit in Markdown

他のツールのためのオプション

{と}で囲むことで、他のツールで使用するためのオプションを追加することができます。

最初の<filename>だけが、PlantUMLに関係しています。それ以降はすべて無視されるので、他のツールで使用することができます。

@startuml{filename.png, This is my other caption text, width=16cm, option_for_other_tools=value}

@enduml

[Ref. QA-1466]

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Adding output format when using pipe mode

⚠ Restriction: Only available when using pipe mode.

To specify the output format (PNG or SVG), on pipe mode, you can add this command on the input:

@@@format png

or

@@@format svg

[Ref. QA-10808]