Summary

• Page properties (1 modified, 0 added, 0 removed)
• Objects (1 modified, 0 added, 0 removed)
  • Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

...	...	@@ -1,7 +1,7 @@
1	1	{{panel title="Project Overview" borderStyle="dashed"}}
2	2	Responsible:
3	3
4		-* {{mention reference="XWiki.uru" style="FULL_NAME" anchor="XWiki-uru-GbKoy"/}}
	4	+* {{mention reference="XWiki.uru" style="FULL_NAME" anchor="XWiki-uru-jbWGz"/}}
5	5
6	6	Demo Videos:
7	7
...	...	@@ -50,25 +50,19 @@
50	50	(((
51	51	{{{de.cau.cs.kieler.klighd.examples.feature.feature.group}}}
52	52	)))
53		-|(% colspan="1" %)(% colspan="1" %)
54		-(((
55		-[[SC Language>>doc:The SC Language (SCL)]]
56		-)))|(% colspan="1" %)(% colspan="1" %)
57		-(((
58		-{{{sccharts}}}
59		-)))|(% colspan="1" %)(% colspan="1" %)
60		-(((
61		-{{{de.cau.cs.kieler.sccharts.feature.feature.group}}}
62		-)))
63	63
64		-=== PermaLinks ===
	54	+=== Transient Static Links ===
65	65
66		-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.
	56	+**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.
67	67
68	68	{{code title="PermaLink" language="bash"}}
69	69	http://[SERVER]/[MODEL_PATH]?perma=[EXPANSION]&transform=[VIEWPORT_MATRIX]
70	70	{{/code}}
71	71
	62	+=== Collaboration ===
	63	+
	64	+**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.
	65	+
72	72
73	73
74	74	== Examples ==
...	...	@@ -85,4 +85,62 @@
85	85
86	86	== Quick Start ==
87	87
88		-TODO
	82	+* Download a release or nightly build of the KLighDning product.
	83	+* 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.
	84	+* Start the server using the {{code language="none"}}start.sh{{/code}} script.
	85	+
	86	+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.
	87	+
	88	+{{code title="Exemplary Deploy Script for KLighDning" linenumbers="true" language="bash"}}
	89	+#!/bin/bash
	90	+#
	91	+# Deploy the KLighDning product and install some features
	92	+#
	93	+
	94	+# location of the klighdning product
	95	+HOST="http://rtsys.informatik.uni-kiel.de"
	96	+SERVER_PATH="/~kieler/files/nightly/klighdning/"
	97	+PLATFORM="linux.gtk.x86_64"
	98	+FILE="klighdning_nightly_*-${PLATFORM}.zip"
	99	+
	100	+# features to be installed into the klighdning instance
	101	+FEATURES="kgraph,klighd.examples"
	102	+
	103	+# local models repository
	104	+MODELS_REPO="/home/layout/models"
	105	+
	106	+
	107	+echo "##################################"
	108	+echo "###### Deploying KLighDning ######"
	109	+echo ""
	110	+echo "Downloading ... "
	111	+echo " archive: ${FILE}"
	112	+echo " host: ${HOST}${SERVER_PATH}"
	113	+
	114	+wget -r -nd -P tmp -A "$FILE" -I $SERVER_PATH "${HOST}${SERVER_PATH}" 2>/dev/null
	115	+
	116	+echo "Unzipping ..."
	117	+cd tmp
	118	+unzip -q *.zip
	119	+cd ..
	120	+mv tmp/klighdning .
	121	+rm -rf tmp
	122	+
	123	+echo "Make the scripts executable ..."
	124	+chmod u+x klighdning/*.sh
	125	+
	126	+echo "Installing features ..."
	127	+cd klighdning
	128	+./install_kieler_features.sh "$FEATURES"
	129	+
	130	+echo "Starting KLighDning ..."
	131	+./start.sh "$MODELS_REPO"
	132	+
	133	+cd ..
	134	+
	135	+
	136	+{{/code}}
	137	+
	138	+
	139	+
	140	+=== Example ===

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-8323108
	1	+8650794

URL

...	...	@@ -1,1 +1,1 @@
1		-https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/8323108/Online Model Browsing (KLighDning)
	1	+https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/8650794/Online Model Browsing (KLighDning)