Wiki source code of Setup and Documentation

Version 2.3 by Soeren Domroes on 2023/07/11 10:04
Show last authors
1 {{layout}}
2 {{layout-section ac:type="single"}}
3 {{layout-cell}}
4 First step is to set up an Eclipe to develop KIELER and the KEITH Language Server in. You might need both to test all features on both platforms.
5
6 If you find anything in the Setup guides that seems unclear or is wrong feel free to contact us.
7 {{/layout-cell}}
8 {{/layout-section}}
9
10 {{layout-section ac:type="two_equal"}}
11 {{layout-cell}}
12 == Set up KIELER development Eclipse ==
13
14 Follow the [[doc:KIELER.Getting Eclipse]] guide and select KIELER semantics **and** KIELER pragmatics.
15
16 \\
17
18 \\
19 {{/layout-cell}}
20
21 {{layout-cell}}
22 == Set up KEITH development Eclipse ==
23
24 \\
25
26 Follow the [[doc:KIELER.Running KEITH]] guide and select only KIELER semantics (you don't need ELK). Be sure to select the **keith** stream.
27
28 Follow the guide to set up an Eclipse to develop the language server and set up Keith.
29
30 {{info}}
31 KEITH does not work on Mac yet. If you only have a Mac you are only able to develop for KIELER.
32 {{/info}}
33 {{/layout-cell}}
34 {{/layout-section}}
35
36 {{layout-section ac:type="single"}}
37 {{layout-cell}}
38 == Repositories that you might need ==
39
40 (% class="relative-table wrapped" style="width: 99.6007%;" %)
41 |=(((
42 Repo
43 )))|=(((
44 Location
45 )))|=(((
46 Contents
47 )))
48 |(((
49 KIELER Semantics
50 )))|(((
51 [[https:~~/~~/git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/semantics/browse>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/semantics/browse||shape="rect"]]
52 )))|(((
53 Languages such as SCCharts, Esterel, Lustre as well as compilation and simulation tools as well as the semantic language server for KEITH. In here is the AdaptiveZoom class.
54
55 You might not want to change much in there. It is mostly to show what approaches already exist.
56 )))
57 |(((
58 KIELER Pragmatics
59 )))|(((
60 [[https:~~/~~/git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse||shape="rect"]]
61 )))|(((
62 The KGraph synthesis.
63 )))
64 |(((
65 KlighD
66 )))|(((
67 [[https:~~/~~/github.com/kieler/KLighD>>url:https://github.com/kieler/KLighD||shape="rect"]]
68 )))|(((
69 The KGraph language, the pragmatics language server, and the KIELER lightweight diagram framework.
70 )))
71 |(% colspan="1" %)(% colspan="1" %)
72 (((
73 KEITH
74 )))|(% colspan="1" %)(% colspan="1" %)
75 (((
76 [[https:~~/~~/git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]
77 )))|(% colspan="1" %)(% colspan="1" %)
78 (((
79 Typescript client that connects to the language server. Renders diagram via Sprotty.
80 )))
81 {{/layout-cell}}
82 {{/layout-section}}
83
84 {{layout-section ac:type="single"}}
85 {{layout-cell}}
86 == Theia Documentation ==
87
88 [[https:~~/~~/github.com/eclipse-theia/theia/blob/master/doc/Developing.md>>url:https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md||shape="rect"]]
89 {{/layout-cell}}
90 {{/layout-section}}
91
92 {{layout-section ac:type="single"}}
93 {{layout-cell}}
94 == General Idea of a Language Server ==
95
96 [[https:~~/~~/microsoft.github.io/language-server-protocol/overviews/lsp/overview/>>url:https://microsoft.github.io/language-server-protocol/overviews/lsp/overview/||shape="rect"]]
97 {{/layout-cell}}
98 {{/layout-section}}
99
100 {{layout-section ac:type="single"}}
101 {{layout-cell}}
102 == Our diagram server ==
103
104 [[https:~~/~~/github.com/eclipse/sprotty/wiki/Client-Server-Protocol>>url:https://github.com/eclipse/sprotty/wiki/Client-Server-Protocol||shape="rect"]]
105
106 [[https:~~/~~/github.com/eclipse/sprotty/wiki/Architectural-Overview>>url:https://github.com/eclipse/sprotty/wiki/Architectural-Overview||shape="rect"]]
107 {{/layout-cell}}
108 {{/layout-section}}
109
110 {{layout-section ac:type="single"}}
111 {{layout-cell}}
112 == Ticket Management ==
113
114 If you encounter any problems in KIELER, KEITH, or somewhere else in the used technology feel free to make a ticket in our [[Jira>>url:https://rtsys.informatik.uni-kiel.de/jira/secure/Dashboard.jspa||shape="rect"]] (or an issue in Github for Klighd).
115
116 Make sure to label your issue appropriately and add the right components to it. Otherwise we might not see it or people not responsible for it get assigned a ticket.
117
118 \\
119 {{/layout-cell}}
120 {{/layout-section}}
121 {{/layout}}

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage