Skip to content

Commit 141f46c

Browse files
committed
Merge remote-tracking branch 'origin/main' into plantuml-theming
2 parents ea53021 + 89ff32e commit 141f46c

File tree

4 files changed

+135
-19
lines changed

4 files changed

+135
-19
lines changed

CHANGELOG.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Changelog
2+
3+
<!-- markdownlint-disable MD024-->
4+
5+
All notable changes to this project will be documented in this file.
6+
7+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
8+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9+
10+
<!-- changelog -->
11+
12+
## [1.4.0] - 2025-07-01
13+
14+
### Added
15+
16+
- C4 level definitions and styling
17+
18+
### Changed
19+
20+
- Refactored skin parameters across multiple theme files for consistency
21+
- Updated border color settings for C4 levels to 'none'
22+
- Improved example files with local input files and consistent include paths
23+
- Enhanced mind map styling with style enhancements
24+
25+
### Fixed
26+
27+
- Node borders fixed
28+
- Removed duplicate and deprecated settings across theme files
29+
- Improved spacing and layout settings
30+
31+
## [1.3.0] - 2025-06-11
32+
33+
### Changed
34+
35+
- Updated layout settings and skin parameters across multiple PUML theme files
36+
37+
## [1.2.0] - 2025-04-14
38+
39+
### Added
40+
41+
- Mind map style adjustments and enhancements
42+
- Complete include URL examples (commented for direct visibility)
43+
- .gitignore file
44+
- Diagram hints for better usability
45+
46+
### Changed
47+
48+
- Linked examples in README.md for better navigation
49+
- Corrected spacing in various theme files
50+
51+
### Fixed
52+
53+
- Fixed node borders in diagrams
54+
55+
## [1.1.0] - 2024-04-23
56+
57+
### Changed
58+
59+
- Font changed from "Arial" to "Helvetica" for better consistency
60+
61+
### Fixed
62+
63+
- Multiple sequence diagram theme updates and improvements
64+
65+
## [1.0.0] - 2024-01-04
66+
67+
### Added
68+
69+
- Initial PlantUML theme collection for doubleSlash CI styling
70+
- Use case diagram theme (`puml-theme-doubleslash-usecase.puml`)
71+
- Activity diagram theme (`puml-theme-doubleslash-activity.puml`) with piprocess support
72+
- System diagram theme for C4 level 1 and 2 (`puml-theme-doubleslash-system.puml`)
73+
- Class diagram theme, also supports ER-diagrams (`puml-theme-doubleslash-class.puml`)
74+
- Sequence diagram theme (`puml-theme-doubleslash-sequence.puml`)
75+
- Gantt diagram theme (`pgantt-theme-doubleslash.puml`)
76+
- Mind map theme (`puml-theme-doubleslash-mindmap.puml`)
77+
- General theme file (`puml-theme-doubleslash-general.puml`)
78+
- Main theme file (`puml-theme-doubleslash.puml`)
79+
- Initial `doubleslash_style.theme` file
80+
- README with comprehensive usage instructions and examples
81+
- Support for 7 different diagram types with examples
82+
83+
### Changed
84+
85+
- Font standardized to Helvetica across all themes
86+
- Multiple refinements to styling parameters throughout development
87+
- Timeline font size adjusted to 12 for better readability
88+
- Various color and layout optimizations
89+
90+
### Fixed
91+
92+
- Consistent styling across all diagram types established
93+
- Theme parameter conflicts resolved
94+
95+
[Unreleased]: https://github.com/doubleSlashde/umltheme/compare/v1.4.0...HEAD
96+
[1.4.0]: https://github.com/doubleSlashde/umltheme/compare/v1.3.0...v1.4.0
97+
[1.3.0]: https://github.com/doubleSlashde/umltheme/compare/v1.2.0...v1.3.0
98+
[1.2.0]: https://github.com/doubleSlashde/umltheme/compare/v1.1.0...v1.2.0
99+
[1.1.0]: https://github.com/doubleSlashde/umltheme/compare/v1.0.0...v1.1.0
100+
[1.0.0]: https://github.com/doubleSlashde/umltheme/releases/tag/v1.0.0

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,62 @@
11
# umltheme
2+
23
This repo contains doubleSlash CI styling information to include in plantUML drawings
34
Use stylings by including the theme file at the top of your code.
5+
6+
## Changelog
7+
8+
The changelog is maintained in [CHANGELOG.md](./CHANGELOG.md). For the latest version, see [releases](https://github.com/doubleSlashde/umltheme/releases).
9+
10+
## Supported themes
11+
412
### Include for use case diagram
5-
```
13+
14+
``` txt
615
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-usecase.puml
716
```
17+
818
### Include for activity diagram
9-
```
19+
20+
``` txt
1021
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-activity.puml
1122
```
23+
1224
### Include for system diagram (C4 level 1 and 2)
13-
```
25+
26+
``` txt
1427
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-system.puml
1528
```
29+
1630
### Include for class diagram (also for ER-diagrams)
17-
```
31+
32+
``` txt
1833
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-class.puml
1934
```
20-
### Include for sequence diagram
21-
```
35+
36+
### Include for sequence diagram
37+
38+
``` txt
2239
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-sequence.puml
2340
```
2441

2542
### Include for Gantt diagram
26-
```
43+
44+
``` txt
2745
@startgantt
2846
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/pgantt-theme-doubleslash.puml
2947
...
3048
```
3149

3250
### Include for mind map
33-
```
51+
52+
``` txt
3453
@startmindmap
3554
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-mindmap.puml
3655
...
3756
```
3857

3958
## Support for the following diagrams
59+
4060
1. Use Cases (see [examples/usecase.puml](examples/usecase.puml)): diagram to support documentation of PEOPLE and PROCESS.
4161
2. Activity (see [examples/activity_model.puml](examples/activity_model.puml)): diagram to illustrate activities in a PROCESS. It can be used as an alternative to BPMN diagrams.
4262
3. System model (see [examples/systemmodel.puml](examples/systemmodel.puml)): diagram for a functional SYSTEM view. Represents the first two layers of a C4 model (System context and Containers)

examples/input/systemmodel with levels.puml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
@startuml
1+
@startuml C5 Example: Online Shop System
22

33
title "C5 Example: Online Shop System"
44

55
' Context Level
66
rectangle "Online Shop System" <<context>> {
77

88
' Container Level
9-
package "Web Application" <<container>> {
9+
rectangle "Web Application" <<container>> {
1010
' Component Level
1111
rectangle "Order Management" <<component>> {
1212
' Module Level
@@ -39,6 +39,5 @@ agent "Shipping Service" as ShippingService <<external>>
3939
[Order Service] --> [PostgreSQL] : stores data
4040
[User Service] --> [PostgreSQL] : stores data
4141
[Order Service] --> ShippingService : requests shipping
42-
[PaymentGatewayAdapter.java] --> PaymentProvider : requests payment
4342

4443
@enduml

puml-theme-doubleslash-system.puml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ skinparam RectangleBorderColor DS_BLUE
1717
skinparam RectangleBorderThickness 1
1818
skinparam RectangleBorderStyle solid
1919
skinparam RectangleFontColor black
20-
20+
skinparam RectangleFontStyle normal
2121

2222
' Summary Table
2323
' *C5 Level* *Stereotype* *Description*
@@ -26,7 +26,6 @@ skinparam RectangleFontColor black
2626
' Component <<component>> Major logical parts inside a container
2727
' Module <<module>> Groupings of code/packages/namespaces/subsystems
2828
' Code <<code>> Classes, files, functions, methods
29-
3029
' Define colors for each C4+M level
3130
!define CONTEXT_BG #FFFFFF
3231
!define CONTAINER_BG #EEF8FE
@@ -41,22 +40,22 @@ skinparam RectangleFontColor<<context>> black
4140

4241
' Container Level
4342
skinparam RectangleBackgroundColor<<container>> CONTAINER_BG
44-
skinparam RectangleBorderColor<<container>> white
43+
skinparam RectangleBorderColor<<container>> none
4544
skinparam RectangleFontColor<<container>> black
4645

4746
' Component Level
4847
skinparam RectangleBackgroundColor<<component>> COMPONENT_BG
49-
skinparam RectangleBorderColor<<component>> white
48+
skinparam RectangleBorderColor<<component>> none
5049
skinparam RectangleFontColor<<component>> black
5150

5251
' Module Level
5352
skinparam RectangleBackgroundColor<<module>> MODULE_BG
54-
skinparam RectangleBorderColor<<module>> white
53+
skinparam RectangleBorderColor<<module>> none
5554
skinparam RectangleFontColor<<module>> black
5655

5756
' Code Level
5857
skinparam RectangleBackgroundColor<<code>> CODE_BG
59-
skinparam RectangleBorderColor<<code>> white
58+
skinparam RectangleBorderColor<<code>> none
6059
skinparam RectangleFontColor<<code>> white
6160

6261
skinparam PackageBackgroundColor ALICEBLUE
@@ -85,5 +84,3 @@ skinparam interfaceFontColor black
8584

8685
skinparam interfaceBorderColor<<external>> DS_GREY
8786
skinparam interfaceBackgroundColor<<external>> DS_GREY
88-
89-

0 commit comments

Comments
 (0)