Wiki source code of KLighD old Minimal Example HowTo
Last modified by Niklas Rentz on 2023/09/12 13:04
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{info}} | ||
| 2 | These examples were created and tested under KIELER Pragmatics 0.10.0. | ||
| 3 | {{/info}} | ||
| 4 | |||
| 5 | |||
| 6 | |||
| 7 | These instructions should guide you if you'd like to try out using KLighD for visualizing your own models or data structures. | ||
| 8 | |||
| 9 | == Two Examples == | ||
| 10 | |||
| 11 | We provide two minimal step-by-step examples: | ||
| 12 | |||
| 13 | |=((( | ||
| 14 | ====== [[image:attach:klighd-minimal-example.png]] ====== | ||
| 15 | |||
| 16 | (% style="text-align: center;" %) | ||
| 17 | [[(1) Minimal Example (Java Model)>>doc:KIELER.Discontinued Projects.KLighD old Minimal Example HowTo.Minimal Example (Java Model).WebHome]] | ||
| 18 | |||
| 19 | (% style="text-align: center;" %) | ||
| 20 | demonstrates a KLighD visualization of a trivial | ||
| 21 | (% style="color: rgb(0,128,0);" %)Java data(%%) (% style="color: rgb(0,128,0);" %)structure | ||
| 22 | )))|=((( | ||
| 23 | [[image:attach:myxtextdata.png]] | ||
| 24 | |||
| 25 | (% style="text-align: center;" %) | ||
| 26 | |||
| 27 | |||
| 28 | |||
| 29 | |||
| 30 | |||
| 31 | |||
| 32 | |||
| 33 | |||
| 34 | |||
| 35 | |||
| 36 | [[(2) Minimal Example (Xtext Model)>>doc:KIELER.Discontinued Projects.KLighD old Minimal Example HowTo.Minimal Example (Xtext Model).WebHome]] | ||
| 37 | |||
| 38 | (% style="text-align: center;" %) | ||
| 39 | demonstrates a KLighD visualization of a trivial | ||
| 40 | (% style="color: rgb(0,128,0);" %)Xtext model | ||
| 41 | ))) | ||
| 42 | |||
| 43 | Both examples require an Eclipse Kepler Modeling setup with the KLighD framework installed. Please follow the instruction below in order to setup an Eclipse suitable to run the examples. It is suggested to start with a fresh copy of Eclipse. You can install both examples in the same workspace and run them together, or, if you are only interested in one of them, you can choose to install only one of the examples in your workspace. | ||
| 44 | |||
| 45 | |||
| 46 | |||
| 47 | == Eclipse Installation (pre-requirement) == | ||
| 48 | |||
| 49 | In order to get these examples working, you need an Eclipse installation according to the following instructions: | ||
| 50 | |||
| 51 | 1. Download Eclipse Kepler (Modeling Edition): | ||
| 52 | Windows x64: [[http:~~/~~/www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/kepler/SR1/eclipse-modeling-kepler-SR1-win32-x86_64.zip&mirror_id=546>>url:http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/kepler/SR1/eclipse-modeling-kepler-SR1-win32-x86_64.zip&mirror_id=546||shape="rect"]] | ||
| 53 | Mac x64: [[http:~~/~~/www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/kepler/SR1/eclipse-modeling-kepler-SR1-macosx-cocoa-x86_64.tar.gz>>url:http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/kepler/SR1/eclipse-modeling-kepler-SR1-macosx-cocoa-x86_64.tar.gz||shape="rect"]] | ||
| 54 | Other: [[http:~~/~~/www.eclipse.org/downloads/packages/eclipse-modeling-tools/keplersr1>>url:http://www.eclipse.org/downloads/packages/eclipse-modeling-tools/keplersr1||shape="rect"]] | ||
| 55 | 1. Start Eclipse. | ||
| 56 | 1. Add the KIELER Pragmatics release 0.10.0 update site to your Eclipse (Help -> Install New Software ... -> Add)[[:>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/updatesite/||shape="rect"]][[http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~kieler/updatesite/release_pragmatics_0.10.0/>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/updatesite/release_pragmatics_0.10.0/||shape="rect"]] | ||
| 57 | 1. Select | ||
| 58 | [x] Layout, | ||
| 59 | [x] Lightweight Diagrams, and | ||
| 60 | [x] Sources | ||
| 61 | to be installed into your Eclipse. You may need to re-start Eclipse after finishing the installation process. Note that you may be asked to review installation process where kieler.ptolemy features are opt out. You can safely accept these proposed changes as this feature is not mandatory in order to properly run the examples. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | == Run-Configuration == | ||
| 66 | |||
| 67 | When you have setup the examples as explained in the sub-pages, you finally want to run the examples. You need to setup a run-configuration to do so. You can run both examples using the same run-configuration. | ||
| 68 | |||
| 69 | 1. Click on Run -> Run Configurations ... | ||
| 70 | 1. Right click on Eclipse Applications and then click on New | ||
| 71 | 1. Give the run-configuration a proper name, e.g. KLighD Example | ||
| 72 | 1. ((( | ||
| 73 | In the Arguments tab, set the **VM arguments** to: | ||
| 74 | |||
| 75 | {{code}} | ||
| 76 | -Dosgi.requiredJavaVersion=1.5 -Dhelp.lucene.tokenizer=standard -Xms80m -Xmx1048m -Xss2048k -XX:MaxPermSize=196m | ||
| 77 | {{/code}} | ||
| 78 | ))) | ||
| 79 | 1. Finally, click on Apply, then click Run to start the example. |