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
|
<!DOCTYPE section>
<section id="gui_main">
<title>Graphical User Interface</title>
<para>
Start the application by a click on the application icon.
</para>
<section>
<title>Window Area Overview</title>
<para>
crystal-facet-uml shows a window with
<itemizedlist>
<listitem><para>toolbar on top,</para></listitem>
<listitem><para>drawing area in the center,</para></listitem>
<listitem><para>element configuration widgets to the right and</para></listitem>
<listitem><para>an optional notification bar at the bottom.</para></listitem>
</itemizedlist>
</para>
<para>
<mediaobject>
<imageobject><imagedata fileref="screenshot_2.png" width="16cm"/></imageobject>
</mediaobject>
</para>
</section>
<section>
<title>Tool Bar</title>
<para>
The top row of a window provides buttons to select files, change the view and modify model elements.
</para>
<para>
<mediaobject>
<imageobject><imagedata fileref="3_main_window_sketch_1.svg" width="4cm"/></imageobject>
</mediaobject>
</para>
<section>
<title>New</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/file_new.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Creates a new database file.
</para>
</listitem>
<listitem>
<para>
Enter a filename;
a json-based file structure is used to store your data in a git-friendly format.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Open</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/file_open.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Opens an existing database file.
</para>
</listitem>
<listitem>
<para>
To open json-based formats (e.g. <command>.cfuJ</command>), write access to the parent
folder is required.
</para>
</listitem>
<listitem>
<para>
If you find a <command>.tmp-cfu</command> file,
this indicates that the last session was possibly terminated abnormally.
You should open this file to continue from the latest state.
Alternatively, select the <command>.cfuJ</command> to continue from the last save action.
Do not open <command>*-journal</command> files.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Save</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/file_save.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/file_saved.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/file_unsaved.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Stores the latest changes to the database immediately.
Note that at regular program exit, the database is stored automatically anyhow.
</para>
</listitem>
<listitem>
<para>
The icon indicates if there are unsaved changes,
it is yellow in case the window is in the background.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Export</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/file_export.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Exports all diagrams to the selected folder.
Supported export formats are docbook, html, json, pdf, png, ps, svg, txt, xmi.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>New Window</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_new_window.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Opens another window on the same database.
This new window allows you to work reliably with multiple windows on the same database.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Search</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_search.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Find diagrams that contain the searched elements (see <xref linkend="draw_search"/>)
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Navigate</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_navigate.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Navigate to parent or child diagrams</para></listitem>
<listitem><para>Create a new diagram (see <xref linkend="draw_navigate"/>)</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Edit</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_edit.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Modify elements in the diagram (see <xref linkend="draw_edit"/>)</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Create</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_create.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Create elements in the diagram (see <xref linkend="draw_create"/>)</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Undo</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_undo.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Un-does the last operation (Opening a database and exporting files cannot be undone)
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Redo</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_redo.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Re-does the last un-done operation</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Cut</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_cut.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Cut all selected (pink-cornered) elements to the clipboard
(features of classifiers are copied if the classifier is selected)
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Copy</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_copy.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Copy all selected (pink-cornered) elements to the clipboard
(features of classifiers are copied if the classifier is selected)
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Paste</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_paste.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
If the clipboard does not contain diagrams, classifiers and relationships from the clipboard
are copied into the current diagram.
</para>
</listitem>
<listitem>
<para>
If the clipboard contains a diagram, this diagram is pasted below the current diagram.
All other elements are pasted into the new diagram.
</para>
</listitem>
<listitem>
<para>
If a classifier is identical to an existing one (same uuid),
an instance of the existing classifier is pasted to the diagram.
Otherwise a new classifier is created.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Delete</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_delete.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Deletes all selected (pink-cornered) elements.
</para>
</listitem>
<listitem>
<para>
This operation may fail on a diagram if the selected diagram contains non-selected elements
or child diagrams.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Instantiate</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_instantiate.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Toggles the selected (pink-cornered) classifiers between classes, named instances and anonymous instances.</para></listitem>
<listitem><para>No effect on relationships and features.</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Highlight</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_highlight.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Toggles the selected (pink-cornered) classifiers between yellow-marked, greyed-out and normal.
(Does not work for relationships and features)
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Reset Selection</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/edit_reset.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Resets the (pink-cornered) selection</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>About</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Shows version, license and copyrights</para></listitem>
</itemizedlist>
</para>
<para>
<mediaobject>
<imageobject><imagedata fileref="screenshot_3.png" width="16cm"/></imageobject>
</mediaobject>
</para>
</section>
</section>
<section>
<title>Drawing Area</title>
<para>
The center area of a window allows to view and change diagrams and model elements.
</para>
<para>
<mediaobject>
<imageobject><imagedata fileref="3_main_window_sketch_2.svg" width="4cm"/></imageobject>
</mediaobject>
Diagrams are layouted automatically. You can influence the locations of classifiers only.
When adding too many classifiers or relations, auto layouting may not achieve the expected results.
In many cases, splitting the diagram into two or more diagrams solves the layouting issues and
at the same time improves understandability by focusing on one aspect/topic per diagram.
</para>
<section id="draw_search">
<title>Search</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_search.pdf" width="1cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_search.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Enter the ID of an element (e.g. C0001) or a part of its name or description
to find diagrams containing this element.
</para>
</listitem>
<listitem>
<para>
Enter nothing
to find diagrams containing elements without description.
</para>
</listitem>
</itemizedlist>
</para>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/search_search.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Starts a search and displays the results</para></listitem>
<listitem>
<para>
In case the list of search results is too long, consider to export the model
and search in the generated output instead.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id="draw_navigate">
<title>Navigate</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_navigate.pdf" width="1cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_navigate.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>To navigate to parent, sibling or children diagrams, click on the diagram.</para>
</listitem>
<listitem>
<para>To create a new diagram, click on the
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/navigate_create_sibling.svg" width="0.7cm"/></imageobject>
</inlinemediaobject>
icon, or the smaller
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/navigate_create_child.svg" width="0.7cm"/></imageobject>
</inlinemediaobject>
icon for a new child-diagram.
</para>
</listitem>
<listitem>
<para>
To restructure the diagram tree, drag a diagram name to the new location.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id="draw_edit">
<title>Edit</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_edit.pdf" width="1cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_edit.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem>
<para>
Click on the diagram or a classifier or a feature or a relationship
to edit the name, type and description of that object.
</para>
<para>
The yellow corners indicate which object is currently focused.
</para>
</listitem>
<listitem>
<para>
Click on an element to select or unselect an object (pink corners).
</para>
<para>
The toolbar buttons apply to this pink-cornered set.
</para>
</listitem>
<listitem>
<para>
To move classifiers within the diagram, 1.) press, 2.) drag and 3.) release the mouse button.
</para>
<para>
Note: When moving a classifier, this is moved in all diagrams where it appears.
Order and locations of things stay consistent between different views.
</para>
</listitem>
</itemizedlist>
It is not possible to change source and destination classifiers of relationships.
Instead, delete the old and create a new relationship.
</para>
</section>
<section id="draw_create">
<title>Create</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_create.pdf" width="1cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/view_create.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<orderedlist>
<listitem>
<para>
To create a classifier, click at an empty space in the diagram.
</para>
</listitem>
<listitem>
<para>
To create a child classifier, click into the white space of a classifier.
(Alternatively, create a classifier (see 1) and a containment relationship (see 4).)
</para>
</listitem>
<listitem>
<para>
To create a feature, click onto a classifier border (not on the classifier name).
</para>
</listitem>
<listitem>
<para>
To create a relationship, press on the source classifier or feature
and drag it to the destination classifier or feature.
</para>
</listitem>
</orderedlist>
<mediaobject>
<imageobject><imagedata fileref="3_main_window_sketch_2_create.svg" width="10cm"/></imageobject>
</mediaobject>
To modify existing elements, switch back to edit mode: <xref linkend="draw_edit"/>.
</para>
</section>
</section>
<section>
<title>Element Configuration Area</title>
<para>
The right side of a window shows the properties of the focused model element.
</para>
<para>
<mediaobject>
<imageobject><imagedata fileref="3_main_window_sketch_3.svg" width="4cm"/></imageobject>
</mediaobject>
Edit the properties of the focused (yellow-cornered) object.
<itemizedlist>
<listitem>
<para>name of the focused object</para>
</listitem>
<listitem>
<para>stereotype of the focused object.</para>
<para>Stereotype names shall consist of characters that are valid XML tokens (Nmtoken).
<!-- see Nmtoken in XML 1.1 spec -->
</para>
<para>Multiple stereotypes shall be separated by comma.
</para>
<para>Rendering images of stereotypes only works for single stereotypes.
</para>
<para>In case of properties and operations enter the type of the property or operation arguments,
in case of tagged values, enter the value (instead of a stereotype).
</para>
</listitem>
<listitem>
<para>type of the focused object</para>
</listitem>
<listitem>
<para>description of the focused object.</para>
<para>For html and DocBook export, use
a double linebreak to create a new paragraph,
start lines with *, + or - to format a list,
use D0001#id and D0001#name to create a link to
the diagram D0001 (showing either the id or the name).
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Notification Bar</title>
<para>
The bottom row of a window, if shown, displays the result of the last user interaction.
</para>
<para>
<mediaobject>
<imageobject><imagedata fileref="3_main_window_sketch_4.svg" width="4cm"/></imageobject>
</mediaobject>
The notification bar appears automatically when there is a new message.
</para>
<para>
Such a message may show statistics on performed actions like created, exported, modified, deleted for the following
elements
<itemizedlist>
<listitem>
<para>diagrams,</para>
</listitem>
<listitem>
<para>classifiers refer to the model-nodes,</para>
</listitem>
<listitem>
<para>classifier-occurrences refer to the visualization of a classifier in a diagram,</para>
</listitem>
<listitem>
<para>features denote properties, operations and ports of classifiers,</para>
</listitem>
<listitem>
<para>relationships are the edges between the classifiers or features or lifelines,</para>
</listitem>
<listitem>
<para>lifelines refer to implicit and automatically managed objects needed to visualize temporal behavior.</para>
</listitem>
</itemizedlist>
</para>
<section><title>Information</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/message_info.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Informs on success of an operation, e.g. an export</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Warning</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/message_warn.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Informs on a possible problem, e.g. a read-only database file</para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Error</title>
<para>
<inlinemediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/message_error.svg" width="1cm"/></imageobject>
</inlinemediaobject>
<itemizedlist>
<listitem><para>Informs on an error, e.g. invalid data pasted from clipboard</para></listitem>
</itemizedlist>
</para>
</section>
</section>
</section>
|
