Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Diagrams from Textual Descriptions in Gitlab
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Examples
Diagrams from Textual Descriptions in Gitlab
Commits
2dfde952
Verified
Commit
2dfde952
authored
3 years ago
by
Huste, Tobias
Browse files
Options
Downloads
Patches
Plain Diff
Add PlantUML examples
parent
22c31c9c
No related branches found
Branches containing commit
No related tags found
1 merge request
!1
Create PlantUML examples
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+23
-19
23 additions, 19 deletions
README.md
examples/plantuml.md
+133
-0
133 additions, 0 deletions
examples/plantuml.md
with
156 additions
and
19 deletions
README.md
+
23
−
19
View file @
2dfde952
...
...
@@ -6,9 +6,31 @@ This document provides you with a set of examples that can be used to create
diagrams.
## PlantUML
Besides various UML diagrams, PlantUML has support for various other
software development related formats.
The
[
official documentation
](
https://plantuml.com/
)
provides you with an
extensive description of the syntax and supported format.
More examples can be found in the
[
PlantUML
](
examples/plantuml.md
)
file.
### Sequence Diagram
### Gantt Diagram
```
plantuml
@startgantt
printscale weekly
Project starts the 1st of July 2021
[Literature Review] lasts 4 weeks
[Literature Review] is 100% completed
then [Run Experiments] lasts 12 weeks
[Run Experiments] is 70% completed
-- Phase Two --
then [Data Analysis] lasts 8 weeks
[Data Analysis] is 0% completed
then [Write Publication] lasts 6 weeks
[Write Publication] is 0% completed
@endgantt
```
### Sequence Diagram
```
plantuml
@startuml
participant User
...
...
@@ -32,24 +54,6 @@ deactivate A
@enduml
```
### Gantt Diagram
```
plantuml
@startgantt
printscale weekly
Project starts the 1st of July 2021
[Literature Review] lasts 4 weeks
[Literature Review] is 100% completed
then [Run Experiments] lasts 12 weeks
[Run Experiments] is 70% completed
-- Phase Two --
then [Data Analysis] lasts 8 weeks
[Data Analysis] is 0% completed
then [Write Publication] lasts 6 weeks
[Write Publication] is 0% completed
@endgantt
```
### Display JSON Data
```
plantuml
@startjson
...
...
This diff is collapsed.
Click to expand it.
examples/plantuml.md
0 → 100644
+
133
−
0
View file @
2dfde952
### Sequence Diagram
<details>
<summary>
Show code
</summary>
<div>
```plantuml
@startuml
participant User
User -> A: DoWork
activate A
A -> B: << createRequest >>
activate B
B -> C: DoWork
activate C
C --> B: WorkDone
destroy C
B --> A: RequestCreated
deactivate B
A -> User: Done
deactivate A
@enduml
```
</div>
</details>
```
plantuml
@startuml
participant User
User -> A: DoWork
activate A
A -> B: << createRequest >>
activate B
B -> C: DoWork
activate C
C --> B: WorkDone
destroy C
B --> A: RequestCreated
deactivate B
A -> User: Done
deactivate A
@enduml
```
### Sequence Diagram
```
plantuml
@startuml
participant User
User -> A: DoWork
activate A
A -> B: << createRequest >>
activate B
B -> C: DoWork
activate C
C --> B: WorkDone
destroy C
B --> A: RequestCreated
deactivate B
A -> User: Done
deactivate A
@enduml
```
### Display JSON Data
```
plantuml
@startjson
{
"firstName": "John",
"lastName": "Smith",
"age": 28,
"address": {
"streetAddress": "Bautzner Landstr. 400",
"city": "Dresden",
"state": "Saxony",
"postalCode": "01328"
},
"offices": [
{
"building": 512,
"room": 1234
},
{
"building": 312,
"room": 3
}
],
"departments": []
}
@endjson
```
### Display JSON Data
```
plantuml
@startjson
{
"firstName": "John",
"lastName": "Smith",
"age": 28,
"address": {
"streetAddress": "Bautzner Landstr. 400",
"city": "Dresden",
"state": "Saxony",
"postalCode": "01328"
},
"offices": [
{
"building": 512,
"room": 1234
},
{
"building": 312,
"room": 3
}
],
"departments": []
}
@endjson
```
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment