| ... |
... |
@@ -13,54 +13,78 @@ |
| 13 |
13 |
|
| 14 |
14 |
As a bonus, we are co-releasing our KLighD-based **KIELER Ptolemy Browser**. |
| 15 |
15 |
|
|
16 |
+{{info title="What's with the new version numbering scheme?"}} |
|
17 |
+Instead of naming this release //KIELER Pragmatics 0.12.0//, we decided to name it //KIELER Pragmatics 2014/05//. This way, people immediately see when this version was released. Also, since the plug-ins and features carry a timestamp, people can immediately see which release a particular plug-in or feature belongs to. All hail to clarity! |
|
18 |
+{{/info}} |
| 16 |
16 |
|
|
20 |
+ |
| 17 |
17 |
|
|
22 |
+ |
|
23 |
+ |
| 18 |
18 |
{{toc minLevel="2"/}} |
| 19 |
19 |
|
| 20 |
20 |
== Installation == |
| 21 |
21 |
|
| 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. |
|
28 |
+KIELER Pragmatics 2014/05 is provided as a set of features, available to be added to your Eclipse installation via an update site. KIELER Pragmatics 2014/05 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. |
| 23 |
23 |
|
| 24 |
|
-* See the [[KIELER Downloads>>doc:Downloads]] site for download details. |
|
30 |
+* See the [[KIELER Downloads>>url:http://www.informatik.uni-kiel.de/rtsys/kieler/downloads/||shape="rect"]] site for download details. |
| 25 |
25 |
* KIELER Pragmatics requires an installed Java Runtime Environment >= version 1.5. |
| 26 |
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 |
27 |
|
| 28 |
|
-Also refer to the [[KIELER Downloads>>doc:Downloads]] page to download the KIELER Ptolemy Browser and the KIELER Web Service. |
|
34 |
+See the [[KIELER Tools and Libraries>>url:http://www.informatik.uni-kiel.de/rtsys/kieler/downloads/tools-and-libraries/||shape="rect"]] page to download the KIELER Ptolemy Browser and the KIELER Web Service. |
| 29 |
29 |
|
| 30 |
30 |
== Release Notes == |
| 31 |
31 |
|
| 32 |
|
-{{warning}} |
| 33 |
|
-Write a summary of the release notes |
| 34 |
|
-{{/warning}} |
|
38 |
+The 2014/05 release of KIELER Pragmatics continues our efforts to redesign our core APIs, KIML and KLighD. **It includes a number of API-breaking changes, so beware of upgrading to this release if you currently do not have time to adapt your code accordingly.** 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=10700||shape="rect"]]. Release notes of older releases can be found at our [[doc:Release Notes]] page. |
| 35 |
35 |
|
| 36 |
|
- |
| 37 |
|
- |
| 38 |
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 |
39 |
|
| 40 |
|
-=== API Changes in 2014/10 === |
|
42 |
+=== API Changes in 2014/05 === |
| 41 |
41 |
|
| 42 |
|
-This is a summary of the API changes introduced with version 2014/10: |
|
44 |
+This is a summary of the API changes introduced with version 2014/05: |
| 43 |
43 |
|
| 44 |
44 |
* [[KIELER Lightweight Diagrams>>doc:Lightweight Diagrams (KLighD)]] |
| 45 |
|
-* [[KIELER Infrastructure for Meta-Layout>>doc:Infrastructure for Meta Layout (KIML)]] |
|
47 |
+* ((( |
|
48 |
+[[KIELER Infrastructure for Meta-Layout>>doc:Infrastructure for Meta Layout (KIML)]]* ((( |
|
49 |
+Renamed LayoutDataService to LayoutMetaDataService and renamed ILayoutData to ILayoutMetaData in order to avoid confusion with the KLayoutData meta model and the respective interface. |
|
50 |
+))) |
|
51 |
+* Removed generic type argument from LayoutOptionData. |
|
52 |
+* ((( |
|
53 |
+ILayoutConfig: renamed API method enrich() to getContextValue(..), renamed getValue(..) to getOptionValue(..), renamed setValue(..) to setOptionValue(..), renamed clearValues() to clearOptionValues(..) – see [[doc:Configuring Automatic Layout]] for more details. |
|
54 |
+))) |
|
55 |
+* ((( |
|
56 |
+IDiagramLayoutManager does not inherit from IAdapterFactory anymore; adapter values are now accessed with layoutManager.getDiagramConfig().getContextValue(..) |
|
57 |
+))) |
|
58 |
+* ((( |
|
59 |
+Graphiti bridge: moved some methods from KimlGraphitiUtil to GraphitiDiagramLayoutManager in order to allow easier adaptation in subclasses. Furthermore, we now differentiate margins (spacing to visible part of a node) and insets (spacing to nested subgraph). |
|
60 |
+))) |
|
61 |
+* Made a design review of the de.cau.cs.kieler.core plugin and improved the API of some core classes and interfaces. |
|
62 |
+))) |
| 46 |
46 |
|
| 47 |
|
-=== New Features Included in 2014/10 === |
|
64 |
+=== New Features Included in 2014/05 === |
| 48 |
48 |
|
| 49 |
|
-Here's a few highlights of what's new in version 2014/10: |
|
66 |
+Here's a few highlights of what's new in version 2014/05: |
| 50 |
50 |
|
| 51 |
51 |
* [[KIELER Lightweight Diagrams>>doc:Lightweight Diagrams (KLighD)]] |
| 52 |
|
-* [[KIELER Infrastructure for Meta-Layout>>doc:Infrastructure for Meta Layout (KIML)]] |
|
69 |
+* ((( |
|
70 |
+[[KIELER Infrastructure for Meta-Layout>>doc:Infrastructure for Meta Layout (KIML)]]* ((( |
|
71 |
+Made categorization of the Layout View more understandable. |
|
72 |
+))) |
|
73 |
+* ((( |
|
74 |
+Added a creation method for VolatileLayoutConfig that makes the far too complicated STATIC_CONFIG of layout managers unnecessary. |
|
75 |
+))) |
|
76 |
+))) |
| 53 |
53 |
* [[KIELER Layout Algorithms>>doc:Layout Algorithms (KLay)]] |
|
78 |
+** KLay Layered now makes sure that labels of compound node ports placed on the inside of the compound node are not overlapped by nodes inside the compound node. |
|
79 |
+** KLay Layered now supports controlling the spacing between and around ports through the new layout options {{code language="none"}}LayoutOptions.PORT_SPACING{{/code}} and {{code language="none"}}LayoutOptions.ADDITIONAL_PORT_SPACING{{/code}}. |
|
80 |
+** KLay Layered now understands LayoutOptions.NO_LAYOUT, which can be set to exclude particular graph elements from automatic layout. |
|
81 |
+** KLay Layered now understands a new programmatic option for edge thickness. |
|
82 |
+** When in hierarchical layout mode, KLay Layered now properly places edge labels of cross-hierarchy edges. |
|
83 |
+** When in hierarchical layout mode, KLay Layered can now compact cross-hierarchy edges as it can compact regular edges ({{code language="none"}}Properties.MERGE_HIERARCHICAL_PORTS{{/code}}): |
|
84 |
+[[image:attach:merge_hierarchy.png]] |
| 54 |
54 |
* [[KGraph Text>>doc:KGraph Text (KGT)]] |
|
86 |
+** The textual language for defining KGraphs now has a lot more defaults. Node and port labels are automatically extracted from the node's and port's ID. Nodes and ports also have a default size. This makes for shorter diagram descriptions. |
| 55 |
55 |
|
| 56 |
|
-=== Important Bugs Fixed in 2014/10 === |
| 57 |
|
- |
| 58 |
|
-Among others, the following bugs were fixed in version 2014/10: |
| 59 |
|
- |
| 60 |
|
-* [[KIELER Layout Algorithms>>doc:Layout Algorithms (KLay)]] |
| 61 |
|
-** In KLay Layered, the polyline edge router could produce results where edges overlapped nodes. |
| 62 |
|
-** In KLay Layered, the polyline edge router could produce weird results when more than one edge leaves a given port. |
| 63 |
|
- |
| 64 |
64 |
== Quickstart == |
| 65 |
65 |
|
| 66 |
66 |
=== Diagram Layout === |