Skip to content

Commit

Permalink
[2041] Documentation for MultiInstanceRole tools
Browse files Browse the repository at this point in the history 
- Document tools for IS, ES and OES diagrams
- Changes the tool icon to have a transparent background.
- Remove a duplicate description for Component tool
- Add known issues document to Release Notes section of the doc

Change-Id: Id9b67fefeb4125252972befdda053c42aaf309af
Signed-off-by: Felix Dorner <felix.dorner@gmail.com>
  • Loading branch information
@felixdo
felixdo committed May 9, 2018
1 parent 17353ca commit 3f84d4c
Show file tree
Hide file tree
Showing 10 changed files with 89 additions and 4 deletions.
Binary file modified .../org.polarsys.capella.core.sirius.analysis/icons/full/obj16/AddInstanceRole.gif
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions core/plugins/org.polarsys.capella.core.sirius.analysis/icons/full/obj16/license.txt
View file
Expand Up @@ -526,3 +526,4 @@ These followings icons are made available under the terms of the Eclipse Public
/icons/full/obj16/ActorSystemFunction.gif - org.polarsys.capella.core.sirius.analysis - org.polarsys.capella.core.sirius.analysis/icons/full/obj16/ActorSystemFunction.gif
/icons/full/obj16/ActorLogicalFunction.gif - org.polarsys.capella.core.sirius.analysis - org.polarsys.capella.core.sirius.analysis/icons/full/obj16/ActorLogicalFunction.gif
/icons/full/obj16/ActorPhysicalFunction.gif - org.polarsys.capella.core.sirius.analysis - org.polarsys.capella.core.sirius.analysis/icons/full/obj16/ActorPhysicalFunction.gif
/icons/full/obj16/AddInstanceRole.gif - org.polarsys.capella.core.sirius.analysis - org.polarsys.capella.core.sirius.analysis/icons/full/obj16/AddInstanceRole.gif
Binary file added ....capella.diagrams.doc/html/Diagrams/Images/icons/full/obj16/AddInstanceRole.gif
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 35 additions & 2 deletions doc/plugins/org.polarsys.capella.diagrams.doc/html/Diagrams/diagrams.html
View file
Expand Up @@ -752,10 +752,19 @@ <h2 id="Component_Exchanges_Scenario">Component Exchanges Scenario</h2>
<td></td>
</tr>
<tr>
<td>Component </td>
<td>Add multiple lifelines for an existing Actor</td>
<td>
<img border="0" src="Images/icons/full/obj16/ComponentInstance.gif"/>
<img border="0" src="Images/icons/full/obj16/AddInstanceRole.gif"/>
</td>
<td>Creates a new Lifeline representing an existing Actor. This allows to have multiple Lifelines representing the same Actor in a single scenario. </td>
<td></td>
</tr>
<tr>
<td>Add multiple lifelines for an existing Component</td>
<td>
<img border="0" src="Images/icons/full/obj16/AddInstanceRole.gif"/>
</td>
<td>Creates a new Lifeline representing an existing Component. This allows to have multiple Lifelines representing the same Component in a single scenario. </td>
<td></td>
</tr>
<tr>
Expand Down Expand Up @@ -975,6 +984,22 @@ <h2 id="Component_Interfaces_Scenario">Component Interfaces Scenario</h2>
</td>
<td></td>
</tr>
<tr>
<td>Add multiple lifelines for an existing Actor</td>
<td>
<img border="0" src="Images/icons/full/obj16/AddInstanceRole.gif"/>
</td>
<td>Creates a new Lifeline representing an existing Actor. This allows to have multiple Lifelines representing the same Actor in a single scenario. </td>
<td></td>
</tr>
<tr>
<td>Add multiple lifelines for an existing Component</td>
<td>
<img border="0" src="Images/icons/full/obj16/AddInstanceRole.gif"/>
</td>
<td>Creates a new Lifeline representing an existing Component. This allows to have multiple Lifelines representing the same Component in a single scenario. </td>
<td></td>
</tr>
<tr>
<td>Shared Data/Event </td>
<td>
Expand Down Expand Up @@ -3910,6 +3935,14 @@ <h2 id="Operational_Interaction_Scenario">Operational Interaction Scenario</h2>
</td>
<td></td>
</tr>
<tr>
<td>Add multiple lifelines for existing Entities / Roles</td>
<td>
<img border="0" src="Images/icons/full/obj16/AddInstanceRole.gif"/>
</td>
<td>Creates a new Lifeline representing an existing Actor / Entity. This allows to have multiple Lifelines representing the same Actor / Entity in a single scenario. </td>
<td></td>
</tr>
<tr>
<td>Interaction with Return Branch </td>
<td>
Expand Down
25 changes: 23 additions & 2 deletions doc/plugins/org.polarsys.capella.diagrams.doc/html/Diagrams/diagrams.mediawiki
View file
Expand Up @@ -440,10 +440,16 @@ This section lists tools that are available on all Capella diagrams. These tools
|-
| Actors
| [[Image:Images/icons/full/obj16/ShowHide.gif]]
|
|-
| Add multiple lifelines for an existing Actor
| [[Image:Images/icons/full/obj16/AddInstanceRole.gif]]
| Creates a new Lifeline representing an existing Actor. This allows to have multiple Lifelines representing the same Actor in a single scenario.
|
|-
| Component
| [[Image:Images/icons/full/obj16/ComponentInstance.gif]]
| Add multiple lifelines for an existing Component
| [[Image:Images/icons/full/obj16/AddInstanceRole.gif]]
| Creates a new Lifeline representing an existing Component. This allows to have multiple Lifelines representing the same Component in a single scenario.
|
|-
| Functional Exchange
Expand Down Expand Up @@ -572,6 +578,16 @@ This section lists tools that are available on all Capella diagrams. These tools
| [[Image:Images/icons/full/obj16/ShowHide.gif]]
|
|-
| Add multiple lifelines for an existing Actor
| [[Image:Images/icons/full/obj16/AddInstanceRole.gif]]
| Creates a new Lifeline representing an existing Actor. This allows to have multiple Lifelines representing the same Actor in a single scenario.
|
|-
| Add multiple lifelines for an existing Component
| [[Image:Images/icons/full/obj16/AddInstanceRole.gif]]
| Creates a new Lifeline representing an existing Component. This allows to have multiple Lifelines representing the same Component in a single scenario.
|
|-
| Shared Data/Event
| [[Image:Images/icons/full/obj16/ShowHide.gif]]
|
Expand Down Expand Up @@ -2307,6 +2323,11 @@ This section lists tools that are available on all Capella diagrams. These tools
| [[Image:Images/icons/full/obj16/ShowHide.gif]]
|
|-
| Add multiple lifelines for existing Entities / Roles
| [[Image:Images/icons/full/obj16/AddInstanceRole.gif]]
| Creates a new Lifeline representing an existing Actor / Entity. This allows to have multiple Lifelines representing the same Actor / Entity in a single scenario.
|
|-
| Interaction with Return Branch
| [[Image:Images/icons/full/obj16/SequenceMessage.gif]]
| Creates a new Sequence Message invoking an Operational Interaction with return branch between the Source and Target Lifelines (representing existing Operational Entities Parts). This tool opens a selection wizard to select an available existing Interaction or to create a new one between existing/new allocated Operational Activities. This tool is masked as soon as a Communication Mean is displayed on the scenario.
Expand Down
1 change: 1 addition & 0 deletions doc/plugins/org.polarsys.capella.diagrams.doc/license.txt
View file
Expand Up @@ -85,6 +85,7 @@ ActorRealisation.gif
ActorRealization.gif
ActorsDiagram.gif
Actor_WB.gif
AddInstanceRole.gif
AspectPkg.gif
Association.gif
AsyncSequenceMessage.gif
Expand Down
1 change: 1 addition & 0 deletions doc/plugins/org.polarsys.capella.doc/.settings/org.eclipse.core.resources.prefs
View file
@@ -1,5 +1,6 @@
eclipse.preferences.version=1
encoding//html/Fragment\ management/Fragment\ management.html=UTF-8
encoding//html/Release\ note/KnownIssues.html=UTF-8
encoding//html/Release\ note/M2_0.8.x_to_1.0.x.html=UTF-8
encoding//html/Release\ note/M2_1.0.x_to_1.1.x.html=UTF-8
encoding//html/Release\ note/M2_1.1.x_to_1.2.x.html=UTF-8
17 changes: 17 additions & 0 deletions doc/plugins/org.polarsys.capella.doc/html/Release note/KnownIssues.html
View file
@@ -0,0 +1,17 @@
<?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"/>
<link type="text/css" rel="stylesheet" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css"/>
<title>Known Issues</title>
</head>
<body>
<h1 id="Known_Issues">Known Issues</h1>
<p>Below is a selection of known issues present at each release of Capella.</p>
<h2 id="Capella_1.2.1">Capella 1.2.1</h2>
<h3 id="Transitions_for_multi-Instancerole_Scenarios">Transitions for multi-Instancerole Scenarios</h3>
<p>
<a href="https://bugs.polarsys.org/show_bug.cgi?id=2052">Bug 2052</a>: Capella 1.2.1 allows the creation of Scenarios with multiple InstanceRoles for identical represented instances. However, the various Scenario Transitions and Subscenario wizards have not been adapted yet and thus may produce unexpected results for such Scenarios.
</p>
</body>
</html>
9 changes: 9 additions & 0 deletions doc/plugins/org.polarsys.capella.doc/html/Release note/KnownIssues.mediawiki
View file
@@ -0,0 +1,9 @@
= Known Issues =

Below is a selection of known issues present at each release of Capella.

== Capella 1.2.1 ==

=== Transitions for multi-Instancerole Scenarios ===

[https://bugs.polarsys.org/show_bug.cgi?id=2052 Bug 2052]: Capella 1.2.1 allows the creation of Scenarios with multiple InstanceRoles for identical represented instances. However, the various Scenario Transitions and Subscenario wizards have not been adapted yet and thus may produce unexpected results for such Scenarios.
2 changes: 2 additions & 0 deletions doc/plugins/org.polarsys.capella.doc/toc.xml
View file
Expand Up @@ -26,6 +26,8 @@
<topic href="html/Release note/M2_0.8.x_to_1.0.x.html" label="Capella 0.8.x to 1.0.x">
</topic>
</topic>
<topic href="html/Release note/KnownIssues.html" label="Known Issues">
</topic>
</topic>
<topic label="User Manual">
<anchor id="main"/>
Expand Down

0 comments on commit 3f84d4c

Please sign in to comment.