Skip to content

Commit 0ad6fed

Browse files
committed
plantuml-stdlib#119, plantuml-stdlib#72: Add link support: Readme.md - add missing args in docu
1 parent 19447d7 commit 0ad6fed

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -163,31 +163,31 @@ Diagram types
163163
* System Context & System Landscape diagrams
164164
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml`
165165
* Macros:
166-
* `Person(alias, label, ?description, ?sprite, ?tags)`
166+
* `Person(alias, label, ?description, ?sprite, ?tags, $link)`
167167
* `Person_Ext`
168-
* `System(alias, label, ?description, ?sprite, ?tags)`
168+
* `System(alias, label, ?description, ?sprite, ?tags, $link)`
169169
* `SystemDb`
170170
* `SystemQueue`
171171
* `System_Ext`
172172
* `SystemDb_Ext`
173173
* `SystemQueue_Ext`
174-
* `Boundary(alias, label, ?type, ?tags)`
175-
* `Enterprise_Boundary(alias, label, ?tags)`
174+
* `Boundary(alias, label, ?type, ?tags, $link)`
175+
* `Enterprise_Boundary(alias, label, ?tags, $link)`
176176
* `System_Boundary`
177177
* Container diagram
178178
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml`
179179
* Additional Macros:
180-
* `Container(alias, label, technology, ?description, ?sprite, ?tags)`
180+
* `Container(alias, label, technology, ?description, ?sprite, ?tags, $link)`
181181
* `ContainerDb`
182182
* `ContainerQueue`
183183
* `Container_Ext`
184184
* `ContainerDb_Ext`
185185
* `ContainerQueue_Ext`
186-
* `Container_Boundary(alias, label)`
186+
* `Container_Boundary(alias, label, ?tags, $link)`
187187
* Component diagram
188188
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml`
189189
* Additional Macros:
190-
* `Component(alias, label, technology, ?description, ?sprite, ?tags)`
190+
* `Component(alias, label, technology, ?description, ?sprite, ?tags, $link)`
191191
* `ComponentDb`
192192
* `ComponentQueue`
193193
* `Component_Ext`
@@ -196,7 +196,7 @@ Diagram types
196196
* Dynamic diagram
197197
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml`
198198
* Additional Macros:
199-
* `RelIndex(index, from, to, label)`
199+
* `RelIndex(index, from, to, label, ?tags, $link)`
200200
* (lowercase) `increment($offset=1)`: increase current index (procedure which has no direct output)
201201
* (lowercase) `setIndex($new_index)`: set the new index (procedure which has no direct output)
202202
* `LastIndex()`: return the last used index (function which can be used as argument)
@@ -208,16 +208,16 @@ Diagram types
208208
* Deployment diagram
209209
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml`
210210
* Additional Macros:
211-
* `Deployment_Node(alias, label, ?type, ?description, ?sprite, ?tags)`
212-
* `Node(alias, label, ?type, ?description, ?sprite, ?tags)`: short name of Deployment_Node()
213-
* `Node_L(alias, label, ?type, ?description, ?sprite, ?tags)`: left aligned Node()
214-
* `Node_R(alias, label, ?type, ?description, ?sprite, ?tags)`: right aligned Node()
211+
* `Deployment_Node(alias, label, ?type, ?description, ?sprite, ?tags, $link)`
212+
* `Node(alias, label, ?type, ?description, ?sprite, ?tags, $link)`: short name of Deployment_Node()
213+
* `Node_L(alias, label, ?type, ?description, ?sprite, ?tags, $link)`: left aligned Node()
214+
* `Node_R(alias, label, ?type, ?description, ?sprite, ?tags, $link)`: right aligned Node()
215215

216216
Take a look at each of the [C4 Model Diagram Samples](samples/C4CoreDiagrams.md).
217217

218218
## Relationship Types
219219

220-
* `Rel(from, to, label, ?technology, ?description, ?sprite, ?tags)`
220+
* `Rel(from, to, label, ?technology, ?description, ?sprite, ?tags, $link)`
221221
* `BiRel` (bidirectional relationship)
222222

223223
You can force the direction of a relationship by using:

0 commit comments

Comments
 (0)