From 0ef6dc54e3b4f8dbf8103058cce5e48eb5a2b186 Mon Sep 17 00:00:00 2001 From: KIRCHSTH Date: Sun, 11 Dec 2022 02:04:12 +0100 Subject: [PATCH] Create release (branch) v2.5.0 (2 - update all missing include paths with v2.5.0 too) --- LayoutOptions.md | 34 ++++++++++++------------ README.md | 42 +++++++++++++++--------------- percy/TestLabelsWithLineBreak.puml | 4 +-- 3 files changed, 40 insertions(+), 40 deletions(-) diff --git a/LayoutOptions.md b/LayoutOptions.md index 4c6396d1..957e2add 100644 --- a/LayoutOptions.md +++ b/LayoutOptions.md @@ -82,7 +82,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS") ```plantuml @startuml LAYOUT_LEFT_RIGHT Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml LAYOUT_LEFT_RIGHT() @@ -103,7 +103,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS") ```plantuml @startuml LAYOUT_LANDSCAPE Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml LAYOUT_LANDSCAPE() @@ -144,7 +144,7 @@ This can be enabled with `LAYOUT_WITH_LEGEND()`. ```plantuml @startuml LAYOUT_WITH_LEGEND Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml LAYOUT_WITH_LEGEND() @@ -177,7 +177,7 @@ The calculated legend has following differences: ```plantuml @startuml SHOW_LEGEND Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml Person(admin, "Administrator") System_Boundary(c1, 'Sample') { @@ -202,7 +202,7 @@ Legend labels and details can be defined via `\n` in `$legendTest` arguments too !if %variable_exists("RELATIVE_INCLUDE") !include %get_variable_value("RELATIVE_INCLUDE")/C4_Container.puml !else - !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml + !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml !endif ' $legendText with \n defines the label and details of the legend entry ("backend container" is label, "eight sided shape" is details) AddElementTag("backendContainer", $fontColor=$ELEMENT_FONT_COLOR, $bgColor="#335DA5", $shape=EightSidedShape(), $legendText="backend container\neight sided shape") @@ -234,7 +234,7 @@ Legend details can be deactivated via `SHOW_LEGEND($details=None())` !if %variable_exists("RELATIVE_INCLUDE") !include %get_variable_value("RELATIVE_INCLUDE")/C4_Container.puml !else - !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml + !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml !endif ' $legendText with \n defines the label and details of the legend entry ("backend container" is label, "eight sided shape" is details) AddElementTag("backendContainer", $fontColor=$ELEMENT_FONT_COLOR, $bgColor="#335DA5", $shape=EightSidedShape(), $legendText="backend container\neight sided shape") @@ -264,7 +264,7 @@ SHOW_LEGEND($details=None()) ```plantuml @startuml Layout With Whitespace Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml Person(a, "Person A") Container(b, "Container B", "techn") @@ -290,7 +290,7 @@ Therefore a floating legend can be added via SHOW_FLOATING_LEGEND(), positioned ```plantuml @startuml Compact Legend Layout Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml Person(a, "Person A") Container(b, "Container B", "techn") @@ -326,7 +326,7 @@ With `LAYOUT_AS_SKETCH()` you can make a difference. ```plantuml @startuml LAYOUT_AS_SKETCH Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml LAYOUT_AS_SKETCH() @@ -354,7 +354,7 @@ PNG does not support fallback fonts based on a PlantUML [bug](https://forum.plan ```plantuml @startuml LAYOUT_AS_SKETCH Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml SET_SKETCH_STYLE($bgColor="lightblue", $fontColor="darkblue", $warningColor="darkred", $footerWarning="Sketch", $footerText="Created for discussion") @@ -400,7 +400,7 @@ This can be enabled with `HIDE_STEREOTYPE()`. ```plantuml @startuml HIDE_STEREOTYPE Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml HIDE_STEREOTYPE() @@ -431,7 +431,7 @@ With the macros `HIDE_PERSON_SPRITE()`, `SHOW_PERSON_SPRITE()` and `SHOW_PERSON_ ```plantuml @startuml predefined sprites Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml Person(userA, "User A", "with predefined sprite person", "person") Person(userB, "User B", "with predefined sprite person2", "person2") @@ -444,7 +444,7 @@ Person(userB, "User B", "with predefined sprite person2", "person2") ```plantuml @startuml HIDE_PERSON_SPRITE Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml HIDE_PERSON_SPRITE() @@ -465,7 +465,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS") ```plantuml @startuml SHOW_PERSON_SPRITE Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml /' Not needed because this is the default with sprite "person" '/ SHOW_PERSON_SPRITE() @@ -487,7 +487,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS") ```plantuml @startuml SHOW_PERSON_SPRITE(sprite) Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml !define osaPuml https://raw.githubusercontent.com/Crashedmind/PlantUML-opensecurityarchitecture2-icons/master !include osaPuml/Common.puml !include osaPuml/User/all.puml @@ -511,7 +511,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS") ```plantuml @startuml SHOW_PERSON_PORTRAIT() Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml SHOW_PERSON_PORTRAIT() @@ -537,7 +537,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS") ```plantuml @startuml SHOW_PERSON_OUTLINE() Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml SHOW_PERSON_OUTLINE() diff --git a/README.md b/README.md index b1a6b83d..b05b6912 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Take a look at the following sample of a C4 Container Diagram: ```plantuml @startuml Basic Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml Person(admin, "Administrator") System_Boundary(c1, "Sample System") { @@ -135,7 +135,7 @@ Entities can also be decorated with icons/sprites using the $sprite parameter, f ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml !define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons !define FONTAWESOME https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/font-awesome-5 @@ -163,7 +163,7 @@ Similar to icons/sprites is it possible to add links to all elements and relatio ```plantuml @startuml Basic Sample -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml Person(admin, "Administrator", $sprite="person2", $link="https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/LayoutOptions.md#hide_person_sprite-or-show_person_spritesprite") System_Boundary(c1, "Sample System", $link="https://github.com/plantuml-stdlib/C4-PlantUML") { @@ -186,7 +186,7 @@ Elements and relationships can be decorated with tags and explained via a calcul ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml AddElementTag("v1.0", $borderColor="#d73027") AddElementTag("v1.1", $fontColor="#d73027") @@ -221,7 +221,7 @@ SHOW_LEGEND() > - `?arg`: argument optional (e.g. `?tags`); an optional argument can be directly set via its keyword `$arg=...` (e.g. `$tags="specificTag"`) without the other optional arguments - System Context & System Landscape diagrams - - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml` + - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Context.puml` - Macros: - `Person(alias, label, ?descr, ?sprite, ?tags, ?link)` - `Person_Ext` @@ -241,7 +241,7 @@ SHOW_LEGEND() - `robot2` - Container diagram - - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml` + - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml` - Additional Macros: - `Container(alias, label, ?techn, ?descr, ?sprite, ?tags, ?link)` - `ContainerDb` @@ -252,7 +252,7 @@ SHOW_LEGEND() - `Container_Boundary(alias, label, ?tags, ?link)` - Component diagram - - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml` + - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml` - Additional Macros: - `Component(alias, label, ?techn, ?descr, ?sprite, ?tags, ?link)` - `ComponentDb` @@ -262,7 +262,7 @@ SHOW_LEGEND() - `ComponentQueue_Ext` - Dynamic diagram - - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml` + - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Dynamic.puml` - Additional Macros: - `RelIndex(index, from, to, label, ?tags, ?link)` - (lowercase) `increment($offset=1)`: increase current index (procedure which has no direct output) @@ -274,7 +274,7 @@ SHOW_LEGEND() - `SetIndex($new_index)`: returns new set index and calculates next index (function which can be used as argument) - Deployment diagram - - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml` + - Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Deployment.puml` - Additional Macros: - `Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, ?link)` - `Node(alias, label, ?type, ?descr, ?sprite, ?tags, ?link)`: short name of Deployment_Node() @@ -299,7 +299,7 @@ In following sample a person uses different systems, and a group of persons whic ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml HIDE_STEREOTYPE() Person(a, "A") @@ -341,7 +341,7 @@ In following sample a person uses different systems, and a group of persons whic ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml HIDE_STEREOTYPE() Person(a, "A") @@ -380,7 +380,7 @@ In following sample the floating legend should be in the left bottom corner of t ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml !define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons !define FONTAWESOME https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/font-awesome-5 @@ -431,7 +431,7 @@ C4-PlantUML offers predefined person and robot sprites which can be directly use ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml Person(pB, "Sam", $sprite="person2") Person_Ext(pA, "Bob", $sprite="person") @@ -458,7 +458,7 @@ Color of the displayed images can be changed with `,color={color}`. ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml 'stdlib users.puml defines sprite "users" !include @@ -490,7 +490,7 @@ Relationship specific sprites are typically smaller and therefore following opti ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Context.puml Person(user, "User") Person(user1, "User 1") @@ -611,7 +611,7 @@ Like the element specific tag definitions exist boundary specific calls with the ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml UpdateElementStyle(person, $fontColor="green") AddElementTag("v1.0", $fontColor="#d73027", $borderColor="#d73027") @@ -657,7 +657,7 @@ SHOW_LEGEND(false) ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml !define osaPuml https://raw.githubusercontent.com/Crashedmind/PlantUML-opensecurityarchitecture2-icons/master !include osaPuml/Common.puml @@ -716,7 +716,7 @@ SHOW_LEGEND() ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml ' Update the generic boundary style and the "system", "enterprise", "container" boundaries styles too UpdateBoundaryStyle($bgColor="gold", $fontColor="brown", $borderColor="brown") @@ -767,7 +767,7 @@ If the custom (color) schema is defined via `UpdateElementStyle()` then the lege ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Context.puml !$COLOR_A_5 = "#7f3b08" !$COLOR_A_4 = "#b35806" @@ -821,7 +821,7 @@ Following sample uses all 3 different property definitions (and the aligned depl ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Deployment.puml ' default header Property, Value AddProperty("Name", "Flash") @@ -861,7 +861,7 @@ C4-PlantUML offers version information like PlantUML with its `%version()` call. ```plantuml @startuml -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml ' existing plantuml version as text %version() diff --git a/percy/TestLabelsWithLineBreak.puml b/percy/TestLabelsWithLineBreak.puml index 64fe7bb0..928ef8f1 100644 --- a/percy/TestLabelsWithLineBreak.puml +++ b/percy/TestLabelsWithLineBreak.puml @@ -5,7 +5,7 @@ !include %get_variable_value("RELATIVE_INCLUDE")/C4_Deployment.puml !else !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml - !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml + !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Deployment.puml !endif Enterprise_Boundary(eb, "Enterprise\nBoundary") { @@ -30,7 +30,7 @@ Node(n2, "A node label", "PlantUML packages have no automatic line breaks, type !if %variable_exists("RELATIVE_INCLUDE") !include %get_variable_value("RELATIVE_INCLUDE")/C4_Dynamic.puml !else - !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml + !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Dynamic.puml !endif Component(from, "From component")