各ダイアグラムの記述は@startuml
キーワードで開始し@enduml
キーワードで終了します。(または、ダイアグラムの種類に応じて@startXYZ
、@endXYZ
を使用します。)
.png
ファイルは、それを生成するために使われたソースファイルと同じ名前になります(拡張子のみ変更されます)。 ソースファイルに複数の@startXXX
が含まれていた場合は、自動的に連番が追加されます。 生成するファイルに別の名前を付けることもできます。例えば、: @startuml image.png
Alice->Bob: Authentication Request
Bob-->Alice: Authentication Response
@enduml
この場合、.png
ファイルはimage.png
という名前になります。 (Word統合機能では、この機能を使うことはできません。) 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! |
![]() |
@startdef(id=<identifier>)
と@enddef
で囲むことで、ファイルの一部を定義(def
)として宣言することができます。 それから、!includedef <identifier>
コマンドを使用して、同一ファイル内で定義をインクルードすることができます。 file.pu
というファイルの例です: 🎉 Copied! |
![]() |
file_001.png
は次のようになります: 🎉 Copied! |
![]() |
{
と}
で囲むことで、他のツールで使用するためのオプションを追加することができます。 最初の<filename>
だけが、PlantUMLに関係しています。それ以降はすべて無視されるので、他のツールで使用することができます。 @startuml{filename.png, This is my other caption text, width=16cm, option_for_other_tools=value}
@enduml
[Ref. QA-1466]