-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathindex.html
916 lines (701 loc) · 49.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to The Hitchhiker’s Guide to PlantUML! — The Hitchhiker's Guide to PlantUML documentation</title>
<link rel="shortcut icon" href="_static/plantumllogo.png"/>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="https://platform.twitter.com/widgets.js"></script>
<script type="text/javascript" src="https://www.googletagmanager.com/gtag/js?id=UA-168177985-1"></script>
<script type="text/javascript" src="_static/google_analytics_tracker.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="1. About PlantUML" href="about/AboutPlantUML.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> The Hitchhiker's Guide to PlantUML
<img src="_static/plantumllogo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/AboutPlantUML.html">1. About PlantUML</a></li>
<li class="toctree-l1"><a class="reference internal" href="about/AboutThisGuide.html">2. About this Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="about/Sections.html">3. Sections of the Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">Using Standard Library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html">1. Create a Diagram of a Typical Network</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws/aws.html">2. Create Real Life AWS Diagrams</a></li>
<li class="toctree-l1"><a class="reference internal" href="kubernetes/kubernetes.html">3. Kubernetes and Azure</a></li>
<li class="toctree-l1"><a class="reference internal" href="gcp/gcp.html">4. Google Cloud Platform</a></li>
<li class="toctree-l1"><a class="reference internal" href="C4/c4acme.html">5. Using C4 To Architect ACME Global Widget Production</a></li>
</ul>
<p class="caption"><span class="caption-text">PlantUML Features</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html">1. Use Images in Diagrams</a></li>
<li class="toctree-l1"><a class="reference internal" href="scale/scale.html">2. Scaling Sprites</a></li>
<li class="toctree-l1"><a class="reference internal" href="procedures/procedures.html">3. Procedures and Keyword Arguments</a></li>
<li class="toctree-l1"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html">4. PassSpriteAsParameter</a></li>
<li class="toctree-l1"><a class="reference internal" href="color/color.html">5. Colors</a></li>
<li class="toctree-l1"><a class="reference internal" href="layout/layout.html">6. Layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html">7. Tricked Out Diagrams (aka Diagram Annotation)</a></li>
</ul>
<p class="caption"><span class="caption-text">Understanding Standard Library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StdLibOverview.html">1. PlantUML Stdlib Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="StdlibUnderTheHood/StdlibUnderstanding.html">2. PlantUML Stdlib Under The Hood</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StandardisingStdLib.html">3. PlantUML Stdlib Under The Hood 2</a></li>
</ul>
<p class="caption"><span class="caption-text">Standardising Standard Library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/stdlibRequirements.html">1. Standard Library - What We Have And What We Want</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html">2. Standardising Standard Library</a></li>
</ul>
<p class="caption"><span class="caption-text">Future</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/future.html">1. Thoughts For The Future</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">2. To Do List</a></li>
</ul>
<p class="caption"><span class="caption-text">Annex Standard Library C4</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="C4/c4.html">1. C4 Lightweight Software Architecture Description Method</a></li>
<li class="toctree-l1"><a class="reference internal" href="C4/C4Stdlib.html">2. Using PlantUML Stdlib C4 Lightweight Software Architecture Description Method</a></li>
</ul>
<p class="caption"><span class="caption-text">Annex</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="github/githubFileFinder.html">1. GitHub File Finder</a></li>
<li class="toctree-l1"><a class="reference internal" href="DocumentationAsCode/JourneyDocumentationASCode.html">2. Journey to Documentation as Code</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">The Hitchhiker's Guide to PlantUML</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Welcome to The Hitchhiker’s Guide to PlantUML!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-the-hitchhiker-s-guide-to-plantuml">
<h1>Welcome to The Hitchhiker’s Guide to PlantUML!<a class="headerlink" href="#welcome-to-the-hitchhiker-s-guide-to-plantuml" title="Permalink to this headline">¶</a></h1>
<div class="align-center figure" id="id1">
<a class="reference internal image-reference" href="_images/plantumllogo1.png"><img alt="alternate text" src="_images/plantumllogo1.png" style="width: 120px; height: 120px;" /></a>
<p class="caption"><span class="caption-text">Where system diagrams meet system reality</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="imagine">
<h2>Imagine<a class="headerlink" href="#imagine" title="Permalink to this headline">¶</a></h2>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p><a class="reference external" href="http://www.plantuml.com/plantuml/svg/SYWkIImgAStDKU3YAYueoYn9LL39JImgoynJY3OqCgWmD37HDpIBLQZc0j1YTykjipeOWCzxDPX_7Kh2tFybRIJILB7PAtJIxvrfkfonyo1vGKpxh-ByCeVhlytNv-oC--_Wm_iG_3_oty1UsAjxN8x-7XRMkeUDvTsVmavKunxthELFOUigkoz_0dlhtjaRVVmHBEp2TS_SwT_3swvxpLLs7yDhrztpAXyVms7XkcNUTHk0jc5nOrJuZIknSBZB0BWFnpttBeTmlSquODw6_HqMOK_k9eGmGhkm51ntNOc5mz6VONLXjzL1tNtOodfHdy798Y00xy0-MdYwUx3aUC049aWRi0lntkbzsHq-I9TVNDY1nRt0RXyUvqh9Q5rXtyD2_hBJaf-AHycTh-e6FBnmBtY_PFbrq6om1FicFBpu2Upb5wbPfxmDXyzWV_WGJSd0U_0mFuTzRxRPEx0RwaTmq9y-P0Ia_OgFz2aSv6Skc8W2zoquV0vBNDS08lKjsCM_WAF09XlmaVu6zh-5VHBPmf9VmYB_5WuAVx9awdLXmcThxVmjVE_r_gF04QAe3BLMPB4tuG--5eF2YNkZMhAaL1Hw2_xWGK3XWBt3P2VDMx3Alt_MqypBSZjF2yDx-4ZlUos8BkX9aaVIl4fV52OY9gWF5Xdv7UmCV9Mbh91ogIEbJ6tQ8iW8a12Wf52844aEQaLYJaT-1_UuA5d0c4jvW47VifsEHIv9fM5AfK85WL5iQWt2E3UzXRs5PsAgY5A85-sMG-GSOynCIKwF2NZ22DIzarXuezSnPKqfuT-RDXzJJDZoNBLYVS9u7a-Oa5ZXTTAth4sRFQpnxJOrPcYexWYiO6HY1eNT6jRaYiYiRYnnOsCUaT8tZEqEDsgCc0USIiaBEZxKcc8YAdBlalTJrjURAgp8qvNm0YPYoccqkbO4nBg4WOOh90uvvU0r8UNuZxyuXUbApZjy4X8aD-2CX8qXNs6PgSJC86rEG6LeafW14OhGQzV0_GRdauWXz06xMg4nbbktMTWcjCoHYb4VyJDYpN8BSdYXZVfqqnqkPsidrpcTKa6TdnVu59GLhqA760KiQIuIWux-Kcmg9QaxKtzWUi2rSpjF0eLx1a90IA_iT6Uevc41Gid2YfmhGWx-cH1pvTQmfFX8w1Rs4pu5RfmdJ4CX9i1IgwgMdI50mZhP7xegFOj5RX9-qix2BKruVBR820EkrAIjqdj0KfRlQOrgjh3GCEcOAxMVaFR5zmKC_MGSCW_O8GyAILwuDM5NcSMyojh-MWfmipbrZDt0Q60QtD2_UXMtiHoAsdYT-O5maOKcrIvqwqkuTc6amrzP6aqypFx_M2I5xHsqASWB-W9pL1W4qHP_LHHulEW4MgRcIjpQclQ7Nz5IY8N9Fs4ckSbVohTPy1eMwldHUcnf-Q8CgMBJCB6bJ_w6yGTM1xz86jxaKDjv8Ii-fd5-o2mX45hcxeYNX3nlDPM2bZwP7l3nXCKb-9h_fGKcbE5UQwqq_v619pm3kcw97UPUEEe9N5EoKqiKCh3EuqO0zOlc2KrWlD5KKaQQHLfPw1H4zlByhCju4fgnn8IFCucL9WG3o_t8yhM8pE9EM6WJ0NCgf5112oijhdn7XoYPj3IZe5wPiMdu2UUcVNO3xeM8snE-qrXI0KGiDxYXoBFSHrALEL9IgZNhCBxpW0FLKdBi0dUep1PMsW249UUIywNLZHkNQ51n2vmoAp77LD3CGIfkmZfMD-5UvmAXy9ec0AIcUR84E62RLEN20RV6HfLn16VWeqzOPI8MU4rFQkR9nYDREEMAZVBXMM0Jmkp5NC8m90ClwVQK6sCDtZa39vd7CXXtu0lCaEtpVw01knUO1BxBXZP53C1PE0FoMKLuXNbM-meVPYSH0AaPU4dFfQXXYMwcA9nIGOIYm2jCLGPuWREu4vRa6tpljxgTizDCEALSOR31kIjCDRbR8e5xWLqbQSoQ_eRFXZb7R-0w7_cbnnRMAHWEju3vl6pQCX0tfZNzA1hIuMno8sMTpO6jKT7XhU1ssoqMe7_IaAAx9F6YhWC6As-kuSKsjIAIj9NMSd2t724iXFkR9ca1vwh2MYQwD5JYTdECh2gsCe3Gx-3_qMftEwwhEXp0xy_J1FnXSmcawwtEkszCd9OqqpLhh-tvNumgMSgle8P1XZGRBF27RiQHl5dW1bksOhAMwlHdE1EFq9-v2Na4Zi_z1bkus91LVTJVmHW5kwmgOdGiZ7TuZKnPcEMwUBV-7s3w3hPiwZ9nMUYsts6AWosgfPXCH7FdvF0ZtPz5xs-r1KVWNq-r1KMBJXa7lK_w3ekgNc4WFaFf_Zgb6tmFYS5CY5XixtQ7VKsumhp2zzpXUpOMOJ9O-sxq7Ru72IqqWjjVmcQFpAzGsknB_89q1huECURixTQFSDxly3VfhRKY8zhwXpGLaL9_b_PtT_RsWVV7v_hiQFp0PS5EHDmVxx6zcAUhQ8-7SyweK-gz-TegR17HChVmJPX_0WRfVO1C2FdjJbU6sGyf8l7m1YJJpAlfiX-DY0g6mtwwaWrENy8v0pD4mpXS631yXc5Ke4J3CDpVm7wUQEjECAoOCpxd-jrrE9iS2biolE1qWyr5-14OSC9tsGTizMno_Ej4ov3JpJKOVW3EVbpfyiZroDXSmb69XiqbN6MFknCcoC7mtDkiyjFEYpk240fdG5vWo6jMbrMsIFXuhCjENraB0DVQLRSmk1Gbm-2PV0duNxA-LPSj1S69UYl-8dc-l7MBjLjmss9Ws9ATUtsu7_5oeSxUKB5o14nfIsLVv9LEgxjRMXx5505ZJa1roEBoUzmj-sEu5RQqfH2O411DRcpmJSxkFYmLRHPYO64okpvCFkcxkvlRS1i9Wdd8281sKkJoZ9CMmCKrE0V2cORS68o-hLlkKd8uHS9JxW8BxIoMntJPt60O3QFsSDbncF5vxfBT3O95sFVJcUoSIX7Mc3lFGoLjJpXc0H6VwvIIc5neeT7SaQxvvSQirHlvN0yvInz8PNn5ZsxsueR05kGvrq-vxrK9FToQmGLURavR1Em_hulSMsMQuL9DLXYWZzOEMe9WCldSO6Qnuw9Q79O1D_75RBA1y3PWborSUwsAI3DrtWcv96u7WcAoqMO3bG7JsGjKNlT2zkbN6BofdYqeiA0KWor-IGEMR46mPK0glisq49zD1zy1keqZeR2tE2VjGN_9UOHm2VmAX4lrTWlFY66p029i1vF7zo8BXiD7vfc_Y8fFXJABnHiao1GxrIe7mDxcBENSSVlFFH_tHJDnB2ppyTwgJA2rUA6ymIWK2Iixx8zdXqNr2YSG38JB0llZzLpKNfKqkp0CiIFc2vnzUM9lB99d_iBYO5JHKjGGNqPo9lz6efwZXaW0KV1sF7OL2B9NH0XXROyJXS66CLxk6US3hdCDVoiHXi5oWnFW9pX16CnyJ6vAwudg2GjVfpfb284jeiku7EOJzjAh5hW3EU4fhx2AFaifViG6d-DAorJx8kvoJXw8W-tnpmLa1XmkzPGXUm13OPFFnmCWbtgKUg_djx8W4XF6_RYg3uoUTzLwEqfrNkfHyMXhoXe6OxMBCUquojVQ1cRkJ5alSBMsTmtzVznwxVl3Z3O--7YFj94oP4khpIhVm___tpzjd45h8p4CXU_pAyImaDlCFOImi8HDe2cba5EQWp9MR7LiETXomz0_NwVJGW-zYCTxJtpw1Mhoo7B5X0467uk1z-QCmsXJB6B-HHyJt1mhrUgSVpqMmGpjQhZdIvjmMg_-pC5wrN-wwxPf92g1fuj2l7plBQ7TmOspWocMXO7NaXMKl8T0a50TfHS1TLX7cbWiQ0GIYvOWJ5MfAvanXzewqu0b4-p0uHl9Gi76oXBgsfcTsBeVy3jxKKdgM4Quonbl8noFJlMQbtq_9CoEJ60ndULAEtSS-oUFeeVzmvPrS8v7Ilb_OKFz8-ajfl6GgxF7mR5G_jNid0OFsytpvdG2bgo4fklgfT3y9J4b-0y0"><img alt="playbutton_index" src="_images/play6.png" style="width: 40px;" /></a> <strong>Press play</strong></p>
<blockquote>
<div><p>Imagine being able to</p>
<ol class="arabic simple">
<li><p>share a model or diagram between all members of the team that they can all understand and contribute to and edit</p></li>
<li><p>draw diagrams like below automatically from a text description.</p></li>
<li><p>describe a system before you build it, when you’re building it, and as you maintain it into the future - keeping the description and the system current, and in sync.</p></li>
<li><p>maintain that text version in a source code repository beside the code for the system it is describing</p></li>
</ol>
<p>Imagine having a diagramming tool that</p>
<ol class="arabic simple">
<li><p>fits with a developer workflow, and developers are comfortable using</p></li>
<li><p>enables <strong>lightweight just-enough</strong> <a class="reference external" href="http://agilemodeling.com/essays/barelyGoodEnough.html">AgileModeling</a> in a way that meets <a class="reference external" href="https://tdan.com/best-practices-for-agile-documentation/18936">AgileModelingBP</a></p></li>
<li><p>fits with modern practices of Continuous Integration Continuous Delivery - and “everything as code” including diagrams.</p></li>
</ol>
<p>Well that’s what PlantUML gives you, and more…</p>
</div></blockquote>
</div>
</div>
<div class="section" id="plantuml-diagram-examples">
<h2>PlantUML Diagram Examples<a class="headerlink" href="#plantuml-diagram-examples" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="http://www.plantuml.com/plantuml/uml/VLNlQkGs4F-kfvWB77NWuetthd-Q3-NI59h0fLt8XdufB8eqNelOaf7acAKK-XfzlJv9PoHxDybo-M2FD7z-C_ERyUxd4AMFGzSAyKvZRIo22t952cXYxCF5Ok7bM6vDR8Q78Q1NpaQqiLIkMrnv6HhKdR5wiMgbZVUtNyvSZpQW6ho9E-bLOoAgE7XSdXcA3OjEXeXUl3DMjOFUfrjSkQvpjkpfV6oyfymBsRPVCLzBhqVfyGsNMnFK6-Oxz4zlfhWpyHcy-AQ4M-btO098-0MViAM-FHWBiK5OUQS75I6Yx4gu8qqZsV4FOigD0QfpM5s1j9eUkBJQEwEXRvp5af5_TWyP-5PQkJt0NYhb1Xl3X7kTOCb9pL1cjSUuUU9xOEtD6hR33iR6GUlS8-dgY3uXXjHs2HonRd07D2ABNBbBTejnTFuHQFWVKf8d8q52RJoEHCRiTcC9a7nBGSm03ok8wBP8DWz_2U9mmxkpsNf4kz4pNGLJ-05EM9oGV4uRt_Uydfo-nc2jZCRPK72dvCo2WwZRzHIVXmgNlA774BJEnc88cowpN13j54HlZdt1DIkcMH3EtzmarMOK7hMfCJn6rnUzef3gnsLPVVT3MPNLEKCSnf-wlPfgQcNF8Pry5RFCQTKiidUUSM5w5apIpihEABXPiL-sGbNn9PrVXicyR4Tnqn9IQQy3yueKMRngAZdVFn1F0qnaBy_Byq_mPNrt642cZ3ZxBM-Jc9XY0ZUZyTZo5BmR8kKPJMqkLo_pCDGKEnL5-rZGG_hVwvfWW2xiTKqYUymhMim7idvRbH-_BvUVgFAFnvYgTOCkqfjiyqg_z1CYVVLdPpz1houWkC5JSkKq7WmJnMnLHhRGeJPI2DghPEua1TR6IfkinjPkRyj3lO0aG57LWLBoPYTpdi45VwIrsGxv0n0YHoMFp9wOIdYkoe8rp9KG6Mj_fwhsv_vm58BUwJRJACHyIkf45-cSYuJslZOjqbfXSGeUhKQFcWg83Sn_3q190rKDxwT3SVgdNJS8roQgfZ6FwF_xvzy0lmv68qIt3nIV2I_zz0hnFm00"><img alt="playbuttonindex3" src="_images/play6.png" style="width: 40px;" /></a> Blah Blah Blah… <strong>play</strong>!</p>
<p>This guide walks through creating PlantUML diagrams, including the ones shown here.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 100%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Diagram of a Typical Network</strong></p></td>
</tr>
<tr class="row-even"><td><p class="plantuml">
<img src="_images/plantuml-37c8ec247632b96b1ec942a75b43eb8a9d642e1e.png" alt="@startuml
!define osaPuml https://raw.githubusercontent.com/Crashedmind/PlantUML-opensecurityarchitecture2-icons/master
!include osaPuml/Common.puml
!include osaPuml/User/all.puml
!include osaPuml/Hardware/all.puml
!include osaPuml/Misc/all.puml
!include osaPuml/Server/all.puml
!include osaPuml/Site/all.puml
'. Mary is a Developer in the Product team. She has a Windows 10 PC and an Android phone.
'. Bob is a Manager in the Accounts team. He has Mac and an iPhone.
'. Ivan is an IT guy who looks after the server.
'. They connect to the network hub, and via a firewall to the Internet.
' Users
together {
osa_user_green_developer(Mary, "Mary", "Product team", "Developer")
osa_user_green_operations(Ivan, "Ivan", "IT Team", "Server Admin")
osa_user_green_business_manager(Bob, "Bob", "Accounts team", "Manager")
}
' Devices
together {
osa_desktop(pc, "192.168.1.10", "Windows 10", "PC")
osa_laptop(mac, "192.168.1.12", "Mac", "Mac")
osa_iPhone(iphone, "Dynamic IP", "iPhone 11", "Phone")
osa_iPhone(android, "Dynamic IP", "Android 10", "Phone")
osa_server(server, "192.168.1.100", "Ubuntu Server 20.04 LTS", "Server")
}
' Network
osa_device_wireless_router(wifiAP, "192.168.1.1", "Network")
osa_hub(hub, "Office hub", "Hub")
osa_firewall(firewall, "51.37.24.103", "Network")
osa_cloud(cloud, "Internet", "Network")
Mary --> pc: source code
Mary --> android: social media
Bob --> mac: financial info
Bob --> iphone: phone calls
Ivan --> server: configuration
iphone --> wifiAP
android --> wifiAP
wifiAP --> hub
server --> hub
mac --> hub
pc --> hub
hub --> firewall
firewall --> cloud
footer %filename() rendered with PlantUML version %version()\nThe Hitchhiker’s Guide to PlantUML
@enduml
"/>
</p>
</td>
</tr>
<tr class="row-odd"><td><p>This uses the Plantuml Stdlib Open Security Architecture icon set.
See <a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#create-a-diagram-of-a-typical-network"><span class="std std-ref">Create a Diagram of a Typical Network</span></a></p></td>
</tr>
</tbody>
</table>
<table class="docutils align-default">
<colgroup>
<col style="width: 100%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Diagram of an AWS Architecture</strong></p></td>
</tr>
<tr class="row-even"><td><p class="plantuml">
<img src="_images/plantuml-0be1227e4e67c7f0f1ef7adab59fde09c0634666.png" alt="@startuml
!include <awslib/AWSCommon>
!include <awslib/AWSSimplified.puml>
!include <awslib/Compute/all.puml>
!include <awslib/mobile/all.puml>
!include <awslib/general/all.puml>
!include <awslib/GroupIcons/all.puml>
!include <awslib/Storage/all.puml>
!include <awslib/ManagementAndGovernance/all.puml>
!include <awslib/CustomerEngagement/all.puml>
!include <awslib/MachineLearning/all.puml>
!include <awslib/NetworkingAndContentDelivery/all.puml>
!include <awslib/Database/all.puml>
!include <awslib/ApplicationIntegration/all.puml>
'Compute/General
'Storage/SimpleStorageServiceS3.png
'ApplicationIntegration/SQS.png
'Compute/Lambda.png
'Compute/EC2
'ManagementAndGovernance/CloudWatch.png
'CustomerEngagement/SESEmail.png
'MachineLearning/SageMaker.png
''Mobile/APIGateway.png
'NetworkingAndContentDelivery/APIGateway2.png
'Database/Aurora.png
'ApplicationIntegration/SQSQueue.png
skinparam linetype polyline
' skinparam linetype ortho
'top left section
'-------------------------------------------------------------
package EC2_Instance {
General(IngestionApp, "Ingestion App", " ")
General(ChunkingApp, "Chunking Orchestration App", " ")
}
SimpleStorageServiceS3(S3Staging, "Amazon S3 Staging Bucket", " ")
SQS(SQSIngest, "Amazon SQS Ingest Queue", " ")
Lambda(LambdaTrigger, "AWS Lambda Trigger Function", " ")
LambdaTrigger -up-> IngestionApp
IngestionApp -up-> SQSIngest
SQSIngest -down-> ChunkingApp
S3Staging <-down-> EC2_Instance
'top right section
'-------------------------------------------------------------
together {
SQS(SQSLargeFileQueue, "Amazon SQS Large File Queue", " ")
SQS(SQSSmallFileQueue, "Amazon SQS Small File Queue", " ")
SQS(SQSSingleFileQueue, "Amazon SQS Single File Queue", " ")
EC2(LargeFileChunkingAppEC2, "Large File Chunking App on EC2", " ")
Lambda(LambdaSmallFileChunking, "Small File Chunking Lambda", " ")
Lambda(ImageConversionLambdaFunction, "Image Conversion Lambda Function", " ")
}
'todo dashed line boundary
package DLQ {
SQSQueue(DLQ1, "DLQ", " ")
SQSQueue(DLQ2, "DLQ", " ")
SQSQueue(DLQ3, "DLQ", " ")
}
ChunkingApp -right-> SQSLargeFileQueue
ChunkingApp -right-> SQSSmallFileQueue
ChunkingApp -right-> SQSSingleFileQueue
SQSLargeFileQueue -right-> LargeFileChunkingAppEC2
LargeFileChunkingAppEC2 -down-> SQSSmallFileQueue
SQSSmallFileQueue -right-> LambdaSmallFileChunking
LambdaSmallFileChunking -down-> SQSSingleFileQueue
SQSSingleFileQueue -right-> ImageConversionLambdaFunction
'todo dashed line
SQSLargeFileQueue -down-> DLQ1
SQSSmallFileQueue -down-> DLQ2
SQSSingleFileQueue -down-> DLQ3
'bottom right section
'-------------------------------------------------------------
SimpleStorageServiceS3(S3Images, "Amazon S3 Images Bucket", " ")
EC2(EC2DLQFailsafeApp, "DLQ Failsafe App on EC2", " ")
SQS(SQSConvertedImageQueue, "Amazon SQS Converted Image Queue", " ")
Lambda(LambdaInferenceInvocation, "Inference Invocation Lambda Function", " ")
Aurora(Aurora, "Amazon Aurora", " ")
APIGateway(AmazonAPIGateway, "Amazon API Gateway", "")
SageMaker(AmazonSageMaker, "Amazon SageMaker Endpoint", "")
DLQ1 -down-> EC2DLQFailsafeApp
DLQ2 -down-> EC2DLQFailsafeApp
DLQ3 -down-> EC2DLQFailsafeApp
EC2DLQFailsafeApp -right-> S3Images
ImageConversionLambdaFunction -down-> S3Images
S3Images -down-> SQSConvertedImageQueue
SQSConvertedImageQueue -left-> LambdaInferenceInvocation
LambdaInferenceInvocation -down-> Aurora
LambdaInferenceInvocation <-left-> AmazonAPIGateway
AmazonAPIGateway <-left-> AmazonSageMaker
'bottom left section
'-------------------------------------------------------------
CloudWatch(CloudWatch, "Amazon Cloudwatch", " ")
SNS(SNS1, "Amazon SNS", "")
SESEmail(SESEmail, "Email Notification", "")
CloudWatch -right-> DLQ
CloudWatch -left-> SNS1
SNS1 -left-> SESEmail
footer %filename() rendered with PlantUML version %version()\nThe Hitchhiker’s Guide to PlantUML
@enduml"/>
</p>
</td>
</tr>
<tr class="row-odd"><td><p>This uses the AWSlib icon set.
See <a class="reference internal" href="aws/aws.html#create-real-life-aws-diagrams"><span class="std std-ref">Create Real Life AWS Diagrams</span></a></p></td>
</tr>
</tbody>
</table>
<table class="docutils align-default">
<colgroup>
<col style="width: 100%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Diagram of a Kubernetes Architecture</strong></p></td>
</tr>
<tr class="row-even"><td><p class="plantuml">
<img src="_images/plantuml-66b6d9919b201f789079b6213fa3392c4411ec4f.png" alt="@startuml
footer Kubernetes Plant-UML
scale max 1024 width
skinparam linetype polyline
skinparam nodesep 10
skinparam ranksep 10
' Azure
!define AzurePuml https://raw.githubusercontent.com/RicardoNiepel/Azure-PlantUML/release/2-1/dist
!includeurl AzurePuml/AzureCommon.puml
!includeurl AzurePuml/AzureSimplified.puml
!includeurl AzurePuml/Compute/AzureAppService.puml
!includeurl AzurePuml/Compute/AzureBatch.puml
!includeurl AzurePuml/Containers/AzureContainerRegistry.puml
!includeurl AzurePuml/Containers/AzureKubernetesService.puml
!includeurl AzurePuml/Databases/AzureDatabaseForPostgreSQL.puml
!includeurl AzurePuml/Databases/AzureCosmosDb.puml
!includeurl AzurePuml/Databases/AzureSqlDatabase.puml
!includeurl AzurePuml/DevOps/AzurePipelines.puml
!includeurl AzurePuml/Identity/AzureActiveDirectory.puml
!includeurl AzurePuml/Networking/AzureLoadBalancer.puml
!includeurl AzurePuml/Security/AzureKeyVault.puml
!includeurl AzurePuml/Storage/AzureBlobStorage.puml
!includeurl AzurePuml/Storage/AzureStorage.puml
' Kubernetes
!define KubernetesPuml https://raw.githubusercontent.com/dcasati/kubernetes-PlantUML/master/dist
!includeurl KubernetesPuml/kubernetes_Context.puml
!includeurl KubernetesPuml/kubernetes_Simplified.puml
!includeurl KubernetesPuml/OSS/KubernetesApi.puml
!includeurl KubernetesPuml/OSS/KubernetesIng.puml
!includeurl KubernetesPuml/OSS/KubernetesPod.puml
actor "DevOps" as devopsAlias
collections "Client Apps" as clientalias
collections "Helm Charts" as helmalias
left to right direction
' Azure Components
AzureActiveDirectory(aad, "\nAzure\nActive Directory", "Global")
AzureContainerRegistry(acr, "ACR", "Canada Central")
AzureCosmosDb(cosmos, "\nCosmos DB", "Global")
AzureKeyVault(keyvault, "\nAzure\nKey Vault", "Global")
AzureLoadBalancer(alb, "\nLoad\nBalancer", "Canada Central")
AzureSqlDatabase(sql, "\nExternal\ndata stores", "Canada Central")
AzurePipelines(ado, "CI/CD\nAzure Pipelines", "Global")
' Kubernetes Components
Cluster_Boundary(cluster, "Kubernetes Cluster") {
KubernetesApi(KubernetesApi, "Kubernetes API", "")
Namespace_Boundary(nsFrontEnd, "Front End") {
KubernetesIng(ingress, "API Gateway", "")
}
Namespace_Boundary(nsBackEnd, "Back End") {
KubernetesPod(KubernetesBE1, "", "")
KubernetesPod(KubernetesBE2, "", "")
KubernetesPod(KubernetesBE3, "", "")
}
Namespace_Boundary(nsUtil, "Utiliy Services") {
KubernetesPod(KubernetesUtil1, "", "")
KubernetesPod(KubernetesUtil2, "","")
}
}
Rel(devopsAlias, aad, "AUTH")
Rel(helmalias, KubernetesApi, "helm upgrade")
Rel(aad, keyvault, " ")
Rel(KubernetesApi, aad, "RBAC", "ASYNC")
Rel(clientalias, alb, "HTTP", "ASYNC")
Rel(alb, ingress, "HTTP", "ASYNC")
Rel(ingress, KubernetesBE1, " ")
Rel(KubernetesBE1, KubernetesBE2, " ")
Rel(KubernetesBE1, KubernetesBE3, " ")
Rel(KubernetesBE2, sql, " ")
Rel(KubernetesBE3, keyvault, "Pod Identity")
Rel(KubernetesBE3, cosmos, " ")
Rel(ado, acr, "docker push")
Rel_U(KubernetesApi, acr, "docker pull")
@enduml"/>
</p>
</td>
</tr>
<tr class="row-odd"><td><p>This uses the Azure and Kubernetes icon sets.
See <a class="reference internal" href="Stdlib/StdLibOverview.html#kubernetes"><span class="std std-ref">kubernetes</span></a></p></td>
</tr>
</tbody>
</table>
<table class="docutils align-default">
<colgroup>
<col style="width: 100%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Diagram of a Global Widget Production System Using C4</strong></p></td>
</tr>
<tr class="row-even"><td><p class="plantuml">
<img src="_images/plantuml-0030585265dac83354a1b981491a78e92165b207.png" alt="@startuml
!include <C4/C4_Context.puml>
!include <office/Users/user.puml>
LAYOUT_WITH_LEGEND()
title Top level Context diagram for ACME Global Widget Production
Person(AcmeProdOwner, Acme Production Owner , "<$user> \n Responsible for Production of widgets in ACME Production Site" )
Person(3rdProdOwner, 3rdParty Production Owner , "<$user> \n Responsible for Production of widgets in 3rdParty Production Site" )
System_Boundary(Remote, "Remote") {
System(ProdSystemHost, "Production Host", "Drives widget Production\n Analyses widget Production data to create reports")
System(Analytics, "Analytics", "Provides data analysis and a dashboard view data - including relevant Production data")
System(Monitoring, "Monitoring", "Monitors Production Host\nUses AWS Services")
System_Ext(SupplyChain, "SupplyChain", "Provides parts to make the widgets")
System_Ext(InventoryTracking, "InventoryTracking", "Customer Reference")
}
Enterprise_Boundary(AcmeProd, "ACME Production Site") {
System(AcmeWorkStation1, "WorkStation1", " Production setup for a group of widgets")
System(AcmeWorkStation2, "WorkStation2", " Production setup for a group of widgets")
System(AcmeWorkStationN, "WorkStationN", " Production setup for a group of widgets")
}
Enterprise_Boundary(3rdProd, "3rdParty Production Site") {
System(3rdWorkStation1, "WorkStation1", " Production setup for a group of widgets")
System(3rdWorkStation2, "WorkStation2", " Production setup for a group of widgets")
System(3rdWorkStationN, "WorkStationN", " Production setup for a group of widgets")
}
Rel_U(AcmeWorkStation1, ProdSystemHost, "Sends Production report for widget")
Rel_U(AcmeWorkStation2, ProdSystemHost, "Sends Production report for widget")
Rel_U(AcmeWorkStationN, ProdSystemHost, "Sends Production report for widget")
Rel_U(3rdWorkStation1, ProdSystemHost, "Sends Production report for widget")
Rel_U(3rdWorkStation2, ProdSystemHost, "Sends Production report for widget")
Rel_U(3rdWorkStationN, ProdSystemHost, "Sends Production report for widget")
Rel_D(AcmeProdOwner, ProdSystemHost, "Reviews Acme and 3rdParty site Production reports")
Rel_D(3rdProdOwner, ProdSystemHost, "Reviews 3rdParty site Production reports")
Rel_D(Analytics, ProdSystemHost, "Data Analysis")
Rel_D(SupplyChain, ProdSystemHost, "Parts")
Rel_D(InventoryTracking, ProdSystemHost, "Tracking")
Rel_D(Monitoring, ProdSystemHost, "Monitoring")
footer %filename() rendered with PlantUML version %version()\nThe Hitchhiker’s Guide to PlantUML
@enduml"/>
</p>
</td>
</tr>
<tr class="row-odd"><td><p>This uses the <a class="reference internal" href="C4/c4.html#c4-lightweight-software-architecture-description-method"><span class="std std-ref">C4 Lightweight Software Architecture Description Method</span></a>.
See <a class="reference internal" href="C4/c4acme.html#using-c4-to-architect-acme-global-widget-production"><span class="std std-ref">Using C4 To Architect ACME Global Widget Production</span></a></p></td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/AboutPlantUML.html">1. About PlantUML</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about/AboutPlantUML.html#diagrams-as-code">1.1. Diagrams As Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutPlantUML.html#shared-lexicon-of-understanding">1.2. Shared Lexicon of Understanding</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutPlantUML.html#interview-with-arnaud-roques-creator-of-plantuml">1.3. Interview with Arnaud Roques (creator of PlantUML)</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutPlantUML.html#useful-plantuml-links">1.4. Useful PlantUML Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="about/AboutThisGuide.html">2. About this Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about/AboutThisGuide.html#the-story">2.1. The Story</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutThisGuide.html#scope">2.2. Scope</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutThisGuide.html#goals">2.3. Goals</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutThisGuide.html#principles">2.4. Principles</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutThisGuide.html#credits">2.5. Credits</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/AboutThisGuide.html#feedback">2.6. Feedback</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="about/Sections.html">3. Sections of the Guide</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Using Standard Library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html">1. Create a Diagram of a Typical Network</a><ul>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#example-network-diagram">1.1. Example Network Diagram</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#select-an-icon-library">1.2. Select an icon library</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#view-all-the-icons-with-listsprites">1.3. View all the icons with listsprites</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#gather-the-icons-we-need">1.4. Gather the icons we need</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#decorate-the-icons">1.5. Decorate the Icons</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#create-the-diagram-by-connecting-things-together">1.6. Create the diagram by connecting things together</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#change-the-layout-to-vertical">1.7. Change the Layout to Vertical</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#change-the-layout-by-grouping-icons-together">1.8. Change the Layout by grouping icons together</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#add-a-legend-table-and-a-note">1.9. Add a Legend Table and a Note</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#conclusion">1.10. Conclusion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="aws/aws.html">2. Create Real Life AWS Diagrams</a><ul>
<li class="toctree-l2"><a class="reference internal" href="aws/aws.html#id1">2.1. AWSArchitectureBlogSample1</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws/aws.html#id17">2.2. AWSArchitectureBlogSample2</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws/aws.html#id24">2.3. AWSArchitectureBlogSample3</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kubernetes/kubernetes.html">3. Kubernetes and Azure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kubernetes/kubernetes.html#original">3.1. Original</a></li>
<li class="toctree-l2"><a class="reference internal" href="kubernetes/kubernetes.html#plantuml-equivalent">3.2. PlantUML Equivalent</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gcp/gcp.html">4. Google Cloud Platform</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gcp/gcp.html#original">4.1. Original</a></li>
<li class="toctree-l2"><a class="reference internal" href="gcp/gcp.html#plantuml-equivalent">4.2. PlantUML Equivalent</a></li>
<li class="toctree-l2"><a class="reference internal" href="gcp/gcp.html#find-icons">4.3. Find icons</a></li>
<li class="toctree-l2"><a class="reference internal" href="gcp/gcp.html#gather-the-icons-we-need">4.4. Gather the icons we need</a></li>
<li class="toctree-l2"><a class="reference internal" href="gcp/gcp.html#connect-the-icons">4.5. Connect The Icons</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="C4/c4acme.html">5. Using C4 To Architect ACME Global Widget Production</a><ul>
<li class="toctree-l2"><a class="reference internal" href="C4/c4acme.html#c4-acme-global-widget-production">5.1. C4 ACME Global Widget Production</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">PlantUML Features</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html">1. Use Images in Diagrams</a><ul>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#deployment-diagram-elements">1.1. Deployment Diagram Elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#standard-library-sprites">1.2. Standard Library Sprites</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#create-a-sprite">1.3. Create A Sprite</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#images">1.4. Images</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scale/scale.html">2. Scaling Sprites</a><ul>
<li class="toctree-l2"><a class="reference internal" href="scale/scale.html#scaling-sprite-options">2.1. Scaling Sprite Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="scale/scale.html#revisiting-scalebigsmall-label">2.2. Revisiting <span class="xref std std-ref">scalebigsmall-label</span></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="procedures/procedures.html">3. Procedures and Keyword Arguments</a><ul>
<li class="toctree-l2"><a class="reference internal" href="procedures/procedures.html#defines-are-deprecated">3.1. Defines Are Deprecated</a></li>
<li class="toctree-l2"><a class="reference internal" href="procedures/procedures.html#default-values">3.2. Default Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="procedures/procedures.html#keyword-arguments">3.3. Keyword Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html">4. PassSpriteAsParameter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html#understand-how-to-pass-a-sprite-to-a-procedure">4.1. Understand How To Pass A Sprite To A Procedure</a></li>
<li class="toctree-l2"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html#understand-how-to-pass-a-sprite-to-a-procedure-using-unquoted-keyword">4.2. Understand How To Pass A Sprite To A Procedure - using unquoted keyword</a></li>
<li class="toctree-l2"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html#use-procedure-defaults">4.3. Use Procedure Defaults</a></li>
<li class="toctree-l2"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html#so-what">4.4. So What?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="color/color.html">5. Colors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="color/color.html#hex-codes-and-pre-defined-colours">5.1. Hex Codes and Pre-defined Colours</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="layout/layout.html">6. Layout</a><ul>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#arrows-for-layout">6.1. Arrows for Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#up-down-left-right">6.2. up down left right</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#left-to-right-direction">6.3. left to right direction</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#top-to-bottom-direction">6.4. top to bottom direction</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#hidden">6.5. hidden</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#nodesep-and-ranksep">6.6. nodesep and ranksep</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#id1">6.7. together</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout/layout.html#linetype-polyline-ortho">6.8. linetype polyline ortho</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html">7. Tricked Out Diagrams (aka Diagram Annotation)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html#notes">7.1. Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html#handwritten">7.2. Handwritten</a></li>
<li class="toctree-l2"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html#title">7.3. Title</a></li>
<li class="toctree-l2"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html#footer">7.4. Footer</a></li>
<li class="toctree-l2"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html#comments">7.5. Comments</a></li>
<li class="toctree-l2"><a class="reference internal" href="diagramAnnotation/diagramAnnotation.html#caption">7.6. Caption</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Understanding Standard Library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StdLibOverview.html">1. PlantUML Stdlib Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StdLibOverview.html#plantuml-standard-library-overview">1.1. PlantUML Standard Library Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StdLibOverview.html#superset-of-parameters">1.2. Superset Of Parameters</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="StdlibUnderTheHood/StdlibUnderstanding.html">2. PlantUML Stdlib Under The Hood</a><ul>
<li class="toctree-l2"><a class="reference internal" href="StdlibUnderTheHood/StdlibUnderstanding.html#goal">2.1. Goal</a></li>
<li class="toctree-l2"><a class="reference internal" href="StdlibUnderTheHood/StdlibUnderstanding.html#steps-to-understanding">2.2. Steps to Understanding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StandardisingStdLib.html">3. PlantUML Stdlib Under The Hood 2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib.html#step-by-step-towards-a-standard-macro">3.1. Step-by-step Towards A Standard Macro</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib.html#close-but">3.2. Close But…</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib.html#procedure-keyword-arguments">3.3. Procedure Keyword Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib.html#extensibility">3.4. Extensibility</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Standardising Standard Library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/stdlibRequirements.html">1. Standard Library - What We Have And What We Want</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/stdlibRequirements.html#observations-on-standard-library">1.1. Observations on Standard Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/stdlibRequirements.html#macro-definitions">1.2. Macro Definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/stdlibRequirements.html#what-a-user-wants-in-a-standard-library">1.3. What a User Wants In A Standard Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/stdlibRequirements.html#user-stories">1.4. User Stories</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html">2. Standardising Standard Library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html#plantuml-stdlib-terminology">2.1. Plantuml Stdlib Terminology</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html#plantuml-stdlib-file-layout">2.2. Plantuml Stdlib File Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html#standardising-sprites">2.3. Standardising Sprites</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html#standardising-icon-macro-api">2.4. Standardising Icon Macro API</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html#mode-example">2.5. Mode Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="Stdlib/StandardisingStdLib2.html#mode-demo">2.6. Mode Demo</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Future</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about/future.html">1. Thoughts For The Future</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#a-showcase-template-site">1.1. A Showcase Template Site</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#hyperlinked-interactive-diagrams">1.2. Hyperlinked Interactive Diagrams</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#machine-processing-of-text-files">1.3. Machine Processing Of Text Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#architecture-icon-sets">1.4. Architecture Icon Sets</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#security-modeling">1.5. Security Modeling</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#github-actions-and-workflows">1.6. Github Actions and Workflows</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#guide-for-plantuml-diagrams">1.7. Guide for PlantUML Diagrams</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/future.html#interactive-notebook-guide">1.8. Interactive Notebook Guide</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">2. To Do List</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Annex Standard Library C4</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="C4/c4.html">1. C4 Lightweight Software Architecture Description Method</a><ul>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#introduction">1.1. Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#cheatsheet">1.2. CheatSheet</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#video-presentation">1.3. Video Presentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#related-methods">1.4. Related Methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="C4/C4Stdlib.html">2. Using PlantUML Stdlib C4 Lightweight Software Architecture Description Method</a><ul>
<li class="toctree-l2"><a class="reference internal" href="C4/C4Stdlib.html#c4">2.1. C4</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/C4Stdlib.html#c4-plantuml">2.2. C4 PlantUML</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/C4Stdlib.html#c4-example-big-bank">2.3. C4 Example Big Bank</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Annex</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="github/githubFileFinder.html">1. GitHub File Finder</a></li>
<li class="toctree-l1"><a class="reference internal" href="DocumentationAsCode/JourneyDocumentationASCode.html">2. Journey to Documentation as Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="DocumentationAsCode/JourneyDocumentationASCode.html#my-view-on-documentation-from-2013">2.1. My View On Documentation From 2013</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="about/AboutPlantUML.html" class="btn btn-neutral float-right" title="1. About PlantUML" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>