KIELER Pragmatics Release 2014/10

1

= KIELER Pragmatics 2014/10 =

2

3

* [[Official Project Website>>url:http://www.informatik.uni-kiel.de/rtsys/kieler||shape="rect"]]

4

* Built on Eclipse 4.3 "Kepler"

5

6

[[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.

7

8

As a bonus, we are co-releasing our KLighD-based **KIELER Ptolemy Browser**.

== Installation ==

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.

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.

== Release Notes ==

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=10701||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 2014/10 ===

31

32

This is a summary of the API changes introduced with version 2014/10:

33

34

* Core Changes

35

** {{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

36

* [[KIELER Lightweight Diagrams>>doc:KIELER.Lightweight Diagrams (KLighD).WebHome]]

37

** 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)

38

** {{code language="none"}}IViewer{{/code}} provides {{code language="none"}}getZoomLevel(){{/code}}

39

** {{code language="none"}}IViewer{{/code}} provides methods for registering {{code language="none"}}IViewChangeListener{{/code}}s

40

** {{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

41

** Introduced {{code language="none"}}IKlighdSelection{{/code}} interface abstracting {{code language="none"}}KlighdTreeSelection{{/code}} and {{code language="none"}}KlighdTextSelection{{/code}}

42

** Updated {{code language="none"}}layoutDiagram(...){{/code}} methods in {{code language="none"}}LightDiagramServices{{/code}}

43

44

=== New Features Included in 2014/10 ===

45

46

Here's a few highlights of what's new in version 2014/10:

47

48

* [[KIELER Lightweight Diagrams>>doc:KIELER.Lightweight Diagrams (KLighD).WebHome]]

49

** (% 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)

50

** (% style="line-height: 1.4285715;" %)Enabled the contribution of action invocation buttons (execution of {{code language="none"}}IActions{{/code}}) in the diagram side bar (so far actions could only be executed by clicking on a diagram element of via menu contributions), see related hook in {{code language="none"}}AbstractDiagramSynthesis{{/code}}

51

** Added {{code language="none"}}editable{{/code}} flag to {{code language="none"}}KText{{/code}} in order to distinguish //cursor selectability// and //editability//

52

** 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}}

53

** 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}}

54

** Diagram image export now supports tiled exports enabling the export of huge diagrams, which may be prevented by memory limitations in the past

55

** Contributed appropriate print support and (customizable) print dialog with preview

56

** 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

57

** 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

58

** Added zoom style {{code language="none"}}ZOOM_TO_ACTUAL_SIZE{{/code}}, added corresponding configuration methods in {{code language="none"}}IAction.ActionResult{{/code}}

59

** Added switch in {{code language="none"}}KlighdSynthesisProperties{{/code}} to deactivate minimal diagram figure size estimation in case size data are already available

60

* [[KGraph Text>>doc:KIELER.KIELER Pragmatics.KGraph Text (KGT).WebHome]]

61

** A new option {{code language="none"}}de.cau.cs.kieler.kgraphsynthesis.defaults{{/code}} can enable default values for element sizes and labels to make KGT files more compact.

62

63

=== Important Bugs Fixed in 2014/10 ===

64

65

Among others, the following bugs were fixed in version 2014/10:

66

67

* [[KIELER Layout Algorithms>>doc:KIELER.Discontinued Projects.Layout Algorithms (KLay).WebHome]]

68

** In KLay Layered, the polyline edge router could produce results where edges overlapped nodes.

69

** In KLay Layered, the polyline edge router could produce weird results when more than one edge leaves a given port.

== Quickstart ==

=== Diagram Layout ===

74

75

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:

76

77

* Open a diagram using a GMF editor.

78

* Press the Layout button in the toolbar:[[image:attach:kieler-arrange.gif]]

79

* Open the //Layout View// by clicking //Window// -> //Show View// -> //Other...// and choosing //Layout// from the //KIELER Layout// category.

80

* Change some of the values and press the Layout button again.

81

82

=== Viewing Ptolemy Models ===

83

84

If you have a Ptolemy installation, try the following:

85

86

* Save a Ptolemy model as a {{code language="none"}}.moml{{/code}} file somewhere.

87

* (((

88

Download and start our //[[Ptolemy Model Browser>>url:http://www.informatik.uni-kiel.de/rtsys/kieler/downloads/tools-and-libraries/||shape="rect"]]//.

89

)))

90

* Open your moml file.

91

* 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.

92

93

== Known Problems and Limitations ==

94

95

* Starting with Mac OS X Mountain Lion, trying to start our software may give you an error message similar to this:

96

[[image:attach:security1.png]]

97

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//.

98

[[image:attach:security2.png]]

99

Starting our software will now result in the following message:

100

[[image:attach:security3.png]]

101

Simply click //Open// and you're good to go.

102

* Upon starting the Ptolemy Model Browser, you may get something like this:

103

[[image:attach:ptBrowserProblem.png]]

104

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}}.

105

* 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.

106

* Currently there is no full-blown user documentation integrated. See our [[doc:KIELER.Kieler]] for more information.

107

108

== Bug Reports, Comments ==

109

110

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.

111

112

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"]].

Wiki source code of KIELER Pragmatics Release 2014/10

Navigation

Quick Links