PlantUML Language specification Common commands

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Commandes communes dans PlantUML

Global Elements

• Comments : Ajoutez des remarques ou des notes explicatives dans le script de votre diagramme pour transmettre des informations supplémentaires ou pour laisser des rappels en vue de modifications ultérieures.
• Notes : Incorporez des informations supplémentaires directement dans votre diagramme pour faciliter la compréhension ou pour mettre en évidence des aspects importants.
• Size Control (Contrôle de la taille) : Ajustez les dimensions des différents éléments en fonction de vos préférences, afin d'obtenir un diagramme équilibré et bien proportionné.
• Titre et légendes : Définissez un titre approprié et ajoutez des légendes pour clarifier le contexte ou pour annoter des parties spécifiques de votre diagramme.

Description de la syntaxe créole

• Formatage du texte : Personnalisez l'apparence de votre texte avec différents styles et alignements.
• Listes : Créez des listes ordonnées ou non ordonnées pour présenter les informations de manière claire.
• Liens : Intégrez des hyperliens pour faciliter la navigation rapide vers les ressources pertinentes.

Commande de contrôle du style

• Définir des styles : Définir des styles uniformes pour les éléments afin de maintenir un thème visuel cohérent.
• Personnaliser les couleurs : Choisir des couleurs spécifiques pour divers éléments afin d'améliorer l'attrait visuel et de créer des classifications distinctes.

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Commentaires

Commentaire simple

@startuml
'Line comments use a single apostrophe
@enduml

Commentaire de bloc

@startuml
/'
many lines comments
here
'/
@enduml

@startuml /' case 1 '/ A -> B : AB-First step B -> C : BC-Second step /' case 2 '/ D -> E : DE-Third step @enduml

Full example

@startuml skinparam activity { ' this is a comment BackgroundColor White BorderColor Black /' this is a comment '/ BorderColor Red ' this is not a comment and this line is ignored } start :foo1; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Zoom or Scale

• scale 1.5
• scale 2/3
• scale 200 width
• scale 200 height
• scale 200*100
• scale max 300*200
• scale max 1024 width
• scale max 800 height

@startuml scale 180*90 Bob->Alice : hello @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Title

@startuml skinparam titleBorderRoundCorner 15 skinparam titleBorderThickness 2 skinparam titleBorderColor red skinparam titleBackgroundColor Aqua-CadetBlue title Simple communication\nexample Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response @enduml

@startuml title <u>Simple</u> communication example on <i>several</i> lines and using <back:cadetblue>creole tags</back> end title Alice -> Bob: Authentication Request Bob -> Alice: Authentication Response @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Caption

@startuml caption figure 1 Alice -> Bob: Hello @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Footer and header

@startuml Alice -> Bob: Authentication Request header <font color=red>Warning:</font> Do not use in production. endheader center footer Generated for demonstration @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Legend the diagram

@startuml Alice -> Bob : Hello legend right Short legend endlegend @enduml

@startuml Alice -> Bob : Hello legend top left Short legend endlegend @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Appendix: Examples on all diagram

Activity

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend start :Hello world; :This is defined on several **lines**; stop @enduml

Archimate

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend archimate #Technology "VPN Server" as vpnServerA <<technology-device>> rectangle GO #lightgreen rectangle STOP #red rectangle WAIT #orange @enduml

Class

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend a -- b @enduml

Component, Deployment, Use-Case

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend node n (u) -> [c] @enduml

Gantt project planning

@startgantt header some header footer some footer title My title caption This is caption legend The legend end legend [t] lasts 5 days @endgantt

Object

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend object user { name = "Dummy" id = 123 } @enduml

MindMap

@startmindmap header some header footer some footer title My title caption This is caption legend The legend end legend * r ** d1 ** d2 @endmindmap

Network (nwdiag)

@startnwdiag header some header footer some footer title My title caption This is caption legend The legend end legend nwdiag { network inet { web01 [shape = cloud] } } @endnwdiag

Sequence

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend a->b @enduml

State

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend [*] --> State1 State1 -> State2 @enduml

Timing

@startuml header some header footer some footer title My title caption This is caption legend The legend end legend robust "Web Browser" as WB concise "Web User" as WU @0 WU is Idle WB is Idle @100 WU is Waiting WB is Processing @300 WB is Waiting @enduml

Work Breakdown Structure (WBS)

@startwbs header some header footer some footer title My title caption This is caption legend The legend end legend * r ** d1 ** d2 @endwbs

Wireframe (SALT)

@startsalt header some header footer some footer title My title caption This is caption legend The legend end legend {+ Login | "MyName " Password | "**** " [Cancel] | [ OK ] } @endsalt

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Appendix: Examples on all diagram with style

• all is only good for Sequence diagram
• title, caption and legend are good for all diagrams except for salt diagram

• Now (test on 1.2020.18-19) header, footer are not good for all other diagrams except only for Sequence diagram.

<style>
title {
  HorizontalAlignment right
  FontSize 24
  FontColor blue
}

header {
  HorizontalAlignment center
  FontSize 26
  FontColor purple
}

footer {
  HorizontalAlignment left
  FontSize 28
  FontColor red
}

legend {
  FontSize 30
  BackGroundColor yellow
  Margin 30
  Padding 50
}

caption {
  FontSize 32
}
</style>

Activity

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend start :Hello world; :This is defined on several **lines**; stop @enduml

Archimate

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend archimate #Technology "VPN Server" as vpnServerA <<technology-device>> rectangle GO #lightgreen rectangle STOP #red rectangle WAIT #orange @enduml

Class

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend a -- b @enduml

Component, Deployment, Use-Case

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend node n (u) -> [c] @enduml

Gantt project planning

@startgantt <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend [t] lasts 5 days @endgantt

Object

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend object user { name = "Dummy" id = 123 } @enduml

MindMap

@startmindmap <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend * r ** d1 ** d2 @endmindmap

Network (nwdiag)

@startnwdiag <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend nwdiag { network inet { web01 [shape = cloud] } } @endnwdiag

Sequence

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend a->b @enduml

State

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend [*] --> State1 State1 -> State2 @enduml

Timing

@startuml <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend robust "Web Browser" as WB concise "Web User" as WU @0 WU is Idle WB is Idle @100 WU is Waiting WB is Processing @300 WB is Waiting @enduml

Work Breakdown Structure (WBS)

@startwbs <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> header some header footer some footer title My title caption This is caption legend The legend end legend * r ** d1 ** d2 @endwbs

Wireframe (SALT)

@startsalt <style> title { HorizontalAlignment right FontSize 24 FontColor blue } header { HorizontalAlignment center FontSize 26 FontColor purple } footer { HorizontalAlignment left FontSize 28 FontColor red } legend { FontSize 30 BackGroundColor yellow Margin 30 Padding 50 } caption { FontSize 32 } </style> @startsalt header some header footer some footer title My title caption This is caption legend The legend end legend {+ Login | "MyName " Password | "**** " [Cancel] | [ OK ] } @endsalt

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Mainframe

@startuml mainframe This is a **mainframe** Alice->Bob : Hello @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Appendix: Examples of Mainframe on all diagram

Activity

@startuml mainframe This is a **mainframe** start :Hello world; :This is defined on several **lines**; stop @enduml

Archimate

@startuml mainframe This is a **mainframe** archimate #Technology "VPN Server" as vpnServerA <<technology-device>> rectangle GO #lightgreen rectangle STOP #red rectangle WAIT #orange @enduml

Class

@startuml mainframe This is a **mainframe** a -- b @enduml

Component, Deployment, Use-Case

@startuml mainframe This is a **mainframe** node n (u) -> [c] @enduml

Gantt project planning

@startgantt mainframe This is a **mainframe** [t] lasts 5 days @endgantt

Object

@startuml mainframe This is a **mainframe** object user { name = "Dummy" id = 123 } @enduml

MindMap

@startmindmap mainframe This is a **mainframe** * r ** d1 ** d2 @endmindmap

Network (nwdiag)

@startnwdiag mainframe This is a **mainframe** nwdiag { network inet { web01 [shape = cloud] } } @endnwdiag

Sequence

@startuml mainframe This is a **mainframe** a->b @enduml

State

@startuml mainframe This is a **mainframe** [*] --> State1 State1 -> State2 @enduml

Timing

@startuml mainframe This is a **mainframe** robust "Web Browser" as WB concise "Web User" as WU @0 WU is Idle WB is Idle @100 WU is Waiting WB is Processing @300 WB is Waiting @enduml

Work Breakdown Structure (WBS)

@startwbs mainframe This is a **mainframe** * r ** d1 ** d2 @endwbs

Wireframe (SALT)

@startsalt mainframe This is a **mainframe** {+ Login | "MyName " Password | "**** " [Cancel] | [ OK ] } @endsalt

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Appendix: Examples of title, header, footer, caption, legend and mainframe on all diagram

Activity

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend start :Hello world; :This is defined on several **lines**; stop @enduml

Archimate

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend archimate #Technology "VPN Server" as vpnServerA <<technology-device>> rectangle GO #lightgreen rectangle STOP #red rectangle WAIT #orange @enduml

Class

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend a -- b @enduml

Component, Deployment, Use-Case

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend node n (u) -> [c] @enduml

Gantt project planning

@startgantt mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend [t] lasts 5 days @endgantt

Object

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend object user { name = "Dummy" id = 123 } @enduml

MindMap

@startmindmap mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend * r ** d1 ** d2 @endmindmap

Network (nwdiag)

@startnwdiag mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend nwdiag { network inet { web01 [shape = cloud] } } @endnwdiag

Sequence

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend a->b @enduml

State

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend [*] --> State1 State1 -> State2 @enduml

Timing

@startuml mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend robust "Web Browser" as WB concise "Web User" as WU @0 WU is Idle WB is Idle @100 WU is Waiting WB is Processing @300 WB is Waiting @enduml

Work Breakdown Structure (WBS)

@startwbs mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend * r ** d1 ** d2 @endwbs

Wireframe (SALT)

@startsalt mainframe This is a **mainframe** header some header footer some footer title My title caption This is caption legend The legend end legend {+ Login | "MyName " Password | "**** " [Cancel] | [ OK ] } @endsalt