Update documentation for v6.0.1
diff --git a/doc/Release_Notes.html b/doc/Release_Notes.html
index 934c130..baab228 100644
--- a/doc/Release_Notes.html
+++ b/doc/Release_Notes.html
@@ -13,7 +13,7 @@
<a href="#ReleaseNotesforSirius">Release Notes for Sirius</a>
<ol style="list-style: disc;">
<li>
- <a href="#sirius6.0.0">Changes in Sirius 6.0.0</a>
+ <a href="#sirius6.0.1">Changes in Sirius 6.0.1</a>
<ol style="list-style: disc;">
<li>
<a href="#UserVisibleChanges">User-Visible Changes</a>
@@ -27,27 +27,41 @@
</ol>
</li>
<li>
- <a href="#sirius5.1.1">Changes in Sirius 5.1.1</a>
+ <a href="#sirius6.0.0">Changes in Sirius 6.0.0</a>
<ol style="list-style: disc;">
<li>
<a href="#UserVisibleChanges2">User-Visible Changes</a>
</li>
<li>
+ <a href="#SpecifierVisibleChanges2">Specifier-Visible Changes</a>
+ </li>
+ <li>
<a href="#DeveloperVisibleChanges2">Developer-Visible Changes</a>
</li>
</ol>
</li>
<li>
- <a href="#sirius5.1.0">Changes in Sirius 5.1.0</a>
+ <a href="#sirius5.1.1">Changes in Sirius 5.1.1</a>
<ol style="list-style: disc;">
<li>
<a href="#UserVisibleChanges3">User-Visible Changes</a>
</li>
<li>
- <a href="#SpecifierVisibleChanges2">Specifier-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges3">Developer-Visible Changes</a>
+ </li>
+ </ol>
+ </li>
+ <li>
+ <a href="#sirius5.1.0">Changes in Sirius 5.1.0</a>
+ <ol style="list-style: disc;">
+ <li>
+ <a href="#UserVisibleChanges4">User-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges3">Developer-Visible Changes</a>
+ <a href="#SpecifierVisibleChanges3">Specifier-Visible Changes</a>
+ </li>
+ <li>
+ <a href="#DeveloperVisibleChanges4">Developer-Visible Changes</a>
</li>
</ol>
</li>
@@ -58,13 +72,13 @@
<a href="#sirius5.0.0">Changes in Sirius 5.0.0</a>
<ol style="list-style: disc;">
<li>
- <a href="#UserVisibleChanges4">User-Visible Changes</a>
+ <a href="#UserVisibleChanges5">User-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges4">Developer-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges5">Developer-Visible Changes</a>
</li>
<li>
- <a href="#SpecifierVisibleChanges3">Specifier-Visible Changes</a>
+ <a href="#SpecifierVisibleChanges4">Specifier-Visible Changes</a>
</li>
</ol>
</li>
@@ -74,8 +88,26 @@
<p>This document contains the release notes for recent major releases of Sirius. See also
<a href="Release_Notes_Previous.html">the release notes from previous versions</a> for details about older releases.
</p>
- <h2 id="sirius6.0.0">Changes in Sirius 6.0.0</h2>
+ <h2 id="sirius6.0.1">Changes in Sirius 6.0.1</h2>
+ <p>Sirius 6.0.1 is a service release which contains only important bug fixes compared to version 6.0.0.</p>
+ <p>
+ <em>Note:</em> The new (and still experimental)
+ <em>Workflow</em> and
+ <em>Server</em> features depend on a specific version of Eclipse Jetty which is available in the main Eclipse Photon repository. They can not be used under Oxygen (which include older and incompatible versions of Jetty).
+ </p>
<h3 id="UserVisibleChanges">User-Visible Changes</h3>
+ <h3 id="SpecifierVisibleChanges">Specifier-Visible Changes</h3>
+ <ul>
+ <li><span class="label label-success">Added</span>
+ <a href="specifier/workflows/Workflows.html">Initial documentation</a> has been added for the “Workflow” feature introduced in 6.0.0 (which is still experimental).
+ </li>
+ </ul>
+ <h3 id="DeveloperVisibleChanges">Developer-Visible Changes</h3>
+ <ul>
+ <li><span class="label label-info">Modified</span> The Acceleo version has been changed from 3.7.2 to 3.7.4.</li>
+ </ul>
+ <h2 id="sirius6.0.0">Changes in Sirius 6.0.0</h2>
+ <h3 id="UserVisibleChanges2">User-Visible Changes</h3>
<ul>
<li><span class="label label-success">Added</span> A new feature allows user to insert vertical blank space in sequence diagram. You can refer to the
<a href="user/sequences/Sequence%20Diagrams.html#insert_vertical_blank_space">user documentation </a> for more details.
@@ -100,7 +132,7 @@
<p>
<img border="0" src="images/color_palette.png"/>
</p>
- <h3 id="SpecifierVisibleChanges">Specifier-Visible Changes</h3>
+ <h3 id="SpecifierVisibleChanges2">Specifier-Visible Changes</h3>
<ul>
<li><span class="label label-success">Added</span> An action is added in main toolbar to reload the VSM of installed plug-ins that may have changed. Refer to the
<a href="specifier/general/Specifying_Viewpoints.html#reloadVSM">specifier documentation</a> for details.
@@ -122,7 +154,7 @@
<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=531487">bugzilla 531487</a> for more details.
</li>
</ul>
- <h3 id="DeveloperVisibleChanges">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges2">Developer-Visible Changes</h3>
<ul>
<li><span class="label label-info">Modified</span> The SWTBot test framework version has been upgraded toward SWTBot 2.6. The main impacts are described below:
<ul>
@@ -275,7 +307,7 @@
</ul>
<h4 id="TranslationKeysChanges">Translation Keys Changes</h4>
<h2 id="sirius5.1.1">Changes in Sirius 5.1.1</h2>
- <h3 id="UserVisibleChanges2">User-Visible Changes</h3>
+ <h3 id="UserVisibleChanges3">User-Visible Changes</h3>
<ul>
<li><span class="label label-info">Modified</span> When exporting a diagram as an image, it is now possible to choose an image size level. Before this, a preference called
<em>AutoScale</em> was available and when it was enable, the diagram was scaled to the maximum size safely allowed by the system. Now, a new preference named
@@ -298,7 +330,7 @@
<a href="user/diagrams/Diagrams.html#standardToolId">Standard Tools</a> chapter for more details on this tool.
</li>
</ul>
- <h3 id="DeveloperVisibleChanges2">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges3">Developer-Visible Changes</h3>
<h4 id="Changesinorg.eclipse.sirius2">Changes in
<code>org.eclipse.sirius</code>
</h4>
@@ -360,7 +392,7 @@
</ul>
<p>testcase.</p>
<h2 id="sirius5.1.0">Changes in Sirius 5.1.0</h2>
- <h3 id="UserVisibleChanges3">User-Visible Changes</h3>
+ <h3 id="UserVisibleChanges4">User-Visible Changes</h3>
<ul>
<li><span class="label label-success">Added</span> When exporting a diagram as an image, it is now possible to choose whether or not the diagram should be scaled. If disabled, the diagram will be exported with its normal size (equivalent to a 100% zoom level). If auto-scaling is enabled, the diagram will be scaled to the maximum size safely allowed by the system (this can be different on different OSes). Note that when auto-scaling is enabled, the image files produced may be larger than without. When exporting very large diagrams it is also possible that the diagram will be scaled
<em>down</em> (i.e. with a zoom level smaller than 100%). Enabling auto-scaling can be chosen on a case by case basis from the export dialog; the initial value in the dialog can be controlled by a new preference available in the
@@ -409,7 +441,7 @@
<a href="developer/extensions-provide_custom_bundled_image_shape.html#bundleImageShape">bundleImageShape</a> ), opening or refreshing a diagram will not display exception anymore when the bundleImageShape extension is not valid. A warning is now displayed in the Error Log view to inform user of which attribute of the extension is not correct.
</li>
</ul>
- <h3 id="SpecifierVisibleChanges2">Specifier-Visible Changes</h3>
+ <h3 id="SpecifierVisibleChanges3">Specifier-Visible Changes</h3>
<ul>
<li><span class="label label-success">Added</span> An
<a href="./user/general/Modeling%20Project.html#Migration">automatic migration</a> has been added in this version to fix diagram with edge labels corrupted (see
@@ -438,7 +470,7 @@
<em>Reference Name</em> field (if a valid feature has been specified).
</li>
</ul>
- <h3 id="DeveloperVisibleChanges3">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges4">Developer-Visible Changes</h3>
<h4 id="Migrations2">Migrations</h4>
<ul>
<li><span class="label label-success">Added</span> A migration has been added to fix diagram with edge labels corrupted (see
@@ -684,7 +716,7 @@
<a href="user/general/Aird_Editor.html">the aird editor</a>.
</p>
<h2 id="sirius5.0.0">Changes in Sirius 5.0.0</h2>
- <h3 id="UserVisibleChanges4">User-Visible Changes</h3>
+ <h3 id="UserVisibleChanges5">User-Visible Changes</h3>
<ul>
<li><span class="label label-success">Added</span> An new
<em>aird editor</em> is available on
@@ -708,8 +740,8 @@
</li>
<li><span class="label label-info">Modified</span> Decorators on diagram elements are drawn on top of other figures. If there is an overlap between a decorator of a figure A and another figure B that is over figure A, when user clicks on the decorator, the figure B is now selected (before it was the parent figure A).</li>
</ul>
- <h3 id="DeveloperVisibleChanges4">Developer-Visible Changes</h3>
- <h3 id="SpecifierVisibleChanges3">Specifier-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges5">Developer-Visible Changes</h3>
+ <h3 id="SpecifierVisibleChanges4">Specifier-Visible Changes</h3>
<ul>
<li><span class="label label-success">Added</span> It is now possible to automatically create one or several pre-configured widget(s) in a group if its domain class and if the meta-models of the properties view containing it have been specified. The widget(s) created will be infered from the features in the domain class (e.g. a properly configured
<em>Checkbox</em> widget will be created for boolean attributes).
diff --git a/doc/specifier/Sirius Specifier Manual.html b/doc/specifier/Sirius Specifier Manual.html
index 33138e4..6f79e0f 100644
--- a/doc/specifier/Sirius Specifier Manual.html
+++ b/doc/specifier/Sirius Specifier Manual.html
@@ -48,6 +48,12 @@
<strong>Properties View</strong>
</a> shows how to define custom properties views for your modelers.
</li>
+ <li>
+ <a href="workflows/Workflows.html">
+ <strong>Workflows</strong>
+ </a> (
+ <b>EXPERIMENTAL</b>) shows how to define in the aird editor a custom workflow improving usability of your modeling environment.
+ </li>
</ul>
</li>
<li>
diff --git a/doc/specifier/workflows/Workflows.html b/doc/specifier/workflows/Workflows.html
new file mode 100644
index 0000000..004ca28
--- /dev/null
+++ b/doc/specifier/workflows/Workflows.html
@@ -0,0 +1,206 @@
+<?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>Workflows</title>
+ <link type="text/css" rel="stylesheet" href="../../resources/bootstrap.css"/>
+ <link type="text/css" rel="stylesheet" href="../../resources/custom.css"/>
+ </head>
+ <body>
+ <h1 id="SpecifyingWorkflows">Specifying Workflows</h1>
+ <ol class="toc" style="list-style: disc;">
+ <li>
+ <a href="#SpecifyingWorkflows">Specifying Workflows</a>
+ <ol style="list-style: disc;">
+ <li>
+ <a href="#introduction">Introduction</a>
+ </li>
+ <li>
+ <a href="#specification">Customizing the workflow tile</a>
+ <ol style="list-style: disc;">
+ <li>
+ <a href="#workflow">Workflow</a>
+ </li>
+ <li>
+ <a href="#page">Page</a>
+ </li>
+ <li>
+ <a href="#section">Section</a>
+ </li>
+ <li>
+ <a href="#activity">Activity</a>
+ </li>
+ <li>
+ <a href="#context">Interpreted Expressions context</a>
+ </li>
+ </ol>
+ </li>
+ <li>
+ <a href="#usage">Usage</a>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ <span style="color:red">WARNING:</span> This feature is
+ <b>experimental</b> in Sirius 6.0.x. Adopters are encouraged to test it and give
+ <a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Sirius">feedback</a>, but this sould not be deployed in production. In particular, workflows defined using Sirius 6.0.x may not work at all in Sirius 6.1 and later.
+ </p>
+ <h2 id="introduction">Introduction</h2>
+ <p>The
+ <em>Workflow</em> section is a new tab included in the aird editor (to open it, double click on the file with
+ <em>aird</em> extension).
+ </p>
+ <p>
+ <img border="0" src="images/aird_editor.png"/>
+ </p>
+ <p>The new workflow tab displays both fixed information and information that can be defined in the VSM. The fixed information are the following:</p>
+ <ul>
+ <li>The name of the project and its description.</li>
+ <li>A list of all semantic resources known by the Sirius session</li>
+ <li>A list of all representations (diagrams, tables and trees) in the Sirius session</li>
+ <li>A workflow tile, empty by default, that can be customized by the specifier in the
+ <a href="../../Glossary.html#VSM">
+ <em>VSM</em>
+ </a> to display actions that should be available more directly to users.
+ </li>
+ </ul>
+ <p>
+ <img border="0" src="images/workflow_page.png"/>
+ </p>
+ <h2 id="specification">Customizing the workflow tile</h2>
+ <p>The workflow tile customization can be done by describing its content directly in the VSM.</p>
+ <p>Workflows are defined around four main concepts:
+ <em>Workflow</em>,
+ <em>Page</em>,
+ <em>Section</em> and
+ <em>Activity</em>.
+ <br/>Once defined in the VSM, the result will be visible in the workflow tile of the aird editor.
+ </p>
+ <h3 id="workflow">Workflow</h3>
+ <p>The
+ <em>Workflow Description</em> element can be created under the root element of the odesign from the specific menu item.
+ </p>
+ <p>
+ <img style="width:60%" border="0" src="images/new_workflow.png"/>
+ </p>
+ <p>This action creates a blank new
+ <em>workflow</em> element. Like many elements inside a
+ <a href="../../Glossary.html#VSM">
+ <em>VSM</em>
+ </a>,
+ <em>Workflow Description</em> has a mandatory
+ <em>Identifier</em> property (which should be unique), and an optional
+ <em>Name</em> property that has the same value as the
+ <em>Identifer</em> if the user doesn’t customize it.
+ </p>
+ <p>Inside a
+ <em>Workflow Description</em> element, you can create
+ <em>Page</em> elements.
+ </p>
+ <h3 id="page">Page</h3>
+ <p>For each
+ <em>page</em> element, a tab will be created in the workflow tile of the aird editor. The following screenshot shows an example where three pages have been defined:
+ <em>Capture</em>,
+ <em>Review</em>, and
+ <em>Help</em>.
+ </p>
+ <p>
+ <img border="0" src="images/pages.png"/>
+ </p>
+ <p>The
+ <em>Page Description</em> element can be created under the
+ <em>Workflow Description</em> element from the specific menu item.
+ <br/>This action creates a blank new
+ <em>page</em> element. Like the
+ <em>Workflow Description</em>, the
+ <em>Page Description</em> element has an
+ <em>Identifier</em> and a
+ <em>Name</em> property. It also has a
+ <em>Title Expression</em> element, which will be used to get the label that will be displayed to the user. This field is an
+ <a href="../general/Specifying_Viewpoints.html#interpreted_expressions">
+ <em>Interpreted Expression</em>
+ </a>.
+ </p>
+ <p>
+ <span style="color:red">WARNING:</span> in the current Sirius version, the
+ <em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
+ </p>
+ <p>Inside a
+ <em>Page Description</em> element, you can create
+ <em>Section</em> elements.
+ </p>
+ <h3 id="section">Section</h3>
+ <p>A
+ <em>section</em> element will create a new subpart in the
+ <em>page</em>. The following screenshot shows two sections
+ <em>Hierarchy</em> and
+ <em>Diagram</em> in the
+ <em>Capture</em> page.
+ </p>
+ <p>
+ <img border="0" src="images/sections.png"/>
+ </p>
+ <p>The
+ <em>Section Description</em> element can be created under the
+ <em>Page Description</em> element from the specific menu item.
+ <br/>The action creates a blank new
+ <em>section</em> element. The
+ <em>section</em> element is similar to the
+ <em>page</em> element: it has an
+ <em>Identifier</em>, a
+ <em>Name</em> and a
+ <em>Title Expression</em> properties, which all behave like the
+ <em>page</em> ones.
+ </p>
+ <p>
+ <span style="color:red">WARNING:</span> in the current Sirius version, the
+ <em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
+ </p>
+ <p>Inside a
+ <em>Section Description</em> element, you can create
+ <em>Activity</em> elements.
+ </p>
+ <h3 id="activity">Activity</h3>
+ <p>
+ <em>Activity</em> elements allow specifiers to describe actions. It contains the same properties as
+ <em>section</em> and
+ <em>page</em> elements (i.e.
+ <em>Identifier</em>,
+ <em>Name</em> and
+ <em>Label Expression</em>).
+ </p>
+ <p>
+ <span style="color:red">WARNING:</span> in the current Sirius version, the
+ <em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
+ </p>
+ <p>An
+ <em>activity</em> contains a
+ <em>begin</em> element that allows user to specify a
+ <a href="../general/Model_Operations.html#introduction">
+ <em>Model Operation</em>
+ </a>.
+ </p>
+ <p>Once created, the
+ <em>activities</em> will appear in the workflow tile and the user will be able to click on these, and trigger the associated
+ <em>Model Operation</em>.
+ </p>
+ <h3 id="context">Interpreted Expressions context</h3>
+ <p>When writing an
+ <a href="../general/Specifying_Viewpoints.html#interpreted_expressions">
+ <em>Interpreted Expression</em>
+ </a>, the user must think of the context on which the expression will be applied. For workflows related element (for instance in the Title Expressions of Pages, Sections and Activities), only one context is available,
+ <em>self</em>. In this case,
+ <em>self</em> will be the
+ <code>DAnalysis</code> of the Sirius session, which is a representation of the odesign file.
+ </p>
+ <h2 id="usage">Usage</h2>
+ <p>
+ <em>Workflow</em> elements are associated automatically with the
+ <em>viewpoints</em> defined in the same odesign file. It means that to display the defined workflows in the correct section of the aird editor, the user will have to activate at least one of the viewpoints defined in the VSM.
+ </p>
+ <p>If several
+ <em>workflows</em> are activated and shown in the workflow tile, they are all merged in the same workflow tile.
+ </p>
+ </body>
+</html>
\ No newline at end of file
diff --git a/doc/specifier/workflows/images/aird_editor.png b/doc/specifier/workflows/images/aird_editor.png
new file mode 100644
index 0000000..54ed6db
--- /dev/null
+++ b/doc/specifier/workflows/images/aird_editor.png
Binary files differ
diff --git a/doc/specifier/workflows/images/new_workflow.png b/doc/specifier/workflows/images/new_workflow.png
new file mode 100644
index 0000000..f84eaf7
--- /dev/null
+++ b/doc/specifier/workflows/images/new_workflow.png
Binary files differ
diff --git a/doc/specifier/workflows/images/pages.png b/doc/specifier/workflows/images/pages.png
new file mode 100644
index 0000000..32b56d9
--- /dev/null
+++ b/doc/specifier/workflows/images/pages.png
Binary files differ
diff --git a/doc/specifier/workflows/images/sections.png b/doc/specifier/workflows/images/sections.png
new file mode 100644
index 0000000..015271c
--- /dev/null
+++ b/doc/specifier/workflows/images/sections.png
Binary files differ
diff --git a/doc/specifier/workflows/images/workflow_page.png b/doc/specifier/workflows/images/workflow_page.png
new file mode 100644
index 0000000..e99e1d2
--- /dev/null
+++ b/doc/specifier/workflows/images/workflow_page.png
Binary files differ
