Wiki source code of KIELER Pragmatics Release 2015/02
Last modified by Richard Kreissig on 2023/09/14 10:41
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = KIELER Pragmatics 2015/02 = | ||
| 2 | |||
| 3 | * [[Official Project Website>>url:http://www.informatik.uni-kiel.de/rtsys/kieler||shape="rect"]] | ||
| 4 | * Built on Eclipse 4.4 "Luna" | ||
| 5 | |||
| 6 | [[We are happy>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/kings_of_coding.mp3||shape="rect"]] to provide release 2015/02 of the **KIELER Pragmatics Project**! KIELER Pragmatics is a framework for enhanced user interaction in graphical modeling that builds on the Eclipse platform. This document describes how to install the release and highlights the most exciting new features. | ||
| 7 | |||
| 8 | As a bonus, we are co-releasing our KLighD-based **KIELER Ptolemy Browser**. | ||
| 9 | |||
| 10 | |||
| 11 | |||
| 12 | {{toc minLevel="2"/}} | ||
| 13 | |||
| 14 | == Installation == | ||
| 15 | |||
| 16 | KIELER Pragmatics 2015/02 is provided as a set of features, available to be added to your Eclipse installation via an update site. KIELER Pragmatics 2015/02 was tested on [[Eclipse 4.4 "Luna">>url:http://www.eclipse.org/downloads/||shape="rect"]], but may also be compatible with other versions of Eclipse. | ||
| 17 | |||
| 18 | * See the [[KIELER Downloads>>doc:KIELER.Overview.Downloads.WebHome]] site for download details. | ||
| 19 | * KIELER Pragmatics requires an installed Java Runtime Environment >= version 1.5. | ||
| 20 | * The layout components of KIELER can make use of the layout algorithms provided by the [[Graphviz>>url:http://www.graphviz.org/||rel="nofollow" shape="rect" class="external-link"]] library. You may want to install that. | ||
| 21 | |||
| 22 | Also refer to the [[KIELER Downloads>>doc:KIELER.Overview.Downloads.WebHome]] page to download the KIELER Ptolemy Browser and the KIELER Web Service. | ||
| 23 | |||
| 24 | == Release Notes == | ||
| 25 | |||
| 26 | You can find a list of solved tickets for this release at [[our issue tracking system>>url:http://rtsys.informatik.uni-kiel.de/jira/secure/ReleaseNote.jspa?projectId=10400&version=10802||shape="rect"]]. Release notes of older releases can be found at our [[doc:KIELER.Old Release Notes.WebHome]] page. | ||
| 27 | |||
| 28 | If you're wondering where components have gone that were traditionally a part of KIELER, you might not know yet that the KIELER was split into two separate projects, KIELER Pragmatics and KIELER Semantics, which release pretty much independently. | ||
| 29 | |||
| 30 | === API Changes in 2015/02 === | ||
| 31 | |||
| 32 | This is a summary of the API changes introduced with version 2015/02: | ||
| 33 | |||
| 34 | * [[KIELER Infrastructure for Meta Layout>>doc:KIELER.Discontinued Projects.Infrastructure for Meta Layout (KIML).WebHome]] | ||
| 35 | ** We reworked our support for the GML graph format. It is not based on Xtext anymore but on a dedicated internal format and lightweight parser and serializer. | ||
| 36 | Existing KLighD diagram syntheses can be migrated using the following 4 steps: | ||
| 37 | **1. Adapt the imports {{code language="none"}}de.cau.cs.kieler.kiml.formats.gml.gml.*{{/code}} to {{code language="none"}}de.cau.cs.kieler.kiml.formats.gml.*{{/code}}. Note that there are new subclasses {{code language="none"}}CollectionElement{{/code}}, {{code language="none"}}StringElement{{/code}}, {{code language="none"}}NumberElement{{/code}}. | ||
| 38 | **1. The root element changed from {{code language="none"}}de.cau.cs.kieler.kiml.formats.gml.gml.GmlModel {{/code}}to {{code language="none"}}de.cau.cs.kieler.kiml.formats.gml.GMLModel{{/code}} | ||
| 39 | **1. ((( | ||
| 40 | Add the following extension to your synthesis | ||
| 41 | |||
| 42 | {{code language="scala"}} | ||
| 43 | private def Iterable<Element> getElements(Element e) { | ||
| 44 | switch(e) { | ||
| 45 | CollectionElement: return (e as CollectionElement).getElements() | ||
| 46 | default: return Collections.emptyList | ||
| 47 | } | ||
| 48 | } | ||
| 49 | {{/code}} | ||
| 50 | ))) | ||
| 51 | **1. Change any call of the {{code language="none"}}getEContainer{{/code}} method to {{code language="none"}}getContainer{{/code}}. Note that in Xtend this might read {{code language="none"}}e.eContainer{{/code}} and should be changed to {{code language="none"}}e.container{{/code}} | ||
| 52 | |||
| 53 | === New Features Included in 2015/02 === | ||
| 54 | |||
| 55 | Here's a few highlights of what's new in version 2015/02: | ||
| 56 | |||
| 57 | * [[KIELER Layout Algorithms>>doc:KIELER.Discontinued Projects.Layout Algorithms (KLay).WebHome]] | ||
| 58 | ** KLay Layered now supports more than one label for any given port. | ||
| 59 | [[image:attach:multiple_port_labels.png]] | ||
| 60 | ** KLay Layered now supports separate node label placements for each node label. | ||
| 61 | [[image:attach:node_label_placement.png]] | ||
| 62 | ** KLay Layered can now place ports more flexibly through the layout options [[Port Alignment>>url:http://rtsys.informatik.uni-kiel.de/confluence/x/toFs#KIMLLayoutOptions-portAlignmentPortAlignment||shape="rect"]] and [[Additional Port Space>>url:http://rtsys.informatik.uni-kiel.de/confluence/x/toFs#KIMLLayoutOptions-addPortSpaceAdditionalPortSpace||shape="rect"]]. | ||
| 63 | [[image:attach:port_alignment.png]] | ||
| 64 | ** KLay Layered now features a new spline edge router. //This is still experimental code – use at your own risk!// | ||
| 65 | [[image:attach:splines.png]] | ||
| 66 | * [[KIELER Lightweight Diagrams>>doc:KIELER.Lightweight Diagrams (KLighD).WebHome]] | ||
| 67 | |||
| 68 | KIPRA-1545 | ||
| 69 | |||
| 70 | === Important Bugs Fixed in 2015/02 === | ||
| 71 | |||
| 72 | Among others, the following bugs were fixed in version 2015/02: | ||
| 73 | |||
| 74 | * [[KIELER Layout Algorithms>>doc:KIELER.Discontinued Projects.Layout Algorithms (KLay).WebHome]] | ||
| 75 | ** Under certain conditions, the Graphviz Layout Provider failed to find the Graphviz executables on Windows even though they were already in the Path. While fixing this, we also improved the automatic detection of the installation location of Graphviz executables on Windows. | ||
| 76 | ** Layout of hierarchical diagrams could lead to broken edge routing. | ||
| 77 | * [[KIELER Lightweight Diagrams>>doc:KIELER.Lightweight Diagrams (KLighD).WebHome]] | ||
| 78 | ** | ||
| 79 | ** | ||
| 80 | ** | ||
| 81 | ** | ||
| 82 | ** | ||
| 83 | ** KIPRA-1555 See the full list of [[related issues>>url:http://rtsys.informatik.uni-kiel.de/jira/issues/?jql=component%20%3D%20%22KLighD%20-%20Light-weight%20Diagrams%22%20and%20fixVersion%20%3D%20%22Next%20Release%22%20and%20status%20%3D%20Closed||shape="rect"]] | ||
| 84 | |||
| 85 | == Quickstart == | ||
| 86 | |||
| 87 | === Diagram Layout === | ||
| 88 | |||
| 89 | One of the core features of KIELER Pragmatics is the KIELER Infrastructure for Meta-Layout (KIML). It provides the glue between diagram editors and layout algorithms. If you have installed layout support for GMF editors, you may want to try the following: | ||
| 90 | |||
| 91 | * Open a diagram using a GMF editor. | ||
| 92 | * Press the Layout button in the toolbar: | ||
| 93 | * Open the //Layout View// by clicking //Window// -> //Show View// -> //Other...// and choosing //Layout// from the //KIELER Layout// category. | ||
| 94 | * Change some of the values and press the Layout button again. | ||
| 95 | |||
| 96 | === Viewing Ptolemy Models === | ||
| 97 | |||
| 98 | If you have a Ptolemy installation, try the following: | ||
| 99 | |||
| 100 | * Save a Ptolemy model as a {{code language="none"}}.moml{{/code}} file somewhere. | ||
| 101 | * ((( | ||
| 102 | Download and start our //[[Ptolemy Model Browser>>url:http://www.informatik.uni-kiel.de/rtsys/kieler/downloads/tools-and-libraries/||shape="rect"]]//. | ||
| 103 | ))) | ||
| 104 | * Open your moml file. | ||
| 105 | * Double-click actors that have further models inside them. Also double-click modal model states that have refinements. Use the sidebar on the right to influence how your model is displayed. | ||
| 106 | |||
| 107 | == Known Problems and Limitations == | ||
| 108 | |||
| 109 | * Starting with Mac OS X Mountain Lion, trying to start our software may give you an error message similar to this: | ||
| 110 | [[image:attach:security1.png]] | ||
| 111 | The solution is to open your system preferences and navigate to the //Security & Privacy// settings. Therein, either click on //Open Anyway// if available or change //Allow apps downloaded from// to //Anywhere//. | ||
| 112 | [[image:attach:security2.png]] | ||
| 113 | Starting our software will now result in the following message: | ||
| 114 | [[image:attach:security3.png]] | ||
| 115 | Simply click //Open// and you're good to go. | ||
| 116 | * Upon starting the Ptolemy Model Browser, you may get something like this: | ||
| 117 | [[image:attach:ptBrowserProblem.png]] | ||
| 118 | The solution is to exit the application, remove your existing workspace, and restart the Ptolemy Model Browser. Your workspace can be found in your home folder and is called {{code language="none"}}kielerPtolemyWs{{/code}}. | ||
| 119 | * The Ptolemy Model Browser can properly display only a limited set of actors. Other actors may look a lot different than they do in Ptolemy. | ||
| 120 | * Currently there is no full-blown user documentation integrated. See our [[doc:KIELER.Kieler]] for more information. | ||
| 121 | |||
| 122 | == Bug Reports, Comments == | ||
| 123 | |||
| 124 | We're working hard to make the graphical modeling user experience as convenient as possible. However, bugs can still remain in the code and some things might not be as you would expect them. Please don't hesitate to send in bug reports or give other comments like feature requests. | ||
| 125 | |||
| 126 | Send bug reports to kieler@…, please. For news or general questions subscribe to the [[rt-kieler mailing list>>url:https://lists.informatik.uni-kiel.de/mailman/listinfo/rt-kieler||rel="nofollow" shape="rect" class="external-link"]]. |