Guide to PlantUml Diagrams

PlantUml Documents

• Reference Manual
• Local Configuration and styling
  • See file docs/contents/assets/plantuml/config.cfg
  • See file docs/contents/assets/plantuml/style.iuml

Using Style

@startuml
'!include data/docs/contents/assets/plantuml/style.iuml

class AClass {
  +int attr: String
  +method(p: Int): Double
}
@enduml

Color palette

• See Color Names and Samples
• Color Manual

Using C4

• Introduction
• Reference

@startuml C4_elements
!include <C4/C4_Container>
title
= Sample C4 Shapes

end title
Person(personAlias, "Label", "Optional Description")
Container(containerAlias, "Label", "Technology", "Optional Description")
System(systemAlias, "Label", "Optional Description")
System_Boundary(c1, "Sample System") {
  Rel(personAlias, containerAlias, "Label", "Optional Technology")
}
@enduml

See Sample Diagrams

Shape Gallery

Boundary Gallery

C4 Sequence

Comments