-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathinstructions.html
1334 lines (1303 loc) · 66.5 KB
/
instructions.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
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SequenceDiagram.org - Instructions and Examples</title>
<meta name="description" content="Sequence diagram examples and instruction.">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" href="https://sequencediagram.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" type="text/css" href="./instructions_files/index.css">
<link rel="shortcut icon" href="https://sequencediagram.org/favicon.ico" type="image/x-icon">
<script src="./instructions_files/lz-string.min.js"></script>
</head>
<body class="popupDialogIFrameBody">
<div>
<div class="instruction">
<p>Below follows a examples of all different sequence diagram UML elements supported by the editor.</p>
<p>Click the example sequence diagram images to append them to the diagram, hover to see the example script.</p>
</div>
<div class="instruction">
<h2 class="instructionHeading">Buttons</h2>
<p><img alt="new" class="negtopmargin" src="./instructions_files/new.svg" height="50">Start working on a new diagram (same as opening a
new tab in your browser, or changing the File Name in the save menu)</p>
<p><img alt="open" class="negtopmargin" src="./instructions_files/open.svg" height="50">Open a source script text file directly from your
hard drive, the browsers local storage, or cloud storage.</p>
<p><img alt="save" class="negtopmargin" src="./instructions_files/save.svg" height="50">Save the source script as a text file directly to
your hard drive, in the browsers local storage, or cloud storage.</p>
<p><img alt="export" class="negtopmargin" src="./instructions_files/export01.svg" height="50">Export the diagram to images files, share link, or render it for copy / paste.</p>
<p><img alt="participant" class="negtopmargin" src="./instructions_files/participant01.svg" height="50">Adds a new participant into the
diagram of type participant.</p>
<p><img alt="zoom in" class="negtopmargin" src="./instructions_files/zoomin.svg" height="50">Zoom in (also affects the export to image files).</p>
<p><img alt="zoom out" class="negtopmargin" src="./instructions_files/zoomout.svg" height="50">Zoom out (also affects the export to image files)</p>
</div>
<div class="instruction">
<h2 class="instructionHeading">Keyboard Shortcuts</h2>
<table>
<tbody><tr>
<td>Ctrl-S / Cmd-S</td>
<td>- Save diagram source</td>
</tr>
<tr>
<td>Ctrl-O / Cmd-O</td>
<td>- Open diagram source</td>
</tr>
<tr>
<td>Ctrl-M / Cmd-M</td>
<td>- Presentation mode</td>
</tr>
<tr>
<td>Ctrl-Space / Cmd-Space</td>
<td>- Autocomplete in source</td>
</tr>
<tr>
<td>Ctrl-F / Cmd-F</td>
<td>- Find in source</td>
</tr>
<tr>
<td>Shift-Ctrl-F / Cmd-Option-F</td>
<td>- Replace in source</td>
</tr>
<tr>
<td>Shift-Ctrl-R / Shift-Cmd-Option-F</td>
<td>- Replace all in source</td>
</tr>
<tr>
<td>Alt-G</td>
<td>- Go to line in source</td>
</tr>
</tbody></table>
</div>
<div class="instruction">
<h2 class="instructionHeading">Comments</h2>
<ul>
<li>Text comments can be added in the diagram source on separate lines prefixed with either // or #</li>
</ul>
<div class="instructionsImage">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText"># This is a comment
// This is also a comment
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Title</h2>
<ul>
<li>The title is displayed at the top of the diagram</li>
<li>The title can also be used as the file name (enabled in settings) when the<img alt="save" class="negtopmargin" src="./instructions_files/save.svg" height="50">icons
are clicked
</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/title.png" alt="sequence diagram title example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">title Title
A->B:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Participants</h2>
<ul>
<li>New particpants of type participant may be added by clicking the <img alt="participant" class="negtopmargin" src="./instructions_files/participant01.svg" height="50"> icon
</li>
<li>The following special participant types exist
<ul>
<li>actor - specific icon</li>
<li>boundary - specific icon</li>
<li>control - specific icon</li>
<li>database - specific icon</li>
<li>entity - specific icon</li>
<li>fontawesome - different icons from Font Awesome specified by the unicode code points found here: <a href="http://fontawesome.io/icons/" target="_blank" rel="noopener">fontawesome.io/icons</a>
</li>
<li>materialdesignicons - different icons from Material Design Icons specified by the unicode code points found here: <a href="https://materialdesignicons.com/cheatsheet" target="_blank" rel="noopener">materialdesignicons.com/cheatsheet</a>
</li>
<li>fontawesome5solid - different icons from Font Awesome 5 Free solid specified by the unicode code points found here: <a href="https://fontawesome.com/icons?d=gallery&s=solid&m=free" target="_blank" rel="noopener">fontawesome.com/icons?d=gallery&s=solid&m=free</a>
</li>
<li>fontawesome5regular - different icons from Font Awesome 5 Free regular specified by the unicode code points found here: <a href="https://fontawesome.com/icons?d=gallery&s=regular&m=free" target="_blank" rel="noopener">fontawesome.com/icons?d=gallery&s=regular&m=free</a>
</li>
<li>fontawesome5brands - different icons from Font Awesome 5 Brands specified by the unicode code points found here: <a href="https://fontawesome.com/icons?d=gallery&s=brands&m=free" target="_blank" rel="noopener">fontawesome.com/icons?d=gallery&s=brands&m=free</a>
</li>
</ul>
</li>
<li>Note: The fonts are not embedded in exported SVG documents, hence, the font must be installed on the device viewing the SVG document</li>
<li>You may also use <a href="https://glyphsearch.com/?copy=unicode-hexadecimal" target="_blank" rel="noopener">glyphsearch.com</a> to get the
unicode code
points for fontawesome and materialdesignicons
</li>
<li>Change the alias of a participant by double clicking it</li>
<li>A long displayed name can be written on form:
<ul>
<li>participant "some very\nlong name" as Alice</li>
</ul>
</li>
<li>Delete a participant by clicking it and using the delete key</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/participant.png" alt="sequence diagram participant example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant Participant</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/actor.png" alt="sequence diagram actor example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">actor Actor</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/boundary.png" alt="sequence diagram boundary example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">boundary Boundary</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/control.png" alt="sequence diagram control example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">control Control</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/database.png" alt="sequence diagram database example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">database Database</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/entity.png" alt="sequence diagram entity example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">entity Entity</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/actorMultiline.png" alt="sequence diagram actor with multi line example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">actor "**++Big and\\nbold name" as actorMultiline #red</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/participantMultiline.png" alt="sequence diagram participant with multi line example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant "some long\\nname with **//styling//**" as participantMultiline</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/fontawesome.png" alt="sequence diagram fontawesome icon example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">fontawesome f099 Twitter #1da1f2</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/materialdesignicons.png" alt="sequence diagram materialdesignicons icon example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">materialdesignicons F1FF escalator</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/fontawesome5.png" alt="sequence diagram font awesome 5 icon example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">fontawesome5solid f48e "++**Syringe**++" as Syringe #red
fontawesome5regular f0f8 Hospital #blue
fontawesome5brands f3b6 Jenkins #green
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/participantStyling.png" alt="sequence diagram participant styling example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">actor #green:0.5 Actor
boundary #ff00ff:2 Boundary
control :1 Control
database #blue:1 Database #red
entity :0.5 Entity
participant :0 Participant
participant :0 "++**Participant 2**++" as p2
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Bottom Participants</h2>
<ul>
<li>The participants can be displayed in the bottom of the diagram by using the bottomparticipants keyword which renders all the participants
in the bottom of the diagram
</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/bottomParticipants.png" alt="sequence diagram bottom participants example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">bottomparticipants
participant A
participant "BBBB\nBBBB" as B
materialdesignicons f14d note
fontawesome5regular f0f8 Hospital
fontawesome5brands f3b6 Jenkins
actor Actor
A->B:info
A->note:info
A->Hospital:info
A->Jenkins:info
A->Actor:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Messages</h2>
<ul>
<li>Messages are created by clicking and dragging in the diagram
<ul>
<li>Hold Shift before clicking for dashed line</li>
<li>Hold Ctrl before clicking for open arrow</li>
<li>Hold Shift+Ctrl before clicking for open arrow with dashed line</li>
</ul>
</li>
<li>Edit the text of a message by double clicking it</li>
<li>Change the start and end participants of the message by clicking and dragging the start or end of the message</li>
<li>Change position of the message by clicking and dragging the middle of the message</li>
<li>Delete the message by clicking it and pressing the delete key</li>
<li>New line is create using \n</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/syncreqresp.png" alt="sequence diagram request response example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->B:request
A<--B:response
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/asyncreqresp.png" alt="sequence diagram async request response example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->>B:request
A<<--B:response
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/selfmessage.png" alt="sequence diagram self referencing message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->A:self message</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/messageLineWeight.png" alt="sequence diagram line weight message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">Alice-:4>Bob:Test12345
Alice-:2>>Bob:Test
Alice-#00ff00:2>Bob:Test
Alice--#red:4>Bob:Test
Alice<<#red:3--Bob:Test
Alicex#red:3-Bob:Test
Alice-:4>(5)Bob:Test
Bob-:4>Bob:Test
Alice<-:3>Bob:Test
Alice<-#00ff00:2>Bob:Test
Alice<-#red:3>Bob:Test</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Non-instantaneous Messages</h2>
<ul>
<li>Non-instantaneous messages are created by adding ([delay]) before the target participant, examples:
<ul>
<li>A->(1)B: info</li>
<li>A-->(5)B: info</li>
<li>A->>(2)B: info</li>
</ul>
</li>
<li>Otherwise non-instantaneous messages behaves just like normal messages</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/noninstantaneousmessage.png" alt="sequence diagram non-instantaneous message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant A
participant B
participant C
A->(1)B:info
A(1)<--B:info
A(1)<-C:info
B->(5)C:info\ninfo
activate B
activate C
B(1)<--C:info
deactivate C
deactivate B
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/spacenoninstantaneousmessage.png" alt="sequence diagram non-instantaneous messages arriving after later message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">Client->(5)Server:first sent message
space -6
Client->Server:later message
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Incoming and Outgoing Messages</h2>
<ul>
<li>Incoming and Outgoing Messages are created by using the special participants [ and ], examples:
<ul>
<li>[->A: info</li>
<li>A->]: info</li>
</ul>
</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/inAndOutMessages.png" alt="sequence diagram incoming and outgoing messages example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">[->A:info
B->]:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Failure Messages</h2>
<ul>
<li>Failure Messages are created by using x to denot the arrow head, examples:
<ul>
<li>A-xB: info</li>
<li>A--#redx(1)C: info</li>
</ul>
</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/failureMessage.png" alt="sequence diagram failure message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A-#redxB:failure 1
C-xB:failure 2
Bx-B:failure 3
C(5)x--A:failure 4
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Notes and Boxes</h2>
<ul>
<li>Notes and boxes are created by right clicking in the diagram and selecting the wanted note / box entry from the menu</li>
<li>Edit the text of a note or box by double clicking it</li>
<li>Change the start and end participants of the "note or box over several participants" by clicking and dragging the start or end of the note
or box
</li>
<li>Change position of the note or box by clicking and dragging the middle of the note or box
<ul>
<li>
Note: It is the bottom of the shapes that counts as the y position when dragging
</li>
</ul>
</li>
<li>Delete the note or box by clicking it and pressing the delete key</li>
<li>New line is create using \n</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/noteover.png" alt="sequence diagram notes over example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">note over A:note over one\nmultiple lines\nof text
note over A,B:note over several
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/notesides.png" alt="sequence diagram notes on sides example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">note left of A:note left of
note right of A:note right of
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/boxover.png" alt="sequence diagram box over example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">box over A:box over one
box over A,B:box over several
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/boxsides.png" alt="sequence diagram boxes on sides example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">box left of A:box left of
box right of A:box right of
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/aboxover.png" alt="sequence diagram angular box over example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">abox over A:abox over one
abox over A,B:abox over several
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/aboxsides.png" alt="sequence diagram angular box on sides example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">abox left of A:abox left of
abox right of A:abox right of
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/rboxover.png" alt="sequence diagram round box over example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">rbox over A:rbox over one
rbox over A,B:rbox over several
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/rboxsides.png" alt="sequence diagram round box on sides example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">rbox left of A:rbox left of
rbox right of A:rbox right of
</div>
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/aboxleftright.png" alt="sequence diagram angular box left and right example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">aboxright over A,B:This is angular boxright
aboxleft over A,B:This is angular boxleft
aboxright over A:This is angular boxright
aboxleft over B:This is angular boxleft
aboxright right of A:This is angular boxright
aboxright left of B:This is angular boxright
aboxleft right of A:This is angular boxright
aboxleft left of B:This is angular boxleft
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">References</h2>
<ul>
<li>References are created by right clicking in the diagram selecting over which participants the reference should be from the menu</li>
<li>Edit the text of a reference by double clicking it</li>
<li>Change the start and end participants of the reference by clicking and dragging the start or end of the reference
</li>
<li>Change position of the reference by clicking and dragging the middle of the note or box
<ul>
<li>
Note: It is the bottom of the shapes that counts as the y position when dragging
</li>
</ul>
</li>
<li>Delete the reference by clicking it and pressing the delete key</li>
<li>New line is create using \n</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/references.png" alt="sequence diagram notes over example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->B:info
ref over B,C:other interaction
C->D:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Dividers</h2>
<ul>
<li>Dividers are created by right clicking in the diagram and selecting the divider entry from the menu</li>
<li>Edit the text of a divider by double clicking it</li>
<li>Change position of the divider by clicking and dragging it</li>
<li>Delete the divider by clicking it and pressing the delete key</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/divider.png" alt="sequence diagram divider example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant A
participant B
participant C
participant D
==info==
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Create and Destroy</h2>
<ul>
<li>Create and destroy are at this point not part of the context menu, participants may be defined in the start of the diagram
<ul>
<li>participantNameA->*participantNameB: message: Sends a message to participantNameB and creates participantNameB</li>
<li>create participantName: Creates the participant without sending a message to it</li>
<li>destroy participantName: Destroys the participant at the previous entry's y position</li>
<li>destroyafter participantName: Destroys the participant at after a space and gives the destroy symbol its own space</li>
<li>destroysilent participantName: Destroys the participant at the previous entry's y position without rendering the destroy symbol</li>
</ul>
</li>
<li>Click and drag on the entries to move them in y axis using the mouse</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/createMessageDestroy.png" alt="sequence diagram create message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant A
actor X
participant B
A->B:info
B-->*C:<<create>>
note over C:do something
B<-C:info
destroy C
B->*X:message to X
note over X:do something
destroyafter X
A->B:info
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/createAndDestroy.png" alt="sequence diagram create without message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->B:info
create C
note over C: C created without message
A<-C:info
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/destroySilent.png" alt="sequence diagram destroy silent example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->>B:request
A<<--B:response
destroysilent B
destroysilent A
C->D: info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Activations</h2>
<ul>
<li>Activations are created by right clicking in the diagram and selecting the activation entry from the menu
<ul>
<li>activate participantName: Activates the participant at the previous entry's y position</li>
<li>deactivate participantName: Deactivates the participant at the previous entry's y position. If no entry has been added since the
activation the activity is deactivated directly, use deactivateafter or space if you want an empty gap
</li>
<li>deactivateafter participantName: Deactivates the participant right below the previous entry's y position</li>
</ul>
</li>
<li>Activations cannot be selected, moved, or edited using the mouse</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/activationcallback.png" alt="sequence diagram activation example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant A
participant B
participant C
participant D
A->B:info
activate B
B->C:info
activate C
C->>D:info
activate D
B<--C:info
deactivate C
A<--B:info
deactivate B
B<-D:callback
deactivate D
activate B
A<<--B:info
deactivate B
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/activationselfref.png" alt="sequence diagram activation with self reference example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant B
participant D
activate D
B->D:info
activate B
deactivateafter B
D->D:info
activate D
space
deactivate D
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/activationselfmessage.png" alt="sequence diagram activation with self message example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">activate Alice
Alice->Alice:privateMethod()
activate Alice
Alice<<--Alice:returnValue
deactivate Alice
Alice->Alice:privateMethod()
activate Alice
Alice<<--Alice:returnValue
deactivateafter Alice
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Auto Activation</h2>
<ul>
<li>Auto Activation automatically create activations on request messages and deactives on response messages, usual activations and deactivations can be used in combination with automatic activation
<ul>
<li>autoactivation on: Activates automatic activations</li>
<li>autoactivation off: Deactivates automatic activations</li>
</ul>
</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/autoactivation.png" alt="sequence diagram automatic activation example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">autoactivation on
A->B:info
B->C:info
B<-C:info
B-->C:info
B->B:info
deactivateafter B
B<--C:info
A<--B:info
autoactivation off
A->B:info
A<--B:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Spaces</h2>
<ul>
<li>Spaces are created by right clicking in the diagram and selecting the space entry from the menu, examples:
<ul>
<li>space</li>
<li>space 3</li>
<li>space -4 (may be used in together with non-instantaneous messages to visualize messages being sent out earlier arriving after later
messages)
</li>
</ul>
</li>
<li>Change position of the space by clicking and dragging it</li>
<li>Delete the space by clicking it and pressing the delete key</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/space.png" alt="sequence diagram space example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant B
participant D
activate D
B->D:info
activate B
space 3
deactivate B
D->D:info
activate D
space
deactivate D
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Fragments</h2>
<ul>
<li>Fragments are created by right clicking in the diagram and selecting the wanted fragment type from the menu
<ul>
<li>Since many possible fragments exists, only the most common are included in the menu, complete list: alt, opt, loop, par, break,
critical, ref, seq, strict, neg, ignore, consider, assert, region
</li>
</ul>
</li>
<li>Special fragments
<ul>
<li>group allows a custom label for the fragment</li>
<li>expandable allows a portion of the diagram to be expanded (expandable-) and collapsed (expandable+), click
the label to toggle the expandable
</li>
</ul>
</li>
<li>Edit the text of a fragment by double clicking the top of the fragment or its else part</li>
<li>Change inclusion of entries by clicking and dragging top, bottom, or else part of the fragment</li>
<li>You can also create new items directly inside the fragment</li>
<li>Delete the whole fragment (but keep the contents) by clicking the top or bottom of the fragment and pressing the delete key</li>
<li>Delete only the else (else is only supported inside the alt fragment) part by clicking the else divider and pressing delete key</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/opt.png" alt="sequence diagram opt fragment example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">opt optional
note over A:info
A->B:info
end
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/alt.png" alt="sequence diagram alt fragment example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">alt case 1
A->B:info
else case 2
A->B:info
else case 3
A->B:info
end
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/loop.png" alt="sequence diagram loop fragment example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">loop i < 1000
note over A:info
A->B:info
end
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/parThread.png" alt="sequence diagram parallel thread fragment example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">par info
A->B:info1
thread test
A->B:info2
thread test
A->B:info2
end
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/par.png" alt="sequence diagram parallel fragment example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">par info
A->C:info
A->B:info
end
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/group.png" alt="sequence diagram group fragment example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">group own name
A->B:info
end
group own name [some text]
A->B:info
end
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/expandable.png" alt="sequence diagram expandable fragment example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->B:info1
expandable- info 1234567890
B->C:info2
C->D:info3
D->E:info4
end
E->F:info5
expandable+ info qwertyurtyuiortyuioasdfghjkwertyuio
B->C:info2
C->D:info3
D->E:info4
end
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Participant Groups</h2>
<ul>
<li>Participant Groups are at this point not part of the context menu</li>
<li>Participant Groups draws a box to encompass a set of participants</li>
<li>Multiple nested levels are supported</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/participantgroup1.png" alt="sequence diagram participant group example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participantgroup #lightgreen **Group 1**
participant A
participant B
end
participantgroup #lightblue **Long\nname**
participant C
end
B->C:info
note over A,B:info
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/participantgroup2.png" alt="sequence diagram nested participant group example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participantgroup #lightgreen **Group 1**
participantgroup #grey sub1
participant A
end
participantgroup #pink sub2
participant B
end
end
participantgroup #lightblue **Long\nname**
participant C
end
B->C:info
note over A,B:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Links</h2>
<ul>
<li>Links can be added to all entries with text</li>
<li>Links can be clicked in the diagram (opens a new window) and are included when the diagram is exported as an SVG document</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/link.png" alt="sequence diagram link example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">A->B:This text contains a <link:http://example.com>link</link>
note right of B:Here is <link:https://www.w3schools.com>another link</link> </div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/participantlink.png" alt="sequence diagram participant link example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant "Participant with a <link:http://example.com>link</link>" as Alice
Alice->Bob:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Frame</h2>
<ul>
<li>Frame draws a frame to encompass the entire diagram</li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/frame.png" alt="sequence diagram frame example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">frame Example Diagram
A->B:info
C->A: info
note over B,C:info
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/frameColor.png" alt="sequence diagram frame example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">frame #red Example Diagram
A->B:info
C->A: info
note over B,C:info
</div>
</div>
</div>
</div>
<div class="instruction">
<h2 class="instructionHeading">Text Styling</h2>
<ul>
<li>Text in all entries can be styled</li>
<li>Bold text: **some bold text**</li>
<li>Italic text: //some italic text//</li>
<li>Small text: --some small text--</li>
<li>Big text: ++some big text++</li>
<li>Monospaced text: ""some big text""</li>
<li>Strike through text: ~~some big text~~</li>
<li>Big and bold: ++**some big and bold text**++</li>
<li>Italic and small: //--italic and small--//</li>
<li>Use \ to escape wanted */-+ chars, examples: c\+\+ http:\/\/www.example.org</li>
<li>Color: <color:#red>red text</color></li>
<li>Aligned text: <align:center>some centered text<align></li>
<li>Sized text: <size:20>some very large text<size></li>
<li>Stroke: <stroke:5:#red>text stroked with weight 5</stroke></li>
<li>Background: <background:#red>text with background</background></li>
<li>Difference: <difference>inverse text color for high contrast, use in combination with text color #white</difference></li>
</ul>
<div class="instructionsImage"><img src="./instructions_files/textstyle.png" alt="sequence diagram text styling example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">box over A:**some bold text**
box over A://some italic text//
box over A:--some small text--
box over A:++some big text++
box over A:++**Big and bold\nlines of text**++\n//--italic and small--//
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/textStyleColor.png" alt="sequence diagram text styling color example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant "Al<color:#red>ice</color>//**Long** ++name++//" as Alice
box over Alice:Com<color:#00ff00>binations:\n++**Big and bold green\nlines of text**++\n//--ital</color>ic and small--//\n++Writing
C\+\+ in big text using \ to escape +++
</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/textStyleMonospaced.png" alt="sequence diagram text styling example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">note over A:""This is mono spaced"" </div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/textStyleSize.png" alt="sequence diagram text styling example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">note over Bob:<size:20>infoinfo</size><size:10>infoinfo</size> </div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/textStyleAlign.png" alt="sequence diagram text styling example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">note over Alice:<align:left>infoinfoinfo\ninfo</align>
note over Alice:<align:center>infoinfoinfo\ninfo</align>
note over Alice:<align:right>infoinfoinfo\ninfo</align> </div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/textStylingStrikethrough.png" alt="sequence diagram text styling strikethrough example">
<div class="instructionImageCaption">
<div class="instructionImageCopyIcon" title="Copy">⎘</div>
<div class="instructionImageText">participant "Long ~~strikethrough~~ name" as Alice
Alice->Bob:Click and ~~drag to create a request~~ or\ntype it in the source area to the left</div>
</div>
</div>
<div class="instructionsImage"><img src="./instructions_files/textStyleStroke.png" alt="sequence diagram text styling stroke example">