What is PlantUML
PlantUML is an open source text language to generate UML (Unified Modeling Language) diagrams.
Tip
Sample 1
```{plantuml}Alice -> Bob: Authentication RequestBob --> Alice: Authentication ResponseAlice -> Bob: Another authentication RequestAlice <-- Bob: another authentication Response```
Sample 2
```{plantuml}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]```
Sample 3
```{plantuml}(*) --> "Find Event""Find Event" -> "Attend Event"if "Capacity?" then->[ok] "Create Ticket"else-->[full] if "Standby?" then->[ok] "Standby Ticket"else-->[no] "Cancel Ticket""Cancel Ticket" --> (*)endifendif"Create Ticket" --> ==show=="Standby Ticket" --> ==show====show== --> "Show Ticket""Show Ticket" --> (*)```
Sample 4
```{plantuml}!define StudentName Misidentified vocational school student
Sample 5
```{plantuml}@startumlUser ||--o{ WatchRepositoryWatchRepository }o--|| RepositoryRepository ||--o{ IssueIssue ||--o{ EventUser ||--o{ WatchIssueWatchIssue }o--|| Issue@enduml```
Sample 6
```{plantuml}actor ClientClient -> Rails : HTTP requestRails -> Hypernova : { "name": "Editor", "props": { "foo", "bar" } }Hypernova -> Rails : "<div class='editor'>...</div>"Rails -> Client : HTTP response```
Sample 7
```{plantuml}actor Foo1boundary Foo2control Foo3entity Foo4database Foo5collections Foo6Foo1 -> Foo2 : To boundaryFoo1 -> Foo3 : To controlFoo1 -> Foo4 : To entityFoo1 -> Foo5 : To databaseFoo1 -> Foo6 : To collections```
Sample 8
```{plantuml}|Swimlane1|start:foo1;|#AntiqueWhite|Swimlane2|:foo2;:foo3;|Swimlane1|:foo4;|Swimlane2|:foo5;stop```
Sample 9
```{plantuml}Alice -> Bob: Authentication Requestalt successful caseBob -> Alice: Authentication Acceptedelse some kind of failureBob -> Alice: Authentication Failuregroup My own labelAlice -> Log : Log attack startloop 1000 timesAlice -> Bob: DNS AttackendAlice -> Log : Log attack endendelse Another type of failureBob -> Alice: Please repeatend```
Sample 10
```{plantuml}:Process1;note leftMulti-line annotationMulti-line annotationend notefork:ParallelProcessing2-1;fork again:ParallelProcessing2-2;end forkif (some decision) then (yes):Process3;elseif (some different decision) then (yes):Process4;else (not applicable):Process5;endifrepeat:Process6;repeat while (repeat decision?)while (repeat decision?) is (loop necessary):Process7;-> string arrow;endwhile (loop unnecessary)end```
LaTeX syntax
To use LaTeX syntax, use the label {latex}to write equations with MathJax. In addition, use $`...` $ for inlineMath, which allows you to embed equations in text.
For sample LaTeX notations by MathJax, please refer to the MathJax basic tutorial and quick reference .