Skip to content

Commit 1912d4a

Browse files
Chng-Zhi-XuanChng-Zhi-Xuan
authored
Add support for PlantUML diagrams (#887)
2 parents cafcb05 + a0b3c0c commit 1912d4a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+840
-3
lines changed

‎docs/_markbind/layouts/userGuide/navigation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Adding Pages]({{baseUrl}}/userGuide/addingPages.html)
88
* [MarkBind Syntax Overview]({{baseUrl}}/userGuide/markBindSyntaxOverview.html)
99
* [Formatting Contents]({{baseUrl}}/userGuide/formattingContents.html)
10+
* [Inserting PlantUML Diagrams]({{baseUrl}}/userGuide/puml.html)
1011
* [Using Components]({{baseUrl}}/userGuide/usingComponents.html)
1112
* [Using HTML, JavaScript, CSS]({{baseUrl}}/userGuide/usingHtmlJavaScriptCss.html)
1213
* [Using Plugins]({{baseUrl}}/userGuide/usingPlugins.html)

‎docs/_markbind/navigation/userGuideSections.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Adding Pages]({{baseUrl}}/userGuide/addingPages.html)
88
* [MarkBind Syntax Overview]({{baseUrl}}/userGuide/markBindSyntaxOverview.html)
99
* [Formatting Contents]({{baseUrl}}/userGuide/formattingContents.html)
10+
* [Inserting PlantUML Diagrams]({{baseUrl}}/userGuide/puml.html)
1011
* [Using Components]({{baseUrl}}/userGuide/usingComponents.html)
1112
* [Using HTML, JavaScript, CSS]({{baseUrl}}/userGuide/usingHtmlJavaScriptCss.html)
1213
* [Using Plugins]({{baseUrl}}/userGuide/usingPlugins.html)

‎docs/userGuide/diagrams/activity.puml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
@startuml
2+
start
3+
if (condition A) then (yes)
4+
:Text 1;
5+
elseif (condition B) then (yes)
6+
:Text 2;
7+
stop
8+
elseif (condition C) then (yes)
9+
:Text 3;
10+
elseif (condition D) then (yes)
11+
:Text 4;
12+
else (nothing)
13+
:Text else;
14+
endif
15+
stop
16+
@enduml

‎docs/userGuide/diagrams/archimate.puml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
@startuml
2+
3+
sprite $bProcess jar:archimate/business-process
4+
sprite $aService jar:archimate/application-service
5+
sprite $aComponent jar:archimate/application-component
6+
7+
archimate #Business "Handle claim" as HC <<business-process>>
8+
archimate #Business "Capture Information" as CI <<business-process>>
9+
archimate #Business "Notify\nAdditional Stakeholders" as NAS <<business-process>>
10+
archimate #Business "Validate" as V <<business-process>>
11+
archimate #Business "Investigate" as I <<business-process>>
12+
archimate #Business "Pay" as P <<business-process>>
13+
14+
HC *-down- CI
15+
HC *-down- NAS
16+
HC *-down- V
17+
HC *-down- I
18+
HC *-down- P
19+
20+
CI -right->> NAS
21+
NAS -right->> V
22+
V -right->> I
23+
I -right->> P
24+
25+
archimate #APPLICATION "Scanning" as scanning <<application-service>>
26+
archimate #APPLICATION "Customer admnistration" as customerAdministration <<application-service>>
27+
archimate #APPLICATION "Claims admnistration" as claimsAdministration <<application-service>>
28+
archimate #APPLICATION Printing <<application-service>>
29+
archimate #APPLICATION Payment <<application-service>>
30+
31+
scanning -up-> CI
32+
customerAdministration -up-> CI
33+
claimsAdministration -up-> NAS
34+
claimsAdministration -up-> V
35+
claimsAdministration -up-> I
36+
Payment -up-> P
37+
38+
Printing -up-> V
39+
Printing -up-> P
40+
41+
archimate #APPLICATION "Document\nManagement\nSystem" as DMS <<application-component>>
42+
archimate #APPLICATION "General\nCRM\nSystem" as CRM <<application-component>>
43+
archimate #APPLICATION "Home & Away\nPolicy\nAdministration" as HAPA <<application-component>>
44+
archimate #APPLICATION "Home & Away\nFinancial\nAdministration" as HFPA <<application-component>>
45+
46+
DMS .up.|> scanning
47+
DMS .up.|> Printing
48+
CRM .up.|> customerAdministration
49+
HAPA .up.|> claimsAdministration
50+
HFPA .up.|> Payment
51+
52+
legend left
53+
Example from the "Archisurance case study" (OpenGroup).
54+
See
55+
==
56+
<$bProcess> :business process
57+
==
58+
<$aService> : application service
59+
==
60+
<$aComponent> : application component
61+
endlegend
62+
63+
@enduml

‎docs/userGuide/diagrams/class.puml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
@startuml
2+
3+
package "Classic Collections" #DDDDDD {
4+
Object <|-- ArrayList
5+
}
6+
7+
package net.sourceforge.plantuml {
8+
Object <|-- Demo1
9+
Demo1 *- Demo2
10+
}
11+
12+
@enduml

‎docs/userGuide/diagrams/component.puml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
@startuml
2+
3+
package "Some Group" {
4+
HTTP - [First Component]
5+
[Another Component]
6+
}
7+
8+
node "Other Groups" {
9+
FTP - [Second Component]
10+
[First Component] --> FTP
11+
}
12+
13+
cloud {
14+
[Example 1]
15+
}
16+
17+
18+
database "MySql" {
19+
folder "This is my folder" {
20+
[Folder 3]
21+
}
22+
frame "Foo" {
23+
[Frame 4]
24+
}
25+
}
26+
27+
28+
[Another Component] --> [Example 1]
29+
[Example 1] --> [Folder 3]
30+
[Folder 3] --> [Frame 4]
31+
32+
@enduml

‎docs/userGuide/diagrams/ditaa.puml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
@startditaa
2+
+--------+ +-------+ +-------+
3+
| +---+ ditaa +--> | |
4+
| Text | +-------+ |diagram|
5+
|Document| |!magic!| | |
6+
| {d}| | | | |
7+
+---+----+ +-------+ +-------+
8+
: ^
9+
| Lots of work |
10+
+-------------------------+
11+
@endditaa

‎docs/userGuide/diagrams/entityrelation.puml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
@startuml
2+
3+
' hide the spot
4+
hide circle
5+
6+
' avoid problems with angled crows feet
7+
skinparam linetype ortho
8+
9+
entity "Entity01" as e01 {
10+
*e1_id : number <<generated>>
11+
--
12+
*name : text
13+
description : text
14+
}
15+
16+
entity "Entity02" as e02 {
17+
*e2_id : number <<generated>>
18+
--
19+
*e1_id : number <<FK>>
20+
other_details : text
21+
}
22+
23+
entity "Entity03" as e03 {
24+
*e3_id : number <<generated>>
25+
--
26+
*e1_id : number <<FK>>
27+
other_details : text
28+
}
29+
30+
e01 ||..o{ e02
31+
e01 |o..o{ e03
32+
33+
@enduml

‎docs/userGuide/diagrams/gantt.puml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@startgantt
2+
[Prototype design] lasts 13 days and is colored in Lavender/LightBlue
3+
[Test prototype] lasts 9 days and is colored in Coral/Green and starts 3 days after [Prototype design]'s end
4+
[Write tests] lasts 5 days and ends at [Prototype design]'s end
5+
[Hire tests writers] lasts 6 days and ends at [Write tests]'s start
6+
[Init and write tests report] is colored in Coral/Green
7+
[Init and write tests report] starts 1 day before [Test prototype]'s start and ends at [Test prototype]'s end
8+
@endgantt

‎docs/userGuide/diagrams/object.puml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
@startuml
2+
object Object01
3+
object Object02
4+
object Object03
5+
object Object04
6+
object Object05
7+
object Object06
8+
object Object07
9+
object Object08
10+
11+
object user {
12+
name = "Dummy"
13+
id = 123
14+
}
15+
16+
Object01 <|-- Object02
17+
Object03 *-- Object04
18+
Object05 o-- "4" Object06
19+
Object07 .. Object08 : some labels
20+
@enduml

0 commit comments

Comments
 (0)