github-mirrors
/
C4-PlantUML
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme with C4_Container.puml

Browse Source
pull/1/head
Victor Lupu 8 years ago
parent 32a458082c
commit cdb341b0ea
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File

24
README.md
Unescape Escape View File

@ -17,25 +17,25 @@ C4-PlantUML includes macros, stereotypes, and other goodies (like VSCode Snippet
## Getting Started ## Getting Started
At the top of your C4 PlantUML `.puml` file, you need to include the `C4.puml` file found in the `root` of this repo. At the top of your C4 PlantUML `.puml` file, you need to include the `C4_Container.puml` file found in the `root` of this repo.
To be independent of any internet connectifity, you can also download `C4.puml` and reference it locally with To be independent of any internet connectifity, you can also download `C4_Container.puml` and reference it locally with
```c# ```c#
!include path/to/C4.puml !include path/to/C4_Container.puml
``` ```
If you want to use the always up-to-date version in this repo, use the following: If you want to use the always up-to-date version in this repo, use the following:
```c# ```c#
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
``` ```
After you have inlcluded `C4.puml` you can use the defined macro definitions for the C4 elements: `Person`, `Person_Ext`, `System`, `System_Ext`, `Container`, `Component`, `Relationship`. After you have inlcluded `C4_Container.puml` you can use the defined macro definitions for the C4 elements: `Person`, `Person_Ext`, `System`, `System_Ext`, `Container`, `Component`, `Relationship`.
```csharp ```csharp
@startuml C4_Elements @startuml C4_Elements
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
Person(personAlias, "Label", "Optional Description") Person(personAlias, "Label", "Optional Description")
Person_Ext(personAlias, "Label", "Optional Description") Person_Ext(personAlias, "Label", "Optional Description")
@ -56,7 +56,7 @@ Take a look a look at the following sample of a C4 Container Diagram:
```csharp ```csharp
@startuml Basic Sample @startuml Basic Sample
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
Person(admin, "Administrator") Person(admin, "Administrator")
package "Sample System" <<boundary>> as c1 { package "Sample System" <<boundary>> as c1 {
@ -73,7 +73,7 @@ or
```csharp ```csharp
@startuml Basic Sample @startuml Basic Sample
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
Person(admin, "Administrator") Person(admin, "Administrator")
System_Boundary(c1, "Sample System") { System_Boundary(c1, "Sample System") {
@ -113,7 +113,7 @@ With the two macros `LAYOUT_TOP_DOWN` and `LAYOUT_LEFT_RIGHT` it is possible to
```csharp ```csharp
@startuml LAYOUT_TOP_DOWN Sample @startuml LAYOUT_TOP_DOWN Sample
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
/' Not needed because this is the default '/ /' Not needed because this is the default '/
LAYOUT_TOP_DOWN LAYOUT_TOP_DOWN
@ -135,7 +135,7 @@ Using `LAYOUT_LEFT_RIGHT`
```csharp ```csharp
@startuml LAYOUT_LEFT_RIGHT Sample @startuml LAYOUT_LEFT_RIGHT Sample
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
LAYOUT_LEFT_RIGHT LAYOUT_LEFT_RIGHT
@ -162,7 +162,7 @@ This can be enabled with `LAYOUT_WITH_LEGEND`.
```csharp ```csharp
@startuml LAYOUT_WITH_LEGEND Sample @startuml LAYOUT_WITH_LEGEND Sample
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
LAYOUT_WITH_LEGEND LAYOUT_WITH_LEGEND
@ -195,7 +195,7 @@ With `LAYOUT_AS_SKETCH` you can make a difference.
```csharp ```csharp
@startuml LAYOUT_AS_SKETCH Sample @startuml LAYOUT_AS_SKETCH Sample
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
LAYOUT_AS_SKETCH LAYOUT_AS_SKETCH

Write Preview
Loading…
Cancel
Save