Wiki source code of KIELER Pragmatics Release 2014/10
Version 9.1 by chsch on 2014/10/02 14:42
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
1.1 | 1 | {{warning title="Warning"}} |
| 2 | Pragmatics 2014-10 hasn't been released yet. These release notes are preliminary! | ||
| 3 | {{/warning}} | ||
| 4 | |||
| 5 | |||
| 6 | |||
| 7 | = KIELER Pragmatics 2014/10 = | ||
| 8 | |||
| 9 | * [[Official Project Website>>url:http://www.informatik.uni-kiel.de/rtsys/kieler||shape="rect"]] | ||
| 10 | * Built on Eclipse 4.3 "Kepler" | ||
| 11 | |||
| 12 | [[We are happy>>url:http://trololololololololololo.com/||rel="nofollow" shape="rect" class="external-link"]] to provide release 2014/10 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. | ||
| 13 | |||
| 14 | As a bonus, we are co-releasing our KLighD-based **KIELER Ptolemy Browser**. | ||
| 15 | |||
| 16 | |||
| 17 | |||
| 18 | {{toc minLevel="2"/}} | ||
| 19 | |||
| 20 | == Installation == | ||
| 21 | |||
| |
3.1 | 22 | KIELER Pragmatics 2014/10 is provided as a set of features, available to be added to your Eclipse installation via an update site. KIELER Pragmatics 2014/10 was tested on [[Eclipse 4.3 "Kepler">>url:http://www.eclipse.org/downloads/||shape="rect"]], but may also be compatible with other versions of Eclipse. |
| |
1.1 | 23 | |
| |
3.1 | 24 | * See the [[KIELER Downloads>>doc:Downloads]] site for download details. |
| |
1.1 | 25 | * KIELER Pragmatics requires an installed Java Runtime Environment >= version 1.5. |
| 26 | * 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. | ||
| 27 | |||
| |
3.1 | 28 | Also refer to the [[KIELER Downloads>>doc:Downloads]] page to download the KIELER Ptolemy Browser and the KIELER Web Service. |
| |
1.1 | 29 | |
| 30 | == Release Notes == | ||
| 31 | |||
| |
3.1 | 32 | {{warning}} |
| 33 | Write a summary of the release notes | ||
| 34 | {{/warning}} | ||
| |
1.1 | 35 | |
| |
3.1 | 36 | |
| 37 | |||
| |
1.1 | 38 | 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. |
| 39 | |||
| |
3.1 | 40 | === API Changes in 2014/10 === |
| |
1.1 | 41 | |
| |
3.1 | 42 | This is a summary of the API changes introduced with version 2014/10: |
| |
1.1 | 43 | |
| 44 | * [[KIELER Lightweight Diagrams>>doc:Lightweight Diagrams (KLighD)]] | ||
| |
9.1 | 45 | ** Added {{code language="none"}}DiagramSyntheses{{/code}} class providing lots of convenience methods for configuring the view model in diagram synthesis implementations (preliminary version introduced with last previous release) |
| |
8.1 | 46 | ** {{code language="none"}}IViewer{{/code}} provides {{code language="none"}}getZoomLevel(){{/code}} |
| |
5.1 | 47 | ** {{code language="none"}}IPropertyHolder{{/code}}'s {{code language="none"}}setProperty(...) {{/code}}and {{code language="none"}}copyProperties(...){{/code}} now return {{code language="none"}}IPropertyHolder{{/code}} instead of {{code language="none"}}void{{/code}}, implementations are supposed to return {{code language="none"}}this{{/code}} for convenience |
| 48 | ** {{code language="none"}}IUpdateStrategy{{/code}} now requires the method {{code language="none"}}requiresDiagramSynthesisReRun(...){{/code}} that allows to tell KLighD's runtime whether a new synthesis run is required for performing a (certain) diagram update | ||
| 49 | ** Introduced {{code language="none"}}IKlighdSelection{{/code}} interface | ||
| 50 | ** Updated {{code language="none"}}layoutDiagram(...){{/code}} methods in {{code language="none"}}LightDiagramServices{{/code}} | ||
| |
3.1 | 51 | * [[KIELER Infrastructure for Meta-Layout>>doc:Infrastructure for Meta Layout (KIML)]] |
| |
1.1 | 52 | |
| |
3.1 | 53 | === New Features Included in 2014/10 === |
| |
1.1 | 54 | |
| |
3.1 | 55 | Here's a few highlights of what's new in version 2014/10: |
| |
1.1 | 56 | |
| 57 | * [[KIELER Lightweight Diagrams>>doc:Lightweight Diagrams (KLighD)]] | ||
| |
9.1 | 58 | ** (% style="line-height: 1.4285715;" %)Improved integration of the //magnifying lens// (hit {{code language="none"}}alt + ctrl/cmd){{/code}} and //rubber band zoom //(press {{code language="none"}}ctrl/cmd{{/code}} and drag on canvas) |
| |
7.1 | 59 | ** Enabled the zoom level-based visibility of diagram elements (nodes, ports, edges, labels) and figure elements (fine grained figure details, texts, ...), see {{code language="none"}}setUpperVisibilityScaleBound{{/code}} & {{code language="none"}}setLowerVisibilityScaleBound {{/code}}methods in {{code language="none"}}DiagramSyntheses{{/code}} |
| 60 | ** Enabled output-dependent visibility (main diagram, outline, printout, image export) of figure elements (highlightings, fine grained figure details, texts, ...), see corresponding methods in {{code language="none"}}DiagramSyntheses{{/code}} | ||
| |
5.1 | 61 | ** Diagram image export now supports tiled exports enabling the export of huge diagrams, which may be prevented by memory limitations in the past |
| 62 | ** Contributed appropriate print support and (customizable) print dialog with preview | ||
| |
8.1 | 63 | ** Contributed a customized SVG image exporter based on FreeHEP ([[http:~~/~~/freehep.github.io/freehep-vectorgraphics/>>url:http://freehep.github.io/freehep-vectorgraphics/||shape="rect"]]) being able to attach semantic data to the image data |
| |
5.1 | 64 | ** Contributed generic {{code language="none"}}PortRotationModifier{{/code}} (style modifier) that realizes the rotation of port figures in case ports are moved to a different side by the automatic layout computation |
| |
8.1 | 65 | ** Added zoom style ZOOM_TO_ACTUAL_SIZE, added corresponding configuration methods in {{code language="none"}}IAction.ActionResult{{/code}} |
| 66 | ** Added switch in {{code language="none"}}KlighdSynthesisProperties{{/code}} to deactivate minimal diagram figure size estimation in case size data are already available | ||
| |
3.1 | 67 | * [[KIELER Infrastructure for Meta-Layout>>doc:Infrastructure for Meta Layout (KIML)]] |
| |
1.1 | 68 | * [[KIELER Layout Algorithms>>doc:Layout Algorithms (KLay)]] |
| 69 | * [[KGraph Text>>doc:KGraph Text (KGT)]] | ||
| 70 | |||
| |
4.1 | 71 | === Important Bugs Fixed in 2014/10 === |
| 72 | |||
| 73 | Among others, the following bugs were fixed in version 2014/10: | ||
| 74 | |||
| 75 | * [[KIELER Layout Algorithms>>doc:Layout Algorithms (KLay)]] | ||
| 76 | ** In KLay Layered, the polyline edge router could produce results where edges overlapped nodes. | ||
| 77 | ** In KLay Layered, the polyline edge router could produce weird results when more than one edge leaves a given port. | ||
| 78 | |||
| |
1.1 | 79 | == Quickstart == |
| 80 | |||
| 81 | === Diagram Layout === | ||
| 82 | |||
| 83 | 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: | ||
| 84 | |||
| 85 | * Open a diagram using a GMF editor. | ||
| 86 | * Press the Layout button in the toolbar:[[image:attach:kieler-arrange.gif]] | ||
| 87 | * Open the //Layout View// by clicking //Window// -> //Show View// -> //Other...// and choosing //Layout// from the //KIELER Layout// category. | ||
| 88 | * Change some of the values and press the Layout button again. | ||
| 89 | |||
| 90 | === Viewing Ptolemy Models === | ||
| 91 | |||
| 92 | If you have a Ptolemy installation, try the following: | ||
| 93 | |||
| 94 | * Save a Ptolemy model as a {{code language="none"}}.moml{{/code}} file somewhere. | ||
| 95 | * ((( | ||
| 96 | Download and start our //[[Ptolemy Model Browser>>url:http://www.informatik.uni-kiel.de/rtsys/kieler/downloads/tools-and-libraries/||shape="rect"]]//. | ||
| 97 | |||
| 98 | {{tip title="Note for Mac OS Users"}} | ||
| 99 | Starting with Mac OS X Mountain Lion, trying to start the Ptolemy Model Browser may give you the following error message: | ||
| 100 | |||
| 101 | [[image:attach:damaged_error.png]] | ||
| 102 | |||
| 103 | The problem is not that our application file is damaged in any way. Much rather, we have not invested the money to obtain a proper developer certificate with which this error would not be generated. The solution is to open your system preferences and navigate to the //Security & Privacy// settings. Therein, make sure to set //Allow apps downloaded from// to //Anywhere//: | ||
| 104 | |||
| 105 | [[image:attach:security_preferences.png]] | ||
| 106 | |||
| 107 | Start the Ptolemy Browser again. This will result in the following warning: | ||
| 108 | |||
| 109 | [[image:attach:untrusted_error.png]] | ||
| 110 | |||
| 111 | Simple click "Open" and you're good to go at last. | ||
| 112 | {{/tip}} | ||
| 113 | ))) | ||
| 114 | * Open your moml file. | ||
| 115 | * 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. | ||
| 116 | |||
| 117 | == Known Problems and Limitations == | ||
| 118 | |||
| 119 | * The Ptolemy Model Viewer 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.WebHome]] 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"]]. |