Skip to content

Commit

Permalink
Create release (branch) v2.5.0 (2 - update all missing include paths …
Browse files Browse the repository at this point in the history
…with v2.5.0 too)
  • Loading branch information
kirchsth committed Dec 11, 2022
1 parent 6c7e581 commit 0ef6dc5
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 40 deletions.
34 changes: 17 additions & 17 deletions LayoutOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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') {
Expand All @@ -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")
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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")
Expand All @@ -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")
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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")
Expand All @@ -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()
Expand All @@ -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()
Expand All @@ -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
Expand All @@ -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()
Expand All @@ -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()
Expand Down
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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") {
Expand All @@ -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
Expand Down Expand Up @@ -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") {
Expand All @@ -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")
Expand Down Expand Up @@ -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`
Expand All @@ -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`
Expand All @@ -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`
Expand All @@ -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)
Expand All @@ -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()
Expand All @@ -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")
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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")
Expand All @@ -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 <office/users/users.puml>
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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()
Expand Down
4 changes: 2 additions & 2 deletions percy/TestLabelsWithLineBreak.puml
Original file line number Diff line number Diff line change
Expand Up @@ -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") {
Expand All @@ -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")
Expand Down

0 comments on commit 0ef6dc5

Please sign in to comment.