Skip to content

Commit 0ef6dc5

Browse files
kirchsthkirchsth
committed
Create release (branch) v2.5.0 (2 - update all missing include paths with v2.5.0 too)
1 parent 6c7e581 commit 0ef6dc5

File tree

3 files changed

+40
-40
lines changed

3 files changed

+40
-40
lines changed

‎LayoutOptions.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS")
8282

8383
```plantuml
8484
@startuml LAYOUT_LEFT_RIGHT Sample
85-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
85+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
8686
8787
LAYOUT_LEFT_RIGHT()
8888
@@ -103,7 +103,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS")
103103

104104
```plantuml
105105
@startuml LAYOUT_LANDSCAPE Sample
106-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
106+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
107107
108108
LAYOUT_LANDSCAPE()
109109
@@ -144,7 +144,7 @@ This can be enabled with `LAYOUT_WITH_LEGEND()`.
144144

145145
```plantuml
146146
@startuml LAYOUT_WITH_LEGEND Sample
147-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
147+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
148148
149149
LAYOUT_WITH_LEGEND()
150150
@@ -177,7 +177,7 @@ The calculated legend has following differences:
177177

178178
```plantuml
179179
@startuml SHOW_LEGEND Sample
180-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
180+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
181181
182182
Person(admin, "Administrator")
183183
System_Boundary(c1, 'Sample') {
@@ -202,7 +202,7 @@ Legend labels and details can be defined via `\n` in `$legendTest` arguments too
202202
!if %variable_exists("RELATIVE_INCLUDE")
203203
!include %get_variable_value("RELATIVE_INCLUDE")/C4_Container.puml
204204
!else
205-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
205+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
206206
!endif
207207
' $legendText with \n defines the label and details of the legend entry ("backend container" is label, "eight sided shape" is details)
208208
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())`
234234
!if %variable_exists("RELATIVE_INCLUDE")
235235
!include %get_variable_value("RELATIVE_INCLUDE")/C4_Container.puml
236236
!else
237-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
237+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
238238
!endif
239239
' $legendText with \n defines the label and details of the legend entry ("backend container" is label, "eight sided shape" is details)
240240
AddElementTag("backendContainer", $fontColor=$ELEMENT_FONT_COLOR, $bgColor="#335DA5", $shape=EightSidedShape(), $legendText="backend container\neight sided shape")
@@ -264,7 +264,7 @@ SHOW_LEGEND($details=None())
264264

265265
```plantuml
266266
@startuml Layout With Whitespace Sample
267-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
267+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
268268
269269
Person(a, "Person A")
270270
Container(b, "Container B", "techn")
@@ -290,7 +290,7 @@ Therefore a floating legend can be added via SHOW_FLOATING_LEGEND(), positioned
290290

291291
```plantuml
292292
@startuml Compact Legend Layout Sample
293-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
293+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
294294
295295
Person(a, "Person A")
296296
Container(b, "Container B", "techn")
@@ -326,7 +326,7 @@ With `LAYOUT_AS_SKETCH()` you can make a difference.
326326

327327
```plantuml
328328
@startuml LAYOUT_AS_SKETCH Sample
329-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
329+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
330330
331331
LAYOUT_AS_SKETCH()
332332
@@ -354,7 +354,7 @@ PNG does not support fallback fonts based on a PlantUML [bug](https://forum.plan
354354

355355
```plantuml
356356
@startuml LAYOUT_AS_SKETCH Sample
357-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
357+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
358358
359359
SET_SKETCH_STYLE($bgColor="lightblue", $fontColor="darkblue", $warningColor="darkred", $footerWarning="Sketch", $footerText="Created for discussion")
360360
@@ -400,7 +400,7 @@ This can be enabled with `HIDE_STEREOTYPE()`.
400400

401401
```plantuml
402402
@startuml HIDE_STEREOTYPE Sample
403-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
403+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
404404
405405
HIDE_STEREOTYPE()
406406
@@ -431,7 +431,7 @@ With the macros `HIDE_PERSON_SPRITE()`, `SHOW_PERSON_SPRITE()` and `SHOW_PERSON_
431431

432432
```plantuml
433433
@startuml predefined sprites Sample
434-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
434+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
435435
436436
Person(userA, "User A", "with predefined sprite person", "person")
437437
Person(userB, "User B", "with predefined sprite person2", "person2")
@@ -444,7 +444,7 @@ Person(userB, "User B", "with predefined sprite person2", "person2")
444444

445445
```plantuml
446446
@startuml HIDE_PERSON_SPRITE Sample
447-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
447+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
448448
449449
HIDE_PERSON_SPRITE()
450450
@@ -465,7 +465,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS")
465465

466466
```plantuml
467467
@startuml SHOW_PERSON_SPRITE Sample
468-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
468+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
469469
470470
/' Not needed because this is the default with sprite "person" '/
471471
SHOW_PERSON_SPRITE()
@@ -487,7 +487,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS")
487487

488488
```plantuml
489489
@startuml SHOW_PERSON_SPRITE(sprite) Sample
490-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
490+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
491491
!define osaPuml https://raw.githubusercontent.com/Crashedmind/PlantUML-opensecurityarchitecture2-icons/master
492492
!include osaPuml/Common.puml
493493
!include osaPuml/User/all.puml
@@ -511,7 +511,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS")
511511

512512
```plantuml
513513
@startuml SHOW_PERSON_PORTRAIT() Sample
514-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
514+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
515515
516516
SHOW_PERSON_PORTRAIT()
517517
@@ -537,7 +537,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS")
537537
538538
```plantuml
539539
@startuml SHOW_PERSON_OUTLINE() Sample
540-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
540+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
541541
542542
SHOW_PERSON_OUTLINE()
543543

‎README.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Take a look at the following sample of a C4 Container Diagram:
116116

117117
```plantuml
118118
@startuml Basic Sample
119-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
119+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
120120
121121
Person(admin, "Administrator")
122122
System_Boundary(c1, "Sample System") {
@@ -135,7 +135,7 @@ Entities can also be decorated with icons/sprites using the $sprite parameter, f
135135

136136
```plantuml
137137
@startuml
138-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
138+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
139139
140140
!define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons
141141
!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
163163

164164
```plantuml
165165
@startuml Basic Sample
166-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
166+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
167167
168168
Person(admin, "Administrator", $sprite="person2", $link="https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/LayoutOptions.md#hide_person_sprite-or-show_person_spritesprite")
169169
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
186186

187187
```plantuml
188188
@startuml
189-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
189+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
190190
191191
AddElementTag("v1.0", $borderColor="#d73027")
192192
AddElementTag("v1.1", $fontColor="#d73027")
@@ -221,7 +221,7 @@ SHOW_LEGEND()
221221
> - `?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
222222
223223
- System Context & System Landscape diagrams
224-
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml`
224+
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Context.puml`
225225
- Macros:
226226
- `Person(alias, label, ?descr, ?sprite, ?tags, ?link)`
227227
- `Person_Ext`
@@ -241,7 +241,7 @@ SHOW_LEGEND()
241241
- `robot2`
242242

243243
- Container diagram
244-
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml`
244+
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml`
245245
- Additional Macros:
246246
- `Container(alias, label, ?techn, ?descr, ?sprite, ?tags, ?link)`
247247
- `ContainerDb`
@@ -252,7 +252,7 @@ SHOW_LEGEND()
252252
- `Container_Boundary(alias, label, ?tags, ?link)`
253253

254254
- Component diagram
255-
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml`
255+
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml`
256256
- Additional Macros:
257257
- `Component(alias, label, ?techn, ?descr, ?sprite, ?tags, ?link)`
258258
- `ComponentDb`
@@ -262,7 +262,7 @@ SHOW_LEGEND()
262262
- `ComponentQueue_Ext`
263263

264264
- Dynamic diagram
265-
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml`
265+
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Dynamic.puml`
266266
- Additional Macros:
267267
- `RelIndex(index, from, to, label, ?tags, ?link)`
268268
- (lowercase) `increment($offset=1)`: increase current index (procedure which has no direct output)
@@ -274,7 +274,7 @@ SHOW_LEGEND()
274274
- `SetIndex($new_index)`: returns new set index and calculates next index (function which can be used as argument)
275275

276276
- Deployment diagram
277-
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml`
277+
- Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Deployment.puml`
278278
- Additional Macros:
279279
- `Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, ?link)`
280280
- `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
299299

300300
```plantuml
301301
@startuml
302-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
302+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
303303
HIDE_STEREOTYPE()
304304
305305
Person(a, "A")
@@ -341,7 +341,7 @@ In following sample a person uses different systems, and a group of persons whic
341341

342342
```plantuml
343343
@startuml
344-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
344+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
345345
HIDE_STEREOTYPE()
346346
347347
Person(a, "A")
@@ -380,7 +380,7 @@ In following sample the floating legend should be in the left bottom corner of t
380380

381381
```plantuml
382382
@startuml
383-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
383+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
384384
385385
!define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons
386386
!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
431431

432432
```plantuml
433433
@startuml
434-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml
434+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml
435435
436436
Person(pB, "Sam", $sprite="person2")
437437
Person_Ext(pA, "Bob", $sprite="person")
@@ -458,7 +458,7 @@ Color of the displayed images can be changed with `,color={color}`.
458458

459459
```plantuml
460460
@startuml
461-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
461+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
462462
463463
'stdlib users.puml defines sprite "users"
464464
!include <office/users/users.puml>
@@ -490,7 +490,7 @@ Relationship specific sprites are typically smaller and therefore following opti
490490

491491
```plantuml
492492
@startuml
493-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
493+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Context.puml
494494
495495
Person(user, "User")
496496
Person(user1, "User 1")
@@ -611,7 +611,7 @@ Like the element specific tag definitions exist boundary specific calls with the
611611

612612
```plantuml
613613
@startuml
614-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
614+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
615615
616616
UpdateElementStyle(person, $fontColor="green")
617617
AddElementTag("v1.0", $fontColor="#d73027", $borderColor="#d73027")
@@ -657,7 +657,7 @@ SHOW_LEGEND(false)
657657

658658
```plantuml
659659
@startuml
660-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
660+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
661661
662662
!define osaPuml https://raw.githubusercontent.com/Crashedmind/PlantUML-opensecurityarchitecture2-icons/master
663663
!include osaPuml/Common.puml
@@ -716,7 +716,7 @@ SHOW_LEGEND()
716716

717717
```plantuml
718718
@startuml
719-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml
719+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml
720720
721721
' Update the generic boundary style and the "system", "enterprise", "container" boundaries styles too
722722
UpdateBoundaryStyle($bgColor="gold", $fontColor="brown", $borderColor="brown")
@@ -767,7 +767,7 @@ If the custom (color) schema is defined via `UpdateElementStyle()` then the lege
767767

768768
```plantuml
769769
@startuml
770-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
770+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Context.puml
771771
772772
!$COLOR_A_5 = "#7f3b08"
773773
!$COLOR_A_4 = "#b35806"
@@ -821,7 +821,7 @@ Following sample uses all 3 different property definitions (and the aligned depl
821821

822822
```plantuml
823823
@startuml
824-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml
824+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Deployment.puml
825825
826826
' default header Property, Value
827827
AddProperty("Name", "Flash")
@@ -861,7 +861,7 @@ C4-PlantUML offers version information like PlantUML with its `%version()` call.
861861

862862
```plantuml
863863
@startuml
864-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
864+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Container.puml
865865
866866
' existing plantuml version as text
867867
%version()

‎percy/TestLabelsWithLineBreak.puml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
!include %get_variable_value("RELATIVE_INCLUDE")/C4_Deployment.puml
66
!else
77
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Component.puml
8-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml
8+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Deployment.puml
99
!endif
1010

1111
Enterprise_Boundary(eb, "Enterprise\nBoundary") {
@@ -30,7 +30,7 @@ Node(n2, "A node label", "PlantUML packages have no automatic line breaks, type
3030
!if %variable_exists("RELATIVE_INCLUDE")
3131
!include %get_variable_value("RELATIVE_INCLUDE")/C4_Dynamic.puml
3232
!else
33-
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml
33+
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/v2.5.0/C4_Dynamic.puml
3434
!endif
3535

3636
Component(from, "From component")

0 commit comments

Comments
 (0)