Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve colour palette of PlantUML graphs #180

Merged
merged 3 commits into from
Aug 9, 2021
Merged

Improve colour palette of PlantUML graphs #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8167650
Create draft PR for #166
pablo-de-andres Aug 5, 2021
418a10b
First draft of new colour palette
pablo-de-andres Aug 5, 2021
01147b4
Updated colours
pablo-de-andres Aug 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions docs/source/detailed_design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,22 @@ For a more general overview, go to [getting started](./getting_started.md#genera
:caption: Standard design
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
ClassBackgroundColor #E3E3E3
ClassBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
InterfaceBackgroundColor transparent
InterfaceBorderColor #179c7d
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
PackageBorderColor black
PackageBackgroundColor #9FC6DE
ArrowColor #179c7d
}

allow_mixing
actor User

Expand Down Expand Up @@ -203,6 +219,21 @@ cuds_obj = some_namespace.OntologyClass()
:caption: `add` method call
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
sequenceBoxBackgroundColor #9FC6DE
sequenceBoxBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
ParticipantBackgroundColor #E3E3E3
ParticipantBorderColor black
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
SequenceLifeLineBorderColor #179c7d
ArrowColor #179c7d
}

actor user
box "Semantic Layer"
participant "cuds" as cuds
Expand Down Expand Up @@ -243,6 +274,21 @@ cuds_obj = some_namespace.OntologyClass()
:caption: `get` method call
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
sequenceBoxBackgroundColor #9FC6DE
sequenceBoxBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
ParticipantBackgroundColor #E3E3E3
ParticipantBorderColor black
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
SequenceLifeLineBorderColor #179c7d
ArrowColor #179c7d
}

actor user
box "Semantic Layer"
participant "cuds" as cuds
Expand Down Expand Up @@ -286,6 +332,21 @@ cuds_obj = some_namespace.OntologyClass()
:caption: `update` method call
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
sequenceBoxBackgroundColor #9FC6DE
sequenceBoxBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
ParticipantBackgroundColor #E3E3E3
ParticipantBorderColor black
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
SequenceLifeLineBorderColor #179c7d
ArrowColor #179c7d
}

actor user
box "Semantic Layer"
participant "cuds" as cuds
Expand Down Expand Up @@ -327,6 +388,21 @@ cuds_obj = some_namespace.OntologyClass()
:caption: `remove` method call
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
sequenceBoxBackgroundColor #9FC6DE
sequenceBoxBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
ParticipantBackgroundColor #E3E3E3
ParticipantBorderColor black
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
SequenceLifeLineBorderColor #179c7d
ArrowColor #179c7d
}

actor user
box "Semantic Layer"
participant "cuds" as cuds
Expand Down Expand Up @@ -363,6 +439,21 @@ cuds_obj = some_namespace.OntologyClass()
:caption: `iter` method call
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
sequenceBoxBackgroundColor #9FC6DE
sequenceBoxBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
ParticipantBackgroundColor #E3E3E3
ParticipantBorderColor black
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
SequenceLifeLineBorderColor #179c7d
ArrowColor #179c7d
}

actor user
box "Semantic Layer"
participant "cuds" as cuds
Expand Down Expand Up @@ -421,6 +512,16 @@ To simplify and group functionality, we built an inheritance scheme:
:caption: Session inheritance scheme
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
ClassBackgroundColor #E3E3E3
ClassBorderColor black
PackageBorderColor black
PackageBackgroundColor #9FC6DE
ArrowColor #179c7d
}

rectangle "OSP-core" as OSP {
abstract class Session {
Registry : registry
Expand Down
37 changes: 37 additions & 0 deletions docs/source/fundamentals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ Based on how tools communicate with other tools, we can define 3 levels:
.. uml::
:align: center
:caption: Compatibility

skinparam {
linetype ortho
Shadowing false
BackgroundColor transparent
RectangleBackgroundColor #E3E3E3
RectangleBorderColor black
ArrowColor #179c7d
}

rectangle A
rectangle B
Expand All @@ -39,6 +48,14 @@ Based on how tools communicate with other tools, we can define 3 levels:
.. uml::
:align: center
:caption: De Facto Standard

skinparam {
Shadowing false
BackgroundColor transparent
RectangleBackgroundColor #E3E3E3
RectangleBorderColor black
ArrowColor #179c7d
}

rectangle A
rectangle B
Expand All @@ -64,6 +81,17 @@ Based on how tools communicate with other tools, we can define 3 levels:
.. uml::
:align: center
:caption: Interoperability

skinparam {
linetype ortho
Shadowing false
BackgroundColor transparent
RectangleBackgroundColor #E3E3E3
RectangleBorderColor black
UsecaseBackgroundColor transparent
UsecaseBorderColor #55A5D9
ArrowColor #179c7d
}

usecase x as "open standard"
rectangle A
Expand Down Expand Up @@ -167,6 +195,15 @@ For the IRIs, `dbpedia`'s namespace was used.
:align: center
:caption: RDF triple sample

skinparam {
linetype ortho
Shadowing false
BackgroundColor transparent
UsecaseBorderColor black
UsecaseBackgroundColor #E3E3E3
ArrowColor #179c7d
}

(dbr:J._R._R._Tolkien) as tolkien
(dbr:The_Lord_of_the_Rings) as lotr
lotr -> tolkien : dbo:author
Expand Down
44 changes: 36 additions & 8 deletions docs/source/general_architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,26 @@ The following architecture has the aim to cover and support the goals presented
:align: center
:caption: Interoperability concept

skinparam linetype ortho
skinparam {
linetype ortho
Shadowing false
BackgroundColor transparent
UsecaseBackgroundColor #E3E3E3
UsecaseBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
PackageBorderColor black
PackageBackgroundColor #9FC6DE
ArrowColor #179c7d
ranksep 10
}


actor user
rectangle SimPhoNy {
usecase "OSP-core" as osp #FFFFFF
usecase "OSP-core" as osp
usecase "database\nwrapper" as db_wrapper
usecase "simulation\nwrapper" as sim_wrapper
usecase wrapper
Expand Down Expand Up @@ -46,14 +62,26 @@ For that, a 3 layer schema is used:
:caption: Three layered design
:align: center

skinparam linetype ortho
skinparam {
linetype ortho
Shadowing false
BackgroundColor transparent
RectangleBackgroundColor #E3E3E3
RectangleBorderColor black
ActorBackgroundColor transparent
ActorBorderColor #179c7d
DatabaseBackgroundColor transparent
DatabaseBorderColor #179c7d
PackageBorderColor #55A5D9
PackageBackgroundColor transparent
ArrowColor #179c7d
ranksep 10
}

skinparam rectangle<<invisible>> {
backgroundColor Transparent
borderColor Transparent
titleFontColor Red
stereotypeFontColor Transparent
shadowing false
BorderColor Transparent
BackgroundColor transparent
stereotypeFontColor transparent
}
Actor user

Expand Down
12 changes: 12 additions & 0 deletions docs/source/wrapper_development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,18 @@ sessions.
:caption: Simplified session inheritance scheme
:align: center

skinparam {
Shadowing false
BackgroundColor transparent
ClassBackgroundColor #E3E3E3
ClassBorderColor black
PackageBorderColor black
PackageBackgroundColor #9FC6DE
ArrowColor #179c7d
NoteBackgroundColor transparent
NoteBorderColor black
}

rectangle "OSP-core" as OSP {
abstract class Session {
}
Expand Down