KIELER Pragmatics 0.11.0
- Official Project Website
- Built on Eclipse 4.3 "Kepler"
Version 0.11.0 hasn't been released yet. These release notes are not complete.
We are happy to provide release 0.11.0 of the KIELER Pragmatics Project! It 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.
As a bonus, we are co-releasing both our KLighD-based KIELER Ptolemy Browser. The KIELER Web Service for Layout (KWebS) will be updated to the new release soon as well.
Installation
KIELER Pragmatics 0.11.0 is provided as a set of features, available to be added to your Eclipse installation via an update site. KIELER Pragmatics 0.11.0 was tested on Eclipse 4.3 "Kepler", but may also be compatible with other versions of Eclipse.
- See the KIELER Downloads site for download details.
- KIELER Pragmatics requires an installed Java Runtime Environment >= version 1.5.
- The layout components of KIELER can make use of the layout algorithms provided by the GraphViz library. You may want to install that.
See the KIELER Tools and Libraries page to download the KIELER Ptolemy Browser and the KIELER Web Service.
Release Notes
The 0.11.0 release of KIELER Pragmatics is mainly an effort 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. Release notes of older releases can be found at our Release Notes page.
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.
API Changes in 0.11.0
This is a summary of the API changes introduced with version 0.11.0:
- KIELER Light-Weight Diagrams
IViewer<?>
now provides the methodgetViewContext()
as the view contexts contain the source/diagram elements mapping information.ContextViewer
's methodgetCurrentViewContext()
is deprecated and will be removed soon.The dedicated internal interface
ILayoutRecorder
now providesstartRecording()
andstopRecording(...)
.Diagram outline pages must now implement
IDiagramOutlinePage
(internal as well), viewer implementation providing outline pages must implement the relatedProvider
interface.The base plug-in
de.cau.cs.kieler.klighd
does not provide and support for KIVi (KIELER Infrastructur for Viewmanagement); include the new plug-inde.cau.cs.kieler.klighd.kivi
in order to use the established effects.The
DiagramViewPart
,DiagramEditorPart
,DiagramViewManager
implementations moved tode.cau.cs.kieler.klighd.ui
, which has been introduced with the last release.The
ViewContext
, which is a record of all data required for building up a diagram, now provides a reference to the workbench part the diagram is shown in (was available viaContextViewer
as yet).
- KIELER Infrastructure for Meta-Layout
A new base feature for KIML was created, containing only the API, but no UI (use this feature if you don’t want the KIELER UI contributions in your application)
A generic type check was added to the method
setProperty(...)
inIPropertyHolder
DiagramLayoutEngine
moved fromkiml.ui
plugin tokiml.service
pluginAdded layout options for animation, zoom-to-fit, and progress bar display
Modified
DiagramLayoutEngine
methods to use these new optionsIDiagramLayoutManager
andLayoutMapping
moved fromkiml.ui
plugin tokiml.service
pluginLayoutDataService
implementation moved fromkiml.ui
plugin tokiml.service
pluginLayoutInfoService
implementation moved fromkiml.ui
plugin tokiml.service
plugin and renamed toLayoutConfigService
Extension point
layoutInfo
renamed tolayoutConfigs
, elementoption
renamed tostaticConfig
, elementsemanticOption
renamed tosemanticConfig
, elementconfig
renamed tocustomConfig
Created base class for
LayoutConfigService
in kiml base plugin- Layout configurators now reference domain model elements as
Object
instead ofEObject
AnalysisService
moved fromkiml.service
plugin tokiml.grana
pluginTransformationService
moved fromkiml.service
plugin tokiml.formats
plugin and renamed toGraphFormatsService
Extension point
layoutManagers
moved fromkiml.ui
plugin tokiml.service
pluginRemoved support for
IGraphLayoutEngine
implementations fromlayoutManagers
extension pointCreated new class
LayoutManagersService
inkiml.service
from code that was previously hidden inkiml.ui
Removed KWebS client for Eclipse (
kwebs.client
) and removed special code for that client from KIMLMoved content of KWebS base plugin to
kwebs.server
Using
IFactory
interface for lazy creation of KIML service classesMoved
LayoutContext
class tokiml.config
Modified
ILayoutConfig
methods:getAffectedOptions(..)
instead oftransferValues(..)
New Features Included in 0.11.0
Here's a few highlights of what's new in version 0.11.0:
- KIELER Light-Weight Diagrams
- KIELER Layout Algorithms
- KIELER Infrastructure for Meta-Layout
- KIELER Ptolemy Viewer
- KIELER Layout Web Services (KWebS)
Quickstart
Diagram Layout
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:
- Open a diagram using a GMF editor.
- Press the Layout button in the toolbar:
- Open the Layout View by clicking Window -> Show View -> Other... and choosing Layout from the KIELER Layout category.
- Change some of the values and press the Layout button again.
Viewing Ptolemy Models
If you have a Ptolemy installation, try the following:
- Save a Ptolemy model as a
.moml
file somewhere. Download and start our Ptolemy Model Browser.
Note for Mac OS Users
Starting with Mac OS X Mountain Lion, starting the Ptolemy Model Browser may give you the following error message:
INSERT SCREENSHOT HERE
The solution is to right-click or Ctrl-left-click the application and choose "Open" from the context menu. This will open the following dialog:
INSERT SCREENSHOT HERE
Simple click "Open" and you're good to go.
- Open your moml file.
- 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.
Known Problems and Limitations
- The Layout Hierarchy option of KLay Layered does not work with center labels of edges that cross hierarchy boundaries. There may also be further problems.
- 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.
- Currently there is no full-blown user documentation integrated. See our KIELER Project for more information.
Bug Reports, Comments
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.
Send bug reports to kieler@…, please. For news or general questions subscribe to the rt-kieler mailing list.