PlantUML

https://plantuml.com
Admin
PlantUML is a versatile tool for creating a wide variety of UML and non-UML diagrams using a simple,...
Tokens:459,813
Snippets:4,453
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get all stdlib names and details with %get_all_stdlib

Source: https://plantuml.com/en/preprocessing

The first example retrieves a JSON array of all standard library names. The second example, with the 'detailed' parameter, retrieves a JSON object including version and source information. Available from version 1.2024.4.

```plantuml
@startjson
%get_all_stdlib()
@endjson
```

```plantuml
@startjson
%get_all_stdlib(detailed)
@endjson
```

--------------------------------

### Autonumber with start and increment

Source: https://plantuml.com/en/sequence-diagram

Specify a start number with `autonumber <start>` and an increment with `autonumber <start> <increment>`. The example starts at 15, then restarts at 40 with increment 10.

```plantuml
@startuml
autonumber
Bob -> Alice : Authentication Request
Bob <- Alice : Authentication Response
autonumber 15
Bob -> Alice : Another authentication Request
Bob <- Alice : Another authentication Response
autonumber 40 10
Bob -> Alice : Yet another authentication Request
Bob <- Alice : Yet another authentication Response
@enduml
```

--------------------------------

### First example with width on all networks

Source: https://plantuml.com/en/nwdiag

First example with width = full on all networks.

```nwdiag
@startnwdiag nwdiag { network NETWORK_BASE { width = full dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { width = full dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { width = full dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag
```

--------------------------------

### Start tasks relative to today with %now and %date

Source: https://plantuml.com/en/gantt-diagram

Starts a project, task, or milestone a number of days before or after today using the builtin functions `%now` and `%date`. The example shows a project starting 14 days in the past, a task starting 4 days in the future, and a milestone happening tomorrow.

```plantuml
@startgantt
title Today is %date("YYYY-MM-dd")
!$now = %now()
!$past = %date("YYYY-MM-dd", $now - 14*24*3600)
Project starts $past today is colored in pink
[foo] requires 10 days
[bar] requires 5 days and starts %date("YYYY-MM-dd", $now + 4*24*3600)
[Tomorrow] happens %date("YYYY-MM-dd", $now + 1*24*3600)
@endgantt
```

--------------------------------

### Second example with width on all networks

Source: https://plantuml.com/en/nwdiag

Second example with width = full on all networks.

```nwdiag
@startnwdiag nwdiag { e1 network n1 { width = full e1 e2 e3 } network n2 { width = full e3 e4 e5 } network n3 { width = full e2 e6 } } @endnwdiag
```

--------------------------------

### Start and stop keywords

Source: https://plantuml.com/activity-diagram-beta

Uses the 'start' and 'stop' keywords to denote the beginning and end of the diagram. The example shows two actions with text, including bold formatting.

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

--------------------------------

### Anchor Points Example

Source: https://plantuml.com/en-dark/timing-diagram

Demonstrates how to define anchor points using the 'as' keyword with a name starting with a colon. The example defines anchors at times 0, 5, and 10, then uses them to set signal states and a data bus value with offsets.

```plantuml
@startuml
clock clk with period 1
binary "enable" as EN
concise "dataBus" as db
@0 as :start
@5 as :en_high
@10 as :en_low
@:en_high-2 as :en_highMinus2
@:start
EN is low
db is "0x0000"
@:en_high
EN is high
@:en_low
EN is low
@:en_highMinus2
db is "0xf23a"
@:en_high+6
db is "0x0000"
@enduml
```

--------------------------------

### First example with width on first network

Source: https://plantuml.com/en/nwdiag

First example with width = full only on the first network.

```nwdiag
@startnwdiag nwdiag { network NETWORK_BASE { width = full dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag
```

--------------------------------

### Full example with comments in skinparam

Source: https://plantuml.com/commons

Full example showing comments inside a skinparam block. Note that a line starting with ' is a comment, while a line starting with /' ... '/ is a block comment. The line ' this is not a comment and this line is ignored' is ignored because it starts with a single quote.

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

--------------------------------

### First example with width on first and second networks

Source: https://plantuml.com/en/nwdiag

First example with width = full on the first and second networks.

```nwdiag
@startnwdiag nwdiag { network NETWORK_BASE { width = full dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { width = full dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag
```

--------------------------------

### Second example with width on first network

Source: https://plantuml.com/en/nwdiag

Second example with width = full only on the first network.

```nwdiag
@startnwdiag nwdiag { e1 network n1 { width = full e1 e2 e3 } network n2 { e3 e4 e5 } network n3 { e2 e6 } } @endnwdiag
```

--------------------------------

### Second example with width on first and second networks

Source: https://plantuml.com/en/nwdiag

Second example with width = full on the first and second networks.

```nwdiag
@startnwdiag nwdiag { e1 network n1 { width = full e1 e2 e3 } network n2 { width = full e3 e4 e5 } network n3 { e2 e6 } } @endnwdiag
```

--------------------------------

### Start and end keywords

Source: https://plantuml.com/activity-diagram-beta

Uses the 'start' and 'end' keywords to denote the beginning and end of the diagram. The example shows two actions with text, including bold formatting.

```plantuml
@startuml
start
:Hello world;
:This is defined on several **lines**;
end
@enduml
```

--------------------------------

### Full example with functions and foreach

Source: https://plantuml.com/en/preprocessing-json

Full example combining functions, procedures, conditionals, and foreach to generate a sequence diagram with boxes and participants from JSON data.

```plantuml
@startuml
!unquoted function DRAW($x)
return %set_variable_value($x, 1)
!procedure addComponent($part, $component, $as)
!if %variable_exists($part)
participant "$component" as $as
!endif
!end procedure
!procedure addBox2($part, $box, $colour, $data)
!if %variable_exists($part)
box "$box" #$colour
!foreach $item in $data.participants
addComponent($part, $item.name, $item.as)
!endfor
end box
!endif
!end procedure
DRAW(PART25)
!ifdef PART25
title TESTING (Boxes & Participants)
//Part25//
!endif
!$data={
  "participants": [
    {"name": "XYZ", "as": "xyz"},
    {"name": "RST", "as": "rst"},
    {"name": "UVW", "as": "uvw"}
  ]
}
addBox2("PART25", "New Box", "white", $data)
@enduml
```

--------------------------------

### Specify project start date

Source: https://plantuml.com/en/gantt-diagram

Sets a starting date for the whole project using the 'Project starts' syntax.

```plantuml
@startgantt
Project starts the 20th of september 2017
[Prototype design] as [TASK1] requires 13 days
[TASK1] is colored in Lavender/LightBlue
@endgantt
```

--------------------------------

### SDL example with split and stereotypes

Source: https://plantuml.com/activity-diagram-beta

Shows a more complex SDL example using split and split again with various SDL stereotypes. The example includes input, output, procedure, task, save, load, and continuous stereotypes.

```plantuml
@startuml
:Ready;
:next(o);
<<procedure>>
:Receiving;
split
:nak(i);
<<input>>
:ack(o);
<<output>>
split again
:ack(i);
<<input>>
:next(o) on several lines;
<<procedure>>
:i := i + 1;
<<task>>
:ack(o);
<<output>>
split again
:err(i);
<<input>>
:nak(o);
<<output>>
split again
:foo;
<<save>>
split again
:bar;
<<load>>
split again
:i > 5;
<<continuous>>
stop
end split
:finish;
@enduml
```

--------------------------------

### Full network diagram example

Source: https://plantuml.com/en/nwdiag

Full example showing two networks (dmz and internal) with servers and databases.

```plantuml
@startnwdiag
network dmz {
  address = "210.x.x.x/24"
  web01 [address = "210.x.x.1"];
  web02 [address = "210.x.x.2"];
}
network internal {
  address = "172.x.x.x/24";
  web01 [address = "172.x.x.1"];
  web02 [address = "172.x.x.2"];
  db01;
  db02;
}
@endnwdiag
```

--------------------------------

### Install fontconfig (apt-get)

Source: https://plantuml.com/en/faq

Install fontconfig on a server using apt-get to resolve the 'Could not initialize class net.sourceforge.plantuml.ugraphic.UFont' error caused by missing fonts.

```bash
sudo apt-get install fontconfig
```

--------------------------------

### Simple Action with start and end points

Source: https://plantuml.com/activity-diagram-legacy

Use (*) for the starting and ending points of the activity diagram. Optionally, use (*top) to force the starting point to be at the top. Use --> for arrows.

```plantuml
@startuml
(*) --> "First Action"
"First Action" --> (*)
@enduml
```

--------------------------------

### Anchor Points in Timing Diagram

Source: https://plantuml.com/en/timing-diagram

Shows how to define anchor points using the 'as' keyword and a name starting with a colon. The first block is the syntax template; the second is a full example using anchors like ':start', ':en_high', and ':en_highMinus2' with offsets.

```plantuml
@XX as :<anchor point name>
```

```plantuml
@startuml
clock clk with period 1
binary "enable" as EN
concise "dataBus" as db
@0 as :start
@5 as :en_high
@10 as :en_low
@:en_high-2 as :en_highMinus2
@:start
EN is low
db is "0x0000"
@:en_high
EN is high
@:en_low
EN is low
@:en_highMinus2
db is "0xf23a"
@:en_high+6
db is "0x0000"
@enduml
```

--------------------------------

### First example without width

Source: https://plantuml.com/en/nwdiag

First example without width settings.

```nwdiag
@startnwdiag nwdiag { network NETWORK_BASE { dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag
```

--------------------------------

### Direct proxy configuration example

Source: https://plantuml.com/en/url-authentication

Example of a direct proxy configuration, representing a direct connection or the absence of a proxy. Address and port are not required and will be ignored.

```json
"proxy": {
  "type": "direct"
}
```

--------------------------------

### Second example without width

Source: https://plantuml.com/en/nwdiag

Second example without width settings.

```nwdiag
@startnwdiag nwdiag { e1 network n1 { e1 e2 e3 } network n2 { e3 e4 e5 } network n3 { e2 e6 } } @endnwdiag
```

--------------------------------

### Complete servlet container activity diagram

Source: https://plantuml.com/activity-diagram-legacy

Complete example of an activity diagram for a servlet container, showing conditional branches, loops, and rendering states. Uses labels like [true], [false], [yes], and [no] to guide flow.

```plantuml
@startuml
title Servlet Container
(*) --> "ClickServlet.handleRequest()"
--> "new Page"

if "Page.onSecurityCheck" then
  ->[true] "Page.onInit()"

  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()"
    --> render
  endif

else
  -->[false] ===REDIRECT_CHECK===
endif

if "Do redirect?" then
  ->[yes] "redirect request"
  --> ==BEFORE_DESTROY===
else
  if "Do Forward?" then
    -left->[yes] "Forward request"
    --> ==BEFORE_DESTROY===
  else
    -right->[no] "Render page template"
    --> ==BEFORE_DESTROY===
  endif
endif

--> "Page.onDestroy()"
-->(*)
@enduml
```

--------------------------------

### Minimal JSON examples (string, number, boolean)

Source: https://plantuml.com/en/json

Minimal JSON examples: a string, a number, and a boolean. These are from STD 90 - Examples.

```plantuml
@startjson "Hello world!" @endjson
```

```plantuml
@startjson 42 @endjson
```

```plantuml
@startjson true @endjson
```

--------------------------------

### JSON structure for full example

Source: https://plantuml.com/en/preprocessing-json

Shows the JSON structure used in the full example: a data object with a participants array.

```plantuml
@startjson
{
  "data": {
    "participants": [
      {"name": "XYZ", "as": "xyz"},
      {"name": "RST", "as": "rst"},
      {"name": "UVW", "as": "uvw"}
    ]
  }
}
@endjson
```

--------------------------------

### Show extended help with --help-more

Source: https://plantuml.com/command-line

Launch the extended help message showing advanced options.

```bash
java -jar plantuml.jar --help-more
```

--------------------------------

### Start, choice, fork, join, end stereotypes example

Source: https://plantuml.com/en/state-diagram

Full example using the start, choice, fork, join, and end stereotypes. It shows transitions between these states with labels that include escaped newlines (\n). References QA-404, QA-1159, and GH-887.

```plantuml
@startuml
state start1 <<start>>
state choice1 <<choice>>
state fork1 <<fork>>
state join2 <<join>>
state end3 <<end>>
[*] --> choice1 : from start\nto choice
start1 --> choice1 : from start stereo\nto choice
choice1 --> fork1 : from choice\nto fork
choice1 --> join2 : from choice\nto join
choice1 --> end3 : from choice\nto end stereo
fork1 ---> State1 : from fork\nto state
fork1 --> State2 : from fork\nto state
State2 --> join2 : from state\nto join
State1 --> [*] : from state\nto end
join2 --> [*] : from join\nto end
@enduml
```

--------------------------------

### Connector (or Circle) example

Source: https://plantuml.com/activity-diagram-beta

Shows how to use parentheses to denote a connector (circle) in an activity diagram. The example uses `(A)` as a connector and `detach` to break the flow.

```plantuml
@startuml
start
:Some activity;
(A)
detach
(A)
:Other activity;
@enduml
```

--------------------------------

### Weekly Gantt with custom week numbering start

Source: https://plantuml.com/gantt-diagram

Two examples showing weekly Gantt charts with week numbering starting from a specific number, including negative integers. The first starts from 11, the second from -3.

```plantuml
@startgantt printscale weekly with week numbering from 11 Project starts the 6th of July 2020 [Task1] on {Alice} requires 2 weeks [Task2] on {Bob:50%} requires 2 weeks then [Task3] on {Alice:25%} requires 3 days @endgantt
```

```plantuml
@startgantt printscale weekly with week numbering from -3 Project starts the 6th of July 2020 [Task1] on {Alice} requires 2 weeks [Task2] on {Bob:50%} requires 2 weeks then [Task3] on {Alice:25%} requires 3 days @endgantt
```

--------------------------------

### BasicAuth example with proxy

Source: https://plantuml.com/en/url-basicauth

BasicAuth configuration example with a SOCKS proxy. The proxy settings override system proxy settings; `type` is `socks`, and the address and port are specified.

```json
{
  "name": "stash-cloud",
  "type": "basicauth",
  "identifier": "repoadmin",
  "secret": "verySecret",
  "proxy": {
    "type": "socks",
    "address": "outboundcloud.int.example.com",
    "port": "8091"
  }
}

```

--------------------------------

### Minimal example with all stereotypes

Source: https://plantuml.com/en/state-diagram

Minimal example that declares all available state stereotypes: start, choice, fork, join, end, sdlreceive, history, and history*. Reference QA-19174.

```plantuml
@startuml
state start1 <<start>>
state choice1 <<choice>>
state fork1 <<fork>>
state join2 <<join>>
state end3 <<end>>
state sdlreceive <<sdlreceive>>
state history <<history>>
state history2 <<history*>>
@enduml
```

--------------------------------

### Run PicoWeb server with default settings

Source: https://plantuml.com/en/picoweb

Launches the built-in web server on all interfaces at port 8080. Requires a Java Runtime Environment and plantuml.jar.

```bash
java -jar plantuml.jar -picoweb
```

--------------------------------

### PlantUML Sequence Diagram Example

Source: https://plantuml.com/en/server

Example diagram description for the PlantUML Server interactive interface. Start diagrams with the @startxxx keyword. The encoded form of this diagram is SyfFKj2rKt3CoKnELR1Io4ZDoSa70000.

```plantuml
@startuml
Bob -> Alice : hello
@enduml
```

--------------------------------

### Weekly scale with specific week numbers (from 11 and -3)

Source: https://plantuml.com/en-dark/gantt-diagram

Weekly scale with week numbers starting from a specific number, including negative integers. The first example starts from 11, the second from -3.

```plantuml
@startgantt
printscale weekly with week numbering from 11
Project starts the 6th of July 2020
[Task1] on {Alice} requires 2 weeks
[Task2] on {Bob:50%} requires 2 weeks
then
[Task3] on {Alice:25%} requires 3 days
@endgantt
```

```plantuml
@startgantt
printscale weekly with week numbering from -3
Project starts the 6th of July 2020
[Task1] on {Alice} requires 2 weeks
[Task2] on {Bob:50%} requires 2 weeks
then
[Task3] on {Alice:25%} requires 3 days
@endgantt
```

--------------------------------

### Grouping components with package, node, cloud, database, folder, and frame

Source: https://plantuml.com/component-diagram

Shows how to group components and interfaces using the keywords package, node, folder, frame, cloud, and database. The example includes nested groups and relationships between components.

```plantuml
@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
```

--------------------------------

### Launch PlantUML GUI with source directory

Source: https://plantuml.com/gui

Launch the PlantUML GUI with a specified source directory to monitor immediately.

```bash
java -jar plantuml.jar -gui /path/to/source/directory
```

--------------------------------

### %get_json_keys builtin function example

Source: https://plantuml.com/preprocessing-json

Shows how to use %get_json_keys to get all keys of a JSON object at one level. The first example iterates over keys of a nested JSON structure and creates rectangles. The second example iterates over keys of a simple JSON object and creates list items in a work breakdown structure.

```plantuml
@startuml
!$myjson = {
  "root" : [{
    "fruits": [
      {"name": "apple", "colorId": "1"},
      {"name": "pear", "colorId": "2"},
      {"name": "pineapple", "colorId": "3"}
    ]
  }, {
    "colors": [
      {"id": "1", "name": "red"},
      {"id": "2", "name": "green"},
      {"id": "3", "name": "yellow"}
    ]
  }]
}
!foreach $key in %get_json_keys($myjson.root)
  rectangle $key
!endfor
@enduml
```

```plantuml
@startwbs
!$json_object = {
  "name": "Mark McGwire",
  "hr": 65,
  "avg": 0.278
}
* json_object
* keys of json_object
!foreach $key in %get_json_keys($json_object)
  * $key
!endfor
@endwbs
```

--------------------------------

### Short arrows for incoming and outgoing messages

Source: https://plantuml.com/en/sequence-diagram

Shows the short arrow syntax for incoming and outgoing messages in PlantUML sequence diagrams. Use ?-> for short arrows, [-> for from start, ->] for to end, and ->? for from start to end. The example includes labels for each arrow type.

```plantuml
@startuml
?-> Alice : ""?->""
**short** to actor1
[-> Alice : ""[->""
**from start** to actor1
[-> Bob : ""[->""
**from start** to actor2
?-> Bob : ""?->""
**short** to actor2
Alice ->] : ""->]""
from actor1 **to end**
Alice ->? : ""->?""
**short** from actor1
Alice -> Bob : ""->"" 
from actor1 to actor2
@enduml
```

--------------------------------

### Complete example

Source: https://plantuml.com/activity-diagram-beta

A complete activity diagram example showing a typical web request flow with conditional branches, loops, and a stop. It demonstrates the use of if/else, nested conditions, and the stop keyword.

```plantuml
@startuml
start
:ClickServlet.handleRequest();
:new page;
if (Page.onSecurityCheck) then (true)
  :Page.onInit();
  if (isForward?) then (no)
    :Process controls;
    if (continue processing?) then (no)
      stop
    endif
    if (isPost?) then (yes)
      :Page.onPost();
    else (no)
      :Page.onGet();
    endif
    :Page.onRender();
  endif
else (false)
endif
if (do redirect?) then (yes)
  :redirect process;
else
  if (do forward?) then (yes)
    :Forward request;
  else (no)
    :Render page template;
  endif
endif
stop
@enduml
```

--------------------------------

### Get JSON element size with %size

Source: https://plantuml.com/en/preprocessing-json

Shows how to use the %size builtin function to get the size of different JSON elements. The example displays the type and size for a JSON object, a string value, a numeric value, and a JSON array.

```plantuml
@startuml
!$json_object= { "name" : "Mark McGwire", "hr" : 65, "avg" : 0.278, "letters": ["a", "b", "c"] }
label l [
|= $variable |= %get_json_type($var) |= %size($var) |
| json_object | %get_json_type($json_object) | %size($json_object) |
| json_object.name | %get_json_type($json_object.name) | %size($json_object.name) |
| json_object.hr | %get_json_type($json_object.hr) | %size($json_object.hr) |
| json_object.letters | %get_json_type($json_object.letters) | %size($json_object.letters) |
]
@enduml
```

--------------------------------

### PortOut keyword example

Source: https://plantuml.com/deployment-diagram

Defines a node with three output ports (p1, p2, p3) and a file (f1). Each output port connects to component o, and the file connects to p1.

```plantuml
@startuml
node node {
  portout p1
  portout p2
  portout p3
  file f1
}
[o]
p1 --> o
p2 --> o
p3 --> o
f1 --> p1
@enduml
```

--------------------------------

### Cloudogu Ecosystem Example

Source: https://plantuml.com/en/stdlib

Example of using Cloudogu sprites and macros to create a diagram of a Cloudogu ecosystem. Includes common includes, dogus (Jenkins, SCM-Manager, Smeagol, Nexus), and a Kubernetes tool, with relationships.

```plantuml
@startuml
!include <cloudogu/common>
!include <cloudogu/dogus/jenkins>
!include <cloudogu/dogus/cloudogu>
!include <cloudogu/dogus/scm>
!include <cloudogu/dogus/smeagol>
!include <cloudogu/dogus/nexus>
!include <cloudogu/tools/k8s>
node "Cloudogu Ecosystem" <<$cloudogu>> {
  DOGU_JENKINS(jenkins, Jenkins) #ffffff
  DOGU_SCM(scm, SCM-Manager) #ffffff
  DOGU_SMEAGOL(smeagol, Smeagol) #ffffff
  DOGU_NEXUS(nexus,Nexus) #ffffff
}
TOOL_K8S(k8s, Kubernetes) #ffffff
actor developer
developer --> smeagol : "Edit Slides"
smeagol -> scm : Push
scm -> jenkins : Trigger
jenkins -> nexus : Deploy
jenkins --> k8s : Deploy
@enduml
```

--------------------------------

### Block comment with /' and '/

Source: https://plantuml.com/commons

Use C-style block comments with apostrophes: start with /' and end with '/. This example shows a multi-line comment.

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

--------------------------------

### Simple State Diagram with Start and End Points

Source: https://plantuml.com/en/state-diagram

Defines a simple state diagram with a starting point ([*]) and an ending point ([*]). Use --> for arrows and add labels to states with a colon. The example shows two states with transitions and state descriptions.

```plantuml
@startuml
[*] --> State1
State1 --> [*]
State1 : this is a string
State1 : this is another string
State1 -> State2
State2 --> [*]
@enduml
```

--------------------------------

### Gantt chart with quarterly scale (projectscale quarterly)

Source: https://plantuml.com/en/gantt-diagram

Two examples using projectscale quarterly. The first starts September 20, 2020 with shorter tasks; the second starts October 1, 2020 with longer tasks (700 and 200 days).

```plantuml
@startgantt projectscale quarterly Project starts the 20th of september 2020 [Prototype design] as [TASK1] requires 130 days [TASK1] is colored in Lavender/LightBlue [Testing] requires 20 days [TASK1]->[Testing] 2021-01-18 to 2021-01-22 are named [End's committee] 2021-01-18 to 2021-01-22 are colored in salmon @endgantt
```

```plantuml
@startgantt projectscale quarterly Project starts the 1st of october 2020 [Prototype design] as [TASK1] requires 700 days [TASK1] is colored in Lavender/LightBlue [Testing] requires 200 days [TASK1]->[Testing] 2021-01-18 to 2021-03-22 are colored in salmon @endgantt
```

--------------------------------

### PortOut example

Source: https://plantuml.com/component-diagram

Adds output ports to a component using the 'portout' keyword. The example shows a component C with three output ports (p1, p2, p3) and a nested component c1, with connections from the ports to an external component o and from the nested component to the ports.

```plantuml
@startuml
component C {
  portout p1
  portout p2
  portout p3
  component c1
}
[o]
p1 --> o
p2 --> o
p3 --> o
c1 --> p1
@enduml
```

--------------------------------

### Gantt chart with weekly scale (printscale weekly)

Source: https://plantuml.com/en/gantt-diagram

Two examples using printscale weekly to change the gantt scale to weekly. The first includes closed weekend days and a January 2021 start; the second starts September 20, 2020 with longer tasks.

```plantuml
@startgantt printscale weekly saturday are closed sunday are closed Project starts the 1st of january 2021 [Prototype design end] as [TASK1] requires 19 days [TASK1] is colored in Lavender/LightBlue [Testing] requires 14 days [TASK1]->[Testing] 2021-01-18 to 2021-01-22 are named [End's committee] 2021-01-18 to 2021-01-22 are colored in salmon @endgantt
```

```plantuml
@startgantt printscale weekly Project starts the 20th of september 2020 [Prototype design] as [TASK1] requires 130 days [TASK1] is colored in Lavender/LightBlue [Testing] requires 20 days [TASK1]->[Testing] 2021-01-18 to 2021-01-22 are named [End's committee] 2021-01-18 to 2021-01-22 are colored in salmon @endgantt
```

--------------------------------

### Sprite usage in activity diagram

Source: https://plantuml.com/en-dark/sprite

Example of using a sprite in an activity diagram. The sprite is defined with a compressed 8z format and referenced in a start action.

```plantuml
@startuml
sprite $printer [15x15/8z] NOtH3W0W208HxFz_kMAhj7lHWpa1XC716sz0Pq4MVPEWfBHIuxP3L6kbTcizR8tAhzaqFvXwvFfPEqm0
start :click on <$printer> to print the page;
@enduml
```

--------------------------------

### While loop on Component/Deployment diagram

Source: https://plantuml.com/en/preprocessing

Illustrates using !while and !endwhile in a component/deployment diagram, with a procedure that decrements $arg and creates components, then connects them.

```plantuml
@startuml
!procedure $foo($arg)
!while $arg!=0
[Component $arg] as $arg
!$arg = $arg - 1
!endwhile
!endprocedure
$foo(4)
1->2
3-->4
@enduml
```

--------------------------------

### After: using %n() function

Source: https://plantuml.com/en/newline

Shows the updated syntax using %n() to replace the old \n escape sequences. This is the 'After' example in the transition guide.

```plantuml
Alice -> Bob : Hello%n()How are you?
note left: This is a%n()test
```

--------------------------------

### Test PlantUML dot installation with -testdot

Source: https://plantuml.com/en/graphviz-dot

Run the PlantUML command-line tool with the -testdot flag to get information about where PlantUML expects to find the dot executable.

```bash
java -jar plantuml.jar -testdot
```

--------------------------------

### All EBNF elements: @startebnf

Source: https://plantuml.com/ebnf

Complete EBNF example that lists all elements handled by PlantUML, including nodes (litteral, special, rule) and edges (required, optional, zero_or_more, one_or_more, etc.). Use it as a reference for supported EBNF syntax.

```ebnf
@startebnf
title All EBNF elements managed by PlantUML
(* Nodes *)
litteral = "a";
special = ? a ?;
rule = a;
(* Edges *)
required = a;
optional = [a];
zero_or_more = {a};
one_or_more = a, {a};
one_or_more_ebnf = {a}-;
zero_or_more_with_separator = [a, {',', a}];
one_or_more_with_separator = a, {',', a};
zero_or_more_with_terminator = {a, ','};
one_or_more_with_terminator = a, ',', {a, ','};
one_or_more_with_terminator_ebnf = {a, ','}-;
alternative = a | b;
group = (a | b) , c;
without_group = a | b , c;
@endebnf
```

--------------------------------

### Component, Deployment, Use-Case diagram with header, footer, title, caption, and legend

Source: https://plantuml.com/commons

Component, deployment, and use-case diagram example combining header, footer, title, caption, and legend.

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

--------------------------------

### Before: old escape sequence \n

Source: https://plantuml.com/en/newline

Shows the old way of using \n escape sequences in PlantUML source code. This is the 'Before' example in the transition guide.

```plantuml
Alice -> Bob : Hello\nHow are you?
note left: This is a\ntest
```

--------------------------------

### Activity diagram with handwritten option

Source: https://plantuml.com/en/handwritten

Enables handwritten style for an Activity diagram using the `!option handwritten true` directive. The example shows a decision on Graphviz installation and processing of diagrams.

```plantuml
@startuml
!option handwritten true
start
if (Graphviz installed?) then (yes)
  :process all\ndiagrams;
else (no)
  :process only __sequence__ and __activity__ diagrams;
endif
stop
@enduml
```

--------------------------------

### Mixing PortIn & PortOut example

Source: https://plantuml.com/component-diagram

Combines input and output ports in one component using both 'portin' and 'portout' keywords. The example shows a component C with three input ports (p1, p2, p3) and three output ports (po1, po2, po3), a nested component c1, and connections to external components i and o.

```plantuml
@startuml
[i] component C {
  portin p1
  portin p2
  portin p3
  portout po1
  portout po2
  portout po3
  component c1
}
[o]
i --> p1
i --> p2
i --> p3
p1 --> c1
p2 --> c1
po1 --> o
po2 --> o
po3 --> o
c1 --> po1
@enduml
```

--------------------------------

### GroupInheritance 2 (grouping from 2)

Source: https://plantuml.com/class-diagram

Sets groupInheritance to 2, which groups inheritance arrow heads starting from classes with at least two subclasses. The example shows the effect on the same class hierarchy.

```plantuml
@startuml
skinparam groupInheritance 2
A1 <|-- B1
A2 <|-- B2
A2 <|-- C2
A3 <|-- B3
A3 <|-- C3
A3 <|-- D3
A4 <|-- B4
A4 <|-- C4
A4 <|-- D4
A4 <|-- E4
@enduml
```

--------------------------------

### JCCKit chart with curves and error bars

Source: https://plantuml.com/en/jcckit

PlantUML JCCKit example that creates a chart with two curves and error bars. It sets data series, titles, error values, and configures coordinate axes, fonts, and curve factories. The example uses JCCKit configuration properties and requires the JCCKit User Guide for full understanding.

```plantuml
@startjcckit(600,300)
data/curves = curve2 errors2 curve1 errors1
data/curve1/title = curve 1
data/curve1/x = 0.02 0.11 0.18 0.3 0.42 0.49 0.61
data/curve1/y = 0.68 0.61 0.52 0.41 0.27 0.21 0.11
data/errors1/x = 0.021 0.01 0.017 0.024 0.023 0.025 0.027
data/errors1/y = 0.034 0.028 0.031 0.039 0.03 0.032 0.041
data/curve2/title = curve 2
data/curve2/x = 0.4 0.5 0.6 0.7 0.8 0.9
data/curve2/y = 0.17 0.29 0.45 0.61 0.64 0.66
data/errors2/x = 0 0 0 0 0 0
data/errors2/y = 0.05 0.036 0.059 0.07 0.061 0.053
background = White
defaultCoordinateSystem/ticLabelAttributes/fontSize = 0.03
defaultCoordinateSystem/axisLabelAttributes/fontSize = 0.04
defaultCoordinateSystem/axisLabelAttributes/fontStyle = bold
plot/coordinateSystem/xAxis/ = defaultCoordinateSystem/
plot/coordinateSystem/xAxis/minimum = 0.1
plot/coordinateSystem/yAxis/ = defaultCoordinateSystem/
plot/initialHintForNextCurve/className = jcckit.plot.PositionHint
plot/initialHintForNextCurve/origin = 0.06 0.1
#plot/initialHintForNextCurve/position = 0 0
plot/curveFactory/definitions = cdef1 edef1 cdef2 edef2
plot/curveFactory/cdef1/symbolFactory/className = jcckit.plot.ErrorBarFactory
plot/curveFactory/edef1/symbolFactory/className = jcckit.plot.ErrorBarFactory
plot/curveFactory/edef1/symbolFactory/attributes/className = jcckit.graphic.ShapeAttributes
plot/curveFactory/edef1/symbolFactory/attributes/fillColor = 0xcafe
plot/curveFactory/edef1/symbolFactory/attributes/lineColor = 0
plot/curveFactory/edef1/symbolFactory/size = 0.01
plot/curveFactory/edef1/withLine = false
plot/curveFactory/edef1/softClipping = false
plot/curveFactory/cdef2/symbolFactory/className = jcckit.plot.ErrorBarFactory
plot/curveFactory/cdef2/symbolFactory/symbolFactory/className = jcckit.plot.SquareSymbolFactory
plot/curveFactory/cdef2/symbolFactory/symbolFactory/attributes/className = jcckit.graphic.ShapeAttributes
plot/curveFactory/cdef2/symbolFactory/symbolFactory/attributes/fillColor = 0x40c0
plot/curveFactory/cdef2/symbolFactory/symbolFactory/attributes/lineColor =
plot/curveFactory/edef2/ = plot/curveFactory/edef1/
plot/curveFactory/edef2/symbolFactory/attributes/fillColor =
plot/curveFactory/edef2/symbolFactory/attributes/lineColor = 0
plot/curveFactory/edef2/symbolFactory/size = 0
@endjcckit
```

--------------------------------

### Start PlantUML FTP server on custom port 12345

Source: https://plantuml.com/en/ftp

Launches PlantUML FTP server on a specified port (12345 in this example). Use this to avoid port conflicts or to match your network configuration.

```bash
java -jar plantuml.jar -ftp:12345
```

--------------------------------

### Start PlantUML FTP server on default port 4242

Source: https://plantuml.com/en/ftp

Launches PlantUML as a mock FTP server on port 4242. The server runs in memory and does not store anything on disk.

```bash
java -jar plantuml.jar -ftp
```

--------------------------------

### Naming exceptions for $ components

Source: https://plantuml.com/component-diagram

Shows that component names starting with '$' are treated as tags by 'hide' and 'remove' commands, so they cannot be removed unless aliased or tagged. The example removes $C1, $C2, and the aliased dollarC2.

```plantuml
@startuml
component [$C1]
component [$C2] $C2
component [$C2] as dollarC2
remove $C1
remove $C2
remove dollarC2
@enduml
```

--------------------------------

### List standard library folders with @startuml stdlib

Source: https://plantuml.com/en/stdlib

Use this special diagram to list the standard library folders. The diagram is created with the @startuml stdlib @enduml syntax.

```plantuml
@startuml stdlib
@enduml
```

--------------------------------

### Verify Graphviz configuration with testdot

Source: https://plantuml.com/en/vizjs

Verifies that PlantUML can find and use the configured Graphviz/DOT engine. Run this after setting GRAPHVIZ_DOT to vizjs to confirm the setup works without a native Graphviz installation.

```plantuml
@startuml
testdot
@enduml

```

--------------------------------

### Gantt calendar in English (default)

Source: https://plantuml.com/en/gantt-diagram

Default Gantt calendar language is English (en). The example shows a Gantt chart with closed weekends, a project start date, tasks, dependencies, and colored date ranges.

```plantuml
@startgantt
saturday are closed
sunday are closed
Project starts 2021-01-01
[Prototype design end] as [TASK1] requires 19 days
[TASK1] is colored in Lavender/LightBlue
[Testing] requires 14 days
[TASK1]->[Testing]
2021-01-18 to 2021-01-22 are colored in salmon
@endgantt
```

--------------------------------

### Including subparts with !startsub, !endsub, and !includesub

Source: https://plantuml.com/en/preprocessing

Shows how to mark reusable sections with !startsub/!endsub and include them from another file with !includesub. The first pair shows file1.puml and its rendered equivalent; the second pair shows file2.puml and its rendered equivalent.

```plantuml
@startuml

A -> A : stuff1
!startsub BASIC
B -> B : stuff2
!endsub
C -> C : stuff3
!startsub BASIC
D -> D : stuff4
!endsub
@enduml

```

```plantuml
@startuml

A -> A : stuff1
B -> B : stuff2
C -> C : stuff3
D -> D : stuff4
@enduml

```

```plantuml
@startuml

title this contains only B and D
!includesub file1.puml!BASIC
@enduml

```

```plantuml
@startuml

title this contains only B and D
B -> B : stuff2
D -> D : stuff4
@enduml

```

--------------------------------

### Highlight today in Gantt diagram

Source: https://plantuml.com/en/gantt-diagram

Highlight today by setting the project start date, closing Sundays, coloring date ranges, naming a range, and coloring today. The example colors today in #AAF and names a vacation period.

```plantuml
@startgantt
Project starts the 20th of september 2018
sunday are close
2018/09/21 to 2018/09/23 are colored in salmon
2018/09/21 to 2018/09/30 are named [Vacation in the Bahamas]
today is 30 days after start and is colored in #AAF
[Foo] happens 40 days after start
[Dummy] requires 10 days and starts 10 days after start
@endgantt
```
Tokens:
Raw