Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/joelparkerhenderson/plantuml-examples

PlantUML eaxmples for UML, ERD, wireframes, mind maps, JSON, YAML, WBS, ASCII art, Gantt charts, C4 models, and more
https://github.com/joelparkerhenderson/plantuml-examples
Last synced: 7 days ago
JSON representation
PlantUML eaxmples for UML, ERD, wireframes, mind maps, JSON, YAML, WBS, ASCII art, Gantt charts, C4 models, and more
Host: GitHub
URL: https://github.com/joelparkerhenderson/plantuml-examples
Owner: joelparkerhenderson
License: other
Created: 2018-11-26T02:43:47.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-09-17T19:37:40.000Z (about 2 months ago)
Last Synced: 2024-09-18T00:09:07.269Z (about 2 months ago)
Language: Shell
Homepage:
Size: 1.4 MB
Stars: 189
Watchers: 6
Forks: 29
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        # PlantUML examples

[PlantUML](http://plantuml.com) is a software tool that uses text formatting to create graphic diagrams. This page introduces PlantUML by showing examples with diagrams and source code, for UML, ERD, wireframes, mind maps, JSON, YAML, WBS, ASCII art, Gantt charts, C4 models, and more. 

## Sequence diagram

![Sequence diagram](doc/sequence-diagram/sequence-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

Alpha -> Bravo

Bravo -> Alpha

@enduml



## Sequence diagram with steps and divider

![Sequence diagram extras](doc/sequence-diagram-extras/sequence-diagram-extras.plantuml.png)

View Source


@startuml

skinparam monochrome true

Alpha -> Bravo: Step 1

Bravo -> Charlie: Step 2

== My Divider ==

Charlie -> Bravo: Step 3

Bravo -> Alpha: Step 4

@enduml



## Sequence diagram with participant shapes

![Sequence diagram extras](doc/sequence-diagram-with-participant-shapes/sequence-diagram-with-participant-shapes.plantuml.png)

View Source


@startuml

skinparam monochrome true

participant Participant as Foo

actor       Actor       as Foo1

boundary    Boundary    as Foo2

control     Control     as Foo3

entity      Entity      as Foo4

database    Database    as Foo5

collections Collections as Foo6

queue       Queue       as Foo7

Foo -> Foo1 : To actor 

Foo -> Foo2 : To boundary

Foo -> Foo3 : To control

Foo -> Foo4 : To entity

Foo -> Foo5 : To database

Foo -> Foo6 : To collections

Foo -> Foo7: To queue

@enduml



## Usecase diagram

![Usecase diagram](doc/usecase-diagram/usecase-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

left to right direction

User1 --> (Story1)

(Story1) --> (Story2)

(Story2) --> (Story3)

@enduml



## Object diagram

![Object diagram](doc/object-diagram/object-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

object Object1 {

  Alpha

  Bravo

}

object Object2 {

  Charlie

  Delta

}

object Object3 {

  Echo

  Foxtrot

}

Object1 <|-- Object2

Object1 <|-- Object3

@enduml



## Class diagram

![Class diagram](doc/class-diagram/class-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

' If you want to hide the "C" circle, then uncomment this line:

' hide circle

class Class1 {

  {field} Alpha

  {method} Bravo

}

class Class2 {

  {field} Charlie

  {method} Delta

}

class Class3 {

  {field} Echo

  {method} Foxtrot

}

Class1 <|--o Class2

Class1 <|--* Class3

@enduml



## Entity relationship diagram (ERD)

![Entity relationship diagram](doc/entity-relationship-diagram/entity-relationship-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

skinparam linetype ortho

' If you want to hide the "E" circle, then uncomment this line:

' hide circle

entity Entity1 {

  Alpha

  Bravo

}

entity Entity2 {

  Charlie

  Delta

}

entity Entity3 {

  Echo

  Foxtrot

}

Entity1 }o-down-o{ Entity2

Entity1 }o-down-o{ Entity3

@enduml



## Package styles

![Package styles](doc/package-styles/package-styles.plantuml.png)

View Source


@startuml

package "Demo Node" <> {

  object Object1

}

package "Demo Rectangle" <> {

  object Object2

}

package "Demo Folder" <> {

  object Object3

}

package "Demo Frame" <> {

  object Object4

}

package "Demo Cloud" <> {

  object Object5

}

package "Demo Database" <> {

  object Object6

}

@enduml



## Activity diagram

![Activity diagram](doc/activity-diagram/activity-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

start

-> Starting;

:Activity 1;

if (Question) then (yes)

  :Option 1;

else (no)

  :Option 2;

endif

:Activity 2;

-> Stopping;

stop

@enduml



## Component diagram of items

![Component diagram](doc/component-diagram/component-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

component "Component"

interface "Interface"

database "Database"

cloud "Cloud"

node "Node"

package "Package"

@enduml



## State diagram

![State diagram](doc/state-diagram/state-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

[*] --> State1 : Start

State1 -> State2 : Change1

State2 -> State3 : Change2

State3 --> [*] : Stop

State1 : Description 1

State2 : Description 2

State3 : Description 3

@enduml



## Deployment diagram items

![Deployment diagram](doc/deployment-diagram/deployment-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

actor actor

agent agent

artifact artifact

boundary boundary

card card

circle circle

cloud cloud

collections collections

component component

control control

database database

entity entity

file file

folder folder

frame frame

hexagon hexagon

interface interface

label label

node node

package package

person person

queue queue

rectangle rectangle

stack stack

storage storage

usecase usecase

@enduml



## Timing diagram

![Timing diagram](doc/timing-diagram/timing-diagram.plantuml.png)

View Source


@startuml

skinparam monochrome true

concise "My Timeline" as T

@T

0 is Alpha

+100 is Bravo

+100 is Charlie

@50 <-> @+100 : My Note

@enduml



## Diagrams through ASCII art (DITAA)

![Diagrams through ASCII art](doc/diagrams-through-ascii-art/diagrams-through-ascii-art.plantuml.png)

View Source


@startditaa

+--------+   +-------+    +-------+

|        +---+ ditaa +--> |       |

|  Text  |   +-------+    |diagram|

|Document|   |!magic!|    |       |

|     {d}|   |       |    |       |

+---+----+   +-------+    +-------+

    :                         ^

    |       Lots of work      |

    +-------------------------+

@endditaa



## Wireframe

![Wireframe](doc/wireframe/wireframe.plantuml.png)

View Source


@startsalt

{

  Hello world

  [Button]

  ()  Radio 1

  (X) Radio 2

  []  Checkbox 1

  [X] Checkbox 2

  "Enter text here   "

  ^This is a droplist^

}

@endsalt



## Gantt chart

![Gantt chart](doc/gantt-chart/gantt-chart.plantuml.png)

View Source


@startgantt

skinparam monochrome true

[Task1] on {Alice} requires 8 days

then [Task2] on {Bob} requires 4 days and is 50% complete

then [Task3] on {Carol} lasts 2 days and is 25% complete

@endgantt



## Mind map

![Mind map](doc/mind-map/mind-map.plantuml.png)

View Source


@startmindmap

+ C

++ D

++ E

-- A

-- B

@endmindmap



## JSON data

![JSON data](doc/json-data/json-data.plantuml.png)

View Source


@startjson

{

   "fruit":"Apple",

   "size":"Large",

   "color": ["Red", "Green"]

}

@endjson



## YAML data

![YAML data](doc/yaml-data/yaml-data.plantuml.png)

View Source


@startyaml

fruit: Apple

size: Large

color: 

  - Red

  - Green

@endyaml



## Network diagram

![Network diagram](doc/network-diagram/network-diagram.plantuml.png)

View Source


@startuml

nwdiag {

  network dmz {

      address = "210.x.x.x/24"

      web01 [address = "210.x.x.1"];

      web02 [address = "210.x.x.2"];

  }

}

@enduml



## Work breakdown structure (WBS)

![Work breakdown structure](doc/work-breakdown-structure/work-breakdown-structure.plantuml.png)

View Source


@startwbs

* Top

** A

*** A1

*** A2

** B

*** B1

*** B2

@endwbs



## OpenIconic

![OpenIconic](doc/openiconic/openiconic.plantuml.png)

View Source


@startuml

title: <&heart> Demo <&heart>

@enduml



OpenIconic provides open source icons. OpenIconic is now built-in to PlantUML.

## Font Awesome

![Font Awesome](doc/font-awesome/font-awesome.plantuml.png)

View Source


@startuml

skinparam monochrome true

!include 

rectangle "<$star>"

@enduml



## Procedure

![Procedure diagram](doc/procedure/procedure.plantuml.png)

View Source


@startuml

!procedure $demo($name, $headline, $description)

  card $name as "\n$headline\n\n$description\n"

!endprocedure

$demo(MyCard, "Hello World", "This is a demonstration")

@enduml



## Procedure layout

![Procedure layout diagram](doc/procedure-layout/procedure-layout.plantuml.png)

View Source


@startuml

skinparam monochrome true

skinparam defaultTextAlignment center

!procedure $layout($shape, $name, $openiconic, $headline, $description)

  $shape $name as "\n\n<&$openiconic>\n$headline\n\n$description\n\n"

!endprocedure

$layout(card, MyCard, heart, "Hello World", "This is a demonstration")

@enduml



This shows how to create your own procedure to create a custom layout with a shape, object name, OpenIconic icon, headline that uses big size text, and a description that uses normal size text.

## Area diagram

![Area diagram](doc/area-diagram/area-diagram.plantuml.png)

The area diagram is an example deployment diagram that shows a bunch of areas and how they interrlate. This example is useful for seeing a real-world diagram, that uses boxes, arrows, Font Awesome icons, multi-line text, Unicode padding, font sizes, and more.

View Source


@startuml

skinparam monochrome true

skinparam defaultTextAlignment center

' icons

!include 

!include 

!include 

!include 

!include 

!include 

!include 

!include 

!include 

!include 

!include 

' Pipeline objects

stack ""Example\n\nexample\nexample\nexample"" as StackLeft

card "<$cubes>\nExample\n\nexample, example, example \n\n" as Pipeline1

queue "<$check_circle>\nExample\n\nexample, example, example\n\n" as Pipeline2

card "<$cloud>\nExample\n\nexample, example, example\n\n" as Pipeline3

stack "Example\n\nexample\nexample\nexample" as StackRight

' Pipeline flow

StackLeft -r-> Pipeline1 : "Example"

Pipeline1 -r-> Pipeline2 : "Example"

Pipeline2 -r-> Pipeline3 : "Example"

Pipeline3 -r-> StackRight : "Example"

' Left side

interface "Example" as InterfaceLeft

InterfaceLeft -u-> StackLeft

' Right side

interface "Example" as InterfaceRight

InterfaceRight -u-> StackRight

' Actor 1

actor "Actor 1" as Actor1

usecase "\n<$file_image_o>\nExample\n\nexample\nexample\nexample\n\n" as UseCase1

Actor1 -d-> UseCase1

UseCase1 -d-> Pipeline1

' Actor 2

actor "Actor 2" as Actor2

usecase "\n<$file_code_o>\nExample\n\nexample\nexample\nexample\n\n" as UseCase2

Actor2 -d-> UseCase2

UseCase2 -d-> Pipeline1

' Actor 3

actor "Actor 3" as Actor3

usecase "\n<$exchange>\nExample\n\nexample\nexample\nexample\n\n" as UseCase3

Actor3 -d-> UseCase3

UseCase3 -d-> Pipeline3

' Actor 4

actor "Actor 4" as Actor4

usecase "\n<$share_alt_square>\nExample\n\nexample\nexample\nexample\n\n" as UseCase4

Actor4 -d-> UseCase4

UseCase4 -d-> Pipeline3

' Diamond upper area

cloud "\n<$heart>\nExample\n\nexample, example, example\n\n" as DiamondUpper

DiamondUpper -d-> Pipeline1

DiamondUpper -d-> Pipeline2

DiamondUpper -d-> Pipeline3

' Diamond lower area

database "\n<$gear>\nExample\n\nexample, example, example\n\n" as DiamondLower

DiamondLower -u-> Pipeline1

DiamondLower -u-> Pipeline2

DiamondLower -u-> Pipeline3

' Hinting

UseCase1 -[hidden]r- UseCase2

UseCase2 -[hidden]r- DiamondUpper

DiamondUpper -[hidden]r- UseCase3

UseCase3 -[hidden]r- UseCase4

' Pipeline 1 controls

control "Example\n\nexample\nexample\nexample" as Pipeline1Control1 

control "Example\n\nexample\nexample\nexample" as Pipeline1Control2

Pipeline1Control1 -u-> Pipeline1

Pipeline1Control2 -u-> Pipeline1

' Pipeline 3 controls

control "Example\n\nexample\nexample\nexample" as Pipeline3Control1

control "Example\n\nexample\nexample\nexample" as Pipeline3Control2

Pipeline3Control1 -u-> Pipeline3

Pipeline3Control2 -u-> Pipeline3

@enduml



## C4 model

![C4 model](doc/c4-model/c4-model.plantuml.png)

View Source


@startuml

!include 

Person(personAlias, "Label", "Optional Description")

Container(containerAlias, "Label", "Technology", "Optional Description")

System(systemAlias, "Label", "Optional Description")

System_Ext(extSystemAlias, "Label", "Optional Description")

Rel(personAlias, containerAlias, "Label", "Optional Technology")

Rel_U(systemAlias, extSystemAlias, "Label", "Optional Technology")

@enduml



[C4 Model](https://c4model.com/) focuses diagrams on four areas: Context, Containers, Components, Code.

## Standard library

![Standard library](doc/standard-library/standard-library.plantuml.png)

View Source


@startuml

stdlib

@enduml



You can list standard library folders by using the special diagram "stdlib".

## OpenIconic list

![OpenIconic](doc/openiconic-list/openiconic-list.plantuml.png)

View Source


@startuml

listopeniconic

@enduml



You can list all the OpenIconic icon names and images by using the special diagram "listopeniconic".