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
|
<!DOCTYPE section>
<section>
<title>Introduction</title>
<para>
<mediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.pdf" width="2cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml_80x80.png"/></imageobject>
</mediaobject>
<!-- What is it? -->
crystal-facet-uml creates diagrams to document system and software architecture.
</para>
<para>
Like a crystal shows different facets of the same thing, this application
shows different views of the same system.
</para>
<para>
<mediaobject>
<imageobject><imagedata fileref="screenshot_1.png" width="16cm"/></imageobject>
</mediaobject>
</para>
<section>
<title>Goal</title>
<para>
<mediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.pdf" width="1cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.png"/></imageobject>
</mediaobject>
<!-- For Whom? What can one do with it? Why does it help? -->
As software architect, you create a set of diagrams describing
use-cases, requirements, structural views, behavioral and deployment views.
</para>
<para>
<!-- How does the tool solve the task? What is the data flow? Is it interoperable? input/output formats. required Environment? -->
crystal-facet-uml keeps element names and element hierarchies consistent.
The tool exports diagrams in svg, pdf, ps and png formats
to be used in text processing systems like DocBook, html, LaTeX.
crystal-facet-uml exports the model to json and xmi format; json can also be imported.
The json-based data file can be stored to git, branched and merged together with your source code.
This tool runs on your local PC and is based on gtk (incl. glib, gdk, cairo, pango) and sqlite.
</para>
</section>
<section>
<title>Features</title>
<para>
<mediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.pdf" width="1cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.png"/></imageobject>
</mediaobject>
</para>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="1_non_tech_intro_para.xml" />
</section>
<section>
<title>Usage Overview</title>
<para>
<mediaobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.pdf" width="1cm"/></imageobject>
<imageobject><imagedata fileref="../../gui/source/resources/crystal_facet_uml.png"/></imageobject>
</mediaobject>
crystal-facet-uml can be started in graphical mode (see <xref linkend="gui_main"/>)
or from command line (see <xref linkend="cli_main"/>).
</para>
</section>
</section>
|
