Version 26.1 by Alexander Schulz-Rosengarten on 2023/07/11 10:25
Show last authors
1 {{panel title="Project Overview" borderStyle="dashed"}}
2 Responsible:
3
4 * {{mention reference="XWiki.uru" style="FULL_NAME" anchor="XWiki-uru-XJiwu"/}}
5
6 Demo Videos:
7
8 * [[Browsing a models repository with KlighDning>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/videos/klighdning/||shape="rect"]]
9 * [[Collaboratively browsing model diagrams>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/videos/klighdning_sync/||shape="rect"]]
10 {{/panel}}
11
12 The **KLighDning** project aims at providing a flexible infrastructure to browse arbitrary models. It combines the [[KlighD >>doc:KIELER.Home.Lightweight Diagrams (KLighD).WebHome]]technology with web technologies, such as websockets and SVG, to present transiently synthesized diagrams of the models within a webbrowser. KLighDnings focus is //browsing// model diagrams for documentation purposes, not //editing// of the models. As part of the documentation idea, basic collaboration facilities are included. Users can join so-called //rooms// in which the browsing process is synchronized for all participants, for instance, panning, zooming, and expanding of compound nodes.
13
14 {{info}}
15 Play around with our prototype at [[http:~~/~~/layout.rtsys.informatik.uni-kiel.de:20443>>url:http://layout.rtsys.informatik.uni-kiel.de:20443||shape="rect"]]
16 {{/info}}
17
18 == Details ==
19
20 === Supported Models ===
21
22 KLighDning leverages the transient views approach to synthesize diagrams for (purely textual) models. Our implementation [[KLighD >>doc:KIELER.Home.Lightweight Diagrams (KLighD).WebHome]]employs the notion of //diagram// //syntheses//, which basically are model transformations from an arbitrary source model format to the [[KGraph >>doc:Kieler.Discontinued Projects.Infrastructure for Meta Layout (KIML).KGraph Meta Model.WebHome]]format (structural description), where each graph element can be equipped with [[KRendering >>doc:KIELER.Home.Lightweight Diagrams (KLighD).The KRendering Notation Model.WebHome]]elements for styling. See the corresponding wiki pages for further information.
23
24 As part of the KIELER Project we currently support following diagram sytheses.
25
26 |=(((
27 Diagram Type
28 )))|=(((
29 Short ID
30 )))|=(((
31 Feature ID
32 )))
33 |(((
34 [[KGraph Text Format>>doc:KIELER.Home.KIELER Pragmatics.KGraph Text (KGT).WebHome]]
35 )))|(((
36 {{{kgraph}}}
37 )))|(((
38 {{{de.cau.cs.kieler.kgraph.feature.feature.group}}}
39 )))
40 |(((
41 [[Ptolemy's MoML>>doc:Kieler.Discontinued Projects.Ptolemy Browser.WebHome]]
42 )))|(((
43 {{{ptolemy}}}
44 )))|(((
45 {{{de.cau.cs.kieler.ptview.feature.feature.group}}}
46 )))
47 |(% colspan="1" %)(% colspan="1" %)
48 (((
49 Ecore Class Diagram
50 )))|(% colspan="1" %)(% colspan="1" %)
51 (((
52 {{{klighd.examples}}}
53 )))|(% colspan="1" %)(% colspan="1" %)
54 (((
55 {{{de.cau.cs.kieler.klighd.examples.feature.feature.group}}}
56 )))
57
58 === Transient Static Links ===
59
60 **Permanent links** are another facet of the documentation purpose. A user can browse a model to a point where he potentially finds a bug. In order to supplement the bug report a //PermaLink// can be retrieved that holds the current viewport and expansion status of the user. The link can be attached to the report and upon opening the link, the diagram is opened as specified by the link.
61
62 {{code title="PermaLink" language="bash"}}
63 http://[SERVER]/[MODEL_PATH]?perma=[EXPANSION]&transform=[VIEWPORT_MATRIX]
64 {{/code}}
65
66 === Collaboration ===
67
68 **Rooms** serve as a basis for collaboratively browsing a model. Users can join a common room in which all browsing activity, i.e., zooming, panning, expanding, is synchronized. One user can explain the model to another, or ask questions about certain details.
69
70
71
72 = Videos =
73
74 == Basic Functionality ==
75
76
77
78 {{multimedia att--filename="KlighDning_new.mp4"/}}
79
80 == Collaboration ==
81
82
83
84 {{multimedia att--filename="KlighDning_sync.mp4"/}}
85
86 == Examples ==
87
88 === Desktop Webbrowser ===
89
90 [[image:attach:ptolemy.png]]
91
92 === Smartphone ===
93
94 [[image:attach:mobile.png]]
95
96
97
98 == Quick Start ==
99
100 * Download a release or nightly build of the KLighDning product.
101 * Use the {{code language="none"}}install_kieler_features.sh{{/code}} or {{code language="none"}}install_features.sh{{/code}} script to add the desired diagram syntheses.
102 * Start the server using the {{code language="none"}}start.sh{{/code}} script.
103
104 Following a small exemplary deploy script for KLighDning is shown that downloads the current nightly build, extracts it, installs the {{code language="none"}}kgraph{{/code}} and {{code language="none"}}klighd.examples{{/code}} diagram syntheses, and starts the server.
105
106 {{code title="Exemplary Deploy Script for KLighDning" linenumbers="true" language="bash"}}
107 #!/bin/bash
108 #
109 # Deploy the KLighDning product and install some features
110 #
111
112 # location of the klighdning product
113 HOST="http://rtsys.informatik.uni-kiel.de"
114 SERVER_PATH="/~kieler/files/nightly/klighdning/"
115 PLATFORM="linux.gtk.x86_64"
116 FILE="klighdning_nightly_*-${PLATFORM}.zip"
117
118 # features to be installed into the klighdning instance
119 FEATURES="kgraph,klighd.examples"
120
121 # local models repository
122 MODELS_REPO="/home/layout/models"
123
124
125 echo "##################################"
126 echo "###### Deploying KLighDning ######"
127 echo ""
128 echo "Downloading ... "
129 echo " archive: ${FILE}"
130 echo " host: ${HOST}${SERVER_PATH}"
131
132 wget -r -nd -P tmp -A "$FILE" -I $SERVER_PATH "${HOST}${SERVER_PATH}" 2>/dev/null
133
134 echo "Unzipping ..."
135 cd tmp
136 unzip -q *.zip
137 cd ..
138 mv tmp/klighdning .
139 rm -rf tmp
140
141 echo "Make the scripts executable ..."
142 chmod u+x klighdning/*.sh
143
144 echo "Installing features ..."
145 cd klighdning
146 ./install_kieler_features.sh "$FEATURES"
147
148 echo "Starting KLighDning ..."
149 ./start.sh "$MODELS_REPO"
150
151 cd ..
152
153  
154 {{/code}}
155
156
157
158 === Example ===