blob: 68d51fa016b35e06636e166add5162386e0052a9 [file] [log] [blame]
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Release Notes</title>
<link type="text/css" rel="stylesheet" href="/sirius/doc/0.9/resources/bootstrap.css"/>
<link type="text/css" rel="stylesheet" href="/sirius/doc/0.9/resources/custom.css"/>
</head>
<body>
<h1 id="ReleaseNotesforSirius">Release Notes for Sirius</h1>
<ol class="toc" style="list-style: disc;">
<li>
<a href="#ReleaseNotesforSirius">Release Notes for Sirius</a>
<ol style="list-style: disc;">
<li>
<a href="#sirius0.9">Changes in Sirius 0.9.0</a>
</li>
</ol>
</li>
</ol>
<p>This document contains the release notes for all releases of Sirius.</p>
<h2 id="sirius0.9">Changes in Sirius 0.9.0</h2>
<p>Version 0.9.0 is the first release under the Sirius name and under the Eclipse Foundation umbrella. Except for the few cases mentioned below (in the &#171;Other API Changes&#187;, &#171;Specifier-Visible Changes&#187; and &#171;User-Visible Changes&#187; sections), Sirius 0.9.0 is functionally equivalent to the latest version of Viewpoint (version 6.10), which was the name of the project before it was open sourced at Eclipse. See the rest of the documentation for the complete list of feature of the Sirius platform.</p>
<h3 id="MigratingfromObeoDesignerorViewpointtoSirius">Migrating from Obeo Designer or Viewpoint to Sirius</h3>
<p>If you have existing projects which used this technology before it became Eclipse Sirius and want to migrate to Sirius, you must:</p>
<ol>
<li>first migrate your projects and models to the latest pre-Sirius version of Viewpoint or Obeo Designer available to you (Viewpoint is the previous name of Sirius);</li>
<li>then migrate those to Sirius 0.9.</li>
</ol>
<p>The latest version of Viewpoint which was available in an Obeo Designer release is Viewpoint 6.8, released in Obeo Designer 6.2. Sirius 0.9 is based on Viewpoint 6.10, which was not released publicly.</p>
<p>If you were using Obeo Designer, you must thus first migrate your projects and models to Obeo Designer 6.2, and then consult the
<a href="release_notes_vp.html">release notes for Viewpoint 6.9 and 6.10</a>, which lists the API changes from Viewpoint 6.8 to 6.10.
</p>
<p>Once your projects are compatible with the latest Viewpoint available to you, you can migrate to Sirius, first by updating your Viewpoint Specification Projects and plug-ins which use the Viewpoint APIs, then by updating any Modeling Project and representation files (
<code>*.aird</code>).
</p>
<h4 id="MigratingViewpointSpecificationProjects">Migrating Viewpoint Specification Projects</h4>
<ul>
<li>Any plug-in dependencies towards Viewpoint plug-ins must be updated to the corresponding Sirius plug-in and version number. See the correspondence table below for the plug-in names to use.</li>
<li>If your plug-ins used any of the extension points defined in Viewpoint, you will need to update your
<code>plugin.xml</code> files to reference the correct extension points identifiers. In particular, all Viewpoint Specification Projects created using Viewpoint use the
<code>fr.obeo.dsl.viewpoint.componentization</code> in their
<code>plugin.xml</code> to register the VSMs they define. This should be changed to use the equivalent
<code>org.eclipse.sirius.componentization</code> extension point id. The identifier changes for the other extension points follow the same rules as the name changes of the plug-ins they are defined in.
</li>
<li>The migration of your VSMs (
<code>*.odesign</code> files) is automatic: simply open your files once in the VSM editor, perform some no-op change to make the editor &#171;dirty&#187; and save it. The saved version will have been migrated to Sirius.
</li>
<li>If you had Java code which used the Viewpoint APIs, you will need to update it to use the Sirius APIs. A simple &#171;Source &gt; Organize Imports&#187; on your source folders should find most classes you used in their new namespace. The Viewpoint code base and APIs used the term &#171;Viewpoint&#187; both for the name of the product and for the name of the concept. When it refered to the name of the product, the names where changed to use &#171;Sirius&#187; instead, so you may need to adjust some names in your code beyond just updating the imports (for example,
<code>ViewpointControlCommand</code> is now
<code>SiriusControlCommand</code>).
</li>
</ul>
<p>Note that if you used Obeo Designer, you may have used the legacy Acceleo 2.x language for the computed expressions inside the
<code>*.odesign</code> files (if your expressions are of the form
<code>&lt;%something%&gt;</code> then you used the legacy language). That language is not supported anymore in Sirius 0.9, so you must migrate your expressions to use Acceleo 3 and/or the specialized interpreters (
<code>var:</code>,
<code>feature:</code> and
<code>service:</code>, see the documentation).
</p>
<h4 id="MigratingModelingProjectsandRepresentationFiles">Migrating Modeling Projects and Representation Files</h4>
<ul>
<li>First migrate any modeler definitions used by your modeling projects and representation files (see the section above).</li>
<li>Modeling projects created using Viewpoint will not be recognized directly by Sirius, because the nature identfier has changed. You must use the &#171;Configure/Convert to Modeling Project&#187; action in the project&#8217;s context menu to make it a Sirius-compatible modeling project (see the section below for the technical details of the change).</li>
<li>The migration of you representation files (
<code>*.aird</code>) is performed automatically when they are loaded in memory. It will become permanent the first time you save it (you can force this by opening a representation, making some arbitrary change and saving the session).
</li>
</ul>
<h3 id="Pluginsversionnumbers.">Plug-ins version numbers.</h3>
<p>As of Sirius 0.9, and probably at least until Sirius 1.0 when the APIs will be more stable, all the bundles share the same version, which is also the version for the feature. If you used versioned dependencies to the old Viewpoint code (e.g. dependencies towards Viewpoint 6.8), you need to adjust the versions in your
<code>MANIFEST.MF</code> files in addition to the namespaces.
</p>
<h3 id="Majornamespacechanges">Major namespace changes</h3>
<p>In the context of the move as an official Eclipse project named Sirius, all the namespaces used in the code have changed.</p>
<h4 id="Pluginandfeaturesidentifiers">Plug-in and features identifiers</h4>
<p>All identifiers have changed to start with the
<code>org.eclipse.sirius</code> namespace prefix. The tables below give the mapping between the Viewpoint plug-in and features identifiers and their Sirius equivalent.
</p>
<table>
<tr>
<th>Viewpoint 6.x plug-in </th>
<th>Sirius 0.9 plug-in </th>
</tr>
<tr>
<td>fr.obeo.dsl.common </td>
<td>org.eclipse.sirius.common </td>
</tr>
<tr>
<td>fr.obeo.dsl.common.acceleo.mtl </td>
<td>org.eclipse.sirius.common.acceleo.mtl </td>
</tr>
<tr>
<td>fr.obeo.dsl.common.acceleo.mtl.ide </td>
<td>org.eclipse.sirius.common.acceleo.mtl.ide </td>
</tr>
<tr>
<td>fr.obeo.dsl.common.ocl </td>
<td>org.eclipse.sirius.common.ocl </td>
</tr>
<tr>
<td>fr.obeo.dsl.common.ui </td>
<td>org.eclipse.sirius.common.ui </td>
</tr>
<tr>
<td>fr.obeo.dsl.common.xtext </td>
<td>org.eclipse.sirius.common.xtext </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint </td>
<td>org.eclipse.sirius </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.diagram </td>
<td>org.eclipse.sirius.diagram </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.diagram.layoutdata </td>
<td>org.eclipse.sirius.layoutdata </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.diagram.sequence </td>
<td>org.eclipse.sirius.sequence </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.diagram.sequence.edit </td>
<td>org.eclipse.sirius.sequence.edit </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.diagram.sequence.ui </td>
<td>org.eclipse.sirius.sequence.edit.ui </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.doc </td>
<td>org.eclipse.sirius.doc </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.editor </td>
<td>org.eclipse.sirius.editor </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.editor.sequence </td>
<td>org.eclipse.sirius.editor.sequence </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.editor.table </td>
<td>org.eclipse.sirius.editor.table </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.editor.tree </td>
<td>org.eclipse.sirius.editor.tree </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.eef.adapters </td>
<td>org.eclipse.sirius.eef.adapters </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.interpreter </td>
<td>org.eclipse.sirius.interpreter </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.table </td>
<td>org.eclipse.sirius.table </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.table.ui </td>
<td>org.eclipse.sirius.table.ui </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.tree </td>
<td>org.eclipse.sirius.tree </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.tree.ui </td>
<td>org.eclipse.sirius.tree.ui </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.ui </td>
<td>org.eclipse.sirius.ui </td>
</tr>
<tr>
<td>fr.obeo.mda.ecore.extender </td>
<td>org.eclipse.sirius.ecore.extender </td>
</tr>
<tr>
<td>fr.obeo.mda.pim.ecore.design </td>
<td>org.eclipse.sirius.sample.ecore.design </td>
</tr>
<tr>
<td>org.eclipselab.emf.synchronizer </td>
<td>org.eclipse.sirius.synchronizer </td>
</tr>
</table>
<table>
<tr>
<th>Viewpoint 6.x feature </th>
<th>Sirius 0.9 feature </th>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.runtime </td>
<td>org.eclipse.sirius.runtime </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.runtime.acceleo </td>
<td>org.eclipse.sirius.runtime.acceleo </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.runtime.ide.eef </td>
<td>org.eclipse.sirius.runtime.ide.eef </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.runtime.ide.ui </td>
<td>org.eclipse.sirius.runtime.ide.ui </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.runtime.ide.ui.acceleo </td>
<td>org.eclipse.sirius.runtime.ide.ui.acceleo </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.runtime.ide.xtext </td>
<td>org.eclipse.sirius.runtime.ide.xtext </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.runtime.ocl </td>
<td>org.eclipse.sirius.runtime.ocl </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.specifier.ide.ui </td>
<td>org.eclipse.sirius.specifier.ide.ui </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.specifier.ide.ui.acceleo </td>
<td>org.eclipse.sirius.specifier.ide.ui.acceleo </td>
</tr>
<tr>
<td>fr.obeo.dsl.viewpoint.doc.feature </td>
<td>org.eclipse.sirius.doc.feature </td>
</tr>
</table>
<h4 id="JavaPackagesandClassesNames">Java Packages and Classes Names</h4>
<p>The Java package names have changed to start with the identifier of the plug-in they are defined in (which has changed). A simple &#171;Source &gt; Organize Imports&#187; on your source folders should find most classes you used in their new namespace.</p>
<p>The Viewpoint code base and APIs used the term &#171;Viewpoint&#187; both for the name of the product and for the name of the concept. When it refered to the name of the product, the names where changed to use &#171;Sirius&#187; instead (for example,
<code>ViewpointControlCommand</code> is now
<code>SiriusControlCommand</code>).
</p>
<h4 id="ModelsnamespaceURIs">Models namespace URIs</h4>
<p>All namespace URIs have also been changed from &#171;http://www.obeo.fr/dsl/viewpoint*&#187; to &#171;http://www.eclipse.org/sirius/&#187;.</p>
<p>If you have created VSM file (.odesign) or representations file (.aird) with Viewpoint, the changes of the namespace URIs will be automatically migrated during the loading of your VSM or your representations file. These new nsURIs will be stored physically in the file during the first save. If the file is not saved, the automatic migration will be replayed at the next opening.</p>
<h3 id="NatureID">Nature ID </h3>
<p>The modeling project has a specific nature (
<code>org.eclipse.sirius.nature.modelingproject</code>).
<br/>If you have modeling project created with Viewpoint, you must launch the action &#171;Configure/Convert to Modeling Project&#187; to replace old nature id (
<code>fr.obeo.dsl.viewpoint.nature.modelingproject</code>) by the new one.
<br/>If you have many modeling projects to &#171;migrate&#187;, you can easily make a script to replace
<code>fr.obeo.dsl.viewpoint.nature.modelingproject</code> by
<code>org.eclipse.sirius.nature.modelingproject</code> in all
<code>.project</code> file of each modeling projects.
</p>
<h3 id="OtherAPIChanges">Other API Changes</h3>
<p>This section only lists API changes in Sirius 0.9.0 compared to the latest version of Viewpoint it is based on, i.e. Viewpoint 6.10.</p>
<h4 id="APIAdded">API Added</h4>
<ul>
<li>Add
<code>IMigrationParticipant.getPackage()</code> to return the EPackage to use for the given namespace. This change concerns our internal migration framework. This is useful to handle our namespace changes (from Viewpoint to Sirius).
</li>
</ul>
<h4 id="APIRemoval">API Removal</h4>
<ul>
<li>Removed
<code>org.eclipse.sirius.common.tools.api.interpreter.IAcceleoInterpreterVariables</code>: This interface only defined a single constant, which refered to the syntax of an obsolete version of the Acceleo language.
</li>
<li>Removed
<code>org.eclipse.sirius.common.tools.api.resource.IFileContributorExtension</code>: This interface only defined a few constants relative to an extension point which does not exist anymore.
</li>
<li>Removed the
<code>org.eclipse.sirius.reconciler</code> extension point definition (which used to be defined in the
<code>org.eclipse.sirius</code> plug-in): This extension point is not supported anymore (and has not been for a long time).
</li>
<li>Removed all the deprecated methods from
<code>Session</code> and replaced the internal calls with the equivalent versions with
<code>IProgressMonitors</code>. The removed methods are:
</li>
</ul>
<pre>void open();
void addSemanticResource(Resource newResource, boolean addCrossReferencedResources);
void addSemanticResource(URI semanticModelURI, boolean addCrossReferencedResources);
void addSemanticResource(URI semanticModelURI, boolean addCrossReferencedResources, IProgressMonitor monitor);
void removeSemanticResource(Resource resource, boolean removeCrossReferencedResources);
void removeSemanticResource(Resource semanticResource);
void save();
void close();
Collection&lt;Viewpoint&gt; getSelectedViewpoints();
void createView(Viewpoint viewpoint, Collection&lt;EObject&gt; semantics);
void createView(Viewpoint viewpoint, Collection&lt;EObject&gt; semantics, boolean createNewRepresentations);
void addSelectedView(DView view) throws IllegalArgumentException;
void removeSelectedView(DView view);
</pre>
<h3 id="SpecifierVisibleChanges">Specifier-Visible Changes</h3>
<p>New variables are available for
<code>sizeComputationExpression</code> to compute the size of edges on
<code>EdgeStyleDescription</code> and
<code>BracketEdgeStyleDescription</code>:
</p>
<ul>
<li>
<em>diagram</em>: the current
<code>DDiagram</code>
</li>
<li>
<em>view</em>: the current
<code>DEdge</code>
</li>
<li>
<em>sourceView</em>: the source view of the current edge.
</li>
<li>
<em>targetView</em>: the target view of the current edge.
</li>
</ul>
<h3 id="UserVisibleChanges">User-Visible Changes</h3>
<ul>
<li>The ability to print table representations has been disabled for the 0.9 release due to an external dependency issue (see
<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=422223">bug #422223</a> for the details). It should be re-introduced in 1.0.
</li>
</ul>
</body>
</html>