Wiki source code of Setup and Documentation
Last modified by Richard Kreissig on 2025/01/30 12:20
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 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. | ||
| 2 | |||
| 3 | If you find anything in the Setup guides that seems unclear or is wrong feel free to contact us. | ||
| 4 | |||
| 5 | |||
| 6 | == Set up KIELER development Eclipse == | ||
| 7 | |||
| 8 | Follow the [[doc:KIELER.Getting Eclipse]] guide and select KIELER semantics **and** KIELER pragmatics. | ||
| 9 | |||
| 10 | |||
| 11 | |||
| 12 | == Set up KEITH development Eclipse == | ||
| 13 | |||
| 14 | |||
| 15 | Follow the [[doc:KIELER.Running KEITH]] guide and select only KIELER semantics (you don't need ELK). Be sure to select the **keith** stream. | ||
| 16 | |||
| 17 | Follow the guide to set up an Eclipse to develop the language server and set up Keith. | ||
| 18 | |||
| 19 | {{info}} | ||
| 20 | KEITH does not work on Mac yet. If you only have a Mac you are only able to develop for KIELER. | ||
| 21 | {{/info}} | ||
| 22 | |||
| 23 | |||
| 24 | == Repositories that you might need == | ||
| 25 | |||
| 26 | (% class="relative-table wrapped" style="width:99.6007%" %) | ||
| 27 | |=((( | ||
| 28 | Repo | ||
| 29 | )))|=((( | ||
| 30 | Location | ||
| 31 | )))|=((( | ||
| 32 | Contents | ||
| 33 | ))) | ||
| 34 | |((( | ||
| 35 | KIELER Semantics | ||
| 36 | )))|((( | ||
| 37 | [[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"]] | ||
| 38 | )))|((( | ||
| 39 | 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. | ||
| 40 | |||
| 41 | You might not want to change much in there. It is mostly to show what approaches already exist. | ||
| 42 | ))) | ||
| 43 | |((( | ||
| 44 | KIELER Pragmatics | ||
| 45 | )))|((( | ||
| 46 | [[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"]] | ||
| 47 | )))|((( | ||
| 48 | The KGraph synthesis. | ||
| 49 | ))) | ||
| 50 | |((( | ||
| 51 | KlighD | ||
| 52 | )))|((( | ||
| 53 | [[https:~~/~~/github.com/kieler/KLighD>>url:https://github.com/kieler/KLighD||shape="rect"]] | ||
| 54 | )))|((( | ||
| 55 | The KGraph language, the pragmatics language server, and the KIELER lightweight diagram framework. | ||
| 56 | ))) | ||
| 57 | |(% colspan="1" %)(% colspan="1" %) | ||
| 58 | ((( | ||
| 59 | KEITH | ||
| 60 | )))|(% colspan="1" %)(% colspan="1" %) | ||
| 61 | ((( | ||
| 62 | [[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"]] | ||
| 63 | )))|(% colspan="1" %)(% colspan="1" %) | ||
| 64 | ((( | ||
| 65 | Typescript client that connects to the language server. Renders diagram via Sprotty. | ||
| 66 | ))) | ||
| 67 | |||
| 68 | |||
| 69 | == Theia Documentation == | ||
| 70 | |||
| 71 | [[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"]] | ||
| 72 | |||
| 73 | |||
| 74 | == General Idea of a Language Server == | ||
| 75 | |||
| 76 | [[https:~~/~~/microsoft.github.io/language-server-protocol/overviews/lsp/overview/>>url:https://microsoft.github.io/language-server-protocol/overviews/lsp/overview/||shape="rect"]] | ||
| 77 | |||
| 78 | |||
| 79 | == Our diagram server == | ||
| 80 | |||
| 81 | [[https:~~/~~/github.com/eclipse/sprotty/wiki/Client-Server-Protocol>>url:https://github.com/eclipse/sprotty/wiki/Client-Server-Protocol||shape="rect"]] | ||
| 82 | |||
| 83 | [[https:~~/~~/github.com/eclipse/sprotty/wiki/Architectural-Overview>>url:https://github.com/eclipse/sprotty/wiki/Architectural-Overview||shape="rect"]] | ||
| 84 | |||
| 85 | |||
| 86 | == Ticket Management == | ||
| 87 | |||
| 88 | 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). | ||
| 89 | |||
| 90 | 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. | ||
| 91 | |||
| 92 |