Updated version of the PlantUML Language Reference Guide.
Transcript of Updated version of the PlantUML Language Reference Guide.
Drawing UML with PlantUML
Language Reference Guide(Version 1.2018.1)
PlantUML is an Open Source project that allows to quickly write:
• Sequence diagram,
• Usecase diagram,
• Class diagram,
• Activity diagram,
• Component diagram,
• State diagram,
• Object diagram.
Diagrams are defined using a simple and intuitive language.
1 SEQUENCE DIAGRAM
1 Sequence Diagram1.1 Basic examplesThe sequence -> is used to draw a message between two participants. Participants do not have to beexplicitly declared.
To have a dotted arrow, you use -->It is also possible to use <- and <--. That does not change the drawing, but may improve readability.
Note that this is only true for sequence diagrams, rules are different for the other diagrams.@startumlAlice -> Bob: Authentication RequestBob --> Alice: Authentication Response
Alice -> Bob: Another authentication RequestAlice <-- Bob: another authentication Response@enduml
1.2 Declaring participantIt is possible to change participant order using the participant keyword.
It is also possible to use other keywords to declare a participant:
• actor
• boundary
• control
• entity
• database
@startumlactor Foo1boundary Foo2control Foo3entity Foo4database Foo5collections Foo6Foo1 -> Foo2 : To boundaryFoo1 -> Foo3 : To controlFoo1 -> Foo4 : To entityFoo1 -> Foo5 : To databaseFoo1 -> Foo6 : To collections
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 1 of 121
1.2 Declaring participant 1 SEQUENCE DIAGRAM
You can rename a participant using the as keyword.You can also change the background color of actor or participant.
@startumlactor Bob #red' The only difference between actor'and participant is the drawingparticipant Aliceparticipant "I have a really\nlong name" as L #99FF99/' You can also declare:participant L as "I have a really\nlong name" #99FF99'/
Alice->Bob: Authentication RequestBob->Alice: Authentication ResponseBob->L: Log transaction@enduml
You can use the orderkeyword to custom the print order of participant.@startumlparticipant Last order 30participant Middle order 20participant First order 10@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 2 of 121
1.3 Use non-letters in participants 1 SEQUENCE DIAGRAM
1.3 Use non-letters in participantsYou can use quotes to define participants. And you can use the as keyword to give an alias to thoseparticipants.@startumlAlice -> "Bob()" : Hello"Bob()" -> "This is very\nlong" as Long' You can also declare:' "Bob()" -> Long as "This is very\nlong"Long --> "Bob()" : ok@enduml
1.4 Message to SelfA participant can send a message to itself.
It is also possible to have multi-line using \n.@startumlAlice->Alice: This is a signal to self.\nIt also demonstrates\nmultiline \ntext@enduml
1.5 Change arrow styleYou can change arrow style by several ways:
• add a final x to denote a lost message
• use \ or / instead of < or > to have only the bottom or top part of the arrow
• repeat the arrow head (for example, >> or //) head to have a thin drawing
• use -- instead of - to have a dotted arrow
• add a final ”o” at arrow head
• use bidirectional arrow
PlantUML Language Reference Guide (Version 1.2018.1) 3 of 121
1.6 Change arrow color 1 SEQUENCE DIAGRAM
@startumlBob ->x AliceBob -> AliceBob ->> AliceBob -\ AliceBob \\- AliceBob //-- Alice
Bob ->o AliceBob o\\-- Alice
Bob <-> AliceBob <->o Alice@enduml
1.6 Change arrow colorYou can change the color of individual arrows using the following notation:@startumlBob -[#red]> Alice : helloAlice -[#0000FF]->Bob : ok@enduml
1.7 Message sequence numberingThe keyword autonumber is used to automatically add number to messages.@startumlautonumberBob -> Alice : Authentication RequestBob <- Alice : Authentication Response@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 4 of 121
1.7 Message sequence numbering 1 SEQUENCE DIAGRAM
You can specify a startnumber with autonumber 'start' , and also an increment with autonumber'start' 'increment'.@startumlautonumberBob -> Alice : Authentication RequestBob <- Alice : Authentication Response
autonumber 15Bob -> Alice : Another authentication RequestBob <- Alice : Another authentication Response
autonumber 40 10Bob -> Alice : Yet another authentication RequestBob <- Alice : Yet another authentication Response
@enduml
You can specify a format for your number by using between double-quote.The formatting is done with the Java class DecimalFormat (’0’ means digit, ’#’ means digit and zero
if absent).You can use some html tag in the format.
@startumlautonumber "<b>[000]"Bob -> Alice : Authentication RequestBob <- Alice : Authentication Response
autonumber 15 "<b>(<u>##</u>)"Bob -> Alice : Another authentication RequestBob <- Alice : Another authentication Response
autonumber 40 10 "<font color=red><b>Message 0 "Bob -> Alice : Yet another authentication RequestBob <- Alice : Yet another authentication Response
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 5 of 121
1.8 Splitting diagrams 1 SEQUENCE DIAGRAM
You can also use autonumber stop and autonumber resume 'increment' 'format' to respectivelypause and resume automatic numbering.@startumlautonumber 10 10 "<b>[000]"Bob -> Alice : Authentication RequestBob <- Alice : Authentication Response
autonumber stopBob -> Alice : dummy
autonumber resume "<font color=red><b>Message 0 "Bob -> Alice : Yet another authentication RequestBob <- Alice : Yet another authentication Response
autonumber stopBob -> Alice : dummy
autonumber resume 1 "<font color=blue><b>Message 0 "Bob -> Alice : Yet another authentication RequestBob <- Alice : Yet another authentication Response@enduml
1.8 Splitting diagramsThe newpage keyword is used to split a diagram into several images.
You can put a title for the new page just after the newpage keyword.This is very handy with Word to print long diagram on several pages.
PlantUML Language Reference Guide (Version 1.2018.1) 6 of 121
1.9 Grouping message 1 SEQUENCE DIAGRAM
@startuml
Alice -> Bob : message 1Alice -> Bob : message 2
newpage
Alice -> Bob : message 3Alice -> Bob : message 4
newpage A title for the\nlast page
Alice -> Bob : message 5Alice -> Bob : message 6@enduml
1.9 Grouping messageIt is possible to group messages together using the following keywords:
• alt/else
• opt
• loop
• par
• break
• critical
• group, followed by a text to be displayed
PlantUML Language Reference Guide (Version 1.2018.1) 7 of 121
1.10 Notes on messages 1 SEQUENCE DIAGRAM
It is possible a add a text that will be displayed into the header (except for group).The end keyword is used to close the group.Note that it is possible to nest groups.
@startumlAlice -> Bob: Authentication Request
alt successful case
Bob -> Alice: Authentication Accepted
else some kind of failure
Bob -> Alice: Authentication Failuregroup My own labelAlice -> Log : Log attack startloop 1000 timesAlice -> Bob: DNS AttackendAlice -> Log : Log attack endend
else Another type of failure
Bob -> Alice: Please repeat
end@enduml
1.10 Notes on messagesIt is possible to put notes on message using the note left or note right keywords just after the message.
You can have a multi-line note using the end note keywords.@startumlAlice->Bob : hellonote left: this is a first note
Bob->Alice : oknote right: this is another note
Bob->Bob : I am thinkingnote left
PlantUML Language Reference Guide (Version 1.2018.1) 8 of 121
1.11 Some other notes 1 SEQUENCE DIAGRAM
a notecan also be definedon several linesend note@enduml
1.11 Some other notesIt is also possible to place notes relative to participant with note left of , note right of or noteover keywords.
It is possible to highlight a note by changing its background color.You can also have a multi-line note using the end note keywords.
@startumlparticipant Aliceparticipant Bobnote left of Alice #aquaThis is displayedleft of Alice.end note
note right of Alice: This is displayed right of Alice.
note over Alice: This is displayed over Alice.
note over Alice, Bob #FFAAAA: This is displayed\n over Bob and Alice.
note over Bob, AliceThis is yet anotherexample ofa long note.end note@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 9 of 121
1.12 Changing notes shape 1 SEQUENCE DIAGRAM
1.12 Changing notes shapeYou can use hnote and rnote keywords to change note shapes.@startumlcaller -> server : conReqhnote over caller : idlecaller <- server : conConfrnote over server"r" as rectangle"h" as hexagonendrnote@enduml
1.13 Creole and HTMLIt is also possible to use creole formatting:@startumlparticipant Aliceparticipant "The **Famous** Bob" as Bob
Alice -> Bob : hello --there--... Some ~~long delay~~ ...Bob -> Alice : oknote leftThis is **bold**This is //italics//This is ""monospaced""This is --stroked--This is __underlined__
PlantUML Language Reference Guide (Version 1.2018.1) 10 of 121
1.14 Divider 1 SEQUENCE DIAGRAM
This is ~~waved~~end note
Alice -> Bob : A //well formatted// messagenote right of AliceThis is <back:cadetblue><size:18>displayed</size></back>__left of__ Alice.end notenote left of Bob<u:red>This</u> is <color #118888>displayed</color>**<color purple>left of</color> <s:red>Alice</strike> Bob**.end notenote over Alice, Bob<w:#FF33FF>This is hosted</w> by <img sourceforge.jpg>end note@enduml
1.14 DividerIf you want, you can split a diagram using == separator to divide your diagram into logical steps.@startuml
== Initialization ==
Alice -> Bob: Authentication RequestBob --> Alice: Authentication Response
== Repetition ==
Alice -> Bob: Another authentication RequestAlice <-- Bob: another authentication Response
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 11 of 121
1.15 Reference 1 SEQUENCE DIAGRAM
1.15 ReferenceYou can use reference in a diagram, using the keyword ref over.@startumlparticipant Aliceactor Bob
ref over Alice, Bob : init
Alice -> Bob : hello
ref over BobThis can be onseveral linesend ref@enduml
1.16 DelayYou can use ... to indicate a delay in the diagram. And it is also possible to put a message with thisdelay.@startuml
Alice -> Bob: Authentication Request...Bob --> Alice: Authentication Response
PlantUML Language Reference Guide (Version 1.2018.1) 12 of 121
1.17 Space 1 SEQUENCE DIAGRAM
...5 minutes latter...Bob --> Alice: Bye !
@enduml
1.17 SpaceYou can use ||| to indicate some spacing in the diagram.
It is also possible to specify a number of pixel to be used.@startuml
Alice -> Bob: message 1Bob --> Alice: ok|||Alice -> Bob: message 2Bob --> Alice: ok||45||Alice -> Bob: message 3Bob --> Alice: ok
@enduml
1.18 Lifeline Activation and DestructionThe activate and deactivate are used to denote participant activation.
Once a participant is activated, its lifeline appears.The activate and deactivate apply on the previous message.The destroy denote the end of the lifeline of a participant.
PlantUML Language Reference Guide (Version 1.2018.1) 13 of 121
1.18 Lifeline Activation and Destruction 1 SEQUENCE DIAGRAM
@startumlparticipant User
User -> A: DoWorkactivate A
A -> B: << createRequest >>activate B
B -> C: DoWorkactivate CC --> B: WorkDonedestroy C
B --> A: RequestCreateddeactivate B
A -> User: Donedeactivate A
@enduml
Nested lifeline can be used, and it is possible to add a color on the lifeline.@startumlparticipant User
User -> A: DoWorkactivate A #FFBBBB
A -> A: Internal callactivate A #DarkSalmon
A -> B: << createRequest >>activate B
B --> A: RequestCreateddeactivate Bdeactivate AA -> User: Donedeactivate A
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 14 of 121
1.19 Participant creation 1 SEQUENCE DIAGRAM
1.19 Participant creationYou can use the create keyword just before the first reception of a message to emphasize the fact thatthis message is actually creating this new object.@startumlBob -> Alice : hello
create OtherAlice -> Other : new
create control StringAlice -> Stringnote right : You can also put notes!
Alice --> Bob : ok
@enduml
1.20 Incoming and outgoing messagesYou can use incoming or outgoing arrows if you want to focus on a part of the diagram.
Use square brackets to denote the left ”[” or the right ”]” side of the diagram.@startuml[-> A: DoWork
activate A
A -> A: Internal callactivate A
A ->] : << createRequest >>
PlantUML Language Reference Guide (Version 1.2018.1) 15 of 121
1.21 Stereotypes and Spots 1 SEQUENCE DIAGRAM
A<--] : RequestCreateddeactivate A[<- A: Donedeactivate A@enduml
You can also have the following syntax:@startuml[-> Bob[o-> Bob[o->o Bob[x-> Bob
[<- Bob[x<- Bob
Bob ->]Bob ->o]Bob o->o]Bob ->x]
Bob <-]Bob x<-]@enduml
1.21 Stereotypes and SpotsIt is possible to add stereotypes to participants using << and >>.
In the stereotype, you can add a spotted character in a colored circle using the syntax (X,color).@startuml
participant "Famous Bob" as Bob << Generated >>participant Alice << (C,#ADD1B2) Testable >>
PlantUML Language Reference Guide (Version 1.2018.1) 16 of 121
1.22 More information on titles 1 SEQUENCE DIAGRAM
Bob->Alice: First message
@enduml
By default, the guillemet character is used to display the stereotype. You can change this behavioususing the skinparam guillemet:@startuml
skinparam guillemet falseparticipant "Famous Bob" as Bob << Generated >>participant Alice << (C,#ADD1B2) Testable >>
Bob->Alice: First message
@enduml
@startuml
participant Bob << (C,#ADD1B2) >>participant Alice << (C,#ADD1B2) >>
Bob->Alice: First message
@enduml
1.22 More information on titlesYou can use creole formatting in the title.@startuml
title __Simple__ **communication** example
Alice -> Bob: Authentication RequestBob -> Alice: Authentication Response
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 17 of 121
1.22 More information on titles 1 SEQUENCE DIAGRAM
You can add newline using \n in the title description.@startuml
title __Simple__ communication example\non several lines
Alice -> Bob: Authentication RequestBob -> Alice: Authentication Response
@enduml
You can also define title on several lines using title and end title keywords.@startuml
title<u>Simple</u> communication exampleon <i>several</i> lines and using <font color=red>html</font>This is hosted by <img:sourceforge.jpg>end title
Alice -> Bob: Authentication RequestBob -> Alice: Authentication Response
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 18 of 121
1.23 Participants encompass 1 SEQUENCE DIAGRAM
1.23 Participants encompassIt is possible to draw a box around some participants, using box and end box commands.
You can add an optional title or a optional background color, after the box keyword.@startuml
box "Internal Service" #LightBlueparticipant Bobparticipant Aliceend boxparticipant Other
Bob -> Alice : helloAlice -> Other : hello
@enduml
1.24 Removing FooterYou can use the hide footbox keywords to remove the footer of the diagram.@startuml
hide footboxtitle Footer removed
Alice -> Bob: Authentication RequestBob --> Alice: Authentication Response
@enduml
1.25 SkinparamYou can use the skinparam command to change colors and fonts for the drawing.
You can use this command:
• In the diagram definition, like any other commands,
• In an included file,
• In a configuration file, provided in the command line or the ANT task.
You can also change other rendering parameter, as seen in the following examples:
PlantUML Language Reference Guide (Version 1.2018.1) 19 of 121
1.25 Skinparam 1 SEQUENCE DIAGRAM
@startumlskinparam sequenceArrowThickness 2skinparam roundcorner 20skinparam maxmessagesize 60skinparam sequenceParticipant underline
actor Userparticipant "First Class" as Aparticipant "Second Class" as Bparticipant "Last Class" as C
User -> A: DoWorkactivate A
A -> B: Create Requestactivate B
B -> C: DoWorkactivate CC --> B: WorkDonedestroy C
B --> A: Request Createddeactivate B
A --> User: Donedeactivate A
@enduml
@startumlskinparam backgroundColor #EEEBDCskinparam handwritten true
skinparam sequence {ArrowColor DeepSkyBlueActorBorderColor DeepSkyBlueLifeLineBorderColor blueLifeLineBackgroundColor #A9DCDF
ParticipantBorderColor DeepSkyBlueParticipantBackgroundColor DodgerBlueParticipantFontName ImpactParticipantFontSize 17
PlantUML Language Reference Guide (Version 1.2018.1) 20 of 121
1.26 Changing padding 1 SEQUENCE DIAGRAM
ParticipantFontColor #A9DCDF
ActorBackgroundColor aquaActorFontColor DeepSkyBlueActorFontSize 17ActorFontName Aapex}
actor Userparticipant "First Class" as Aparticipant "Second Class" as Bparticipant "Last Class" as C
User -> A: DoWorkactivate A
A -> B: Create Requestactivate B
B -> C: DoWorkactivate CC --> B: WorkDonedestroy C
B --> A: Request Createddeactivate B
A --> User: Donedeactivate A
@enduml
1.26 Changing paddingIt is possible to tune some padding settings.@startumlskinparam ParticipantPadding 20skinparam BoxPadding 10
box "Foo1"participant Alice1participant Alice2end boxbox "Foo2"participant Bob1participant Bob2
PlantUML Language Reference Guide (Version 1.2018.1) 21 of 121
1.26 Changing padding 1 SEQUENCE DIAGRAM
end boxAlice1 -> Bob1 : helloAlice1 -> Out : out@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 22 of 121
2 USE CASE DIAGRAM
2 Use Case Diagram2.1 UsecasesUse cases are enclosed using between parentheses (because two parentheses looks like an oval).
You can also use the usecase keyword to define a usecase. And you can define an alias, using the askeyword. This alias will be used latter, when defining relations.@startuml
(First usecase)(Another usecase) as (UC2)usecase UC3usecase (Last\nusecase) as UC4
@enduml
2.2 ActorsActor are enclosed using between two points.
You can also use the actor keyword to define an actor. And you can define an alias, using the askeyword. This alias will be used latter, when defining relations.
We will see later that the actor definitions are optional.@startuml
:First Actor::Another\nactor: as Men2actor Men3actor :Last actor: as Men4
@enduml
2.3 Usecases descriptionIf you want to have description on several lines, you can use quotes.
You can also use the following separators: -- .. == __. And you can put titles within the separators.
PlantUML Language Reference Guide (Version 1.2018.1) 23 of 121
2.4 Basic example 2 USE CASE DIAGRAM
@startuml
usecase UC1 as "You can useseveral lines to define your usecase.You can also use separators.--Several separators are possible.==And you can add titles:..Conclusion..This allows large description."
@enduml
2.4 Basic exampleTo link actors and use cases, the arrow --> is used.
The more dashes "-" in the arrow, the longer the arrow. You can add a label on the arrow, by addinga ”:” character in the arrow definition.
In this example, you see that User has not been defined before, and is used as an actor.@startuml
User -> (Start)User --> (Use the application) : A small label
:Main Admin: ---> (Use the application) : This is\nyet another\nlabel
@enduml
2.5 ExtensionIf one actor/use case extends another one, you can use the symbol <|-- (which stands for ).
PlantUML Language Reference Guide (Version 1.2018.1) 24 of 121
2.6 Using notes 2 USE CASE DIAGRAM
@startuml:Main Admin: as Admin(Use the application) as (Use)
User <|-- Admin(Start) <|-- (Use)
@enduml
2.6 Using notesYou can use the note left of , note right of , note top of , note bottom of keywords to definenotes related to a single object.
A note can be also define alone with the note keywords, then linked to other objects using the ..symbol.@startuml:Main Admin: as Admin(Use the application) as (Use)
User -> (Start)User --> (Use)
Admin ---> (Use)
note right of Admin : This is an example.
note right of (Use)A note can alsobe on several linesend note
note "This note is connected\nto several objects." as N2(Start) .. N2N2 .. (Use)@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 25 of 121
2.7 Stereotypes 2 USE CASE DIAGRAM
2.7 StereotypesYou can add stereotypes while defining actors and use cases using ” << ” and ” >> ”.@startumlUser << Human >>:Main Database: as MySql << Application >>(Start) << One Shot >>(Use the application) as (Use) << Main >>
User -> (Start)User --> (Use)
MySql --> (Use)
@enduml
2.8 Changing arrows directionBy default, links between classes have two dashes -- and are vertically oriented. It is possible to usehorizontal link by putting a single dash (or dot) like this:@startuml:user: --> (Use case 1):user: -> (Use case 2)@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 26 of 121
2.8 Changing arrows direction 2 USE CASE DIAGRAM
You can also change directions by reversing the link:@startuml(Use case 1) <.. :user:(Use case 2) <- :user:@enduml
It is also possible to change arrow direction by adding left, right, up or down keywords inside thearrow:@startuml:user: -left-> (dummyLeft):user: -right-> (dummyRight):user: -up-> (dummyUp):user: -down-> (dummyDown)@enduml
You can shorten the arrow by using only the first character of the direction (for example, -d- insteadof -down-) or the two first characters (-do-).
Please note that you should not abuse this functionality : Graphviz gives usually good results withouttweaking.
PlantUML Language Reference Guide (Version 1.2018.1) 27 of 121
2.9 Splitting diagrams 2 USE CASE DIAGRAM
2.9 Splitting diagramsThe newpage keywords to split your diagram into several pages or images.@startuml:actor1: --> (Usecase1)newpage:actor2: --> (Usecase2)@enduml
2.10 Left to right directionThe general default behavior when building diagram is top to bottom.@startuml'defaulttop to bottom directionuser1 --> (Usecase 1)user2 --> (Usecase 2)
@enduml
You may change to left to right using the left to right direction command. The result is oftenbetter with this direction.@startuml
left to right directionuser1 --> (Usecase 1)user2 --> (Usecase 2)
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 28 of 121
2.11 Skinparam 2 USE CASE DIAGRAM
2.11 SkinparamYou can use the skinparam command to change colors and fonts for the drawing.
You can use this command :
• In the diagram definition, like any other commands,
• In an included file,
• In a configuration file, provided in the command line or the ANT task.
You can define specific color and fonts for stereotyped actors and usecases.@startumlskinparam handwritten true
skinparam usecase {BackgroundColor DarkSeaGreenBorderColor DarkSlateGray
BackgroundColor<< Main >> YellowGreenBorderColor<< Main >> YellowGreen
ArrowColor OliveActorBorderColor blackActorFontName Courier
ActorBackgroundColor << Human >> Gold}
User << Human >>:Main Database: as MySql << Application >>(Start) << One Shot >>(Use the application) as (Use) << Main >>
User -> (Start)User --> (Use)
MySql --> (Use)
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 29 of 121
2.12 Complete example 2 USE CASE DIAGRAM
2.12 Complete example
@startumlleft to right directionskinparam packageStyle rectangleactor customeractor clerkrectangle checkout {customer -- (checkout)(checkout) .> (payment) : include(help) .> (checkout) : extends(checkout) -- clerk}@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 30 of 121
3 CLASS DIAGRAM
3 Class Diagram3.1 Relations between classesRelations between classes are defined using the following symbols :
Extension <|--Composition *--Aggregation o--
It is possible to replace -- by .. to have a dotted line.Knowing those rules, it is possible to draw the following drawings:
@startumlClass01 <|-- Class02Class03 *-- Class04Class05 o-- Class06Class07 .. Class08Class09 -- Class10@enduml
@startumlClass11 <|.. Class12Class13 --> Class14Class15 ..> Class16Class17 ..|> Class18Class19 <--* Class20@enduml
@startumlClass21 #-- Class22Class23 x-- Class24Class25 }-- Class26Class27 +-- Class28Class29 ^-- Class30@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 31 of 121
3.2 Label on relations 3 CLASS DIAGRAM
3.2 Label on relationsIt is possible a add a label on the relation, using ”:”, followed by the text of the label.
For cardinality, you can use double-quotes "" on each side of the relation.
@startuml
Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : aggregation
Class05 --> "1" Class06
@enduml
You can add an extra arrow pointing at one object showing which object acts on the other object,using < or > at the begin or at the end of the label.@startumlclass Car
Driver - Car : drives >Car *- Wheel : have 4 >Car -- Person : < owns
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 32 of 121
3.3 Adding methods 3 CLASS DIAGRAM
3.3 Adding methodsTo declare fields and methods, you can use the symbol ":" followed by the field’s or method’s name.
The system checks for parenthesis to choose between methods and fields.
@startumlObject <|-- ArrayList
Object : equals()ArrayList : Object[] elementDataArrayList : size()
@enduml
It is also possible to group between brackets {} all fields and methods.
Note that the syntax is highly flexible about type/name order.
@startumlclass Dummy {String datavoid methods()}
class Flight {flightNumber : IntegerdepartureTime : Date}@enduml
You can use {field} and {method} modifiers to override default behaviour of the parser about fieldsand methods.@startumlclass Dummy {{field} A field (despite parentheses){method} Some method}
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 33 of 121
3.4 Defining visibility 3 CLASS DIAGRAM
3.4 Defining visibilityWhen you define methods or fields, you can use characters to define the visibility of the corresponding
item:
- private# protected̃ package private+ public
@startuml
class Dummy {-field1#field2~method1()+method2()}
@enduml
You can turn off this feature using the skinparam classAttributeIconSize 0 command :
@startumlskinparam classAttributeIconSize 0class Dummy {-field1#field2~method1()+method2()}
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 34 of 121
3.5 Abstract and Static 3 CLASS DIAGRAM
3.5 Abstract and StaticYou can define static or abstract methods or fields using the {static} or {abstract} modifier.
These modifiers can be used at the start or at the end of the line. You can also use {classifier}instead of {static}.
@startumlclass Dummy {{static} String id{abstract} void methods()}@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 35 of 121
3.6 Advanced class body 3 CLASS DIAGRAM
3.6 Advanced class bodyBy default, methods and fields are automatically regrouped by PlantUML. You can use separators to
define your own way of ordering fields and methods. The following separators are possible : -- ..== __.
You can also use titles within the separators:
@startumlclass Foo1 {You can useseveral lines..as you wantand group==things together.__You can have as many groupsas you want--End of class}
class User {.. Simple Getter ..+ getName()+ getAddress().. Some setter ..+ setName()__ private data __int age-- encrypted --String password}
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 36 of 121
3.7 Notes and stereotypes 3 CLASS DIAGRAM
3.7 Notes and stereotypesStereotypes are defined with the class keyword, ” << ” and ” >> ”.
You can also define notes using note left of , note right of , note top of , note bottom ofkeywords.
You can also define a note on the last defined class using note left, note right, note top, notebottom.
A note can be also define alone with the note keywords, then linked to other objects using the ..symbol.@startumlclass Object << general >>Object <|--- ArrayList
note top of Object : In java, every class\nextends this one.
note "This is a floating note" as N1note "This note is connected\nto several objects." as N2Object .. N2N2 .. ArrayList
class Foonote left: On last defined class
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 37 of 121
3.8 More on notes 3 CLASS DIAGRAM
3.8 More on notes
It is also possible to use few html tags like :
• <b>• <u>• <i>• <s>, <del>, <strike>• <font color="#AAAAAA"> or <font color="colorName">• <color:#AAAAAA> or <color:colorName>• <size:nn> to change font size• <img src="file"> or <img:file> : the file must be accessible by the filesystem
You can also have a note on several lines.You can also define a note on the last defined class using note left, note right, note top, notebottom.@startuml
class Foonote left: On last defined class
note top of ObjectIn java, <size:18>every</size> <u>class</u><b>extends</b><i>this</i> one.end note
note as N1This note is <u>also</u><b><color:royalBlue>on several</color><s>words</s> linesAnd this is hosted by <img:sourceforge.jpg>end note
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 38 of 121
3.9 Note on links 3 CLASS DIAGRAM
3.9 Note on links
It is possible to add a note on a link, just after the link definition, using note on link.You can also use note left on link, note right on link, note top on link, note bottom onlink if you want to change the relative position of the note with the label.@startuml
class DummyDummy --> Foo : A linknote on link #red: note that is red
Dummy --> Foo2 : Another linknote right on link #bluethis is my note on right linkand in blueend note
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 39 of 121
3.10 Abstract class and interface 3 CLASS DIAGRAM
3.10 Abstract class and interface
You can declare a class as abstract using "abstract" or "abstract class" keywords.The class will be printed in italic.You can use the interface, annotation and enum keywords too.@startuml
abstract class AbstractListabstract AbstractCollectioninterface Listinterface Collection
List <|-- AbstractListCollection <|-- AbstractCollection
Collection <|- ListAbstractCollection <|- AbstractListAbstractList <|-- ArrayList
class ArrayList {Object[] elementDatasize()}
enum TimeUnit {DAYSHOURSMINUTES}
annotation SuppressWarnings
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 40 of 121
3.11 Using non-letters 3 CLASS DIAGRAM
3.11 Using non-letters
If you want to use non-letters in the class (or enum...) display, you can either :
• Use the as keyword in the class definition• Put quotes "" around the class name
@startumlclass "This is my class" as class1class class2 as "It works this way too"
class2 *-- "foo/dummy" : use@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 41 of 121
3.12 Hide attributes, methods... 3 CLASS DIAGRAM
3.12 Hide attributes, methods...
You can parameterize the display of classes using the hide/show command.The basic command is: hide empty members. This command will hide attributes or methods ifthey are empty.Instead of empty members, you can use:
• empty fields or empty attributes for empty fields,• empty methods for empty methods,• fields or attributes which will hide fields, even if they are described,• methods which will hide methods, even if they are described,• members which will hide fields and methods, even if they are described,• circle for the circled character in front of class name,• stereotype for the stereotype.
You can also provide, just after the hide or show keyword:
• class for all classes,• interface for all interfaces,• enum for all enums,• <<foo1>> for classes which are stereotyped with foo1,• an existing class name.
You can use several show/hide commands to define rules and exceptions.@startuml
class Dummy1 {+myMethods()}
class Dummy2 {+hiddenMethod()}
class Dummy3 <<Serializable>> {String name}
hide membershide <<Serializable>> circleshow Dummy1 methodsshow <<Serializable>> fields
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 42 of 121
3.13 Hide classes 3 CLASS DIAGRAM
3.13 Hide classes
You can also use the show/hide commands to hide classes.This may be useful if you define a large !included file, and if you want to hide come classes afterfile inclusion.@startuml
class Foo1class Foo2
Foo2 *-- Foo1
hide Foo2
@enduml
3.14 Use generics
You can also use bracket < and > to define generics usage in a class.@startuml
class Foo<? extends Element> {int size()}Foo *- Element
@enduml
It is possible to disable this drawing using skinparam genericDisplay old command.
3.15 Specific Spot
Usually, a spotted character (C, I, E or A) is used for classes, interface, enum and abstract classes.But you can define your own spot for a class when you define the stereotype, adding a singlecharacter and a color, like in this example:@startuml
class System << (S,#FF7700) Singleton >>class Date << (D,orchid) >>@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 43 of 121
3.16 Packages 3 CLASS DIAGRAM
3.16 Packages
You can define a package using the package keyword, and optionally declare a background colorfor your package (Using a html color code or name).Note that package definitions can be nested.@startuml
package "Classic Collections" #DDDDDD {Object <|-- ArrayList}
package net.sourceforge.plantuml {Object <|-- Demo1Demo1 *- Demo2}
@enduml
3.17 Packages style
There are different styles available for packages.You can specify them either by setting a default style with the command : skinparam packageStyle,or by using a stereotype on the package:@startumlscale 750 widthpackage foo1 <<Node>> {class Class1}
package foo2 <<Rectangle>> {class Class2}
package foo3 <<Folder>> {class Class3}
package foo4 <<Frame>> {class Class4}
package foo5 <<Cloud>> {class Class5}
package foo6 <<Database>> {class Class6}
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 44 of 121
3.18 Namespaces 3 CLASS DIAGRAM
You can also define links between packages, like in the following example:@startuml
skinparam packageStyle rectangle
package foo1.foo2 {}
package foo1.foo2.foo3 {class Object}
foo1.foo2 +-- foo1.foo2.foo3
@enduml
3.18 Namespaces
In packages, the name of a class is the unique identifier of this class. It means that you cannot havetwo classes with the very same name in different packages.In that case, you should use namespaces instead of packages.You can refer to classes from other namespaces by fully qualify them. Classes from the defaultnamespace are qualified with a starting dot.Note that you don’t have to explicitly create namespace : a fully qualified class is automaticallyput in the right namespace.@startuml
class BaseClass
namespace net.dummy #DDDDDD {.BaseClass <|-- PersonMeeting o-- Person
.BaseClass <|- Meeting}
namespace net.foo {net.dummy.Person <|- Person.BaseClass <|-- Person
PlantUML Language Reference Guide (Version 1.2018.1) 45 of 121
3.19 Automatic namespace creation 3 CLASS DIAGRAM
net.dummy.Meeting o-- Person}
BaseClass <|-- net.unused.Person
@enduml
3.19 Automatic namespace creation
You can define another separator (other than the dot) using the command : set namespaceSeparator???.@startuml
set namespaceSeparator ::class X1::X2::foo {some info}
@enduml
You can disable automatic package creation using the command set namespaceSeparator none.@startuml
set namespaceSeparator noneclass X1.X2.foo {some info}
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 46 of 121
3.20 Lollipop interface 3 CLASS DIAGRAM
3.20 Lollipop interface
You can also define lollipops interface on classes, using the following syntax:
• bar ()- foo• bar ()-- foo• foo -() bar
@startumlclass foobar ()- foo@enduml
3.21 Changing arrows direction
By default, links between classes have two dashes -- and are vertically oriented. It is possible touse horizontal link by putting a single dash (or dot) like this:@startumlRoom o- StudentRoom *-- Chair@enduml
You can also change directions by reversing the link:@startumlStudent -o RoomChair --* Room@enduml
It is also possible to change arrow direction by adding left, right, up or down keywords inside thearrow:
PlantUML Language Reference Guide (Version 1.2018.1) 47 of 121
3.22 Association classes 3 CLASS DIAGRAM
@startumlfoo -left-> dummyLeftfoo -right-> dummyRightfoo -up-> dummyUpfoo -down-> dummyDown@enduml
You can shorten the arrow by using only the first character of the direction (for example, -d-instead of -down-) or the two first characters (-do-).Please note that you should not abuse this functionality : Graphviz gives usually good resultswithout tweaking.
3.22 Association classes
You can define association class after that a relation has been defined between two classes, like inthis example:@startumlclass Student {Name}Student "0..*" - "1..*" Course(Student, Course) .. Enrollment
class Enrollment {drop()cancel()}@enduml
You can define it in another direction:
PlantUML Language Reference Guide (Version 1.2018.1) 48 of 121
3.23 Skinparam 3 CLASS DIAGRAM
@startumlclass Student {Name}Student "0..*" -- "1..*" Course(Student, Course) . Enrollment
class Enrollment {drop()cancel()}@enduml
3.23 Skinparam
You can use the skinparam command to change colors and fonts for the drawing.You can use this command :
• In the diagram definition, like any other commands,• In an included file,• In a configuration file, provided in the command line or the ANT task.
@startuml
skinparam class {BackgroundColor PaleGreenArrowColor SeaGreenBorderColor SpringGreen}skinparam stereotypeCBackgroundColor YellowGreen
Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : aggregation
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 49 of 121
3.24 Skinned Stereotypes 3 CLASS DIAGRAM
3.24 Skinned Stereotypes
You can define specific color and fonts for stereotyped classes.@startuml
skinparam class {BackgroundColor PaleGreenArrowColor SeaGreenBorderColor SpringGreenBackgroundColor<<Foo>> WheatBorderColor<<Foo>> Tomato}skinparam stereotypeCBackgroundColor YellowGreenskinparam stereotypeCBackgroundColor << Foo >> DimGray
Class01 <<Foo>>Class03 <<Foo>>Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : aggregation
@enduml
3.25 Color gradient
It’s possible to declare individual color for classes or note using the notation.You can use either standard color name or RGB code.You can also use color gradient in background, with the following syntax: two colors names separatedeither by:
• |,• /,• \,• or -
depending the direction of the gradient.For example, you could have:
PlantUML Language Reference Guide (Version 1.2018.1) 50 of 121
3.26 Help on layout 3 CLASS DIAGRAM
@startuml
skinparam backgroundcolor AntiqueWhite/Goldskinparam classBackgroundColor Wheat|CornflowerBlue
class Foo #red-greennote left of Foo #blue\9932CCthis is mynote on this classend note
package example #GreenYellow/LightGoldenRodYellow {class Dummy}
@enduml
3.26 Help on layout
Sometimes, the default layout is not perfect...You can use together keyword to group some classes together : the layout engine will try to groupthem (as if they were in the same package).You can also use hidden links to force the layout.@startuml
class Bar1class Bar2together {class Together1class Together2class Together3}Together1 - Together2Together2 - Together3Together2 -[hidden]--> Bar1Bar1 -[hidden]> Bar2
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 51 of 121
3.27 Splitting large files 3 CLASS DIAGRAM
3.27 Splitting large files
Sometimes, you will get some very large image files.You can use the ”page (hpages)x(vpages)” command to split the generated image into severalfiles :hpages is a number that indicated the number of horizontal pages, and vpages is a number thatindicated the number of vertical pages.You can also use some specific skinparam settings to put borders on splitted pages (see example).@startuml' Split into 4 pagespage 2x2skinparam pageMargin 10skinparam pageExternalColor grayskinparam pageBorderColor black
class BaseClass
namespace net.dummy #DDDDDD {.BaseClass <|-- PersonMeeting o-- Person
.BaseClass <|- Meeting
}
namespace net.foo {net.dummy.Person <|- Person.BaseClass <|-- Person
net.dummy.Meeting o-- Person}
BaseClass <|-- net.unused.Person@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 52 of 121
3.27 Splitting large files 3 CLASS DIAGRAM
PlantUML Language Reference Guide (Version 1.2018.1) 53 of 121
4 ACTIVITY DIAGRAM
4 Activity Diagram
4.1 Simple Activity
You can use (*) for the starting point and ending point of the activity diagram.In some occasion, you may want to use (*top) to force the starting point to be at the top of thediagram.Use --> for arrows.@startuml
(*) --> "First Activity""First Activity" --> (*)
@enduml
4.2 Label on arrows
By default, an arrow starts at the last used activity.You can put a label on an arrow using brackets [ and ] just after the arrow definition.@startuml
(*) --> "First Activity"-->[You can put also labels] "Second Activity"--> (*)
@enduml
4.3 Changing arrow direction
You can use -> for horizontal arrows. It is possible to force arrow’s direction using the followingsyntax:
• -down-> (default arrow)
PlantUML Language Reference Guide (Version 1.2018.1) 54 of 121
4.4 Branches 4 ACTIVITY DIAGRAM
• -right-> or ->• -left->• -up->
@startuml
(*) -up-> "First Activity"-right-> "Second Activity"--> "Third Activity"-left-> (*)
@enduml
4.4 Branches
You can use if/then/else keywords to define branches.@startuml(*) --> "Initialization"
if "Some Test" then-->[true] "Some Activity"--> "Another activity"-right-> (*)else->[false] "Something else"-->[Ending process] (*)endif
@enduml
Unfortunately, you will have to sometimes repeat the same activity in the diagram text:
PlantUML Language Reference Guide (Version 1.2018.1) 55 of 121
4.5 More on Branches 4 ACTIVITY DIAGRAM
@startuml(*) --> "check input"If "input is verbose" then--> [Yes] "turn on verbosity"--> "run command"else--> "run command"Endif-->(*)@enduml
4.5 More on Branches
By default, a branch is connected to the last defined activity, but it is possible to override this andto define a link with the if keywords.It is also possible to nest branches.@startuml
(*) --> if "Some Test" then
-->[true] "activity 1"
if "" then-> "activity 3" as a3elseif "Other test" then-left-> "activity 5"else--> "activity 6"endifendif
else
->[false] "activity 2"
endif
a3 --> if "last test" then--> "activity 7"else-> "activity 8"
PlantUML Language Reference Guide (Version 1.2018.1) 56 of 121
4.6 Synchronization 4 ACTIVITY DIAGRAM
endif
@enduml
4.6 Synchronization
You can use === code === to display synchronization bars.@startuml
(*) --> ===B1===--> "Parallel Activity 1"--> ===B2===
===B1=== --> "Parallel Activity 2"--> ===B2===
--> (*)
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 57 of 121
4.7 Long activity description 4 ACTIVITY DIAGRAM
4.7 Long activity description
When you declare activities, you can span on several lines the description text. You can also add\n in the description.You can also give a short code to the activity with the as keyword. This code can be used latterin the diagram description.@startuml(*) -left-> "this <size:20>activity</size>is <b>very</b> <color:red>long2</color>and defined on several linesthat contains many <i>text</i>" as A1
-up-> "Another activity\n on several lines"
A1 --> "Short activity <img:sourceforge.jpg>"@enduml
4.8 Notes
You can add notes on a activity using the commands note left, note right, note top or notebottom, just after the description of the activity you want to note.If you want to put a note on the starting point, define the note at the very beginning of the diagramdescription.You can also have a note on several lines, using the endnote keywords.@startuml
(*) --> "Some Activity"note right: This activity has to be defined"Some Activity" --> (*)note leftThis note is onseveral linesend note
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 58 of 121
4.9 Partition 4 ACTIVITY DIAGRAM
4.9 Partition
You can define a partition using the partition keyword, and optionally declare a background colorfor your partition (Using a html color code or name)When you declare activities, they are automatically put in the last used partition.You can close the partition definition using a closing bracket }.@startuml
partition Conductor {(*) --> "Climbs on Platform"--> === S1 ===--> Bows}
partition Audience #LightSkyBlue {=== S1 === --> Applauds}
partition Conductor {Bows --> === S2 ===--> WavesArmesApplauds --> === S2 ===}
partition Orchestra #CCCCEE {WavesArmes --> Introduction--> "Play music"}
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 59 of 121
4.10 Skinparam 4 ACTIVITY DIAGRAM
4.10 Skinparam
You can use the skinparam command to change colors and fonts for the drawing.You can use this command :
• In the diagram definition, like any other commands,• In an included file,• In a configuration file, provided in the command line or the ANT task.
You can define specific color and fonts for stereotyped activities.@startuml
skinparam backgroundColor #AAFFFFskinparam activity {StartColor redBarColor SaddleBrownEndColor SilverBackgroundColor PeruBackgroundColor<< Begin >> OliveBorderColor PeruFontName Impact}
(*) --> "Climbs on Platform" << Begin >>--> === S1 ===--> Bows--> === S2 ===--> WavesArmes--> (*)
PlantUML Language Reference Guide (Version 1.2018.1) 60 of 121
4.11 Octagon 4 ACTIVITY DIAGRAM
@enduml
4.11 Octagon
You can change the shape of activities to octagon using the skinparam activityShape octagoncommand.@startuml'Default is skinparam activityShape roundBoxskinparam activityShape octagon
(*) --> "First Activity""First Activity" --> (*)
@enduml
4.12 Complete example
@startumltitle Servlet Container
(*) --> "ClickServlet.handleRequest()"--> "new Page"
if "Page.onSecurityCheck" then->[true] "Page.onInit()"
PlantUML Language Reference Guide (Version 1.2018.1) 61 of 121
4.12 Complete example 4 ACTIVITY DIAGRAM
if "isForward?" then->[no] "Process controls"
if "continue processing?" then-->[yes] ===RENDERING===else-->[no] ===REDIRECT_CHECK===endif
else-->[yes] ===RENDERING===endif
if "is Post?" then-->[yes] "Page.onPost()"--> "Page.onRender()" as render--> ===REDIRECT_CHECK===else-->[no] "Page.onGet()"--> renderendif
else-->[false] ===REDIRECT_CHECK===endif
if "Do redirect?" then->[yes] "redirect request"--> ==BEFORE_DESTROY===elseif "Do Forward?" then-left->[yes] "Forward request"--> ==BEFORE_DESTROY===else-right->[no] "Render page template"--> ==BEFORE_DESTROY===endifendif
--> "Page.onDestroy()"-->(*)
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 62 of 121
4.12 Complete example 4 ACTIVITY DIAGRAM
PlantUML Language Reference Guide (Version 1.2018.1) 63 of 121
5 ACTIVITY DIAGRAM (BETA)
5 Activity Diagram (beta)
Current syntax for activity diagram has several limitations and drawbacks (for example, it’s difficultto maintain).So a completely new syntax and implementation is proposed as beta version to users (startingwith V7947), so that we could define a better format and syntax.Another advantage of this new implementation is that it’s done without the need of having Graphvizinstalled (as for sequence diagrams).The new syntax will replace the old one. However, for compatibility reason, the old syntax will stillbe recognized, to ensure ascending compatibility.Users are simply encouraged to migrate to the new syntax.
5.1 Simple Activity
Activities label starts with : and ends with ;.Text formatting can be done using creole wiki syntax.They are implicitly linked in their definition order.@startuml:Hello world;:This is on defined onseveral **lines**;@enduml
5.2 Start/Stop
You can use start and stop keywords to denote the beginning and the end of a diagram.@startumlstart:Hello world;:This is on defined onseveral **lines**;stop@enduml
You can also use the end keyword.
PlantUML Language Reference Guide (Version 1.2018.1) 64 of 121
5.3 Conditional 5 ACTIVITY DIAGRAM (BETA)
@startumlstart:Hello world;:This is on defined onseveral **lines**;end@enduml
5.3 Conditional
You can use if, then and else keywords to put tests if your diagram. Labels can be providedusing parentheses.@startuml
start
if (Graphviz installed?) then (yes):process all\ndiagrams;else (no):process only__sequence__ and __activity__ diagrams;endif
stop
@enduml
You can use the elseif keyword to have several tests :@startumlstartif (condition A) then (yes):Text 1;elseif (condition B) then (yes):Text 2;stopelseif (condition C) then (yes):Text 3;elseif (condition D) then (yes)
PlantUML Language Reference Guide (Version 1.2018.1) 65 of 121
5.4 Repeat loop 5 ACTIVITY DIAGRAM (BETA)
:Text 4;else (nothing):Text else;endifstop@enduml
5.4 Repeat loop
You can use repeat and repeatwhile keywords to have repeat loops.@startuml
start
repeat:read data;:generate diagrams;repeat while (more data?)
stop
@enduml
5.5 While loop
You can use while and end while keywords to have repeat loops.@startuml
start
PlantUML Language Reference Guide (Version 1.2018.1) 66 of 121
5.6 Parallel processing 5 ACTIVITY DIAGRAM (BETA)
while (data available?):read data;:generate diagrams;endwhile
stop
@enduml
It is possible to provide a label after the endwhile keyword, or using the is keyword.@startumlwhile (check filesize ?) is (not empty):read file;endwhile (empty):close file;@enduml
5.6 Parallel processing
You can use fork, fork again and end fork keywords to denote parallel processing.@startuml
start
if (multiprocessor?) then (yes)fork:Treatment 1;fork again:Treatment 2;end forkelse (monoproc):Treatment 1;:Treatment 2;endif
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 67 of 121
5.7 Notes 5 ACTIVITY DIAGRAM (BETA)
5.7 Notes
Text formatting can be done using creole wiki syntax.A note can be floating, using floating keyword.@startuml
start:foo1;floating note left: This is a note:foo2;note rightThis note is on several//lines// and cancontain <b>HTML</b>====* Calling the method ""foo()"" is prohibitedend notestop
@enduml
5.8 Colors
You can use specify a color for some activities.@startuml
start:starting progress;#HotPink:reading configuration filesThese files should edited at this point!;#AAAAAA:ending of the process;
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 68 of 121
5.9 Arrows 5 ACTIVITY DIAGRAM (BETA)
5.9 Arrows
Using the -> notation, you can add texts to arrow, and change their color.It’s also possible to have dotted, dashed, bold or hidden arrows.@startuml:foo1;-> You can put text on arrows;if (test) then-[#blue]->:foo2;-[#green,dashed]-> The text canalso be on several linesand **very** long...;:foo3;else-[#black,dotted]->:foo4;endif-[#gray,bold]->:foo5;@enduml
5.10 Connector
You can use parentheses to denote connector.@startumlstart:Some activity;(A)
PlantUML Language Reference Guide (Version 1.2018.1) 69 of 121
5.11 Grouping 5 ACTIVITY DIAGRAM (BETA)
detach(A):Other activity;@enduml
5.11 Grouping
You can group activity together by defining partition:@startumlstartpartition Initialization {:read config file;:init internal variable;}partition Running {:wait for user interaction;:print information;}
stop@enduml
5.12 Swimlanes
Using pipe |, you can define swimlanes.
PlantUML Language Reference Guide (Version 1.2018.1) 70 of 121
5.13 Detach 5 ACTIVITY DIAGRAM (BETA)
It’s also possible to change swimlanes color.@startuml|Swimlane1|start:foo1;|#AntiqueWhite|Swimlane2|:foo2;:foo3;|Swimlane1|:foo4;|Swimlane2|:foo5;stop@enduml
5.13 Detach
It’s possible to remove an arrow using the detach keyword.@startuml:start;fork:foo1;:foo2;fork again:foo3;detachendforkif (foo4) then:foo5;detachendif:foo6;detach:foo7;stop@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 71 of 121
5.14 SDL 5 ACTIVITY DIAGRAM (BETA)
5.14 SDL
By changing the final ; separator, you can set different rendering for the activity:
• |• <
• >
• /• ]• }
@startuml:Ready;:next(o)|:Receiving;split:nak(i)<:ack(o)>split again:ack(i)<:next(o)on several line|:i := i + 1]:ack(o)>split again:err(i)<:nak(o)>split again:foo/split again:i > 5}stopend split:finish;@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 72 of 121
5.15 Complete example 5 ACTIVITY DIAGRAM (BETA)
5.15 Complete example
@startuml
start:ClickServlet.handleRequest();:new page;if (Page.onSecurityCheck) then (true):Page.onInit();if (isForward?) then (no):Process controls;if (continue processing?) then (no)stopendif
if (isPost?) then (yes):Page.onPost();else (no):Page.onGet();endif:Page.onRender();endifelse (false)endif
if (do redirect?) then (yes):redirect process;elseif (do forward?) then (yes):Forward request;else (no):Render page template;endifendif
stop
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 73 of 121
5.15 Complete example 5 ACTIVITY DIAGRAM (BETA)
PlantUML Language Reference Guide (Version 1.2018.1) 74 of 121
6 COMPONENT DIAGRAM
6 Component Diagram
6.1 Components
Components must be bracketed.You can also use the component keyword to defines a component. And you can define an alias,using the as keyword. This alias will be used latter, when defining relations.@startuml
[First component][Another component] as Comp2component Comp3component [Last\ncomponent] as Comp4
@enduml
6.2 Interfaces
Interface can be defined using the () symbol (because this looks like a circle).You can also use the interface keyword to defines an interface. And you can define an alias, usingthe as keyword. This alias will be used latter, when defining relations.We will see latter that interface definition is optional.@startuml
() "First Interface"() "Another interface" as Interf2interface Interf3interface "Last\ninterface" as Interf4
@enduml
6.3 Basic example
Links between elements are made using combinations of dotted line (..), straight line (--), andarrows (-->) symbols.
PlantUML Language Reference Guide (Version 1.2018.1) 75 of 121
6.4 Using notes 6 COMPONENT DIAGRAM
@startuml
DataAccess - [First Component][First Component] ..> HTTP : use
@enduml
6.4 Using notes
You can use the note left of , note right of , note top of , note bottom of keywords todefine notes related to a single object.A note can be also define alone with the note keywords, then linked to other objects using the ..symbol.@startuml
interface "Data Access" as DA
DA - [First Component][First Component] ..> HTTP : use
note left of HTTP : Web Service only
note right of [First Component]A note can alsobe on several linesend note
@enduml
6.5 Grouping Components
You can use several keywords to group components and interfaces together:
• package• node
PlantUML Language Reference Guide (Version 1.2018.1) 76 of 121
6.5 Grouping Components 6 COMPONENT DIAGRAM
• folder• frame• cloud• database
@startuml
package "Some Group" {HTTP - [First Component][Another Component]}
node "Other Groups" {FTP - [Second Component][First Component] --> FTP}
cloud {[Example 1]}
database "MySql" {folder "This is my folder" {[Folder 3]}frame "Foo" {[Frame 4]}}
[Another Component] --> [Example 1][Example 1] --> [Folder 3][Folder 3] --> [Frame 4]
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 77 of 121
6.6 Changing arrows direction 6 COMPONENT DIAGRAM
6.6 Changing arrows direction
By default, links between classes have two dashes -- and are vertically oriented. It is possible touse horizontal link by putting a single dash (or dot) like this:@startuml[Component] --> Interface1[Component] -> Interface2@enduml
You can also change directions by reversing the link:@startumlInterface1 <-- [Component]Interface2 <- [Component]@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 78 of 121
6.7 Use UML2 notation 6 COMPONENT DIAGRAM
It is also possible to change arrow direction by adding left, right, up or down keywords inside thearrow:@startuml[Component] -left-> left[Component] -right-> right[Component] -up-> up[Component] -down-> down@enduml
You can shorten the arrow by using only the first character of the direction (for example, -d-instead of -down-) or the two first characters (-do-).Please note that you should not abuse this functionality : Graphviz gives usually good resultswithout tweaking.
6.7 Use UML2 notation
The skinparam componentStyle uml2 command is used to switch to UML2 notation.@startumlskinparam componentStyle uml2
interface "Data Access" as DA
DA - [First Component][First Component] ..> HTTP : use
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 79 of 121
6.8 Long description 6 COMPONENT DIAGRAM
6.8 Long description
It is possible to put description on several lines using square brackets.@startumlcomponent comp1 [This componenthas a long commenton several lines]@enduml
6.9 Individual colors
You can specify a color after component definition.@startumlcomponent [Web Server] #Yellow@enduml
6.10 Using Sprite in Stereotype
You can use sprites within stereotype components.@startumlsprite $businessProcess [16x16/16] {FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0FFFFFFFFFFFFFFF00FFFFFF00000000000FFFFF000000000000FFFF00000000000FFFFFFFFFFFFF00FFFFFFFFFFFFFF0FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
PlantUML Language Reference Guide (Version 1.2018.1) 80 of 121
6.11 Skinparam 6 COMPONENT DIAGRAM
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF}
rectangle " End to End\nbusiness process" <<$businessProcess>> {rectangle "inner process 1" <<$businessProcess>> as srcrectangle "inner process 2" <<$businessProcess>> as tgtsrc -> tgt}@enduml
6.11 Skinparam
You can use the skinparam command to change colors and fonts for the drawing.You can use this command :
• In the diagram definition, like any other commands,• In an included file,• In a configuration file, provided in the command line or the ANT task.
You can define specific color and fonts for stereotyped components and interfaces.@startuml
skinparam interface {backgroundColor RosyBrownborderColor orange}
skinparam component {FontSize 13BackgroundColor<<Apache>> RedBorderColor<<Apache>> #FF6655FontName CourierBorderColor blackBackgroundColor goldArrowFontName ImpactArrowColor #FF6655ArrowFontColor #777777}
() "Data Access" as DA
DA - [First Component][First Component] ..> () HTTP : useHTTP - [Web Server] << Apache >>
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 81 of 121
6.11 Skinparam 6 COMPONENT DIAGRAM
@startuml[AA] <<static lib>>[BB] <<shared lib>>[CC] <<static lib>>
node node1node node2 <<shared node>>database Production
skinparam component {backgroundColor<<static lib>> DarkKhakibackgroundColor<<shared lib>> Green}
skinparam node {borderColor GreenbackgroundColor YellowbackgroundColor<<shared node>> Magenta}skinparam databaseBackgroundColor Aqua
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 82 of 121
7 STATE DIAGRAM
7 State Diagram
7.1 Simple State
You can use [*] for the starting point and ending point of the state diagram.Use --> for arrows.@startuml
[*] --> State1State1 --> [*]State1 : this is a stringState1 : this is another string
State1 -> State2State2 --> [*]
@enduml
7.2 Composite state
A state can also be composite. You have to define it using the state keywords and brackets.@startumlscale 350 width[*] --> NotShooting
state NotShooting {[*] --> IdleIdle --> Configuring : EvConfigConfiguring --> Idle : EvConfig}
state Configuring {[*] --> NewValueSelectionNewValueSelection --> NewValuePreview : EvNewValueNewValuePreview --> NewValueSelection : EvNewValueRejectedNewValuePreview --> NewValueSelection : EvNewValueSaved
state NewValuePreview {State1 -> State2}
}@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 83 of 121
7.3 Long name 7 STATE DIAGRAM
7.3 Long name
You can also use the state keyword to use long description for states.@startumlscale 600 width
[*] -> State1State1 --> State2 : SucceededState1 --> [*] : AbortedState2 --> State3 : SucceededState2 --> [*] : Abortedstate State3 {state "Accumulate Enough Data\nLong State Name" as long1long1 : Just a test[*] --> long1long1 --> long1 : New Datalong1 --> ProcessData : Enough Data}State3 --> State3 : FailedState3 --> [*] : Succeeded / Save ResultState3 --> [*] : Aborted
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 84 of 121
7.4 Concurrent state 7 STATE DIAGRAM
7.4 Concurrent state
You can define concurrent state into a composite state using either -- or || symbol as separator.@startuml[*] --> Active
state Active {[*] -> NumLockOffNumLockOff --> NumLockOn : EvNumLockPressedNumLockOn --> NumLockOff : EvNumLockPressed--[*] -> CapsLockOffCapsLockOff --> CapsLockOn : EvCapsLockPressedCapsLockOn --> CapsLockOff : EvCapsLockPressed--[*] -> ScrollLockOffScrollLockOff --> ScrollLockOn : EvCapsLockPressedScrollLockOn --> ScrollLockOff : EvCapsLockPressed}
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 85 of 121
7.5 Arrow direction 7 STATE DIAGRAM
7.5 Arrow direction
You can use -> for horizontal arrows. It is possible to force arrow’s direction using the followingsyntax:
• -down-> (default arrow)• -right-> or ->• -left->• -up->
@startuml
[*] -up-> FirstFirst -right-> SecondSecond --> ThirdThird -left-> Last
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 86 of 121
7.6 Note 7 STATE DIAGRAM
You can shorten the arrow by using only the first character of the direction (for example, -d-instead of -down-) or the two first characters (-do-).Please note that you should not abuse this functionality : Graphviz gives usually good resultswithout tweaking.
7.6 Note
You can also define notes using note left of, note right of, note top of, note bottom ofkeywords.You can also define notes on several lines.@startuml
[*] --> ActiveActive --> Inactive
note left of Active : this is a short\nnote
note right of InactiveA note can alsobe defined onseveral linesend note
@enduml
You can also have floating notes.@startuml
state foonote "This is a floating note" as N1
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 87 of 121
7.7 More in notes 7 STATE DIAGRAM
7.7 More in notes
You can put notes on composite states.@startuml
[*] --> NotShooting
state "Not Shooting State" as NotShooting {state "Idle mode" as Idlestate "Configuring mode" as Configuring[*] --> IdleIdle --> Configuring : EvConfigConfiguring --> Idle : EvConfig}
note right of NotShooting : This is a note on a composite state
@enduml
7.8 Skinparam
You can use the skinparam command to change colors and fonts for the drawing.You can use this command :
• In the diagram definition, like any other commands,• In an included file,• In a configuration file, provided in the command line or the ANT task.
You can define specific color and fonts for stereotyped states.@startumlskinparam backgroundColor LightYellowskinparam state {StartColor MediumBlueEndColor RedBackgroundColor PeruBackgroundColor<<Warning>> OliveBorderColor GrayFontName Impact}
[*] --> NotShooting
state "Not Shooting State" as NotShooting {
PlantUML Language Reference Guide (Version 1.2018.1) 88 of 121
7.8 Skinparam 7 STATE DIAGRAM
state "Idle mode" as Idle <<Warning>>state "Configuring mode" as Configuring[*] --> IdleIdle --> Configuring : EvConfigConfiguring --> Idle : EvConfig}
NotShooting --> [*]@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 89 of 121
8 OBJECT DIAGRAM
8 Object Diagram
8.1 Definition of objects
You define instance of objects using the object keywords.@startumlobject firstObjectobject "My Second Object" as o2@enduml
8.2 Relations between objects
Relations between objects are defined using the following symbols :Extension <|--Composition *--Aggregation o--
It is possible to replace -- by .. to have a dotted line.Knowing those rules, it is possible to draw the following drawings.It is possible a add a label on the relation, using ” : ”, followed by the text of the label.For cardinality, you can use double-quotes "" on each side of the relation.@startumlobject Object01object Object02object Object03object Object04object Object05object Object06object Object07object Object08
Object01 <|-- Object02Object03 *-- Object04Object05 o-- "4" Object06Object07 .. Object08 : some labels@enduml
8.3 Adding fields
To declare fields, you can use the symbol ":" followed by the field’s name.@startuml
object user
user : name = "Dummy"user : id = 123
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 90 of 121
8.4 Common features with class diagrams 8 OBJECT DIAGRAM
It is also possible to ground between brackets {} all fields.@startuml
object user {name = "Dummy"id = 123}
@enduml
8.4 Common features with class diagrams• Visibility• Defines notes• Use packages• Skin the output
PlantUML Language Reference Guide (Version 1.2018.1) 91 of 121
9 COMMON COMMANDS
9 Common commands
9.1 Footer and header
You can use the commands header or footer to add a footer or a header on any generated diagram.You can optionally specify if you want a center, left or right footer/header, by adding a keyword.As for title, it is possible to define a header or a footer on several lines.It is also possible to put some HTML into the header or footer.@startumlAlice -> Bob: Authentication Request
header<font color=red>Warning:</font>Do not use in production.endheader
center footer Generated for demonstration
@enduml
9.2 Zoom
You can use the scale command to zoom the generated image.You can use either a number or a fraction to define the scale factor. You can also specify eitherwidth or height (in pixel). And you can also give both width and height : the image is scaled to fitinside the specified dimension.
• scale 1.5• scale 2/3• scale 200 width• scale 200 height• scale 200*100• scale max 300*200
@startumlscale 180*90Bob->Alice : hello@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 92 of 121
10 SALT
10 Salt
Salt is a subproject included in PlantUML that may help you to design graphical interface.You can use either @startsalt keyword, or @startuml followed by a line with salt keyword.
10.1 Basic widgets
A window must start and end with brackets. You can then define:
• Button using [ and ].• Radio button using ( and ).• Checkbox using [ and ].• User text area using ".
@startumlsalt{Just plain text[This is my button]() Unchecked radio(X) Checked radio[] Unchecked box[X] Checked box"Enter text here "^This is a droplist^}@enduml
The goal of this tool is to discuss about simple and sample windows.
10.2 Using grid
A table is automatically created when you use an opening bracket {.And you have to use | to separate columns.For example:@startsalt{Login | "MyName "Password | "**** "[Cancel] | [ OK ]}@endsalt
PlantUML Language Reference Guide (Version 1.2018.1) 93 of 121
10.3 Using separator 10 SALT
Just after the opening bracket, you can use a character to define if you want to draw lines or columnsof the grid :# To display all vertical and horizontal lines! To display all vertical lines- To display all horizontal lines+ To display external lines@startsalt{+Login | "MyName "Password | "**** "[Cancel] | [ OK ]}@endsalt
10.3 Using separator
You can use several horizontal lines as separator.@startsalt{Text1.."Some field"==Note on usage~~Another text--[Ok]}@endsalt
10.4 Tree widget
To have a Tree, you have to start with {T and to use + to denote hierarchy.@startsalt{{T+ World++ America+++ Canada+++ USA++++ New York++++ Boston+++ Mexico++ Europe+++ Italy+++ Germany
PlantUML Language Reference Guide (Version 1.2018.1) 94 of 121
10.5 Enclosing brackets 10 SALT
++++ Berlin++ Africa}}@endsalt
10.5 Enclosing brackets
You can define subelements by opening a new opening bracket.@startsalt{Name | " "Modifiers: | { (X) public | () default | () private | () protected[] abstract | [] final | [] static }Superclass: | { "java.lang.Object " | [Browse...] }}@endsalt
10.6 Adding tabs
You can add tabs using {/ notation. Note that you can use HTML code to have bold text.@startsalt{+{/ <b>General | Fullscreen | Behavior | Saving }{{ Open image in: | ^Smart Mode^ }[X] Smooth images when zoomed[X] Confirm image deletion[ ] Show hidden images}[Close]}@endsalt
Tab could also be vertically oriented:
PlantUML Language Reference Guide (Version 1.2018.1) 95 of 121
10.7 Using menu 10 SALT
@startsalt{+{/ <b>GeneralFullscreenBehaviorSaving } |{{ Open image in: | ^Smart Mode^ }[X] Smooth images when zoomed[X] Confirm image deletion[ ] Show hidden images[Close]}}@endsalt
10.7 Using menu
You can add a menu by using {* notation.@startsalt{+{* File | Edit | Source | Refactor }{/ General | Fullscreen | Behavior | Saving }{{ Open image in: | ^Smart Mode^ }[X] Smooth images when zoomed[X] Confirm image deletion[ ] Show hidden images}[Close]}@endsalt
It is also possible to open a menu:@startsalt{+{* File | Edit | Source | RefactorRefactor | New | Open File | - | Close | Close All }{/ General | Fullscreen | Behavior | Saving }{{ Open image in: | ^Smart Mode^ }[X] Smooth images when zoomed[X] Confirm image deletion[ ] Show hidden images}[Close]}@endsalt
PlantUML Language Reference Guide (Version 1.2018.1) 96 of 121
10.8 Advanced table 10 SALT
10.8 Advanced table
You can use two special notations for table :
• * to indicate that a cell with span with left• . to denotate an empty cell
@startsalt{#. | Column 2 | Column 3Row header 1 | value 1 | value 2Row header 2 | A long cell | *}@endsalt
PlantUML Language Reference Guide (Version 1.2018.1) 97 of 121
11 CREOLE
11 Creole
A light Creole engine have been integrated into PlantUML to have a standardized way of definingtext style.All diagrams are now supporting this syntax.Note that ascending compatibility with HTML syntax is preserved.
11.1 Emphasized text
@startumlAlice -> Bob : hello --there--... Some ~~long delay~~ ...Bob -> Alice : oknote leftThis is **bold**This is //italics//This is ""monospaced""This is --stroked--This is __underlined__This is ~~waved~~end note@enduml
11.2 List
@startumlobject demo {* Bullet list* Second item** Sub item}
legend# Numbered list# Second item## Sub item## Another sub item# Third itemend legend@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 98 of 121
11.3 Escape character 11 CREOLE
11.3 Escape character
You can use the tilde ~ to escape special creole characters.@startumlobject demo {This is not ~___underscored__.This is not ~""monospaced"".}@enduml
11.4 Horizontal lines
@startumldatabase DB1 as "You can have horizontal line----Or double line====Or strong line____Or dotted line..My title..Enjoy!"note rightThis is working also in notesYou can also add title in all these lines==Title==--Another title--end note
@enduml
11.5 Headings
@startumlusecase UC1 as "= Extra-large headingSome text== Large headingOther text=== Medium headingInformation....==== Small heading"@enduml
11.6 Legacy HTML
Some HTML tags are also working:
• <b> for bold text• <u> or <u:#AAAAAA> or <u:colorName> for underline• <i> for italic• <s> or <s:#AAAAAA> or <s:colorName> for strike text
PlantUML Language Reference Guide (Version 1.2018.1) 99 of 121
11.7 Table 11 CREOLE
• <w> or <w:#AAAAAA> or <w:colorName> for wave underline text• <color:#AAAAAA> or <color:colorName>• <back:#AAAAAA> or <back:colorName> for background color• <size:nn> to change font size• <img:file> : the file must be accessible by the filesystem• <img:http://url> : the URL must be available from the Internet
@startuml:* You can change <color:red>text color</color>* You can change <back:cadetblue>background color</back>* You can change <size:18>size</size>* You use <u>legacy</u> <b>HTML <i>tag</i></b>* You use <u:red>color</u> <s:green>in HTML</s> <w:#0000FF>tag</w>----* Use image : <img:sourceforge.jpg>;
@enduml
11.7 Table@startumlskinparam titleFontSize 14titleExample of simple table|= |= table |= header || a | table | row || b | table | row |end title[*] --> State1@enduml
11.8 Tree
You can use |_ characters to build a tree.@startumlskinparam titleFontSize 14titleExample of Tree|_ First line|_ **Bom(Model)**|_ prop1|_ prop2|_ prop3|_ Last lineend title[*] --> State1@enduml
11.9 Special characters
It’s possible to use any unicode characters with &# syntax or <U+XXXX>startumlusecase foo as "this is ∞ long"usecase bar as "this is also <U+221E> long"enduml
PlantUML Language Reference Guide (Version 1.2018.1) 100 of 121
11.10 OpenIconic 11 CREOLE
11.10 OpenIconic
OpenIconic is an very nice open source icon set. Those icons have been integrated into the creoleparser, so you can use them out-of-the-box.You can use the following syntax: <&ICON_NAME>.@startumltitle: <size:20><&heart>Use of OpenIconic <&heart></size>class Wifinote leftClick on <&wifi>end note@enduml
The complete list is available on OpenIconic Website, or you can use the following special diagram:@startumllistopeniconic@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 101 of 121
11.11 Defining and using sprites 11 CREOLE
11.11 Defining and using sprites
A Sprite is a small graphic element that can be used in diagrams.In PlantUML, sprites are monochrome and can have either 4, 8 or 16 gray level.To define a sprite, you have to use a hexadecimal digit between 0 and F per pixel.Then you can use the sprite using <$XXX> where XXX is the name of the sprite.@startumlsprite $foo1 {FFFFFFFFFFFFFFFF0123456789ABCFF0123456789ABCFF0123456789ABCFF0123456789ABCFF0123456789ABCFF0123456789ABCFF0123456789ABCFF0123456789ABCFFFFFFFFFFFFFFFF}Alice -> Bob : Testing <$foo1>@enduml
11.12 Encoding Sprite
To encode sprite, you can use the command line like:
java -jar plantuml.jar -encodesprite 16z foo.png
where foo.png if the image file you want to use (it will be converted to gray automatically).After -encodesprite, you have to specify a format: 4, 8, 16, 4z, 8z or 16z.The number indicates the gray level and the optionnal z is used to enable compression in spritedefinition.
11.13 Importing Sprite
You can also launch the GUI to generate a sprite from an existing image.Click in the menubar then on File/Open Sprite Window.
After copying an image into you clipboard, several possible definitions of the corresponding spritewill be displayed : you will just have to pickup the one you want.
11.14 Examples
@startumlsprite $printer [15x15/8z] NOtH3W0W208HxFz_kMAhj7lHWpa1XC716sz0Pq4MVPEWfBHIuxP3L6kbTcizR8tAhzaqFvXwvFfPEqm0start:click on <$printer> to print the page;@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 102 of 121
11.14 Examples 11 CREOLE
@startumlsprite $bug [15x15/16z] PKzR2i0m2BFMi15p__FEjQEqB1z27aeqCqixa8S4OT7C53cKpsHpaYPDJY_12MHM -BLRyywPhrrlw3qumqNThmXgd1TOterAZmOW8sgiJafogofWRwtV3nCFsprite $printer [15x15/8z] NOtH3W0W208HxFz_kMAhj7lHWpa1XC716sz0Pq4MVPEWfBHIuxP3L6kbTcizR8tAhzaqFvXwvFfPEqm0sprite $disk {44444556667788143600000000999143600000000ACA153700000001A7A153700000012B8A153800000123B8A163800001233C9A1634999AABBC99B1744566778899AB17456AAAAA99AAB18566AFC228AABB18567AC8118BBBB1867BD4433BBBBB139AAAAABBBBBBC1}
title Use of sprites (<$printer>, <$bug>...)
class Example {Can have some bug : <$bug>Click on <$disk> to save}
note left : The printer <$printer> is available
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 103 of 121
12 CHANGING FONTS AND COLORS
12 Changing fonts and colors
12.1 Usage
You can change colors and font of the drawing using the skinparam command. Example:skinparam backgroundColor yellow
You can use this command :
• In the diagram definition, like any other commands,• In an included file (see Preprocessing),• In a configuration file, provided in the command line or the ANT task.
12.2 Nested
To avoid repetition, it is possible to nest definition. So the following definition :skinparam xxxxParam1 value1skinparam xxxxParam2 value2skinparam xxxxParam3 value3skinparam xxxxParam4 value4
is strictly equivalent to:skinparam xxxx {
Param1 value1Param2 value2Param3 value3Param4 value4
}
PlantUML Language Reference Guide (Version 1.2018.1) 104 of 121
12.3 Color 12 CHANGING FONTS AND COLORS
12.3 Color
You can use either standard color name or RGB code.
Parameter name Default Color CommentValue
backgroundColor white Background of the pageactivityArrowColor #A80036 Color of arrows in activity diagramsactivityBackgroundColor #FEFECE Background of activitiesactivityBorderColor #A80036 Color of activity bordersactivityStartColor black Starting circle in activity diagramsactivityEndColor black Ending circle in activity diagramsactivityBarColor black Synchronization bar in activity diagramsusecaseArrowColor #A80036 Color of arrows in usecase diagramsusecaseActorBackgroundColor #FEFECE Head’s color of actor in usecase diagramsusecaseActorBorderColor #A80036 Color of actor borders in usecase diagramsusecaseBackgroundColor #FEFECE Background of usecasesusecaseBorderColor #A80036 Color of usecase borders in usecase diagramsclassArrowColor #A80036 Color of arrows in class diagramsclassBackgroundColor #FEFECE Background of classes/interface/enum in class diagramsclassBorderColor #A80036 Borders of classes/interface/enum in class diagramspackageBackgroundColor #FEFECE Background of packages in class diagramspackageBorderColor #A80036 Borders of packages in class diagramsstereotypeCBackgroundColor #ADD1B2 Background of class spots in class diagramsstereotypeABackgroundColor #A9DCDF Background of abstract class spots in class diagramsstereotypeIBackgroundColor #B4A7E5 Background of interface spots in class diagramsstereotypeEBackgroundColor #EB937F Background of enum spots in class diagramscomponentArrowColor #A80036 Color of arrows in component diagramscomponentBackgroundColor #FEFECE Background of componentscomponentBorderColor #A80036 Borders of componentscomponentInterfaceBackgroundColor #FEFECE Background of interface in component diagramscomponentInterfaceBorderColor #A80036 Border of interface in component diagramsnoteBackgroundColor #FBFB77 Background of notesnoteBorderColor #A80036 Border of notesstateBackgroundColor #FEFECE Background of states in state diagramsstateBorderColor #A80036 Border of states in state diagramsstateArrowColor #A80036 Colors of arrows in state diagramsstateStartColor black Starting circle in state diagramsstateEndColor black Ending circle in state diagramssequenceArrowColor #A80036 Color of arrows in sequence diagramssequenceActorBackgroundColor #FEFECE Head’s color of actor in sequence diagramssequenceActorBorderColor #A80036 Border of actor in sequence diagramssequenceGroupBackgroundColor #EEEEEE Header color of alt/opt/loop in sequence diagramssequenceLifeLineBackgroundColor white Background of life line in sequence diagramssequenceLifeLineBorderColor #A80036 Border of life line in sequence diagramssequenceParticipantBackgroundColor #FEFECE Background of participant in sequence diagramssequenceParticipantBorderColor #A80036 Border of participant in sequence diagrams
PlantUML Language Reference Guide (Version 1.2018.1) 105 of 121
12.4 Font color, name and size 12 CHANGING FONTS AND COLORS
12.4 Font color, name and size
You can change the font for the drawing using xxxFontColor, xxxFontSize and xxxFontNameparameters.Example:skinparam classFontColor redskinparam classFontSize 10skinparam classFontName Aapex
You can also change the default font for all fonts using skinparam defaultFontName.Example:skinparam defaultFontName Aapex
Please note the fontname is highly system dependent, so do not over use it, if you look for portability.
Parameter Default CommentName ValueactivityFontColor black
Used for activity boxactivityFontSize 14activityFontStyle plainactivityFontNameactivityArrowFontColor black
Used for text on arrows in activity diagramsactivityArrowFontSize 13activityArrowFontStyle plainactivityArrowFontNamecircledCharacterFontColor black
Used for text in circle for class, enum and otherscircledCharacterFontSize 17circledCharacterFontStyle boldcircledCharacterFontName CouriercircledCharacterRadius 11classArrowFontColor black
Used for text on arrows in class diagramsclassArrowFontSize 10classArrowFontStyle plainclassArrowFontNameclassAttributeFontColor black
Class attributes and methodsclassAttributeFontSize 10classAttributeIconSize 10classAttributeFontStyle plainclassAttributeFontNameclassFontColor black
Used for classes nameclassFontSize 12classFontStyle plainclassFontNameclassStereotypeFontColor black
Used for stereotype in classesclassStereotypeFontSize 12classStereotypeFontStyle italicclassStereotypeFontNamecomponentFontColor black
Used for components namecomponentFontSize 14componentFontStyle plaincomponentFontNamecomponentStereotypeFontColor black
Used for stereotype in componentscomponentStereotypeFontSize 14componentStereotypeFontStyle italiccomponentStereotypeFontName
PlantUML Language Reference Guide (Version 1.2018.1) 106 of 121
12.4 Font color, name and size 12 CHANGING FONTS AND COLORS
componentArrowFontColor black
Used for text on arrows in component diagramscomponentArrowFontSize 13componentArrowFontStyle plaincomponentArrowFontNamenoteFontColor black
Used for notes in all diagrams but sequence diagramsnoteFontSize 13noteFontStyle plainnoteFontNamepackageFontColor black
Used for package and partition namespackageFontSize 14packageFontStyle plainpackageFontNamesequenceActorFontColor black
Used for actor in sequence diagramssequenceActorFontSize 13sequenceActorFontStyle plainsequenceActorFontNamesequenceDividerFontColor black
Used for text on dividers in sequence diagramssequenceDividerFontSize 13sequenceDividerFontStyle boldsequenceDividerFontNamesequenceArrowFontColor black
Used for text on arrows in sequence diagramssequenceArrowFontSize 13sequenceArrowFontStyle plainsequenceArrowFontNamesequenceGroupingFontColor black
Used for text for ”else” in sequence diagramssequenceGroupingFontSize 11sequenceGroupingFontStyle plainsequenceGroupingFontNamesequenceGroupingHeaderFontColor black
Used for text for ”alt/opt/loop” headers in sequence diagramssequenceGroupingHeaderFontSize 13sequenceGroupingHeaderFontStyle plainsequenceGroupingHeaderFontNamesequenceParticipantFontColor black
Used for text on participant in sequence diagramssequenceParticipantFontSize 13sequenceParticipantFontStyle plainsequenceParticipantFontNamesequenceTitleFontColor black
Used for titles in sequence diagramssequenceTitleFontSize 13sequenceTitleFontStyle plainsequenceTitleFontNametitleFontColor black
Used for titles in all diagrams but sequence diagramstitleFontSize 18titleFontStyle plaintitleFontNamestateFontColor black
Used for states in state diagramsstateFontSize 14stateFontStyle plainstateFontNamestateArrowFontColor black
Used for text on arrows in state diagramsstateArrowFontSize 13stateArrowFontStyle plainstateArrowFontNamestateAttributeFontColor black
Used for states description in state diagramsstateAttributeFontSize 12stateAttributeFontStyle plainstateAttributeFontName
PlantUML Language Reference Guide (Version 1.2018.1) 107 of 121
12.4 Font color, name and size 12 CHANGING FONTS AND COLORS
usecaseFontColor black
Used for usecase labels in usecase diagramsusecaseFontSize 14usecaseFontStyle plainusecaseFontNameusecaseStereotypeFontColor black
Used for stereotype in usecaseusecaseStereotypeFontSize 14usecaseStereotypeFontStyle italicusecaseStereotypeFontNameusecaseActorFontColor black
Used for actor labels in usecase diagramsusecaseActorFontSize 14usecaseActorFontStyle plainusecaseActorFontNameusecaseActorStereotypeFontColor black
Used for stereotype for actorusecaseActorStereotypeFontSize 14usecaseActorStereotypeFontStyle italicusecaseActorStereotypeFontNameusecaseArrowFontColor black
Used for text on arrows in usecase diagramsusecaseArrowFontSize 13usecaseArrowFontStyle plainusecaseArrowFontNamefooterFontColor black
Used for footerfooterFontSize 10footerFontStyle plainfooterFontNameheaderFontColor black
Used for headerheaderFontSize 10headerFontStyle plainheaderFontName
PlantUML Language Reference Guide (Version 1.2018.1) 108 of 121
12.5 Black and White 12 CHANGING FONTS AND COLORS
12.5 Black and White
You can force the use of a black white output using the skinparam monochrome true command.@startumlskinparam monochrome true
actor Userparticipant "First Class" as Aparticipant "Second Class" as Bparticipant "Last Class" as C
User -> A: DoWorkactivate A
A -> B: Create Requestactivate B
B -> C: DoWorkactivate CC --> B: WorkDonedestroy C
B --> A: Request Createddeactivate B
A --> User: Donedeactivate A
@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 109 of 121
13 PREPROCESSING
13 Preprocessing
Some minor preprocessing capabilities are included in PlantUML, and available for all diagrams.Those functionnalities are very similar to the C language preprocessor, except that the specialcharacter (#) has been changed to the exclamation mark (!).
13.1 Including files
Use the !include directive to include file in your diagram.Imagine you have the very same class that appears in many diagrams. Instead of duplicating thedescription of this class, you can define a file that contains the description.@startuml!include List.iumlList <|.. ArrayList@enduml
File List.iuml: interface List List : int size() List : void clear()The file List.iuml can be included in many diagrams, and any modification in this file will changeall diagrams that include it.You can also put several @startuml/@enduml text block in an included file and then specify whichblock you want to include adding !0 where 0 is the block number.For example, if you use !include foo.txt!1, the second @startuml/@enduml block within foo.txtwill be included.You can also put an id to some @startuml/@enduml text block in an included file using @startuml(id=MY_OWN_ID)syntax and then include the block adding !MY_OWN_ID when including the file, so using somethinglike !include foo.txt!MY_OWN_ID.
13.2 Including URL
Use the !includeurl directive to include file from Internet/Intranet in your diagram.You can also use !includeurl http://someurl.com/mypath!0 to specify which @startuml/@endumlblock from http://someurl.com/mypath you want to include. The !0 notation denotes the firstdiagram.
13.3 Constant definition
You can define constant using the !define directive. As in C language, a constant name can onlyuse alphanumeric and underscore characters, and cannot start with a digit.@startuml
!define SEQUENCE (S,#AAAAAA) Database Sequence!define TABLE (T,#FFAAAA) Database Table
PlantUML Language Reference Guide (Version 1.2018.1) 110 of 121
13.4 Macro definition 13 PREPROCESSING
class USER << TABLE >>class ACCOUNT << TABLE >>class UID << SEQUENCE >>USER "1" -- "*" ACCOUNTUSER -> UID@enduml
Of course, you can use the !include directive to define all your constants in a single file that youinclude in your diagram.Constant can be undefined with the !undef XXX directive.You can also specify constants within the command line, with the -D flags.
java -jar plantuml.jar -DTITLE="My title" atest1.txt
Note that the -D flag must be put after the ”-jar plantuml.jar” section.
13.4 Macro definition
You can also define macro with arguments.@startuml
!define module(x) component x <<module>>module(ABC)module(XYZ)@enduml
Macro can have several arguments.@startuml!define send(a,b,c) a->b : csend(Alice, Bob, Hello)send(Bob, Alice, ok)@enduml
13.5 Macro on several lines
You can also define macro on several lines using !definelong and !enddefinelong.@startuml!define DOUBLE(x) x x!definelong AUTHEN(x,y)x -> y : DOUBLE(hello)y -> x : ok!enddefinelong
AUTHEN(Bob,Alice)@enduml
PlantUML Language Reference Guide (Version 1.2018.1) 111 of 121
13.6 Conditions 13 PREPROCESSING
13.6 Conditions
You can use !ifdef XXX and !endif directives to have conditionnal drawings.The lines between those two directives will be included only if the constant after the !ifdef directivehas been defined before.You can also provide a !else part which will be included if the constant has not been defined.@startuml!include ArrayList.iuml@enduml
File ArrayList.iuml:
class ArrayList!ifdef SHOW_METHODSArrayList : int size()ArrayList : void clear()!endif
You can then use the !define directive to activate the conditionnal part of the diagram.@startuml!define SHOW_METHODS!include ArrayList.iuml@enduml
You can also use the !ifndef directive that includes lines if the provided constant has NOT beendefined.
13.7 Search path
You can specify the java property ”plantuml.include.path” in the command line.For example:
java -Dplantuml.include.path="c:/mydir" -jar plantuml.jar atest1.txt
Note the this -D option has to put before the -jar option. -D options after the -jar option will beused to define constants within plantuml preprocessor.
13.8 Advanced features
It is possible to append text to a macro argument using the ## syntax.@startuml!definelong COMP_TEXTGENCOMP(name)[name] << Comp >>interface Ifc << IfcType >> AS name##Ifcname##Ifc - [name]!enddefinelongCOMP_TEXTGENCOMP(dummy)@enduml
A macro can be defined by another macro.
PlantUML Language Reference Guide (Version 1.2018.1) 112 of 121
13.8 Advanced features 13 PREPROCESSING
@startuml!define DOUBLE(x) x x!definelong AUTHEN(x,y)x -> y : DOUBLE(hello)y -> x : ok!enddefinelongAUTHEN(Bob,Alice)@enduml
A macro can be polymorphic with argument count.@startuml!define module(x) component x <<module>>!define module(x,y) component x as y <<module>>module(foo)module(bar, barcode)@enduml
You can use system environment variable or constant definition when using include:
!include %windir%/test1.txt!define PLANTUML_HOME /home/foo!include PLANTUML_HOME/test1.txt
PlantUML Language Reference Guide (Version 1.2018.1) 113 of 121
14 INTERNATIONALIZATION
14 InternationalizationThe PlantUML language use letters to define actor, usecase and so on. But letters are not only A-Zlatin characters, it could be any kind of letter from any language.
@startumlskinparam backgroundColor #EEEBDCactor 使用者participant "頭等艙 " as Aparticipant "第二類 " as Bparticipant "最後一堂課 " as 別的東西使用者 -> A: 完成這項工作activate AA -> B: 創建請求activate BB -> 別的東西 : 創建請求activate 別的東西別的東西 --> B: 這項工作完成destroy 別的東西B --> A: 請求創建deactivate BA --> 使用者 : 做完deactivate A@enduml
14.1 Charset
The default charset used when reading the text files containing the UML text description is systemdependent. Normally, it should just be fine, but in some case, you may want to the use anothercharset. For example, with the command line:java -jar plantuml.jar -charset UTF-8 files.txt
Or, with the ant task:
PlantUML Language Reference Guide (Version 1.2018.1) 114 of 121
14.1 Charset 14 INTERNATIONALIZATION
<target name="main"><plantuml dir="./src" charset="UTF-8" /></target>
Depending of your Java installation, the following charset should be available: ISO-8859-1, UTF-8,UTF-16BE, UTF-16LE, UTF-16.
PlantUML Language Reference Guide (Version 1.2018.1) 115 of 121
15 COLOR NAMES
15 Color Names
Here is the list of colors recognized by PlantUML. Note that color names are case insensitive.
AliceBlue GhostWhite NavajoWhiteAntiqueWhite GoldenRod NavyAquamarine Gold OldLaceAqua Gray OliveDrabAzure GreenYellow OliveBeige Green OrangeRedBisque HoneyDew OrangeBlack HotPink OrchidBlanchedAlmond IndianRed PaleGoldenRodBlueViolet Indigo PaleGreenBlue Ivory PaleTurquoiseBrown Khaki PaleVioletRedBurlyWood LavenderBlush PapayaWhipCadetBlue Lavender PeachPuffChartreuse LawnGreen PeruChocolate LemonChiffon PinkCoral LightBlue PlumCornflowerBlue LightCoral PowderBlueCornsilk LightCyan PurpleCrimson LightGoldenRodYellow RedCyan LightGreen RosyBrownDarkBlue LightGray RoyalBlueDarkCyan LightPink SaddleBrownDarkGoldenRod LightSalmon SalmonDarkGray LightSeaGreen SandyBrownDarkGreen LightSkyBlue SeaGreenDarkKhaki LightSlateGray SeaShellDarkMagenta LightSteelBlue SiennaDarkOliveGreen LightYellow SilverDarkOrchid LimeGreen SkyBlueDarkRed Lime SlateBlueDarkSalmon Linen SlateGrayDarkSeaGreen Magenta SnowDarkSlateBlue Maroon SpringGreenDarkSlateGray MediumAquaMarine SteelBlueDarkTurquoise MediumBlue TanDarkViolet MediumOrchid TealDarkorange MediumPurple ThistleDeepPink MediumSeaGreen TomatoDeepSkyBlue MediumSlateBlue TurquoiseDimGray MediumSpringGreen VioletDodgerBlue MediumTurquoise WheatFireBrick MediumVioletRed WhiteSmokeFloralWhite MidnightBlue WhiteForestGreen MintCream YellowGreenFuchsia MistyRose YellowGainsboro Moccasin
PlantUML Language Reference Guide (Version 1.2018.1) 116 of 121
CONTENTS CONTENTS
Contents
1 Sequence Diagram 11.1 Basic examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.2 Declaring participant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.3 Use non-letters in participants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4 Message to Self . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.5 Change arrow style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.6 Change arrow color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.7 Message sequence numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.8 Splitting diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.9 Grouping message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.10 Notes on messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.11 Some other notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.12 Changing notes shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.13 Creole and HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.14 Divider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111.15 Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.16 Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.17 Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.18 Lifeline Activation and Destruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.19 Participant creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.20 Incoming and outgoing messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.21 Stereotypes and Spots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.22 More information on titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171.23 Participants encompass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.24 Removing Footer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.25 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.26 Changing padding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2 Use Case Diagram 232.1 Usecases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232.2 Actors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232.3 Usecases description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232.4 Basic example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.5 Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.6 Using notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252.7 Stereotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.8 Changing arrows direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.9 Splitting diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282.10 Left to right direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282.11 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292.12 Complete example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
PlantUML Language Reference Guide (Version 1.2018.1) 117 of 121
CONTENTS CONTENTS
3 Class Diagram 313.1 Relations between classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313.2 Label on relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323.3 Adding methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333.4 Defining visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343.5 Abstract and Static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353.6 Advanced class body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363.7 Notes and stereotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373.8 More on notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383.9 Note on links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393.10 Abstract class and interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403.11 Using non-letters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413.12 Hide attributes, methods... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423.13 Hide classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433.14 Use generics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433.15 Specific Spot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433.16 Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443.17 Packages style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443.18 Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453.19 Automatic namespace creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463.20 Lollipop interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473.21 Changing arrows direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473.22 Association classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483.23 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493.24 Skinned Stereotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503.25 Color gradient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503.26 Help on layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513.27 Splitting large files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4 Activity Diagram 544.1 Simple Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544.2 Label on arrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544.3 Changing arrow direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544.4 Branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554.5 More on Branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564.6 Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574.7 Long activity description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584.8 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584.9 Partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594.10 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604.11 Octagon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614.12 Complete example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
PlantUML Language Reference Guide (Version 1.2018.1) 118 of 121
CONTENTS CONTENTS
5 Activity Diagram (beta) 645.1 Simple Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645.2 Start/Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645.3 Conditional . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655.4 Repeat loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665.5 While loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665.6 Parallel processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675.7 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685.8 Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685.9 Arrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695.10 Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695.11 Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705.12 Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705.13 Detach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715.14 SDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725.15 Complete example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
6 Component Diagram 756.1 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756.2 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756.3 Basic example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756.4 Using notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766.5 Grouping Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766.6 Changing arrows direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786.7 Use UML2 notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796.8 Long description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806.9 Individual colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806.10 Using Sprite in Stereotype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806.11 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
7 State Diagram 837.1 Simple State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837.2 Composite state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837.3 Long name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847.4 Concurrent state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857.5 Arrow direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867.6 Note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877.7 More in notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887.8 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
8 Object Diagram 908.1 Definition of objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908.2 Relations between objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908.3 Adding fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908.4 Common features with class diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . 91
PlantUML Language Reference Guide (Version 1.2018.1) 119 of 121
CONTENTS CONTENTS
9 Common commands 929.1 Footer and header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929.2 Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
10 Salt 9310.1 Basic widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9310.2 Using grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9310.3 Using separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9410.4 Tree widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9410.5 Enclosing brackets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9510.6 Adding tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9510.7 Using menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9610.8 Advanced table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
11 Creole 9811.1 Emphasized text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9811.2 List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9811.3 Escape character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9911.4 Horizontal lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9911.5 Headings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9911.6 Legacy HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9911.7 Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10011.8 Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10011.9 Special characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10011.10OpenIconic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10111.11Defining and using sprites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10211.12Encoding Sprite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10211.13Importing Sprite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10211.14Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
12 Changing fonts and colors 10412.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10412.2 Nested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10412.3 Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10512.4 Font color, name and size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10612.5 Black and White . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
13 Preprocessing 11013.1 Including files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11013.2 Including URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11013.3 Constant definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11013.4 Macro definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11113.5 Macro on several lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11113.6 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11213.7 Search path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11213.8 Advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
PlantUML Language Reference Guide (Version 1.2018.1) 120 of 121
CONTENTS CONTENTS
14 Internationalization 11414.1 Charset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
15 Color Names 116
PlantUML Language Reference Guide (Version 1.2018.1) 121 of 121